@sanity/runtime-cli 10.10.0 → 10.11.1

package/dist/cores/blueprints/init.js

@@ -38,7 +38,8 @@ export async function blueprintInitCore(options) {
             // * 3. create empty stack with name from example name
             const stack = await createEmptyStack({
                 token,
-                projectId,
+                scopeType: 'project',
+                scopeId: projectId,
                 name: `example-${flagExample}`,
                 projectBased: false,
             });
@@ -106,17 +107,17 @@ export async function blueprintInitCore(options) {
             // using --stack-name gets around "LAUNCH LIMIT: 1 Stack per Project"
             const stack = await createEmptyStack({
                 token,
-                projectId,
+                scopeType: 'project',
+                scopeId: projectId,
                 name: flagStackName,
                 projectBased: false,
             });
             stackId = stack.id;
         }
-        const auth = { token: token, projectId };
         if (!stackId) {
             // LAUNCH LIMIT: 1 Stack per Project - do not prompt for Stack, just create one
             if (LAUNCH_LIMIT_STACK_PER_PROJECT) {
-                await createProjectBasedStack(auth, token, log);
+                await createProjectBasedStack({ token, scopeType: 'project', scopeId: projectId }, log);
                 // do not set stackId, to avoid saving it to the config file
             }
             else {
@@ -175,10 +176,17 @@ async function promptForBlueprintType() {
     return pickedBlueprintsType;
 }
 // LAUNCH LIMIT: 1 Stack per Project - create exclusive stack for project
-async function createProjectBasedStack(auth, token, log) {
-    const { projectId } = auth;
+async function createProjectBasedStack(auth, log) {
+    if (auth.scopeType !== 'project') {
+        throw new Error('Auth must be for a project');
+    }
+    const { scopeId: projectId, token } = auth;
     // get project
-    const { ok: projectOk, project } = await getProject(auth);
+    const { ok: projectOk, project } = await getProject({
+        token: auth.token,
+        scopeType: 'project',
+        scopeId: projectId,
+    });
     if (!projectOk) {
         throw new Error('Failed to find Project while creating Stack');
     }
@@ -196,7 +204,8 @@ async function createProjectBasedStack(auth, token, log) {
     // if not, create a stack
     const stack = await createEmptyStack({
         token,
-        projectId,
+        scopeType: 'project',
+        scopeId: projectId,
         name: projectDisplayName,
     });
     return stack;

package/dist/cores/blueprints/plan.js

@@ -7,7 +7,10 @@ export async function blueprintPlanCore(options) {
     log(`${chalk.bold.blueBright('Blueprint Deployment Plan')} ${chalk.dim(`(${fileInfo.fileName})`)}`);
     log(formatResourceTree(parsedBlueprint.resources));
     if (token && projectId && stackId) {
-        const stackResponse = await getStack({ stackId, auth: { token, projectId } });
+        const stackResponse = await getStack({
+            auth: { token, scopeType: 'project', scopeId: projectId },
+            stackId,
+        });
         if (!stackResponse.ok) {
             log(chalk.dim('Unable to retrieve live deployment for comparison'));
         }

package/dist/cores/blueprints/stacks.js

@@ -11,7 +11,7 @@ export async function blueprintStacksCore(options) {
         return { success: false, error: 'No Project ID provided' };
     }
     try {
-        const { ok, stacks, error } = await listStacks({ token, projectId });
+        const { ok, stacks, error } = await listStacks({ token, scopeType: 'project', scopeId: projectId });
         if (!ok)
             return { success: false, error: error || 'Failed to list stacks' };
         if (!stacks || stacks.length === 0) {

package/dist/cores/index.d.ts

@@ -19,6 +19,9 @@ export interface DeployedBlueprintConfig extends BlueprintConfig {
     deployedStack: Stack;
 }
 export type CoreResult = {
+    /** Arbitrary data for isolated testing */
+    data?: Record<string, unknown>;
+} & ({
     /** Something went wrong. */
     success: false;
     /** The error message, if the operation failed. */
@@ -30,7 +33,7 @@ export type CoreResult = {
     /** The streaming function, if the operation is streaming. */
     streaming?: Promise<void>;
     error?: never;
-};
+});
 type InitBlueprintConfigParams = {
     bin: string;
     log: (msg: string) => void;

package/dist/cores/index.js

@@ -48,7 +48,7 @@ export async function initDeployedBlueprintConfig(config) {
         if (!stackId)
             return { ok: false, error: 'Missing deployment configuration for Blueprint' };
     }
-    const auth = { token: config.token, projectId };
+    const auth = { token: config.token, scopeType: 'project', scopeId: projectId };
     const stackResponse = await getStack({ stackId, auth });
     if (!stackResponse.ok) {
         config.log(`Could not retrieve deployment info for ${niceId(stackId)}. Was it destroyed?`);

package/dist/utils/display/prompt.js

@@ -54,7 +54,7 @@ export async function promptForProject({ token, knownOrganizationId, knownProjec
     return pickedProject;
 }
 export async function promptForStackId({ projectId, token, }) {
-    const { ok: stacksOk, error: stacksErr, stacks } = await listStacks({ token, projectId });
+    const { ok: stacksOk, error: stacksErr, stacks, } = await listStacks({ token, scopeType: 'project', scopeId: projectId });
     if (!stacksOk) {
         throw new Error(stacksErr || 'Failed to list Stacks');
     }
@@ -87,7 +87,8 @@ export async function promptForStackId({ projectId, token, }) {
         ]);
         const stack = await createEmptyStack({
             token,
-            projectId,
+            scopeType: 'project',
+            scopeId: projectId,
             name: stackName,
         });
         return stack.id;

package/dist/utils/get-headers.d.ts

@@ -1,9 +1,9 @@
 import type { AuthParams } from './types.js';
-export default function getHeaders({ token, projectId }: AuthParams): {
+export default function getHeaders({ token, scopeId, scopeType }: AuthParams): {
     Accept: string;
     'Content-Type': string;
     Authorization: string;
-    'X-Sanity-Scope-Type': string;
+    'X-Sanity-Scope-Type': import("./types.js").ScopeType;
     'X-Sanity-Scope-Id': string;
     'User-Agent': string;
 };

package/dist/utils/get-headers.js

@@ -1,20 +1,12 @@
-const userAgent = await getUserAgent();
-async function getUserAgent() {
-    try {
-        const pkg = await (await import('../../package.json', { with: { type: 'json' } })).default;
-        return `${pkg.name}@${pkg.version}`;
-    }
-    catch {
-        return 'unknown@0.0.0';
-    }
-}
-export default function getHeaders({ token, projectId }) {
+import pkg from '../../package.json' with { type: 'json' };
+const userAgent = `${pkg.name}@${pkg.version}`;
+export default function getHeaders({ token, scopeId, scopeType }) {
     return {
         Accept: 'application/json',
         'Content-Type': 'application/json',
         Authorization: `Bearer ${token}`,
-        'X-Sanity-Scope-Type': 'project',
-        'X-Sanity-Scope-Id': projectId,
+        'X-Sanity-Scope-Type': scopeType,
+        'X-Sanity-Scope-Id': scopeId,
         'User-Agent': userAgent,
     };
 }

package/dist/utils/types.d.ts

@@ -11,7 +11,8 @@ export type Result<T, E = string> = {
 /** @internal */
 export interface AuthParams {
     token: string;
-    projectId: string;
+    scopeType: ScopeType;
+    scopeId: string;
 }
 /** @internal */
 export interface GroqRule {
@@ -55,7 +56,8 @@ export interface Stack {
     id: string;
     name: string;
     displayName: string;
-    projectId: string;
+    scopeType: ScopeType;
+    scopeId: string;
     resources: Array<DeployedResource>;
     createdAt?: string;
     updatedAt?: string;
@@ -71,7 +73,8 @@ export interface StackOperation {
 /** @internal */
 export interface StackMutation {
     name: string;
-    projectId: string;
+    scopeType: ScopeType;
+    scopeId: string;
     document: Blueprint;
     useProjectBasedId?: boolean;
 }

package/dist/utils/validate/resource.js

@@ -1,7 +1,7 @@
 import { BlueprintParserErrorType } from '../types.js';
 export function validateFunctionName(name) {
-    // must be 6+ characters, no special characters, no spaces, allow _ and -
-    return /^[a-zA-Z0-9][a-zA-Z0-9_-]{5,}$/.test(name);
+    // must be 3+ characters, no special characters, no spaces, allow _ and -
+    return /^[a-zA-Z0-9][a-zA-Z0-9_-]{2,}$/.test(name);
 }
 const validFunctionEventNames = ['publish', 'create', 'update', 'delete'];
 export function validateFunctionResource(resource) {
@@ -10,7 +10,7 @@ export function validateFunctionResource(resource) {
     const errors = [];
     if (!validateFunctionName(resource.name)) {
         errors.push({
-            message: `${msgPrefix} Function name must be at least 6 characters, start with a letter or number, and only contain letters, numbers, _ or -`,
+            message: `${msgPrefix} Function name must be at least 3 characters, start with a letter or number, and only contain letters, numbers, _ or -`,
             type: BlueprintParserErrorType.InvalidProperty,
         });
     }

package/oclif.manifest.json

@@ -351,6 +351,42 @@
         "destroy.js"
       ]
     },
+    "blueprints:doctor": {
+      "aliases": [],
+      "args": {},
+      "description": "Diagnose potential issues with Blueprint configuration",
+      "examples": [],
+      "flags": {
+        "verbose": {
+          "description": "Provide detailed information about issues",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "path": {
+          "description": "Path to the Blueprint configuration file",
+          "name": "path",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "blueprints:doctor",
+      "pluginAlias": "@sanity/runtime-cli",
+      "pluginName": "@sanity/runtime-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "blueprints",
+        "doctor.js"
+      ]
+    },
     "blueprints:info": {
       "aliases": [],
       "args": {},
@@ -1141,5 +1177,5 @@
       ]
     }
   },
-  "version": "10.10.0"
+  "version": "10.11.1"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sanity/runtime-cli",
   "description": "Sanity's Runtime CLI for Blueprints and Functions",
-  "version": "10.10.0",
+  "version": "10.11.1",
   "author": "Sanity Runtime Team",
   "type": "module",
   "license": "MIT",
@@ -71,6 +71,7 @@
     "test": "vitest run",
     "test:depmgmt": "vitest run --config ./test-depmgmt/vitest.config.ts",
     "test:integration": "cd test/integration && npm run typecheck",
+    "typecheck": "tsc --project tsconfig.typecheck.json",
     "posttest": "npm run lint",
     "test:watch": "vitest",
     "watch": "tsc --watch"

package/dist/server/static/api.d.ts

@@ -1,24 +0,0 @@
-export default function API(): {
-    blueprint: typeof blueprint;
-    document: typeof document;
-    invoke: typeof invoke;
-    projects: typeof projects;
-    datasets: typeof datasets;
-    store: any;
-    subscribe: any;
-    unsubscribe: any;
-};
-declare function blueprint(): void;
-declare function document({ projectId, dataset, docId }: {
-    projectId: any;
-    dataset: any;
-    docId: any;
-}): Promise<void>;
-declare function invoke({ context, event, metadata }: {
-    context: any;
-    event: any;
-    metadata: any;
-}): void;
-declare function projects(): void;
-declare function datasets(selectedProject: any): void;
-export {};

package/dist/server/static/components/api-base.d.ts

@@ -1,20 +0,0 @@
-export class ApiBaseElement extends HTMLElement {
-    api: {
-        blueprint: () => void;
-        document: ({ projectId, dataset, docId }: {
-            projectId: any;
-            dataset: any;
-            docId: any;
-        }) => Promise<void>;
-        invoke: ({ context, event, metadata }: {
-            context: any;
-            event: any;
-            metadata: any;
-        }) => void;
-        projects: () => void;
-        datasets: (selectedProject: any) => void;
-        store: any;
-        subscribe: any;
-        unsubscribe: any;
-    };
-}

package/dist/server/static/components/clear-button.d.ts

@@ -1,6 +0,0 @@
-export class ClearButton extends ApiBaseElement {
-    connectedCallback(): void;
-    disconnectedCallback(): void;
-    clear: () => void;
-}
-import { ApiBaseElement } from './api-base.js';

package/dist/server/static/components/codemirror-theme.d.ts

@@ -1,6 +0,0 @@
-export const sanityHighlightStyle: HighlightStyle;
-export const sanityCodeMirrorTheme: {
-    inner: any;
-    prec: any;
-}[][];
-import { HighlightStyle } from '../vendor/vendor.bundle.js';

package/dist/server/static/components/console-panel.d.ts

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

package/dist/server/static/components/fetch-button.d.ts

@@ -1,7 +0,0 @@
-export class FetchButton extends ApiBaseElement {
-    connectedCallback(): void;
-    button: HTMLButtonElement | null | undefined;
-    disconnectedCallback(): void;
-    fetchDoc: () => Promise<void>;
-}
-import { ApiBaseElement } from './api-base.js';

package/dist/server/static/components/filters.d.ts

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

package/dist/server/static/components/function-list.d.ts

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

package/dist/server/static/components/help-button.d.ts

@@ -1,3 +0,0 @@
-export class HelpButton extends ApiBaseElement {
-}
-import { ApiBaseElement } from './api-base.js';

package/dist/server/static/components/network-spinner.d.ts

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

package/dist/server/static/components/payload-panel.d.ts

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

package/dist/server/static/components/response-panel.d.ts

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

package/dist/server/static/components/rule-panel.d.ts

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

package/dist/server/static/components/run-panel.d.ts

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

package/dist/server/static/components/select-dropdown.d.ts

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

package/dist/server/static/components/toggle-switch.d.ts

@@ -1,11 +0,0 @@
-export class ToggleSwitch extends ApiBaseElement {
-    static get observedAttributes(): string[];
-    connectedCallback(): void;
-    toggleKey: string | null | undefined;
-    disconnectedCallback(): void;
-    attributeChangedCallback(name: any): void;
-    set checked(value: boolean);
-    get checked(): boolean;
-    toggle: () => void;
-}
-import { ApiBaseElement } from './api-base.js';

package/dist/server/static/hot-reload.d.ts

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