@bluepic/embed 0.6.8 → 0.6.10

package/dist/util/blankImage.d.ts

@@ -0,0 +1,6 @@
+/**
+ * True when an image is fully transparent — what a canvas serialized before
+ * the engine drew anything looks like. Sampled at 32×32: cheap, and a real
+ * graphic with any visible pixel survives the downscale.
+ */
+export declare function isBlankImage(source: Blob | HTMLCanvasElement): Promise<boolean>;

package/dist/util/gallery.d.ts

@@ -38,6 +38,55 @@ export type CampaignCategory = Studio.CampaignCategory;
  * never the relative order of two given assets.
  */
 export declare function sortPortalAssetsByTitle(assets: PortalAsset[]): PortalAsset[];
+/** One rendered entry of a portal group: a template card (a name group) or an asset card, in display order. */
+export type PortalItem<T> = {
+    kind: 'template';
+    key: string;
+    templates: {
+        [k: string]: T;
+    };
+} | {
+    kind: 'asset';
+    asset: PortalAsset;
+};
+export type PortalGroup<T> = {
+    /** Display label ("Other" for the uncategorised group, "" when categories are off). */
+    category: string;
+    /** Index into `config.categories`, or `null` for the uncategorised / implicit group. */
+    categoryIndex: number | null;
+    /** Name groups, alphabetical (legacy field — prefer `items`). */
+    templatesByName: {
+        [k: string]: {
+            [k: string]: T;
+        };
+    };
+    /** Assets, alphabetical (legacy field — prefer `items`). */
+    assets: PortalAsset[];
+    /** Templates and assets in display order: alphabetical (templates, then assets) or the manual order. */
+    items: PortalItem<T>[];
+};
+export type PortalGroupingOptions = {
+    /**
+     * The RESOLVED manual order (`Studio.resolveCampaignOrder(config.order, …)`)
+     * when the campaign has one (`Studio.hasManualOrder(config)`), else omit it.
+     * Present → items render in manual order: inside a category in that category's
+     * `items` order, in the uncategorised group in this global order. Absent →
+     * the legacy alphabetical rendering, byte-for-byte.
+     */
+    order?: readonly string[] | null;
+    /** Keep categories that hold nothing (edit mode renders them with a "+" card). */
+    includeEmpty?: boolean;
+};
+/**
+ * Templates and assets of `templates` / `assets` in the order of `ids`.
+ * A name group sits where its FIRST member appears and carries all its members
+ * that are in `templates`; ids that are neither are skipped. Members missing
+ * from `ids` are appended in the legacy alphabetical order, so nothing ever
+ * disappears because the order is stale.
+ */
+export declare function orderPortalItems<T extends BaseTemplateDescriptor>(templates: {
+    [k: string]: T;
+}, assets: PortalAsset[], ids: readonly string[]): PortalItem<T>[];
 /**
  * Group templates AND assets by the campaign's categories.
  *
@@ -46,35 +95,23 @@ export declare function sortPortalAssetsByTitle(assets: PortalAsset[]): PortalAs
  * no separate order field: array position IS the order.
  *
  * Anything no category claims falls into "Other", which always renders last.
- * Categories that end up empty are dropped: an empty category is legitimate
- * while editing, but not something to render a tab for.
+ * Categories that end up empty are dropped unless `includeEmpty`: an empty
+ * category is legitimate while editing, but not something to render a tab for.
+ *
+ * Within a group, `items` is the display order — see `PortalGroupingOptions.order`.
  */
 export declare function groupPortalItemsByCategory<T extends BaseTemplateDescriptor>(templates: {
     [k: string]: T;
-}, assets: PortalAsset[] | undefined, categories: CampaignCategory[] | undefined): {
-    category: string;
-    templatesByName: {
-        [k: string]: {
-            [k: string]: T;
-        };
-    };
-    assets: {
-        id: string;
-        kind: "image" | "file";
-        title: string;
-        description: string | null;
-        category: string | null;
-        mime: string;
-        size: number;
-        filename: string;
-        previewUrl: string | null;
-        downloadUrl: string;
-        width?: number | undefined;
-        height?: number | undefined;
-        pageCount?: number | undefined;
-        documentUrl?: string | undefined;
-    }[];
-}[];
+}, assets: PortalAsset[] | undefined, categories: CampaignCategory[] | undefined, options?: PortalGroupingOptions): PortalGroup<T>[];
+/**
+ * Every template (name group) and asset as ONE flat list, ignoring categories —
+ * the selection strip / sidebar. Manual order when `order` is given (the
+ * resolved global order), else the legacy order: templates alphabetical, then
+ * assets alphabetical.
+ */
+export declare function flatPortalItems<T extends BaseTemplateDescriptor>(templates: {
+    [k: string]: T;
+}, assets: PortalAsset[] | undefined, order?: readonly string[] | null): PortalItem<T>[];
 /** The category strip: only labels that actually have something in them. */
 export declare function collectPortalCategories<T extends BaseTemplateDescriptor>(templates: {
     [k: string]: T;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bluepic/embed",
-  "version": "0.6.8",
+  "version": "0.6.10",
   "description": "Bluepic embed sdk",
   "type": "module",
   "sideEffects": false,