@sanity/cli 5.9.0-next.8 → 6.0.0-alpha.11

package/dist/commands/documents/delete.js

@@ -0,0 +1,104 @@
+import { Args, Flags } from '@oclif/core';
+import { getProjectCliClient, SanityCommand, subdebug } from '@sanity/cli-core';
+import { DOCUMENTS_API_VERSION } from '../../actions/documents/constants.js';
+import { NO_PROJECT_ID } from '../../util/errorMessages.js';
+const deleteDocumentDebug = subdebug('documents:delete');
+export class DeleteDocumentCommand extends SanityCommand {
+    static args = {
+        id: Args.string({
+            description: 'Document ID to delete',
+            required: true
+        }),
+        ids: Args.string({
+            description: 'Additional document IDs to delete',
+            required: false
+        })
+    };
+    static description = 'Delete one or more documents from the projects configured dataset';
+    static examples = [
+        {
+            command: '<%= config.bin %> <%= command.id %> myDocId',
+            description: 'Delete the document with the ID "myDocId"'
+        },
+        {
+            command: "<%= config.bin %> <%= command.id %> 'myDocId'",
+            description: 'ID wrapped in double or single quote works equally well'
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> --dataset=blog someDocId',
+            description: 'Delete document with ID "someDocId" from dataset "blog"'
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> doc1 doc2',
+            description: 'Delete the document with ID "doc1" and "doc2"'
+        }
+    ];
+    static flags = {
+        dataset: Flags.string({
+            description: 'NAME to override dataset'
+        })
+    };
+    // Disable strict mode to allow for more flexible input
+    // This is needed for supporting multiple document IDs
+    static strict = false;
+    async run() {
+        const { args, argv, flags } = await this.parse(DeleteDocumentCommand);
+        const { id } = args;
+        const { dataset } = flags;
+        // Collect all document IDs from args and argv
+        const ids = [
+            id,
+            ...argv.slice(1)
+        ].filter(Boolean);
+        if (ids.length === 0) {
+            this.error('Document ID must be specified', {
+                exit: 1
+            });
+        }
+        // Get project configuration
+        const cliConfig = await this.getCliConfig();
+        const projectId = await this.getProjectId();
+        if (!projectId) {
+            this.error(NO_PROJECT_ID, {
+                exit: 1
+            });
+        }
+        if (!cliConfig.api?.dataset && !dataset) {
+            this.error('No dataset specified. Either configure a dataset in sanity.cli.ts or use the --dataset flag', {
+                exit: 1
+            });
+        }
+        const targetDataset = dataset || cliConfig.api?.dataset;
+        try {
+            const projectClient = await getProjectCliClient({
+                apiVersion: DOCUMENTS_API_VERSION,
+                dataset: targetDataset,
+                projectId,
+                requireUser: true
+            });
+            const transaction = projectClient.transaction();
+            for (const id of ids){
+                transaction.delete(id);
+            }
+            const { results } = await transaction.commit();
+            const deleted = results.filter((res)=>res.operation === 'delete').map((res)=>res.id);
+            const notFound = ids.filter((id)=>!deleted.includes(id));
+            if (deleted.length > 0) {
+                this.log(`Deleted ${deleted.length} ${deleted.length === 1 ? 'document' : 'documents'}`);
+            }
+            if (notFound.length > 0) {
+                this.error(`${notFound.length === 1 ? 'Document' : 'Documents'} not found: ${notFound.join(', ')}`, {
+                    exit: 1
+                });
+            }
+        } catch (error) {
+            const err = error;
+            deleteDocumentDebug(`Error deleting documents ${ids.join(', ')}`, err);
+            this.error(`Failed to delete ${ids.length} ${ids.length === 1 ? 'document' : 'documents'}: ${err.message}`, {
+                exit: 1
+            });
+        }
+    }
+}
+
+//# sourceMappingURL=delete.js.map

package/dist/commands/documents/delete.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/commands/documents/delete.ts"],"sourcesContent":["import {Args, Flags} from '@oclif/core'\nimport {getProjectCliClient, SanityCommand, subdebug} from '@sanity/cli-core'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {NO_PROJECT_ID} from '../../util/errorMessages.js'\n\nconst deleteDocumentDebug = subdebug('documents:delete')\n\nexport class DeleteDocumentCommand extends SanityCommand<typeof DeleteDocumentCommand> {\n  static override args = {\n    id: Args.string({\n      description: 'Document ID to delete',\n      required: true,\n    }),\n    ids: Args.string({\n      description: 'Additional document IDs to delete',\n      required: false,\n    }),\n  }\n\n  static override description = 'Delete one or more documents from the projects configured dataset'\n\n  static override examples = [\n    {\n      command: '<%= config.bin %> <%= command.id %> myDocId',\n      description: 'Delete the document with the ID \"myDocId\"',\n    },\n    {\n      command: \"<%= config.bin %> <%= command.id %> 'myDocId'\",\n      description: 'ID wrapped in double or single quote works equally well',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> --dataset=blog someDocId',\n      description: 'Delete document with ID \"someDocId\" from dataset \"blog\"',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> doc1 doc2',\n      description: 'Delete the document with ID \"doc1\" and \"doc2\"',\n    },\n  ]\n\n  static override flags = {\n    dataset: Flags.string({\n      description: 'NAME to override dataset',\n    }),\n  }\n\n  // Disable strict mode to allow for more flexible input\n  // This is needed for supporting multiple document IDs\n  static override strict = false\n\n  public async run(): Promise<void> {\n    const {args, argv, flags} = await this.parse(DeleteDocumentCommand)\n    const {id} = args\n    const {dataset} = flags\n\n    // Collect all document IDs from args and argv\n    const ids = [id, ...argv.slice(1)].filter(Boolean) as string[]\n\n    if (ids.length === 0) {\n      this.error('Document ID must be specified', {exit: 1})\n    }\n\n    // Get project configuration\n    const cliConfig = await this.getCliConfig()\n    const projectId = await this.getProjectId()\n\n    if (!projectId) {\n      this.error(NO_PROJECT_ID, {exit: 1})\n    }\n\n    if (!cliConfig.api?.dataset && !dataset) {\n      this.error(\n        'No dataset specified. Either configure a dataset in sanity.cli.ts or use the --dataset flag',\n        {exit: 1},\n      )\n    }\n\n    const targetDataset = dataset || cliConfig.api?.dataset\n\n    try {\n      const projectClient = await getProjectCliClient({\n        apiVersion: DOCUMENTS_API_VERSION,\n        dataset: targetDataset,\n        projectId,\n        requireUser: true,\n      })\n\n      const transaction = projectClient.transaction()\n      for (const id of ids) {\n        transaction.delete(id)\n      }\n      const {results} = await transaction.commit()\n      const deleted = results.filter((res) => res.operation === 'delete').map((res) => res.id)\n      const notFound = ids.filter((id) => !deleted.includes(id))\n\n      if (deleted.length > 0) {\n        this.log(`Deleted ${deleted.length} ${deleted.length === 1 ? 'document' : 'documents'}`)\n      }\n\n      if (notFound.length > 0) {\n        this.error(\n          `${notFound.length === 1 ? 'Document' : 'Documents'} not found: ${notFound.join(', ')}`,\n          {\n            exit: 1,\n          },\n        )\n      }\n    } catch (error) {\n      const err = error as Error\n      deleteDocumentDebug(`Error deleting documents ${ids.join(', ')}`, err)\n      this.error(\n        `Failed to delete ${ids.length} ${ids.length === 1 ? 'document' : 'documents'}: ${err.message}`,\n        {\n          exit: 1,\n        },\n      )\n    }\n  }\n}\n"],"names":["Args","Flags","getProjectCliClient","SanityCommand","subdebug","DOCUMENTS_API_VERSION","NO_PROJECT_ID","deleteDocumentDebug","DeleteDocumentCommand","args","id","string","description","required","ids","examples","command","flags","dataset","strict","run","argv","parse","slice","filter","Boolean","length","error","exit","cliConfig","getCliConfig","projectId","getProjectId","api","targetDataset","projectClient","apiVersion","requireUser","transaction","delete","results","commit","deleted","res","operation","map","notFound","includes","log","join","err","message"],"mappings":"AAAA,SAAQA,IAAI,EAAEC,KAAK,QAAO,cAAa;AACvC,SAAQC,mBAAmB,EAAEC,aAAa,EAAEC,QAAQ,QAAO,mBAAkB;AAE7E,SAAQC,qBAAqB,QAAO,uCAAsC;AAC1E,SAAQC,aAAa,QAAO,8BAA6B;AAEzD,MAAMC,sBAAsBH,SAAS;AAErC,OAAO,MAAMI,8BAA8BL;IACzC,OAAgBM,OAAO;QACrBC,IAAIV,KAAKW,MAAM,CAAC;YACdC,aAAa;YACbC,UAAU;QACZ;QACAC,KAAKd,KAAKW,MAAM,CAAC;YACfC,aAAa;YACbC,UAAU;QACZ;IACF,EAAC;IAED,OAAgBD,cAAc,oEAAmE;IAEjG,OAAgBG,WAAW;QACzB;YACEC,SAAS;YACTJ,aAAa;QACf;QACA;YACEI,SAAS;YACTJ,aAAa;QACf;QACA;YACEI,SAAS;YACTJ,aAAa;QACf;QACA;YACEI,SAAS;YACTJ,aAAa;QACf;KACD,CAAA;IAED,OAAgBK,QAAQ;QACtBC,SAASjB,MAAMU,MAAM,CAAC;YACpBC,aAAa;QACf;IACF,EAAC;IAED,uDAAuD;IACvD,sDAAsD;IACtD,OAAgBO,SAAS,MAAK;IAE9B,MAAaC,MAAqB;QAChC,MAAM,EAACX,IAAI,EAAEY,IAAI,EAAEJ,KAAK,EAAC,GAAG,MAAM,IAAI,CAACK,KAAK,CAACd;QAC7C,MAAM,EAACE,EAAE,EAAC,GAAGD;QACb,MAAM,EAACS,OAAO,EAAC,GAAGD;QAElB,8CAA8C;QAC9C,MAAMH,MAAM;YAACJ;eAAOW,KAAKE,KAAK,CAAC;SAAG,CAACC,MAAM,CAACC;QAE1C,IAAIX,IAAIY,MAAM,KAAK,GAAG;YACpB,IAAI,CAACC,KAAK,CAAC,iCAAiC;gBAACC,MAAM;YAAC;QACtD;QAEA,4BAA4B;QAC5B,MAAMC,YAAY,MAAM,IAAI,CAACC,YAAY;QACzC,MAAMC,YAAY,MAAM,IAAI,CAACC,YAAY;QAEzC,IAAI,CAACD,WAAW;YACd,IAAI,CAACJ,KAAK,CAACrB,eAAe;gBAACsB,MAAM;YAAC;QACpC;QAEA,IAAI,CAACC,UAAUI,GAAG,EAAEf,WAAW,CAACA,SAAS;YACvC,IAAI,CAACS,KAAK,CACR,+FACA;gBAACC,MAAM;YAAC;QAEZ;QAEA,MAAMM,gBAAgBhB,WAAWW,UAAUI,GAAG,EAAEf;QAEhD,IAAI;YACF,MAAMiB,gBAAgB,MAAMjC,oBAAoB;gBAC9CkC,YAAY/B;gBACZa,SAASgB;gBACTH;gBACAM,aAAa;YACf;YAEA,MAAMC,cAAcH,cAAcG,WAAW;YAC7C,KAAK,MAAM5B,MAAMI,IAAK;gBACpBwB,YAAYC,MAAM,CAAC7B;YACrB;YACA,MAAM,EAAC8B,OAAO,EAAC,GAAG,MAAMF,YAAYG,MAAM;YAC1C,MAAMC,UAAUF,QAAQhB,MAAM,CAAC,CAACmB,MAAQA,IAAIC,SAAS,KAAK,UAAUC,GAAG,CAAC,CAACF,MAAQA,IAAIjC,EAAE;YACvF,MAAMoC,WAAWhC,IAAIU,MAAM,CAAC,CAACd,KAAO,CAACgC,QAAQK,QAAQ,CAACrC;YAEtD,IAAIgC,QAAQhB,MAAM,GAAG,GAAG;gBACtB,IAAI,CAACsB,GAAG,CAAC,CAAC,QAAQ,EAAEN,QAAQhB,MAAM,CAAC,CAAC,EAAEgB,QAAQhB,MAAM,KAAK,IAAI,aAAa,aAAa;YACzF;YAEA,IAAIoB,SAASpB,MAAM,GAAG,GAAG;gBACvB,IAAI,CAACC,KAAK,CACR,GAAGmB,SAASpB,MAAM,KAAK,IAAI,aAAa,YAAY,YAAY,EAAEoB,SAASG,IAAI,CAAC,OAAO,EACvF;oBACErB,MAAM;gBACR;YAEJ;QACF,EAAE,OAAOD,OAAO;YACd,MAAMuB,MAAMvB;YACZpB,oBAAoB,CAAC,yBAAyB,EAAEO,IAAImC,IAAI,CAAC,OAAO,EAAEC;YAClE,IAAI,CAACvB,KAAK,CACR,CAAC,iBAAiB,EAAEb,IAAIY,MAAM,CAAC,CAAC,EAAEZ,IAAIY,MAAM,KAAK,IAAI,aAAa,YAAY,EAAE,EAAEwB,IAAIC,OAAO,EAAE,EAC/F;gBACEvB,MAAM;YACR;QAEJ;IACF;AACF"}

package/dist/commands/documents/get.js

@@ -0,0 +1,85 @@
+import { Args, Flags } from '@oclif/core';
+import { colorizeJson, getProjectCliClient, SanityCommand, subdebug } from '@sanity/cli-core';
+import { DOCUMENTS_API_VERSION } from '../../actions/documents/constants.js';
+import { NO_PROJECT_ID } from '../../util/errorMessages.js';
+const getDocumentDebug = subdebug('documents:get');
+export class GetDocumentCommand extends SanityCommand {
+    static args = {
+        documentId: Args.string({
+            description: 'Document ID to retrieve',
+            required: true
+        })
+    };
+    static description = 'Get and print a document by ID';
+    static examples = [
+        {
+            command: '<%= config.bin %> <%= command.id %> myDocId',
+            description: 'Get the document with ID "myDocId"'
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> myDocId --pretty',
+            description: 'Get document with colorized JSON output'
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> myDocId --dataset production',
+            description: 'Get document from a specific dataset'
+        }
+    ];
+    static flags = {
+        dataset: Flags.string({
+            char: 'd',
+            description: 'Dataset to get document from (overrides config)'
+        }),
+        pretty: Flags.boolean({
+            default: false,
+            description: 'Colorize JSON output'
+        })
+    };
+    async run() {
+        const { args, flags } = await this.parse(GetDocumentCommand);
+        const { documentId } = args;
+        const { dataset, pretty } = flags;
+        // Get project configuration
+        const cliConfig = await this.getCliConfig();
+        const projectId = await this.getProjectId();
+        if (!projectId) {
+            this.error(NO_PROJECT_ID, {
+                exit: 1
+            });
+        }
+        if (!cliConfig.api?.dataset && !dataset) {
+            this.error('No dataset specified. Either configure a dataset in sanity.cli.ts or use the --dataset flag', {
+                exit: 1
+            });
+        }
+        const targetDataset = dataset || cliConfig.api?.dataset;
+        try {
+            const projectClient = await getProjectCliClient({
+                apiVersion: DOCUMENTS_API_VERSION,
+                dataset: targetDataset,
+                projectId,
+                requireUser: true
+            });
+            const doc = await projectClient.getDocument(documentId);
+            if (!doc) {
+                this.error(`Document "${documentId}" not found in dataset "${targetDataset}"`, {
+                    exit: 1
+                });
+            }
+            // Output the document
+            if (pretty) {
+                this.log(colorizeJson(doc));
+            } else {
+                this.log(JSON.stringify(doc, null, 2));
+            }
+        } catch (error) {
+            const err = error;
+            getDocumentDebug(`Error fetching document ${documentId}`, err);
+            this.error(`Failed to fetch document: ${err.message}`, {
+                exit: 1
+            });
+        }
+    }
+}
+
+//# sourceMappingURL=get.js.map

package/dist/commands/documents/get.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/commands/documents/get.ts"],"sourcesContent":["import {Args, Flags} from '@oclif/core'\nimport {colorizeJson, getProjectCliClient, SanityCommand, subdebug} from '@sanity/cli-core'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {NO_PROJECT_ID} from '../../util/errorMessages.js'\n\nconst getDocumentDebug = subdebug('documents:get')\n\nexport class GetDocumentCommand extends SanityCommand<typeof GetDocumentCommand> {\n  static override args = {\n    documentId: Args.string({\n      description: 'Document ID to retrieve',\n      required: true,\n    }),\n  }\n\n  static override description = 'Get and print a document by ID'\n\n  static override examples = [\n    {\n      command: '<%= config.bin %> <%= command.id %> myDocId',\n      description: 'Get the document with ID \"myDocId\"',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> myDocId --pretty',\n      description: 'Get document with colorized JSON output',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> myDocId --dataset production',\n      description: 'Get document from a specific dataset',\n    },\n  ]\n\n  static override flags = {\n    dataset: Flags.string({\n      char: 'd',\n      description: 'Dataset to get document from (overrides config)',\n    }),\n    pretty: Flags.boolean({\n      default: false,\n      description: 'Colorize JSON output',\n    }),\n  }\n\n  public async run(): Promise<void> {\n    const {args, flags} = await this.parse(GetDocumentCommand)\n    const {documentId} = args\n    const {dataset, pretty} = flags\n\n    // Get project configuration\n    const cliConfig = await this.getCliConfig()\n    const projectId = await this.getProjectId()\n\n    if (!projectId) {\n      this.error(NO_PROJECT_ID, {exit: 1})\n    }\n\n    if (!cliConfig.api?.dataset && !dataset) {\n      this.error(\n        'No dataset specified. Either configure a dataset in sanity.cli.ts or use the --dataset flag',\n        {exit: 1},\n      )\n    }\n\n    const targetDataset = dataset || cliConfig.api?.dataset\n\n    try {\n      const projectClient = await getProjectCliClient({\n        apiVersion: DOCUMENTS_API_VERSION,\n        dataset: targetDataset,\n        projectId,\n        requireUser: true,\n      })\n\n      const doc = await projectClient.getDocument(documentId)\n\n      if (!doc) {\n        this.error(`Document \"${documentId}\" not found in dataset \"${targetDataset}\"`, {exit: 1})\n      }\n\n      // Output the document\n      if (pretty) {\n        this.log(colorizeJson(doc))\n      } else {\n        this.log(JSON.stringify(doc, null, 2))\n      }\n    } catch (error) {\n      const err = error as Error\n\n      getDocumentDebug(`Error fetching document ${documentId}`, err)\n      this.error(`Failed to fetch document: ${err.message}`, {exit: 1})\n    }\n  }\n}\n"],"names":["Args","Flags","colorizeJson","getProjectCliClient","SanityCommand","subdebug","DOCUMENTS_API_VERSION","NO_PROJECT_ID","getDocumentDebug","GetDocumentCommand","args","documentId","string","description","required","examples","command","flags","dataset","char","pretty","boolean","default","run","parse","cliConfig","getCliConfig","projectId","getProjectId","error","exit","api","targetDataset","projectClient","apiVersion","requireUser","doc","getDocument","log","JSON","stringify","err","message"],"mappings":"AAAA,SAAQA,IAAI,EAAEC,KAAK,QAAO,cAAa;AACvC,SAAQC,YAAY,EAAEC,mBAAmB,EAAEC,aAAa,EAAEC,QAAQ,QAAO,mBAAkB;AAE3F,SAAQC,qBAAqB,QAAO,uCAAsC;AAC1E,SAAQC,aAAa,QAAO,8BAA6B;AAEzD,MAAMC,mBAAmBH,SAAS;AAElC,OAAO,MAAMI,2BAA2BL;IACtC,OAAgBM,OAAO;QACrBC,YAAYX,KAAKY,MAAM,CAAC;YACtBC,aAAa;YACbC,UAAU;QACZ;IACF,EAAC;IAED,OAAgBD,cAAc,iCAAgC;IAE9D,OAAgBE,WAAW;QACzB;YACEC,SAAS;YACTH,aAAa;QACf;QACA;YACEG,SAAS;YACTH,aAAa;QACf;QACA;YACEG,SAAS;YACTH,aAAa;QACf;KACD,CAAA;IAED,OAAgBI,QAAQ;QACtBC,SAASjB,MAAMW,MAAM,CAAC;YACpBO,MAAM;YACNN,aAAa;QACf;QACAO,QAAQnB,MAAMoB,OAAO,CAAC;YACpBC,SAAS;YACTT,aAAa;QACf;IACF,EAAC;IAED,MAAaU,MAAqB;QAChC,MAAM,EAACb,IAAI,EAAEO,KAAK,EAAC,GAAG,MAAM,IAAI,CAACO,KAAK,CAACf;QACvC,MAAM,EAACE,UAAU,EAAC,GAAGD;QACrB,MAAM,EAACQ,OAAO,EAAEE,MAAM,EAAC,GAAGH;QAE1B,4BAA4B;QAC5B,MAAMQ,YAAY,MAAM,IAAI,CAACC,YAAY;QACzC,MAAMC,YAAY,MAAM,IAAI,CAACC,YAAY;QAEzC,IAAI,CAACD,WAAW;YACd,IAAI,CAACE,KAAK,CAACtB,eAAe;gBAACuB,MAAM;YAAC;QACpC;QAEA,IAAI,CAACL,UAAUM,GAAG,EAAEb,WAAW,CAACA,SAAS;YACvC,IAAI,CAACW,KAAK,CACR,+FACA;gBAACC,MAAM;YAAC;QAEZ;QAEA,MAAME,gBAAgBd,WAAWO,UAAUM,GAAG,EAAEb;QAEhD,IAAI;YACF,MAAMe,gBAAgB,MAAM9B,oBAAoB;gBAC9C+B,YAAY5B;gBACZY,SAASc;gBACTL;gBACAQ,aAAa;YACf;YAEA,MAAMC,MAAM,MAAMH,cAAcI,WAAW,CAAC1B;YAE5C,IAAI,CAACyB,KAAK;gBACR,IAAI,CAACP,KAAK,CAAC,CAAC,UAAU,EAAElB,WAAW,wBAAwB,EAAEqB,cAAc,CAAC,CAAC,EAAE;oBAACF,MAAM;gBAAC;YACzF;YAEA,sBAAsB;YACtB,IAAIV,QAAQ;gBACV,IAAI,CAACkB,GAAG,CAACpC,aAAakC;YACxB,OAAO;gBACL,IAAI,CAACE,GAAG,CAACC,KAAKC,SAAS,CAACJ,KAAK,MAAM;YACrC;QACF,EAAE,OAAOP,OAAO;YACd,MAAMY,MAAMZ;YAEZrB,iBAAiB,CAAC,wBAAwB,EAAEG,YAAY,EAAE8B;YAC1D,IAAI,CAACZ,KAAK,CAAC,CAAC,0BAA0B,EAAEY,IAAIC,OAAO,EAAE,EAAE;gBAACZ,MAAM;YAAC;QACjE;IACF;AACF"}

package/dist/commands/documents/query.js

@@ -0,0 +1,105 @@
+import { Args, Flags } from '@oclif/core';
+import { colorizeJson, getProjectCliClient, SanityCommand, subdebug } from '@sanity/cli-core';
+import { DOCUMENTS_API_VERSION } from '../../actions/documents/constants.js';
+import { NO_PROJECT_ID } from '../../util/errorMessages.js';
+const queryDocumentDebug = subdebug('documents:query');
+export class QueryDocumentCommand extends SanityCommand {
+    static args = {
+        query: Args.string({
+            description: 'GROQ query to run against the dataset',
+            required: true
+        })
+    };
+    static description = 'Query for documents';
+    static examples = [
+        {
+            command: '<%= config.bin %> <%= command.id %> \'*[_type == "movie"][0..4]\'',
+            description: 'Fetch 5 documents of type "movie"'
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> \'*[_type == "movie"]|order(releaseDate asc)[0]{title}\' --dataset staging',
+            description: 'Fetch title of the oldest movie in the dataset named "staging"'
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> \'*[_id == "header"] { "headerText": pt::text(body) }\' --api-version v2021-06-07',
+            description: 'Use API version v2021-06-07 and do a query'
+        }
+    ];
+    static flags = {
+        anonymous: Flags.boolean({
+            default: false,
+            description: 'Send the query without any authorization token'
+        }),
+        'api-version': Flags.string({
+            description: `API version to use (defaults to ${DOCUMENTS_API_VERSION})`,
+            env: 'SANITY_CLI_QUERY_API_VERSION'
+        }),
+        dataset: Flags.string({
+            char: 'd',
+            description: 'Dataset to query (overrides config)'
+        }),
+        pretty: Flags.boolean({
+            default: false,
+            description: 'Colorize JSON output'
+        }),
+        project: Flags.string({
+            char: 'p',
+            description: 'Project ID to query (overrides config)'
+        })
+    };
+    async run() {
+        const { args, flags } = await this.parse(QueryDocumentCommand);
+        const { query } = args;
+        const { anonymous, 'api-version': apiVersion, dataset, pretty, project } = flags;
+        // Get project configuration
+        const cliConfig = await this.getCliConfig();
+        const configProjectId = await this.getProjectId();
+        const targetProject = project || configProjectId;
+        const requireUser = !anonymous;
+        if (!targetProject) {
+            this.error(NO_PROJECT_ID, {
+                exit: 1
+            });
+        }
+        if (!cliConfig.api?.dataset && !dataset) {
+            this.error('No dataset specified. Either configure a dataset in sanity.cli.ts or use the --dataset flag', {
+                exit: 1
+            });
+        }
+        const targetDataset = dataset || cliConfig.api?.dataset;
+        const targetApiVersion = apiVersion || DOCUMENTS_API_VERSION;
+        if (!apiVersion) {
+            this.warn(`--api-version not specified, using \`${DOCUMENTS_API_VERSION}\``);
+        }
+        try {
+            const projectClient = await getProjectCliClient({
+                apiVersion: targetApiVersion,
+                dataset: targetDataset,
+                projectId: targetProject,
+                requireUser
+            });
+            const docs = await projectClient.fetch(query);
+            if (!docs) {
+                this.error('Query returned no results', {
+                    exit: 1
+                });
+            }
+            // Output the query results
+            if (pretty) {
+                this.log(colorizeJson(docs));
+            } else {
+                this.log(JSON.stringify(docs, null, 2));
+            }
+        } catch (error) {
+            const err = error;
+            queryDocumentDebug(`Error running query: ${query}`, err);
+            // Provide more context in error messages
+            const errorMsg = err.message.toLowerCase().includes('syntax') ? `Invalid GROQ query syntax: ${err.message}` : `Failed to run query: ${err.message}`;
+            this.error(`${errorMsg}\nQuery: ${query}`, {
+                exit: 1
+            });
+        }
+    }
+}
+
+//# sourceMappingURL=query.js.map

package/dist/commands/documents/query.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/commands/documents/query.ts"],"sourcesContent":["import {Args, Flags} from '@oclif/core'\nimport {colorizeJson, getProjectCliClient, SanityCommand, subdebug} from '@sanity/cli-core'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {NO_PROJECT_ID} from '../../util/errorMessages.js'\n\nconst queryDocumentDebug = subdebug('documents:query')\n\nexport class QueryDocumentCommand extends SanityCommand<typeof QueryDocumentCommand> {\n  static override args = {\n    query: Args.string({\n      description: 'GROQ query to run against the dataset',\n      required: true,\n    }),\n  }\n\n  static override description = 'Query for documents'\n\n  static override examples = [\n    {\n      command: '<%= config.bin %> <%= command.id %> \\'*[_type == \"movie\"][0..4]\\'',\n      description: 'Fetch 5 documents of type \"movie\"',\n    },\n    {\n      command:\n        '<%= config.bin %> <%= command.id %> \\'*[_type == \"movie\"]|order(releaseDate asc)[0]{title}\\' --dataset staging',\n      description: 'Fetch title of the oldest movie in the dataset named \"staging\"',\n    },\n    {\n      command:\n        '<%= config.bin %> <%= command.id %> \\'*[_id == \"header\"] { \"headerText\": pt::text(body) }\\' --api-version v2021-06-07',\n      description: 'Use API version v2021-06-07 and do a query',\n    },\n  ]\n\n  static override flags = {\n    anonymous: Flags.boolean({\n      default: false,\n      description: 'Send the query without any authorization token',\n    }),\n    'api-version': Flags.string({\n      description: `API version to use (defaults to ${DOCUMENTS_API_VERSION})`,\n      env: 'SANITY_CLI_QUERY_API_VERSION',\n    }),\n    dataset: Flags.string({\n      char: 'd',\n      description: 'Dataset to query (overrides config)',\n    }),\n    pretty: Flags.boolean({\n      default: false,\n      description: 'Colorize JSON output',\n    }),\n    project: Flags.string({\n      char: 'p',\n      description: 'Project ID to query (overrides config)',\n    }),\n  }\n\n  public async run(): Promise<void> {\n    const {args, flags} = await this.parse(QueryDocumentCommand)\n    const {query} = args\n    const {anonymous, 'api-version': apiVersion, dataset, pretty, project} = flags\n\n    // Get project configuration\n    const cliConfig = await this.getCliConfig()\n    const configProjectId = await this.getProjectId()\n\n    const targetProject = project || configProjectId\n    const requireUser = !anonymous\n\n    if (!targetProject) {\n      this.error(NO_PROJECT_ID, {exit: 1})\n    }\n\n    if (!cliConfig.api?.dataset && !dataset) {\n      this.error(\n        'No dataset specified. Either configure a dataset in sanity.cli.ts or use the --dataset flag',\n        {exit: 1},\n      )\n    }\n\n    const targetDataset = dataset || cliConfig.api?.dataset\n    const targetApiVersion = apiVersion || DOCUMENTS_API_VERSION\n\n    if (!apiVersion) {\n      this.warn(`--api-version not specified, using \\`${DOCUMENTS_API_VERSION}\\``)\n    }\n\n    try {\n      const projectClient = await getProjectCliClient({\n        apiVersion: targetApiVersion,\n        dataset: targetDataset,\n        projectId: targetProject,\n        requireUser,\n      })\n\n      const docs = await projectClient.fetch(query)\n\n      if (!docs) {\n        this.error('Query returned no results', {exit: 1})\n      }\n\n      // Output the query results\n      if (pretty) {\n        this.log(colorizeJson(docs))\n      } else {\n        this.log(JSON.stringify(docs, null, 2))\n      }\n    } catch (error) {\n      const err = error as Error\n\n      queryDocumentDebug(`Error running query: ${query}`, err)\n\n      // Provide more context in error messages\n      const errorMsg = err.message.toLowerCase().includes('syntax')\n        ? `Invalid GROQ query syntax: ${err.message}`\n        : `Failed to run query: ${err.message}`\n\n      this.error(`${errorMsg}\\nQuery: ${query}`, {exit: 1})\n    }\n  }\n}\n"],"names":["Args","Flags","colorizeJson","getProjectCliClient","SanityCommand","subdebug","DOCUMENTS_API_VERSION","NO_PROJECT_ID","queryDocumentDebug","QueryDocumentCommand","args","query","string","description","required","examples","command","flags","anonymous","boolean","default","env","dataset","char","pretty","project","run","parse","apiVersion","cliConfig","getCliConfig","configProjectId","getProjectId","targetProject","requireUser","error","exit","api","targetDataset","targetApiVersion","warn","projectClient","projectId","docs","fetch","log","JSON","stringify","err","errorMsg","message","toLowerCase","includes"],"mappings":"AAAA,SAAQA,IAAI,EAAEC,KAAK,QAAO,cAAa;AACvC,SAAQC,YAAY,EAAEC,mBAAmB,EAAEC,aAAa,EAAEC,QAAQ,QAAO,mBAAkB;AAE3F,SAAQC,qBAAqB,QAAO,uCAAsC;AAC1E,SAAQC,aAAa,QAAO,8BAA6B;AAEzD,MAAMC,qBAAqBH,SAAS;AAEpC,OAAO,MAAMI,6BAA6BL;IACxC,OAAgBM,OAAO;QACrBC,OAAOX,KAAKY,MAAM,CAAC;YACjBC,aAAa;YACbC,UAAU;QACZ;IACF,EAAC;IAED,OAAgBD,cAAc,sBAAqB;IAEnD,OAAgBE,WAAW;QACzB;YACEC,SAAS;YACTH,aAAa;QACf;QACA;YACEG,SACE;YACFH,aAAa;QACf;QACA;YACEG,SACE;YACFH,aAAa;QACf;KACD,CAAA;IAED,OAAgBI,QAAQ;QACtBC,WAAWjB,MAAMkB,OAAO,CAAC;YACvBC,SAAS;YACTP,aAAa;QACf;QACA,eAAeZ,MAAMW,MAAM,CAAC;YAC1BC,aAAa,CAAC,gCAAgC,EAAEP,sBAAsB,CAAC,CAAC;YACxEe,KAAK;QACP;QACAC,SAASrB,MAAMW,MAAM,CAAC;YACpBW,MAAM;YACNV,aAAa;QACf;QACAW,QAAQvB,MAAMkB,OAAO,CAAC;YACpBC,SAAS;YACTP,aAAa;QACf;QACAY,SAASxB,MAAMW,MAAM,CAAC;YACpBW,MAAM;YACNV,aAAa;QACf;IACF,EAAC;IAED,MAAaa,MAAqB;QAChC,MAAM,EAAChB,IAAI,EAAEO,KAAK,EAAC,GAAG,MAAM,IAAI,CAACU,KAAK,CAAClB;QACvC,MAAM,EAACE,KAAK,EAAC,GAAGD;QAChB,MAAM,EAACQ,SAAS,EAAE,eAAeU,UAAU,EAAEN,OAAO,EAAEE,MAAM,EAAEC,OAAO,EAAC,GAAGR;QAEzE,4BAA4B;QAC5B,MAAMY,YAAY,MAAM,IAAI,CAACC,YAAY;QACzC,MAAMC,kBAAkB,MAAM,IAAI,CAACC,YAAY;QAE/C,MAAMC,gBAAgBR,WAAWM;QACjC,MAAMG,cAAc,CAAChB;QAErB,IAAI,CAACe,eAAe;YAClB,IAAI,CAACE,KAAK,CAAC5B,eAAe;gBAAC6B,MAAM;YAAC;QACpC;QAEA,IAAI,CAACP,UAAUQ,GAAG,EAAEf,WAAW,CAACA,SAAS;YACvC,IAAI,CAACa,KAAK,CACR,+FACA;gBAACC,MAAM;YAAC;QAEZ;QAEA,MAAME,gBAAgBhB,WAAWO,UAAUQ,GAAG,EAAEf;QAChD,MAAMiB,mBAAmBX,cAActB;QAEvC,IAAI,CAACsB,YAAY;YACf,IAAI,CAACY,IAAI,CAAC,CAAC,qCAAqC,EAAElC,sBAAsB,EAAE,CAAC;QAC7E;QAEA,IAAI;YACF,MAAMmC,gBAAgB,MAAMtC,oBAAoB;gBAC9CyB,YAAYW;gBACZjB,SAASgB;gBACTI,WAAWT;gBACXC;YACF;YAEA,MAAMS,OAAO,MAAMF,cAAcG,KAAK,CAACjC;YAEvC,IAAI,CAACgC,MAAM;gBACT,IAAI,CAACR,KAAK,CAAC,6BAA6B;oBAACC,MAAM;gBAAC;YAClD;YAEA,2BAA2B;YAC3B,IAAIZ,QAAQ;gBACV,IAAI,CAACqB,GAAG,CAAC3C,aAAayC;YACxB,OAAO;gBACL,IAAI,CAACE,GAAG,CAACC,KAAKC,SAAS,CAACJ,MAAM,MAAM;YACtC;QACF,EAAE,OAAOR,OAAO;YACd,MAAMa,MAAMb;YAEZ3B,mBAAmB,CAAC,qBAAqB,EAAEG,OAAO,EAAEqC;YAEpD,yCAAyC;YACzC,MAAMC,WAAWD,IAAIE,OAAO,CAACC,WAAW,GAAGC,QAAQ,CAAC,YAChD,CAAC,2BAA2B,EAAEJ,IAAIE,OAAO,EAAE,GAC3C,CAAC,qBAAqB,EAAEF,IAAIE,OAAO,EAAE;YAEzC,IAAI,CAACf,KAAK,CAAC,GAAGc,SAAS,SAAS,EAAEtC,OAAO,EAAE;gBAACyB,MAAM;YAAC;QACrD;IACF;AACF"}

package/dist/commands/documents/validate.js

@@ -0,0 +1,142 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { styleText } from 'node:util';
+import { Flags } from '@oclif/core';
+import { SanityCommand } from '@sanity/cli-core';
+import { confirm, logSymbols } from '@sanity/cli-core/ux';
+import { validateDocuments } from '../../actions/documents/validate.js';
+import { reporters } from '../../actions/documents/validation/reporters/index.js';
+export class ValidateDocumentsCommand extends SanityCommand {
+    static description = 'Validate documents in a dataset against the studio schema';
+    static examples = [
+        {
+            command: '<%= config.bin %> <%= command.id %> --workspace default',
+            description: 'Validates all documents in a Sanity project with more than one workspace'
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> --workspace default --dataset staging',
+            description: 'Override the dataset specified in the workspace'
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> --yes > report.txt',
+            description: 'Save the results of the report into a file'
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> --level info',
+            description: 'Report out info level validation markers too'
+        }
+    ];
+    static flags = {
+        dataset: Flags.string({
+            char: 'd',
+            description: 'Override the dataset used. By default, this is derived from the given workspace'
+        }),
+        file: Flags.string({
+            description: 'Provide a path to either an .ndjson file or a tarball containing an .ndjson file'
+        }),
+        format: Flags.string({
+            description: 'The output format used to print the found validation markers and report progress'
+        }),
+        level: Flags.custom({
+            default: 'warning',
+            description: 'The minimum level reported out. Defaults to warning',
+            options: [
+                'error',
+                'warning',
+                'info'
+            ]
+        })(),
+        'max-custom-validation-concurrency': Flags.integer({
+            default: 5,
+            description: 'Specify how many custom validators can run concurrently'
+        }),
+        'max-fetch-concurrency': Flags.integer({
+            default: 25,
+            description: 'Specify how many `client.fetch` requests are allow concurrency at once'
+        }),
+        workspace: Flags.string({
+            description: 'The name of the workspace to use when downloading and validating all documents'
+        }),
+        yes: Flags.boolean({
+            char: 'y',
+            default: false,
+            description: 'Skips the first confirmation prompt'
+        })
+    };
+    async run() {
+        const { flags } = await this.parse(ValidateDocumentsCommand);
+        const { dataset, file, format, level, 'max-custom-validation-concurrency': maxCustomValidationConcurrency, 'max-fetch-concurrency': maxFetchConcurrency, workspace } = flags;
+        const unattendedMode = Boolean(flags.yes);
+        const cliConfig = await this.getCliConfig();
+        const workDir = (await this.getProjectRoot()).directory;
+        if (!unattendedMode) {
+            this.log(`${styleText('yellow', `${logSymbols.warning} Warning:`)} This command ${file ? 'reads all documents from your input file' : 'downloads all documents from your dataset'} and processes them through your local schema within a ` + `simulated browser environment.\n`);
+            this.log(`Potential pitfalls:\n`);
+            this.log(`- Processes all documents locally (excluding assets). Large datasets may require more resources.`);
+            this.log(`- Executes all custom validation functions. Some functions may need to be refactored for compatibility.`);
+            this.log(`- Not all standard browser features are available and may cause issues while loading your Studio.`);
+            this.log(`- Adheres to document permissions. Ensure this account can see all desired documents.`);
+            if (file) {
+                this.log(`- Checks for missing document references against the live dataset if not found in your file.`);
+            }
+            const confirmed = await confirm({
+                default: true,
+                message: `Are you sure you want to continue?`
+            });
+            if (!confirmed) {
+                this.error('User aborted', {
+                    exit: 1
+                });
+            }
+        }
+        if (format && !(format in reporters)) {
+            const formatter = new Intl.ListFormat('en-US', {
+                style: 'long',
+                type: 'conjunction'
+            });
+            this.error(`Did not recognize format '${format}'. Available formats are ${formatter.format(Object.keys(reporters).map((key)=>`'${key}'`))}`, {
+                exit: 1
+            });
+        }
+        let ndjsonFilePath;
+        if (file) {
+            const filePath = path.resolve(workDir, file);
+            const stat = await fs.promises.stat(filePath);
+            if (!stat.isFile()) {
+                this.error(`'--file' must point to a valid ndjson file or tarball`, {
+                    exit: 1
+                });
+            }
+            ndjsonFilePath = filePath;
+        }
+        try {
+            const overallLevel = await validateDocuments({
+                dataset,
+                level,
+                maxCustomValidationConcurrency,
+                maxFetchConcurrency,
+                ndjsonFilePath,
+                reporter: (worker)=>{
+                    const reporter = format && format in reporters ? reporters[format] : reporters.pretty;
+                    return reporter({
+                        flags,
+                        output: this.output,
+                        worker
+                    });
+                },
+                studioHost: cliConfig?.studioHost,
+                workDir,
+                workspace
+            });
+            if (overallLevel === 'error') {
+                this.exit(1);
+            }
+        } catch (err) {
+            this.error(err instanceof Error ? err.message : String(err), {
+                exit: 1
+            });
+        }
+    }
+}
+
+//# sourceMappingURL=validate.js.map

package/dist/commands/documents/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/commands/documents/validate.ts"],"sourcesContent":["import fs from 'node:fs'\nimport path from 'node:path'\nimport {styleText} from 'node:util'\n\nimport {Flags} from '@oclif/core'\nimport {SanityCommand} from '@sanity/cli-core'\nimport {confirm, logSymbols} from '@sanity/cli-core/ux'\n\nimport {type Level} from '../../actions/documents/types.js'\nimport {validateDocuments} from '../../actions/documents/validate.js'\nimport {reporters} from '../../actions/documents/validation/reporters/index.js'\n\nexport class ValidateDocumentsCommand extends SanityCommand<typeof ValidateDocumentsCommand> {\n  static description = 'Validate documents in a dataset against the studio schema'\n\n  static examples = [\n    {\n      command: '<%= config.bin %> <%= command.id %> --workspace default',\n      description: 'Validates all documents in a Sanity project with more than one workspace',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> --workspace default --dataset staging',\n      description: 'Override the dataset specified in the workspace',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> --yes > report.txt',\n      description: 'Save the results of the report into a file',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> --level info',\n      description: 'Report out info level validation markers too',\n    },\n  ]\n\n  static flags = {\n    dataset: Flags.string({\n      char: 'd',\n      description:\n        'Override the dataset used. By default, this is derived from the given workspace',\n    }),\n    file: Flags.string({\n      description:\n        'Provide a path to either an .ndjson file or a tarball containing an .ndjson file',\n    }),\n    format: Flags.string({\n      description:\n        'The output format used to print the found validation markers and report progress',\n    }),\n    level: Flags.custom<Level>({\n      default: 'warning',\n      description: 'The minimum level reported out. Defaults to warning',\n      options: ['error', 'warning', 'info'],\n    })(),\n    'max-custom-validation-concurrency': Flags.integer({\n      default: 5,\n      description: 'Specify how many custom validators can run concurrently',\n    }),\n    'max-fetch-concurrency': Flags.integer({\n      default: 25,\n      description: 'Specify how many `client.fetch` requests are allow concurrency at once',\n    }),\n    workspace: Flags.string({\n      description: 'The name of the workspace to use when downloading and validating all documents',\n    }),\n    yes: Flags.boolean({\n      char: 'y',\n      default: false,\n      description: 'Skips the first confirmation prompt',\n    }),\n  }\n\n  public async run(): Promise<void> {\n    const {flags} = await this.parse(ValidateDocumentsCommand)\n    const {\n      dataset,\n      file,\n      format,\n      level,\n      'max-custom-validation-concurrency': maxCustomValidationConcurrency,\n      'max-fetch-concurrency': maxFetchConcurrency,\n      workspace,\n    } = flags\n    const unattendedMode = Boolean(flags.yes)\n\n    const cliConfig = await this.getCliConfig()\n    const workDir = (await this.getProjectRoot()).directory\n\n    if (!unattendedMode) {\n      this.log(\n        `${styleText('yellow', `${logSymbols.warning} Warning:`)} This command ${\n          file\n            ? 'reads all documents from your input file'\n            : 'downloads all documents from your dataset'\n        } and processes them through your local schema within a ` +\n          `simulated browser environment.\\n`,\n      )\n      this.log(`Potential pitfalls:\\n`)\n      this.log(\n        `- Processes all documents locally (excluding assets). Large datasets may require more resources.`,\n      )\n      this.log(\n        `- Executes all custom validation functions. Some functions may need to be refactored for compatibility.`,\n      )\n      this.log(\n        `- Not all standard browser features are available and may cause issues while loading your Studio.`,\n      )\n      this.log(\n        `- Adheres to document permissions. Ensure this account can see all desired documents.`,\n      )\n      if (file) {\n        this.log(\n          `- Checks for missing document references against the live dataset if not found in your file.`,\n        )\n      }\n\n      const confirmed = await confirm({\n        default: true,\n        message: `Are you sure you want to continue?`,\n      })\n\n      if (!confirmed) {\n        this.error('User aborted', {exit: 1})\n      }\n    }\n\n    if (format && !(format in reporters)) {\n      const formatter = new Intl.ListFormat('en-US', {\n        style: 'long',\n        type: 'conjunction',\n      })\n      this.error(\n        `Did not recognize format '${format}'. Available formats are ${formatter.format(\n          Object.keys(reporters).map((key) => `'${key}'`),\n        )}`,\n        {exit: 1},\n      )\n    }\n\n    let ndjsonFilePath\n    if (file) {\n      const filePath = path.resolve(workDir, file)\n\n      const stat = await fs.promises.stat(filePath)\n      if (!stat.isFile()) {\n        this.error(`'--file' must point to a valid ndjson file or tarball`, {exit: 1})\n      }\n\n      ndjsonFilePath = filePath\n    }\n\n    try {\n      const overallLevel = await validateDocuments({\n        dataset,\n        level,\n        maxCustomValidationConcurrency,\n        maxFetchConcurrency,\n        ndjsonFilePath,\n        reporter: (worker) => {\n          const reporter =\n            format && format in reporters\n              ? reporters[format as keyof typeof reporters]\n              : reporters.pretty\n\n          return reporter({flags, output: this.output, worker})\n        },\n        studioHost: cliConfig?.studioHost,\n        workDir,\n        workspace,\n      })\n\n      if (overallLevel === 'error') {\n        this.exit(1)\n      }\n    } catch (err) {\n      this.error(err instanceof Error ? err.message : String(err), {exit: 1})\n    }\n  }\n}\n"],"names":["fs","path","styleText","Flags","SanityCommand","confirm","logSymbols","validateDocuments","reporters","ValidateDocumentsCommand","description","examples","command","flags","dataset","string","char","file","format","level","custom","default","options","integer","workspace","yes","boolean","run","parse","maxCustomValidationConcurrency","maxFetchConcurrency","unattendedMode","Boolean","cliConfig","getCliConfig","workDir","getProjectRoot","directory","log","warning","confirmed","message","error","exit","formatter","Intl","ListFormat","style","type","Object","keys","map","key","ndjsonFilePath","filePath","resolve","stat","promises","isFile","overallLevel","reporter","worker","pretty","output","studioHost","err","Error","String"],"mappings":"AAAA,OAAOA,QAAQ,UAAS;AACxB,OAAOC,UAAU,YAAW;AAC5B,SAAQC,SAAS,QAAO,YAAW;AAEnC,SAAQC,KAAK,QAAO,cAAa;AACjC,SAAQC,aAAa,QAAO,mBAAkB;AAC9C,SAAQC,OAAO,EAAEC,UAAU,QAAO,sBAAqB;AAGvD,SAAQC,iBAAiB,QAAO,sCAAqC;AACrE,SAAQC,SAAS,QAAO,wDAAuD;AAE/E,OAAO,MAAMC,iCAAiCL;IAC5C,OAAOM,cAAc,4DAA2D;IAEhF,OAAOC,WAAW;QAChB;YACEC,SAAS;YACTF,aAAa;QACf;QACA;YACEE,SAAS;YACTF,aAAa;QACf;QACA;YACEE,SAAS;YACTF,aAAa;QACf;QACA;YACEE,SAAS;YACTF,aAAa;QACf;KACD,CAAA;IAED,OAAOG,QAAQ;QACbC,SAASX,MAAMY,MAAM,CAAC;YACpBC,MAAM;YACNN,aACE;QACJ;QACAO,MAAMd,MAAMY,MAAM,CAAC;YACjBL,aACE;QACJ;QACAQ,QAAQf,MAAMY,MAAM,CAAC;YACnBL,aACE;QACJ;QACAS,OAAOhB,MAAMiB,MAAM,CAAQ;YACzBC,SAAS;YACTX,aAAa;YACbY,SAAS;gBAAC;gBAAS;gBAAW;aAAO;QACvC;QACA,qCAAqCnB,MAAMoB,OAAO,CAAC;YACjDF,SAAS;YACTX,aAAa;QACf;QACA,yBAAyBP,MAAMoB,OAAO,CAAC;YACrCF,SAAS;YACTX,aAAa;QACf;QACAc,WAAWrB,MAAMY,MAAM,CAAC;YACtBL,aAAa;QACf;QACAe,KAAKtB,MAAMuB,OAAO,CAAC;YACjBV,MAAM;YACNK,SAAS;YACTX,aAAa;QACf;IACF,EAAC;IAED,MAAaiB,MAAqB;QAChC,MAAM,EAACd,KAAK,EAAC,GAAG,MAAM,IAAI,CAACe,KAAK,CAACnB;QACjC,MAAM,EACJK,OAAO,EACPG,IAAI,EACJC,MAAM,EACNC,KAAK,EACL,qCAAqCU,8BAA8B,EACnE,yBAAyBC,mBAAmB,EAC5CN,SAAS,EACV,GAAGX;QACJ,MAAMkB,iBAAiBC,QAAQnB,MAAMY,GAAG;QAExC,MAAMQ,YAAY,MAAM,IAAI,CAACC,YAAY;QACzC,MAAMC,UAAU,AAAC,CAAA,MAAM,IAAI,CAACC,cAAc,EAAC,EAAGC,SAAS;QAEvD,IAAI,CAACN,gBAAgB;YACnB,IAAI,CAACO,GAAG,CACN,GAAGpC,UAAU,UAAU,GAAGI,WAAWiC,OAAO,CAAC,SAAS,CAAC,EAAE,cAAc,EACrEtB,OACI,6CACA,4CACL,uDAAuD,CAAC,GACvD,CAAC,gCAAgC,CAAC;YAEtC,IAAI,CAACqB,GAAG,CAAC,CAAC,qBAAqB,CAAC;YAChC,IAAI,CAACA,GAAG,CACN,CAAC,gGAAgG,CAAC;YAEpG,IAAI,CAACA,GAAG,CACN,CAAC,uGAAuG,CAAC;YAE3G,IAAI,CAACA,GAAG,CACN,CAAC,iGAAiG,CAAC;YAErG,IAAI,CAACA,GAAG,CACN,CAAC,qFAAqF,CAAC;YAEzF,IAAIrB,MAAM;gBACR,IAAI,CAACqB,GAAG,CACN,CAAC,4FAA4F,CAAC;YAElG;YAEA,MAAME,YAAY,MAAMnC,QAAQ;gBAC9BgB,SAAS;gBACToB,SAAS,CAAC,kCAAkC,CAAC;YAC/C;YAEA,IAAI,CAACD,WAAW;gBACd,IAAI,CAACE,KAAK,CAAC,gBAAgB;oBAACC,MAAM;gBAAC;YACrC;QACF;QAEA,IAAIzB,UAAU,CAAEA,CAAAA,UAAUV,SAAQ,GAAI;YACpC,MAAMoC,YAAY,IAAIC,KAAKC,UAAU,CAAC,SAAS;gBAC7CC,OAAO;gBACPC,MAAM;YACR;YACA,IAAI,CAACN,KAAK,CACR,CAAC,0BAA0B,EAAExB,OAAO,yBAAyB,EAAE0B,UAAU1B,MAAM,CAC7E+B,OAAOC,IAAI,CAAC1C,WAAW2C,GAAG,CAAC,CAACC,MAAQ,CAAC,CAAC,EAAEA,IAAI,CAAC,CAAC,IAC7C,EACH;gBAACT,MAAM;YAAC;QAEZ;QAEA,IAAIU;QACJ,IAAIpC,MAAM;YACR,MAAMqC,WAAWrD,KAAKsD,OAAO,CAACpB,SAASlB;YAEvC,MAAMuC,OAAO,MAAMxD,GAAGyD,QAAQ,CAACD,IAAI,CAACF;YACpC,IAAI,CAACE,KAAKE,MAAM,IAAI;gBAClB,IAAI,CAAChB,KAAK,CAAC,CAAC,qDAAqD,CAAC,EAAE;oBAACC,MAAM;gBAAC;YAC9E;YAEAU,iBAAiBC;QACnB;QAEA,IAAI;YACF,MAAMK,eAAe,MAAMpD,kBAAkB;gBAC3CO;gBACAK;gBACAU;gBACAC;gBACAuB;gBACAO,UAAU,CAACC;oBACT,MAAMD,WACJ1C,UAAUA,UAAUV,YAChBA,SAAS,CAACU,OAAiC,GAC3CV,UAAUsD,MAAM;oBAEtB,OAAOF,SAAS;wBAAC/C;wBAAOkD,QAAQ,IAAI,CAACA,MAAM;wBAAEF;oBAAM;gBACrD;gBACAG,YAAY/B,WAAW+B;gBACvB7B;gBACAX;YACF;YAEA,IAAImC,iBAAiB,SAAS;gBAC5B,IAAI,CAAChB,IAAI,CAAC;YACZ;QACF,EAAE,OAAOsB,KAAK;YACZ,IAAI,CAACvB,KAAK,CAACuB,eAAeC,QAAQD,IAAIxB,OAAO,GAAG0B,OAAOF,MAAM;gBAACtB,MAAM;YAAC;QACvE;IACF;AACF"}

package/dist/commands/exec.js

@@ -0,0 +1,54 @@
+import { Args, Flags } from '@oclif/core';
+import { SanityCommand } from '@sanity/cli-core';
+import { execScript } from '../actions/exec/execScript.js';
+export class ExecCommand extends SanityCommand {
+    static args = {
+        script: Args.file({
+            description: 'Path to the script to execute',
+            exists: true,
+            required: true
+        })
+    };
+    static description = 'Executes a script within the Sanity Studio context';
+    static examples = [
+        {
+            command: '<%= config.bin %> <%= command.id %> some/script.js',
+            description: 'Run the script at some/script.js in Sanity context'
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> migrations/fullname.ts --with-user-token',
+            description: "Run the script at migrations/fullname.ts and configure `getCliClient()` from `sanity/cli` to include the current user's token"
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> scripts/browserScript.js --mock-browser-env',
+            description: 'Run the script at scripts/browserScript.js in a mock browser environment'
+        },
+        {
+            command: '<%= config.bin %> <%= command.id %> --mock-browser-env myscript.js -- --dry-run positional-argument',
+            description: "Pass arbitrary arguments to scripts by separating them with a `--`. Arguments are available in `process.argv` as they would in regular node scripts (eg the following command would yield a `process.argv` of: `['/path/to/node', '/path/to/myscript.js', '--dry-run', 'positional-argument']`)"
+        }
+    ];
+    static flags = {
+        'mock-browser-env': Flags.boolean({
+            default: false,
+            description: 'Mocks a browser-like environment using jsdom'
+        }),
+        'with-user-token': Flags.boolean({
+            default: false,
+            description: 'Prime access token from CLI config into getCliClient()'
+        })
+    };
+    static strict = false;
+    async run() {
+        const { args, argv, flags } = await this.parse(ExecCommand);
+        const { directory: workDir } = await this.getProjectRoot();
+        await execScript({
+            extraArguments: argv.slice(1),
+            flags,
+            scriptPath: args.script,
+            workDir
+        });
+    }
+}
+
+//# sourceMappingURL=exec.js.map

package/dist/commands/exec.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/commands/exec.ts"],"sourcesContent":["import {Args, Flags} from '@oclif/core'\nimport {SanityCommand} from '@sanity/cli-core'\n\nimport {execScript} from '../actions/exec/execScript.js'\n\nexport class ExecCommand extends SanityCommand<typeof ExecCommand> {\n  static override args = {\n    script: Args.file({\n      description: 'Path to the script to execute',\n      exists: true,\n      required: true,\n    }),\n  }\n\n  static override description = 'Executes a script within the Sanity Studio context'\n\n  static override examples = [\n    {\n      command: '<%= config.bin %> <%= command.id %> some/script.js',\n      description: 'Run the script at some/script.js in Sanity context',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> migrations/fullname.ts --with-user-token',\n      description:\n        \"Run the script at migrations/fullname.ts and configure `getCliClient()` from `sanity/cli` to include the current user's token\",\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> scripts/browserScript.js --mock-browser-env',\n      description: 'Run the script at scripts/browserScript.js in a mock browser environment',\n    },\n    {\n      command:\n        '<%= config.bin %> <%= command.id %> --mock-browser-env myscript.js -- --dry-run positional-argument',\n      description:\n        \"Pass arbitrary arguments to scripts by separating them with a `--`. Arguments are available in `process.argv` as they would in regular node scripts (eg the following command would yield a `process.argv` of: `['/path/to/node', '/path/to/myscript.js', '--dry-run', 'positional-argument']`)\",\n    },\n  ]\n\n  static override flags = {\n    'mock-browser-env': Flags.boolean({\n      default: false,\n      description: 'Mocks a browser-like environment using jsdom',\n    }),\n    'with-user-token': Flags.boolean({\n      default: false,\n      description: 'Prime access token from CLI config into getCliClient()',\n    }),\n  }\n\n  static override strict = false\n\n  public async run(): Promise<void> {\n    const {args, argv, flags} = await this.parse(ExecCommand)\n    const {directory: workDir} = await this.getProjectRoot()\n\n    await execScript({\n      extraArguments: (argv as string[]).slice(1), // Remove the script path from argv\n      flags,\n      scriptPath: args.script,\n      workDir,\n    })\n  }\n}\n"],"names":["Args","Flags","SanityCommand","execScript","ExecCommand","args","script","file","description","exists","required","examples","command","flags","boolean","default","strict","run","argv","parse","directory","workDir","getProjectRoot","extraArguments","slice","scriptPath"],"mappings":"AAAA,SAAQA,IAAI,EAAEC,KAAK,QAAO,cAAa;AACvC,SAAQC,aAAa,QAAO,mBAAkB;AAE9C,SAAQC,UAAU,QAAO,gCAA+B;AAExD,OAAO,MAAMC,oBAAoBF;IAC/B,OAAgBG,OAAO;QACrBC,QAAQN,KAAKO,IAAI,CAAC;YAChBC,aAAa;YACbC,QAAQ;YACRC,UAAU;QACZ;IACF,EAAC;IAED,OAAgBF,cAAc,qDAAoD;IAElF,OAAgBG,WAAW;QACzB;YACEC,SAAS;YACTJ,aAAa;QACf;QACA;YACEI,SAAS;YACTJ,aACE;QACJ;QACA;YACEI,SAAS;YACTJ,aAAa;QACf;QACA;YACEI,SACE;YACFJ,aACE;QACJ;KACD,CAAA;IAED,OAAgBK,QAAQ;QACtB,oBAAoBZ,MAAMa,OAAO,CAAC;YAChCC,SAAS;YACTP,aAAa;QACf;QACA,mBAAmBP,MAAMa,OAAO,CAAC;YAC/BC,SAAS;YACTP,aAAa;QACf;IACF,EAAC;IAED,OAAgBQ,SAAS,MAAK;IAE9B,MAAaC,MAAqB;QAChC,MAAM,EAACZ,IAAI,EAAEa,IAAI,EAAEL,KAAK,EAAC,GAAG,MAAM,IAAI,CAACM,KAAK,CAACf;QAC7C,MAAM,EAACgB,WAAWC,OAAO,EAAC,GAAG,MAAM,IAAI,CAACC,cAAc;QAEtD,MAAMnB,WAAW;YACfoB,gBAAgB,AAACL,KAAkBM,KAAK,CAAC;YACzCX;YACAY,YAAYpB,KAAKC,MAAM;YACvBe;QACF;IACF;AACF"}