@sanity/runtime-cli 1.0.2

package/dist/utils/build-payload.d.ts

@@ -0,0 +1,2 @@
+import type { PayloadOptions } from './types.js';
+export default function buildPayload(options: PayloadOptions): object | null;

package/dist/utils/build-payload.js

@@ -0,0 +1,15 @@
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { cwd } from 'node:process';
+import isJson from './is-json.js';
+export default function buildPayload(options) {
+    const { data, file } = options;
+    let payload = {};
+    if (data) {
+        payload = isJson(data);
+    }
+    else if (file) {
+        payload = isJson(readFileSync(join(cwd(), file), 'utf8'));
+    }
+    return payload;
+}

package/dist/utils/child-process-wrapper.js

@@ -0,0 +1,33 @@
+import {join} from 'node:path'
+import process from 'node:process'
+
+// Start when payload data arrives from parent process
+process.on('message', async (data) => {
+  const {srcPath, payload} = JSON.parse(data)
+  let logs = ''
+  let json = null
+
+  // Import the function code
+  const {handler} = await import(join(process.cwd(), srcPath))
+
+  // backup stdout
+  const originalStdoutWrite = process.stdout.write.bind(process.stdout)
+
+  // redirect stdout to a buffer
+  process.stdout.write = (chunk) => {
+    if (typeof chunk === 'string') {
+      logs += chunk
+    }
+    return true
+  }
+
+  if (handler && typeof handler === 'function') {
+    json = await handler(payload)
+  }
+
+  // revert changes to stdout
+  process.stdout.write = originalStdoutWrite
+
+  // Send result of handler code to parent process.
+  process.send(JSON.stringify({json, logs}))
+})

package/dist/utils/invoke-local.d.ts

@@ -0,0 +1,2 @@
+import type { InvocationResponse } from './types.js';
+export default function invoke(srcPath: string, payload: null | object, timeout?: number): Promise<InvocationResponse>;

package/dist/utils/invoke-local.js

@@ -0,0 +1,51 @@
+import { spawn } from 'node:child_process';
+import { join } from 'node:path';
+import { cwd } from 'node:process';
+import { setTimeout } from 'node:timers';
+import isDependency from './is-dependency.js';
+function getChildProcessWrapperPath() {
+    return isDependency('./utils/child-process-wrapper.js')
+        ? join(cwd(), './node_modules/@sanity/runtime-cli/dist/utils/child-process-wrapper.js')
+        : join(cwd(), './src/utils/child-process-wrapper.js');
+}
+export default async function invoke(srcPath, payload, timeout = 5) {
+    return new Promise((resolve, reject) => {
+        let child;
+        let timer;
+        function start() {
+            child = spawn('node', [getChildProcessWrapperPath()], {
+                cwd: cwd(),
+                stdio: ['inherit', 'inherit', 'inherit', 'ipc'],
+            });
+            // Note: start a timeout so child process doesn't run forever
+            child.on('message', (data) => {
+                const { json, logs } = JSON.parse(data.toString());
+                shutdown();
+                resolve({ json, logs, error: '' });
+            });
+            child.on('error', (error) => {
+                reject(new Error(`encountered error ${error.message}`));
+            });
+            child.on('exit', (code) => {
+                shutdown();
+                if (code !== 0) {
+                    reject(new Error(`exited with code ${code}`));
+                }
+                else {
+                    resolve({ json: {}, logs: '', error: '' });
+                }
+            });
+            timer = setTimeout(() => {
+                // timedOut = true
+                shutdown();
+                reject(new Error(`Timed out after hitting its ${timeout}s timeout!`));
+            }, timeout * 1000);
+            child.send(JSON.stringify({ srcPath, payload }, null, 2));
+        }
+        function shutdown() {
+            clearTimeout(timer);
+            child.kill();
+        }
+        start();
+    });
+}

package/dist/utils/is-dependency.d.ts

@@ -0,0 +1 @@
+export default function isDependency(filePath: string): boolean;

package/dist/utils/is-dependency.js

@@ -0,0 +1,7 @@
+import { existsSync } from 'node:fs';
+import { join } from 'node:path';
+import { cwd } from 'node:process';
+export default function isDependency(filePath) {
+    const path = join(cwd(), 'node_modules/@sanity/runtime-cli/dist/', filePath);
+    return existsSync(path);
+}

package/dist/utils/is-json.d.ts

@@ -0,0 +1 @@
+export default function isJson(jsonString: string): null | object;

package/dist/utils/is-json.js

@@ -0,0 +1,12 @@
+export default function isJson(jsonString) {
+    try {
+        const o = JSON.parse(jsonString);
+        if (o && typeof o === 'object') {
+            return o;
+        }
+    }
+    catch {
+        return null;
+    }
+    return null;
+}

package/dist/utils/types.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @internal
+ */
+export interface PayloadOptions {
+    data: string | undefined;
+    file: string | undefined;
+    timeout?: number | undefined;
+}
+/**
+ * @internal
+ */
+export interface InvocationResponse {
+    error: undefined | unknown;
+    json: object | undefined;
+    logs: string | undefined;
+}

package/dist/utils/types.js

@@ -0,0 +1 @@
+export {};

package/oclif.manifest.json

@@ -0,0 +1,179 @@
+{
+  "commands": {
+    "functions:dev": {
+      "aliases": [],
+      "args": {},
+      "description": "Start the Sanity Function emulator",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> --port 8974"
+      ],
+      "flags": {
+        "port": {
+          "char": "p",
+          "description": "Port to start emulator on",
+          "name": "port",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "functions:dev",
+      "pluginAlias": "@sanity/runtime-cli",
+      "pluginName": "@sanity/runtime-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "functions",
+        "dev.js"
+      ]
+    },
+    "functions:invoke": {
+      "aliases": [],
+      "args": {
+        "id": {
+          "description": "The ID of the function to invoke",
+          "name": "id",
+          "required": true
+        }
+      },
+      "description": "Invoke a remote Sanity Function",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> <ID> --data '{ \"id\": 1 }'",
+        "<%= config.bin %> <%= command.id %> <ID> --file 'payload.json'"
+      ],
+      "flags": {
+        "data": {
+          "char": "d",
+          "description": "Data to send to the function",
+          "name": "data",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "file": {
+          "char": "f",
+          "description": "Read data from file and send to the function",
+          "name": "file",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "functions:invoke",
+      "pluginAlias": "@sanity/runtime-cli",
+      "pluginName": "@sanity/runtime-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "functions",
+        "invoke.js"
+      ]
+    },
+    "functions:logs": {
+      "aliases": [],
+      "args": {
+        "id": {
+          "description": "The ID of the function to retrieve logs for",
+          "name": "id",
+          "required": true
+        }
+      },
+      "description": "Retrieve logs for a Sanity Function",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> <ID>"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "functions:logs",
+      "pluginAlias": "@sanity/runtime-cli",
+      "pluginName": "@sanity/runtime-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "functions",
+        "logs.js"
+      ]
+    },
+    "functions:test": {
+      "aliases": [],
+      "args": {
+        "path": {
+          "description": "The path to the function source code",
+          "name": "path",
+          "required": true
+        }
+      },
+      "description": "Invoke a local Sanity Function",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> ./test.ts --data '{ \"id\": 1 }'",
+        "<%= config.bin %> <%= command.id %> ./test.js --file 'payload.json'",
+        "<%= config.bin %> <%= command.id %> ./test.ts --data '{ \"id\": 1 }' --timeout 60"
+      ],
+      "flags": {
+        "data": {
+          "char": "d",
+          "description": "Data to send to the function",
+          "name": "data",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "file": {
+          "char": "f",
+          "description": "Read data from file and send to the function",
+          "name": "file",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "timeout": {
+          "char": "t",
+          "description": "Execution timeout value in seconds",
+          "name": "timeout",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "functions:test",
+      "pluginAlias": "@sanity/runtime-cli",
+      "pluginName": "@sanity/runtime-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "functions",
+        "test.js"
+      ]
+    }
+  },
+  "version": "1.0.2"
+}

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@sanity/runtime-cli",
+  "description": "A new CLI generated with oclif",
+  "version": "1.0.2",
+  "author": "Sanity Runtime Team",
+  "type": "module",
+  "license": "UNLICENSED",
+  "repository": "sanity-io/runtime-cli",
+  "bugs": "https://github.com/sanity-io/runtime-cli/issues",
+  "homepage": "https://github.com/sanity-io/runtime-cli",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "engines": {
+    "node": ">=20.11.0"
+  },
+  "files": [
+    "./bin",
+    "./dist",
+    "./oclif.manifest.json"
+  ],
+  "bin": {
+    "sanity": "./bin/run.js"
+  },
+  "scripts": {
+    "build": "rollup -c && shx rm -rf dist && tsc -b && npm run build:static",
+    "build:static": "npm run copy:wrapper && npm run copy:server",
+    "copy:server": "shx cp -r ./src/server/static ./dist/server/static",
+    "copy:wrapper": "shx cp ./src/utils/child-process-wrapper.js ./dist/utils/child-process-wrapper.js",
+    "lint": "biome ci",
+    "lint:write": "biome check --write",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "npm run lint",
+    "prepack": "oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "dependencies": {
+    "@hono/node-server": "^1.13.8",
+    "@oclif/core": "^4",
+    "@oclif/plugin-help": "^6",
+    "@oclif/plugin-plugins": "^5",
+    "hono": "^4.7.2"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "1.9.4",
+    "@codemirror/lang-json": "^6.0.1",
+    "@codemirror/state": "^6.5.2",
+    "@enhance/store": "^1.0.2",
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^4",
+    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@types/chai": "^5",
+    "@types/mocha": "^10",
+    "@types/node": "^20",
+    "chai": "^5",
+    "codemirror": "^6.0.1",
+    "mocha": "^11",
+    "oclif": "^4",
+    "pretty-bytes": "^6.1.1",
+    "pretty-ms": "^9.2.0",
+    "rollup": "^4.34.8",
+    "shx": "^0.3.4",
+    "ts-node": "^10",
+    "typescript": "^5"
+  },
+  "oclif": {
+    "bin": "sanity",
+    "dirname": "sanity",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins"
+    ],
+    "topicSeparator": " ",
+    "topics": {
+      "hello": {
+        "description": "Say hello to the world and others"
+      }
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": false
+  }
+}