@sanity/cli 8.11.0 → 8.13.0

package/dist/util/assetUploadErrors.js

@@ -0,0 +1,64 @@
+import { getErrorMessage } from '@sanity/cli-core/errors';
+import { isHttpError } from '@sanity/client';
+const DATASET_ASSET_LIMITS_URL = 'https://www.sanity.io/docs/content-lake/technical-limits#k2c53dc30e24b';
+const MEDIA_LIBRARY_ASSET_LIMITS_URL = 'https://www.sanity.io/docs/media-library';
+const TARGET_GUIDANCE = {
+    dataset: {
+        limitsUrl: DATASET_ASSET_LIMITS_URL,
+        writeAccessTo: 'this dataset'
+    },
+    'media-library': {
+        limitsUrl: MEDIA_LIBRARY_ASSET_LIMITS_URL,
+        writeAccessTo: 'this media library'
+    }
+};
+function isProjectUserNotFoundError(body) {
+    const responseError = body.error;
+    return typeof responseError === 'object' && responseError !== null && 'type' in responseError && responseError.type === 'projectUserNotFoundError';
+}
+/**
+ * Turn an asset upload failure into a message that says what the API reported
+ * and what to do about it.
+ *
+ * @param error - The thrown error, HTTP or otherwise.
+ * @param options - `fromUrl` selects the gateway-failure guidance, which only
+ *   makes sense when Content Lake was fetching the source itself; `target`
+ *   selects the resource-specific wording.
+ *
+ * @internal
+ */ export function getAssetUploadErrorMessage(error, options) {
+    if (!isHttpError(error)) {
+        return `Asset upload failed: ${getErrorMessage(error)}`;
+    }
+    const { limitsUrl, writeAccessTo } = TARGET_GUIDANCE[options.target];
+    const body = typeof error.response.body === 'object' && error.response.body !== null && !Array.isArray(error.response.body) ? error.response.body : {};
+    const responseError = typeof body.error === 'string' ? body.error : error.response.statusMessage || 'HTTP error';
+    const statusCode = typeof body.statusCode === 'number' || typeof body.statusCode === 'string' ? body.statusCode : error.statusCode;
+    const projectUserNotFound = isProjectUserNotFoundError(body);
+    const responseMessage = projectUserNotFound ? error.message : getErrorMessage(error);
+    const message = /[.!?]$/.test(responseMessage) ? responseMessage : `${responseMessage}.`;
+    const details = typeof body.details === 'string' ? `\n\nDetails:\n${body.details}` : '';
+    const response = `Asset upload failed: HTTP ${statusCode} - ${responseError}\n${message}${details}`;
+    if (error.statusCode === 401 && !projectUserNotFound) {
+        return `${response}\n\nRun \`sanity login\` to authenticate, then try again.`;
+    }
+    if (error.statusCode === 403) {
+        return `${response}\n\nCheck that your account has write access to ${writeAccessTo}, then try again.`;
+    }
+    if ([
+        400,
+        413,
+        422
+    ].includes(error.statusCode)) {
+        return `${response}\n\nCheck the asset requirements and current technical limits, then try again: ${limitsUrl}`;
+    }
+    if (options.fromUrl && [
+        502,
+        504
+    ].includes(error.statusCode)) {
+        return `${response}\n\nSanity could not fetch the source URL. Check that it is reachable from the public internet without authentication and serves the asset directly, then try again.`;
+    }
+    return `${response}\n\nTry again.`;
+}
+
+//# sourceMappingURL=assetUploadErrors.js.map

package/dist/util/assetUploadErrors.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/util/assetUploadErrors.ts"],"sourcesContent":["import {getErrorMessage} from '@sanity/cli-core/errors'\nimport {isHttpError} from '@sanity/client'\n\nconst DATASET_ASSET_LIMITS_URL =\n  'https://www.sanity.io/docs/content-lake/technical-limits#k2c53dc30e24b'\nconst MEDIA_LIBRARY_ASSET_LIMITS_URL = 'https://www.sanity.io/docs/media-library'\n\n/**\n * The asset store an upload targeted. Only affects guidance wording: which\n * resource the user needs write access to, and which limits to check.\n */\nexport type AssetUploadTarget = 'dataset' | 'media-library'\n\nconst TARGET_GUIDANCE: Record<AssetUploadTarget, {limitsUrl: string; writeAccessTo: string}> = {\n  dataset: {limitsUrl: DATASET_ASSET_LIMITS_URL, writeAccessTo: 'this dataset'},\n  'media-library': {limitsUrl: MEDIA_LIBRARY_ASSET_LIMITS_URL, writeAccessTo: 'this media library'},\n}\n\nfunction isProjectUserNotFoundError(body: Record<string, unknown>): boolean {\n  const responseError = body.error\n  return (\n    typeof responseError === 'object' &&\n    responseError !== null &&\n    'type' in responseError &&\n    responseError.type === 'projectUserNotFoundError'\n  )\n}\n\n/**\n * Turn an asset upload failure into a message that says what the API reported\n * and what to do about it.\n *\n * @param error - The thrown error, HTTP or otherwise.\n * @param options - `fromUrl` selects the gateway-failure guidance, which only\n *   makes sense when Content Lake was fetching the source itself; `target`\n *   selects the resource-specific wording.\n *\n * @internal\n */\nexport function getAssetUploadErrorMessage(\n  error: unknown,\n  options: {fromUrl: boolean; target: AssetUploadTarget},\n): string {\n  if (!isHttpError(error)) {\n    return `Asset upload failed: ${getErrorMessage(error)}`\n  }\n\n  const {limitsUrl, writeAccessTo} = TARGET_GUIDANCE[options.target]\n\n  const body =\n    typeof error.response.body === 'object' &&\n    error.response.body !== null &&\n    !Array.isArray(error.response.body)\n      ? (error.response.body as Record<string, unknown>)\n      : {}\n\n  const responseError =\n    typeof body.error === 'string' ? body.error : error.response.statusMessage || 'HTTP error'\n\n  const statusCode =\n    typeof body.statusCode === 'number' || typeof body.statusCode === 'string'\n      ? body.statusCode\n      : error.statusCode\n\n  const projectUserNotFound = isProjectUserNotFoundError(body)\n  const responseMessage = projectUserNotFound ? error.message : getErrorMessage(error)\n  const message = /[.!?]$/.test(responseMessage) ? responseMessage : `${responseMessage}.`\n  const details = typeof body.details === 'string' ? `\\n\\nDetails:\\n${body.details}` : ''\n  const response = `Asset upload failed: HTTP ${statusCode} - ${responseError}\\n${message}${details}`\n\n  if (error.statusCode === 401 && !projectUserNotFound) {\n    return `${response}\\n\\nRun \\`sanity login\\` to authenticate, then try again.`\n  }\n  if (error.statusCode === 403) {\n    return `${response}\\n\\nCheck that your account has write access to ${writeAccessTo}, then try again.`\n  }\n  if ([400, 413, 422].includes(error.statusCode)) {\n    return `${response}\\n\\nCheck the asset requirements and current technical limits, then try again: ${limitsUrl}`\n  }\n  if (options.fromUrl && [502, 504].includes(error.statusCode)) {\n    return `${response}\\n\\nSanity could not fetch the source URL. Check that it is reachable from the public internet without authentication and serves the asset directly, then try again.`\n  }\n  return `${response}\\n\\nTry again.`\n}\n"],"names":["getErrorMessage","isHttpError","DATASET_ASSET_LIMITS_URL","MEDIA_LIBRARY_ASSET_LIMITS_URL","TARGET_GUIDANCE","dataset","limitsUrl","writeAccessTo","isProjectUserNotFoundError","body","responseError","error","type","getAssetUploadErrorMessage","options","target","response","Array","isArray","statusMessage","statusCode","projectUserNotFound","responseMessage","message","test","details","includes","fromUrl"],"mappings":"AAAA,SAAQA,eAAe,QAAO,0BAAyB;AACvD,SAAQC,WAAW,QAAO,iBAAgB;AAE1C,MAAMC,2BACJ;AACF,MAAMC,iCAAiC;AAQvC,MAAMC,kBAAyF;IAC7FC,SAAS;QAACC,WAAWJ;QAA0BK,eAAe;IAAc;IAC5E,iBAAiB;QAACD,WAAWH;QAAgCI,eAAe;IAAoB;AAClG;AAEA,SAASC,2BAA2BC,IAA6B;IAC/D,MAAMC,gBAAgBD,KAAKE,KAAK;IAChC,OACE,OAAOD,kBAAkB,YACzBA,kBAAkB,QAClB,UAAUA,iBACVA,cAAcE,IAAI,KAAK;AAE3B;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASC,2BACdF,KAAc,EACdG,OAAsD;IAEtD,IAAI,CAACb,YAAYU,QAAQ;QACvB,OAAO,CAAC,qBAAqB,EAAEX,gBAAgBW,QAAQ;IACzD;IAEA,MAAM,EAACL,SAAS,EAAEC,aAAa,EAAC,GAAGH,eAAe,CAACU,QAAQC,MAAM,CAAC;IAElE,MAAMN,OACJ,OAAOE,MAAMK,QAAQ,CAACP,IAAI,KAAK,YAC/BE,MAAMK,QAAQ,CAACP,IAAI,KAAK,QACxB,CAACQ,MAAMC,OAAO,CAACP,MAAMK,QAAQ,CAACP,IAAI,IAC7BE,MAAMK,QAAQ,CAACP,IAAI,GACpB,CAAC;IAEP,MAAMC,gBACJ,OAAOD,KAAKE,KAAK,KAAK,WAAWF,KAAKE,KAAK,GAAGA,MAAMK,QAAQ,CAACG,aAAa,IAAI;IAEhF,MAAMC,aACJ,OAAOX,KAAKW,UAAU,KAAK,YAAY,OAAOX,KAAKW,UAAU,KAAK,WAC9DX,KAAKW,UAAU,GACfT,MAAMS,UAAU;IAEtB,MAAMC,sBAAsBb,2BAA2BC;IACvD,MAAMa,kBAAkBD,sBAAsBV,MAAMY,OAAO,GAAGvB,gBAAgBW;IAC9E,MAAMY,UAAU,SAASC,IAAI,CAACF,mBAAmBA,kBAAkB,GAAGA,gBAAgB,CAAC,CAAC;IACxF,MAAMG,UAAU,OAAOhB,KAAKgB,OAAO,KAAK,WAAW,CAAC,cAAc,EAAEhB,KAAKgB,OAAO,EAAE,GAAG;IACrF,MAAMT,WAAW,CAAC,0BAA0B,EAAEI,WAAW,GAAG,EAAEV,cAAc,EAAE,EAAEa,UAAUE,SAAS;IAEnG,IAAId,MAAMS,UAAU,KAAK,OAAO,CAACC,qBAAqB;QACpD,OAAO,GAAGL,SAAS,yDAAyD,CAAC;IAC/E;IACA,IAAIL,MAAMS,UAAU,KAAK,KAAK;QAC5B,OAAO,GAAGJ,SAAS,gDAAgD,EAAET,cAAc,iBAAiB,CAAC;IACvG;IACA,IAAI;QAAC;QAAK;QAAK;KAAI,CAACmB,QAAQ,CAACf,MAAMS,UAAU,GAAG;QAC9C,OAAO,GAAGJ,SAAS,+EAA+E,EAAEV,WAAW;IACjH;IACA,IAAIQ,QAAQa,OAAO,IAAI;QAAC;QAAK;KAAI,CAACD,QAAQ,CAACf,MAAMS,UAAU,GAAG;QAC5D,OAAO,GAAGJ,SAAS,oKAAoK,CAAC;IAC1L;IACA,OAAO,GAAGA,SAAS,cAAc,CAAC;AACpC"}

package/dist/util/isRemoteAssetSource.js

@@ -0,0 +1,19 @@
+/**
+ * Whether a command's source argument names a remote asset for Content Lake to
+ * fetch, rather than a path on the local filesystem.
+ *
+ * The protocol allowlist is load-bearing rather than defensive: a Windows path
+ * parses as a URL whose protocol is its drive letter (`C:\media` → `c:`), so
+ * matching on parseability alone would route local imports to the network.
+ * Anything else, `file:` included, is treated as a local path.
+ *
+ * `http:` counts as remote even though Content Lake only fetches over `https:`,
+ * so that an insecure URL reaches `getIngestUrlError` and is reported as one,
+ * rather than being stat'ed as a directory that does not exist.
+ */ export function isRemoteAssetSource(source) {
+    if (!URL.canParse(source)) return false;
+    const { protocol } = new URL(source);
+    return protocol === 'http:' || protocol === 'https:';
+}
+
+//# sourceMappingURL=isRemoteAssetSource.js.map

package/dist/util/isRemoteAssetSource.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/util/isRemoteAssetSource.ts"],"sourcesContent":["/**\n * Whether a command's source argument names a remote asset for Content Lake to\n * fetch, rather than a path on the local filesystem.\n *\n * The protocol allowlist is load-bearing rather than defensive: a Windows path\n * parses as a URL whose protocol is its drive letter (`C:\\media` → `c:`), so\n * matching on parseability alone would route local imports to the network.\n * Anything else, `file:` included, is treated as a local path.\n *\n * `http:` counts as remote even though Content Lake only fetches over `https:`,\n * so that an insecure URL reaches `getIngestUrlError` and is reported as one,\n * rather than being stat'ed as a directory that does not exist.\n */\nexport function isRemoteAssetSource(source: string): boolean {\n  if (!URL.canParse(source)) return false\n  const {protocol} = new URL(source)\n  return protocol === 'http:' || protocol === 'https:'\n}\n"],"names":["isRemoteAssetSource","source","URL","canParse","protocol"],"mappings":"AAAA;;;;;;;;;;;;CAYC,GACD,OAAO,SAASA,oBAAoBC,MAAc;IAChD,IAAI,CAACC,IAAIC,QAAQ,CAACF,SAAS,OAAO;IAClC,MAAM,EAACG,QAAQ,EAAC,GAAG,IAAIF,IAAID;IAC3B,OAAOG,aAAa,WAAWA,aAAa;AAC9C"}

package/dist/util/parseAspectFlags.js

@@ -0,0 +1,34 @@
+/**
+ * Parsed `--aspect` values, or the message explaining which occurrence was
+ * malformed. Returned rather than thrown so the caller decides the exit code.
+ */ /**
+ * Assemble repeated `--aspect key=value` flags into the aspects object the
+ * media library ingest endpoint accepts.
+ *
+ * Values stay strings: the CLI has no access to the aspect definitions, so
+ * coercing `42` or `true` would guess at the target field's type. Aspects
+ * needing non-string or nested values belong in the `data.ndjson` of a
+ * directory import.
+ *
+ * Later occurrences of a key win, matching how `--header` and the NDJSON
+ * aspect index resolve duplicates.
+ *
+ * @internal
+ */ export function parseAspectFlags(aspectFlags) {
+    // Null-prototype so an aspect named e.g. `constructor` cannot reach Object.prototype
+    const aspects = Object.create(null);
+    for (const aspect of aspectFlags){
+        const separatorIndex = aspect.indexOf('=');
+        if (separatorIndex < 1) {
+            return {
+                error: `Invalid --aspect "${aspect}": expected key=value format`
+            };
+        }
+        aspects[aspect.slice(0, separatorIndex).trim()] = aspect.slice(separatorIndex + 1);
+    }
+    return {
+        aspects
+    };
+}
+
+//# sourceMappingURL=parseAspectFlags.js.map

package/dist/util/parseAspectFlags.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/util/parseAspectFlags.ts"],"sourcesContent":["/**\n * Parsed `--aspect` values, or the message explaining which occurrence was\n * malformed. Returned rather than thrown so the caller decides the exit code.\n */\ntype ParseAspectFlagsResult = {aspects: Record<string, string>} | {error: string}\n\n/**\n * Assemble repeated `--aspect key=value` flags into the aspects object the\n * media library ingest endpoint accepts.\n *\n * Values stay strings: the CLI has no access to the aspect definitions, so\n * coercing `42` or `true` would guess at the target field's type. Aspects\n * needing non-string or nested values belong in the `data.ndjson` of a\n * directory import.\n *\n * Later occurrences of a key win, matching how `--header` and the NDJSON\n * aspect index resolve duplicates.\n *\n * @internal\n */\nexport function parseAspectFlags(aspectFlags: readonly string[]): ParseAspectFlagsResult {\n  // Null-prototype so an aspect named e.g. `constructor` cannot reach Object.prototype\n  const aspects: Record<string, string> = Object.create(null)\n\n  for (const aspect of aspectFlags) {\n    const separatorIndex = aspect.indexOf('=')\n    if (separatorIndex < 1) {\n      return {error: `Invalid --aspect \"${aspect}\": expected key=value format`}\n    }\n    aspects[aspect.slice(0, separatorIndex).trim()] = aspect.slice(separatorIndex + 1)\n  }\n\n  return {aspects}\n}\n"],"names":["parseAspectFlags","aspectFlags","aspects","Object","create","aspect","separatorIndex","indexOf","error","slice","trim"],"mappings":"AAAA;;;CAGC,GAGD;;;;;;;;;;;;;CAaC,GACD,OAAO,SAASA,iBAAiBC,WAA8B;IAC7D,qFAAqF;IACrF,MAAMC,UAAkCC,OAAOC,MAAM,CAAC;IAEtD,KAAK,MAAMC,UAAUJ,YAAa;QAChC,MAAMK,iBAAiBD,OAAOE,OAAO,CAAC;QACtC,IAAID,iBAAiB,GAAG;YACtB,OAAO;gBAACE,OAAO,CAAC,kBAAkB,EAAEH,OAAO,4BAA4B,CAAC;YAAA;QAC1E;QACAH,OAAO,CAACG,OAAOI,KAAK,CAAC,GAAGH,gBAAgBI,IAAI,GAAG,GAAGL,OAAOI,KAAK,CAACH,iBAAiB;IAClF;IAEA,OAAO;QAACJ;IAAO;AACjB"}

package/oclif.config.js

@@ -36,7 +36,6 @@ export default {
     tokens: {description: 'Manage API tokens for your project'},
     typegen: {description: 'Generate TypeScript types for schema and GROQ'},
     users: {description: 'Manage project users and invitations'},
-    workflows: {hidden: true},
   },
   topicSeparator: ' ',
 }