@extenshi/cli 0.20.0 → 0.22.0

package/dist/store-assets.d.ts

@@ -0,0 +1,139 @@
+/**
+ * `extenshi icon store-assets <source>` — the store LISTING artwork each store
+ * asks for, rendered offline from one .svg / .png source.
+ *
+ * `icon preview` covers the toolbar sizes inside the package (16/32/48/128);
+ * this covers what the store dashboards ask for next to it: the Chrome Web
+ * Store promo tile and marquee, the Edge Add-ons logo and tiles, the AMO icon.
+ * Same source validation (readIconSource / svg-scrub) as the preview.
+ *
+ * Rendering is resvg compiled to WebAssembly (@resvg/resvg-wasm): no native
+ * module, no browser, no network. It is imported lazily so no other command
+ * pays for loading it.
+ *
+ * Sizes are the stores' own numbers; each spec carries the page it came from.
+ * The screenshot sizes used by `extenshi screenshots` live here too, so there is
+ * one table of store image requirements in the CLI.
+ */
+import { type IconSource } from './icon.js';
+/** https://developer.chrome.com/docs/webstore/images */
+export declare const CWS_IMAGES_DOC = "https://developer.chrome.com/docs/webstore/images";
+/** https://learn.microsoft.com/en-us/microsoft-edge/extensions/publish/publish-extension (Step 7, store listing) */
+export declare const EDGE_LISTING_DOC = "https://learn.microsoft.com/en-us/microsoft-edge/extensions/publish/publish-extension#step-7-enter-store-listing-details-for-each-language";
+/** https://mozilla.github.io/addons-server/topics/api/addons.html#addon-icon — square PNG/JPEG, 128×128 recommended; AMO derives 32/64/128. */
+export declare const AMO_ICON_DOC = "https://mozilla.github.io/addons-server/topics/api/addons.html#addon-icon";
+/** https://extensionworkshop.com/documentation/develop/create-an-appealing-listing/ — screenshots 1280×800 (1.6:1). */
+export declare const AMO_LISTING_DOC = "https://extensionworkshop.com/documentation/develop/create-an-appealing-listing/";
+/** https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/icons — 32 px default, 2× for HiDPI. */
+export declare const MDN_ICONS_DOC = "https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/icons";
+export declare const STORES: readonly ["chrome", "edge", "firefox"];
+export type StoreId = (typeof STORES)[number];
+export interface Size {
+    width: number;
+    height: number;
+}
+/**
+ * Listing screenshots. All three stores take 1280×800, so one capture serves
+ * every store at the default size; `small` is each store's other accepted size.
+ */
+export declare const STORE_SCREENSHOT_SPECS: Record<StoreId, {
+    large: Size;
+    small: Size;
+    max: number | null;
+    doc: string;
+    note: string;
+}>;
+export type AssetKind = 'icon' | 'logo' | 'promo' | 'marquee';
+export interface StoreAssetSpec extends Size {
+    store: StoreId;
+    id: string;
+    file: string;
+    kind: AssetKind;
+    required: boolean;
+    /** Artwork box as a fraction of the canvas (icons/logos) — the transparent margin is the rest. */
+    artwork?: number;
+    note: string;
+    doc: string;
+}
+export declare const STORE_ASSET_SPECS: readonly StoreAssetSpec[];
+export declare function parseStores(value: string | undefined): StoreId[];
+type ResvgModule = typeof import('@resvg/resvg-wasm');
+export declare function loadResvg(): Promise<ResvgModule>;
+export interface Raster {
+    width: number;
+    height: number;
+    pixels: Uint8Array;
+    png: Uint8Array;
+}
+export declare function renderSvg(svg: string, width: number, fontBuffers?: Uint8Array[]): Promise<Raster>;
+export interface SourceInfo extends Size {
+    /** The user-coordinate system of an SVG source (its viewBox, or 0 0 w h). */
+    viewBox: Box;
+    /** Some painted content lies outside the canvas (and would be cut off). */
+    overflow: boolean;
+}
+/** Intrinsic size, user coordinates and (for SVG) whether content overflows the canvas. */
+export declare function sourceInfo(source: IconSource, fontBuffers?: Uint8Array[]): Promise<SourceInfo>;
+/** Map a box in rendered-canvas pixels of a source to its user coordinates (xMidYMid meet). */
+export declare function canvasToUser(box: Box, info: SourceInfo): Box;
+export interface Box {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+/** Bounding box of pixels with alpha > threshold, or null for a fully transparent image. */
+export declare function alphaBoundingBox(pixels: Uint8Array, width: number, height: number, threshold?: number): Box | null;
+/** Alpha-weighted average colour of the opaque artwork, as #rrggbb. */
+export declare function dominantColor(pixels: Uint8Array): string;
+/** Mix a #rrggbb colour toward white by `t` (0 = colour, 1 = white). */
+export declare function tint(color: string, t: number): string;
+/**
+ * resvg in WebAssembly cannot see system fonts, so text in a source SVG would
+ * silently vanish. Load only the files whose names match the families the SVG
+ * asks for (plus a common sans fallback) — not the whole font directory.
+ */
+export declare function fontsForSvg(svg: string, extraFiles?: string[]): {
+    buffers: Uint8Array[];
+    files: string[];
+};
+export interface StoreAssetsOptions {
+    /** Comma-separated stores (default all). */
+    store?: string;
+    /** Output directory (default ./store-assets). */
+    out?: string;
+    /** Background for promo tiles/marquee (default: a light tint of the artwork colour). */
+    background?: string;
+    /** Background for icons/logos (default transparent). */
+    iconBackground?: string;
+    /** Full-bleed artwork for the 440×280 tiles (else composed from the icon). */
+    promo?: string;
+    /** Full-bleed artwork for the 1400×560 tiles (else composed from the icon). */
+    marquee?: string;
+    /** Extra font files for text in SVG sources. */
+    font?: string[];
+}
+export interface RenderedAsset {
+    store: StoreId;
+    id: string;
+    file: string;
+    path: string;
+    width: number;
+    height: number;
+    bytes: number;
+    sha256: string;
+    required: boolean;
+    doc: string;
+}
+export interface StoreAssetsResult {
+    outDir: string;
+    assets: RenderedAsset[];
+    warnings: string[];
+}
+/** Render every requested store's listing artwork. Exported for tests. */
+export declare function renderStoreAssets(iconPath: string, opts?: StoreAssetsOptions): Promise<StoreAssetsResult>;
+export declare function runStoreAssets(iconPath: string, opts: StoreAssetsOptions & {
+    json?: boolean;
+}): Promise<void>;
+export {};
+//# sourceMappingURL=store-assets.d.ts.map

package/dist/store-assets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store-assets.d.ts","sourceRoot":"","sources":["../src/store-assets.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AASH,OAAO,EAAE,KAAK,UAAU,EAAkB,MAAM,WAAW,CAAA;AAI3D,wDAAwD;AACxD,eAAO,MAAM,cAAc,sDAAsD,CAAA;AACjF,oHAAoH;AACpH,eAAO,MAAM,gBAAgB,+IACgH,CAAA;AAC7I,+IAA+I;AAC/I,eAAO,MAAM,YAAY,8EAA8E,CAAA;AACvG,uHAAuH;AACvH,eAAO,MAAM,eAAe,qFACuD,CAAA;AACnF,gIAAgI;AAChI,eAAO,MAAM,aAAa,+FACmE,CAAA;AAE7F,eAAO,MAAM,MAAM,wCAAyC,CAAA;AAC5D,MAAM,MAAM,OAAO,GAAG,CAAC,OAAO,MAAM,CAAC,CAAC,MAAM,CAAC,CAAA;AAE7C,MAAM,WAAW,IAAI;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACd;AAED;;;GAGG;AACH,eAAO,MAAM,sBAAsB,EAAE,MAAM,CAC1C,OAAO,EACP;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,IAAI,CAAC;IAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CA0B3E,CAAA;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAA;AAE7D,MAAM,WAAW,cAAe,SAAQ,IAAI;IAC3C,KAAK,EAAE,OAAO,CAAA;IACd,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,SAAS,CAAA;IACf,QAAQ,EAAE,OAAO,CAAA;IACjB,kGAAkG;IAClG,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;CACX;AAED,eAAO,MAAM,iBAAiB,EAAE,SAAS,cAAc,EA2GtD,CAAA;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,EAAE,CAchE;AAID,KAAK,WAAW,GAAG,cAAc,mBAAmB,CAAC,CAAA;AAGrD,wBAAgB,SAAS,IAAI,OAAO,CAAC,WAAW,CAAC,CAQhD;AAED,MAAM,WAAW,MAAM;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,UAAU,CAAA;IAClB,GAAG,EAAE,UAAU,CAAA;CACf;AAED,wBAAsB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,GAAE,UAAU,EAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAgB3G;AAED,MAAM,WAAW,UAAW,SAAQ,IAAI;IACvC,6EAA6E;IAC7E,OAAO,EAAE,GAAG,CAAA;IACZ,2EAA2E;IAC3E,QAAQ,EAAE,OAAO,CAAA;CACjB;AAaD,2FAA2F;AAC3F,wBAAsB,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,GAAE,UAAU,EAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAyBxG;AAED,+FAA+F;AAC/F,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,GAAG,GAAG,CAW5D;AAcD,MAAM,WAAW,GAAG;IACnB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACd;AAED,4FAA4F;AAC5F,wBAAgB,gBAAgB,CAC/B,MAAM,EAAE,UAAU,EAClB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,SAAS,SAAI,GACX,GAAG,GAAG,IAAI,CAgBZ;AAED,uEAAuE;AACvE,wBAAgB,aAAa,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAkBxD;AAED,wEAAwE;AACxE,wBAAgB,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CASrD;AAwCD;;;;GAIG;AACH,wBAAgB,WAAW,CAC1B,GAAG,EAAE,MAAM,EACX,UAAU,GAAE,MAAM,EAAO,GACvB;IAAE,OAAO,EAAE,UAAU,EAAE,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CAAE,CAoD5C;AA6CD,MAAM,WAAW,kBAAkB;IAClC,4CAA4C;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,iDAAiD;IACjD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,wFAAwF;IACxF,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,wDAAwD;IACxD,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,8EAA8E;IAC9E,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,+EAA+E;IAC/E,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,gDAAgD;IAChD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CACf;AAED,MAAM,WAAW,aAAa;IAC7B,KAAK,EAAE,OAAO,CAAA;IACd,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,OAAO,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;CACX;AAED,MAAM,WAAW,iBAAiB;IACjC,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,aAAa,EAAE,CAAA;IACvB,QAAQ,EAAE,MAAM,EAAE,CAAA;CAClB;AAwBD,0EAA0E;AAC1E,wBAAsB,iBAAiB,CACtC,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,kBAAuB,GAC3B,OAAO,CAAC,iBAAiB,CAAC,CA6G5B;AAED,wBAAsB,cAAc,CACnC,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,kBAAkB,GAAG;IAAE,IAAI,CAAC,EAAE,OAAO,CAAA;CAAE,GAC3C,OAAO,CAAC,IAAI,CAAC,CAef"}