@contrail/extensions-sdk 1.0.29 → 1.0.31

package/lib/apps/boards.d.ts

@@ -20,9 +20,20 @@ export interface ClipboardItemsPayload {
 }
 /** One image in a composition, placed in fractions of the output box. */
 export interface ComposeContentLayer {
-    /** The content to draw. The host resolves it to an image, so no URL is needed - and none can
-     * expire between planning the layout and composing it. */
-    contentId: string;
+    /**
+     * The content to draw. The host resolves it to an image, so no URL is needed - and none can
+     * expire between planning the layout and composing it.
+     *
+     * Supply this or {@link fileId}, not both.
+     */
+    contentId?: string;
+    /**
+     * A file to draw, for images that exist as files without a content wrapper - the output of a
+     * background-removal operation, for instance, which returns a file id.
+     *
+     * Supply this or {@link contentId}, not both.
+     */
+    fileId?: string;
     /**
      * Top-left corner as a fraction of the composition box, so `{x: 0.5, y: 0}` is the top middle.
      *
@@ -61,6 +72,15 @@ export interface ComposeContentRequest {
     /** Defaults to transparent, which is usually what a composed pack shot wants. */
     backgroundColor?: string;
     fileName?: string;
+    /**
+     * Also make the composition the holder's primary viewable, so it is the image the entity shows
+     * everywhere - grids, cards, choosers.
+     *
+     * Off by default: composing an image and deciding it is the entity's main picture are separate
+     * intentions, and a caller adding one image among several should not silently repoint the item.
+     * A newly created set item, by contrast, has no image at all and wants this.
+     */
+    assignAsPrimaryViewable?: boolean;
 }
 export interface ComposeContentResult {
     contentId: string;
@@ -70,6 +90,8 @@ export interface ComposeContentResult {
         width: number;
         height: number;
     };
+    /** Whether the holder was repointed at this content, when it was asked for. */
+    assignedAsPrimaryViewable?: boolean;
 }
 export interface BoardDocumentElement extends DocumentElement {
     [key: string]: any;

package/lib/apps/boards.js

@@ -124,6 +124,10 @@ class BoardsApp {
             if (!(request === null || request === void 0 ? void 0 : request.contentHolderReference)) {
                 throw new Error('composeContent requires a contentHolderReference, e.g. `item:<id>`.');
             }
+            const unsourced = request.layers.findIndex((layer) => !(layer === null || layer === void 0 ? void 0 : layer.contentId) && !(layer === null || layer === void 0 ? void 0 : layer.fileId));
+            if (unsourced >= 0) {
+                throw new Error(`composeContent layer ${unsourced} needs either a contentId or a fileId.`);
+            }
             const results = yield (0, actions_1.getExtensionActions)().sendMessageToHost({
                 command: BoardCommand.COMPOSE_CONTENT,
                 data: request,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/extensions-sdk",
-  "version": "1.0.29",
+  "version": "1.0.31",
   "description": "Client library for interfacing with VibeIQ's services and apps from an extension.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",