examples: add Share CLI example (PAN-8682)

Author: kenany

dev/run_all_examples.sh

@@ -1,12 +1,25 @@
 #!/usr/bin/env bash
 
 set -e
+skip_items=("/node_modules/", "cli.mjs")
 
 # Root directory
 root_directory=$(pwd)
 
 # Find all *.mjs files and run them with node
 find . -type f -name '*.mjs' | while read -r file; do
+    # Exclusions.
+    skip=false
+    for item in "${skip_items[@]}"; do
+        if [[ $file == *"$item"* ]]; then
+            skip=true
+            break
+        fi
+    done
+    if [ "$skip" = true ]; then
+        continue
+    fi
+
     echo -e "\n\n--------------------------------------------------------------\nRunning: $file"
     node "$file"
     echo -e "\nFinish: $file\n--------------------------------------------------------------\n"

examples/share/cli.mjs

@@ -0,0 +1,115 @@
+#!/usr/bin/env node
+
+// @ts-check
+
+import fs from "node:fs/promises";
+import path from "node:path";
+import process from "node:process";
+
+import { defineCommand, runMain } from "citty";
+import { PangeaConfig, Share, ShareService } from "pangea-node-sdk";
+
+const main = defineCommand({
+  meta: {
+    name: "share",
+    version: "0.0.0",
+    description:
+      "An example command line utility that creates an email+code, SMS+code, " +
+      "or password-secured download/upload/editor share-link for a given " +
+      "file or for each file in a given directory.",
+  },
+  args: {
+    input: {
+      type: "string",
+      required: true,
+      alias: "i",
+      description: "Local path to upload.",
+    },
+    dest: {
+      type: "string",
+      default: "/",
+      description: "Destination path in Share.",
+    },
+    email: {
+      type: "string",
+      description: "Email address to protect the share link with.",
+    },
+    phone: {
+      type: "string",
+      description: "Phone number to protect the share link with.",
+    },
+    password: {
+      type: "string",
+      description: "Password to protect the share link with.",
+    },
+    link_type: {
+      type: "string",
+      default: Share.LinkType.DOWNLOAD,
+      description: "Type of link.",
+    },
+  },
+  async run({ args }) {
+    if (!args.email && !args.phone && !args.password) {
+      throw new Error(
+        "At least one of --email, --phone, or --password must be provided."
+      );
+    }
+
+    /** @type {Set<Share.Authenticator>} */
+    const authenticators = new Set();
+    if (args.password) {
+      authenticators.add({
+        auth_type: Share.AuthenticatorType.PASSWORD,
+        auth_context: args.password,
+      });
+    }
+    if (args.email) {
+      authenticators.add({
+        auth_type: Share.AuthenticatorType.EMAIL_OTP,
+        auth_context: args.email,
+      });
+    }
+    if (args.phone) {
+      authenticators.add({
+        auth_type: Share.AuthenticatorType.SMS_OTP,
+        auth_context: args.phone,
+      });
+    }
+
+    const share = new ShareService(
+      // @ts-expect-error
+      process.env.PANGEA_SHARE_TOKEN,
+      new PangeaConfig({ domain: process.env.PANGEA_DOMAIN })
+    );
+
+    // Upload files.
+    const files = (await fs.lstat(args.input)).isDirectory()
+      ? (await fs.readdir(args.input)).map((x) => path.resolve(args.input, x))
+      : [args.input];
+    const objectIds = new Set();
+    for (const file of files) {
+      const uploadResponse = await share.put(
+        {
+          path: `${args.dest}/${path.basename(file)}`,
+        },
+        { file, name: "file" }
+      );
+      objectIds.add(uploadResponse.result.object.id);
+    }
+
+    // Create share link.
+    const linkResponse = await share.shareLinkCreate({
+      links: [
+        {
+          targets: Array.from(objectIds),
+          // @ts-expect-error
+          link_type: args.link_type,
+          authenticators: Array.from(authenticators),
+        },
+      ],
+    });
+    console.log(linkResponse.result.share_link_objects[0].link);
+  },
+});
+
+runMain(main);

examples/share/package.json

@@ -1,14 +1,12 @@
 {
   "name": "share_examples",
-  "version": "2.0.0",
-  "description": "Pangea Share example",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
+  "version": "0.0.0",
+  "description": "Pangea Secure Share examples",
+  "private": true,
   "author": "Pangea",
   "license": "MIT",
   "dependencies": {
+    "citty": "^0.1.6",
     "pangea-node-sdk": "file:../../packages/pangea-node-sdk"
   }
 }