@sanity/runtime-cli 3.0.0 → 3.1.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/3.0.0 linux-x64 node-v22.14.0
+@sanity/runtime-cli/3.1.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/v3.0.0/src/commands/blueprints/add.ts)_
+_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v3.1.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/v3.0.0/src/commands/blueprints/config.ts)_
+_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v3.1.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/v3.0.0/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v3.1.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/v3.0.0/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v3.1.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/v3.0.0/src/commands/blueprints/init.ts)_
+_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v3.1.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/v3.0.0/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v3.1.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/v3.0.0/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v3.1.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/v3.0.0/src/commands/blueprints/stacks.ts)_
+_See code: [src/commands/blueprints/stacks.ts](https://github.com/sanity-io/runtime-cli/blob/v3.1.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/v3.0.0/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v3.1.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/v3.0.0/src/commands/functions/env/add.ts)_
+_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v3.1.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/v3.0.0/src/commands/functions/env/remove.ts)_
+_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v3.1.0/src/commands/functions/env/remove.ts)_
 
 ## `sanity-run functions invoke NAME`
 
@@ -286,25 +286,27 @@ EXAMPLES
   $ sanity-run functions invoke <name> --file 'payload.json'
 ```
 
-_See code: [src/commands/functions/invoke.ts](https://github.com/sanity-io/runtime-cli/blob/v3.0.0/src/commands/functions/invoke.ts)_
+_See code: [src/commands/functions/invoke.ts](https://github.com/sanity-io/runtime-cli/blob/v3.1.0/src/commands/functions/invoke.ts)_
 
 ## `sanity-run functions logs NAME`
 
-Retrieve logs for a Sanity Function
+Retrieve or delete logs for a Sanity Function
 
 ```
 USAGE
-  $ sanity-run functions logs NAME [-l <value>] [-j]
+  $ sanity-run functions logs NAME [-f [-d | -l <value> | -j]]
 
 ARGUMENTS
   NAME  The name of the Sanity Function
 
 FLAGS
+  -d, --delete         Delete all logs for the function
+  -f, --force          Skip confirmation for deleting logs
   -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
+  Retrieve or delete logs for a Sanity Function
 
 EXAMPLES
   $ sanity-run functions logs <name>
@@ -312,9 +314,11 @@ EXAMPLES
   $ sanity-run functions logs <name> --json
 
   $ sanity-run functions logs <name> --limit 100
+
+  $ sanity-run functions logs <name> --delete
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v3.0.0/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v3.1.0/src/commands/functions/logs.ts)_
 
 ## `sanity-run functions test NAME`
 
@@ -347,7 +351,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/v3.0.0/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v3.1.0/src/commands/functions/test.ts)_
 
 ## `sanity-run help [COMMAND]`
 

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

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

package/dist/actions/functions/logs.js

@@ -15,3 +15,14 @@ export async function logs(id, options, auth) {
         total: response.ok ? json.total : 0,
     };
 }
+export async function deleteLogs(id, auth) {
+    const response = await fetch(`${functions}vX/functions/${id}/logs`, {
+        headers: getHeaders(auth),
+        method: 'DELETE',
+    });
+    const json = response.ok ? null : await response.json();
+    return {
+        ok: response.ok,
+        error: response.ok ? null : json?.error?.message,
+    };
+}

package/dist/commands/blueprints/deploy.js

@@ -6,6 +6,7 @@ import { readBlueprintOnDisk, writeConfigFile } from '../../actions/blueprints/b
 import { createStack, updateStack } from '../../actions/blueprints/stacks.js';
 import config from '../../config.js';
 import { bold, green, red, yellow } from '../../utils/display/colors.js';
+import { isLocalFunctionResource } from '../../utils/types.js';
 const { token } = config;
 export default class Deploy extends Command {
     static description = 'Deploy a Blueprint';
@@ -50,7 +51,7 @@ export default class Deploy extends Command {
         if (!name)
             this.error('Stack name is required');
         const validResources = resources?.filter((r) => r.type);
-        const functionResources = validResources?.filter((r) => r.type.startsWith('sanity.function.'));
+        const functionResources = validResources?.filter(isLocalFunctionResource);
         // First stash all function assets
         if (functionResources?.length) {
             for (const resource of functionResources) {

package/dist/commands/functions/invoke.js

@@ -33,6 +33,9 @@ export default class Invoke extends Command {
         const result = await invoke(externalId, { data: flags.data, file: flags.file }, { token: config.token, projectId });
         if (result.ok) {
             spinner.success(`Invocation of ${args.name} succeeded`);
+            if (result.json?.data?.type === 'Buffer') {
+                return;
+            }
             this.log(JSON.stringify(result.json, null, 2));
         }
         else {

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

@@ -1,4 +1,11 @@
 import { Command } from '@oclif/core';
+type RunDeleteOptions = {
+    force: boolean;
+};
+type RunGetOptions = {
+    limit: number;
+    json?: boolean;
+};
 export default class Logs extends Command {
     static args: {
         name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
@@ -8,6 +15,11 @@ export default class Logs extends Command {
     static flags: {
         limit: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
         json: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        delete: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;
+    runDeleteLogs(name: string, options: RunDeleteOptions): Promise<void>;
+    runGetLogs(name: string, options: RunGetOptions): Promise<void>;
 }
+export {};

package/dist/commands/functions/logs.js

@@ -1,7 +1,8 @@
 import { Args, Command, Flags } from '@oclif/core';
+import inquirer from 'inquirer';
 import Spinner from 'yocto-spinner';
 import { readBlueprintOnDisk } from '../../actions/blueprints/blueprint.js';
-import { logs as logsAction } from '../../actions/functions/logs.js';
+import { deleteLogs as deleteLogsAction, logs as logsAction } from '../../actions/functions/logs.js';
 import config from '../../config.js';
 import { formatTitle } from '../../utils/display/blueprints-formatting.js';
 import { blue, bold, green, red, yellow } from '../../utils/display/colors.js';
@@ -15,15 +16,26 @@ function logLevel(level) {
     }
     return green(level);
 }
+// TODO extract to a shared module
+async function getProjectAndExternalId(name) {
+    const { deployedStack } = await readBlueprintOnDisk({ getStack: true, token: config.token });
+    if (!deployedStack) {
+        return {};
+    }
+    const { projectId } = deployedStack;
+    const { externalId } = findFunctionByName(deployedStack, name);
+    return { projectId, externalId };
+}
 export default class Logs extends Command {
     static args = {
         name: Args.string({ description: 'The name of the Sanity Function', required: true }),
     };
-    static description = 'Retrieve logs for a Sanity Function';
+    static description = 'Retrieve or delete logs for a Sanity Function';
     static examples = [
         '<%= config.bin %> <%= command.id %> <name>',
         '<%= config.bin %> <%= command.id %> <name> --json',
         '<%= config.bin %> <%= command.id %> <name> --limit 100',
+        '<%= config.bin %> <%= command.id %> <name> --delete',
     ];
     static flags = {
         limit: Flags.integer({
@@ -37,16 +49,61 @@ export default class Logs extends Command {
             description: 'Return logs in JSON format',
             required: false,
         }),
+        delete: Flags.boolean({
+            char: 'd',
+            exclusive: ['limit', 'json'],
+            description: 'Delete all logs for the function',
+            required: false,
+        }),
+        force: Flags.boolean({
+            char: 'f',
+            dependsOn: ['delete'],
+            description: 'Skip confirmation for deleting logs',
+            required: false,
+        }),
     };
     async run() {
         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 { projectId } = deployedStack;
-        const { externalId } = findFunctionByName(deployedStack, args.name);
-        const { ok, error, logs, total } = await logsAction(externalId, { limit: flags.limit }, { token: config.token, projectId });
+        if (flags.delete === true) {
+            await this.runDeleteLogs(args.name, flags);
+        }
+        else {
+            await this.runGetLogs(args.name, flags);
+        }
+    }
+    async runDeleteLogs(name, options) {
+        if (!options.force) {
+            const { certain } = await inquirer.prompt({
+                type: 'confirm',
+                name: 'certain',
+                message: `Are you sure you want to delete ${bold('all')} logs for function ${yellow(name)}?`,
+                default: false,
+            });
+            if (!certain)
+                return;
+        }
+        const { projectId, externalId } = await getProjectAndExternalId(name);
+        if (!projectId || !externalId) {
+            this.error('Stack not found');
+            return;
+        }
+        const spinner = Spinner({ text: `Deleting logs for function ${yellow(name)}` }).start();
+        const { ok, error } = await deleteLogsAction(externalId, { token: config.token, projectId });
+        if (!ok) {
+            spinner.error(`${red('Failed')} to retrieve logs`);
+            this.log(`Error: ${error || 'Unknown error'}`);
+            return;
+        }
+        spinner.success('Logs deleted');
+    }
+    async runGetLogs(name, options) {
+        const spinner = Spinner({ text: `Finding logs for function "${name}"` }).start();
+        const { projectId, externalId } = await getProjectAndExternalId(name);
+        if (!projectId || !externalId) {
+            this.error('Stack not found');
+            return;
+        }
+        const { ok, error, logs, total } = await logsAction(externalId, { limit: options.limit }, { token: config.token, projectId });
         if (!ok) {
             spinner.error(`${red('Failed')} to retrieve logs`);
             this.log(`Error: ${error || 'Unknown error'}`);
@@ -54,12 +111,12 @@ export default class Logs extends Command {
         }
         const filteredLogs = logs.filter((entry) => entry.level && entry.message);
         if (filteredLogs.length === 0) {
-            spinner.info(`No logs found for function ${args.name}`);
+            spinner.info(`No logs found for function ${name}`);
             return;
         }
-        spinner.success(`${formatTitle('Function', args.name)} Logs`);
-        if (!flags.json) {
-            this.log(`Found ${bold(total)} log entries for function ${yellow(args.name)}`);
+        spinner.success(`${formatTitle('Function', name)} Logs`);
+        if (!options.json) {
+            this.log(`Found ${bold(total)} log entries for function ${yellow(name)}`);
             if (logs.length < total) {
                 this.log(`Here are the last ${bold(filteredLogs.length.toString())} entries`);
             }

package/dist/utils/find-function.d.ts

@@ -1,3 +1,4 @@
 import type { LocalBlueprint, LocalFunctionResource, Stack, StackFunctionResource } from './types.js';
-export declare function findFunctionByName(blueprintOrStack: LocalBlueprint | Stack, name: string): LocalFunctionResource | StackFunctionResource;
+export declare function findFunctionByName(blueprintOrStack: LocalBlueprint, name: string): LocalFunctionResource;
+export declare function findFunctionByName(blueprintOrStack: Stack, name: string): StackFunctionResource;
 export declare function getFunctionSource(blueprintOrStack: LocalBlueprint | Stack, name: string): string;

package/dist/utils/types.d.ts

@@ -15,8 +15,8 @@ export interface LocalResource {
     name: string;
     type: string;
     displayName?: string;
-    [key: string]: unknown;
 }
+export declare function isLocalFunctionResource(r: LocalResource): r is LocalFunctionResource;
 /** @internal */
 export interface LocalFunctionResource extends LocalResource {
     src?: string;

package/dist/utils/types.js

@@ -1,3 +1,6 @@
+export function isLocalFunctionResource(r) {
+    return r.type.startsWith('sanity.function.');
+}
 /** @internal */
 export var BlueprintParserErrorType;
 (function (BlueprintParserErrorType) {

package/oclif.manifest.json

@@ -322,11 +322,12 @@
           "required": true
         }
       },
-      "description": "Retrieve logs for a Sanity Function",
+      "description": "Retrieve or delete logs for a Sanity Function",
       "examples": [
         "<%= config.bin %> <%= command.id %> <name>",
         "<%= config.bin %> <%= command.id %> <name> --json",
-        "<%= config.bin %> <%= command.id %> <name> --limit 100"
+        "<%= config.bin %> <%= command.id %> <name> --limit 100",
+        "<%= config.bin %> <%= command.id %> <name> --delete"
       ],
       "flags": {
         "limit": {
@@ -346,6 +347,29 @@
           "required": false,
           "allowNo": false,
           "type": "boolean"
+        },
+        "delete": {
+          "char": "d",
+          "description": "Delete all logs for the function",
+          "exclusive": [
+            "limit",
+            "json"
+          ],
+          "name": "delete",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "force": {
+          "char": "f",
+          "dependsOn": [
+            "delete"
+          ],
+          "description": "Skip confirmation for deleting logs",
+          "name": "force",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -527,5 +551,5 @@
       ]
     }
   },
-  "version": "3.0.0"
+  "version": "3.1.0"
 }

package/package.json

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