@sanity/runtime-cli 14.10.1 → 14.12.0

package/dist/constants.d.ts

@@ -17,8 +17,20 @@ export declare const EVENT_MEDIA_LIBRARY_ASSET_CREATE = "media-library-asset-cre
 export declare const EVENT_MEDIA_LIBRARY_ASSET_UPDATE = "media-library-asset-update";
 export declare const EVENT_MEDIA_LIBRARY_ASSET_DELETE = "media-library-asset-delete";
 export declare const EVENT_SCHEDULED = "scheduled-function";
-export declare const FUNCTION_TYPES: readonly ["document-publish", "document-create", "document-update", "document-delete", "media-library-asset-create", "media-library-asset-update", "media-library-asset-delete", "scheduled-function"];
-export type ARRAY_OF_FUNCTION_TYPES = (typeof FUNCTION_TYPES)[number][];
+export declare const EVENT_SYNC_TAG_INVALIDATE = "sync-tag-invalidate";
+export declare const MAP_EVENT_TO_FUNCTION_TYPE: {
+    readonly "document-publish": "sanity.function.document";
+    readonly "document-create": "sanity.function.document";
+    readonly "document-delete": "sanity.function.document";
+    readonly "document-update": "sanity.function.document";
+    readonly "media-library-asset-create": "sanity.function.media-library.asset";
+    readonly "media-library-asset-delete": "sanity.function.media-library.asset";
+    readonly "media-library-asset-update": "sanity.function.media-library.asset";
+    readonly "scheduled-function": "sanity.function.cron";
+    readonly "sync-tag-invalidate": "sanity.function.sync-tag-invalidate";
+};
+export declare const FUNCTION_TYPES: (keyof typeof MAP_EVENT_TO_FUNCTION_TYPE)[];
+export type ARRAY_OF_FUNCTION_TYPES = typeof FUNCTION_TYPES;
 export declare const PROJECT_SCOPED_FUNCTION_TYPES: ReadonlySet<string>;
 export declare const ORGANIZATION_SCOPED_FUNCTION_TYPES: ReadonlySet<string>;
 export declare const MAX_ASSET_SIZE = 209715200;
@@ -30,3 +42,4 @@ export declare const LABEL_MEDIA_LIBRARY_ASSET_CREATE = "Media Library Asset Cre
 export declare const LABEL_MEDIA_LIBRARY_ASSET_UPDATE = "Media Library Asset Update";
 export declare const LABEL_MEDIA_LIBRARY_ASSET_DELETE = "Media Library Asset Delete";
 export declare const LABEL_SCHEDULED = "Scheduled";
+export declare const LABEL_SYNC_TAG_INVALIDATE = "Sync Tag Invalidate";

package/dist/constants.js

@@ -17,16 +17,19 @@ export const EVENT_MEDIA_LIBRARY_ASSET_CREATE = 'media-library-asset-create';
 export const EVENT_MEDIA_LIBRARY_ASSET_UPDATE = 'media-library-asset-update';
 export const EVENT_MEDIA_LIBRARY_ASSET_DELETE = 'media-library-asset-delete';
 export const EVENT_SCHEDULED = 'scheduled-function';
-export const FUNCTION_TYPES = [
-    EVENT_DOCUMENT_PUBLISH,
-    EVENT_DOCUMENT_CREATE,
-    EVENT_DOCUMENT_UPDATE,
-    EVENT_DOCUMENT_DELETE,
-    EVENT_MEDIA_LIBRARY_ASSET_CREATE,
-    EVENT_MEDIA_LIBRARY_ASSET_UPDATE,
-    EVENT_MEDIA_LIBRARY_ASSET_DELETE,
-    EVENT_SCHEDULED,
-];
+export const EVENT_SYNC_TAG_INVALIDATE = 'sync-tag-invalidate';
+export const MAP_EVENT_TO_FUNCTION_TYPE = {
+    [EVENT_DOCUMENT_PUBLISH]: SANITY_FUNCTION_DOCUMENT,
+    [EVENT_DOCUMENT_CREATE]: SANITY_FUNCTION_DOCUMENT,
+    [EVENT_DOCUMENT_DELETE]: SANITY_FUNCTION_DOCUMENT,
+    [EVENT_DOCUMENT_UPDATE]: SANITY_FUNCTION_DOCUMENT,
+    [EVENT_MEDIA_LIBRARY_ASSET_CREATE]: SANITY_FUNCTION_MEDIA_LIBRARY_ASSET,
+    [EVENT_MEDIA_LIBRARY_ASSET_DELETE]: SANITY_FUNCTION_MEDIA_LIBRARY_ASSET,
+    [EVENT_MEDIA_LIBRARY_ASSET_UPDATE]: SANITY_FUNCTION_MEDIA_LIBRARY_ASSET,
+    [EVENT_SCHEDULED]: SANITY_FUNCTION_SCHEDULED,
+    [EVENT_SYNC_TAG_INVALIDATE]: SANITY_FUNCTION_SYNC_TAG_INVALIDATE,
+};
+export const FUNCTION_TYPES = Object.keys(MAP_EVENT_TO_FUNCTION_TYPE);
 export const PROJECT_SCOPED_FUNCTION_TYPES = new Set([
     SANITY_FUNCTION_DOCUMENT,
     SANITY_FUNCTION_MEDIA_LIBRARY_ASSET,
@@ -44,3 +47,4 @@ export const LABEL_MEDIA_LIBRARY_ASSET_CREATE = 'Media Library Asset Create';
 export const LABEL_MEDIA_LIBRARY_ASSET_UPDATE = 'Media Library Asset Update';
 export const LABEL_MEDIA_LIBRARY_ASSET_DELETE = 'Media Library Asset Delete';
 export const LABEL_SCHEDULED = 'Scheduled';
+export const LABEL_SYNC_TAG_INVALIDATE = 'Sync Tag Invalidate';

package/dist/cores/functions/add.js

@@ -5,26 +5,29 @@ import { checkbox, confirm, input, select } from '@inquirer/prompts';
 import { highlight } from 'cardinal';
 import { createFunctionResource } from '../../actions/blueprints/resources.js';
 import { verifyExampleExists, writeExample } from '../../actions/sanity/examples.js';
-import { EVENT_DOCUMENT_CREATE, EVENT_DOCUMENT_DELETE, EVENT_DOCUMENT_UPDATE, EVENT_MEDIA_LIBRARY_ASSET_CREATE, EVENT_MEDIA_LIBRARY_ASSET_DELETE, EVENT_MEDIA_LIBRARY_ASSET_UPDATE, 
+import { EVENT_DOCUMENT_CREATE, EVENT_DOCUMENT_DELETE, EVENT_DOCUMENT_UPDATE, EVENT_MEDIA_LIBRARY_ASSET_CREATE, EVENT_MEDIA_LIBRARY_ASSET_DELETE, EVENT_MEDIA_LIBRARY_ASSET_UPDATE, EVENT_SYNC_TAG_INVALIDATE, 
 // EVENT_SCHEDULED,
-FUNCTION_TYPES, LABEL_DOCUMENT_CREATE, LABEL_DOCUMENT_DELETE, LABEL_DOCUMENT_UPDATE, LABEL_MEDIA_LIBRARY_ASSET_CREATE, LABEL_MEDIA_LIBRARY_ASSET_DELETE, LABEL_MEDIA_LIBRARY_ASSET_UPDATE, LABEL_SCHEDULED, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_SCHEDULED, } from '../../constants.js';
+FUNCTION_TYPES, LABEL_DOCUMENT_CREATE, LABEL_DOCUMENT_DELETE, LABEL_DOCUMENT_UPDATE, LABEL_MEDIA_LIBRARY_ASSET_CREATE, LABEL_MEDIA_LIBRARY_ASSET_DELETE, LABEL_MEDIA_LIBRARY_ASSET_UPDATE, LABEL_SCHEDULED, LABEL_SYNC_TAG_INVALIDATE, MAP_EVENT_TO_FUNCTION_TYPE, SANITY_FUNCTION_DOCUMENT, SANITY_FUNCTION_MEDIA_LIBRARY_ASSET, SANITY_FUNCTION_SCHEDULED, SANITY_FUNCTION_SYNC_TAG_INVALIDATE, } from '../../constants.js';
 import { check, indent, warn } from '../../utils/display/presenters.js';
 import { styleText } from '../../utils/style-text.js';
 import { validateFunctionName } from '../../utils/validate/resource.js';
 export const generateFunctionBlueprintResourceTemplate = (fnName, eventNames) => {
-    const functionType = eventNames[0].substring(0, eventNames[0].lastIndexOf('-'));
+    const functionType = MAP_EVENT_TO_FUNCTION_TYPE[eventNames[0]];
     let definer = '';
     const eventOns = eventNames.map((e) => `'${e.substring(e.lastIndexOf('-') + 1)}'`);
     switch (functionType) {
-        case 'document':
+        case SANITY_FUNCTION_DOCUMENT:
             definer = `defineDocumentFunction({name: '${fnName}', event: {on: [${eventOns.join(', ')}]}}), // ← add this line`;
             break;
-        case 'media-library-asset':
+        case SANITY_FUNCTION_MEDIA_LIBRARY_ASSET:
             definer = `defineMediaLibraryAssetFunction({name: '${fnName}', event: {on: [${eventOns.join(', ')}], resource: {type: 'media-library', id: 'my-media-library-id'}}}), // ← add this line`;
             break;
-        case 'scheduled':
+        case SANITY_FUNCTION_SCHEDULED:
             definer = `defineScheduledFunction({name: '${fnName}', event: {expression: '0 0 * * *'}}), // ← add this line`;
             break;
+        case SANITY_FUNCTION_SYNC_TAG_INVALIDATE:
+            definer = `defineSyncTagInvalidateFunction({name: '${fnName}'}), // ← add this line`;
+            break;
     }
     return `
   export default defineBlueprint({
@@ -154,7 +157,7 @@ export async function functionAddCore(options) {
         }
         const eventSources = new Set(fnTypes.map((t) => t.substring(0, t.lastIndexOf('-'))));
         if (eventSources.size > 1) {
-            throw new Error('Invalid function type. Cannot mix document-*, media-library-asset-*, and/or scheduled-* types.');
+            throw new Error('Invalid function type. Cannot mix document-*, media-library-asset-*, sync-tag-* and/or scheduled-* types.');
         }
         let addHelpers;
         let installCommand;
@@ -238,6 +241,7 @@ async function promptForFunctionType() {
             { name: LABEL_MEDIA_LIBRARY_ASSET_CREATE, value: EVENT_MEDIA_LIBRARY_ASSET_CREATE },
             { name: LABEL_MEDIA_LIBRARY_ASSET_UPDATE, value: EVENT_MEDIA_LIBRARY_ASSET_UPDATE },
             { name: LABEL_MEDIA_LIBRARY_ASSET_DELETE, value: EVENT_MEDIA_LIBRARY_ASSET_DELETE },
+            { name: LABEL_SYNC_TAG_INVALIDATE, value: EVENT_SYNC_TAG_INVALIDATE },
             // {name: LABEL_SCHEDULED, value: EVENT_SCHEDULED},
         ],
         validate(choices) {

package/dist/server/static/components/api-base.js

@@ -10,5 +10,6 @@ export class ApiBaseElement extends HTMLElement {
     this.SANITY_FUNCTION_DOCUMENT = 'sanity.function.document'
     this.SANITY_FUNCTION_MEDIA_LIBRARY_ASSET = 'sanity.function.media-library.asset'
     this.SANITY_FUNCTION_SCHEDULED = 'sanity.function.cron'
+    this.SANITY_FUNCTION_SYNC_TAG_INVALIDATE = 'sanity.function.sync-tag-invalidate'
   }
 }

package/dist/server/static/components/filters.js

@@ -80,17 +80,24 @@ class FiltersComponent extends ApiBaseElement {
       this.SANITY_FUNCTION_MEDIA_LIBRARY_ASSET,
     )
     const scheduleFunction = this.api.store.selectedFunctionType === this.SANITY_FUNCTION_SCHEDULED
+    const stiFunction =
+      this.api.store.selectedFunctionType === this.SANITY_FUNCTION_SYNC_TAG_INVALIDATE
 
     const container = this.shadowRoot.querySelector('fieldset')
-    container.innerHTML = this.buildFilters(docFunction, mediaFunction, scheduleFunction)
+    container.innerHTML = this.buildFilters(
+      docFunction,
+      mediaFunction,
+      scheduleFunction,
+      stiFunction,
+    )
   }
 
-  buildFilters = (docFunction, mediaFunction, scheduleFunction) => {
+  buildFilters = (docFunction, mediaFunction, scheduleFunction, stiFunction) => {
     return `
     <legend class="config-label">Client Options</legend>
     <div id="dynamic-dropdowns" class="flex gap-2">
       ${
-        docFunction || scheduleFunction
+        docFunction || scheduleFunction || stiFunction
           ? `<select-dropdown
         label="Project"
         store-key="projects"

package/dist/server/static/components/function-list.js

@@ -61,6 +61,7 @@ class FunctionList extends ApiBaseElement {
       case this.SANITY_FUNCTION_SCHEDULED:
         return 'Scheduled'
       default:
+        // this works well for sync-tag-invalidate functions!
         return type.split('.').pop().replaceAll('-', ' ')
     }
   }

package/dist/server/static/components/payload-panel.js

@@ -29,7 +29,7 @@ template.innerHTML = `
 <div id="payloadContainer" class="gutter-gradient relative h-100 max-h-100 y-scroll border-top border-top-none-l">
   <div class="bg gutter-gradient sticky top-0 right-0 left-0 z-100">
     <div class="flex items-center space-between pad-t-2 pad-r-5 pad-b-2 pad-l-12">
-      <h2 class="config-label mar-t-0 mar-b-0">Document</h2>
+      <h2 id="payloadTitle" class="config-label mar-t-0 mar-b-0">Document</h2>
     </div>
     <hr class='hr-border mar-l-specific' />
   </div>
@@ -75,11 +75,35 @@ class PayloadPanel extends ApiBaseElement {
 
     this.api.subscribe(this.updatePayload, ['document'])
     this.api.subscribe(this.updateSelectedEvent, ['selectedEvent'])
-    this.api.subscribe(this.updateCodeMirror, ['selectedFunctionType'])
+    this.api.subscribe(this.updateCodeMirror, ['selectedIndex', 'functions'])
+    this.api.subscribe(this.updatePanelTitle, ['selectedFunctionType'])
+    this.documentCacheByFunction = {}
+    this.currentIndex = -1
   }
 
-  updateCodeMirror = ({selectedFunctionType}) => {
-    if (selectedFunctionType === this.SANITY_FUNCTION_SCHEDULED) {
+  updateCodeMirror = () => {
+    const {
+      functions,
+      selectedIndex: selectedFuncName,
+      payload: {state},
+    } = this.api.store
+    const docText = state.doc.text.join('')
+    // save the previous payload in the cache before we do anything else
+    if (docText) {
+      const currentDoc = JSON.parse(docText)
+      this.documentCacheByFunction[this.currentIndex] = currentDoc
+    } else {
+      this.documentCacheByFunction[this.currentIndex] = ''
+    }
+    const selectedIndex = functions.findIndex((f) => f.name === selectedFuncName)
+    if (selectedIndex === this.currentIndex) return
+    const selectedFunction = functions[selectedIndex]
+    // flip editable of code mirror textarea based on function type
+    if (
+      [this.SANITY_FUNCTION_SCHEDULED, this.SANITY_FUNCTION_SYNC_TAG_INVALIDATE].includes(
+        selectedFunction.type,
+      )
+    ) {
       this.api.store.beforePayload.dispatch({
         effects: editableCompartment.reconfigure(EditorView.editable.of(false)),
       })
@@ -100,6 +124,16 @@ class PayloadPanel extends ApiBaseElement {
         effects: editableCompartment.reconfigure(EditorView.editable.of(true)),
       })
     }
+    // for certain other specific function types, set the payload to something specific, or reload whatever was loaded into its document payload before
+    switch (selectedFunction.type) {
+      case this.SANITY_FUNCTION_SYNC_TAG_INVALIDATE:
+        this.#updateCodeView(this.api.store.payload, {data: {syncTags: ['s1:1234', 's2:5678']}})
+        break
+      default:
+        this.#updateCodeView(this.api.store.payload, this.documentCacheByFunction[selectedIndex])
+        break
+    }
+    this.currentIndex = selectedIndex
   }
   updatePayload = ({document}) => {
     if (!document) return
@@ -112,7 +146,7 @@ class PayloadPanel extends ApiBaseElement {
     const transaction = view.state.update({
       changes: {
         from: 0,
-        insert: JSON.stringify(document, null, 2),
+        insert: document ? JSON.stringify(document, null, 2) : '',
         to: view.state.doc.length,
       },
     })
@@ -126,6 +160,22 @@ class PayloadPanel extends ApiBaseElement {
     payloadContainer.style.display = isUpdateEvent ? 'none' : 'block'
     deltaPayloadContainer.style.display = isUpdateEvent ? 'block' : 'none'
   }
+  updatePanelTitle = ({selectedFunctionType}) => {
+    const payloadTitle = this.shadowRoot.querySelector('#payloadTitle')
+    let title = 'Document'
+    switch (selectedFunctionType) {
+      case this.SANITY_FUNCTION_SYNC_TAG_INVALIDATE:
+        title = 'Sync Tag Payload'
+        break
+      case this.SANITY_FUNCTION_SCHEDULED:
+        title = 'Schedule Payload'
+        break
+      case this.SANITY_FUNCTION_DOCUMENT:
+      case this.SANITY_FUNCTION_MEDIA_LIBRARY_ASSET:
+        title = 'Document'
+    }
+    payloadTitle.innerHTML = title
+  }
 
   disconnectedCallback() {
     if (this.api) {

package/dist/server/static/components/rule-panel.js

@@ -14,7 +14,7 @@ template.innerHTML = `<div class="border-left y-scroll min-h-0">
     <h3 class="config-label mar-t-0 hidden">Filter/Projection</h3>
     <header class='flex space-between'>
         <dl class='flex items-center margin-0 pad-3 slab-stat'>
-          <dt class='nowrap'>Filter/Projection</dt>
+          <dt id="ruleTitle" class="nowrap">Filter/Projection</dt>
         </dl>
     </header>
     <div id="rule" name="rule" class="cm-s-dracula"></div>
@@ -30,17 +30,27 @@ class RulePanel extends ApiBaseElement {
   updateRule = () => {
     const {functions, rule, selectedIndex} = this.api.store
     const func = functions.find((func) => func.name === selectedIndex)
-
-    if (func.event) {
-      const transaction = rule.state.update({
-        changes: {
-          from: 0,
-          insert: JSON.stringify(func.event, null, 2),
-          to: rule.state.doc.length,
-        },
-      })
-      rule.dispatch(transaction)
+    switch (func.type) {
+      case this.SANITY_FUNCTION_SCHEDULED:
+        this.ruleTitle.innerHTML = 'Schedule Rule'
+        break
+      case this.SANITY_FUNCTION_DOCUMENT:
+      case this.SANITY_FUNCTION_MEDIA_LIBRARY_ASSET:
+        this.ruleTitle.innerHTML = 'Filter/Projection'
+        break
+      case this.SANITY_FUNCTION_SYNC_TAG_INVALIDATE:
+        this.ruleTitle.innerHTML = 'Resource'
+        break
     }
+
+    const transaction = rule.state.update({
+      changes: {
+        from: 0,
+        insert: func.event ? JSON.stringify(func.event, null, 2) : '',
+        to: rule.state.doc.length,
+      },
+    })
+    rule.dispatch(transaction)
   }
 
   async connectedCallback() {
@@ -48,6 +58,7 @@ class RulePanel extends ApiBaseElement {
     this.shadowRoot.adoptedStyleSheets = sheets
 
     this.rule = this.shadowRoot.querySelector('#rule')
+    this.ruleTitle = this.shadowRoot.querySelector('#ruleTitle')
 
     if (this.api) {
       this.api.subscribe(this.updateRule, ['selectedIndex', 'functions'])

package/dist/utils/child-process-wrapper.js

@@ -117,7 +117,12 @@ process.on('message', async (data) => {
       )
     }
 
-    json = await eventHandler({context, event})
+    json = await eventHandler({
+      context,
+      event,
+      // mock sync-tag-invalidate done callback
+      done: async (_tags) => new Response(null, {status: 204}),
+    })
 
     // Restore streams
     process.stdout.write = originalStdoutWrite

package/dist/utils/invoke-local.js

@@ -70,7 +70,7 @@ export default async function invoke(resource, payload, context, options) {
         createTempPackageJson(functionPath);
     }
     const { forceColor = true, timeout = 10 } = options;
-    let filteredData = {};
+    let filteredData = payload?.payload?.data || {};
     if (resource.type === 'sanity.function.document' ||
         resource.type === 'sanity.function.media-library.asset') {
         if (!isGroqContextOptions(context)) {