@sanity/runtime-cli 7.5.0 → 7.6.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/7.5.0 linux-x64 node-v22.15.0
+@sanity/runtime-cli/7.6.0 linux-x64 node-v22.15.0
 $ sanity-run --help [COMMAND]
 USAGE
   $ sanity-run COMMAND
@@ -84,7 +84,7 @@ EXAMPLES
   $ sanity-run blueprints add function --name my-function --fn-type document-publish --lang js
 ```
 
-_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v7.5.0/src/commands/blueprints/add.ts)_
+_See code: [src/commands/blueprints/add.ts](https://github.com/sanity-io/runtime-cli/blob/v7.6.0/src/commands/blueprints/add.ts)_
 
 ## `sanity-run blueprints config`
 
@@ -112,7 +112,7 @@ EXAMPLES
   $ sanity-run blueprints config --edit --project-id <projectId>
 ```
 
-_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v7.5.0/src/commands/blueprints/config.ts)_
+_See code: [src/commands/blueprints/config.ts](https://github.com/sanity-io/runtime-cli/blob/v7.6.0/src/commands/blueprints/config.ts)_
 
 ## `sanity-run blueprints deploy`
 
@@ -134,7 +134,7 @@ EXAMPLES
   $ sanity-run blueprints deploy --no-wait
 ```
 
-_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v7.5.0/src/commands/blueprints/deploy.ts)_
+_See code: [src/commands/blueprints/deploy.ts](https://github.com/sanity-io/runtime-cli/blob/v7.6.0/src/commands/blueprints/deploy.ts)_
 
 ## `sanity-run blueprints destroy`
 
@@ -155,7 +155,7 @@ EXAMPLES
   $ sanity-run blueprints destroy
 ```
 
-_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v7.5.0/src/commands/blueprints/destroy.ts)_
+_See code: [src/commands/blueprints/destroy.ts](https://github.com/sanity-io/runtime-cli/blob/v7.6.0/src/commands/blueprints/destroy.ts)_
 
 ## `sanity-run blueprints info`
 
@@ -172,7 +172,7 @@ EXAMPLES
   $ sanity-run blueprints info
 ```
 
-_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v7.5.0/src/commands/blueprints/info.ts)_
+_See code: [src/commands/blueprints/info.ts](https://github.com/sanity-io/runtime-cli/blob/v7.6.0/src/commands/blueprints/info.ts)_
 
 ## `sanity-run blueprints init [DIR]`
 
@@ -204,7 +204,7 @@ EXAMPLES
   $ sanity-run blueprints init --blueprint-type <json|js|ts> --project-id <projectId>
 ```
 
-_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v7.5.0/src/commands/blueprints/init.ts)_
+_See code: [src/commands/blueprints/init.ts](https://github.com/sanity-io/runtime-cli/blob/v7.6.0/src/commands/blueprints/init.ts)_
 
 ## `sanity-run blueprints logs`
 
@@ -226,7 +226,7 @@ EXAMPLES
   $ sanity-run blueprints logs --watch
 ```
 
-_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v7.5.0/src/commands/blueprints/logs.ts)_
+_See code: [src/commands/blueprints/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v7.6.0/src/commands/blueprints/logs.ts)_
 
 ## `sanity-run blueprints plan`
 
@@ -243,7 +243,7 @@ EXAMPLES
   $ sanity-run blueprints plan
 ```
 
-_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v7.5.0/src/commands/blueprints/plan.ts)_
+_See code: [src/commands/blueprints/plan.ts](https://github.com/sanity-io/runtime-cli/blob/v7.6.0/src/commands/blueprints/plan.ts)_
 
 ## `sanity-run functions dev`
 
@@ -263,7 +263,7 @@ EXAMPLES
   $ sanity-run functions dev --port 8974
 ```
 
-_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v7.5.0/src/commands/functions/dev.ts)_
+_See code: [src/commands/functions/dev.ts](https://github.com/sanity-io/runtime-cli/blob/v7.6.0/src/commands/functions/dev.ts)_
 
 ## `sanity-run functions env add NAME KEY VALUE`
 
@@ -285,7 +285,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/v7.5.0/src/commands/functions/env/add.ts)_
+_See code: [src/commands/functions/env/add.ts](https://github.com/sanity-io/runtime-cli/blob/v7.6.0/src/commands/functions/env/add.ts)_
 
 ## `sanity-run functions env list NAME`
 
@@ -305,7 +305,7 @@ EXAMPLES
   $ sanity-run functions env list MyFunction
 ```
 
-_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v7.5.0/src/commands/functions/env/list.ts)_
+_See code: [src/commands/functions/env/list.ts](https://github.com/sanity-io/runtime-cli/blob/v7.6.0/src/commands/functions/env/list.ts)_
 
 ## `sanity-run functions env remove NAME KEY`
 
@@ -326,7 +326,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/v7.5.0/src/commands/functions/env/remove.ts)_
+_See code: [src/commands/functions/env/remove.ts](https://github.com/sanity-io/runtime-cli/blob/v7.6.0/src/commands/functions/env/remove.ts)_
 
 ## `sanity-run functions logs NAME`
 
@@ -360,7 +360,7 @@ EXAMPLES
   $ sanity-run functions logs <name> --delete
 ```
 
-_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v7.5.0/src/commands/functions/logs.ts)_
+_See code: [src/commands/functions/logs.ts](https://github.com/sanity-io/runtime-cli/blob/v7.6.0/src/commands/functions/logs.ts)_
 
 ## `sanity-run functions test NAME`
 
@@ -393,7 +393,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/v7.5.0/src/commands/functions/test.ts)_
+_See code: [src/commands/functions/test.ts](https://github.com/sanity-io/runtime-cli/blob/v7.6.0/src/commands/functions/test.ts)_
 
 ## `sanity-run help [COMMAND]`
 

package/dist/server/app.js

@@ -1,6 +1,7 @@
-import { existsSync, readFileSync } from 'node:fs';
+import { existsSync, readFileSync, watchFile } from 'node:fs';
 import * as http from 'node:http';
 import { default as mime } from 'mime-types';
+import { WebSocketServer } from 'ws';
 import { readLocalBlueprint } from '../actions/blueprints/blueprint.js';
 import config from '../config.js';
 import { findFunctionByName } from '../utils/find-function.js';
@@ -123,6 +124,14 @@ const app = (port) => {
     };
     const server = http.createServer(requestListener);
     server.listen(port, host, () => { });
+    const wss = new WebSocketServer({ port: 8974 });
+    wss.on('connection', async function connection(ws) {
+        ws.on('error', console.error);
+        const { fileInfo } = await readLocalBlueprint();
+        watchFile(fileInfo.blueprintFilePath, { interval: 2007 }, async () => {
+            ws.send('reload-blueprint');
+        });
+    });
 };
 function parseInvokeRequest(body) {
     let json;

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

@@ -4,13 +4,15 @@ import {sanityCodeMirrorTheme} from './codemirror-theme.js'
 import {EditorView, basicSetup, json} from '../vendor/vendor.bundle.js'
 import {ApiBaseElement} from './api-base.js'
 
+const runTemplate = `<span>Run</span>
+  <svg data-sanity-icon="play" width="1em" height="1em" viewBox="0 0 25 25" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.5 18.5V6.5L17.5 12.5L7.5 18.5Z" fill="currentColor" stroke="currentColor" stroke-width="1.2" stroke-linejoin="round"></path></svg>`
+
 const template = `<div 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" style="padding: 8px 20px 8px 48px;">
       <h2 class="config-label mar-t-0 mar-b-0">Event</h2>
       <button ord="primary" class="sanity-button">
-        <span>Run</span>
-        <svg data-sanity-icon="play" width="1em" height="1em" viewBox="0 0 25 25" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.5 18.5V6.5L17.5 12.5L7.5 18.5Z" fill="currentColor" stroke="currentColor" stroke-width="1.2" stroke-linejoin="round"></path></svg>
+        ${runTemplate}
       </button>
   </div>
     <hr class='hr-border' style='margin-left: 31px; ' />
@@ -46,8 +48,7 @@ class PayloadPanel extends ApiBaseElement {
       this.button.innerHTML = '<network-spinner></network-spinner>'
     } else {
       this.button.removeAttribute('disabled')
-      this.button.innerHTML = `<span>Run</span>
-  <svg data-sanity-icon="play" width="1em" height="1em" viewBox="0 0 25 25" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.5 18.5V6.5L17.5 12.5L7.5 18.5Z" fill="currentColor" stroke="currentColor" stroke-width="1.2" stroke-linejoin="round"></path></svg>`
+      this.button.innerHTML = runTemplate
     }
   }
 

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

@@ -36,7 +36,7 @@ class ResponsePanel extends ApiBaseElement {
   updateResponse = ({result}) => {
     if (!result) return
 
-    const {error, json, logs, time, timings} = result
+    const {error, json, time, timings} = result
     if (!error) {
       const transaction = this.api.store.response.state.update({
         changes: {

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

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

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

@@ -0,0 +1,62 @@
+/* globals customElements document */
+/* eslint-disable unicorn/prefer-dom-node-text-content */
+import {sanityCodeMirrorTheme} from './codemirror-theme.js'
+
+import {EditorState, EditorView, basicSetup, json} from '../vendor/vendor.bundle.js'
+import {ApiBaseElement} from './api-base.js'
+
+const template = `<div style='overflow-y:scroll; min-height: 0;'>
+  <div>
+    <h3 class="config-label" style='display: none; margin-top: 0;'>Filter/Projection</h3>
+    <header class='flex space-between'>
+        <dl class='slab-stat'>
+          <dt style='white-space:nowrap;'>Filter/Projection</dt>
+        </dl>
+    </header>
+    <div id="rule" name="rule" class="cm-s-dracula"></div>
+  </div>
+</div>
+`
+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)
+    }
+  }
+
+  connectedCallback() {
+    this.innerHTML = template
+    this.rule = this.querySelector('#rule')
+
+    if (this.api) {
+      this.api.subscribe(this.updateRule, ['selectedIndex', 'functions'])
+      if (this.api.store.selectedIndex) {
+        this.updateRule({selectedIndex: this.api.store.selectedIndex})
+      }
+    }
+
+    this.api.store.rule = new EditorView({
+      doc: '\n\n\n\n',
+      extensions: [basicSetup, json(), sanityCodeMirrorTheme, EditorState.readOnly.of(true)],
+      parent: this.rule,
+    })
+  }
+
+  disconnectedCallback() {
+    if (this.api) {
+      this.api.unsubscribe(this.updateResponse)
+    }
+  }
+}
+
+customElements.define('rule-panel', RulePanel)

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

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

package/dist/server/static/hot-reload.js

@@ -0,0 +1,15 @@
+import apiConstructor from '../api.js'
+const api = apiConstructor()
+
+// Create WebSocket connection.
+const socket = new WebSocket('ws://localhost:8974')
+
+// Connection opened
+socket.addEventListener('open', () => {
+  console.log('Watching for Blueprint changes')
+})
+
+// Listen for messages
+socket.addEventListener('message', (event) => {
+  if (event.data === 'reload-blueprint') api.blueprint()
+})

package/dist/server/static/index.html

@@ -36,7 +36,10 @@
         </nav>
         <main id="main-content" style='max-height: 100%; overflow: hidden;'>
               <payload-panel></payload-panel>
-              <response-panel></response-panel>
+              <div>
+                <rule-panel></rule-paneL>
+                <response-panel></response-panel>
+              </div>
               <console-panel></console-panel>
         </main>
 
@@ -48,6 +51,8 @@
         <script src="./components/network-spinner.js" type="module"></script>
         <script src="./components/payload-panel.js" type="module"></script>
         <script src="./components/response-panel.js" type="module"></script>
+        <script src="./components/rule-panel.js" type="module"></script>
         <script src="./components/console-panel.js" type="module"></script>
+        <script src="./hot-reload.js" type="module"></script>
     </body>
 </html>

package/dist/utils/invoke-local.d.ts

@@ -1,3 +1,10 @@
-import type { InvocationResponse, InvokeContextOptions, LocalFunctionResource } from './types.js';
+import type { GroqRule, InvocationResponse, InvokeContextOptions, LocalFunctionResource } from './types.js';
 export declare function sanitizeLogs(logs: string): string;
+export declare const DEFAULT_GROQ_RULE: {
+    on: string[];
+    filter: string;
+    projection: string;
+};
+export declare function isDefaultGROQRule(rule: GroqRule | undefined): boolean;
+export declare function applyGroqRule(resource: LocalFunctionResource, data: Record<string, unknown> | null): Promise<any>;
 export default function invoke(resource: LocalFunctionResource, data: Record<string, unknown> | null, context: InvokeContextOptions, timeout?: number): Promise<InvocationResponse>;

package/dist/utils/invoke-local.js

@@ -3,6 +3,7 @@ import { performance } from 'node:perf_hooks';
 import { cwd } from 'node:process';
 import { setTimeout } from 'node:timers';
 import { fileURLToPath } from 'node:url';
+import * as groq from 'groq-js';
 import config from '../config.js';
 import { bundleFunction } from './bundle/bundle-function.js';
 import { findFunctionEntryPoint } from './functions/find-entry-point.js';
@@ -13,10 +14,45 @@ function getChildProcessWrapperPath() {
 export function sanitizeLogs(logs) {
     return logs.replace(/([a-zA-Z0-9]{10})[a-zA-Z0-9]{65,}/g, '$1**********');
 }
+export const DEFAULT_GROQ_RULE = { on: ['publish'], filter: '', projection: '' };
+export function isDefaultGROQRule(rule) {
+    if (!rule)
+        return true;
+    return (Array.isArray(rule.on) &&
+        rule.on.length === DEFAULT_GROQ_RULE.on.length &&
+        rule.on.every((v) => DEFAULT_GROQ_RULE.on.includes(v)) &&
+        rule.filter === DEFAULT_GROQ_RULE.filter &&
+        rule.projection === DEFAULT_GROQ_RULE.projection);
+}
+export async function applyGroqRule(resource, data) {
+    // If there is no rule set return everything
+    if (!resource.event)
+        return data;
+    // default groq rule is: gimme full doc content. otherwise, parse + eval custom rule
+    // applying the GROQ filter may result in a slimmer set of documents
+    if (!isDefaultGROQRule(resource.event)) {
+        const hasProjection = resource?.event?.projection?.length;
+        const projection = hasProjection ? `{${resource?.event?.projection}}` : '';
+        const query = `*[${resource?.event?.filter}]${projection}`;
+        try {
+            const rule = groq.parse(query);
+            const queryResults = await groq.evaluate(rule, { dataset: [data] });
+            const currentFunctionDocumentSet = await queryResults.get();
+            // TODO can this be multiple documents?
+            return currentFunctionDocumentSet[0] || {};
+        }
+        catch (e) {
+            // parsing/validating the groq rule we do up front as part of functions HTTP API
+            // so this likely would be triggered by evaluating the query, if anything
+            throw Error('⚠️ failed parsing/evaluating GROQ rule! Skipping invoke.');
+        }
+    }
+}
 export default async function invoke(resource, data, context, timeout = 10) {
     if (!resource.src) {
         throw new Error(`Function resource "${resource.name}" is missing the 'src' property.`);
     }
+    const filteredData = await applyGroqRule(resource, data);
     let cleanupBundle = async () => { };
     let functionPath = '';
     let bundleTimings = undefined;
@@ -80,7 +116,7 @@ export default async function invoke(resource, data, context, timeout = 10) {
                 reject(new Error(`Timed out after hitting its ${timeout}s timeout!`));
             }, timeout * 1000);
             const payload = {
-                ...data,
+                ...filteredData,
                 context: {
                     ...context,
                     clientOptions: {

package/dist/utils/types.d.ts

@@ -12,6 +12,12 @@ export interface AuthParams {
     projectId: string;
 }
 /** @internal */
+export interface GroqRule {
+    on: Array<string>;
+    filter?: string;
+    projection?: string;
+}
+/** @internal */
 export interface LocalBlueprint {
     /** @link https://github.com/sanity-io/blueprints-rfc/blob/main/readme.md#versioning */
     blueprintVersion?: string;
@@ -63,11 +69,7 @@ export interface LocalFunctionResource extends LocalResource {
     memory?: number;
     timeout?: number;
     env?: Record<string, string>;
-    event?: {
-        on: Array<string>;
-        filter?: string;
-        projection?: string;
-    };
+    event?: GroqRule;
 }
 export interface Stack {
     id: string;
@@ -95,11 +97,7 @@ export interface StackFunctionResource extends StackResource {
         memory?: number;
         timeout?: number;
         env?: Record<string, string>;
-        event?: {
-            on: Array<string>;
-            filter?: string;
-            projection?: string;
-        };
+        event?: GroqRule;
     };
 }
 /** @internal */

package/oclif.manifest.json

@@ -839,5 +839,5 @@
       ]
     }
   },
-  "version": "7.5.0"
+  "version": "7.6.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sanity/runtime-cli",
   "description": "Sanity's Runtime CLI for Blueprints and Functions",
-  "version": "7.5.0",
+  "version": "7.6.0",
   "author": "Sanity Runtime Team",
   "type": "module",
   "license": "MIT",
@@ -84,11 +84,13 @@
     "color-json": "^3.0.5",
     "eventsource": "^4.0.0",
     "find-up": "^7.0.0",
+    "groq-js": "^1.16.1",
     "inquirer": "^12.6.1",
     "mime-types": "^3.0.1",
     "ora": "^8.2.0",
     "vite": "^6.3.5",
     "vite-tsconfig-paths": "^5.1.4",
+    "ws": "^8.18.2",
     "xdg-basedir": "^5.1.0"
   },
   "devDependencies": {
@@ -103,6 +105,7 @@
     "@types/adm-zip": "^0.5.7",
     "@types/mime-types": "^2.1.4",
     "@types/node": "20",
+    "@types/ws": "^8.18.1",
     "codemirror": "^6.0.1",
     "mentoss": "^0.11.0",
     "oclif": "^4.17.46",