@crystaldesign/diva-core 26.14.0-beta.13 → 26.14.0-beta.15

package/build/types/core/src/handler/AIHandler/index.d.ts

@@ -1,60 +1,90 @@
 import { IRootStore } from '../../store/RootStore';
+export type RenderingStatus = 'queued' | 'generating' | 'done' | 'error';
+/** Why a variant or a release failed: `errorCode` tells the cases apart (e.g. CONTENT_BLOCKED, MEDIA_0010), `error` is for people. */
+export interface RenderingError {
+    errorCode: string;
+    error: string;
+}
+export interface RenderingJobVariant {
+    index: number;
+    status: RenderingStatus;
+    /** The display version: at most 1200 px, watermarked. */
+    image?: {
+        url: string;
+        mimeType: string;
+    };
+    error?: RenderingError;
+}
+export interface RenderingRelease {
+    variant: number;
+    /** slotTaken: the product's slot for the image was taken by the time it finished; the renderjob waits approved for a decision in the approval. */
+    status: 'pending' | 'done' | 'error' | 'slotTaken';
+    renderJobId?: string;
+    /** The released original. */
+    image?: {
+        url: string;
+        mimeType: string;
+    };
+    /** Once done: the name the asset got - the one the tenant's media service derived, else the one sent. */
+    fileName?: string;
+    error?: RenderingError;
+}
+/** A rendering job of diva-ai (GET /v2/renderings/jobs/{id}): the variants of its current run and its release. */
+export interface RenderingJob {
+    id: string;
+    status: RenderingStatus;
+    variants: RenderingJobVariant[];
+    release?: RenderingRelease;
+}
+/** A failed rendering call: the HTTP status, and the code and details diva-ai sends along. */
+export interface AIServiceError extends Error {
+    status: number;
+    errorCode?: string;
+    details?: unknown;
+}
 export declare class AIHandler {
     private root;
     constructor(root: IRootStore);
     private get aiService();
     private get jwt();
     private get organizationId();
-    private get organizationName();
     getPrompts(options?: {
         includeProductRooms?: boolean;
     }): Promise<any>;
-    generateImageWithReferences(data: {
-        referenceImages: string[];
-        resolution?: string;
-        promptId?: string;
-        additionalPrompt?: string;
-        model?: string;
-        engine?: 'gemini' | 'openai';
-        persistPreview?: boolean;
+    /** Starts a rendering job whose variants render in the background (POST /v2/renderings/jobs); poll it with getRenderingJob. */
+    createRenderingJob(data: {
+        /** The template; `upscale` upscales the original of `sourceVariant` of the job `sourceJobId`. */
+        promptId: string;
+        prompt?: string;
+        images?: string[];
+        sourceJobId?: string;
+        sourceVariant?: number;
+        aspectRatio?: string;
+        size?: '512' | '1K' | '2K' | '4K';
+        variants?: number;
         /** 'content-studio' marks a Content Studio generation, which diva-ai exempts from the AI limits for users who may create AI images directly. */
         useCase?: 'content-studio';
-    }, abortController?: AbortController): Promise<any>;
-    generateProductPhoto(data: {
-        referenceImages: string[];
-        previewImageId?: string;
-        resolution: string;
+    }): Promise<RenderingJob>;
+    /** Renders the job's variants again; `prompt` replaces the addition of its last run (POST /v2/renderings/jobs/{id}/rerun). */
+    rerunRenderingJob(id: string, prompt?: string): Promise<RenderingJob>;
+    getRenderingJob(id: string): Promise<RenderingJob>;
+    /**
+     * Releases a variant of a job into the media library and, with a product, onto the product (POST
+     * /v2/renderings/jobs/{id}/release): diva-media's renderjob is created right away, the upload follows once the job is done.
+     */
+    releaseRenderingJob(id: string, data: {
+        variant?: number;
         fileName: string;
-        /** Omit for a standalone photo (e.g. generated from an uploaded, non-catalog photo) — the result then isn't attached to any product. */
-        productId?: string;
-        divaNr?: string;
-        reference?: string;
-        promptId?: string;
-        additionalPrompt?: string;
-        diva3DProject?: string;
-        /** Saved on the created renderjob's `group` field, so images can be found again by campaign in the media library. */
+        /** Saved on the renderjob's `group` field, so images can be found again by campaign in the media library. */
         group?: string;
+        /** Omit for a standalone photo (e.g. generated from an uploaded, non-catalog photo) — the result then isn't attached to any product. */
+        product?: {
+            productId: string;
+        };
         /** The product medium (its ref id) the photo may replace when its slot on the product is taken. */
         replaceRef?: string;
-    }): Promise<{
-        renderJobId: string;
-    }>;
-    generatePreviewPhoto(data: {
-        referenceImages?: string[];
-        resolution?: string;
-        promptId?: string;
-        additionalPrompt?: string;
-    }): Promise<{
-        previewJobId: string;
-    }>;
-    getPreviewJob(id: string): Promise<{
-        _id: string;
-        status: 'queued' | 'generating' | 'done' | 'error';
-        fileUrl?: string;
-        mediaItemId?: string;
-        previewImageId?: string;
-        errorMessage?: string;
-    }>;
+    }): Promise<RenderingJob>;
+    private renderingCall;
     createOrder(data: {
         campaignName?: string;
         stepIndex?: number;

package/build/types/core/src/handler/AIHandler/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/handler/AIHandler/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAGnD,qBAAa,SAAS;IACR,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAEpC,OAAO,KAAK,SAAS,GAEpB;IAED,OAAO,KAAK,GAAG,GAEd;IAED,OAAO,KAAK,cAAc,GAEzB;IAED,OAAO,KAAK,gBAAgB,GAE3B;IAEK,UAAU,CAAC,OAAO,CAAC,EAAE;QAAE,mBAAmB,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAyBrE,2BAA2B,CAC/B,IAAI,EAAE;QACJ,eAAe,EAAE,MAAM,EAAE,CAAC;QAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;QAC7B,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,gJAAgJ;QAChJ,OAAO,CAAC,EAAE,gBAAgB,CAAC;KAC5B,EACD,eAAe,CAAC,EAAE,eAAe,GAChC,OAAO,CAAC,GAAG,CAAC;IAsBT,oBAAoB,CAAC,IAAI,EAAE;QAC/B,eAAe,EAAE,MAAM,EAAE,CAAC;QAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,wIAAwI;QACxI,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,qHAAqH;QACrH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,mGAAmG;QACnG,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IA0B9B,oBAAoB,CAAC,IAAI,EAAE;QAC/B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;QAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,GAAG,OAAO,CAAC;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC;IAqB/B,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;QACvC,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,QAAQ,GAAG,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;QACnD,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;IAkBI,WAAW,CAAC,IAAI,EAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAoB1G,UAAU,CACd,EAAE,EAAE,MAAM,EACV,IAAI,EAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GACxG,OAAO,CAAC,GAAG,CAAC;IAoBT,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBlC,SAAS,CAAC,KAAK,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAwBjI,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAkB5C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/handler/AIHandler/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAGnD,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;AAEzE,sIAAsI;AACtI,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,eAAe,CAAC;IACxB,yDAAyD;IACzD,KAAK,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1C,KAAK,CAAC,EAAE,cAAc,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,kJAAkJ;IAClJ,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,WAAW,CAAC;IACnD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6BAA6B;IAC7B,KAAK,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1C,yGAAyG;IACzG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,cAAc,CAAC;CACxB;AAED,kHAAkH;AAClH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,eAAe,CAAC;IACxB,QAAQ,EAAE,mBAAmB,EAAE,CAAC;IAChC,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC5B;AAED,8FAA8F;AAC9F,MAAM,WAAW,cAAe,SAAQ,KAAK;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,qBAAa,SAAS;IACR,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAEpC,OAAO,KAAK,SAAS,GAEpB;IAED,OAAO,KAAK,GAAG,GAEd;IAED,OAAO,KAAK,cAAc,GAEzB;IAEK,UAAU,CAAC,OAAO,CAAC,EAAE;QAAE,mBAAmB,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAyB3E,+HAA+H;IACzH,kBAAkB,CAAC,IAAI,EAAE;QAC7B,iGAAiG;QACjG,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,KAAK,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;QAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,gJAAgJ;QAChJ,OAAO,CAAC,EAAE,gBAAgB,CAAC;KAC5B,GAAG,OAAO,CAAC,YAAY,CAAC;IAIzB,8HAA8H;IACxH,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAIrE,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAIxD;;;OAGG;IACG,mBAAmB,CACvB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE;QACJ,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,6GAA6G;QAC7G,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,wIAAwI;QACxI,OAAO,CAAC,EAAE;YAAE,SAAS,EAAE,MAAM,CAAA;SAAE,CAAC;QAChC,mGAAmG;QACnG,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GACA,OAAO,CAAC,YAAY,CAAC;YAIV,aAAa;IAoBrB,WAAW,CAAC,IAAI,EAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAoB1G,UAAU,CACd,EAAE,EAAE,MAAM,EACV,IAAI,EAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GACxG,OAAO,CAAC,GAAG,CAAC;IAoBT,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBlC,SAAS,CAAC,KAAK,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAwBjI,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAkB5C"}

package/build/types/core/src/index.d.ts

@@ -24,6 +24,7 @@ export * from './handler/AnalyticsHandler';
 export * from './handler/OrganizationHandler';
 export * from './handler/SupportHandler';
 export * from './handler/ClientArticleHandler';
+export type { AIServiceError, RenderingError, RenderingJob, RenderingJobVariant, RenderingRelease, RenderingStatus } from './handler/AIHandler';
 export * from './elements/HelpButton';
 export { getUserAgentInfo } from './utils/analyzeUserAgent';
 export { getNativeArPlatform, isWebXrArSupported, openQuickLook } from './utils/nativeAr';

package/build/types/core/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,IAAI,MAAM,cAAc,CAAC;AAKhC,OAAO,cAAc,CAAC;AACtB,OAAO,gBAAgB,CAAC;AACxB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,SAAS,MAAM,2BAA2B,CAAC;AAClD,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,mBAAmB,MAAM,uBAAuB,CAAC;AAExD,OAAO,EAAE,mBAAmB,EAAE,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,6BAA6B,CAAC;AAC5C,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC1F,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACtC,YAAY,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAErF,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;AACxF,cAAc,gCAAgC,CAAC;AAC/C,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uBAAuB,CAAC;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC1F,YAAY,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACzD,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,IAAI,EAAE,CAAC;AAEhB,eAAe,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,IAAI,MAAM,cAAc,CAAC;AAKhC,OAAO,cAAc,CAAC;AACtB,OAAO,gBAAgB,CAAC;AACxB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,SAAS,MAAM,2BAA2B,CAAC;AAClD,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,mBAAmB,MAAM,uBAAuB,CAAC;AAExD,OAAO,EAAE,mBAAmB,EAAE,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,6BAA6B,CAAC;AAC5C,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC1F,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACtC,YAAY,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAErF,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;AACxF,cAAc,gCAAgC,CAAC;AAC/C,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC;AAC/C,YAAY,EAAE,cAAc,EAAE,cAAc,EAAE,YAAY,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAChJ,cAAc,uBAAuB,CAAC;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC1F,YAAY,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACzD,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,IAAI,EAAE,CAAC;AAEhB,eAAe,QAAQ,CAAC"}