@sanity/runtime-cli 2.2.0 → 2.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/2.2.0 linux-x64 node-v22.14.0
+@sanity/runtime-cli/2.3.0 linux-x64 node-v22.14.0
 $ sanity-run --help [COMMAND]
 USAGE
   $ sanity-run COMMAND
@@ -63,7 +63,7 @@ EXAMPLES
   $ sanity-run blueprints add function
 ```
 
-_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v2.2.0/src/commands/blueprints/add.ts)_
+_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v2.3.0/src/commands/blueprints/add.ts)_
 
 ## `sanity-run blueprints config`
 
@@ -85,7 +85,7 @@ EXAMPLES
   $ sanity-run blueprints config --edit
 ```
 
-_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v2.2.0/src/commands/blueprints/config.ts)_
+_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v2.3.0/src/commands/blueprints/config.ts)_
 
 ## `sanity-run blueprints deploy`
 
@@ -102,7 +102,7 @@ EXAMPLES
   $ sanity-run blueprints deploy
 ```
 
-_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v2.2.0/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v2.3.0/src/commands/blueprints/deploy.ts)_
 
 ## `sanity-run blueprints info`
 
@@ -124,7 +124,7 @@ EXAMPLES
   $ sanity-run blueprints info --id abc123
 ```
 
-_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v2.2.0/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v2.3.0/src/commands/blueprints/info.ts)_
 
 ## `sanity-run blueprints init`
 
@@ -141,7 +141,7 @@ EXAMPLES
   $ sanity-run blueprints init
 ```
 
-_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v2.2.0/src/commands/blueprints/init.ts)_
+_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v2.3.0/src/commands/blueprints/init.ts)_
 
 ## `sanity-run blueprints logs`
 
@@ -163,7 +163,7 @@ EXAMPLES
   $ sanity-run blueprints logs --watch
 ```
 
-_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v2.2.0/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v2.3.0/src/commands/blueprints/logs.ts)_
 
 ## `sanity-run blueprints plan`
 
@@ -180,7 +180,7 @@ EXAMPLES
   $ sanity-run blueprints plan
 ```
 
-_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v2.2.0/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v2.3.0/src/commands/blueprints/plan.ts)_
 
 ## `sanity-run blueprints stacks`
 
@@ -197,7 +197,7 @@ EXAMPLES
   $ sanity-run blueprints stacks
 ```
 
-_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v2.2.0/src/commands/blueprints/stacks.ts)_
+_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v2.3.0/src/commands/blueprints/stacks.ts)_
 
 ## `sanity-run functions dev`
 
@@ -217,7 +217,7 @@ EXAMPLES
   $ sanity-run functions dev --port 8974
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v2.2.0/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v2.3.0/src/commands/functions/dev.ts)_
 
 ## `sanity-run functions env add NAME KEY VALUE`
 
@@ -239,7 +239,7 @@ 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/v2.2.0/src/commands/functions/env/add.ts)_
+_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v2.3.0/src/commands/functions/env/add.ts)_
 
 ## `sanity-run functions env remove NAME KEY`
 
@@ -260,7 +260,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/v2.2.0/src/commands/functions/env/remove.ts)_
+_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v2.3.0/src/commands/functions/env/remove.ts)_
 
 ## `sanity-run functions invoke NAME`
 
@@ -281,12 +281,12 @@ DESCRIPTION
   Invoke a remote Sanity Function
 
 EXAMPLES
-  $ sanity-run functions invoke <ID> --data '{ "id": 1 }'
+  $ sanity-run functions invoke <name> --data '{ "id": 1 }'
 
-  $ sanity-run functions invoke <ID> --file 'payload.json'
+  $ sanity-run functions invoke <name> --file 'payload.json'
 ```
 
-_See code: [src/commands/functions/invoke.ts](https://github.com/sanity-io/runtime-cli/blob/v2.2.0/src/commands/functions/invoke.ts)_
+_See code: [src/commands/functions/invoke.ts](https://github.com/sanity-io/runtime-cli/blob/v2.3.0/src/commands/functions/invoke.ts)_
 
 ## `sanity-run functions logs NAME`
 
@@ -294,19 +294,27 @@ Retrieve logs for a Sanity Function
 
 ```
 USAGE
-  $ sanity-run functions logs NAME
+  $ sanity-run functions logs NAME [-l <value>] [-j]
 
 ARGUMENTS
   NAME  The name of the Sanity Function
 
+FLAGS
+  -j, --json           Return logs in JSON format
+  -l, --limit=<value>  [default: 50] Total number of log entries to retrieve
+
 DESCRIPTION
   Retrieve logs for a Sanity Function
 
 EXAMPLES
-  $ sanity-run functions logs <ID>
+  $ sanity-run functions logs <name>
+
+  $ sanity-run functions logs <name> --json
+
+  $ sanity-run functions logs <name> --limit 100
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v2.2.0/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v2.3.0/src/commands/functions/logs.ts)_
 
 ## `sanity-run functions test NAME`
 
@@ -328,14 +336,14 @@ DESCRIPTION
   Invoke a local Sanity Function
 
 EXAMPLES
-  $ sanity-run functions test echo-fn --data '{ "id": 1 }'
+  $ sanity-run functions test <name> --data '{ "id": 1 }'
 
-  $ sanity-run functions test echo-fn --file 'payload.json'
+  $ sanity-run functions test <name> --file 'payload.json'
 
-  $ sanity-run functions test echo-fn --data '{ "id": 1 }' --timeout 60
+  $ 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/v2.2.0/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v2.3.0/src/commands/functions/test.ts)_
 
 ## `sanity-run help [COMMAND]`
 

package/dist/actions/functions/logs.d.ts

@@ -1,6 +1,11 @@
 import type { AuthParams } from '../../utils/types.js';
-export declare function logs(id: string, auth: AuthParams): Promise<{
+/** internal */
+export interface LoggingOptions {
+    limit: number;
+}
+export declare function logs(id: string, options: LoggingOptions, auth: AuthParams): Promise<{
     ok: boolean;
     error: any;
     logs: any;
+    total: any;
 }>;

package/dist/actions/functions/logs.js

@@ -1,8 +1,9 @@
 import config from '../../config.js';
 import getHeaders from '../../utils/get-headers.js';
 const { functions } = config.server;
-export async function logs(id, auth) {
-    const response = await fetch(`${functions}vX/functions/${id}/logs`, {
+export async function logs(id, options, auth) {
+    const { limit } = options;
+    const response = await fetch(`${functions}vX/functions/${id}/logs?limit=${limit}`, {
         headers: getHeaders(auth),
         method: 'GET',
     });
@@ -11,5 +12,6 @@ export async function logs(id, auth) {
         ok: response.ok,
         error: response.ok ? null : json?.error?.message,
         logs: response.ok ? json.logs : [],
+        total: response.ok ? json.total : 0,
     };
 }

package/dist/commands/functions/invoke.js

@@ -11,8 +11,8 @@ export default class Invoke extends Command {
     };
     static description = 'Invoke a remote Sanity Function';
     static examples = [
-        `<%= config.bin %> <%= command.id %> <ID> --data '{ "id": 1 }'`,
-        `<%= config.bin %> <%= command.id %> <ID> --file 'payload.json'`,
+        `<%= config.bin %> <%= command.id %> <name> --data '{ "id": 1 }'`,
+        `<%= config.bin %> <%= command.id %> <name> --file 'payload.json'`,
     ];
     static flags = {
         data: Flags.string({ char: 'd', description: 'Data to send to the function', required: false }),

package/dist/commands/functions/logs.d.ts

@@ -5,5 +5,9 @@ export default class Logs extends Command {
     };
     static description: string;
     static examples: string[];
+    static flags: {
+        limit: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        json: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
     run(): Promise<void>;
 }

package/dist/commands/functions/logs.js

@@ -1,4 +1,4 @@
-import { Args, Command } from '@oclif/core';
+import { Args, Command, Flags } from '@oclif/core';
 import Spinner from 'yocto-spinner';
 import { readBlueprintOnDisk } from '../../actions/blueprints/blueprint.js';
 import { logs as logsAction } from '../../actions/functions/logs.js';
@@ -10,7 +10,7 @@ function logLevel(level) {
     if (level === 'ERROR') {
         return red(level);
     }
-    if (level === 'ERROR') {
+    if (level === 'WARN') {
         return yellow(level);
     }
     return green(level);
@@ -20,16 +20,33 @@ export default class Logs extends Command {
         name: Args.string({ description: 'The name of the Sanity Function', required: true }),
     };
     static description = 'Retrieve logs for a Sanity Function';
-    static examples = ['<%= config.bin %> <%= command.id %> <ID>'];
+    static examples = [
+        '<%= config.bin %> <%= command.id %> <name>',
+        '<%= config.bin %> <%= command.id %> <name> --json',
+        '<%= config.bin %> <%= command.id %> <name> --limit 100',
+    ];
+    static flags = {
+        limit: Flags.integer({
+            char: 'l',
+            description: 'Total number of log entries to retrieve',
+            required: false,
+            default: 50,
+        }),
+        json: Flags.boolean({
+            char: 'j',
+            description: 'Return logs in JSON format',
+            required: false,
+        }),
+    };
     async run() {
-        const { args } = await this.parse(Logs);
+        const { args, flags } = await this.parse(Logs);
         const spinner = Spinner({ text: `Finding logs for function "${args.name}"` }).start();
         const { deployedStack } = await readBlueprintOnDisk({ getStack: true, token: config.token });
         if (!deployedStack)
             this.error('Stack not found'); // returns
-        const { name, projectId } = deployedStack;
+        const { projectId } = deployedStack;
         const { externalId } = findFunctionByName(deployedStack, args.name);
-        const { ok, error, logs } = await logsAction(externalId, { token: config.token, projectId });
+        const { ok, error, logs, total } = await logsAction(externalId, { limit: flags.limit }, { token: config.token, projectId });
         if (!ok) {
             spinner.error(`${red('Failed')} to retrieve logs`);
             this.log(`Error: ${error || 'Unknown error'}`);
@@ -41,11 +58,20 @@ export default class Logs extends Command {
             return;
         }
         spinner.success(`${formatTitle('Function', args.name)} Logs`);
-        this.log(`Found ${bold(filteredLogs.length.toString())} log entries for function ${yellow(args.name)}\n`);
-        for (const log of filteredLogs) {
-            const { time, level, message } = log;
-            const date = new Date(time);
-            this.log(`${bold(date.toLocaleDateString())} ${bold(blue(date.toLocaleTimeString()))} ${logLevel(level)} ${message}`);
+        if (!flags.json) {
+            this.log(`Found ${bold(total)} log entries for function ${yellow(args.name)}`);
+            if (logs.length < total) {
+                this.log(`Here are the last ${bold(filteredLogs.length.toString())} entries`);
+            }
+            this.log('\n');
+            for (const log of filteredLogs) {
+                const { time, level, message } = log;
+                const date = new Date(time);
+                this.log(`${bold(date.toLocaleDateString())} ${bold(blue(date.toLocaleTimeString()))} ${logLevel(level)} ${message}`);
+            }
+        }
+        else {
+            this.log(JSON.stringify(filteredLogs, null, 2));
         }
     }
 }

package/dist/commands/functions/test.js

@@ -8,9 +8,9 @@ export default class Test extends Command {
     };
     static description = 'Invoke a local Sanity Function';
     static examples = [
-        `<%= config.bin %> <%= command.id %> echo-fn --data '{ "id": 1 }'`,
-        `<%= config.bin %> <%= command.id %> echo-fn --file 'payload.json'`,
-        `<%= config.bin %> <%= command.id %> echo-fn --data '{ "id": 1 }' --timeout 60`,
+        `<%= config.bin %> <%= command.id %> <name> --data '{ "id": 1 }'`,
+        `<%= config.bin %> <%= command.id %> <name> --file 'payload.json'`,
+        `<%= config.bin %> <%= command.id %> <name> --data '{ "id": 1 }' --timeout 60`,
     ];
     static flags = {
         data: Flags.string({ char: 'd', description: 'Data to send to the function', required: false }),

package/dist/utils/format-error.d.ts

@@ -0,0 +1,4 @@
+import type { BlueprintError } from './types.js';
+export default function formatError(response: Response, json: {
+    error: BlueprintError;
+}): string | null;

package/dist/utils/format-error.js

@@ -0,0 +1,9 @@
+export default function formatError(response, json) {
+    if (response.ok) {
+        return null;
+    }
+    if (response.status === 401 || response.status === 403) {
+        return 'Please login to the Sanity CLI to run this command';
+    }
+    return json?.error?.message || 'Unknown Error';
+}

package/oclif.manifest.json

@@ -274,8 +274,8 @@
       },
       "description": "Invoke a remote Sanity Function",
       "examples": [
-        "<%= config.bin %> <%= command.id %> <ID> --data '{ \"id\": 1 }'",
-        "<%= config.bin %> <%= command.id %> <ID> --file 'payload.json'"
+        "<%= config.bin %> <%= command.id %> <name> --data '{ \"id\": 1 }'",
+        "<%= config.bin %> <%= command.id %> <name> --file 'payload.json'"
       ],
       "flags": {
         "data": {
@@ -324,9 +324,30 @@
       },
       "description": "Retrieve logs for a Sanity Function",
       "examples": [
-        "<%= config.bin %> <%= command.id %> <ID>"
+        "<%= config.bin %> <%= command.id %> <name>",
+        "<%= config.bin %> <%= command.id %> <name> --json",
+        "<%= config.bin %> <%= command.id %> <name> --limit 100"
       ],
-      "flags": {},
+      "flags": {
+        "limit": {
+          "char": "l",
+          "description": "Total number of log entries to retrieve",
+          "name": "limit",
+          "required": false,
+          "default": 50,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "json": {
+          "char": "j",
+          "description": "Return logs in JSON format",
+          "name": "json",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
       "id": "functions:logs",
@@ -354,9 +375,9 @@
       },
       "description": "Invoke a local Sanity Function",
       "examples": [
-        "<%= config.bin %> <%= command.id %> echo-fn --data '{ \"id\": 1 }'",
-        "<%= config.bin %> <%= command.id %> echo-fn --file 'payload.json'",
-        "<%= config.bin %> <%= command.id %> echo-fn --data '{ \"id\": 1 }' --timeout 60"
+        "<%= config.bin %> <%= command.id %> <name> --data '{ \"id\": 1 }'",
+        "<%= config.bin %> <%= command.id %> <name> --file 'payload.json'",
+        "<%= config.bin %> <%= command.id %> <name> --data '{ \"id\": 1 }' --timeout 60"
       ],
       "flags": {
         "data": {
@@ -481,5 +502,5 @@
       ]
     }
   },
-  "version": "2.2.0"
+  "version": "2.3.0"
 }

package/package.json

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