@sanity/cli 7.10.0 → 7.11.0

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/commands/documents/create.ts"],"sourcesContent":["import {randomUUID} from 'node:crypto'\nimport fs from 'node:fs/promises'\nimport os from 'node:os'\nimport path from 'node:path'\n\nimport {Args, Flags} from '@oclif/core'\nimport {getProjectCliClient, SanityCommand, subdebug} from '@sanity/cli-core'\nimport {type MultipleMutationResult, type Mutation} from '@sanity/client'\nimport {watch as chokidarWatch} from 'chokidar'\nimport {execa, execaSync} from 'execa'\nimport json5 from 'json5'\nimport isEqual from 'lodash-es/isEqual.js'\nimport isPlainObject from 'lodash-es/isPlainObject.js'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {getEditor, registerUnlinkOnSigInt} from '../../actions/documents/editor.js'\nimport {promptForProject} from '../../prompts/promptForProject.js'\nimport {isIdentifiedSanityDocument, isSanityDocumentish} from '../../util/isSanityDocumentish.js'\nimport {getDatasetFlag, getProjectIdFlag} from '../../util/sharedFlags.js'\n\nexport type MutationOperationName = 'create' | 'createIfNotExists' | 'createOrReplace'\n\nconst createDocumentDebug = subdebug('documents:create')\n\nexport class CreateDocumentCommand extends SanityCommand<typeof CreateDocumentCommand> {\n  static override args = {\n    file: Args.string({\n      description: 'JSON file to create document(s) from',\n      required: false,\n    }),\n  }\n\n  static override description = 'Create one or more documents'\n\n  static override examples = [\n    {\n      command: '<%= config.bin %> <%= command.id %> myDocument.json',\n      description: 'Create the document specified in \"myDocument.json\"',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %>',\n      description: 'Open configured $EDITOR and create the specified document(s)',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> --id myDocId --replace',\n      description:\n        'Fetch document with the ID \"myDocId\" and open configured $EDITOR with the current document content (if any). Replace document with the edited version when the editor closes',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> --id myDocId --watch --replace --json5',\n      description:\n        'Open configured $EDITOR and replace the document with the given content on each save. Use JSON5 file extension and parser for simplified syntax.',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> myDocument.json --project-id abc123',\n      description: 'Create documents in a specific project',\n    },\n  ]\n\n  static override flags = {\n    ...getProjectIdFlag({\n      description: 'Project ID to create document(s) in',\n      semantics: 'override',\n    }),\n    ...getDatasetFlag({\n      description: 'Dataset to create document(s) in',\n      semantics: 'override',\n    }),\n    id: Flags.string({\n      description:\n        'Specify a document ID to use. Will fetch remote document ID and populate editor.',\n    }),\n    json5: Flags.boolean({\n      description: 'Use JSON5 file type to allow a \"simplified\" version of JSON',\n    }),\n    missing: Flags.boolean({\n      description: \"On duplicate document IDs, don't modify the target document(s)\",\n    }),\n    replace: Flags.boolean({\n      description:\n        'On duplicate document IDs, replace existing document with specified document(s)',\n    }),\n    watch: Flags.boolean({\n      description: 'Write the documents whenever the target file or buffer changes',\n    }),\n  }\n\n  static override hiddenAliases: string[] = ['document:create']\n\n  private client!: Awaited<ReturnType<typeof getProjectCliClient>>\n\n  public async run(): Promise<void> {\n    const {args, flags} = await this.parse(CreateDocumentCommand)\n    const {file} = args\n    const {dataset, id, json5: useJson5, missing, replace, watch} = flags\n\n    const cliConfig = await this.tryGetCliConfig()\n\n    const projectId = await this.getProjectId({fallback: () => promptForProject({})})\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    this.client = await getProjectCliClient({\n      apiVersion: DOCUMENTS_API_VERSION,\n      dataset: targetDataset,\n      projectId,\n      requireUser: true,\n    })\n\n    if (replace && missing) {\n      this.error('Cannot use both --replace and --missing', {exit: 1})\n    }\n\n    if (id && file) {\n      this.error('Cannot use --id when specifying a file path', {exit: 1})\n    }\n\n    let operation: MutationOperationName = 'create'\n    if (replace || missing) {\n      operation = replace ? 'createOrReplace' : 'createIfNotExists'\n    }\n\n    if (file) {\n      try {\n        const contentPath = path.resolve(process.cwd(), file)\n        const content = json5.parse(await fs.readFile(contentPath, 'utf8'))\n        const result = await this.writeDocuments(content, operation)\n        this.log(this.getResultMessage(result, operation))\n        return\n      } catch (error) {\n        const err = error as Error\n        createDocumentDebug(`Error creating documents from file ${file}`, err)\n        this.error(`Failed to create documents: ${err.message}`, {exit: 1})\n      }\n    }\n\n    try {\n      // Create a temporary file and use that as source, opening an editor on it\n      const docId = id || randomUUID()\n      const ext = useJson5 ? 'json5' : 'json'\n      // Add UUID prefix to prevent predictable file names and potential conflicts\n      const tmpFile = path.join(os.tmpdir(), 'sanity-cli', `${randomUUID()}-${docId}.${ext}`)\n      const stringify = useJson5 ? json5.stringify : JSON.stringify\n      const defaultValue = (id && (await this.client.getDocument(id))) || {\n        _id: docId,\n        _type: 'specify-me',\n      }\n\n      // Create temp directory with restricted permissions (owner only)\n      const tempDir = path.join(os.tmpdir(), 'sanity-cli')\n      await fs.mkdir(tempDir, {\n        mode: 0o700, // rwx------ (owner read/write/execute only)\n        recursive: true,\n      })\n\n      // Write file with restricted permissions (owner read/write only)\n      await fs.writeFile(tmpFile, stringify(defaultValue, null, 2), {\n        encoding: 'utf8',\n        mode: 0o600, // rw------- (owner read/write only)\n      })\n\n      const editor = getEditor()\n      const readAndPerformCreatesFromFile = this.readAndPerformCreatesFromFile.bind(this, operation)\n\n      if (watch) {\n        // If we're in watch mode, we want to run the creation on each change (if it validates)\n        registerUnlinkOnSigInt(tmpFile)\n        this.log(`Watch mode: ${tmpFile}`)\n        this.log('Watch mode: Will write documents on each save.')\n        this.log('Watch mode: Press Ctrl + C to cancel watch mode.')\n\n        // Add race condition protection\n        let isProcessing = false\n        chokidarWatch(tmpFile).on('change', async () => {\n          if (isProcessing) {\n            return // Skip if already processing\n          }\n          isProcessing = true\n\n          this.log('')\n          try {\n            await readAndPerformCreatesFromFile(tmpFile, defaultValue)\n          } finally {\n            isProcessing = false\n          }\n        })\n        execa(editor.bin, [...editor.args, tmpFile], {stdio: 'inherit'})\n      } else {\n        // While in normal mode, we just want to wait for the editor to close and run the thing once\n        execaSync(editor.bin, [...editor.args, tmpFile], {stdio: 'inherit'})\n        await readAndPerformCreatesFromFile(tmpFile, defaultValue)\n        await fs.unlink(tmpFile).catch(() => {})\n      }\n    } catch (error) {\n      const err = error as Error\n      createDocumentDebug('Error in editor workflow', err)\n      this.error(`Failed to create documents: ${err.message}`, {exit: 1})\n    }\n  }\n\n  private getErrorMessage(message: string, index: number, isSingle: boolean): string {\n    return isSingle ? `Document ${message}` : `Document at index ${index} ${message}`\n  }\n\n  /**\n   * Formats the result message for document operations\n   */\n  private getResultMessage(\n    result: MultipleMutationResult,\n    operation: MutationOperationName,\n  ): string {\n    const joiner = '\\n  - '\n    if (operation === 'createOrReplace') {\n      return `Upserted:\\n  - ${result.results.map((res) => res.id).join(joiner)}`\n    }\n\n    if (operation === 'create') {\n      return `Created:\\n  - ${result.results.map((res) => res.id).join(joiner)}`\n    }\n\n    // \"Missing\" (createIfNotExists)\n    const created: string[] = []\n    const skipped: string[] = []\n    for (const res of result.results) {\n      if (res.operation === 'update') {\n        skipped.push(res.id)\n      } else {\n        created.push(res.id)\n      }\n    }\n\n    if (created.length > 0 && skipped.length > 0) {\n      return [\n        `Created:\\n  - ${created.join(joiner)}`,\n        `Skipped (already exists):${joiner}${skipped.join(joiner)}`,\n      ].join('\\n\\n')\n    } else if (created.length > 0) {\n      return `Created:\\n  - ${created.join(joiner)}`\n    }\n\n    return `Skipped (already exists):\\n  - ${skipped.join(joiner)}`\n  }\n\n  /**\n   * Reads and processes documents from a file for creation\n   */\n  private async readAndPerformCreatesFromFile(\n    operation: MutationOperationName,\n    filePath: string,\n    defaultValue: unknown,\n  ): Promise<void> {\n    let content\n    try {\n      content = json5.parse(await fs.readFile(filePath, 'utf8'))\n    } catch (err) {\n      const error = err as Error\n      createDocumentDebug(`Failed to read input file ${filePath}`, error)\n      this.log(`Failed to read input: ${error.message}`)\n      return\n    }\n\n    if (isEqual(content, defaultValue)) {\n      this.log('Value not modified, doing nothing.')\n      this.log('Modify document to trigger creation.')\n      return\n    }\n\n    try {\n      const writeResult = await this.writeDocuments(content, operation)\n      this.log(this.getResultMessage(writeResult, operation))\n    } catch (err) {\n      const error = err as Error\n      createDocumentDebug(`Failed to write documents`, error)\n      let errorMessage = `Failed to write documents: ${error.message}`\n      if (error.message.includes('already exists')) {\n        errorMessage += '\\nPerhaps you want to use `--replace` or `--missing`?'\n      }\n      this.error(errorMessage, {exit: 1})\n    }\n  }\n\n  /**\n   * Validates a document for Sanity requirements\n   */\n  private validateDocument(doc: unknown, index: number, arr: unknown[]): void {\n    const isSingle = arr.length === 1\n\n    if (!isPlainObject(doc)) {\n      throw new Error(this.getErrorMessage('must be an object', index, isSingle))\n    }\n\n    if (!isSanityDocumentish(doc)) {\n      throw new Error(\n        this.getErrorMessage('must have a `_type` property of type string', index, isSingle),\n      )\n    }\n\n    // Enhanced validations for Sanity document constraints\n    const docObj = doc as Record<string, unknown>\n\n    // Validate _type is non-empty\n    const typeValue = docObj._type?.toString().trim()\n    if (!typeValue) {\n      throw new Error(this.getErrorMessage('_type cannot be empty', index, isSingle))\n    }\n\n    // Validate _type format (alphanumeric, underscore, hyphen, dot)\n    if (!/^[a-zA-Z][a-zA-Z0-9_.-]*$/.test(typeValue)) {\n      throw new Error(\n        this.getErrorMessage(\n          '_type must start with a letter and contain only alphanumeric characters, underscores, hyphens, and dots',\n          index,\n          isSingle,\n        ),\n      )\n    }\n\n    // Validate _id format if present\n    if (docObj._id && typeof docObj._id === 'string') {\n      const idValue = docObj._id.trim()\n      if (!idValue) {\n        throw new Error(this.getErrorMessage('_id cannot be empty', index, isSingle))\n      }\n\n      // Sanity document IDs can contain alphanumeric chars, hyphens, underscores, and dots\n      if (!/^[a-zA-Z0-9_.-]+$/.test(idValue)) {\n        throw new Error(\n          this.getErrorMessage(\n            '_id can only contain alphanumeric characters, underscores, hyphens, and dots',\n            index,\n            isSingle,\n          ),\n        )\n      }\n\n      // Check length constraints (Sanity has reasonable limits)\n      if (idValue.length > 200) {\n        throw new Error(\n          this.getErrorMessage('_id cannot be longer than 200 characters', index, isSingle),\n        )\n      }\n    }\n\n    // Warn about reserved fields (these are managed by Sanity)\n    const reservedFields = ['_rev', '_updatedAt', '_createdAt']\n    for (const field of reservedFields) {\n      if (field in docObj) {\n        // Note: We don't throw an error here as these might be present in fetched documents\n        // that are being re-uploaded, but we could add a debug warning\n        createDocumentDebug(\n          `Warning: Document ${index} contains reserved field '${field}' which will be ignored by Sanity`,\n        )\n      }\n    }\n  }\n\n  /**\n   * Writes documents to Sanity using the specified operation\n   */\n  private async writeDocuments(\n    documents: {_id?: string; _type: string} | {_id?: string; _type: string}[],\n    operation: MutationOperationName,\n  ): Promise<MultipleMutationResult> {\n    const docs = Array.isArray(documents) ? documents : [documents]\n    if (docs.length === 0) {\n      throw new Error('No documents provided')\n    }\n\n    const mutations = docs.map((doc, index): Mutation => {\n      this.validateDocument(doc, index, docs)\n      if (operation === 'create') {\n        return {create: doc}\n      }\n\n      if (operation === 'createIfNotExists') {\n        if (isIdentifiedSanityDocument(doc)) {\n          return {createIfNotExists: doc}\n        }\n\n        throw new Error(`Missing required _id attribute for ${operation}`)\n      }\n\n      if (operation === 'createOrReplace') {\n        if (isIdentifiedSanityDocument(doc)) {\n          return {createOrReplace: doc}\n        }\n\n        throw new Error(`Missing required _id attribute for ${operation}`)\n      }\n\n      throw new Error(`Unsupported operation ${operation}`)\n    })\n\n    return this.client.transaction(mutations).commit()\n  }\n}\n"],"names":["randomUUID","fs","os","path","Args","Flags","getProjectCliClient","SanityCommand","subdebug","watch","chokidarWatch","execa","execaSync","json5","isEqual","isPlainObject","DOCUMENTS_API_VERSION","getEditor","registerUnlinkOnSigInt","promptForProject","isIdentifiedSanityDocument","isSanityDocumentish","getDatasetFlag","getProjectIdFlag","createDocumentDebug","CreateDocumentCommand","args","file","string","description","required","examples","command","flags","semantics","id","boolean","missing","replace","hiddenAliases","client","run","parse","dataset","useJson5","cliConfig","tryGetCliConfig","projectId","getProjectId","fallback","api","error","exit","targetDataset","apiVersion","requireUser","operation","contentPath","resolve","process","cwd","content","readFile","result","writeDocuments","log","getResultMessage","err","message","docId","ext","tmpFile","join","tmpdir","stringify","JSON","defaultValue","getDocument","_id","_type","tempDir","mkdir","mode","recursive","writeFile","encoding","editor","readAndPerformCreatesFromFile","bind","isProcessing","on","bin","stdio","unlink","catch","getErrorMessage","index","isSingle","joiner","results","map","res","created","skipped","push","length","filePath","writeResult","errorMessage","includes","validateDocument","doc","arr","Error","docObj","typeValue","toString","trim","test","idValue","reservedFields","field","documents","docs","Array","isArray","mutations","create","createIfNotExists","createOrReplace","transaction","commit"],"mappings":"AAAA,SAAQA,UAAU,QAAO,cAAa;AACtC,OAAOC,QAAQ,mBAAkB;AACjC,OAAOC,QAAQ,UAAS;AACxB,OAAOC,UAAU,YAAW;AAE5B,SAAQC,IAAI,EAAEC,KAAK,QAAO,cAAa;AACvC,SAAQC,mBAAmB,EAAEC,aAAa,EAAEC,QAAQ,QAAO,mBAAkB;AAE7E,SAAQC,SAASC,aAAa,QAAO,WAAU;AAC/C,SAAQC,KAAK,EAAEC,SAAS,QAAO,QAAO;AACtC,OAAOC,WAAW,QAAO;AACzB,OAAOC,aAAa,uBAAsB;AAC1C,OAAOC,mBAAmB,6BAA4B;AAEtD,SAAQC,qBAAqB,QAAO,uCAAsC;AAC1E,SAAQC,SAAS,EAAEC,sBAAsB,QAAO,oCAAmC;AACnF,SAAQC,gBAAgB,QAAO,oCAAmC;AAClE,SAAQC,0BAA0B,EAAEC,mBAAmB,QAAO,oCAAmC;AACjG,SAAQC,cAAc,EAAEC,gBAAgB,QAAO,4BAA2B;AAI1E,MAAMC,sBAAsBhB,SAAS;AAErC,OAAO,MAAMiB,8BAA8BlB;IACzC,OAAgBmB,OAAO;QACrBC,MAAMvB,KAAKwB,MAAM,CAAC;YAChBC,aAAa;YACbC,UAAU;QACZ;IACF,EAAC;IAED,OAAgBD,cAAc,+BAA8B;IAE5D,OAAgBE,WAAW;QACzB;YACEC,SAAS;YACTH,aAAa;QACf;QACA;YACEG,SAAS;YACTH,aAAa;QACf;QACA;YACEG,SAAS;YACTH,aACE;QACJ;QACA;YACEG,SAAS;YACTH,aACE;QACJ;QACA;YACEG,SAAS;YACTH,aAAa;QACf;KACD,CAAA;IAED,OAAgBI,QAAQ;QACtB,GAAGV,iBAAiB;YAClBM,aAAa;YACbK,WAAW;QACb,EAAE;QACF,GAAGZ,eAAe;YAChBO,aAAa;YACbK,WAAW;QACb,EAAE;QACFC,IAAI9B,MAAMuB,MAAM,CAAC;YACfC,aACE;QACJ;QACAhB,OAAOR,MAAM+B,OAAO,CAAC;YACnBP,aAAa;QACf;QACAQ,SAAShC,MAAM+B,OAAO,CAAC;YACrBP,aAAa;QACf;QACAS,SAASjC,MAAM+B,OAAO,CAAC;YACrBP,aACE;QACJ;QACApB,OAAOJ,MAAM+B,OAAO,CAAC;YACnBP,aAAa;QACf;IACF,EAAC;IAED,OAAgBU,gBAA0B;QAAC;KAAkB,CAAA;IAErDC,OAAwD;IAEhE,MAAaC,MAAqB;QAChC,MAAM,EAACf,IAAI,EAAEO,KAAK,EAAC,GAAG,MAAM,IAAI,CAACS,KAAK,CAACjB;QACvC,MAAM,EAACE,IAAI,EAAC,GAAGD;QACf,MAAM,EAACiB,OAAO,EAAER,EAAE,EAAEtB,OAAO+B,QAAQ,EAAEP,OAAO,EAAEC,OAAO,EAAE7B,KAAK,EAAC,GAAGwB;QAEhE,MAAMY,YAAY,MAAM,IAAI,CAACC,eAAe;QAE5C,MAAMC,YAAY,MAAM,IAAI,CAACC,YAAY,CAAC;YAACC,UAAU,IAAM9B,iBAAiB,CAAC;QAAE;QAE/E,IAAI,CAAC0B,UAAUK,GAAG,EAAEP,WAAW,CAACA,SAAS;YACvC,IAAI,CAACQ,KAAK,CACR,+FACA;gBAACC,MAAM;YAAC;QAEZ;QAEA,MAAMC,gBAAgBV,WAAWE,UAAUK,GAAG,EAAEP;QAEhD,IAAI,CAACH,MAAM,GAAG,MAAMlC,oBAAoB;YACtCgD,YAAYtC;YACZ2B,SAASU;YACTN;YACAQ,aAAa;QACf;QAEA,IAAIjB,WAAWD,SAAS;YACtB,IAAI,CAACc,KAAK,CAAC,2CAA2C;gBAACC,MAAM;YAAC;QAChE;QAEA,IAAIjB,MAAMR,MAAM;YACd,IAAI,CAACwB,KAAK,CAAC,+CAA+C;gBAACC,MAAM;YAAC;QACpE;QAEA,IAAII,YAAmC;QACvC,IAAIlB,WAAWD,SAAS;YACtBmB,YAAYlB,UAAU,oBAAoB;QAC5C;QAEA,IAAIX,MAAM;YACR,IAAI;gBACF,MAAM8B,cAActD,KAAKuD,OAAO,CAACC,QAAQC,GAAG,IAAIjC;gBAChD,MAAMkC,UAAUhD,MAAM6B,KAAK,CAAC,MAAMzC,GAAG6D,QAAQ,CAACL,aAAa;gBAC3D,MAAMM,SAAS,MAAM,IAAI,CAACC,cAAc,CAACH,SAASL;gBAClD,IAAI,CAACS,GAAG,CAAC,IAAI,CAACC,gBAAgB,CAACH,QAAQP;gBACvC;YACF,EAAE,OAAOL,OAAO;gBACd,MAAMgB,MAAMhB;gBACZ3B,oBAAoB,CAAC,mCAAmC,EAAEG,MAAM,EAAEwC;gBAClE,IAAI,CAAChB,KAAK,CAAC,CAAC,4BAA4B,EAAEgB,IAAIC,OAAO,EAAE,EAAE;oBAAChB,MAAM;gBAAC;YACnE;QACF;QAEA,IAAI;YACF,0EAA0E;YAC1E,MAAMiB,QAAQlC,MAAMnC;YACpB,MAAMsE,MAAM1B,WAAW,UAAU;YACjC,4EAA4E;YAC5E,MAAM2B,UAAUpE,KAAKqE,IAAI,CAACtE,GAAGuE,MAAM,IAAI,cAAc,GAAGzE,aAAa,CAAC,EAAEqE,MAAM,CAAC,EAAEC,KAAK;YACtF,MAAMI,YAAY9B,WAAW/B,MAAM6D,SAAS,GAAGC,KAAKD,SAAS;YAC7D,MAAME,eAAe,AAACzC,MAAO,MAAM,IAAI,CAACK,MAAM,CAACqC,WAAW,CAAC1C,OAAS;gBAClE2C,KAAKT;gBACLU,OAAO;YACT;YAEA,iEAAiE;YACjE,MAAMC,UAAU7E,KAAKqE,IAAI,CAACtE,GAAGuE,MAAM,IAAI;YACvC,MAAMxE,GAAGgF,KAAK,CAACD,SAAS;gBACtBE,MAAM;gBACNC,WAAW;YACb;YAEA,iEAAiE;YACjE,MAAMlF,GAAGmF,SAAS,CAACb,SAASG,UAAUE,cAAc,MAAM,IAAI;gBAC5DS,UAAU;gBACVH,MAAM;YACR;YAEA,MAAMI,SAASrE;YACf,MAAMsE,gCAAgC,IAAI,CAACA,6BAA6B,CAACC,IAAI,CAAC,IAAI,EAAEhC;YAEpF,IAAI/C,OAAO;gBACT,uFAAuF;gBACvFS,uBAAuBqD;gBACvB,IAAI,CAACN,GAAG,CAAC,CAAC,YAAY,EAAEM,SAAS;gBACjC,IAAI,CAACN,GAAG,CAAC;gBACT,IAAI,CAACA,GAAG,CAAC;gBAET,gCAAgC;gBAChC,IAAIwB,eAAe;gBACnB/E,cAAc6D,SAASmB,EAAE,CAAC,UAAU;oBAClC,IAAID,cAAc;wBAChB,QAAO,6BAA6B;oBACtC;oBACAA,eAAe;oBAEf,IAAI,CAACxB,GAAG,CAAC;oBACT,IAAI;wBACF,MAAMsB,8BAA8BhB,SAASK;oBAC/C,SAAU;wBACRa,eAAe;oBACjB;gBACF;gBACA9E,MAAM2E,OAAOK,GAAG,EAAE;uBAAIL,OAAO5D,IAAI;oBAAE6C;iBAAQ,EAAE;oBAACqB,OAAO;gBAAS;YAChE,OAAO;gBACL,4FAA4F;gBAC5FhF,UAAU0E,OAAOK,GAAG,EAAE;uBAAIL,OAAO5D,IAAI;oBAAE6C;iBAAQ,EAAE;oBAACqB,OAAO;gBAAS;gBAClE,MAAML,8BAA8BhB,SAASK;gBAC7C,MAAM3E,GAAG4F,MAAM,CAACtB,SAASuB,KAAK,CAAC,KAAO;YACxC;QACF,EAAE,OAAO3C,OAAO;YACd,MAAMgB,MAAMhB;YACZ3B,oBAAoB,4BAA4B2C;YAChD,IAAI,CAAChB,KAAK,CAAC,CAAC,4BAA4B,EAAEgB,IAAIC,OAAO,EAAE,EAAE;gBAAChB,MAAM;YAAC;QACnE;IACF;IAEQ2C,gBAAgB3B,OAAe,EAAE4B,KAAa,EAAEC,QAAiB,EAAU;QACjF,OAAOA,WAAW,CAAC,SAAS,EAAE7B,SAAS,GAAG,CAAC,kBAAkB,EAAE4B,MAAM,CAAC,EAAE5B,SAAS;IACnF;IAEA;;GAEC,GACD,AAAQF,iBACNH,MAA8B,EAC9BP,SAAgC,EACxB;QACR,MAAM0C,SAAS;QACf,IAAI1C,cAAc,mBAAmB;YACnC,OAAO,CAAC,eAAe,EAAEO,OAAOoC,OAAO,CAACC,GAAG,CAAC,CAACC,MAAQA,IAAIlE,EAAE,EAAEqC,IAAI,CAAC0B,SAAS;QAC7E;QAEA,IAAI1C,cAAc,UAAU;YAC1B,OAAO,CAAC,cAAc,EAAEO,OAAOoC,OAAO,CAACC,GAAG,CAAC,CAACC,MAAQA,IAAIlE,EAAE,EAAEqC,IAAI,CAAC0B,SAAS;QAC5E;QAEA,gCAAgC;QAChC,MAAMI,UAAoB,EAAE;QAC5B,MAAMC,UAAoB,EAAE;QAC5B,KAAK,MAAMF,OAAOtC,OAAOoC,OAAO,CAAE;YAChC,IAAIE,IAAI7C,SAAS,KAAK,UAAU;gBAC9B+C,QAAQC,IAAI,CAACH,IAAIlE,EAAE;YACrB,OAAO;gBACLmE,QAAQE,IAAI,CAACH,IAAIlE,EAAE;YACrB;QACF;QAEA,IAAImE,QAAQG,MAAM,GAAG,KAAKF,QAAQE,MAAM,GAAG,GAAG;YAC5C,OAAO;gBACL,CAAC,cAAc,EAAEH,QAAQ9B,IAAI,CAAC0B,SAAS;gBACvC,CAAC,yBAAyB,EAAEA,SAASK,QAAQ/B,IAAI,CAAC0B,SAAS;aAC5D,CAAC1B,IAAI,CAAC;QACT,OAAO,IAAI8B,QAAQG,MAAM,GAAG,GAAG;YAC7B,OAAO,CAAC,cAAc,EAAEH,QAAQ9B,IAAI,CAAC0B,SAAS;QAChD;QAEA,OAAO,CAAC,+BAA+B,EAAEK,QAAQ/B,IAAI,CAAC0B,SAAS;IACjE;IAEA;;GAEC,GACD,MAAcX,8BACZ/B,SAAgC,EAChCkD,QAAgB,EAChB9B,YAAqB,EACN;QACf,IAAIf;QACJ,IAAI;YACFA,UAAUhD,MAAM6B,KAAK,CAAC,MAAMzC,GAAG6D,QAAQ,CAAC4C,UAAU;QACpD,EAAE,OAAOvC,KAAK;YACZ,MAAMhB,QAAQgB;YACd3C,oBAAoB,CAAC,0BAA0B,EAAEkF,UAAU,EAAEvD;YAC7D,IAAI,CAACc,GAAG,CAAC,CAAC,sBAAsB,EAAEd,MAAMiB,OAAO,EAAE;YACjD;QACF;QAEA,IAAItD,QAAQ+C,SAASe,eAAe;YAClC,IAAI,CAACX,GAAG,CAAC;YACT,IAAI,CAACA,GAAG,CAAC;YACT;QACF;QAEA,IAAI;YACF,MAAM0C,cAAc,MAAM,IAAI,CAAC3C,cAAc,CAACH,SAASL;YACvD,IAAI,CAACS,GAAG,CAAC,IAAI,CAACC,gBAAgB,CAACyC,aAAanD;QAC9C,EAAE,OAAOW,KAAK;YACZ,MAAMhB,QAAQgB;YACd3C,oBAAoB,CAAC,yBAAyB,CAAC,EAAE2B;YACjD,IAAIyD,eAAe,CAAC,2BAA2B,EAAEzD,MAAMiB,OAAO,EAAE;YAChE,IAAIjB,MAAMiB,OAAO,CAACyC,QAAQ,CAAC,mBAAmB;gBAC5CD,gBAAgB;YAClB;YACA,IAAI,CAACzD,KAAK,CAACyD,cAAc;gBAACxD,MAAM;YAAC;QACnC;IACF;IAEA;;GAEC,GACD,AAAQ0D,iBAAiBC,GAAY,EAAEf,KAAa,EAAEgB,GAAc,EAAQ;QAC1E,MAAMf,WAAWe,IAAIP,MAAM,KAAK;QAEhC,IAAI,CAAC1F,cAAcgG,MAAM;YACvB,MAAM,IAAIE,MAAM,IAAI,CAAClB,eAAe,CAAC,qBAAqBC,OAAOC;QACnE;QAEA,IAAI,CAAC5E,oBAAoB0F,MAAM;YAC7B,MAAM,IAAIE,MACR,IAAI,CAAClB,eAAe,CAAC,+CAA+CC,OAAOC;QAE/E;QAEA,uDAAuD;QACvD,MAAMiB,SAASH;QAEf,8BAA8B;QAC9B,MAAMI,YAAYD,OAAOnC,KAAK,EAAEqC,WAAWC;QAC3C,IAAI,CAACF,WAAW;YACd,MAAM,IAAIF,MAAM,IAAI,CAAClB,eAAe,CAAC,yBAAyBC,OAAOC;QACvE;QAEA,gEAAgE;QAChE,IAAI,CAAC,4BAA4BqB,IAAI,CAACH,YAAY;YAChD,MAAM,IAAIF,MACR,IAAI,CAAClB,eAAe,CAClB,2GACAC,OACAC;QAGN;QAEA,iCAAiC;QACjC,IAAIiB,OAAOpC,GAAG,IAAI,OAAOoC,OAAOpC,GAAG,KAAK,UAAU;YAChD,MAAMyC,UAAUL,OAAOpC,GAAG,CAACuC,IAAI;YAC/B,IAAI,CAACE,SAAS;gBACZ,MAAM,IAAIN,MAAM,IAAI,CAAClB,eAAe,CAAC,uBAAuBC,OAAOC;YACrE;YAEA,qFAAqF;YACrF,IAAI,CAAC,oBAAoBqB,IAAI,CAACC,UAAU;gBACtC,MAAM,IAAIN,MACR,IAAI,CAAClB,eAAe,CAClB,gFACAC,OACAC;YAGN;YAEA,0DAA0D;YAC1D,IAAIsB,QAAQd,MAAM,GAAG,KAAK;gBACxB,MAAM,IAAIQ,MACR,IAAI,CAAClB,eAAe,CAAC,4CAA4CC,OAAOC;YAE5E;QACF;QAEA,2DAA2D;QAC3D,MAAMuB,iBAAiB;YAAC;YAAQ;YAAc;SAAa;QAC3D,KAAK,MAAMC,SAASD,eAAgB;YAClC,IAAIC,SAASP,QAAQ;gBACnB,oFAAoF;gBACpF,+DAA+D;gBAC/D1F,oBACE,CAAC,kBAAkB,EAAEwE,MAAM,0BAA0B,EAAEyB,MAAM,iCAAiC,CAAC;YAEnG;QACF;IACF;IAEA;;GAEC,GACD,MAAczD,eACZ0D,SAA0E,EAC1ElE,SAAgC,EACC;QACjC,MAAMmE,OAAOC,MAAMC,OAAO,CAACH,aAAaA,YAAY;YAACA;SAAU;QAC/D,IAAIC,KAAKlB,MAAM,KAAK,GAAG;YACrB,MAAM,IAAIQ,MAAM;QAClB;QAEA,MAAMa,YAAYH,KAAKvB,GAAG,CAAC,CAACW,KAAKf;YAC/B,IAAI,CAACc,gBAAgB,CAACC,KAAKf,OAAO2B;YAClC,IAAInE,cAAc,UAAU;gBAC1B,OAAO;oBAACuE,QAAQhB;gBAAG;YACrB;YAEA,IAAIvD,cAAc,qBAAqB;gBACrC,IAAIpC,2BAA2B2F,MAAM;oBACnC,OAAO;wBAACiB,mBAAmBjB;oBAAG;gBAChC;gBAEA,MAAM,IAAIE,MAAM,CAAC,mCAAmC,EAAEzD,WAAW;YACnE;YAEA,IAAIA,cAAc,mBAAmB;gBACnC,IAAIpC,2BAA2B2F,MAAM;oBACnC,OAAO;wBAACkB,iBAAiBlB;oBAAG;gBAC9B;gBAEA,MAAM,IAAIE,MAAM,CAAC,mCAAmC,EAAEzD,WAAW;YACnE;YAEA,MAAM,IAAIyD,MAAM,CAAC,sBAAsB,EAAEzD,WAAW;QACtD;QAEA,OAAO,IAAI,CAAChB,MAAM,CAAC0F,WAAW,CAACJ,WAAWK,MAAM;IAClD;AACF"}
+{"version":3,"sources":["../../../src/commands/documents/create.ts"],"sourcesContent":["import {randomUUID} from 'node:crypto'\nimport fs from 'node:fs/promises'\nimport os from 'node:os'\nimport path from 'node:path'\n\nimport {Args, Flags} from '@oclif/core'\nimport {exitCodes, getProjectCliClient, SanityCommand, subdebug} from '@sanity/cli-core'\nimport {type MultipleMutationResult, type Mutation} from '@sanity/client'\nimport {watch as chokidarWatch} from 'chokidar'\nimport {execa, execaSync} from 'execa'\nimport json5 from 'json5'\nimport isEqual from 'lodash-es/isEqual.js'\nimport isPlainObject from 'lodash-es/isPlainObject.js'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {getEditor, registerUnlinkOnSigInt} from '../../actions/documents/editor.js'\nimport {promptForProject} from '../../prompts/promptForProject.js'\nimport {isIdentifiedSanityDocument, isSanityDocumentish} from '../../util/isSanityDocumentish.js'\nimport {getDatasetFlag, getProjectIdFlag} from '../../util/sharedFlags.js'\n\nexport type MutationOperationName = 'create' | 'createIfNotExists' | 'createOrReplace'\n\nconst createDocumentDebug = subdebug('documents:create')\n\nexport class CreateDocumentCommand extends SanityCommand<typeof CreateDocumentCommand> {\n  static override args = {\n    file: Args.string({\n      description: 'JSON file to create document(s) from',\n      required: false,\n    }),\n  }\n\n  static override description = 'Create one or more documents'\n\n  static override examples = [\n    {\n      command: '<%= config.bin %> <%= command.id %> myDocument.json',\n      description: 'Create the document specified in \"myDocument.json\"',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %>',\n      description: 'Open configured $EDITOR and create the specified document(s)',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> --id myDocId --replace',\n      description:\n        'Fetch document with the ID \"myDocId\" and open configured $EDITOR with the current document content (if any). Replace document with the edited version when the editor closes',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> --id myDocId --watch --replace --json5',\n      description:\n        'Open configured $EDITOR and replace the document with the given content on each save. Use JSON5 file extension and parser for simplified syntax.',\n    },\n    {\n      command: '<%= config.bin %> <%= command.id %> myDocument.json --project-id abc123',\n      description: 'Create documents in a specific project',\n    },\n  ]\n\n  static override flags = {\n    ...getProjectIdFlag({\n      description: 'Project ID to create document(s) in',\n      semantics: 'override',\n    }),\n    ...getDatasetFlag({\n      description: 'Dataset to create document(s) in',\n      semantics: 'override',\n    }),\n    id: Flags.string({\n      description:\n        'Specify a document ID to use. Will fetch remote document ID and populate editor.',\n    }),\n    json5: Flags.boolean({\n      description: 'Use JSON5 file type to allow a \"simplified\" version of JSON',\n    }),\n    missing: Flags.boolean({\n      description: \"On duplicate document IDs, don't modify the target document(s)\",\n    }),\n    replace: Flags.boolean({\n      description:\n        'On duplicate document IDs, replace existing document with specified document(s)',\n    }),\n    watch: Flags.boolean({\n      description: 'Write the documents whenever the target file or buffer changes',\n    }),\n  }\n\n  static override hiddenAliases: string[] = ['document:create']\n\n  private client!: Awaited<ReturnType<typeof getProjectCliClient>>\n\n  public async run(): Promise<void> {\n    const {args, flags} = await this.parse(CreateDocumentCommand)\n    const {file} = args\n    const {dataset, id, json5: useJson5, missing, replace, watch} = flags\n\n    if (!file && this.isUnattended()) {\n      this.error(\n        'Document input is required in unattended mode. Pass it as the `<file>` argument.',\n        {exit: exitCodes.USAGE_ERROR},\n      )\n    }\n\n    if (replace && missing) {\n      this.error(\n        'Cannot use `--replace` and `--missing` together. Remove one flag and try again.',\n        {\n          exit: exitCodes.USAGE_ERROR,\n        },\n      )\n    }\n\n    if (id && file) {\n      this.error(\n        'Cannot use `--id` with the `<file>` argument. Remove `--id` or omit `<file>` and try again.',\n        {exit: exitCodes.USAGE_ERROR},\n      )\n    }\n\n    const cliConfig = await this.tryGetCliConfig()\n\n    const projectId = await this.getProjectId({fallback: () => promptForProject({})})\n\n    if (!cliConfig.api?.dataset && !dataset) {\n      this.error(\n        'Dataset is required. Pass it with `--dataset <name>` or configure it in `sanity.cli.ts`.',\n        {exit: exitCodes.USAGE_ERROR},\n      )\n    }\n\n    const targetDataset = dataset || cliConfig.api?.dataset\n\n    this.client = await getProjectCliClient({\n      apiVersion: DOCUMENTS_API_VERSION,\n      dataset: targetDataset,\n      projectId,\n      requireUser: true,\n    })\n\n    let operation: MutationOperationName = 'create'\n    if (replace || missing) {\n      operation = replace ? 'createOrReplace' : 'createIfNotExists'\n    }\n\n    if (file) {\n      try {\n        const contentPath = path.resolve(process.cwd(), file)\n        const content = json5.parse(await fs.readFile(contentPath, 'utf8'))\n        const result = await this.writeDocuments(content, operation)\n        this.log(this.getResultMessage(result, operation))\n        return\n      } catch (error) {\n        const err = error as Error\n        createDocumentDebug(`Error creating documents from file ${file}`, err)\n        this.error(`Failed to create documents: ${err.message}`, {exit: 1})\n      }\n    }\n\n    try {\n      // Create a temporary file and use that as source, opening an editor on it\n      const docId = id || randomUUID()\n      const ext = useJson5 ? 'json5' : 'json'\n      // Add UUID prefix to prevent predictable file names and potential conflicts\n      const tmpFile = path.join(os.tmpdir(), 'sanity-cli', `${randomUUID()}-${docId}.${ext}`)\n      const stringify = useJson5 ? json5.stringify : JSON.stringify\n      const defaultValue = (id && (await this.client.getDocument(id))) || {\n        _id: docId,\n        _type: 'specify-me',\n      }\n\n      // Create temp directory with restricted permissions (owner only)\n      const tempDir = path.join(os.tmpdir(), 'sanity-cli')\n      await fs.mkdir(tempDir, {\n        mode: 0o700, // rwx------ (owner read/write/execute only)\n        recursive: true,\n      })\n\n      // Write file with restricted permissions (owner read/write only)\n      await fs.writeFile(tmpFile, stringify(defaultValue, null, 2), {\n        encoding: 'utf8',\n        mode: 0o600, // rw------- (owner read/write only)\n      })\n\n      const editor = getEditor()\n      const readAndPerformCreatesFromFile = this.readAndPerformCreatesFromFile.bind(this, operation)\n\n      if (watch) {\n        // If we're in watch mode, we want to run the creation on each change (if it validates)\n        registerUnlinkOnSigInt(tmpFile)\n        this.log(`Watch mode: ${tmpFile}`)\n        this.log('Watch mode: Will write documents on each save.')\n        this.log('Watch mode: Press Ctrl + C to cancel watch mode.')\n\n        // Add race condition protection\n        let isProcessing = false\n        chokidarWatch(tmpFile).on('change', async () => {\n          if (isProcessing) {\n            return // Skip if already processing\n          }\n          isProcessing = true\n\n          this.log('')\n          try {\n            await readAndPerformCreatesFromFile(tmpFile, defaultValue)\n          } finally {\n            isProcessing = false\n          }\n        })\n        execa(editor.bin, [...editor.args, tmpFile], {stdio: 'inherit'})\n      } else {\n        // While in normal mode, we just want to wait for the editor to close and run the thing once\n        execaSync(editor.bin, [...editor.args, tmpFile], {stdio: 'inherit'})\n        await readAndPerformCreatesFromFile(tmpFile, defaultValue)\n        await fs.unlink(tmpFile).catch(() => {})\n      }\n    } catch (error) {\n      const err = error as Error\n      createDocumentDebug('Error in editor workflow', err)\n      this.error(`Failed to create documents: ${err.message}`, {exit: 1})\n    }\n  }\n\n  private getErrorMessage(message: string, index: number, isSingle: boolean): string {\n    return isSingle ? `Document ${message}` : `Document at index ${index} ${message}`\n  }\n\n  /**\n   * Formats the result message for document operations\n   */\n  private getResultMessage(\n    result: MultipleMutationResult,\n    operation: MutationOperationName,\n  ): string {\n    const joiner = '\\n  - '\n    if (operation === 'createOrReplace') {\n      return `Upserted:\\n  - ${result.results.map((res) => res.id).join(joiner)}`\n    }\n\n    if (operation === 'create') {\n      return `Created:\\n  - ${result.results.map((res) => res.id).join(joiner)}`\n    }\n\n    // \"Missing\" (createIfNotExists)\n    const created: string[] = []\n    const skipped: string[] = []\n    for (const res of result.results) {\n      if (res.operation === 'update') {\n        skipped.push(res.id)\n      } else {\n        created.push(res.id)\n      }\n    }\n\n    if (created.length > 0 && skipped.length > 0) {\n      return [\n        `Created:\\n  - ${created.join(joiner)}`,\n        `Skipped (already exists):${joiner}${skipped.join(joiner)}`,\n      ].join('\\n\\n')\n    } else if (created.length > 0) {\n      return `Created:\\n  - ${created.join(joiner)}`\n    }\n\n    return `Skipped (already exists):\\n  - ${skipped.join(joiner)}`\n  }\n\n  /**\n   * Reads and processes documents from a file for creation\n   */\n  private async readAndPerformCreatesFromFile(\n    operation: MutationOperationName,\n    filePath: string,\n    defaultValue: unknown,\n  ): Promise<void> {\n    let content\n    try {\n      content = json5.parse(await fs.readFile(filePath, 'utf8'))\n    } catch (err) {\n      const error = err as Error\n      createDocumentDebug(`Failed to read input file ${filePath}`, error)\n      this.log(`Failed to read input: ${error.message}`)\n      return\n    }\n\n    if (isEqual(content, defaultValue)) {\n      this.log('Value not modified, doing nothing.')\n      this.log('Modify document to trigger creation.')\n      return\n    }\n\n    try {\n      const writeResult = await this.writeDocuments(content, operation)\n      this.log(this.getResultMessage(writeResult, operation))\n    } catch (err) {\n      const error = err as Error\n      createDocumentDebug(`Failed to write documents`, error)\n      let errorMessage = `Failed to write documents: ${error.message}`\n      if (error.message.includes('already exists')) {\n        errorMessage += '\\nPerhaps you want to use `--replace` or `--missing`?'\n      }\n      this.error(errorMessage, {exit: 1})\n    }\n  }\n\n  /**\n   * Validates a document for Sanity requirements\n   */\n  private validateDocument(doc: unknown, index: number, arr: unknown[]): void {\n    const isSingle = arr.length === 1\n\n    if (!isPlainObject(doc)) {\n      throw new Error(this.getErrorMessage('must be an object', index, isSingle))\n    }\n\n    if (!isSanityDocumentish(doc)) {\n      throw new Error(\n        this.getErrorMessage('must have a `_type` property of type string', index, isSingle),\n      )\n    }\n\n    // Enhanced validations for Sanity document constraints\n    const docObj = doc as Record<string, unknown>\n\n    // Validate _type is non-empty\n    const typeValue = docObj._type?.toString().trim()\n    if (!typeValue) {\n      throw new Error(this.getErrorMessage('_type cannot be empty', index, isSingle))\n    }\n\n    // Validate _type format (alphanumeric, underscore, hyphen, dot)\n    if (!/^[a-zA-Z][a-zA-Z0-9_.-]*$/.test(typeValue)) {\n      throw new Error(\n        this.getErrorMessage(\n          '_type must start with a letter and contain only alphanumeric characters, underscores, hyphens, and dots',\n          index,\n          isSingle,\n        ),\n      )\n    }\n\n    // Validate _id format if present\n    if (docObj._id && typeof docObj._id === 'string') {\n      const idValue = docObj._id.trim()\n      if (!idValue) {\n        throw new Error(this.getErrorMessage('_id cannot be empty', index, isSingle))\n      }\n\n      // Sanity document IDs can contain alphanumeric chars, hyphens, underscores, and dots\n      if (!/^[a-zA-Z0-9_.-]+$/.test(idValue)) {\n        throw new Error(\n          this.getErrorMessage(\n            '_id can only contain alphanumeric characters, underscores, hyphens, and dots',\n            index,\n            isSingle,\n          ),\n        )\n      }\n\n      // Check length constraints (Sanity has reasonable limits)\n      if (idValue.length > 200) {\n        throw new Error(\n          this.getErrorMessage('_id cannot be longer than 200 characters', index, isSingle),\n        )\n      }\n    }\n\n    // Warn about reserved fields (these are managed by Sanity)\n    const reservedFields = ['_rev', '_updatedAt', '_createdAt']\n    for (const field of reservedFields) {\n      if (field in docObj) {\n        // Note: We don't throw an error here as these might be present in fetched documents\n        // that are being re-uploaded, but we could add a debug warning\n        createDocumentDebug(\n          `Warning: Document ${index} contains reserved field '${field}' which will be ignored by Sanity`,\n        )\n      }\n    }\n  }\n\n  /**\n   * Writes documents to Sanity using the specified operation\n   */\n  private async writeDocuments(\n    documents: {_id?: string; _type: string} | {_id?: string; _type: string}[],\n    operation: MutationOperationName,\n  ): Promise<MultipleMutationResult> {\n    const docs = Array.isArray(documents) ? documents : [documents]\n    if (docs.length === 0) {\n      throw new Error('No documents provided')\n    }\n\n    const mutations = docs.map((doc, index): Mutation => {\n      this.validateDocument(doc, index, docs)\n      if (operation === 'create') {\n        return {create: doc}\n      }\n\n      if (operation === 'createIfNotExists') {\n        if (isIdentifiedSanityDocument(doc)) {\n          return {createIfNotExists: doc}\n        }\n\n        throw new Error(`Missing required _id attribute for ${operation}`)\n      }\n\n      if (operation === 'createOrReplace') {\n        if (isIdentifiedSanityDocument(doc)) {\n          return {createOrReplace: doc}\n        }\n\n        throw new Error(`Missing required _id attribute for ${operation}`)\n      }\n\n      throw new Error(`Unsupported operation ${operation}`)\n    })\n\n    return this.client.transaction(mutations).commit()\n  }\n}\n"],"names":["randomUUID","fs","os","path","Args","Flags","exitCodes","getProjectCliClient","SanityCommand","subdebug","watch","chokidarWatch","execa","execaSync","json5","isEqual","isPlainObject","DOCUMENTS_API_VERSION","getEditor","registerUnlinkOnSigInt","promptForProject","isIdentifiedSanityDocument","isSanityDocumentish","getDatasetFlag","getProjectIdFlag","createDocumentDebug","CreateDocumentCommand","args","file","string","description","required","examples","command","flags","semantics","id","boolean","missing","replace","hiddenAliases","client","run","parse","dataset","useJson5","isUnattended","error","exit","USAGE_ERROR","cliConfig","tryGetCliConfig","projectId","getProjectId","fallback","api","targetDataset","apiVersion","requireUser","operation","contentPath","resolve","process","cwd","content","readFile","result","writeDocuments","log","getResultMessage","err","message","docId","ext","tmpFile","join","tmpdir","stringify","JSON","defaultValue","getDocument","_id","_type","tempDir","mkdir","mode","recursive","writeFile","encoding","editor","readAndPerformCreatesFromFile","bind","isProcessing","on","bin","stdio","unlink","catch","getErrorMessage","index","isSingle","joiner","results","map","res","created","skipped","push","length","filePath","writeResult","errorMessage","includes","validateDocument","doc","arr","Error","docObj","typeValue","toString","trim","test","idValue","reservedFields","field","documents","docs","Array","isArray","mutations","create","createIfNotExists","createOrReplace","transaction","commit"],"mappings":"AAAA,SAAQA,UAAU,QAAO,cAAa;AACtC,OAAOC,QAAQ,mBAAkB;AACjC,OAAOC,QAAQ,UAAS;AACxB,OAAOC,UAAU,YAAW;AAE5B,SAAQC,IAAI,EAAEC,KAAK,QAAO,cAAa;AACvC,SAAQC,SAAS,EAAEC,mBAAmB,EAAEC,aAAa,EAAEC,QAAQ,QAAO,mBAAkB;AAExF,SAAQC,SAASC,aAAa,QAAO,WAAU;AAC/C,SAAQC,KAAK,EAAEC,SAAS,QAAO,QAAO;AACtC,OAAOC,WAAW,QAAO;AACzB,OAAOC,aAAa,uBAAsB;AAC1C,OAAOC,mBAAmB,6BAA4B;AAEtD,SAAQC,qBAAqB,QAAO,uCAAsC;AAC1E,SAAQC,SAAS,EAAEC,sBAAsB,QAAO,oCAAmC;AACnF,SAAQC,gBAAgB,QAAO,oCAAmC;AAClE,SAAQC,0BAA0B,EAAEC,mBAAmB,QAAO,oCAAmC;AACjG,SAAQC,cAAc,EAAEC,gBAAgB,QAAO,4BAA2B;AAI1E,MAAMC,sBAAsBhB,SAAS;AAErC,OAAO,MAAMiB,8BAA8BlB;IACzC,OAAgBmB,OAAO;QACrBC,MAAMxB,KAAKyB,MAAM,CAAC;YAChBC,aAAa;YACbC,UAAU;QACZ;IACF,EAAC;IAED,OAAgBD,cAAc,+BAA8B;IAE5D,OAAgBE,WAAW;QACzB;YACEC,SAAS;YACTH,aAAa;QACf;QACA;YACEG,SAAS;YACTH,aAAa;QACf;QACA;YACEG,SAAS;YACTH,aACE;QACJ;QACA;YACEG,SAAS;YACTH,aACE;QACJ;QACA;YACEG,SAAS;YACTH,aAAa;QACf;KACD,CAAA;IAED,OAAgBI,QAAQ;QACtB,GAAGV,iBAAiB;YAClBM,aAAa;YACbK,WAAW;QACb,EAAE;QACF,GAAGZ,eAAe;YAChBO,aAAa;YACbK,WAAW;QACb,EAAE;QACFC,IAAI/B,MAAMwB,MAAM,CAAC;YACfC,aACE;QACJ;QACAhB,OAAOT,MAAMgC,OAAO,CAAC;YACnBP,aAAa;QACf;QACAQ,SAASjC,MAAMgC,OAAO,CAAC;YACrBP,aAAa;QACf;QACAS,SAASlC,MAAMgC,OAAO,CAAC;YACrBP,aACE;QACJ;QACApB,OAAOL,MAAMgC,OAAO,CAAC;YACnBP,aAAa;QACf;IACF,EAAC;IAED,OAAgBU,gBAA0B;QAAC;KAAkB,CAAA;IAErDC,OAAwD;IAEhE,MAAaC,MAAqB;QAChC,MAAM,EAACf,IAAI,EAAEO,KAAK,EAAC,GAAG,MAAM,IAAI,CAACS,KAAK,CAACjB;QACvC,MAAM,EAACE,IAAI,EAAC,GAAGD;QACf,MAAM,EAACiB,OAAO,EAAER,EAAE,EAAEtB,OAAO+B,QAAQ,EAAEP,OAAO,EAAEC,OAAO,EAAE7B,KAAK,EAAC,GAAGwB;QAEhE,IAAI,CAACN,QAAQ,IAAI,CAACkB,YAAY,IAAI;YAChC,IAAI,CAACC,KAAK,CACR,oFACA;gBAACC,MAAM1C,UAAU2C,WAAW;YAAA;QAEhC;QAEA,IAAIV,WAAWD,SAAS;YACtB,IAAI,CAACS,KAAK,CACR,mFACA;gBACEC,MAAM1C,UAAU2C,WAAW;YAC7B;QAEJ;QAEA,IAAIb,MAAMR,MAAM;YACd,IAAI,CAACmB,KAAK,CACR,+FACA;gBAACC,MAAM1C,UAAU2C,WAAW;YAAA;QAEhC;QAEA,MAAMC,YAAY,MAAM,IAAI,CAACC,eAAe;QAE5C,MAAMC,YAAY,MAAM,IAAI,CAACC,YAAY,CAAC;YAACC,UAAU,IAAMlC,iBAAiB,CAAC;QAAE;QAE/E,IAAI,CAAC8B,UAAUK,GAAG,EAAEX,WAAW,CAACA,SAAS;YACvC,IAAI,CAACG,KAAK,CACR,4FACA;gBAACC,MAAM1C,UAAU2C,WAAW;YAAA;QAEhC;QAEA,MAAMO,gBAAgBZ,WAAWM,UAAUK,GAAG,EAAEX;QAEhD,IAAI,CAACH,MAAM,GAAG,MAAMlC,oBAAoB;YACtCkD,YAAYxC;YACZ2B,SAASY;YACTJ;YACAM,aAAa;QACf;QAEA,IAAIC,YAAmC;QACvC,IAAIpB,WAAWD,SAAS;YACtBqB,YAAYpB,UAAU,oBAAoB;QAC5C;QAEA,IAAIX,MAAM;YACR,IAAI;gBACF,MAAMgC,cAAczD,KAAK0D,OAAO,CAACC,QAAQC,GAAG,IAAInC;gBAChD,MAAMoC,UAAUlD,MAAM6B,KAAK,CAAC,MAAM1C,GAAGgE,QAAQ,CAACL,aAAa;gBAC3D,MAAMM,SAAS,MAAM,IAAI,CAACC,cAAc,CAACH,SAASL;gBAClD,IAAI,CAACS,GAAG,CAAC,IAAI,CAACC,gBAAgB,CAACH,QAAQP;gBACvC;YACF,EAAE,OAAOZ,OAAO;gBACd,MAAMuB,MAAMvB;gBACZtB,oBAAoB,CAAC,mCAAmC,EAAEG,MAAM,EAAE0C;gBAClE,IAAI,CAACvB,KAAK,CAAC,CAAC,4BAA4B,EAAEuB,IAAIC,OAAO,EAAE,EAAE;oBAACvB,MAAM;gBAAC;YACnE;QACF;QAEA,IAAI;YACF,0EAA0E;YAC1E,MAAMwB,QAAQpC,MAAMpC;YACpB,MAAMyE,MAAM5B,WAAW,UAAU;YACjC,4EAA4E;YAC5E,MAAM6B,UAAUvE,KAAKwE,IAAI,CAACzE,GAAG0E,MAAM,IAAI,cAAc,GAAG5E,aAAa,CAAC,EAAEwE,MAAM,CAAC,EAAEC,KAAK;YACtF,MAAMI,YAAYhC,WAAW/B,MAAM+D,SAAS,GAAGC,KAAKD,SAAS;YAC7D,MAAME,eAAe,AAAC3C,MAAO,MAAM,IAAI,CAACK,MAAM,CAACuC,WAAW,CAAC5C,OAAS;gBAClE6C,KAAKT;gBACLU,OAAO;YACT;YAEA,iEAAiE;YACjE,MAAMC,UAAUhF,KAAKwE,IAAI,CAACzE,GAAG0E,MAAM,IAAI;YACvC,MAAM3E,GAAGmF,KAAK,CAACD,SAAS;gBACtBE,MAAM;gBACNC,WAAW;YACb;YAEA,iEAAiE;YACjE,MAAMrF,GAAGsF,SAAS,CAACb,SAASG,UAAUE,cAAc,MAAM,IAAI;gBAC5DS,UAAU;gBACVH,MAAM;YACR;YAEA,MAAMI,SAASvE;YACf,MAAMwE,gCAAgC,IAAI,CAACA,6BAA6B,CAACC,IAAI,CAAC,IAAI,EAAEhC;YAEpF,IAAIjD,OAAO;gBACT,uFAAuF;gBACvFS,uBAAuBuD;gBACvB,IAAI,CAACN,GAAG,CAAC,CAAC,YAAY,EAAEM,SAAS;gBACjC,IAAI,CAACN,GAAG,CAAC;gBACT,IAAI,CAACA,GAAG,CAAC;gBAET,gCAAgC;gBAChC,IAAIwB,eAAe;gBACnBjF,cAAc+D,SAASmB,EAAE,CAAC,UAAU;oBAClC,IAAID,cAAc;wBAChB,QAAO,6BAA6B;oBACtC;oBACAA,eAAe;oBAEf,IAAI,CAACxB,GAAG,CAAC;oBACT,IAAI;wBACF,MAAMsB,8BAA8BhB,SAASK;oBAC/C,SAAU;wBACRa,eAAe;oBACjB;gBACF;gBACAhF,MAAM6E,OAAOK,GAAG,EAAE;uBAAIL,OAAO9D,IAAI;oBAAE+C;iBAAQ,EAAE;oBAACqB,OAAO;gBAAS;YAChE,OAAO;gBACL,4FAA4F;gBAC5FlF,UAAU4E,OAAOK,GAAG,EAAE;uBAAIL,OAAO9D,IAAI;oBAAE+C;iBAAQ,EAAE;oBAACqB,OAAO;gBAAS;gBAClE,MAAML,8BAA8BhB,SAASK;gBAC7C,MAAM9E,GAAG+F,MAAM,CAACtB,SAASuB,KAAK,CAAC,KAAO;YACxC;QACF,EAAE,OAAOlD,OAAO;YACd,MAAMuB,MAAMvB;YACZtB,oBAAoB,4BAA4B6C;YAChD,IAAI,CAACvB,KAAK,CAAC,CAAC,4BAA4B,EAAEuB,IAAIC,OAAO,EAAE,EAAE;gBAACvB,MAAM;YAAC;QACnE;IACF;IAEQkD,gBAAgB3B,OAAe,EAAE4B,KAAa,EAAEC,QAAiB,EAAU;QACjF,OAAOA,WAAW,CAAC,SAAS,EAAE7B,SAAS,GAAG,CAAC,kBAAkB,EAAE4B,MAAM,CAAC,EAAE5B,SAAS;IACnF;IAEA;;GAEC,GACD,AAAQF,iBACNH,MAA8B,EAC9BP,SAAgC,EACxB;QACR,MAAM0C,SAAS;QACf,IAAI1C,cAAc,mBAAmB;YACnC,OAAO,CAAC,eAAe,EAAEO,OAAOoC,OAAO,CAACC,GAAG,CAAC,CAACC,MAAQA,IAAIpE,EAAE,EAAEuC,IAAI,CAAC0B,SAAS;QAC7E;QAEA,IAAI1C,cAAc,UAAU;YAC1B,OAAO,CAAC,cAAc,EAAEO,OAAOoC,OAAO,CAACC,GAAG,CAAC,CAACC,MAAQA,IAAIpE,EAAE,EAAEuC,IAAI,CAAC0B,SAAS;QAC5E;QAEA,gCAAgC;QAChC,MAAMI,UAAoB,EAAE;QAC5B,MAAMC,UAAoB,EAAE;QAC5B,KAAK,MAAMF,OAAOtC,OAAOoC,OAAO,CAAE;YAChC,IAAIE,IAAI7C,SAAS,KAAK,UAAU;gBAC9B+C,QAAQC,IAAI,CAACH,IAAIpE,EAAE;YACrB,OAAO;gBACLqE,QAAQE,IAAI,CAACH,IAAIpE,EAAE;YACrB;QACF;QAEA,IAAIqE,QAAQG,MAAM,GAAG,KAAKF,QAAQE,MAAM,GAAG,GAAG;YAC5C,OAAO;gBACL,CAAC,cAAc,EAAEH,QAAQ9B,IAAI,CAAC0B,SAAS;gBACvC,CAAC,yBAAyB,EAAEA,SAASK,QAAQ/B,IAAI,CAAC0B,SAAS;aAC5D,CAAC1B,IAAI,CAAC;QACT,OAAO,IAAI8B,QAAQG,MAAM,GAAG,GAAG;YAC7B,OAAO,CAAC,cAAc,EAAEH,QAAQ9B,IAAI,CAAC0B,SAAS;QAChD;QAEA,OAAO,CAAC,+BAA+B,EAAEK,QAAQ/B,IAAI,CAAC0B,SAAS;IACjE;IAEA;;GAEC,GACD,MAAcX,8BACZ/B,SAAgC,EAChCkD,QAAgB,EAChB9B,YAAqB,EACN;QACf,IAAIf;QACJ,IAAI;YACFA,UAAUlD,MAAM6B,KAAK,CAAC,MAAM1C,GAAGgE,QAAQ,CAAC4C,UAAU;QACpD,EAAE,OAAOvC,KAAK;YACZ,MAAMvB,QAAQuB;YACd7C,oBAAoB,CAAC,0BAA0B,EAAEoF,UAAU,EAAE9D;YAC7D,IAAI,CAACqB,GAAG,CAAC,CAAC,sBAAsB,EAAErB,MAAMwB,OAAO,EAAE;YACjD;QACF;QAEA,IAAIxD,QAAQiD,SAASe,eAAe;YAClC,IAAI,CAACX,GAAG,CAAC;YACT,IAAI,CAACA,GAAG,CAAC;YACT;QACF;QAEA,IAAI;YACF,MAAM0C,cAAc,MAAM,IAAI,CAAC3C,cAAc,CAACH,SAASL;YACvD,IAAI,CAACS,GAAG,CAAC,IAAI,CAACC,gBAAgB,CAACyC,aAAanD;QAC9C,EAAE,OAAOW,KAAK;YACZ,MAAMvB,QAAQuB;YACd7C,oBAAoB,CAAC,yBAAyB,CAAC,EAAEsB;YACjD,IAAIgE,eAAe,CAAC,2BAA2B,EAAEhE,MAAMwB,OAAO,EAAE;YAChE,IAAIxB,MAAMwB,OAAO,CAACyC,QAAQ,CAAC,mBAAmB;gBAC5CD,gBAAgB;YAClB;YACA,IAAI,CAAChE,KAAK,CAACgE,cAAc;gBAAC/D,MAAM;YAAC;QACnC;IACF;IAEA;;GAEC,GACD,AAAQiE,iBAAiBC,GAAY,EAAEf,KAAa,EAAEgB,GAAc,EAAQ;QAC1E,MAAMf,WAAWe,IAAIP,MAAM,KAAK;QAEhC,IAAI,CAAC5F,cAAckG,MAAM;YACvB,MAAM,IAAIE,MAAM,IAAI,CAAClB,eAAe,CAAC,qBAAqBC,OAAOC;QACnE;QAEA,IAAI,CAAC9E,oBAAoB4F,MAAM;YAC7B,MAAM,IAAIE,MACR,IAAI,CAAClB,eAAe,CAAC,+CAA+CC,OAAOC;QAE/E;QAEA,uDAAuD;QACvD,MAAMiB,SAASH;QAEf,8BAA8B;QAC9B,MAAMI,YAAYD,OAAOnC,KAAK,EAAEqC,WAAWC;QAC3C,IAAI,CAACF,WAAW;YACd,MAAM,IAAIF,MAAM,IAAI,CAAClB,eAAe,CAAC,yBAAyBC,OAAOC;QACvE;QAEA,gEAAgE;QAChE,IAAI,CAAC,4BAA4BqB,IAAI,CAACH,YAAY;YAChD,MAAM,IAAIF,MACR,IAAI,CAAClB,eAAe,CAClB,2GACAC,OACAC;QAGN;QAEA,iCAAiC;QACjC,IAAIiB,OAAOpC,GAAG,IAAI,OAAOoC,OAAOpC,GAAG,KAAK,UAAU;YAChD,MAAMyC,UAAUL,OAAOpC,GAAG,CAACuC,IAAI;YAC/B,IAAI,CAACE,SAAS;gBACZ,MAAM,IAAIN,MAAM,IAAI,CAAClB,eAAe,CAAC,uBAAuBC,OAAOC;YACrE;YAEA,qFAAqF;YACrF,IAAI,CAAC,oBAAoBqB,IAAI,CAACC,UAAU;gBACtC,MAAM,IAAIN,MACR,IAAI,CAAClB,eAAe,CAClB,gFACAC,OACAC;YAGN;YAEA,0DAA0D;YAC1D,IAAIsB,QAAQd,MAAM,GAAG,KAAK;gBACxB,MAAM,IAAIQ,MACR,IAAI,CAAClB,eAAe,CAAC,4CAA4CC,OAAOC;YAE5E;QACF;QAEA,2DAA2D;QAC3D,MAAMuB,iBAAiB;YAAC;YAAQ;YAAc;SAAa;QAC3D,KAAK,MAAMC,SAASD,eAAgB;YAClC,IAAIC,SAASP,QAAQ;gBACnB,oFAAoF;gBACpF,+DAA+D;gBAC/D5F,oBACE,CAAC,kBAAkB,EAAE0E,MAAM,0BAA0B,EAAEyB,MAAM,iCAAiC,CAAC;YAEnG;QACF;IACF;IAEA;;GAEC,GACD,MAAczD,eACZ0D,SAA0E,EAC1ElE,SAAgC,EACC;QACjC,MAAMmE,OAAOC,MAAMC,OAAO,CAACH,aAAaA,YAAY;YAACA;SAAU;QAC/D,IAAIC,KAAKlB,MAAM,KAAK,GAAG;YACrB,MAAM,IAAIQ,MAAM;QAClB;QAEA,MAAMa,YAAYH,KAAKvB,GAAG,CAAC,CAACW,KAAKf;YAC/B,IAAI,CAACc,gBAAgB,CAACC,KAAKf,OAAO2B;YAClC,IAAInE,cAAc,UAAU;gBAC1B,OAAO;oBAACuE,QAAQhB;gBAAG;YACrB;YAEA,IAAIvD,cAAc,qBAAqB;gBACrC,IAAItC,2BAA2B6F,MAAM;oBACnC,OAAO;wBAACiB,mBAAmBjB;oBAAG;gBAChC;gBAEA,MAAM,IAAIE,MAAM,CAAC,mCAAmC,EAAEzD,WAAW;YACnE;YAEA,IAAIA,cAAc,mBAAmB;gBACnC,IAAItC,2BAA2B6F,MAAM;oBACnC,OAAO;wBAACkB,iBAAiBlB;oBAAG;gBAC9B;gBAEA,MAAM,IAAIE,MAAM,CAAC,mCAAmC,EAAEzD,WAAW;YACnE;YAEA,MAAM,IAAIyD,MAAM,CAAC,sBAAsB,EAAEzD,WAAW;QACtD;QAEA,OAAO,IAAI,CAAClB,MAAM,CAAC4F,WAAW,CAACJ,WAAWK,MAAM;IAClD;AACF"}

package/dist/commands/documents/delete.js

@@ -1,5 +1,5 @@
 import { Args } from '@oclif/core';
-import { getProjectCliClient, SanityCommand, subdebug } from '@sanity/cli-core';
+import { exitCodes, getProjectCliClient, SanityCommand, subdebug } from '@sanity/cli-core';
 import { DOCUMENTS_API_VERSION } from '../../actions/documents/constants.js';
 import { promptForProject } from '../../prompts/promptForProject.js';
 import { getDatasetFlag, getProjectIdFlag } from '../../util/sharedFlags.js';
@@ -74,8 +74,8 @@ export class DeleteDocumentCommand extends SanityCommand {
             fallback: ()=>promptForProject({})
         });
         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
+            this.error('Dataset is required. Pass it with `--dataset <name>` or configure it in `sanity.cli.ts`.', {
+                exit: exitCodes.USAGE_ERROR
             });
         }
         const targetDataset = dataset || cliConfig.api?.dataset;

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/commands/documents/delete.ts"],"sourcesContent":["import {Args} from '@oclif/core'\nimport {getProjectCliClient, SanityCommand, subdebug} from '@sanity/cli-core'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {promptForProject} from '../../prompts/promptForProject.js'\nimport {getDatasetFlag, getProjectIdFlag} from '../../util/sharedFlags.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 project's 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      command: '<%= config.bin %> <%= command.id %> myDocId --project-id abc123',\n      description: 'Delete a document from a specific project',\n    },\n  ]\n\n  static override flags = {\n    ...getProjectIdFlag({description: 'Project ID to delete from', semantics: 'override'}),\n    ...getDatasetFlag({description: 'Dataset to delete from', semantics: 'override'}),\n  }\n\n  static override hiddenAliases: string[] = ['document:delete']\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 (may not exist when running outside a project directory)\n    const cliConfig = await this.tryGetCliConfig()\n\n    const projectId = await this.getProjectId({fallback: () => promptForProject({})})\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","getProjectCliClient","SanityCommand","subdebug","DOCUMENTS_API_VERSION","promptForProject","getDatasetFlag","getProjectIdFlag","deleteDocumentDebug","DeleteDocumentCommand","args","id","string","description","required","ids","examples","command","flags","semantics","hiddenAliases","strict","run","argv","parse","dataset","slice","filter","Boolean","length","error","exit","cliConfig","tryGetCliConfig","projectId","getProjectId","fallback","api","targetDataset","projectClient","apiVersion","requireUser","transaction","delete","results","commit","deleted","res","operation","map","notFound","includes","log","join","err","message"],"mappings":"AAAA,SAAQA,IAAI,QAAO,cAAa;AAChC,SAAQC,mBAAmB,EAAEC,aAAa,EAAEC,QAAQ,QAAO,mBAAkB;AAE7E,SAAQC,qBAAqB,QAAO,uCAAsC;AAC1E,SAAQC,gBAAgB,QAAO,oCAAmC;AAClE,SAAQC,cAAc,EAAEC,gBAAgB,QAAO,4BAA2B;AAE1E,MAAMC,sBAAsBL,SAAS;AAErC,OAAO,MAAMM,8BAA8BP;IACzC,OAAgBQ,OAAO;QACrBC,IAAIX,KAAKY,MAAM,CAAC;YACdC,aAAa;YACbC,UAAU;QACZ;QACAC,KAAKf,KAAKY,MAAM,CAAC;YACfC,aAAa;YACbC,UAAU;QACZ;IACF,EAAC;IAED,OAAgBD,cAAc,qEAAoE;IAElG,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;QACA;YACEI,SAAS;YACTJ,aAAa;QACf;KACD,CAAA;IAED,OAAgBK,QAAQ;QACtB,GAAGX,iBAAiB;YAACM,aAAa;YAA6BM,WAAW;QAAU,EAAE;QACtF,GAAGb,eAAe;YAACO,aAAa;YAA0BM,WAAW;QAAU,EAAE;IACnF,EAAC;IAED,OAAgBC,gBAA0B;QAAC;KAAkB,CAAA;IAE7D,uDAAuD;IACvD,sDAAsD;IACtD,OAAgBC,SAAS,MAAK;IAE9B,MAAaC,MAAqB;QAChC,MAAM,EAACZ,IAAI,EAAEa,IAAI,EAAEL,KAAK,EAAC,GAAG,MAAM,IAAI,CAACM,KAAK,CAACf;QAC7C,MAAM,EAACE,EAAE,EAAC,GAAGD;QACb,MAAM,EAACe,OAAO,EAAC,GAAGP;QAElB,8CAA8C;QAC9C,MAAMH,MAAM;YAACJ;eAAOY,KAAKG,KAAK,CAAC;SAAG,CAACC,MAAM,CAACC;QAE1C,IAAIb,IAAIc,MAAM,KAAK,GAAG;YACpB,IAAI,CAACC,KAAK,CAAC,iCAAiC;gBAACC,MAAM;YAAC;QACtD;QAEA,qFAAqF;QACrF,MAAMC,YAAY,MAAM,IAAI,CAACC,eAAe;QAE5C,MAAMC,YAAY,MAAM,IAAI,CAACC,YAAY,CAAC;YAACC,UAAU,IAAM/B,iBAAiB,CAAC;QAAE;QAE/E,IAAI,CAAC2B,UAAUK,GAAG,EAAEZ,WAAW,CAACA,SAAS;YACvC,IAAI,CAACK,KAAK,CACR,+FACA;gBAACC,MAAM;YAAC;QAEZ;QAEA,MAAMO,gBAAgBb,WAAWO,UAAUK,GAAG,EAAEZ;QAEhD,IAAI;YACF,MAAMc,gBAAgB,MAAMtC,oBAAoB;gBAC9CuC,YAAYpC;gBACZqB,SAASa;gBACTJ;gBACAO,aAAa;YACf;YAEA,MAAMC,cAAcH,cAAcG,WAAW;YAC7C,KAAK,MAAM/B,MAAMI,IAAK;gBACpB2B,YAAYC,MAAM,CAAChC;YACrB;YACA,MAAM,EAACiC,OAAO,EAAC,GAAG,MAAMF,YAAYG,MAAM;YAC1C,MAAMC,UAAUF,QAAQjB,MAAM,CAAC,CAACoB,MAAQA,IAAIC,SAAS,KAAK,UAAUC,GAAG,CAAC,CAACF,MAAQA,IAAIpC,EAAE;YACvF,MAAMuC,WAAWnC,IAAIY,MAAM,CAAC,CAAChB,KAAO,CAACmC,QAAQK,QAAQ,CAACxC;YAEtD,IAAImC,QAAQjB,MAAM,GAAG,GAAG;gBACtB,IAAI,CAACuB,GAAG,CAAC,CAAC,QAAQ,EAAEN,QAAQjB,MAAM,CAAC,CAAC,EAAEiB,QAAQjB,MAAM,KAAK,IAAI,aAAa,aAAa;YACzF;YAEA,IAAIqB,SAASrB,MAAM,GAAG,GAAG;gBACvB,IAAI,CAACC,KAAK,CACR,GAAGoB,SAASrB,MAAM,KAAK,IAAI,aAAa,YAAY,YAAY,EAAEqB,SAASG,IAAI,CAAC,OAAO,EACvF;oBACEtB,MAAM;gBACR;YAEJ;QACF,EAAE,OAAOD,OAAO;YACd,MAAMwB,MAAMxB;YACZtB,oBAAoB,CAAC,yBAAyB,EAAEO,IAAIsC,IAAI,CAAC,OAAO,EAAEC;YAClE,IAAI,CAACxB,KAAK,CACR,CAAC,iBAAiB,EAAEf,IAAIc,MAAM,CAAC,CAAC,EAAEd,IAAIc,MAAM,KAAK,IAAI,aAAa,YAAY,EAAE,EAAEyB,IAAIC,OAAO,EAAE,EAC/F;gBACExB,MAAM;YACR;QAEJ;IACF;AACF"}
+{"version":3,"sources":["../../../src/commands/documents/delete.ts"],"sourcesContent":["import {Args} from '@oclif/core'\nimport {exitCodes, getProjectCliClient, SanityCommand, subdebug} from '@sanity/cli-core'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {promptForProject} from '../../prompts/promptForProject.js'\nimport {getDatasetFlag, getProjectIdFlag} from '../../util/sharedFlags.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 project's 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      command: '<%= config.bin %> <%= command.id %> myDocId --project-id abc123',\n      description: 'Delete a document from a specific project',\n    },\n  ]\n\n  static override flags = {\n    ...getProjectIdFlag({description: 'Project ID to delete from', semantics: 'override'}),\n    ...getDatasetFlag({description: 'Dataset to delete from', semantics: 'override'}),\n  }\n\n  static override hiddenAliases: string[] = ['document:delete']\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 (may not exist when running outside a project directory)\n    const cliConfig = await this.tryGetCliConfig()\n\n    const projectId = await this.getProjectId({fallback: () => promptForProject({})})\n\n    if (!cliConfig.api?.dataset && !dataset) {\n      this.error(\n        'Dataset is required. Pass it with `--dataset <name>` or configure it in `sanity.cli.ts`.',\n        {exit: exitCodes.USAGE_ERROR},\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","exitCodes","getProjectCliClient","SanityCommand","subdebug","DOCUMENTS_API_VERSION","promptForProject","getDatasetFlag","getProjectIdFlag","deleteDocumentDebug","DeleteDocumentCommand","args","id","string","description","required","ids","examples","command","flags","semantics","hiddenAliases","strict","run","argv","parse","dataset","slice","filter","Boolean","length","error","exit","cliConfig","tryGetCliConfig","projectId","getProjectId","fallback","api","USAGE_ERROR","targetDataset","projectClient","apiVersion","requireUser","transaction","delete","results","commit","deleted","res","operation","map","notFound","includes","log","join","err","message"],"mappings":"AAAA,SAAQA,IAAI,QAAO,cAAa;AAChC,SAAQC,SAAS,EAAEC,mBAAmB,EAAEC,aAAa,EAAEC,QAAQ,QAAO,mBAAkB;AAExF,SAAQC,qBAAqB,QAAO,uCAAsC;AAC1E,SAAQC,gBAAgB,QAAO,oCAAmC;AAClE,SAAQC,cAAc,EAAEC,gBAAgB,QAAO,4BAA2B;AAE1E,MAAMC,sBAAsBL,SAAS;AAErC,OAAO,MAAMM,8BAA8BP;IACzC,OAAgBQ,OAAO;QACrBC,IAAIZ,KAAKa,MAAM,CAAC;YACdC,aAAa;YACbC,UAAU;QACZ;QACAC,KAAKhB,KAAKa,MAAM,CAAC;YACfC,aAAa;YACbC,UAAU;QACZ;IACF,EAAC;IAED,OAAgBD,cAAc,qEAAoE;IAElG,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;QACA;YACEI,SAAS;YACTJ,aAAa;QACf;KACD,CAAA;IAED,OAAgBK,QAAQ;QACtB,GAAGX,iBAAiB;YAACM,aAAa;YAA6BM,WAAW;QAAU,EAAE;QACtF,GAAGb,eAAe;YAACO,aAAa;YAA0BM,WAAW;QAAU,EAAE;IACnF,EAAC;IAED,OAAgBC,gBAA0B;QAAC;KAAkB,CAAA;IAE7D,uDAAuD;IACvD,sDAAsD;IACtD,OAAgBC,SAAS,MAAK;IAE9B,MAAaC,MAAqB;QAChC,MAAM,EAACZ,IAAI,EAAEa,IAAI,EAAEL,KAAK,EAAC,GAAG,MAAM,IAAI,CAACM,KAAK,CAACf;QAC7C,MAAM,EAACE,EAAE,EAAC,GAAGD;QACb,MAAM,EAACe,OAAO,EAAC,GAAGP;QAElB,8CAA8C;QAC9C,MAAMH,MAAM;YAACJ;eAAOY,KAAKG,KAAK,CAAC;SAAG,CAACC,MAAM,CAACC;QAE1C,IAAIb,IAAIc,MAAM,KAAK,GAAG;YACpB,IAAI,CAACC,KAAK,CAAC,iCAAiC;gBAACC,MAAM;YAAC;QACtD;QAEA,qFAAqF;QACrF,MAAMC,YAAY,MAAM,IAAI,CAACC,eAAe;QAE5C,MAAMC,YAAY,MAAM,IAAI,CAACC,YAAY,CAAC;YAACC,UAAU,IAAM/B,iBAAiB,CAAC;QAAE;QAE/E,IAAI,CAAC2B,UAAUK,GAAG,EAAEZ,WAAW,CAACA,SAAS;YACvC,IAAI,CAACK,KAAK,CACR,4FACA;gBAACC,MAAM/B,UAAUsC,WAAW;YAAA;QAEhC;QAEA,MAAMC,gBAAgBd,WAAWO,UAAUK,GAAG,EAAEZ;QAEhD,IAAI;YACF,MAAMe,gBAAgB,MAAMvC,oBAAoB;gBAC9CwC,YAAYrC;gBACZqB,SAASc;gBACTL;gBACAQ,aAAa;YACf;YAEA,MAAMC,cAAcH,cAAcG,WAAW;YAC7C,KAAK,MAAMhC,MAAMI,IAAK;gBACpB4B,YAAYC,MAAM,CAACjC;YACrB;YACA,MAAM,EAACkC,OAAO,EAAC,GAAG,MAAMF,YAAYG,MAAM;YAC1C,MAAMC,UAAUF,QAAQlB,MAAM,CAAC,CAACqB,MAAQA,IAAIC,SAAS,KAAK,UAAUC,GAAG,CAAC,CAACF,MAAQA,IAAIrC,EAAE;YACvF,MAAMwC,WAAWpC,IAAIY,MAAM,CAAC,CAAChB,KAAO,CAACoC,QAAQK,QAAQ,CAACzC;YAEtD,IAAIoC,QAAQlB,MAAM,GAAG,GAAG;gBACtB,IAAI,CAACwB,GAAG,CAAC,CAAC,QAAQ,EAAEN,QAAQlB,MAAM,CAAC,CAAC,EAAEkB,QAAQlB,MAAM,KAAK,IAAI,aAAa,aAAa;YACzF;YAEA,IAAIsB,SAAStB,MAAM,GAAG,GAAG;gBACvB,IAAI,CAACC,KAAK,CACR,GAAGqB,SAAStB,MAAM,KAAK,IAAI,aAAa,YAAY,YAAY,EAAEsB,SAASG,IAAI,CAAC,OAAO,EACvF;oBACEvB,MAAM;gBACR;YAEJ;QACF,EAAE,OAAOD,OAAO;YACd,MAAMyB,MAAMzB;YACZtB,oBAAoB,CAAC,yBAAyB,EAAEO,IAAIuC,IAAI,CAAC,OAAO,EAAEC;YAClE,IAAI,CAACzB,KAAK,CACR,CAAC,iBAAiB,EAAEf,IAAIc,MAAM,CAAC,CAAC,EAAEd,IAAIc,MAAM,KAAK,IAAI,aAAa,YAAY,EAAE,EAAE0B,IAAIC,OAAO,EAAE,EAC/F;gBACEzB,MAAM;YACR;QAEJ;IACF;AACF"}

package/dist/commands/documents/get.js

@@ -1,5 +1,5 @@
 import { Args, Flags } from '@oclif/core';
-import { colorizeJson, getProjectCliClient, SanityCommand, subdebug } from '@sanity/cli-core';
+import { colorizeJson, exitCodes, getProjectCliClient, SanityCommand, subdebug } from '@sanity/cli-core';
 import { DOCUMENTS_API_VERSION } from '../../actions/documents/constants.js';
 import { promptForProject } from '../../prompts/promptForProject.js';
 import { getDatasetFlag, getProjectIdFlag } from '../../util/sharedFlags.js';
@@ -56,8 +56,8 @@ export class GetDocumentCommand extends SanityCommand {
             fallback: ()=>promptForProject({})
         });
         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
+            this.error('Dataset is required. Pass it with `--dataset <name>` or configure it in `sanity.cli.ts`.', {
+                exit: exitCodes.USAGE_ERROR
             });
         }
         const targetDataset = dataset || cliConfig.api?.dataset;

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

@@ -1 +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 {promptForProject} from '../../prompts/promptForProject.js'\nimport {getDatasetFlag, getProjectIdFlag} from '../../util/sharedFlags.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      command: '<%= config.bin %> <%= command.id %> myDocId --project-id abc123',\n      description: 'Get a document from a specific project',\n    },\n  ]\n\n  static override flags = {\n    ...getProjectIdFlag({\n      description: 'Project ID to get document from',\n      semantics: 'override',\n    }),\n    ...getDatasetFlag({description: 'Dataset to get document from', semantics: 'override'}),\n    pretty: Flags.boolean({\n      default: false,\n      description: 'Colorize JSON output',\n    }),\n  }\n\n  static override hiddenAliases: string[] = ['document:get']\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    const cliConfig = await this.tryGetCliConfig()\n\n    const projectId = await this.getProjectId({fallback: () => promptForProject({})})\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","promptForProject","getDatasetFlag","getProjectIdFlag","getDocumentDebug","GetDocumentCommand","args","documentId","string","description","required","examples","command","flags","semantics","pretty","boolean","default","hiddenAliases","run","parse","dataset","cliConfig","tryGetCliConfig","projectId","getProjectId","fallback","api","error","exit","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,gBAAgB,QAAO,oCAAmC;AAClE,SAAQC,cAAc,EAAEC,gBAAgB,QAAO,4BAA2B;AAE1E,MAAMC,mBAAmBL,SAAS;AAElC,OAAO,MAAMM,2BAA2BP;IACtC,OAAgBQ,OAAO;QACrBC,YAAYb,KAAKc,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;QACA;YACEG,SAAS;YACTH,aAAa;QACf;KACD,CAAA;IAED,OAAgBI,QAAQ;QACtB,GAAGV,iBAAiB;YAClBM,aAAa;YACbK,WAAW;QACb,EAAE;QACF,GAAGZ,eAAe;YAACO,aAAa;YAAgCK,WAAW;QAAU,EAAE;QACvFC,QAAQpB,MAAMqB,OAAO,CAAC;YACpBC,SAAS;YACTR,aAAa;QACf;IACF,EAAC;IAED,OAAgBS,gBAA0B;QAAC;KAAe,CAAA;IAE1D,MAAaC,MAAqB;QAChC,MAAM,EAACb,IAAI,EAAEO,KAAK,EAAC,GAAG,MAAM,IAAI,CAACO,KAAK,CAACf;QACvC,MAAM,EAACE,UAAU,EAAC,GAAGD;QACrB,MAAM,EAACe,OAAO,EAAEN,MAAM,EAAC,GAAGF;QAE1B,MAAMS,YAAY,MAAM,IAAI,CAACC,eAAe;QAE5C,MAAMC,YAAY,MAAM,IAAI,CAACC,YAAY,CAAC;YAACC,UAAU,IAAMzB,iBAAiB,CAAC;QAAE;QAE/E,IAAI,CAACqB,UAAUK,GAAG,EAAEN,WAAW,CAACA,SAAS;YACvC,IAAI,CAACO,KAAK,CACR,+FACA;gBAACC,MAAM;YAAC;QAEZ;QAEA,MAAMC,gBAAgBT,WAAWC,UAAUK,GAAG,EAAEN;QAEhD,IAAI;YACF,MAAMU,gBAAgB,MAAMlC,oBAAoB;gBAC9CmC,YAAYhC;gBACZqB,SAASS;gBACTN;gBACAS,aAAa;YACf;YAEA,MAAMC,MAAM,MAAMH,cAAcI,WAAW,CAAC5B;YAE5C,IAAI,CAAC2B,KAAK;gBACR,IAAI,CAACN,KAAK,CAAC,CAAC,UAAU,EAAErB,WAAW,wBAAwB,EAAEuB,cAAc,CAAC,CAAC,EAAE;oBAACD,MAAM;gBAAC;YACzF;YAEA,sBAAsB;YACtB,IAAId,QAAQ;gBACV,IAAI,CAACqB,GAAG,CAACxC,aAAasC;YACxB,OAAO;gBACL,IAAI,CAACE,GAAG,CAACC,KAAKC,SAAS,CAACJ,KAAK,MAAM;YACrC;QACF,EAAE,OAAON,OAAO;YACd,MAAMW,MAAMX;YAEZxB,iBAAiB,CAAC,wBAAwB,EAAEG,YAAY,EAAEgC;YAC1D,IAAI,CAACX,KAAK,CAAC,CAAC,0BAA0B,EAAEW,IAAIC,OAAO,EAAE,EAAE;gBAACX,MAAM;YAAC;QACjE;IACF;AACF"}
+{"version":3,"sources":["../../../src/commands/documents/get.ts"],"sourcesContent":["import {Args, Flags} from '@oclif/core'\nimport {\n  colorizeJson,\n  exitCodes,\n  getProjectCliClient,\n  SanityCommand,\n  subdebug,\n} from '@sanity/cli-core'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {promptForProject} from '../../prompts/promptForProject.js'\nimport {getDatasetFlag, getProjectIdFlag} from '../../util/sharedFlags.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      command: '<%= config.bin %> <%= command.id %> myDocId --project-id abc123',\n      description: 'Get a document from a specific project',\n    },\n  ]\n\n  static override flags = {\n    ...getProjectIdFlag({\n      description: 'Project ID to get document from',\n      semantics: 'override',\n    }),\n    ...getDatasetFlag({description: 'Dataset to get document from', semantics: 'override'}),\n    pretty: Flags.boolean({\n      default: false,\n      description: 'Colorize JSON output',\n    }),\n  }\n\n  static override hiddenAliases: string[] = ['document:get']\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    const cliConfig = await this.tryGetCliConfig()\n\n    const projectId = await this.getProjectId({fallback: () => promptForProject({})})\n\n    if (!cliConfig.api?.dataset && !dataset) {\n      this.error(\n        'Dataset is required. Pass it with `--dataset <name>` or configure it in `sanity.cli.ts`.',\n        {exit: exitCodes.USAGE_ERROR},\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","exitCodes","getProjectCliClient","SanityCommand","subdebug","DOCUMENTS_API_VERSION","promptForProject","getDatasetFlag","getProjectIdFlag","getDocumentDebug","GetDocumentCommand","args","documentId","string","description","required","examples","command","flags","semantics","pretty","boolean","default","hiddenAliases","run","parse","dataset","cliConfig","tryGetCliConfig","projectId","getProjectId","fallback","api","error","exit","USAGE_ERROR","targetDataset","projectClient","apiVersion","requireUser","doc","getDocument","log","JSON","stringify","err","message"],"mappings":"AAAA,SAAQA,IAAI,EAAEC,KAAK,QAAO,cAAa;AACvC,SACEC,YAAY,EACZC,SAAS,EACTC,mBAAmB,EACnBC,aAAa,EACbC,QAAQ,QACH,mBAAkB;AAEzB,SAAQC,qBAAqB,QAAO,uCAAsC;AAC1E,SAAQC,gBAAgB,QAAO,oCAAmC;AAClE,SAAQC,cAAc,EAAEC,gBAAgB,QAAO,4BAA2B;AAE1E,MAAMC,mBAAmBL,SAAS;AAElC,OAAO,MAAMM,2BAA2BP;IACtC,OAAgBQ,OAAO;QACrBC,YAAYd,KAAKe,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;QACA;YACEG,SAAS;YACTH,aAAa;QACf;KACD,CAAA;IAED,OAAgBI,QAAQ;QACtB,GAAGV,iBAAiB;YAClBM,aAAa;YACbK,WAAW;QACb,EAAE;QACF,GAAGZ,eAAe;YAACO,aAAa;YAAgCK,WAAW;QAAU,EAAE;QACvFC,QAAQrB,MAAMsB,OAAO,CAAC;YACpBC,SAAS;YACTR,aAAa;QACf;IACF,EAAC;IAED,OAAgBS,gBAA0B;QAAC;KAAe,CAAA;IAE1D,MAAaC,MAAqB;QAChC,MAAM,EAACb,IAAI,EAAEO,KAAK,EAAC,GAAG,MAAM,IAAI,CAACO,KAAK,CAACf;QACvC,MAAM,EAACE,UAAU,EAAC,GAAGD;QACrB,MAAM,EAACe,OAAO,EAAEN,MAAM,EAAC,GAAGF;QAE1B,MAAMS,YAAY,MAAM,IAAI,CAACC,eAAe;QAE5C,MAAMC,YAAY,MAAM,IAAI,CAACC,YAAY,CAAC;YAACC,UAAU,IAAMzB,iBAAiB,CAAC;QAAE;QAE/E,IAAI,CAACqB,UAAUK,GAAG,EAAEN,WAAW,CAACA,SAAS;YACvC,IAAI,CAACO,KAAK,CACR,4FACA;gBAACC,MAAMjC,UAAUkC,WAAW;YAAA;QAEhC;QAEA,MAAMC,gBAAgBV,WAAWC,UAAUK,GAAG,EAAEN;QAEhD,IAAI;YACF,MAAMW,gBAAgB,MAAMnC,oBAAoB;gBAC9CoC,YAAYjC;gBACZqB,SAASU;gBACTP;gBACAU,aAAa;YACf;YAEA,MAAMC,MAAM,MAAMH,cAAcI,WAAW,CAAC7B;YAE5C,IAAI,CAAC4B,KAAK;gBACR,IAAI,CAACP,KAAK,CAAC,CAAC,UAAU,EAAErB,WAAW,wBAAwB,EAAEwB,cAAc,CAAC,CAAC,EAAE;oBAACF,MAAM;gBAAC;YACzF;YAEA,sBAAsB;YACtB,IAAId,QAAQ;gBACV,IAAI,CAACsB,GAAG,CAAC1C,aAAawC;YACxB,OAAO;gBACL,IAAI,CAACE,GAAG,CAACC,KAAKC,SAAS,CAACJ,KAAK,MAAM;YACrC;QACF,EAAE,OAAOP,OAAO;YACd,MAAMY,MAAMZ;YAEZxB,iBAAiB,CAAC,wBAAwB,EAAEG,YAAY,EAAEiC;YAC1D,IAAI,CAACZ,KAAK,CAAC,CAAC,0BAA0B,EAAEY,IAAIC,OAAO,EAAE,EAAE;gBAACZ,MAAM;YAAC;QACjE;IACF;AACF"}

package/dist/commands/documents/query.js

@@ -1,5 +1,5 @@
 import { Args, Flags } from '@oclif/core';
-import { colorizeJson, getProjectCliClient, SanityCommand, subdebug } from '@sanity/cli-core';
+import { colorizeJson, exitCodes, getProjectCliClient, SanityCommand, subdebug } from '@sanity/cli-core';
 import { DOCUMENTS_API_VERSION } from '../../actions/documents/constants.js';
 import { promptForProject } from '../../prompts/promptForProject.js';
 import { getDatasetFlag, getProjectIdFlag } from '../../util/sharedFlags.js';
@@ -73,8 +73,8 @@ export class QueryDocumentCommand extends SanityCommand {
         });
         const requireUser = !anonymous;
         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
+            this.error('Dataset is required. Pass it with `--dataset <name>` or configure it in `sanity.cli.ts`.', {
+                exit: exitCodes.USAGE_ERROR
             });
         }
         const targetDataset = dataset || cliConfig.api?.dataset;

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

@@ -1 +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 {promptForProject} from '../../prompts/promptForProject.js'\nimport {getDatasetFlag, getProjectIdFlag} from '../../util/sharedFlags.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      command:\n        '<%= config.bin %> <%= command.id %> \\'*[_type == \"post\"]\\' --project-id abc123 --dataset production',\n      description: 'Query documents in a specific project and dataset',\n    },\n  ]\n\n  static override flags = {\n    ...getProjectIdFlag({description: 'Project ID to query', semantics: 'override'}),\n    ...getDatasetFlag({description: 'Dataset to query', semantics: 'override'}),\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    pretty: Flags.boolean({\n      default: false,\n      description: 'Colorize JSON output',\n    }),\n    project: Flags.string({\n      deprecated: {to: 'project-id'},\n      description: 'Project ID to query',\n      hidden: true,\n    }),\n  }\n\n  static override hiddenAliases: string[] = ['document:query']\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} = flags\n\n    const cliConfig = await this.tryGetCliConfig()\n\n    const projectId = await this.getProjectId({\n      deprecatedFlagName: 'project',\n      fallback: () => promptForProject({}),\n    })\n\n    const requireUser = !anonymous\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,\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","promptForProject","getDatasetFlag","getProjectIdFlag","queryDocumentDebug","QueryDocumentCommand","args","query","string","description","required","examples","command","flags","semantics","anonymous","boolean","default","env","pretty","project","deprecated","to","hidden","hiddenAliases","run","parse","apiVersion","dataset","cliConfig","tryGetCliConfig","projectId","getProjectId","deprecatedFlagName","fallback","requireUser","api","error","exit","targetDataset","targetApiVersion","warn","projectClient","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,gBAAgB,QAAO,oCAAmC;AAClE,SAAQC,cAAc,EAAEC,gBAAgB,QAAO,4BAA2B;AAE1E,MAAMC,qBAAqBL,SAAS;AAEpC,OAAO,MAAMM,6BAA6BP;IACxC,OAAgBQ,OAAO;QACrBC,OAAOb,KAAKc,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;QACA;YACEG,SACE;YACFH,aAAa;QACf;KACD,CAAA;IAED,OAAgBI,QAAQ;QACtB,GAAGV,iBAAiB;YAACM,aAAa;YAAuBK,WAAW;QAAU,EAAE;QAChF,GAAGZ,eAAe;YAACO,aAAa;YAAoBK,WAAW;QAAU,EAAE;QAC3EC,WAAWpB,MAAMqB,OAAO,CAAC;YACvBC,SAAS;YACTR,aAAa;QACf;QACA,eAAed,MAAMa,MAAM,CAAC;YAC1BC,aAAa,CAAC,gCAAgC,EAAET,sBAAsB,CAAC,CAAC;YACxEkB,KAAK;QACP;QACAC,QAAQxB,MAAMqB,OAAO,CAAC;YACpBC,SAAS;YACTR,aAAa;QACf;QACAW,SAASzB,MAAMa,MAAM,CAAC;YACpBa,YAAY;gBAACC,IAAI;YAAY;YAC7Bb,aAAa;YACbc,QAAQ;QACV;IACF,EAAC;IAED,OAAgBC,gBAA0B;QAAC;KAAiB,CAAA;IAE5D,MAAaC,MAAqB;QAChC,MAAM,EAACnB,IAAI,EAAEO,KAAK,EAAC,GAAG,MAAM,IAAI,CAACa,KAAK,CAACrB;QACvC,MAAM,EAACE,KAAK,EAAC,GAAGD;QAChB,MAAM,EAACS,SAAS,EAAE,eAAeY,UAAU,EAAEC,OAAO,EAAET,MAAM,EAAC,GAAGN;QAEhE,MAAMgB,YAAY,MAAM,IAAI,CAACC,eAAe;QAE5C,MAAMC,YAAY,MAAM,IAAI,CAACC,YAAY,CAAC;YACxCC,oBAAoB;YACpBC,UAAU,IAAMjC,iBAAiB,CAAC;QACpC;QAEA,MAAMkC,cAAc,CAACpB;QAErB,IAAI,CAACc,UAAUO,GAAG,EAAER,WAAW,CAACA,SAAS;YACvC,IAAI,CAACS,KAAK,CACR,+FACA;gBAACC,MAAM;YAAC;QAEZ;QAEA,MAAMC,gBAAgBX,WAAWC,UAAUO,GAAG,EAAER;QAChD,MAAMY,mBAAmBb,cAAc3B;QAEvC,IAAI,CAAC2B,YAAY;YACf,IAAI,CAACc,IAAI,CAAC,CAAC,qCAAqC,EAAEzC,sBAAsB,EAAE,CAAC;QAC7E;QAEA,IAAI;YACF,MAAM0C,gBAAgB,MAAM7C,oBAAoB;gBAC9C8B,YAAYa;gBACZZ,SAASW;gBACTR;gBACAI;YACF;YAEA,MAAMQ,OAAO,MAAMD,cAAcE,KAAK,CAACrC;YAEvC,IAAI,CAACoC,MAAM;gBACT,IAAI,CAACN,KAAK,CAAC,6BAA6B;oBAACC,MAAM;gBAAC;YAClD;YAEA,2BAA2B;YAC3B,IAAInB,QAAQ;gBACV,IAAI,CAAC0B,GAAG,CAACjD,aAAa+C;YACxB,OAAO;gBACL,IAAI,CAACE,GAAG,CAACC,KAAKC,SAAS,CAACJ,MAAM,MAAM;YACtC;QACF,EAAE,OAAON,OAAO;YACd,MAAMW,MAAMX;YAEZjC,mBAAmB,CAAC,qBAAqB,EAAEG,OAAO,EAAEyC;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,CAACb,KAAK,CAAC,GAAGY,SAAS,SAAS,EAAE1C,OAAO,EAAE;gBAAC+B,MAAM;YAAC;QACrD;IACF;AACF"}
+{"version":3,"sources":["../../../src/commands/documents/query.ts"],"sourcesContent":["import {Args, Flags} from '@oclif/core'\nimport {\n  colorizeJson,\n  exitCodes,\n  getProjectCliClient,\n  SanityCommand,\n  subdebug,\n} from '@sanity/cli-core'\n\nimport {DOCUMENTS_API_VERSION} from '../../actions/documents/constants.js'\nimport {promptForProject} from '../../prompts/promptForProject.js'\nimport {getDatasetFlag, getProjectIdFlag} from '../../util/sharedFlags.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      command:\n        '<%= config.bin %> <%= command.id %> \\'*[_type == \"post\"]\\' --project-id abc123 --dataset production',\n      description: 'Query documents in a specific project and dataset',\n    },\n  ]\n\n  static override flags = {\n    ...getProjectIdFlag({description: 'Project ID to query', semantics: 'override'}),\n    ...getDatasetFlag({description: 'Dataset to query', semantics: 'override'}),\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    pretty: Flags.boolean({\n      default: false,\n      description: 'Colorize JSON output',\n    }),\n    project: Flags.string({\n      deprecated: {to: 'project-id'},\n      description: 'Project ID to query',\n      hidden: true,\n    }),\n  }\n\n  static override hiddenAliases: string[] = ['document:query']\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} = flags\n\n    const cliConfig = await this.tryGetCliConfig()\n\n    const projectId = await this.getProjectId({\n      deprecatedFlagName: 'project',\n      fallback: () => promptForProject({}),\n    })\n\n    const requireUser = !anonymous\n\n    if (!cliConfig.api?.dataset && !dataset) {\n      this.error(\n        'Dataset is required. Pass it with `--dataset <name>` or configure it in `sanity.cli.ts`.',\n        {exit: exitCodes.USAGE_ERROR},\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,\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","exitCodes","getProjectCliClient","SanityCommand","subdebug","DOCUMENTS_API_VERSION","promptForProject","getDatasetFlag","getProjectIdFlag","queryDocumentDebug","QueryDocumentCommand","args","query","string","description","required","examples","command","flags","semantics","anonymous","boolean","default","env","pretty","project","deprecated","to","hidden","hiddenAliases","run","parse","apiVersion","dataset","cliConfig","tryGetCliConfig","projectId","getProjectId","deprecatedFlagName","fallback","requireUser","api","error","exit","USAGE_ERROR","targetDataset","targetApiVersion","warn","projectClient","docs","fetch","log","JSON","stringify","err","errorMsg","message","toLowerCase","includes"],"mappings":"AAAA,SAAQA,IAAI,EAAEC,KAAK,QAAO,cAAa;AACvC,SACEC,YAAY,EACZC,SAAS,EACTC,mBAAmB,EACnBC,aAAa,EACbC,QAAQ,QACH,mBAAkB;AAEzB,SAAQC,qBAAqB,QAAO,uCAAsC;AAC1E,SAAQC,gBAAgB,QAAO,oCAAmC;AAClE,SAAQC,cAAc,EAAEC,gBAAgB,QAAO,4BAA2B;AAE1E,MAAMC,qBAAqBL,SAAS;AAEpC,OAAO,MAAMM,6BAA6BP;IACxC,OAAgBQ,OAAO;QACrBC,OAAOd,KAAKe,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;QACA;YACEG,SACE;YACFH,aAAa;QACf;KACD,CAAA;IAED,OAAgBI,QAAQ;QACtB,GAAGV,iBAAiB;YAACM,aAAa;YAAuBK,WAAW;QAAU,EAAE;QAChF,GAAGZ,eAAe;YAACO,aAAa;YAAoBK,WAAW;QAAU,EAAE;QAC3EC,WAAWrB,MAAMsB,OAAO,CAAC;YACvBC,SAAS;YACTR,aAAa;QACf;QACA,eAAef,MAAMc,MAAM,CAAC;YAC1BC,aAAa,CAAC,gCAAgC,EAAET,sBAAsB,CAAC,CAAC;YACxEkB,KAAK;QACP;QACAC,QAAQzB,MAAMsB,OAAO,CAAC;YACpBC,SAAS;YACTR,aAAa;QACf;QACAW,SAAS1B,MAAMc,MAAM,CAAC;YACpBa,YAAY;gBAACC,IAAI;YAAY;YAC7Bb,aAAa;YACbc,QAAQ;QACV;IACF,EAAC;IAED,OAAgBC,gBAA0B;QAAC;KAAiB,CAAA;IAE5D,MAAaC,MAAqB;QAChC,MAAM,EAACnB,IAAI,EAAEO,KAAK,EAAC,GAAG,MAAM,IAAI,CAACa,KAAK,CAACrB;QACvC,MAAM,EAACE,KAAK,EAAC,GAAGD;QAChB,MAAM,EAACS,SAAS,EAAE,eAAeY,UAAU,EAAEC,OAAO,EAAET,MAAM,EAAC,GAAGN;QAEhE,MAAMgB,YAAY,MAAM,IAAI,CAACC,eAAe;QAE5C,MAAMC,YAAY,MAAM,IAAI,CAACC,YAAY,CAAC;YACxCC,oBAAoB;YACpBC,UAAU,IAAMjC,iBAAiB,CAAC;QACpC;QAEA,MAAMkC,cAAc,CAACpB;QAErB,IAAI,CAACc,UAAUO,GAAG,EAAER,WAAW,CAACA,SAAS;YACvC,IAAI,CAACS,KAAK,CACR,4FACA;gBAACC,MAAM1C,UAAU2C,WAAW;YAAA;QAEhC;QAEA,MAAMC,gBAAgBZ,WAAWC,UAAUO,GAAG,EAAER;QAChD,MAAMa,mBAAmBd,cAAc3B;QAEvC,IAAI,CAAC2B,YAAY;YACf,IAAI,CAACe,IAAI,CAAC,CAAC,qCAAqC,EAAE1C,sBAAsB,EAAE,CAAC;QAC7E;QAEA,IAAI;YACF,MAAM2C,gBAAgB,MAAM9C,oBAAoB;gBAC9C8B,YAAYc;gBACZb,SAASY;gBACTT;gBACAI;YACF;YAEA,MAAMS,OAAO,MAAMD,cAAcE,KAAK,CAACtC;YAEvC,IAAI,CAACqC,MAAM;gBACT,IAAI,CAACP,KAAK,CAAC,6BAA6B;oBAACC,MAAM;gBAAC;YAClD;YAEA,2BAA2B;YAC3B,IAAInB,QAAQ;gBACV,IAAI,CAAC2B,GAAG,CAACnD,aAAaiD;YACxB,OAAO;gBACL,IAAI,CAACE,GAAG,CAACC,KAAKC,SAAS,CAACJ,MAAM,MAAM;YACtC;QACF,EAAE,OAAOP,OAAO;YACd,MAAMY,MAAMZ;YAEZjC,mBAAmB,CAAC,qBAAqB,EAAEG,OAAO,EAAE0C;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,CAACd,KAAK,CAAC,GAAGa,SAAS,SAAS,EAAE3C,OAAO,EAAE;gBAAC+B,MAAM;YAAC;QACrD;IACF;AACF"}

package/dist/commands/documents/validate.js

@@ -2,6 +2,7 @@ import { stat } from 'node:fs/promises';
 import path from 'node:path';
 import { styleText } from 'node:util';
 import { Flags } from '@oclif/core';
+import { exitCodes } from '@sanity/cli-core';
 import { ProjectRootNotFoundError } from '@sanity/cli-core/errors';
 import { SanityCommand } from '@sanity/cli-core/SanityCommand';
 import { confirm, logSymbols } from '@sanity/cli-core/ux';
@@ -42,10 +43,15 @@ export class ValidateDocumentsCommand extends SanityCommand {
             semantics: 'specify'
         }),
         file: Flags.string({
-            description: 'Provide a path to either an .ndjson file or a tarball containing an .ndjson file'
+            description: 'Path to an NDJSON file or tar archive containing an NDJSON file (optionally gzip-compressed)'
         }),
         format: Flags.string({
-            description: 'The output format used to print the found validation markers and report progress'
+            description: 'The output format used to print the found validation markers and report progress',
+            options: [
+                'json',
+                'ndjson',
+                'pretty'
+            ]
         }),
         level: Flags.custom({
             default: 'warning',
@@ -79,7 +85,7 @@ export class ValidateDocumentsCommand extends SanityCommand {
     async run() {
         const { flags } = await this.parse(ValidateDocumentsCommand);
         const { dataset, file, format, level, 'max-custom-validation-concurrency': maxCustomValidationConcurrency, 'max-fetch-concurrency': maxFetchConcurrency, 'project-id': projectId, workspace } = flags;
-        const unattendedMode = Boolean(flags.yes);
+        const unattendedMode = this.isUnattended();
         let workDir;
         let cliConfig;
         try {
@@ -94,6 +100,24 @@ export class ValidateDocumentsCommand extends SanityCommand {
             }
             throw err;
         }
+        let ndjsonFilePath;
+        if (file) {
+            const filePath = path.resolve(workDir, file);
+            let fileStat;
+            try {
+                fileStat = await stat(filePath);
+            } catch  {
+                return this.output.error(`File not found: ${file}. Pass an existing NDJSON file or tar archive with \`--file <path>\`.`, {
+                    exit: exitCodes.USAGE_ERROR
+                });
+            }
+            if (!fileStat.isFile()) {
+                return this.output.error(`Invalid file path: ${file} is not a file. Pass an NDJSON file or tar archive with \`--file <path>\`.`, {
+                    exit: exitCodes.USAGE_ERROR
+                });
+            }
+            ndjsonFilePath = filePath;
+        }
         if (!unattendedMode) {
             this.output.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.output.log(`Potential pitfalls:\n`);
@@ -109,31 +133,10 @@ export class ValidateDocumentsCommand extends SanityCommand {
                 message: `Are you sure you want to continue?`
             });
             if (!confirmed) {
-                return this.output.error('User aborted', {
-                    exit: 1
-                });
+                this.output.log('Validation cancelled');
+                return this.exit(exitCodes.USER_ABORT);
             }
         }
-        if (format && !(format in reporters)) {
-            const formatter = new Intl.ListFormat('en-US', {
-                style: 'long',
-                type: 'conjunction'
-            });
-            return this.output.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 st = await stat(filePath);
-            if (!st.isFile()) {
-                return this.output.error(`'--file' must point to a valid ndjson file or tarball`, {
-                    exit: 1
-                });
-            }
-            ndjsonFilePath = filePath;
-        }
         try {
             const overallLevel = await validateDocuments({
                 dataset,

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/commands/documents/validate.ts"],"sourcesContent":["import {stat} from 'node:fs/promises'\nimport path from 'node:path'\nimport {styleText} from 'node:util'\n\nimport {Flags} from '@oclif/core'\nimport {ProjectRootNotFoundError} from '@sanity/cli-core/errors'\nimport {SanityCommand} from '@sanity/cli-core/SanityCommand'\nimport {type CliConfig} from '@sanity/cli-core/types'\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'\nimport {getDatasetFlag, getProjectIdFlag} from '../../util/sharedFlags.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      command: '<%= config.bin %> <%= command.id %> --project-id abc123 --dataset production',\n      description: 'Validate documents in a specific project and dataset',\n    },\n  ]\n\n  static flags = {\n    ...getProjectIdFlag({\n      description:\n        'Override the project ID used. By default, this is derived from the given workspace',\n      semantics: 'specify',\n    }),\n    ...getDatasetFlag({\n      description:\n        'Override the dataset used. By default, this is derived from the given workspace',\n      semantics: 'specify',\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. 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 allowed to run concurrently',\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  static override hiddenAliases: string[] = ['document:validate']\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      'project-id': projectId,\n      workspace,\n    } = flags\n    const unattendedMode = Boolean(flags.yes)\n\n    let workDir: string\n    let cliConfig: CliConfig\n    try {\n      const root = await this.getProjectRoot()\n      workDir = root.directory\n      cliConfig = await this.getCliConfig()\n    } catch (err) {\n      if (err instanceof ProjectRootNotFoundError) {\n        return this.output.error(\n          'This command must be run from within a Sanity project directory (requires studio schema for validation)',\n          {exit: 1},\n        )\n      }\n      throw err\n    }\n\n    if (!unattendedMode) {\n      this.output.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.output.log(`Potential pitfalls:\\n`)\n      this.output.log(\n        `- Processes all documents locally (excluding assets). Large datasets may require more resources.`,\n      )\n      this.output.log(\n        `- Executes all custom validation functions. Some functions may need to be refactored for compatibility.`,\n      )\n      this.output.log(\n        `- Not all standard browser features are available and may cause issues while loading your Studio.`,\n      )\n      this.output.log(\n        `- Adheres to document permissions. Ensure this account can see all desired documents.`,\n      )\n      if (file) {\n        this.output.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        return this.output.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      return this.output.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 st = await stat(filePath)\n      if (!st.isFile()) {\n        return this.output.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        projectId,\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        return this.exit(1)\n      }\n    } catch (err) {\n      return this.output.error(err instanceof Error ? err.message : String(err), {exit: 1})\n    }\n  }\n}\n"],"names":["stat","path","styleText","Flags","ProjectRootNotFoundError","SanityCommand","confirm","logSymbols","validateDocuments","reporters","getDatasetFlag","getProjectIdFlag","ValidateDocumentsCommand","description","examples","command","flags","semantics","file","string","format","level","custom","default","options","integer","workspace","yes","boolean","char","hiddenAliases","run","parse","dataset","maxCustomValidationConcurrency","maxFetchConcurrency","projectId","unattendedMode","Boolean","workDir","cliConfig","root","getProjectRoot","directory","getCliConfig","err","output","error","exit","log","warning","confirmed","message","formatter","Intl","ListFormat","style","type","Object","keys","map","key","ndjsonFilePath","filePath","resolve","st","isFile","overallLevel","reporter","worker","pretty","studioHost","Error","String"],"mappings":"AAAA,SAAQA,IAAI,QAAO,mBAAkB;AACrC,OAAOC,UAAU,YAAW;AAC5B,SAAQC,SAAS,QAAO,YAAW;AAEnC,SAAQC,KAAK,QAAO,cAAa;AACjC,SAAQC,wBAAwB,QAAO,0BAAyB;AAChE,SAAQC,aAAa,QAAO,iCAAgC;AAE5D,SAAQC,OAAO,EAAEC,UAAU,QAAO,sBAAqB;AAGvD,SAAQC,iBAAiB,QAAO,sCAAqC;AACrE,SAAQC,SAAS,QAAO,wDAAuD;AAC/E,SAAQC,cAAc,EAAEC,gBAAgB,QAAO,4BAA2B;AAE1E,OAAO,MAAMC,iCAAiCP;IAC5C,OAAOQ,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;QACA;YACEE,SAAS;YACTF,aAAa;QACf;KACD,CAAA;IAED,OAAOG,QAAQ;QACb,GAAGL,iBAAiB;YAClBE,aACE;YACFI,WAAW;QACb,EAAE;QACF,GAAGP,eAAe;YAChBG,aACE;YACFI,WAAW;QACb,EAAE;QACFC,MAAMf,MAAMgB,MAAM,CAAC;YACjBN,aACE;QACJ;QACAO,QAAQjB,MAAMgB,MAAM,CAAC;YACnBN,aACE;QACJ;QACAQ,OAAOlB,MAAMmB,MAAM,CAAQ;YACzBC,SAAS;YACTV,aAAa;YACbW,SAAS;gBAAC;gBAAS;gBAAW;aAAO;QACvC;QACA,qCAAqCrB,MAAMsB,OAAO,CAAC;YACjDF,SAAS;YACTV,aAAa;QACf;QACA,yBAAyBV,MAAMsB,OAAO,CAAC;YACrCF,SAAS;YACTV,aAAa;QACf;QACAa,WAAWvB,MAAMgB,MAAM,CAAC;YACtBN,aAAa;QACf;QACAc,KAAKxB,MAAMyB,OAAO,CAAC;YACjBC,MAAM;YACNN,SAAS;YACTV,aAAa;QACf;IACF,EAAC;IAED,OAAgBiB,gBAA0B;QAAC;KAAoB,CAAA;IAE/D,MAAaC,MAAqB;QAChC,MAAM,EAACf,KAAK,EAAC,GAAG,MAAM,IAAI,CAACgB,KAAK,CAACpB;QACjC,MAAM,EACJqB,OAAO,EACPf,IAAI,EACJE,MAAM,EACNC,KAAK,EACL,qCAAqCa,8BAA8B,EACnE,yBAAyBC,mBAAmB,EAC5C,cAAcC,SAAS,EACvBV,SAAS,EACV,GAAGV;QACJ,MAAMqB,iBAAiBC,QAAQtB,MAAMW,GAAG;QAExC,IAAIY;QACJ,IAAIC;QACJ,IAAI;YACF,MAAMC,OAAO,MAAM,IAAI,CAACC,cAAc;YACtCH,UAAUE,KAAKE,SAAS;YACxBH,YAAY,MAAM,IAAI,CAACI,YAAY;QACrC,EAAE,OAAOC,KAAK;YACZ,IAAIA,eAAezC,0BAA0B;gBAC3C,OAAO,IAAI,CAAC0C,MAAM,CAACC,KAAK,CACtB,2GACA;oBAACC,MAAM;gBAAC;YAEZ;YACA,MAAMH;QACR;QAEA,IAAI,CAACR,gBAAgB;YACnB,IAAI,CAACS,MAAM,CAACG,GAAG,CACb,GAAG/C,UAAU,UAAU,GAAGK,WAAW2C,OAAO,CAAC,SAAS,CAAC,EAAE,cAAc,EACrEhC,OACI,6CACA,4CACL,uDAAuD,CAAC,GACvD,CAAC,gCAAgC,CAAC;YAEtC,IAAI,CAAC4B,MAAM,CAACG,GAAG,CAAC,CAAC,qBAAqB,CAAC;YACvC,IAAI,CAACH,MAAM,CAACG,GAAG,CACb,CAAC,gGAAgG,CAAC;YAEpG,IAAI,CAACH,MAAM,CAACG,GAAG,CACb,CAAC,uGAAuG,CAAC;YAE3G,IAAI,CAACH,MAAM,CAACG,GAAG,CACb,CAAC,iGAAiG,CAAC;YAErG,IAAI,CAACH,MAAM,CAACG,GAAG,CACb,CAAC,qFAAqF,CAAC;YAEzF,IAAI/B,MAAM;gBACR,IAAI,CAAC4B,MAAM,CAACG,GAAG,CACb,CAAC,4FAA4F,CAAC;YAElG;YAEA,MAAME,YAAY,MAAM7C,QAAQ;gBAC9BiB,SAAS;gBACT6B,SAAS,CAAC,kCAAkC,CAAC;YAC/C;YAEA,IAAI,CAACD,WAAW;gBACd,OAAO,IAAI,CAACL,MAAM,CAACC,KAAK,CAAC,gBAAgB;oBAACC,MAAM;gBAAC;YACnD;QACF;QAEA,IAAI5B,UAAU,CAAEA,CAAAA,UAAUX,SAAQ,GAAI;YACpC,MAAM4C,YAAY,IAAIC,KAAKC,UAAU,CAAC,SAAS;gBAC7CC,OAAO;gBACPC,MAAM;YACR;YACA,OAAO,IAAI,CAACX,MAAM,CAACC,KAAK,CACtB,CAAC,0BAA0B,EAAE3B,OAAO,yBAAyB,EAAEiC,UAAUjC,MAAM,CAC7EsC,OAAOC,IAAI,CAAClD,WAAWmD,GAAG,CAAC,CAACC,MAAQ,CAAC,CAAC,EAAEA,IAAI,CAAC,CAAC,IAC7C,EACH;gBAACb,MAAM;YAAC;QAEZ;QAEA,IAAIc;QACJ,IAAI5C,MAAM;YACR,MAAM6C,WAAW9D,KAAK+D,OAAO,CAACzB,SAASrB;YAEvC,MAAM+C,KAAK,MAAMjE,KAAK+D;YACtB,IAAI,CAACE,GAAGC,MAAM,IAAI;gBAChB,OAAO,IAAI,CAACpB,MAAM,CAACC,KAAK,CAAC,CAAC,qDAAqD,CAAC,EAAE;oBAACC,MAAM;gBAAC;YAC5F;YAEAc,iBAAiBC;QACnB;QAEA,IAAI;YACF,MAAMI,eAAe,MAAM3D,kBAAkB;gBAC3CyB;gBACAZ;gBACAa;gBACAC;gBACA2B;gBACA1B;gBACAgC,UAAU,CAACC;oBACT,MAAMD,WACJhD,UAAUA,UAAUX,YAChBA,SAAS,CAACW,OAAiC,GAC3CX,UAAU6D,MAAM;oBAEtB,OAAOF,SAAS;wBAACpD;wBAAO8B,QAAQ,IAAI,CAACA,MAAM;wBAAEuB;oBAAM;gBACrD;gBACAE,YAAY/B,UAAU+B,UAAU;gBAChChC;gBACAb;YACF;YAEA,IAAIyC,iBAAiB,SAAS;gBAC5B,OAAO,IAAI,CAACnB,IAAI,CAAC;YACnB;QACF,EAAE,OAAOH,KAAK;YACZ,OAAO,IAAI,CAACC,MAAM,CAACC,KAAK,CAACF,eAAe2B,QAAQ3B,IAAIO,OAAO,GAAGqB,OAAO5B,MAAM;gBAACG,MAAM;YAAC;QACrF;IACF;AACF"}
+{"version":3,"sources":["../../../src/commands/documents/validate.ts"],"sourcesContent":["import {stat} from 'node:fs/promises'\nimport path from 'node:path'\nimport {styleText} from 'node:util'\n\nimport {Flags} from '@oclif/core'\nimport {exitCodes} from '@sanity/cli-core'\nimport {ProjectRootNotFoundError} from '@sanity/cli-core/errors'\nimport {SanityCommand} from '@sanity/cli-core/SanityCommand'\nimport {type CliConfig} from '@sanity/cli-core/types'\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'\nimport {getDatasetFlag, getProjectIdFlag} from '../../util/sharedFlags.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      command: '<%= config.bin %> <%= command.id %> --project-id abc123 --dataset production',\n      description: 'Validate documents in a specific project and dataset',\n    },\n  ]\n\n  static flags = {\n    ...getProjectIdFlag({\n      description:\n        'Override the project ID used. By default, this is derived from the given workspace',\n      semantics: 'specify',\n    }),\n    ...getDatasetFlag({\n      description:\n        'Override the dataset used. By default, this is derived from the given workspace',\n      semantics: 'specify',\n    }),\n    file: Flags.string({\n      description:\n        'Path to an NDJSON file or tar archive containing an NDJSON file (optionally gzip-compressed)',\n    }),\n    format: Flags.string({\n      description:\n        'The output format used to print the found validation markers and report progress',\n      options: ['json', 'ndjson', 'pretty'],\n    }),\n    level: Flags.custom<Level>({\n      default: 'warning',\n      description: 'The minimum level reported. 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 allowed to run concurrently',\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  static override hiddenAliases: string[] = ['document:validate']\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      'project-id': projectId,\n      workspace,\n    } = flags\n    const unattendedMode = this.isUnattended()\n\n    let workDir: string\n    let cliConfig: CliConfig\n    try {\n      const root = await this.getProjectRoot()\n      workDir = root.directory\n      cliConfig = await this.getCliConfig()\n    } catch (err) {\n      if (err instanceof ProjectRootNotFoundError) {\n        return this.output.error(\n          'This command must be run from within a Sanity project directory (requires studio schema for validation)',\n          {exit: 1},\n        )\n      }\n      throw err\n    }\n\n    let ndjsonFilePath\n    if (file) {\n      const filePath = path.resolve(workDir, file)\n\n      let fileStat\n      try {\n        fileStat = await stat(filePath)\n      } catch {\n        return this.output.error(\n          `File not found: ${file}. Pass an existing NDJSON file or tar archive with \\`--file <path>\\`.`,\n          {exit: exitCodes.USAGE_ERROR},\n        )\n      }\n\n      if (!fileStat.isFile()) {\n        return this.output.error(\n          `Invalid file path: ${file} is not a file. Pass an NDJSON file or tar archive with \\`--file <path>\\`.`,\n          {exit: exitCodes.USAGE_ERROR},\n        )\n      }\n\n      ndjsonFilePath = filePath\n    }\n\n    if (!unattendedMode) {\n      this.output.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.output.log(`Potential pitfalls:\\n`)\n      this.output.log(\n        `- Processes all documents locally (excluding assets). Large datasets may require more resources.`,\n      )\n      this.output.log(\n        `- Executes all custom validation functions. Some functions may need to be refactored for compatibility.`,\n      )\n      this.output.log(\n        `- Not all standard browser features are available and may cause issues while loading your Studio.`,\n      )\n      this.output.log(\n        `- Adheres to document permissions. Ensure this account can see all desired documents.`,\n      )\n      if (file) {\n        this.output.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.output.log('Validation cancelled')\n        return this.exit(exitCodes.USER_ABORT)\n      }\n    }\n\n    try {\n      const overallLevel = await validateDocuments({\n        dataset,\n        level,\n        maxCustomValidationConcurrency,\n        maxFetchConcurrency,\n        ndjsonFilePath,\n        projectId,\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        return this.exit(1)\n      }\n    } catch (err) {\n      return this.output.error(err instanceof Error ? err.message : String(err), {exit: 1})\n    }\n  }\n}\n"],"names":["stat","path","styleText","Flags","exitCodes","ProjectRootNotFoundError","SanityCommand","confirm","logSymbols","validateDocuments","reporters","getDatasetFlag","getProjectIdFlag","ValidateDocumentsCommand","description","examples","command","flags","semantics","file","string","format","options","level","custom","default","integer","workspace","yes","boolean","char","hiddenAliases","run","parse","dataset","maxCustomValidationConcurrency","maxFetchConcurrency","projectId","unattendedMode","isUnattended","workDir","cliConfig","root","getProjectRoot","directory","getCliConfig","err","output","error","exit","ndjsonFilePath","filePath","resolve","fileStat","USAGE_ERROR","isFile","log","warning","confirmed","message","USER_ABORT","overallLevel","reporter","worker","pretty","studioHost","Error","String"],"mappings":"AAAA,SAAQA,IAAI,QAAO,mBAAkB;AACrC,OAAOC,UAAU,YAAW;AAC5B,SAAQC,SAAS,QAAO,YAAW;AAEnC,SAAQC,KAAK,QAAO,cAAa;AACjC,SAAQC,SAAS,QAAO,mBAAkB;AAC1C,SAAQC,wBAAwB,QAAO,0BAAyB;AAChE,SAAQC,aAAa,QAAO,iCAAgC;AAE5D,SAAQC,OAAO,EAAEC,UAAU,QAAO,sBAAqB;AAGvD,SAAQC,iBAAiB,QAAO,sCAAqC;AACrE,SAAQC,SAAS,QAAO,wDAAuD;AAC/E,SAAQC,cAAc,EAAEC,gBAAgB,QAAO,4BAA2B;AAE1E,OAAO,MAAMC,iCAAiCP;IAC5C,OAAOQ,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;QACA;YACEE,SAAS;YACTF,aAAa;QACf;KACD,CAAA;IAED,OAAOG,QAAQ;QACb,GAAGL,iBAAiB;YAClBE,aACE;YACFI,WAAW;QACb,EAAE;QACF,GAAGP,eAAe;YAChBG,aACE;YACFI,WAAW;QACb,EAAE;QACFC,MAAMhB,MAAMiB,MAAM,CAAC;YACjBN,aACE;QACJ;QACAO,QAAQlB,MAAMiB,MAAM,CAAC;YACnBN,aACE;YACFQ,SAAS;gBAAC;gBAAQ;gBAAU;aAAS;QACvC;QACAC,OAAOpB,MAAMqB,MAAM,CAAQ;YACzBC,SAAS;YACTX,aAAa;YACbQ,SAAS;gBAAC;gBAAS;gBAAW;aAAO;QACvC;QACA,qCAAqCnB,MAAMuB,OAAO,CAAC;YACjDD,SAAS;YACTX,aAAa;QACf;QACA,yBAAyBX,MAAMuB,OAAO,CAAC;YACrCD,SAAS;YACTX,aAAa;QACf;QACAa,WAAWxB,MAAMiB,MAAM,CAAC;YACtBN,aAAa;QACf;QACAc,KAAKzB,MAAM0B,OAAO,CAAC;YACjBC,MAAM;YACNL,SAAS;YACTX,aAAa;QACf;IACF,EAAC;IAED,OAAgBiB,gBAA0B;QAAC;KAAoB,CAAA;IAE/D,MAAaC,MAAqB;QAChC,MAAM,EAACf,KAAK,EAAC,GAAG,MAAM,IAAI,CAACgB,KAAK,CAACpB;QACjC,MAAM,EACJqB,OAAO,EACPf,IAAI,EACJE,MAAM,EACNE,KAAK,EACL,qCAAqCY,8BAA8B,EACnE,yBAAyBC,mBAAmB,EAC5C,cAAcC,SAAS,EACvBV,SAAS,EACV,GAAGV;QACJ,MAAMqB,iBAAiB,IAAI,CAACC,YAAY;QAExC,IAAIC;QACJ,IAAIC;QACJ,IAAI;YACF,MAAMC,OAAO,MAAM,IAAI,CAACC,cAAc;YACtCH,UAAUE,KAAKE,SAAS;YACxBH,YAAY,MAAM,IAAI,CAACI,YAAY;QACrC,EAAE,OAAOC,KAAK;YACZ,IAAIA,eAAezC,0BAA0B;gBAC3C,OAAO,IAAI,CAAC0C,MAAM,CAACC,KAAK,CACtB,2GACA;oBAACC,MAAM;gBAAC;YAEZ;YACA,MAAMH;QACR;QAEA,IAAII;QACJ,IAAI/B,MAAM;YACR,MAAMgC,WAAWlD,KAAKmD,OAAO,CAACZ,SAASrB;YAEvC,IAAIkC;YACJ,IAAI;gBACFA,WAAW,MAAMrD,KAAKmD;YACxB,EAAE,OAAM;gBACN,OAAO,IAAI,CAACJ,MAAM,CAACC,KAAK,CACtB,CAAC,gBAAgB,EAAE7B,KAAK,qEAAqE,CAAC,EAC9F;oBAAC8B,MAAM7C,UAAUkD,WAAW;gBAAA;YAEhC;YAEA,IAAI,CAACD,SAASE,MAAM,IAAI;gBACtB,OAAO,IAAI,CAACR,MAAM,CAACC,KAAK,CACtB,CAAC,mBAAmB,EAAE7B,KAAK,0EAA0E,CAAC,EACtG;oBAAC8B,MAAM7C,UAAUkD,WAAW;gBAAA;YAEhC;YAEAJ,iBAAiBC;QACnB;QAEA,IAAI,CAACb,gBAAgB;YACnB,IAAI,CAACS,MAAM,CAACS,GAAG,CACb,GAAGtD,UAAU,UAAU,GAAGM,WAAWiD,OAAO,CAAC,SAAS,CAAC,EAAE,cAAc,EACrEtC,OACI,6CACA,4CACL,uDAAuD,CAAC,GACvD,CAAC,gCAAgC,CAAC;YAEtC,IAAI,CAAC4B,MAAM,CAACS,GAAG,CAAC,CAAC,qBAAqB,CAAC;YACvC,IAAI,CAACT,MAAM,CAACS,GAAG,CACb,CAAC,gGAAgG,CAAC;YAEpG,IAAI,CAACT,MAAM,CAACS,GAAG,CACb,CAAC,uGAAuG,CAAC;YAE3G,IAAI,CAACT,MAAM,CAACS,GAAG,CACb,CAAC,iGAAiG,CAAC;YAErG,IAAI,CAACT,MAAM,CAACS,GAAG,CACb,CAAC,qFAAqF,CAAC;YAEzF,IAAIrC,MAAM;gBACR,IAAI,CAAC4B,MAAM,CAACS,GAAG,CACb,CAAC,4FAA4F,CAAC;YAElG;YAEA,MAAME,YAAY,MAAMnD,QAAQ;gBAC9BkB,SAAS;gBACTkC,SAAS,CAAC,kCAAkC,CAAC;YAC/C;YAEA,IAAI,CAACD,WAAW;gBACd,IAAI,CAACX,MAAM,CAACS,GAAG,CAAC;gBAChB,OAAO,IAAI,CAACP,IAAI,CAAC7C,UAAUwD,UAAU;YACvC;QACF;QAEA,IAAI;YACF,MAAMC,eAAe,MAAMpD,kBAAkB;gBAC3CyB;gBACAX;gBACAY;gBACAC;gBACAc;gBACAb;gBACAyB,UAAU,CAACC;oBACT,MAAMD,WACJzC,UAAUA,UAAUX,YAChBA,SAAS,CAACW,OAAiC,GAC3CX,UAAUsD,MAAM;oBAEtB,OAAOF,SAAS;wBAAC7C;wBAAO8B,QAAQ,IAAI,CAACA,MAAM;wBAAEgB;oBAAM;gBACrD;gBACAE,YAAYxB,UAAUwB,UAAU;gBAChCzB;gBACAb;YACF;YAEA,IAAIkC,iBAAiB,SAAS;gBAC5B,OAAO,IAAI,CAACZ,IAAI,CAAC;YACnB;QACF,EAAE,OAAOH,KAAK;YACZ,OAAO,IAAI,CAACC,MAAM,CAACC,KAAK,CAACF,eAAeoB,QAAQpB,IAAIa,OAAO,GAAGQ,OAAOrB,MAAM;gBAACG,MAAM;YAAC;QACrF;IACF;AACF"}

package/dist/commands/graphql/deploy.js

@@ -1,5 +1,5 @@
 import { Flags } from '@oclif/core';
-import { isInteractive, SanityCommand } from '@sanity/cli-core';
+import { exitCodes, SanityCommand } from '@sanity/cli-core';
 import { confirm, spinner } from '@sanity/cli-core/ux';
 import get from 'lodash-es/get.js';
 import { extractGraphQLAPIs } from '../../actions/graphql/extractGraphQLAPIs.js';
@@ -119,15 +119,18 @@ export class GraphQLDeployCommand extends SanityCommand {
             this.warn(`This will use the specified flag(s) for ALL APIs, overriding config!`);
             if (flags.force) {
                 this.warn(`--force specified, continuing...`);
+            } else if (this.isUnattended()) {
+                this.error('Flag overrides for multiple APIs require confirmation. Pass `--force` to continue.', {
+                    exit: exitCodes.USAGE_ERROR
+                });
             } else {
                 const confirmed = await confirm({
                     default: false,
                     message: 'Continue with flag overrides for all APIs?'
                 });
                 if (!confirmed) {
-                    this.error('Operation cancelled', {
-                        exit: 1
-                    });
+                    this.log('GraphQL deployment cancelled');
+                    this.exit(exitCodes.USER_ABORT);
                 }
             }
         }
@@ -181,8 +184,8 @@ export class GraphQLDeployCommand extends SanityCommand {
             spin = spinner(`Generating GraphQL API: ${apiName}`).start();
             if (!dataset) {
                 spin.fail();
-                this.error(`No dataset specified for API at index ${index}`, {
-                    exit: 1
+                this.error(`Dataset is required for API at index ${index}. Pass it with \`--dataset <name>\` or configure a dataset for the API.`, {
+                    exit: exitCodes.USAGE_ERROR
                 });
             }
             // Handle extraction errors early (computed in worker), before network calls and prompts.
@@ -226,12 +229,13 @@ export class GraphQLDeployCommand extends SanityCommand {
                 force: flags.force,
                 index,
                 output: this.output,
-                specifiedGeneration
+                specifiedGeneration,
+                unattended: this.isUnattended()
             });
             if (!generation) {
-                // User cancelled
-                spin.fail();
-                continue;
+                spin.stop();
+                this.log('GraphQL deployment cancelled');
+                this.exit(exitCodes.USER_ABORT);
             }
             if (!this.isRecognizedApiGeneration(generation)) {
                 spin.fail();
@@ -289,11 +293,11 @@ export class GraphQLDeployCommand extends SanityCommand {
                     hasErrors = true;
                     continue;
                 }
-                if (!isInteractive()) {
+                if (this.isUnattended()) {
                     spin.fail();
                     this.renderBreakingChanges(valid);
-                    this.error('Dangerous changes found - falling back. Re-run the command with the `--force` flag to force deployment.', {
-                        exit: 1
+                    this.error('GraphQL deployment requires confirmation because the schema contains dangerous changes. Pass `--force` to continue.', {
+                        exit: exitCodes.USAGE_ERROR
                     });
                 }
                 spin.stop();
@@ -303,8 +307,8 @@ export class GraphQLDeployCommand extends SanityCommand {
                     message: 'Do you want to deploy a new API despite the dangerous changes?'
                 });
                 if (!shouldDeploy) {
-                    spin.fail();
-                    continue;
+                    this.log('GraphQL deployment cancelled');
+                    this.exit(exitCodes.USER_ABORT);
                 }
                 spin.succeed();
             } else if (dryRun) {
@@ -439,7 +443,7 @@ export class GraphQLDeployCommand extends SanityCommand {
             return playgroundCurrentlyEnabled;
         }
         // If no API is deployed, default to true if non-interactive
-        if (!isInteractive()) {
+        if (this.isUnattended()) {
             return true;
         }
         // Interactive environment, so prompt the user