@sanity/runtime-cli 4.2.0 → 4.3.0

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @sanity/runtime-cli
 $ sanity-run COMMAND
 running command...
 $ sanity-run (--version)
-@sanity/runtime-cli/4.2.0 linux-x64 node-v22.14.0
+@sanity/runtime-cli/4.3.0 linux-x64 node-v22.14.0
 $ sanity-run --help [COMMAND]
 USAGE
   $ sanity-run COMMAND
@@ -40,6 +40,7 @@ USAGE
 * [`sanity-run blueprints stacks`](#sanity-run-blueprints-stacks)
 * [`sanity-run functions dev`](#sanity-run-functions-dev)
 * [`sanity-run functions env add NAME KEY VALUE`](#sanity-run-functions-env-add-name-key-value)
+* [`sanity-run functions env list NAME`](#sanity-run-functions-env-list-name)
 * [`sanity-run functions env remove NAME KEY`](#sanity-run-functions-env-remove-name-key)
 * [`sanity-run functions invoke NAME`](#sanity-run-functions-invoke-name)
 * [`sanity-run functions logs NAME`](#sanity-run-functions-logs-name)
@@ -73,7 +74,7 @@ EXAMPLES
   $ sanity-run blueprints add function --name my-function --function-type document-publish
 ```
 
-_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v4.2.0/src/commands/blueprints/add.ts)_
+_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/add.ts)_
 
 ## `sanity-run blueprints config`
 
@@ -102,7 +103,7 @@ EXAMPLES
   $ sanity-run blueprints config --edit --project-id <projectId> --stack-id <stackId>
 ```
 
-_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v4.2.0/src/commands/blueprints/config.ts)_
+_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/config.ts)_
 
 ## `sanity-run blueprints deploy`
 
@@ -122,7 +123,7 @@ EXAMPLES
   $ sanity-run blueprints deploy
 ```
 
-_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v4.2.0/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/deploy.ts)_
 
 ## `sanity-run blueprints destroy`
 
@@ -145,7 +146,7 @@ EXAMPLES
   $ sanity-run blueprints destroy --id ST-a1b2c3
 ```
 
-_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v4.2.0/src/commands/blueprints/destroy.ts)_
+_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/destroy.ts)_
 
 ## `sanity-run blueprints info`
 
@@ -167,7 +168,7 @@ EXAMPLES
   $ sanity-run blueprints info --id ST-a1b2c3
 ```
 
-_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v4.2.0/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/info.ts)_
 
 ## `sanity-run blueprints init`
 
@@ -197,7 +198,7 @@ EXAMPLES
   $ sanity-run blueprints init --blueprint-type <json|js|ts> --project-id <projectId> --stack-name <stackName>
 ```
 
-_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v4.2.0/src/commands/blueprints/init.ts)_
+_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/init.ts)_
 
 ## `sanity-run blueprints logs`
 
@@ -219,7 +220,7 @@ EXAMPLES
   $ sanity-run blueprints logs --watch
 ```
 
-_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v4.2.0/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/logs.ts)_
 
 ## `sanity-run blueprints plan`
 
@@ -236,7 +237,7 @@ EXAMPLES
   $ sanity-run blueprints plan
 ```
 
-_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v4.2.0/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/plan.ts)_
 
 ## `sanity-run blueprints stacks`
 
@@ -258,7 +259,7 @@ EXAMPLES
   $ sanity-run blueprints stacks --projectId a1b2c3
 ```
 
-_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v4.2.0/src/commands/blueprints/stacks.ts)_
+_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/blueprints/stacks.ts)_
 
 ## `sanity-run functions dev`
 
@@ -278,7 +279,7 @@ EXAMPLES
   $ sanity-run functions dev --port 8974
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v4.2.0/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/functions/dev.ts)_
 
 ## `sanity-run functions env add NAME KEY VALUE`
 
@@ -300,7 +301,27 @@ EXAMPLES
   $ sanity-run functions env add MyFunction API_URL https://api.example.com/
 ```
 
-_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v4.2.0/src/commands/functions/env/add.ts)_
+_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/functions/env/add.ts)_
+
+## `sanity-run functions env list NAME`
+
+List the environment variables for a Sanity function
+
+```
+USAGE
+  $ sanity-run functions env list NAME
+
+ARGUMENTS
+  NAME  The name of the Sanity Function
+
+DESCRIPTION
+  List the environment variables for a Sanity function
+
+EXAMPLES
+  $ sanity-run functions env list MyFunction
+```
+
+_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/functions/env/list.ts)_
 
 ## `sanity-run functions env remove NAME KEY`
 
@@ -321,7 +342,7 @@ EXAMPLES
   $ sanity-run functions env remove MyFunction API_URL
 ```
 
-_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v4.2.0/src/commands/functions/env/remove.ts)_
+_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/functions/env/remove.ts)_
 
 ## `sanity-run functions invoke NAME`
 
@@ -347,7 +368,7 @@ EXAMPLES
   $ sanity-run functions invoke <name> --file 'payload.json'
 ```
 
-_See code: [src/commands/functions/invoke.ts](https://github.com/sanity-io/runtime-cli/blob/v4.2.0/src/commands/functions/invoke.ts)_
+_See code: [src/commands/functions/invoke.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/functions/invoke.ts)_
 
 ## `sanity-run functions logs NAME`
 
@@ -379,7 +400,7 @@ EXAMPLES
   $ sanity-run functions logs <name> --delete
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v4.2.0/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/functions/logs.ts)_
 
 ## `sanity-run functions test NAME`
 
@@ -412,7 +433,7 @@ EXAMPLES
   $ sanity-run functions test <name> --data '{ "id": 1 }' --timeout 60
 ```
 
-_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v4.2.0/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v4.3.0/src/commands/functions/test.ts)_
 
 ## `sanity-run help [COMMAND]`
 

package/dist/actions/functions/env/index.d.ts

@@ -1,2 +1,3 @@
+export * from './list.js';
 export * from './remove.js';
 export * from './update.js';

package/dist/actions/functions/env/index.js

@@ -1,2 +1,3 @@
+export * from './list.js';
 export * from './remove.js';
 export * from './update.js';

package/dist/actions/functions/env/list.d.ts

@@ -0,0 +1,6 @@
+import type { AuthParams } from '../../../utils/types.js';
+export declare function list(id: string, auth: AuthParams): Promise<{
+    ok: boolean;
+    envvars: any;
+    error: any;
+}>;

package/dist/actions/functions/env/list.js

@@ -0,0 +1,15 @@
+import config from '../../../config.js';
+import getHeaders from '../../../utils/get-headers.js';
+const { functions } = config.server;
+export async function list(id, auth) {
+    const response = await fetch(`${functions}vX/functions/${id}/envvars`, {
+        headers: getHeaders(auth),
+        method: 'GET',
+    });
+    const json = await response.json();
+    return {
+        ok: response.ok,
+        envvars: json.envvars,
+        error: response.ok ? null : json?.error?.message,
+    };
+}

package/dist/commands/functions/env/list.d.ts

@@ -0,0 +1,9 @@
+import { Command } from '@oclif/core';
+export default class List extends Command {
+    static args: {
+        name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

package/dist/commands/functions/env/list.js

@@ -0,0 +1,30 @@
+import { Args, Command } from '@oclif/core';
+import { readBlueprintOnDisk } from '../../../actions/blueprints/blueprint.js';
+import { list } from '../../../actions/functions/env/list.js';
+import config from '../../../config.js';
+import { findFunctionByName } from '../../../utils/find-function.js';
+export default class List extends Command {
+    static args = {
+        name: Args.string({ description: 'The name of the Sanity Function', required: true }),
+    };
+    static description = 'List the environment variables for a Sanity function';
+    static examples = ['<%= config.bin %> <%= command.id %> MyFunction'];
+    async run() {
+        const { args } = await this.parse(List);
+        const { deployedStack } = await readBlueprintOnDisk({ getStack: true, token: config.token });
+        if (!deployedStack)
+            this.error('Stack not found. Is it deployed?'); // returns
+        const { projectId } = deployedStack;
+        const { externalId } = findFunctionByName(deployedStack, args.name);
+        const result = await list(externalId, {
+            token: config.token,
+            projectId,
+        });
+        if (!result.ok) {
+            this.error(`Error: ${result.error || 'Unknown error'}`);
+        }
+        for (const key of result.envvars) {
+            this.log(key);
+        }
+    }
+}

package/oclif.manifest.json

@@ -701,6 +701,37 @@
         "add.js"
       ]
     },
+    "functions:env:list": {
+      "aliases": [],
+      "args": {
+        "name": {
+          "description": "The name of the Sanity Function",
+          "name": "name",
+          "required": true
+        }
+      },
+      "description": "List the environment variables for a Sanity function",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> MyFunction"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "functions:env:list",
+      "pluginAlias": "@sanity/runtime-cli",
+      "pluginName": "@sanity/runtime-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "functions",
+        "env",
+        "list.js"
+      ]
+    },
     "functions:env:remove": {
       "aliases": [],
       "args": {
@@ -738,5 +769,5 @@
       ]
     }
   },
-  "version": "4.2.0"
+  "version": "4.3.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sanity/runtime-cli",
   "description": "Sanity's Runtime CLI for Blueprints and Functions",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "author": "Sanity Runtime Team",
   "type": "module",
   "license": "MIT",