@hypersoniclabs/helix-cli 0.1.7 → 0.1.24-helix3.438

package/dist/itemThumbnail.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_ITEM_THUMBNAIL_BYTES = void 0;
+exports.describeThumbnailError = describeThumbnailError;
+exports.refreshItemThumbnail = refreshItemThumbnail;
+exports.setItemThumbnail = setItemThumbnail;
+exports.renderItemThumbnailResult = renderItemThumbnailResult;
+const promises_1 = require("node:fs/promises");
+const node_path_1 = require("node:path");
+const api_1 = require("./api");
+const item_1 = require("./item");
+/** Client-side ceiling for a creator-supplied thumbnail; the server may be stricter. */
+exports.MAX_ITEM_THUMBNAIL_BYTES = 10 * 1024 * 1024;
+const UPLOAD_TIMEOUT_MS = 60_000;
+const REGENERATE_TIMEOUT_MS = 120_000;
+const UUID = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
+function assertItemId(itemId) {
+    if (!UUID.test(itemId))
+        throw new Error('Item ID must be a UUID.');
+}
+/** Sniff the leading bytes so a renamed file is refused before the upload, not by the moderator. */
+function sniffImageType(bytes) {
+    if (bytes.length >= 8 && bytes[0] === 0x89 && bytes[1] === 0x50 && bytes[2] === 0x4e && bytes[3] === 0x47)
+        return 'image/png';
+    if (bytes.length >= 3 && bytes[0] === 0xff && bytes[1] === 0xd8 && bytes[2] === 0xff)
+        return 'image/jpeg';
+    if (bytes.length >= 12 &&
+        String.fromCharCode(...bytes.slice(0, 4)) === 'RIFF' &&
+        String.fromCharCode(...bytes.slice(8, 12)) === 'WEBP')
+        return 'image/webp';
+    return null;
+}
+const NOT_SUPPORTED = 'this backend does not support thumbnail refresh yet (the thumbnail routes are not deployed on ' +
+    'this API). Try again after the backend rolls out, or republish the item with --thumbnail.';
+/** Translate the server's refusals into text that names the cause and the next step. */
+function describeThumbnailError(error, itemId) {
+    if (!(error instanceof api_1.ApiError))
+        return error instanceof Error ? error.message : String(error);
+    const detail = error.message && error.message !== `HTTP ${error.status}` ? error.message : '';
+    switch (error.status) {
+        case 401:
+            return 'You are not signed in (or your session expired). Run `helix login`, then retry.';
+        case 403:
+            return `You are not the owner of item ${itemId}, so you cannot change its thumbnail. ` +
+                `Sign in as the creator that published it${detail ? ` (server: ${detail})` : ''}.`;
+        case 404:
+            // Nest's unrouted-path 404 reads "Cannot POST /..." (or has no message); a real miss names the item.
+            return !detail || /^cannot (post|put|get)\b/i.test(detail)
+                ? NOT_SUPPORTED
+                : `Item ${itemId} was not found (server: ${detail}).`;
+        case 422:
+            return `The server could not use this item or image${detail ? `: ${detail}` : '.'}`;
+        default:
+            return error.render();
+    }
+}
+/** Re-render an item's canonical thumbnail from its active Package Version with the standard server renderer. */
+async function refreshItemThumbnail(itemId, options, credentials) {
+    assertItemId(itemId);
+    const body = {};
+    if (options.force)
+        body.force = true;
+    if (options.dryRun)
+        body.dryRun = true;
+    const api = api_1.HelixApi.forCredentials(credentials);
+    const result = await api.request('POST', `/api/v1/universal-items/${itemId}/thumbnail/regenerate`, body);
+    return result;
+}
+/** Upload an explicit creator thumbnail (png/jpeg/webp) for an already-published item. */
+async function setItemThumbnail(itemId, file, credentials) {
+    assertItemId(itemId);
+    const declared = (0, item_1.thumbnailContentTypeFromExtension)(file);
+    const bytes = await (0, promises_1.readFile)(file).catch((error) => {
+        throw new Error(error.code === 'ENOENT' ? `thumbnail file not found: ${file}` : `cannot read thumbnail ${file}: ${error.message}`);
+    });
+    if (bytes.length === 0)
+        throw new Error(`thumbnail "${file}" is empty`);
+    if (bytes.length > exports.MAX_ITEM_THUMBNAIL_BYTES) {
+        throw new Error(`thumbnail "${file}" is ${(bytes.length / 1048576).toFixed(1)} MiB; the limit is ${exports.MAX_ITEM_THUMBNAIL_BYTES / 1048576} MiB`);
+    }
+    const actual = sniffImageType(bytes);
+    if (!actual)
+        throw new Error(`thumbnail "${file}" is not a png, jpeg, or webp image (its bytes do not match)`);
+    if (actual !== declared) {
+        throw new Error(`thumbnail "${file}" has a ${declared} extension but ${actual} contents — rename it or re-export it`);
+    }
+    const form = new FormData();
+    form.set('image', new Blob([new Uint8Array(bytes)], { type: actual }), (0, node_path_1.basename)(file));
+    return api_1.HelixApi.forCredentials(credentials).sendMultipart('PUT', `/api/v1/universal-items/${itemId}/thumbnail`, form, UPLOAD_TIMEOUT_MS);
+}
+/** Human-readable receipt shared by both subcommands. */
+function renderItemThumbnailResult(result) {
+    const headline = {
+        generated: 'Regenerated',
+        current: 'Already current (nothing changed; use --force to re-render)',
+        'dry-run': 'Dry run (nothing written)',
+        uploaded: 'Uploaded',
+    };
+    const lines = [`${result.status === 'current' || result.status === 'dry-run' ? '·' : '✔'} ${headline[result.status] ?? result.status}: thumbnail for item ${result.itemId}`];
+    lines.push(`  thumbnail: ${result.previousThumbnailUrl ?? '(none)'} -> ${result.thumbnailUrl ?? '(unchanged)'}`);
+    const refresh = result;
+    if (refresh.rendererVersion)
+        lines.push(`  renderer:  ${refresh.rendererVersion}`);
+    if (refresh.source) {
+        const pieces = [refresh.source.lane];
+        if (refresh.source.version)
+            pieces.push(`Package Version ${refresh.source.version}`);
+        else if (refresh.source.packageVersionId)
+            pieces.push(`Package Version ${refresh.source.packageVersionId}`);
+        lines.push(`  source:    ${pieces.join(' · ')}`);
+    }
+    if (refresh.sourceChecksumSha256)
+        lines.push(`  source sha256: ${refresh.sourceChecksumSha256}`);
+    return lines;
+}
+//# sourceMappingURL=itemThumbnail.js.map

package/dist/itemThumbnail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"itemThumbnail.js","sourceRoot":"","sources":["../src/itemThumbnail.ts"],"names":[],"mappings":";;;AAkEA,wDAmBC;AAGD,oDAcC;AAGD,4CAwBC;AAGD,8DAmBC;AAvJD,+CAA4C;AAC5C,yCAAqC;AACrC,+BAA2C;AAE3C,iCAA2D;AAE3D,wFAAwF;AAC3E,QAAA,wBAAwB,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC;AACzD,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACjC,MAAM,qBAAqB,GAAG,OAAO,CAAC;AACtC,MAAM,IAAI,GAAG,iEAAiE,CAAC;AAmC/E,SAAS,YAAY,CAAC,MAAc;IAClC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;AACrE,CAAC;AAED,oGAAoG;AACpG,SAAS,cAAc,CAAC,KAAiB;IACvC,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI;QAAE,OAAO,WAAW,CAAC;IAC9H,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI;QAAE,OAAO,YAAY,CAAC;IAC1G,IACE,KAAK,CAAC,MAAM,IAAI,EAAE;QAClB,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,MAAM;QACpD,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,MAAM;QACrD,OAAO,YAAY,CAAC;IACtB,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,aAAa,GACjB,gGAAgG;IAChG,2FAA2F,CAAC;AAE9F,wFAAwF;AACxF,SAAgB,sBAAsB,CAAC,KAAc,EAAE,MAAc;IACnE,IAAI,CAAC,CAAC,KAAK,YAAY,cAAQ,CAAC;QAAE,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAChG,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,KAAK,QAAQ,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9F,QAAQ,KAAK,CAAC,MAAM,EAAE,CAAC;QACrB,KAAK,GAAG;YACN,OAAO,iFAAiF,CAAC;QAC3F,KAAK,GAAG;YACN,OAAO,iCAAiC,MAAM,wCAAwC;gBACpF,2CAA2C,MAAM,CAAC,CAAC,CAAC,aAAa,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC;QACvF,KAAK,GAAG;YACN,qGAAqG;YACrG,OAAO,CAAC,MAAM,IAAI,2BAA2B,CAAC,IAAI,CAAC,MAAM,CAAC;gBACxD,CAAC,CAAC,aAAa;gBACf,CAAC,CAAC,QAAQ,MAAM,2BAA2B,MAAM,IAAI,CAAC;QAC1D,KAAK,GAAG;YACN,OAAO,8CAA8C,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;QACtF;YACE,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;IAC1B,CAAC;AACH,CAAC;AAED,iHAAiH;AAC1G,KAAK,UAAU,oBAAoB,CACxC,MAAc,EACd,OAAoC,EACpC,WAA2B;IAE3B,YAAY,CAAC,MAAM,CAAC,CAAC;IACrB,MAAM,IAAI,GAA0C,EAAE,CAAC;IACvD,IAAI,OAAO,CAAC,KAAK;QAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACrC,IAAI,OAAO,CAAC,MAAM;QAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IACvC,MAAM,GAAG,GAAG,cAAQ,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,OAAO,CAC9B,MAAM,EAAE,2BAA2B,MAAM,uBAAuB,EAAE,IAAI,CACvE,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,0FAA0F;AACnF,KAAK,UAAU,gBAAgB,CACpC,MAAc,EACd,IAAY,EACZ,WAA2B;IAE3B,YAAY,CAAC,MAAM,CAAC,CAAC;IACrB,MAAM,QAAQ,GAAG,IAAA,wCAAiC,EAAC,IAAI,CAAC,CAAC;IACzD,MAAM,KAAK,GAAG,MAAM,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAA4B,EAAE,EAAE;QACxE,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,6BAA6B,IAAI,EAAE,CAAC,CAAC,CAAC,yBAAyB,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACrI,CAAC,CAAC,CAAC;IACH,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,cAAc,IAAI,YAAY,CAAC,CAAC;IACxE,IAAI,KAAK,CAAC,MAAM,GAAG,gCAAwB,EAAE,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,cAAc,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,sBAAsB,gCAAwB,GAAG,OAAO,MAAM,CAAC,CAAC;IAC/I,CAAC;IACD,MAAM,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,cAAc,IAAI,8DAA8D,CAAC,CAAC;IAC/G,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,cAAc,IAAI,WAAW,QAAQ,kBAAkB,MAAM,uCAAuC,CAAC,CAAC;IACxH,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;IAC5B,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,IAAA,oBAAQ,EAAC,IAAI,CAAC,CAAC,CAAC;IACvF,OAAO,cAAQ,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,aAAa,CACvD,KAAK,EAAE,2BAA2B,MAAM,YAAY,EAAE,IAAI,EAAE,iBAAiB,CAC9E,CAAC;AACJ,CAAC;AAED,yDAAyD;AACzD,SAAgB,yBAAyB,CAAC,MAA2D;IACnG,MAAM,QAAQ,GAA2B;QACvC,SAAS,EAAE,aAAa;QACxB,OAAO,EAAE,6DAA6D;QACtE,SAAS,EAAE,2BAA2B;QACtC,QAAQ,EAAE,UAAU;KACrB,CAAC;IACF,MAAM,KAAK,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,wBAAwB,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7K,KAAK,CAAC,IAAI,CAAC,gBAAgB,MAAM,CAAC,oBAAoB,IAAI,QAAQ,OAAO,MAAM,CAAC,YAAY,IAAI,aAAa,EAAE,CAAC,CAAC;IACjH,MAAM,OAAO,GAAG,MAAoC,CAAC;IACrD,IAAI,OAAO,CAAC,eAAe;QAAE,KAAK,CAAC,IAAI,CAAC,gBAAgB,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;IACnF,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,MAAM,GAAa,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO;YAAE,MAAM,CAAC,IAAI,CAAC,mBAAmB,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;aAChF,IAAI,OAAO,CAAC,MAAM,CAAC,gBAAgB;YAAE,MAAM,CAAC,IAAI,CAAC,mBAAmB,OAAO,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAC5G,KAAK,CAAC,IAAI,CAAC,gBAAgB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACnD,CAAC;IACD,IAAI,OAAO,CAAC,oBAAoB;QAAE,KAAK,CAAC,IAAI,CAAC,oBAAoB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;IACjG,OAAO,KAAK,CAAC;AACf,CAAC"}