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

package/dist/actions/documents/validate.js

@@ -0,0 +1,60 @@
+import { createStudioWorker, getGlobalCliClient } from '@sanity/cli-core';
+import { createReceiver } from '../../util/workerChannels.js';
+import { DOCUMENTS_API_VERSION } from './constants.js';
+const defaultReporter = ({ dispose, stream })=>{
+    async function* createValidationGenerator() {
+        for await (const { documentId, documentType, level, markers, revision } of stream.validation()){
+            const result = {
+                documentId,
+                documentType,
+                level,
+                markers,
+                revision
+            };
+            yield result;
+        }
+        await dispose();
+    }
+    return createValidationGenerator();
+};
+export async function validateDocuments(options) {
+    const { dataset, level, maxCustomValidationConcurrency, maxFetchConcurrency, ndjsonFilePath, projectId, reporter = defaultReporter, workDir = process.cwd(), workspace } = options;
+    const apiClient = await getGlobalCliClient({
+        apiVersion: DOCUMENTS_API_VERSION,
+        requireUser: true
+    });
+    const clientConfig = {
+        ...apiClient.config(),
+        // we set this explictly to true because we pass in a token via the
+        // `clientConfiguration` object and also mock a browser environment in
+        // this worker which triggers the browser warning
+        ignoreBrowserTokenWarning: true,
+        // Removing from object so config can be serialized
+        // before sent to validation worker
+        requester: undefined,
+        // we set this explictly to true because the default client configuration
+        // from the CLI comes configured with `useProjectHostname: false` when
+        // `requireProject` is set to false
+        useProjectHostname: true
+    };
+    const worker = createStudioWorker(new URL('validateDocuments.worker.js', import.meta.url), {
+        name: 'validateDocuments',
+        studioRootPath: workDir,
+        workerData: {
+            // removes props in the config that make this object fail to serialize
+            clientConfig: structuredClone(clientConfig),
+            dataset,
+            level,
+            maxCustomValidationConcurrency,
+            maxFetchConcurrency,
+            ndjsonFilePath,
+            projectId,
+            studioHost: options.studioHost,
+            workDir,
+            workspace
+        }
+    });
+    return reporter(createReceiver(worker));
+}
+
+//# sourceMappingURL=validate.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/actions/documents/validate.ts"],"sourcesContent":["import {createStudioWorker, getGlobalCliClient} from '@sanity/cli-core'\nimport {type ClientConfig} from '@sanity/client'\nimport {type ValidationMarker} from '@sanity/types'\n\nimport {createReceiver, type WorkerChannelReceiver} from '../../util/workerChannels.js'\nimport {DOCUMENTS_API_VERSION} from './constants.js'\nimport {Level, type ValidateDocumentsWorkerData, type ValidationWorkerChannel} from './types.js'\n\ninterface ValidateDocumentsOptions<TReturn = unknown> {\n  dataset?: string // override\n  level?: Level\n  maxCustomValidationConcurrency?: number\n  maxFetchConcurrency?: number\n  ndjsonFilePath?: string\n  projectId?: string // override\n  reporter?: (worker: WorkerChannelReceiver<ValidationWorkerChannel>) => TReturn\n  studioHost?: string\n  workDir?: string\n  workspace?: string\n}\n\ninterface DocumentValidationResult {\n  documentId: string\n  documentType: string\n  level: ValidationMarker['level']\n  markers: ValidationMarker[]\n  revision: string\n}\n\nconst defaultReporter = ({dispose, stream}: WorkerChannelReceiver<ValidationWorkerChannel>) => {\n  async function* createValidationGenerator() {\n    for await (const {documentId, documentType, level, markers, revision} of stream.validation()) {\n      const result: DocumentValidationResult = {\n        documentId,\n        documentType,\n        level,\n        markers,\n        revision,\n      }\n\n      yield result\n    }\n\n    await dispose()\n  }\n\n  return createValidationGenerator()\n}\n\nexport function validateDocuments<TReturn>(\n  options: Required<Pick<ValidateDocumentsOptions<TReturn>, 'reporter'>> &\n    ValidateDocumentsOptions<TReturn>,\n): Promise<TReturn>\nexport function validateDocuments(\n  options: ValidateDocumentsOptions,\n): Promise<AsyncIterable<DocumentValidationResult>>\nexport async function validateDocuments(options: ValidateDocumentsOptions): Promise<unknown> {\n  const {\n    dataset,\n    level,\n    maxCustomValidationConcurrency,\n    maxFetchConcurrency,\n    ndjsonFilePath,\n    projectId,\n    reporter = defaultReporter,\n    workDir = process.cwd(),\n    workspace,\n  } = options\n\n  const apiClient = await getGlobalCliClient({\n    apiVersion: DOCUMENTS_API_VERSION,\n    requireUser: true,\n  })\n\n  const clientConfig: ClientConfig = {\n    ...apiClient.config(),\n    // we set this explictly to true because we pass in a token via the\n    // `clientConfiguration` object and also mock a browser environment in\n    // this worker which triggers the browser warning\n    ignoreBrowserTokenWarning: true,\n    // Removing from object so config can be serialized\n    // before sent to validation worker\n    requester: undefined,\n    // we set this explictly to true because the default client configuration\n    // from the CLI comes configured with `useProjectHostname: false` when\n    // `requireProject` is set to false\n    useProjectHostname: true,\n  }\n\n  const worker = createStudioWorker(new URL('validateDocuments.worker.js', import.meta.url), {\n    name: 'validateDocuments',\n    studioRootPath: workDir,\n    workerData: {\n      // removes props in the config that make this object fail to serialize\n      clientConfig: structuredClone(clientConfig),\n      dataset,\n      level,\n      maxCustomValidationConcurrency,\n      maxFetchConcurrency,\n      ndjsonFilePath,\n      projectId,\n      studioHost: options.studioHost,\n      workDir,\n      workspace,\n    } satisfies ValidateDocumentsWorkerData,\n  })\n\n  return reporter(createReceiver<ValidationWorkerChannel>(worker))\n}\n"],"names":["createStudioWorker","getGlobalCliClient","createReceiver","DOCUMENTS_API_VERSION","defaultReporter","dispose","stream","createValidationGenerator","documentId","documentType","level","markers","revision","validation","result","validateDocuments","options","dataset","maxCustomValidationConcurrency","maxFetchConcurrency","ndjsonFilePath","projectId","reporter","workDir","process","cwd","workspace","apiClient","apiVersion","requireUser","clientConfig","config","ignoreBrowserTokenWarning","requester","undefined","useProjectHostname","worker","URL","url","name","studioRootPath","workerData","structuredClone","studioHost"],"mappings":"AAAA,SAAQA,kBAAkB,EAAEC,kBAAkB,QAAO,mBAAkB;AAIvE,SAAQC,cAAc,QAAmC,+BAA8B;AACvF,SAAQC,qBAAqB,QAAO,iBAAgB;AAwBpD,MAAMC,kBAAkB,CAAC,EAACC,OAAO,EAAEC,MAAM,EAAiD;IACxF,gBAAgBC;QACd,WAAW,MAAM,EAACC,UAAU,EAAEC,YAAY,EAAEC,KAAK,EAAEC,OAAO,EAAEC,QAAQ,EAAC,IAAIN,OAAOO,UAAU,GAAI;YAC5F,MAAMC,SAAmC;gBACvCN;gBACAC;gBACAC;gBACAC;gBACAC;YACF;YAEA,MAAME;QACR;QAEA,MAAMT;IACR;IAEA,OAAOE;AACT;AASA,OAAO,eAAeQ,kBAAkBC,OAAiC;IACvE,MAAM,EACJC,OAAO,EACPP,KAAK,EACLQ,8BAA8B,EAC9BC,mBAAmB,EACnBC,cAAc,EACdC,SAAS,EACTC,WAAWlB,eAAe,EAC1BmB,UAAUC,QAAQC,GAAG,EAAE,EACvBC,SAAS,EACV,GAAGV;IAEJ,MAAMW,YAAY,MAAM1B,mBAAmB;QACzC2B,YAAYzB;QACZ0B,aAAa;IACf;IAEA,MAAMC,eAA6B;QACjC,GAAGH,UAAUI,MAAM,EAAE;QACrB,mEAAmE;QACnE,sEAAsE;QACtE,iDAAiD;QACjDC,2BAA2B;QAC3B,mDAAmD;QACnD,mCAAmC;QACnCC,WAAWC;QACX,yEAAyE;QACzE,sEAAsE;QACtE,mCAAmC;QACnCC,oBAAoB;IACtB;IAEA,MAAMC,SAASpC,mBAAmB,IAAIqC,IAAI,+BAA+B,YAAYC,GAAG,GAAG;QACzFC,MAAM;QACNC,gBAAgBjB;QAChBkB,YAAY;YACV,sEAAsE;YACtEX,cAAcY,gBAAgBZ;YAC9Bb;YACAP;YACAQ;YACAC;YACAC;YACAC;YACAsB,YAAY3B,QAAQ2B,UAAU;YAC9BpB;YACAG;QACF;IACF;IAEA,OAAOJ,SAASpB,eAAwCkC;AAC1D"}

package/dist/actions/documents/validateDocuments.worker.js

@@ -0,0 +1,251 @@
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import readline from 'node:readline';
+import { Readable } from 'node:stream';
+import { workerData as _workerData, isMainThread, parentPort } from 'node:worker_threads';
+import { getStudioWorkspaces, isRecord, resolveLocalPackage } from '@sanity/cli-core';
+import { createClient } from '@sanity/client';
+import pMap from 'p-map';
+import { checkDocumentAvailability, exportDocuments, getDocumentCount } from '../../services/documents.js';
+import { extractDocumentsFromNdjsonOrTarball } from '../../util/extractDocumentsFromNdjsonOrTarball.js';
+import { getWorkspace } from '../../util/getWorkspace.js';
+import { DOCUMENT_VALIDATION_TIMEOUT, getReferenceIds, isValidId, levelValues, MAX_VALIDATION_CONCURRENCY, REFERENCE_INTEGRITY_BATCH_SIZE, shouldIncludeDocument } from '../../util/validation/validateDocumentsUtils.js';
+import { createReporter } from '../../util/workerChannels.js';
+const { clientConfig, dataset, level, maxCustomValidationConcurrency, maxFetchConcurrency, ndjsonFilePath, projectId, studioHost, workDir, workspace: workspaceName } = _workerData;
+if (isMainThread || !parentPort) {
+    throw new Error('This module must be run as a worker thread');
+}
+const report = createReporter(parentPort);
+// eslint-disable-next-line n/no-unsupported-features/node-builtins
+async function* readerToGenerator(reader) {
+    while(true){
+        const { done, value } = await reader.read();
+        if (value) yield value;
+        if (done) return;
+    }
+}
+await main();
+process.exit();
+async function loadWorkspace() {
+    const workspaces = await getStudioWorkspaces(workDir);
+    const workspace = getWorkspace(workspaces, workspaceName);
+    const resolvedDataset = dataset || workspace.dataset;
+    const resolvedProjectId = projectId || workspace.projectId;
+    const client = createClient({
+        ...clientConfig,
+        dataset: resolvedDataset,
+        projectId: resolvedProjectId,
+        requestTagPrefix: 'sanity.cli.validate'
+    }).config({
+        apiVersion: 'v2021-03-25'
+    });
+    report.event.loadedWorkspace({
+        basePath: workspace.basePath,
+        dataset: workspace.dataset,
+        name: workspace.name,
+        projectId: workspace.projectId
+    });
+    return {
+        client,
+        dataset: resolvedDataset,
+        projectId: resolvedProjectId,
+        workspace
+    };
+}
+async function downloadFromExport({ dataset: datasetName, projectId: projId }) {
+    const documentCount = await getDocumentCount({
+        dataset: datasetName,
+        projectId: projId
+    });
+    report.event.loadedDocumentCount({
+        documentCount
+    });
+    const response = await exportDocuments({
+        dataset: datasetName,
+        projectId: projId
+    });
+    const reader = response.body?.getReader();
+    if (!reader) throw new Error('Could not get reader from response body.');
+    let downloadedCount = 0;
+    const referencedIds = new Set();
+    const documentIds = new Set();
+    const lines = readline.createInterface({
+        input: Readable.from(readerToGenerator(reader))
+    });
+    // Note: we stream the export to a file and then re-read from that file to
+    // make this less memory intensive.
+    // this is a similar pattern to the import/export CLI commands
+    const slugDate = new Date().toISOString().replaceAll(/[^a-z0-9]/gi, '-').toLowerCase();
+    const tempOutputFile = path.join(os.tmpdir(), `sanity-validate-${slugDate}.ndjson`);
+    const outputStream = fs.createWriteStream(tempOutputFile);
+    for await (const line of lines){
+        const document = JSON.parse(line);
+        if (shouldIncludeDocument(document)) {
+            documentIds.add(document._id);
+            for (const referenceId of getReferenceIds(document)){
+                referencedIds.add(referenceId);
+            }
+            outputStream.write(`${line}\n`);
+        }
+        downloadedCount++;
+        report.stream.exportProgress.emit({
+            documentCount,
+            downloadedCount
+        });
+    }
+    await new Promise((resolve, reject)=>outputStream.close((err)=>err ? reject(err) : resolve()));
+    report.stream.exportProgress.end();
+    report.event.exportFinished({
+        totalDocumentsToValidate: documentIds.size
+    });
+    const getDocuments = ()=>extractDocumentsFromNdjsonOrTarball(fs.createReadStream(tempOutputFile));
+    return {
+        cleanup: ()=>fs.promises.rm(tempOutputFile),
+        documentIds,
+        getDocuments,
+        referencedIds
+    };
+}
+async function downloadFromFile(filePath) {
+    const referencedIds = new Set();
+    const documentIds = new Set();
+    const getDocuments = ()=>extractDocumentsFromNdjsonOrTarball(fs.createReadStream(filePath));
+    for await (const document of getDocuments()){
+        if (shouldIncludeDocument(document)) {
+            documentIds.add(document._id);
+            for (const referenceId of getReferenceIds(document)){
+                referencedIds.add(referenceId);
+            }
+        }
+    }
+    report.event.exportFinished({
+        totalDocumentsToValidate: documentIds.size
+    });
+    return {
+        cleanup: undefined,
+        documentIds,
+        getDocuments,
+        referencedIds
+    };
+}
+async function checkReferenceExistence({ dataset: datasetName, documentIds, projectId: projId, referencedIds: _referencedIds }) {
+    const existingIds = new Set(documentIds);
+    const idsToCheck = [
+        ..._referencedIds
+    ].filter((id)=>!existingIds.has(id) && isValidId(id)).toSorted();
+    const batches = [];
+    for(let i = 0; i < idsToCheck.length; i += REFERENCE_INTEGRITY_BATCH_SIZE){
+        batches.push(idsToCheck.slice(i, i + REFERENCE_INTEGRITY_BATCH_SIZE));
+    }
+    for (const batch of batches){
+        const { omitted } = await checkDocumentAvailability({
+            dataset: datasetName,
+            documentIds: batch,
+            projectId: projId
+        });
+        const omittedIds = {};
+        for (const item of omitted){
+            omittedIds[item.id] = item.reason;
+        }
+        for (const id of batch){
+            // unless the document ID is in the `omitted` object explictly due to
+            // the reason `'existence'`, then it should exist
+            if (omittedIds[id] !== 'existence') {
+                existingIds.add(id);
+            }
+        }
+    }
+    report.event.loadedReferenceIntegrity();
+    return {
+        existingIds
+    };
+}
+async function main() {
+    let cleanupDownloadedDocuments;
+    try {
+        const { client, dataset: datasetName, projectId: projId, workspace } = await loadWorkspace();
+        const { cleanup, documentIds, getDocuments, referencedIds } = ndjsonFilePath ? await downloadFromFile(ndjsonFilePath) : await downloadFromExport({
+            dataset: datasetName,
+            projectId: projId
+        });
+        cleanupDownloadedDocuments = cleanup;
+        const { existingIds } = await checkReferenceExistence({
+            dataset: datasetName,
+            documentIds,
+            projectId: projId,
+            referencedIds
+        });
+        const getClient = (options)=>client.withConfig(options);
+        const getDocumentExists = ({ id })=>Promise.resolve(existingIds.has(id));
+        const getLevel = (markers)=>{
+            let foundWarning = false;
+            for (const marker of markers){
+                if (marker.level === 'error') return 'error';
+                if (marker.level === 'warning') foundWarning = true;
+            }
+            if (foundWarning) return 'warning';
+            return 'info';
+        };
+        let validatedCount = 0;
+        const validate = async (document)=>{
+            let markers;
+            try {
+                const timeout = Symbol('timeout');
+                const { validateDocument } = await resolveLocalPackage('sanity', workDir);
+                const result = await Promise.race([
+                    validateDocument({
+                        document,
+                        environment: 'cli',
+                        getClient,
+                        getDocumentExists,
+                        maxCustomValidationConcurrency,
+                        maxFetchConcurrency,
+                        workspace
+                    }),
+                    new Promise((resolve)=>setTimeout(()=>resolve(timeout), DOCUMENT_VALIDATION_TIMEOUT))
+                ]);
+                if (result === timeout) {
+                    throw new Error(`Document '${document._id}' failed to validate within ${DOCUMENT_VALIDATION_TIMEOUT}ms.`);
+                }
+                markers = result// filter out unwanted levels
+                .filter((marker)=>{
+                    const markerValue = levelValues[marker.level];
+                    const flagLevelValue = levelValues[level] ?? levelValues.info;
+                    return markerValue <= flagLevelValue;
+                });
+            } catch (err) {
+                const errorMessage = isRecord(err) && typeof err.message === 'string' ? err.message : 'Unknown error';
+                const message = `Exception occurred while validating value: ${errorMessage}`;
+                markers = [
+                    {
+                        level: 'error',
+                        message,
+                        path: []
+                    }
+                ];
+            }
+            validatedCount++;
+            const intentUrl = studioHost && `${studioHost}${path.resolve(workspace.basePath, `/intent/edit/id=${encodeURIComponent(document._id)};type=${encodeURIComponent(document._type)}`)}`;
+            report.stream.validation.emit({
+                documentId: document._id,
+                documentType: document._type,
+                ...intentUrl && {
+                    intentUrl
+                },
+                level: getLevel(markers),
+                markers,
+                revision: document._rev,
+                validatedCount
+            });
+        };
+        await pMap(getDocuments(), validate, {
+            concurrency: MAX_VALIDATION_CONCURRENCY
+        });
+        report.stream.validation.end();
+    } finally{
+        await cleanupDownloadedDocuments?.();
+    }
+}
+
+//# sourceMappingURL=validateDocuments.worker.js.map

package/dist/actions/documents/validateDocuments.worker.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/actions/documents/validateDocuments.worker.ts"],"sourcesContent":["import fs from 'node:fs'\nimport os from 'node:os'\nimport path from 'node:path'\nimport readline from 'node:readline'\nimport {Readable} from 'node:stream'\nimport {workerData as _workerData, isMainThread, parentPort} from 'node:worker_threads'\n\nimport {getStudioWorkspaces, isRecord, resolveLocalPackage} from '@sanity/cli-core'\nimport {type ClientConfig, createClient, type SanityDocument} from '@sanity/client'\nimport {type ValidationContext, type ValidationMarker} from '@sanity/types'\nimport pMap from 'p-map'\n\nimport {\n  type AvailabilityResponse,\n  checkDocumentAvailability,\n  exportDocuments,\n  getDocumentCount,\n} from '../../services/documents.js'\nimport {extractDocumentsFromNdjsonOrTarball} from '../../util/extractDocumentsFromNdjsonOrTarball.js'\nimport {getWorkspace} from '../../util/getWorkspace.js'\nimport {\n  DOCUMENT_VALIDATION_TIMEOUT,\n  getReferenceIds,\n  isValidId,\n  levelValues,\n  MAX_VALIDATION_CONCURRENCY,\n  REFERENCE_INTEGRITY_BATCH_SIZE,\n  shouldIncludeDocument,\n} from '../../util/validation/validateDocumentsUtils.js'\nimport {createReporter} from '../../util/workerChannels.js'\nimport {type ValidateDocumentsWorkerData, type ValidationWorkerChannel} from './types.js'\n\nconst {\n  clientConfig,\n  dataset,\n  level,\n  maxCustomValidationConcurrency,\n  maxFetchConcurrency,\n  ndjsonFilePath,\n  projectId,\n  studioHost,\n  workDir,\n  workspace: workspaceName,\n} = _workerData as ValidateDocumentsWorkerData\n\nif (isMainThread || !parentPort) {\n  throw new Error('This module must be run as a worker thread')\n}\n\nconst report = createReporter<ValidationWorkerChannel>(parentPort)\n\n// eslint-disable-next-line n/no-unsupported-features/node-builtins\nasync function* readerToGenerator(reader: ReadableStreamDefaultReader<Uint8Array>) {\n  while (true) {\n    const {done, value} = await reader.read()\n    if (value) yield value\n    if (done) return\n  }\n}\n\nawait main()\nprocess.exit()\n\nasync function loadWorkspace() {\n  const workspaces = await getStudioWorkspaces(workDir)\n  const workspace = getWorkspace(workspaces, workspaceName)\n\n  const resolvedDataset = dataset || workspace.dataset\n  const resolvedProjectId = projectId || workspace.projectId\n\n  const client = createClient({\n    ...clientConfig,\n    dataset: resolvedDataset,\n    projectId: resolvedProjectId,\n    requestTagPrefix: 'sanity.cli.validate',\n  }).config({apiVersion: 'v2021-03-25'})\n\n  report.event.loadedWorkspace({\n    basePath: workspace.basePath,\n    dataset: workspace.dataset,\n    name: workspace.name,\n    projectId: workspace.projectId,\n  })\n\n  return {client, dataset: resolvedDataset, projectId: resolvedProjectId, workspace}\n}\n\ninterface DownloadFromExportOptions {\n  dataset: string\n  projectId: string\n}\n\nasync function downloadFromExport({\n  dataset: datasetName,\n  projectId: projId,\n}: DownloadFromExportOptions) {\n  const documentCount = await getDocumentCount({dataset: datasetName, projectId: projId})\n  report.event.loadedDocumentCount({documentCount})\n\n  const response = await exportDocuments({dataset: datasetName, projectId: projId})\n\n  const reader = response.body?.getReader()\n  if (!reader) throw new Error('Could not get reader from response body.')\n\n  let downloadedCount = 0\n  const referencedIds = new Set<string>()\n  const documentIds = new Set<string>()\n  const lines = readline.createInterface({input: Readable.from(readerToGenerator(reader))})\n\n  // Note: we stream the export to a file and then re-read from that file to\n  // make this less memory intensive.\n  // this is a similar pattern to the import/export CLI commands\n  const slugDate = new Date()\n    .toISOString()\n    .replaceAll(/[^a-z0-9]/gi, '-')\n    .toLowerCase()\n  const tempOutputFile = path.join(os.tmpdir(), `sanity-validate-${slugDate}.ndjson`)\n  const outputStream = fs.createWriteStream(tempOutputFile)\n\n  for await (const line of lines) {\n    const document = JSON.parse(line) as SanityDocument\n\n    if (shouldIncludeDocument(document)) {\n      documentIds.add(document._id)\n      for (const referenceId of getReferenceIds(document)) {\n        referencedIds.add(referenceId)\n      }\n\n      outputStream.write(`${line}\\n`)\n    }\n\n    downloadedCount++\n    report.stream.exportProgress.emit({documentCount, downloadedCount})\n  }\n\n  await new Promise<void>((resolve, reject) =>\n    outputStream.close((err) => (err ? reject(err) : resolve())),\n  )\n\n  report.stream.exportProgress.end()\n  report.event.exportFinished({totalDocumentsToValidate: documentIds.size})\n\n  const getDocuments = () =>\n    extractDocumentsFromNdjsonOrTarball(fs.createReadStream(tempOutputFile))\n\n  return {cleanup: () => fs.promises.rm(tempOutputFile), documentIds, getDocuments, referencedIds}\n}\n\nasync function downloadFromFile(filePath: string) {\n  const referencedIds = new Set<string>()\n  const documentIds = new Set<string>()\n  const getDocuments = () => extractDocumentsFromNdjsonOrTarball(fs.createReadStream(filePath))\n\n  for await (const document of getDocuments()) {\n    if (shouldIncludeDocument(document)) {\n      documentIds.add(document._id)\n      for (const referenceId of getReferenceIds(document)) {\n        referencedIds.add(referenceId)\n      }\n    }\n  }\n\n  report.event.exportFinished({totalDocumentsToValidate: documentIds.size})\n\n  return {cleanup: undefined, documentIds, getDocuments, referencedIds}\n}\n\ninterface CheckReferenceExistenceOptions {\n  dataset: string\n  documentIds: Set<string>\n  projectId: string\n  referencedIds: Set<string>\n}\n\nasync function checkReferenceExistence({\n  dataset: datasetName,\n  documentIds,\n  projectId: projId,\n  referencedIds: _referencedIds,\n}: CheckReferenceExistenceOptions) {\n  const existingIds = new Set(documentIds)\n  const idsToCheck = [..._referencedIds]\n    .filter((id) => !existingIds.has(id) && isValidId(id))\n    .toSorted()\n\n  const batches: string[][] = []\n  for (let i = 0; i < idsToCheck.length; i += REFERENCE_INTEGRITY_BATCH_SIZE) {\n    batches.push(idsToCheck.slice(i, i + REFERENCE_INTEGRITY_BATCH_SIZE))\n  }\n\n  for (const batch of batches) {\n    const {omitted} = await checkDocumentAvailability({\n      dataset: datasetName,\n      documentIds: batch,\n      projectId: projId,\n    })\n\n    const omittedIds: Record<string, AvailabilityResponse['omitted'][number]['reason']> = {}\n    for (const item of omitted) {\n      omittedIds[item.id] = item.reason\n    }\n\n    for (const id of batch) {\n      // unless the document ID is in the `omitted` object explictly due to\n      // the reason `'existence'`, then it should exist\n      if (omittedIds[id] !== 'existence') {\n        existingIds.add(id)\n      }\n    }\n  }\n  report.event.loadedReferenceIntegrity()\n\n  return {existingIds}\n}\n\nasync function main() {\n  let cleanupDownloadedDocuments: (() => Promise<void>) | undefined\n\n  try {\n    const {client, dataset: datasetName, projectId: projId, workspace} = await loadWorkspace()\n    const {cleanup, documentIds, getDocuments, referencedIds} = ndjsonFilePath\n      ? await downloadFromFile(ndjsonFilePath)\n      : await downloadFromExport({dataset: datasetName, projectId: projId})\n    cleanupDownloadedDocuments = cleanup\n    const {existingIds} = await checkReferenceExistence({\n      dataset: datasetName,\n      documentIds,\n      projectId: projId,\n      referencedIds,\n    })\n\n    const getClient = <TOptions extends Partial<ClientConfig>>(options: TOptions) =>\n      client.withConfig(options)\n\n    const getDocumentExists: ValidationContext['getDocumentExists'] = ({id}) =>\n      Promise.resolve(existingIds.has(id))\n\n    const getLevel = (markers: ValidationMarker[]) => {\n      let foundWarning = false\n      for (const marker of markers) {\n        if (marker.level === 'error') return 'error'\n        if (marker.level === 'warning') foundWarning = true\n      }\n\n      if (foundWarning) return 'warning'\n      return 'info'\n    }\n\n    let validatedCount = 0\n\n    const validate = async (document: SanityDocument) => {\n      let markers: ValidationMarker[]\n\n      try {\n        const timeout = Symbol('timeout')\n\n        const {validateDocument} = await resolveLocalPackage<typeof import('sanity')>(\n          'sanity',\n          workDir,\n        )\n\n        const result = await Promise.race([\n          validateDocument({\n            document,\n            environment: 'cli',\n            getClient,\n            getDocumentExists,\n            maxCustomValidationConcurrency,\n            maxFetchConcurrency,\n            workspace,\n          }),\n          new Promise<typeof timeout>((resolve) =>\n            setTimeout(() => resolve(timeout), DOCUMENT_VALIDATION_TIMEOUT),\n          ),\n        ])\n\n        if (result === timeout) {\n          throw new Error(\n            `Document '${document._id}' failed to validate within ${DOCUMENT_VALIDATION_TIMEOUT}ms.`,\n          )\n        }\n\n        markers = result\n          // filter out unwanted levels\n          .filter((marker) => {\n            const markerValue = levelValues[marker.level]\n            const flagLevelValue =\n              levelValues[level as keyof typeof levelValues] ?? levelValues.info\n            return markerValue <= flagLevelValue\n          })\n      } catch (err) {\n        const errorMessage =\n          isRecord(err) && typeof err.message === 'string' ? err.message : 'Unknown error'\n\n        const message = `Exception occurred while validating value: ${errorMessage}`\n\n        markers = [\n          {\n            level: 'error',\n            message,\n            path: [],\n          },\n        ]\n      }\n\n      validatedCount++\n\n      const intentUrl =\n        studioHost &&\n        `${studioHost}${path.resolve(\n          workspace.basePath,\n          `/intent/edit/id=${encodeURIComponent(document._id)};type=${encodeURIComponent(\n            document._type,\n          )}`,\n        )}`\n\n      report.stream.validation.emit({\n        documentId: document._id,\n        documentType: document._type,\n        ...(intentUrl && {intentUrl}),\n        level: getLevel(markers),\n        markers,\n        revision: document._rev,\n        validatedCount,\n      })\n    }\n\n    await pMap(getDocuments(), validate, {concurrency: MAX_VALIDATION_CONCURRENCY})\n\n    report.stream.validation.end()\n  } finally {\n    await cleanupDownloadedDocuments?.()\n  }\n}\n"],"names":["fs","os","path","readline","Readable","workerData","_workerData","isMainThread","parentPort","getStudioWorkspaces","isRecord","resolveLocalPackage","createClient","pMap","checkDocumentAvailability","exportDocuments","getDocumentCount","extractDocumentsFromNdjsonOrTarball","getWorkspace","DOCUMENT_VALIDATION_TIMEOUT","getReferenceIds","isValidId","levelValues","MAX_VALIDATION_CONCURRENCY","REFERENCE_INTEGRITY_BATCH_SIZE","shouldIncludeDocument","createReporter","clientConfig","dataset","level","maxCustomValidationConcurrency","maxFetchConcurrency","ndjsonFilePath","projectId","studioHost","workDir","workspace","workspaceName","Error","report","readerToGenerator","reader","done","value","read","main","process","exit","loadWorkspace","workspaces","resolvedDataset","resolvedProjectId","client","requestTagPrefix","config","apiVersion","event","loadedWorkspace","basePath","name","downloadFromExport","datasetName","projId","documentCount","loadedDocumentCount","response","body","getReader","downloadedCount","referencedIds","Set","documentIds","lines","createInterface","input","from","slugDate","Date","toISOString","replaceAll","toLowerCase","tempOutputFile","join","tmpdir","outputStream","createWriteStream","line","document","JSON","parse","add","_id","referenceId","write","stream","exportProgress","emit","Promise","resolve","reject","close","err","end","exportFinished","totalDocumentsToValidate","size","getDocuments","createReadStream","cleanup","promises","rm","downloadFromFile","filePath","undefined","checkReferenceExistence","_referencedIds","existingIds","idsToCheck","filter","id","has","toSorted","batches","i","length","push","slice","batch","omitted","omittedIds","item","reason","loadedReferenceIntegrity","cleanupDownloadedDocuments","getClient","options","withConfig","getDocumentExists","getLevel","markers","foundWarning","marker","validatedCount","validate","timeout","Symbol","validateDocument","result","race","environment","setTimeout","markerValue","flagLevelValue","info","errorMessage","message","intentUrl","encodeURIComponent","_type","validation","documentId","documentType","revision","_rev","concurrency"],"mappings":"AAAA,OAAOA,QAAQ,UAAS;AACxB,OAAOC,QAAQ,UAAS;AACxB,OAAOC,UAAU,YAAW;AAC5B,OAAOC,cAAc,gBAAe;AACpC,SAAQC,QAAQ,QAAO,cAAa;AACpC,SAAQC,cAAcC,WAAW,EAAEC,YAAY,EAAEC,UAAU,QAAO,sBAAqB;AAEvF,SAAQC,mBAAmB,EAAEC,QAAQ,EAAEC,mBAAmB,QAAO,mBAAkB;AACnF,SAA2BC,YAAY,QAA4B,iBAAgB;AAEnF,OAAOC,UAAU,QAAO;AAExB,SAEEC,yBAAyB,EACzBC,eAAe,EACfC,gBAAgB,QACX,8BAA6B;AACpC,SAAQC,mCAAmC,QAAO,oDAAmD;AACrG,SAAQC,YAAY,QAAO,6BAA4B;AACvD,SACEC,2BAA2B,EAC3BC,eAAe,EACfC,SAAS,EACTC,WAAW,EACXC,0BAA0B,EAC1BC,8BAA8B,EAC9BC,qBAAqB,QAChB,kDAAiD;AACxD,SAAQC,cAAc,QAAO,+BAA8B;AAG3D,MAAM,EACJC,YAAY,EACZC,OAAO,EACPC,KAAK,EACLC,8BAA8B,EAC9BC,mBAAmB,EACnBC,cAAc,EACdC,SAAS,EACTC,UAAU,EACVC,OAAO,EACPC,WAAWC,aAAa,EACzB,GAAG/B;AAEJ,IAAIC,gBAAgB,CAACC,YAAY;IAC/B,MAAM,IAAI8B,MAAM;AAClB;AAEA,MAAMC,SAASb,eAAwClB;AAEvD,mEAAmE;AACnE,gBAAgBgC,kBAAkBC,MAA+C;IAC/E,MAAO,KAAM;QACX,MAAM,EAACC,IAAI,EAAEC,KAAK,EAAC,GAAG,MAAMF,OAAOG,IAAI;QACvC,IAAID,OAAO,MAAMA;QACjB,IAAID,MAAM;IACZ;AACF;AAEA,MAAMG;AACNC,QAAQC,IAAI;AAEZ,eAAeC;IACb,MAAMC,aAAa,MAAMxC,oBAAoB0B;IAC7C,MAAMC,YAAYlB,aAAa+B,YAAYZ;IAE3C,MAAMa,kBAAkBtB,WAAWQ,UAAUR,OAAO;IACpD,MAAMuB,oBAAoBlB,aAAaG,UAAUH,SAAS;IAE1D,MAAMmB,SAASxC,aAAa;QAC1B,GAAGe,YAAY;QACfC,SAASsB;QACTjB,WAAWkB;QACXE,kBAAkB;IACpB,GAAGC,MAAM,CAAC;QAACC,YAAY;IAAa;IAEpChB,OAAOiB,KAAK,CAACC,eAAe,CAAC;QAC3BC,UAAUtB,UAAUsB,QAAQ;QAC5B9B,SAASQ,UAAUR,OAAO;QAC1B+B,MAAMvB,UAAUuB,IAAI;QACpB1B,WAAWG,UAAUH,SAAS;IAChC;IAEA,OAAO;QAACmB;QAAQxB,SAASsB;QAAiBjB,WAAWkB;QAAmBf;IAAS;AACnF;AAOA,eAAewB,mBAAmB,EAChChC,SAASiC,WAAW,EACpB5B,WAAW6B,MAAM,EACS;IAC1B,MAAMC,gBAAgB,MAAM/C,iBAAiB;QAACY,SAASiC;QAAa5B,WAAW6B;IAAM;IACrFvB,OAAOiB,KAAK,CAACQ,mBAAmB,CAAC;QAACD;IAAa;IAE/C,MAAME,WAAW,MAAMlD,gBAAgB;QAACa,SAASiC;QAAa5B,WAAW6B;IAAM;IAE/E,MAAMrB,SAASwB,SAASC,IAAI,EAAEC;IAC9B,IAAI,CAAC1B,QAAQ,MAAM,IAAIH,MAAM;IAE7B,IAAI8B,kBAAkB;IACtB,MAAMC,gBAAgB,IAAIC;IAC1B,MAAMC,cAAc,IAAID;IACxB,MAAME,QAAQrE,SAASsE,eAAe,CAAC;QAACC,OAAOtE,SAASuE,IAAI,CAACnC,kBAAkBC;IAAQ;IAEvF,0EAA0E;IAC1E,mCAAmC;IACnC,8DAA8D;IAC9D,MAAMmC,WAAW,IAAIC,OAClBC,WAAW,GACXC,UAAU,CAAC,eAAe,KAC1BC,WAAW;IACd,MAAMC,iBAAiB/E,KAAKgF,IAAI,CAACjF,GAAGkF,MAAM,IAAI,CAAC,gBAAgB,EAAEP,SAAS,OAAO,CAAC;IAClF,MAAMQ,eAAepF,GAAGqF,iBAAiB,CAACJ;IAE1C,WAAW,MAAMK,QAAQd,MAAO;QAC9B,MAAMe,WAAWC,KAAKC,KAAK,CAACH;QAE5B,IAAI7D,sBAAsB8D,WAAW;YACnChB,YAAYmB,GAAG,CAACH,SAASI,GAAG;YAC5B,KAAK,MAAMC,eAAexE,gBAAgBmE,UAAW;gBACnDlB,cAAcqB,GAAG,CAACE;YACpB;YAEAR,aAAaS,KAAK,CAAC,GAAGP,KAAK,EAAE,CAAC;QAChC;QAEAlB;QACA7B,OAAOuD,MAAM,CAACC,cAAc,CAACC,IAAI,CAAC;YAACjC;YAAeK;QAAe;IACnE;IAEA,MAAM,IAAI6B,QAAc,CAACC,SAASC,SAChCf,aAAagB,KAAK,CAAC,CAACC,MAASA,MAAMF,OAAOE,OAAOH;IAGnD3D,OAAOuD,MAAM,CAACC,cAAc,CAACO,GAAG;IAChC/D,OAAOiB,KAAK,CAAC+C,cAAc,CAAC;QAACC,0BAA0BjC,YAAYkC,IAAI;IAAA;IAEvE,MAAMC,eAAe,IACnBzF,oCAAoCjB,GAAG2G,gBAAgB,CAAC1B;IAE1D,OAAO;QAAC2B,SAAS,IAAM5G,GAAG6G,QAAQ,CAACC,EAAE,CAAC7B;QAAiBV;QAAamC;QAAcrC;IAAa;AACjG;AAEA,eAAe0C,iBAAiBC,QAAgB;IAC9C,MAAM3C,gBAAgB,IAAIC;IAC1B,MAAMC,cAAc,IAAID;IACxB,MAAMoC,eAAe,IAAMzF,oCAAoCjB,GAAG2G,gBAAgB,CAACK;IAEnF,WAAW,MAAMzB,YAAYmB,eAAgB;QAC3C,IAAIjF,sBAAsB8D,WAAW;YACnChB,YAAYmB,GAAG,CAACH,SAASI,GAAG;YAC5B,KAAK,MAAMC,eAAexE,gBAAgBmE,UAAW;gBACnDlB,cAAcqB,GAAG,CAACE;YACpB;QACF;IACF;IAEArD,OAAOiB,KAAK,CAAC+C,cAAc,CAAC;QAACC,0BAA0BjC,YAAYkC,IAAI;IAAA;IAEvE,OAAO;QAACG,SAASK;QAAW1C;QAAamC;QAAcrC;IAAa;AACtE;AASA,eAAe6C,wBAAwB,EACrCtF,SAASiC,WAAW,EACpBU,WAAW,EACXtC,WAAW6B,MAAM,EACjBO,eAAe8C,cAAc,EACE;IAC/B,MAAMC,cAAc,IAAI9C,IAAIC;IAC5B,MAAM8C,aAAa;WAAIF;KAAe,CACnCG,MAAM,CAAC,CAACC,KAAO,CAACH,YAAYI,GAAG,CAACD,OAAOlG,UAAUkG,KACjDE,QAAQ;IAEX,MAAMC,UAAsB,EAAE;IAC9B,IAAK,IAAIC,IAAI,GAAGA,IAAIN,WAAWO,MAAM,EAAED,KAAKnG,+BAAgC;QAC1EkG,QAAQG,IAAI,CAACR,WAAWS,KAAK,CAACH,GAAGA,IAAInG;IACvC;IAEA,KAAK,MAAMuG,SAASL,QAAS;QAC3B,MAAM,EAACM,OAAO,EAAC,GAAG,MAAMlH,0BAA0B;YAChDc,SAASiC;YACTU,aAAawD;YACb9F,WAAW6B;QACb;QAEA,MAAMmE,aAAgF,CAAC;QACvF,KAAK,MAAMC,QAAQF,QAAS;YAC1BC,UAAU,CAACC,KAAKX,EAAE,CAAC,GAAGW,KAAKC,MAAM;QACnC;QAEA,KAAK,MAAMZ,MAAMQ,MAAO;YACtB,qEAAqE;YACrE,iDAAiD;YACjD,IAAIE,UAAU,CAACV,GAAG,KAAK,aAAa;gBAClCH,YAAY1B,GAAG,CAAC6B;YAClB;QACF;IACF;IACAhF,OAAOiB,KAAK,CAAC4E,wBAAwB;IAErC,OAAO;QAAChB;IAAW;AACrB;AAEA,eAAevE;IACb,IAAIwF;IAEJ,IAAI;QACF,MAAM,EAACjF,MAAM,EAAExB,SAASiC,WAAW,EAAE5B,WAAW6B,MAAM,EAAE1B,SAAS,EAAC,GAAG,MAAMY;QAC3E,MAAM,EAAC4D,OAAO,EAAErC,WAAW,EAAEmC,YAAY,EAAErC,aAAa,EAAC,GAAGrC,iBACxD,MAAM+E,iBAAiB/E,kBACvB,MAAM4B,mBAAmB;YAAChC,SAASiC;YAAa5B,WAAW6B;QAAM;QACrEuE,6BAA6BzB;QAC7B,MAAM,EAACQ,WAAW,EAAC,GAAG,MAAMF,wBAAwB;YAClDtF,SAASiC;YACTU;YACAtC,WAAW6B;YACXO;QACF;QAEA,MAAMiE,YAAY,CAAyCC,UACzDnF,OAAOoF,UAAU,CAACD;QAEpB,MAAME,oBAA4D,CAAC,EAAClB,EAAE,EAAC,GACrEtB,QAAQC,OAAO,CAACkB,YAAYI,GAAG,CAACD;QAElC,MAAMmB,WAAW,CAACC;YAChB,IAAIC,eAAe;YACnB,KAAK,MAAMC,UAAUF,QAAS;gBAC5B,IAAIE,OAAOhH,KAAK,KAAK,SAAS,OAAO;gBACrC,IAAIgH,OAAOhH,KAAK,KAAK,WAAW+G,eAAe;YACjD;YAEA,IAAIA,cAAc,OAAO;YACzB,OAAO;QACT;QAEA,IAAIE,iBAAiB;QAErB,MAAMC,WAAW,OAAOxD;YACtB,IAAIoD;YAEJ,IAAI;gBACF,MAAMK,UAAUC,OAAO;gBAEvB,MAAM,EAACC,gBAAgB,EAAC,GAAG,MAAMvI,oBAC/B,UACAwB;gBAGF,MAAMgH,SAAS,MAAMlD,QAAQmD,IAAI,CAAC;oBAChCF,iBAAiB;wBACf3D;wBACA8D,aAAa;wBACbf;wBACAG;wBACA3G;wBACAC;wBACAK;oBACF;oBACA,IAAI6D,QAAwB,CAACC,UAC3BoD,WAAW,IAAMpD,QAAQ8C,UAAU7H;iBAEtC;gBAED,IAAIgI,WAAWH,SAAS;oBACtB,MAAM,IAAI1G,MACR,CAAC,UAAU,EAAEiD,SAASI,GAAG,CAAC,4BAA4B,EAAExE,4BAA4B,GAAG,CAAC;gBAE5F;gBAEAwH,UAAUQ,MACR,6BAA6B;iBAC5B7B,MAAM,CAAC,CAACuB;oBACP,MAAMU,cAAcjI,WAAW,CAACuH,OAAOhH,KAAK,CAAC;oBAC7C,MAAM2H,iBACJlI,WAAW,CAACO,MAAkC,IAAIP,YAAYmI,IAAI;oBACpE,OAAOF,eAAeC;gBACxB;YACJ,EAAE,OAAOnD,KAAK;gBACZ,MAAMqD,eACJhJ,SAAS2F,QAAQ,OAAOA,IAAIsD,OAAO,KAAK,WAAWtD,IAAIsD,OAAO,GAAG;gBAEnE,MAAMA,UAAU,CAAC,2CAA2C,EAAED,cAAc;gBAE5Ef,UAAU;oBACR;wBACE9G,OAAO;wBACP8H;wBACAzJ,MAAM,EAAE;oBACV;iBACD;YACH;YAEA4I;YAEA,MAAMc,YACJ1H,cACA,GAAGA,aAAahC,KAAKgG,OAAO,CAC1B9D,UAAUsB,QAAQ,EAClB,CAAC,gBAAgB,EAAEmG,mBAAmBtE,SAASI,GAAG,EAAE,MAAM,EAAEkE,mBAC1DtE,SAASuE,KAAK,GACb,GACF;YAELvH,OAAOuD,MAAM,CAACiE,UAAU,CAAC/D,IAAI,CAAC;gBAC5BgE,YAAYzE,SAASI,GAAG;gBACxBsE,cAAc1E,SAASuE,KAAK;gBAC5B,GAAIF,aAAa;oBAACA;gBAAS,CAAC;gBAC5B/H,OAAO6G,SAASC;gBAChBA;gBACAuB,UAAU3E,SAAS4E,IAAI;gBACvBrB;YACF;QACF;QAEA,MAAMjI,KAAK6F,gBAAgBqC,UAAU;YAACqB,aAAa7I;QAA0B;QAE7EgB,OAAOuD,MAAM,CAACiE,UAAU,CAACzD,GAAG;IAC9B,SAAU;QACR,MAAM+B;IACR;AACF"}

package/dist/actions/documents/validation/reporters/index.js

@@ -0,0 +1,10 @@
+import { json } from './jsonReporter.js';
+import { ndjson } from './ndjsonReporter.js';
+import { pretty } from './prettyReporter/index.js';
+export const reporters = {
+    json,
+    ndjson,
+    pretty
+};
+
+//# sourceMappingURL=index.js.map

package/dist/actions/documents/validation/reporters/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/actions/documents/validation/reporters/index.ts"],"sourcesContent":["import {json} from './jsonReporter.js'\nimport {ndjson} from './ndjsonReporter.js'\nimport {pretty} from './prettyReporter/index.js'\n\nexport const reporters = {json, ndjson, pretty}\n"],"names":["json","ndjson","pretty","reporters"],"mappings":"AAAA,SAAQA,IAAI,QAAO,oBAAmB;AACtC,SAAQC,MAAM,QAAO,sBAAqB;AAC1C,SAAQC,MAAM,QAAO,4BAA2B;AAEhD,OAAO,MAAMC,YAAY;IAACH;IAAMC;IAAQC;AAAM,EAAC"}

package/dist/actions/documents/validation/reporters/jsonReporter.js

@@ -0,0 +1,25 @@
+import { omit } from 'lodash-es';
+// TODO: replace with Array.fromAsync when it's out of stage3
+async function arrayFromAsync(iterable) {
+    const results = [];
+    for await (const item of iterable)results.push(item);
+    return results;
+}
+export const json = async ({ output, worker })=>{
+    const results = await arrayFromAsync(worker.stream.validation());
+    const formatted = results// report out only documents with some markers
+    .filter(({ markers })=>markers.length)// remove validatedCount from the results
+    .map((result)=>omit(result, [
+            'validatedCount'
+        ]));
+    await worker.dispose();
+    output.log(JSON.stringify(formatted));
+    let overallLevel = 'info';
+    for (const { level } of formatted){
+        if (level === 'error') overallLevel = 'error';
+        if (level === 'warning' && overallLevel !== 'error') overallLevel = 'warning';
+    }
+    return overallLevel;
+};
+
+//# sourceMappingURL=jsonReporter.js.map

package/dist/actions/documents/validation/reporters/jsonReporter.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/actions/documents/validation/reporters/jsonReporter.ts"],"sourcesContent":["import {omit} from 'lodash-es'\n\nimport {type BuiltInValidationReporter, Level} from '../../types.js'\n\n// TODO: replace with Array.fromAsync when it's out of stage3\nasync function arrayFromAsync<T>(iterable: AsyncIterable<T>) {\n  const results: T[] = []\n  for await (const item of iterable) results.push(item)\n  return results\n}\n\nexport const json: BuiltInValidationReporter = async ({output, worker}) => {\n  const results = await arrayFromAsync(worker.stream.validation())\n  const formatted = results\n    // report out only documents with some markers\n    .filter(({markers}) => markers.length)\n    // remove validatedCount from the results\n    .map((result) => omit(result, ['validatedCount']))\n\n  await worker.dispose()\n\n  output.log(JSON.stringify(formatted))\n\n  let overallLevel: Level = 'info'\n\n  for (const {level} of formatted) {\n    if (level === 'error') overallLevel = 'error'\n    if (level === 'warning' && overallLevel !== 'error') overallLevel = 'warning'\n  }\n\n  return overallLevel\n}\n"],"names":["omit","arrayFromAsync","iterable","results","item","push","json","output","worker","stream","validation","formatted","filter","markers","length","map","result","dispose","log","JSON","stringify","overallLevel","level"],"mappings":"AAAA,SAAQA,IAAI,QAAO,YAAW;AAI9B,6DAA6D;AAC7D,eAAeC,eAAkBC,QAA0B;IACzD,MAAMC,UAAe,EAAE;IACvB,WAAW,MAAMC,QAAQF,SAAUC,QAAQE,IAAI,CAACD;IAChD,OAAOD;AACT;AAEA,OAAO,MAAMG,OAAkC,OAAO,EAACC,MAAM,EAAEC,MAAM,EAAC;IACpE,MAAML,UAAU,MAAMF,eAAeO,OAAOC,MAAM,CAACC,UAAU;IAC7D,MAAMC,YAAYR,OAChB,8CAA8C;KAC7CS,MAAM,CAAC,CAAC,EAACC,OAAO,EAAC,GAAKA,QAAQC,MAAM,CACrC,yCAAyC;KACxCC,GAAG,CAAC,CAACC,SAAWhB,KAAKgB,QAAQ;YAAC;SAAiB;IAElD,MAAMR,OAAOS,OAAO;IAEpBV,OAAOW,GAAG,CAACC,KAAKC,SAAS,CAACT;IAE1B,IAAIU,eAAsB;IAE1B,KAAK,MAAM,EAACC,KAAK,EAAC,IAAIX,UAAW;QAC/B,IAAIW,UAAU,SAASD,eAAe;QACtC,IAAIC,UAAU,aAAaD,iBAAiB,SAASA,eAAe;IACtE;IAEA,OAAOA;AACT,EAAC"}

package/dist/actions/documents/validation/reporters/ndjsonReporter.js

@@ -0,0 +1,18 @@
+import { omit } from 'lodash-es';
+export const ndjson = async ({ output, worker })=>{
+    let overallLevel = 'info';
+    for await (const item of worker.stream.validation()){
+        const result = omit(item, [
+            'validatedCount'
+        ]);
+        if (result.level === 'error') overallLevel = 'error';
+        if (result.level === 'warning' && overallLevel !== 'error') overallLevel = 'warning';
+        if (result.markers.length > 0) {
+            output.log(JSON.stringify(result));
+        }
+    }
+    await worker.dispose();
+    return overallLevel;
+};
+
+//# sourceMappingURL=ndjsonReporter.js.map

package/dist/actions/documents/validation/reporters/ndjsonReporter.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/actions/documents/validation/reporters/ndjsonReporter.ts"],"sourcesContent":["import {omit} from 'lodash-es'\n\nimport {type BuiltInValidationReporter, Level} from '../../types.js'\n\nexport const ndjson: BuiltInValidationReporter = async ({output, worker}) => {\n  let overallLevel: Level = 'info'\n\n  for await (const item of worker.stream.validation()) {\n    const result = omit(item, ['validatedCount'])\n\n    if (result.level === 'error') overallLevel = 'error'\n    if (result.level === 'warning' && overallLevel !== 'error') overallLevel = 'warning'\n\n    if (result.markers.length > 0) {\n      output.log(JSON.stringify(result))\n    }\n  }\n\n  await worker.dispose()\n\n  return overallLevel\n}\n"],"names":["omit","ndjson","output","worker","overallLevel","item","stream","validation","result","level","markers","length","log","JSON","stringify","dispose"],"mappings":"AAAA,SAAQA,IAAI,QAAO,YAAW;AAI9B,OAAO,MAAMC,SAAoC,OAAO,EAACC,MAAM,EAAEC,MAAM,EAAC;IACtE,IAAIC,eAAsB;IAE1B,WAAW,MAAMC,QAAQF,OAAOG,MAAM,CAACC,UAAU,GAAI;QACnD,MAAMC,SAASR,KAAKK,MAAM;YAAC;SAAiB;QAE5C,IAAIG,OAAOC,KAAK,KAAK,SAASL,eAAe;QAC7C,IAAII,OAAOC,KAAK,KAAK,aAAaL,iBAAiB,SAASA,eAAe;QAE3E,IAAII,OAAOE,OAAO,CAACC,MAAM,GAAG,GAAG;YAC7BT,OAAOU,GAAG,CAACC,KAAKC,SAAS,CAACN;QAC5B;IACF;IAEA,MAAML,OAAOY,OAAO;IAEpB,OAAOX;AACT,EAAC"}

package/dist/actions/documents/validation/reporters/prettyReporter/formatDocumentValidation.js

@@ -0,0 +1,62 @@
+import { styleText } from 'node:util';
+import { convertToTree, formatTree, maxKeyLength } from '@sanity/cli-core/tree';
+import { logSymbols } from '@sanity/cli-core/ux';
+import { isTty, levelValues } from './util.js';
+const levelHeaders = {
+    error: isTty ? styleText('bold', styleText('bgRed', styleText('black', ' ERROR '))) : styleText('red', '[ERROR]'),
+    info: isTty ? styleText('bold', styleText('cyan', styleText('black', ' INFO '))) : styleText('cyan', '[INFO]'),
+    warning: isTty ? styleText('bold', styleText('bgYellow', styleText('black', ' WARN '))) : styleText('yellow', '[WARN]')
+};
+/**
+ * Creates a terminal hyperlink. Only outputs a hyperlink if the output is
+ * determined to be a TTY
+ */ const link = (linkText, url)=>isTty ? `\u001B]8;;${url}\u0007${linkText}\u001B]8;;\u0007` : styleText('underline', linkText);
+/**
+ * For sorting markers
+ */ const compareLevels = (a, b)=>levelValues[a.level] - levelValues[b.level];
+/**
+ * Formats the markers at the root of the validation tree
+ */ const formatRootErrors = (root, hasChildren, paddingLength)=>{
+    if (!root.nodes) return '';
+    const [first, ...rest] = [
+        ...root.nodes
+    ].toSorted(compareLevels);
+    if (!first) return '';
+    const firstElbow = hasChildren ? '│ ' : '└─';
+    const firstPadding = '.'.repeat(paddingLength - 6);
+    const firstLine = `${firstElbow} (root) ${firstPadding} ${logSymbols[first.level]} ${first.message}`;
+    const subsequentPadding = ' '.repeat(paddingLength + 2);
+    const subsequentElbow = hasChildren ? '│ ' : '  ';
+    const restOfLines = rest.map((marker)=>`${subsequentElbow}${subsequentPadding} ${logSymbols[marker.level]} ${marker.message}`).join('\n');
+    return [
+        firstLine,
+        restOfLines
+    ].filter(Boolean).join('\n');
+};
+/**
+ * Formats document validation results into a user-friendly tree structure
+ */ export function formatDocumentValidation({ documentId, documentType, intentUrl, level, markers }) {
+    const tree = convertToTree(markers);
+    const documentTypeHeader = isTty ? styleText('bgWhite', styleText('black', ` ${documentType} `)) : `[${documentType}]`;
+    const header = `${levelHeaders[level]} ${documentTypeHeader} ${intentUrl ? link(documentId, intentUrl) : styleText('underline', documentId)}`;
+    const paddingLength = Math.max(maxKeyLength(tree.children) + 2, 30);
+    const childErrors = formatTree({
+        getMessage: (marker)=>[
+                logSymbols[marker.level],
+                marker.message
+            ].join(' '),
+        getNodes: ({ nodes })=>[
+                ...nodes ?? []
+            ].toSorted(compareLevels),
+        node: tree.children,
+        paddingLength
+    });
+    const rootErrors = formatRootErrors(tree, childErrors.length > 0, paddingLength);
+    return [
+        header,
+        rootErrors,
+        childErrors
+    ].filter(Boolean).join('\n');
+}
+
+//# sourceMappingURL=formatDocumentValidation.js.map

package/dist/actions/documents/validation/reporters/prettyReporter/formatDocumentValidation.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../src/actions/documents/validation/reporters/prettyReporter/formatDocumentValidation.ts"],"sourcesContent":["import {styleText} from 'node:util'\n\nimport {convertToTree, formatTree, maxKeyLength, type Tree} from '@sanity/cli-core/tree'\nimport {logSymbols} from '@sanity/cli-core/ux'\nimport {type Path, type ValidationMarker} from '@sanity/types'\n\nimport {Level} from '../../../types'\nimport {type DocumentValidationResult, isTty, levelValues} from './util.js'\n\ninterface FormatDocumentValidationOptions extends DocumentValidationResult {\n  basePath?: string\n  studioHost?: string\n}\n\ninterface Marker extends Pick<ValidationMarker, 'level' | 'message'> {\n  path: Path\n}\n\ntype ValidationTree = Tree<Marker>\n\nconst levelHeaders = {\n  error: isTty\n    ? styleText('bold', styleText('bgRed', styleText('black', ' ERROR ')))\n    : styleText('red', '[ERROR]'),\n  info: isTty\n    ? styleText('bold', styleText('cyan', styleText('black', ' INFO ')))\n    : styleText('cyan', '[INFO]'),\n  warning: isTty\n    ? styleText('bold', styleText('bgYellow', styleText('black', ' WARN ')))\n    : styleText('yellow', '[WARN]'),\n}\n/**\n * Creates a terminal hyperlink. Only outputs a hyperlink if the output is\n * determined to be a TTY\n */\nconst link = (linkText: string, url: string) =>\n  isTty ? `\\u001B]8;;${url}\\u0007${linkText}\\u001B]8;;\\u0007` : styleText('underline', linkText)\n\n/**\n * For sorting markers\n */\nconst compareLevels = <T extends {level: Level; message: string}>(a: T, b: T) =>\n  levelValues[a.level] - levelValues[b.level]\n\n/**\n * Formats the markers at the root of the validation tree\n */\nconst formatRootErrors = (root: ValidationTree, hasChildren: boolean, paddingLength: number) => {\n  if (!root.nodes) return ''\n\n  const [first, ...rest] = [...root.nodes].toSorted(compareLevels)\n  if (!first) return ''\n\n  const firstElbow = hasChildren ? '│ ' : '└─'\n  const firstPadding = '.'.repeat(paddingLength - 6)\n  const firstLine = `${firstElbow} (root) ${firstPadding} ${logSymbols[first.level]} ${\n    first.message\n  }`\n  const subsequentPadding = ' '.repeat(paddingLength + 2)\n  const subsequentElbow = hasChildren ? '│ ' : '  '\n\n  const restOfLines = rest\n    .map(\n      (marker) =>\n        `${subsequentElbow}${subsequentPadding} ${logSymbols[marker.level]} ${marker.message}`,\n    )\n    .join('\\n')\n  return [firstLine, restOfLines].filter(Boolean).join('\\n')\n}\n\n/**\n * Formats document validation results into a user-friendly tree structure\n */\nexport function formatDocumentValidation({\n  documentId,\n  documentType,\n  intentUrl,\n  level,\n  markers,\n}: FormatDocumentValidationOptions): string {\n  const tree = convertToTree<Marker>(markers)\n\n  const documentTypeHeader = isTty\n    ? styleText('bgWhite', styleText('black', ` ${documentType} `))\n    : `[${documentType}]`\n\n  const header = `${levelHeaders[level]} ${documentTypeHeader} ${\n    intentUrl ? link(documentId, intentUrl) : styleText('underline', documentId)\n  }`\n\n  const paddingLength = Math.max(maxKeyLength(tree.children) + 2, 30)\n\n  const childErrors = formatTree<Marker>({\n    getMessage: (marker) => [logSymbols[marker.level], marker.message].join(' '),\n    getNodes: ({nodes}) => [...(nodes ?? [])].toSorted(compareLevels),\n    node: tree.children,\n    paddingLength,\n  })\n\n  const rootErrors = formatRootErrors(tree, childErrors.length > 0, paddingLength)\n\n  return [header, rootErrors, childErrors].filter(Boolean).join('\\n')\n}\n"],"names":["styleText","convertToTree","formatTree","maxKeyLength","logSymbols","isTty","levelValues","levelHeaders","error","info","warning","link","linkText","url","compareLevels","a","b","level","formatRootErrors","root","hasChildren","paddingLength","nodes","first","rest","toSorted","firstElbow","firstPadding","repeat","firstLine","message","subsequentPadding","subsequentElbow","restOfLines","map","marker","join","filter","Boolean","formatDocumentValidation","documentId","documentType","intentUrl","markers","tree","documentTypeHeader","header","Math","max","children","childErrors","getMessage","getNodes","node","rootErrors","length"],"mappings":"AAAA,SAAQA,SAAS,QAAO,YAAW;AAEnC,SAAQC,aAAa,EAAEC,UAAU,EAAEC,YAAY,QAAkB,wBAAuB;AACxF,SAAQC,UAAU,QAAO,sBAAqB;AAI9C,SAAuCC,KAAK,EAAEC,WAAW,QAAO,YAAW;AAa3E,MAAMC,eAAe;IACnBC,OAAOH,QACHL,UAAU,QAAQA,UAAU,SAASA,UAAU,SAAS,eACxDA,UAAU,OAAO;IACrBS,MAAMJ,QACFL,UAAU,QAAQA,UAAU,QAAQA,UAAU,SAAS,cACvDA,UAAU,QAAQ;IACtBU,SAASL,QACLL,UAAU,QAAQA,UAAU,YAAYA,UAAU,SAAS,cAC3DA,UAAU,UAAU;AAC1B;AACA;;;CAGC,GACD,MAAMW,OAAO,CAACC,UAAkBC,MAC9BR,QAAQ,CAAC,UAAU,EAAEQ,IAAI,MAAM,EAAED,SAAS,gBAAgB,CAAC,GAAGZ,UAAU,aAAaY;AAEvF;;CAEC,GACD,MAAME,gBAAgB,CAA4CC,GAAMC,IACtEV,WAAW,CAACS,EAAEE,KAAK,CAAC,GAAGX,WAAW,CAACU,EAAEC,KAAK,CAAC;AAE7C;;CAEC,GACD,MAAMC,mBAAmB,CAACC,MAAsBC,aAAsBC;IACpE,IAAI,CAACF,KAAKG,KAAK,EAAE,OAAO;IAExB,MAAM,CAACC,OAAO,GAAGC,KAAK,GAAG;WAAIL,KAAKG,KAAK;KAAC,CAACG,QAAQ,CAACX;IAClD,IAAI,CAACS,OAAO,OAAO;IAEnB,MAAMG,aAAaN,cAAc,OAAO;IACxC,MAAMO,eAAe,IAAIC,MAAM,CAACP,gBAAgB;IAChD,MAAMQ,YAAY,GAAGH,WAAW,QAAQ,EAAEC,aAAa,CAAC,EAAEvB,UAAU,CAACmB,MAAMN,KAAK,CAAC,CAAC,CAAC,EACjFM,MAAMO,OAAO,EACb;IACF,MAAMC,oBAAoB,IAAIH,MAAM,CAACP,gBAAgB;IACrD,MAAMW,kBAAkBZ,cAAc,OAAO;IAE7C,MAAMa,cAAcT,KACjBU,GAAG,CACF,CAACC,SACC,GAAGH,kBAAkBD,kBAAkB,CAAC,EAAE3B,UAAU,CAAC+B,OAAOlB,KAAK,CAAC,CAAC,CAAC,EAAEkB,OAAOL,OAAO,EAAE,EAEzFM,IAAI,CAAC;IACR,OAAO;QAACP;QAAWI;KAAY,CAACI,MAAM,CAACC,SAASF,IAAI,CAAC;AACvD;AAEA;;CAEC,GACD,OAAO,SAASG,yBAAyB,EACvCC,UAAU,EACVC,YAAY,EACZC,SAAS,EACTzB,KAAK,EACL0B,OAAO,EACyB;IAChC,MAAMC,OAAO3C,cAAsB0C;IAEnC,MAAME,qBAAqBxC,QACvBL,UAAU,WAAWA,UAAU,SAAS,CAAC,CAAC,EAAEyC,aAAa,CAAC,CAAC,KAC3D,CAAC,CAAC,EAAEA,aAAa,CAAC,CAAC;IAEvB,MAAMK,SAAS,GAAGvC,YAAY,CAACU,MAAM,CAAC,CAAC,EAAE4B,mBAAmB,CAAC,EAC3DH,YAAY/B,KAAK6B,YAAYE,aAAa1C,UAAU,aAAawC,aACjE;IAEF,MAAMnB,gBAAgB0B,KAAKC,GAAG,CAAC7C,aAAayC,KAAKK,QAAQ,IAAI,GAAG;IAEhE,MAAMC,cAAchD,WAAmB;QACrCiD,YAAY,CAAChB,SAAW;gBAAC/B,UAAU,CAAC+B,OAAOlB,KAAK,CAAC;gBAAEkB,OAAOL,OAAO;aAAC,CAACM,IAAI,CAAC;QACxEgB,UAAU,CAAC,EAAC9B,KAAK,EAAC,GAAK;mBAAKA,SAAS,EAAE;aAAE,CAACG,QAAQ,CAACX;QACnDuC,MAAMT,KAAKK,QAAQ;QACnB5B;IACF;IAEA,MAAMiC,aAAapC,iBAAiB0B,MAAMM,YAAYK,MAAM,GAAG,GAAGlC;IAElE,OAAO;QAACyB;QAAQQ;QAAYJ;KAAY,CAACb,MAAM,CAACC,SAASF,IAAI,CAAC;AAChE"}

package/dist/actions/documents/validation/reporters/prettyReporter/index.js

@@ -0,0 +1,3 @@
+export { pretty } from './prettyReporter.js';
+
+//# sourceMappingURL=index.js.map

package/dist/actions/documents/validation/reporters/prettyReporter/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../src/actions/documents/validation/reporters/prettyReporter/index.ts"],"sourcesContent":["export {pretty} from './prettyReporter.js'\n"],"names":["pretty"],"mappings":"AAAA,SAAQA,MAAM,QAAO,sBAAqB"}

package/dist/actions/documents/validation/reporters/prettyReporter/prettyReporter.js

@@ -0,0 +1,92 @@
+import { spinner } from '@sanity/cli-core/ux';
+import { formatDocumentValidation } from './formatDocumentValidation.js';
+import { count, levelValues, percent, seconds, summary } from './util.js';
+/**
+ * Represents the default stylish/pretty reporter
+ */ export const pretty = async ({ flags, output, worker })=>{
+    const workspaceLoadStart = Date.now();
+    // Report workspace loaded
+    const spin = spinner(flags.workspace ? `Loading workspace '${flags.workspace}'…` : 'Loading workspace…').start();
+    const workspace = await worker.event.loadedWorkspace();
+    spin.succeed(`Loaded workspace '${workspace.name}' using project '${workspace.projectId}' and dataset '${flags.dataset || workspace.dataset}' ${seconds(workspaceLoadStart)}`);
+    if (!flags.file) {
+        // Report document count
+        spin.start('Calculating documents to be validated…');
+        const { documentCount } = await worker.event.loadedDocumentCount();
+        // Report export progress
+        const downloadStart = Date.now();
+        spin.text = `Downloading ${count(documentCount, 'documents')}…`;
+        for await (const { downloadedCount } of worker.stream.exportProgress()){
+            const percentage = percent(downloadedCount / documentCount);
+            spin.text = `Downloading ${count(documentCount, 'documents')}… ${percentage}`;
+        }
+        spin.succeed(`Downloaded ${count(documentCount, 'documents')} ${seconds(downloadStart)}`);
+    }
+    const { totalDocumentsToValidate } = await worker.event.exportFinished();
+    const referenceIntegrityStart = Date.now();
+    spin.start(`Checking reference existence…`);
+    await worker.event.loadedReferenceIntegrity();
+    spin.succeed(`Checked all references ${seconds(referenceIntegrityStart)}`);
+    // Report validation progress
+    const validationStart = Date.now();
+    spin.start(`Validating ${count(totalDocumentsToValidate, 'documents')}…`);
+    const results = [];
+    const totals = {
+        errors: {
+            documents: 0,
+            markers: 0
+        },
+        infos: {
+            documents: 0,
+            markers: 0
+        },
+        valid: {
+            documents: 0
+        },
+        warnings: {
+            documents: 0,
+            markers: 0
+        }
+    };
+    for await (const { validatedCount, ...result } of worker.stream.validation()){
+        const { markers } = result;
+        if (markers.length > 0) {
+            results.push(result);
+        }
+        const errors = markers.filter((marker)=>marker.level === 'error');
+        const warnings = markers.filter((marker)=>marker.level === 'warning');
+        const infos = markers.filter((marker)=>marker.level === 'info');
+        if (markers.length === 0) {
+            totals.valid.documents += 1;
+        }
+        if (errors.length > 0) {
+            totals.errors.documents += 1;
+            totals.errors.markers += errors.length;
+        }
+        if (warnings.length > 0) {
+            totals.warnings.documents += 1;
+            totals.warnings.markers += warnings.length;
+        }
+        if (infos.length > 0) {
+            totals.infos.documents += 1;
+            totals.infos.markers += infos.length;
+        }
+        spin.text = `Validating ${count(totalDocumentsToValidate, 'documents')}…\n\n` + `Processed ${count(validatedCount, 'documents')} (${percent(validatedCount / totalDocumentsToValidate)}):\n${summary(totals, flags.level)}`;
+    }
+    spin.succeed(`Validated ${count(totalDocumentsToValidate, 'documents')} ${seconds(validationStart)}`);
+    output.log(`\nValidation results:\n${summary(totals, flags.level)}`);
+    results.sort((a, b)=>{
+        if (a.level === b.level) return a.documentType.localeCompare(b.documentType);
+        return levelValues[a.level] - levelValues[b.level];
+    });
+    let overallLevel = 'info';
+    for (const result of results){
+        if (result.level === 'error') overallLevel = 'error';
+        if (result.level === 'warning' && overallLevel !== 'error') overallLevel = 'warning';
+        output.log(`${formatDocumentValidation(result)}\n`);
+    }
+    await worker.dispose();
+    return overallLevel;
+};
+
+//# sourceMappingURL=prettyReporter.js.map