@sanity/runtime-cli 11.0.3 → 11.1.0

package/dist/utils/invoke-local.js

@@ -45,11 +45,17 @@ export async function applyGroqRule(resource, data, before, after, projectId, da
         const hasProjection = event.projection?.length;
         const projection = hasProjection ? `${event?.projection}` : '';
         const query = `*[${event?.filter}]${projection}`;
-        const rule = groq.parse(query, { mode: 'delta' });
-        const sanity = projectId && dataset ? { projectId, dataset } : undefined;
-        const queryResults = await groq.evaluate(rule, { dataset: [data], before, after, sanity });
-        const currentFunctionDocumentSet = await queryResults.get();
-        return currentFunctionDocumentSet[0];
+        try {
+            const rule = groq.parse(query, { mode: 'delta' });
+            const sanity = projectId && dataset ? { projectId, dataset } : undefined;
+            const queryResults = await groq.evaluate(rule, { dataset: [data], before, after, sanity });
+            const currentFunctionDocumentSet = await queryResults.get();
+            return currentFunctionDocumentSet[0];
+        }
+        catch (groqErr) {
+            const detail = groqErr instanceof Error && `; ${groqErr.message}`;
+            throw new Error(`Invalid rule configuration: ${query}${detail}`, { cause: groqErr });
+        }
     }
     // default groq rule so just return the data
     return data;

package/dist/utils/types.d.ts

@@ -15,17 +15,26 @@ export interface AuthParams {
     scopeId: string;
 }
 /** @internal */
-export interface GroqRule {
+export type GroqRule = GroqRuleDocumentFunction | GroqRuleMediaLibraryFunction;
+export interface GroqRuleBase {
     on: Array<string>;
     filter?: string;
+    projection?: string;
+}
+interface GroqRuleDocumentFunction extends GroqRuleBase {
     includeDrafts?: boolean;
     includeAllVersions?: boolean;
-    projection?: string;
     resource?: {
         type: 'dataset';
         id: string;
     };
 }
+interface GroqRuleMediaLibraryFunction extends GroqRuleBase {
+    resource: {
+        type: 'media-library';
+        id: string;
+    };
+}
 /** @internal */
 export interface Resource {
     name: string;
@@ -38,16 +47,27 @@ export interface DeployedResource extends Resource {
     id: string;
     externalId: string;
 }
-export declare function isLocalFunctionResource(r: Resource): r is FunctionResource;
+export declare function isLocalFunctionResource<T extends Resource>(r: T): r is T & FunctionResourceBase;
+export declare function isDocumentFunctionResource<T extends Resource>(r: T): r is T & FunctionResourceDocument;
+export declare function isMediaLibraryAssetFunctionResource<T extends Resource>(r: T): r is T & FunctionResourceMediaLibraryAsset;
 /** @internal */
-export interface FunctionResource extends Resource {
+export type FunctionResource = FunctionResourceDocument | FunctionResourceMediaLibraryAsset | FunctionResourceBase;
+export interface FunctionResourceBase extends Resource {
     src?: string;
     autoResolveDeps?: boolean;
     transpile?: boolean;
     memory?: number;
     timeout?: number;
     env?: Record<string, string>;
-    event?: GroqRule;
+    event?: GroqRuleBase;
+}
+interface FunctionResourceDocument extends FunctionResourceBase {
+    type: 'sanity.function.document';
+    event?: GroqRuleDocumentFunction;
+}
+interface FunctionResourceMediaLibraryAsset extends FunctionResourceBase {
+    type: 'sanity.function.media-library.asset';
+    event: GroqRuleMediaLibraryFunction;
 }
 export interface CorsResource extends Resource {
     origin?: string;
@@ -102,6 +122,14 @@ export interface InvokeContextOptions {
         organizationId?: string;
         token?: string;
     };
+    /** The resource type of the event source; resource type that invoked the function. */
+    eventResourceType: string;
+    /** The resource ID of the event source; resource ID that invoked the function. */
+    eventResourceId: string;
+    /** The resource type of the function container; resource type that houses the function. */
+    functionResourceType: string;
+    /** The resource ID of the function container; resource ID that houses the function. */
+    functionResourceId: string;
 }
 /** @internal */
 export interface InvokeExecutionOptions {
@@ -152,3 +180,11 @@ export interface BlueprintParserError {
     message: string;
     type: string;
 }
+/** @internal */
+export declare interface FetchConfig {
+    mediaLibraryId?: string;
+    token?: string;
+    apiHost?: string;
+    apiVersion?: string;
+}
+export {};

package/dist/utils/types.js

@@ -1,6 +1,14 @@
 export function isLocalFunctionResource(r) {
     return r.type.startsWith('sanity.function.');
 }
+// annoyed that checking for equality on `type` isnt sufficient to narrow down to a specific type from a union
+// instead need to use these type predicated
+export function isDocumentFunctionResource(r) {
+    return r.type === 'sanity.function.document';
+}
+export function isMediaLibraryAssetFunctionResource(r) {
+    return r.type === 'sanity.function.media-library.asset';
+}
 export function isEventType(arg) {
     return ['create', 'update', 'delete'].includes(arg);
 }

package/dist/utils/validate/resource.js

@@ -1,4 +1,4 @@
-import { BlueprintParserErrorType } from '../types.js';
+import { BlueprintParserErrorType, isDocumentFunctionResource, isMediaLibraryAssetFunctionResource, } from '../types.js';
 export function validateFunctionName(name) {
     // must be 3+ characters, no special characters, no spaces, allow _ and -
     return /^[a-zA-Z0-9][a-zA-Z0-9_-]{2,}$/.test(name);
@@ -44,35 +44,6 @@ export function validateFunctionResource(resource) {
             type: BlueprintParserErrorType.InvalidType,
         });
     }
-    if (resource.event?.includeDrafts && typeof resource.event.includeDrafts !== 'boolean') {
-        errors.push({
-            message: `${msgPrefix} event.includeDrafts must be a boolean`,
-            type: BlueprintParserErrorType.InvalidType,
-        });
-    }
-    if (resource.event?.includeAllVersions &&
-        typeof resource.event.includeAllVersions !== 'boolean') {
-        errors.push({
-            message: `${msgPrefix} event.includeAllVersions must be a boolean`,
-            type: BlueprintParserErrorType.InvalidType,
-        });
-    }
-    if (resource.event?.resource) {
-        if (!resource.event.resource.type || resource.event.resource.type !== 'dataset') {
-            errors.push({
-                message: `${msgPrefix} event.resource.type must be "dataset"`,
-                type: BlueprintParserErrorType.InvalidType,
-            });
-        }
-        // Ensure exactly one period is passed into the ID to conform to the format <projectId>.<datasetName>
-        if (!resource.event.resource.id || resource.event.resource.id.split('.').length !== 2) {
-            errors.push({
-                message: `${msgPrefix} event.resource.id must be of the form <projectId>.<datasetName>. <datasetName> can be "*" to signify "all datasets in project with ID <projectId>."`,
-                type: BlueprintParserErrorType.InvalidFormat,
-            });
-        }
-        // TODO: validate the project ID and dataset names exist by making an API call?
-    }
     if (resource.memory !== undefined) {
         if (!Number.isInteger(resource.memory)) {
             errors.push({
@@ -123,5 +94,59 @@ export function validateFunctionResource(resource) {
             }
         }
     }
+    if (resource.event && 'resource' in resource.event && resource.event.resource) {
+        if (!resource.event.resource.type) {
+            errors.push({
+                message: `${msgPrefix} event.resource.type must be defined`,
+                type: BlueprintParserErrorType.MissingRequiredProperty,
+            });
+        }
+        if (!resource.event.resource.id) {
+            errors.push({
+                message: `${msgPrefix} event.resource.id must be defined`,
+                type: BlueprintParserErrorType.MissingRequiredProperty,
+            });
+        }
+    }
+    if (isMediaLibraryAssetFunctionResource(resource)) {
+        if (resource.event.resource.type !== 'media-library') {
+            errors.push({
+                message: `${msgPrefix} event.resource.type must be "media-library"`,
+                type: BlueprintParserErrorType.InvalidType,
+            });
+        }
+    }
+    if (isDocumentFunctionResource(resource) && resource.event) {
+        if (resource.event.includeDrafts && typeof resource.event.includeDrafts !== 'boolean') {
+            errors.push({
+                message: `${msgPrefix} event.includeDrafts must be a boolean`,
+                type: BlueprintParserErrorType.InvalidType,
+            });
+        }
+        if (resource.event.includeAllVersions &&
+            typeof resource.event.includeAllVersions !== 'boolean') {
+            errors.push({
+                message: `${msgPrefix} event.includeAllVersions must be a boolean`,
+                type: BlueprintParserErrorType.InvalidType,
+            });
+        }
+        if (resource.event.resource) {
+            if (!resource.event.resource.type || resource.event.resource.type !== 'dataset') {
+                errors.push({
+                    message: `${msgPrefix} event.resource.type must be "dataset"`,
+                    type: BlueprintParserErrorType.InvalidType,
+                });
+            }
+            // Ensure exactly one period is passed into the ID to conform to the format <projectId>.<datasetName>
+            if (!resource.event.resource.id || resource.event.resource.id.split('.').length !== 2) {
+                errors.push({
+                    message: `${msgPrefix} event.resource.id must be of the form <projectId>.<datasetName>. <datasetName> can be "*" to signify "all datasets in project with ID <projectId>."`,
+                    type: BlueprintParserErrorType.InvalidFormat,
+                });
+            }
+            // TODO: validate the project ID and dataset names exist by making an API call?
+            // NB: this is done by the functions service
+        }
+    }
     return errors;
 }

package/oclif.manifest.json

@@ -69,7 +69,10 @@
             "document-create",
             "document-delete",
             "document-update",
-            "document-publish"
+            "document-publish",
+            "media-library-asset-create",
+            "media-library-asset-update",
+            "media-library-asset-delete"
           ],
           "type": "option"
         },
@@ -778,7 +781,10 @@
             "document-create",
             "document-delete",
             "document-update",
-            "document-publish"
+            "document-publish",
+            "media-library-asset-create",
+            "media-library-asset-update",
+            "media-library-asset-delete"
           ],
           "type": "option"
         },
@@ -1236,6 +1242,21 @@
           "name": "with-user-token",
           "allowNo": false,
           "type": "boolean"
+        },
+        "media-library-id": {
+          "aliases": [
+            "media"
+          ],
+          "description": "Sanity Media Library ID to use",
+          "exclusive": [
+            "project-id",
+            "dataset"
+          ],
+          "name": "media-library-id",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -1387,5 +1408,5 @@
       ]
     }
   },
-  "version": "11.0.3"
+  "version": "11.1.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sanity/runtime-cli",
   "description": "Sanity's Runtime CLI for Blueprints and Functions",
-  "version": "11.0.3",
+  "version": "11.1.0",
   "author": "Sanity Runtime Team",
   "type": "module",
   "license": "MIT",
@@ -65,7 +65,7 @@
     "copy:wrapper": "shx cp ./src/utils/child-process-wrapper.js ./dist/utils/child-process-wrapper.js",
     "lint": "biome ci",
     "lint:write": "biome check --write",
-    "prepack": "npm run build:oclif",
+    "prepare": "npm run build",
     "postpack": "shx rm -f oclif.manifest.json",
     "test": "vitest run && npm run lint",
     "test:depmgmt": "vitest run --config ./test-depmgmt/vitest.config.ts",