@kittl/sdk 0.0.1 → 0.0.2

package/dist/kittl-sdk.esm.js

@@ -9,6 +9,9 @@ var isSDKResponseMessage = (data) => {
 var isStatelessPushMessage = (data) => {
   return typeof data === "object" && data !== null && "command" in data && data.command === "stateless-message" && "type" in data && typeof data.type === "string" && "payload" in data && typeof data.payload === "object" && data.payload !== null;
 };
+var isAIGenerationUpdatePushMessage = (data) => {
+  return typeof data === "object" && data !== null && "command" in data && data.command === "ai-generation-update" && "subscriptionId" in data && typeof data.subscriptionId === "string" && "update" in data && typeof data.update === "object" && data.update !== null;
+};
 
 // ../../packages/editor-core/sdk/sdk-bridge/dist/bridge/shared/createApiProxyCore.js
 var buildMethodPath = (rootPrefix, pathSegments) => {
@@ -117,8 +120,11 @@ var generateMessageId = () => {
   }
   return Math.random().toString(36).substring(7);
 };
-var sendMessage = (message) => {
+var postMessageToParent = (message) => {
   window.parent.postMessage(message, getParentDomain());
+};
+var sendMessage = (message) => {
+  postMessageToParent(message);
   return new Promise((resolve, reject) => {
     pendingRequests.set(message.messageId, {
       resolve: (value) => {
@@ -134,7 +140,7 @@ var sendLoaded = () => {
     return;
   }
   const message = { command: "loaded" };
-  parent.postMessage(message, getParentDomain());
+  postMessageToParent(message);
 };
 
 // ../../packages/editor-core/sdk/sdk-bridge/dist/bridge/sandboxed/handlers/apiProxy/index.js
@@ -197,6 +203,14 @@ function createApiProxy(apiType) {
 }
 
 // ../../packages/editor-core/sdk/sdk-bridge/dist/bridge/sandboxed/handlers/apiProxy/aiApiProxy.js
+var generationHandlers = /* @__PURE__ */ new Map();
+var dispatchAIGenerationUpdate = (subscriptionId, update) => {
+  const handler = generationHandlers.get(subscriptionId);
+  if (!handler) {
+    return;
+  }
+  void handler(update);
+};
 function createAIApiProxy() {
   return {
     spendCredits: async (options) => {
@@ -215,6 +229,51 @@ function createAIApiProxy() {
         onDecline?.();
       }
       return response;
+    },
+    startGeneration: (generatorId, inputSettings, output) => {
+      const message = {
+        command: "sdk-call",
+        dots: ["startGeneration"],
+        args: [generatorId, inputSettings, output],
+        messageId: generateMessageId(),
+        apiType: "ai"
+      };
+      return sendMessage(message);
+    },
+    registerHandler: async (generatorId, onStatusUpdate) => {
+      const subscriptionId = generateMessageId();
+      const unregister = () => {
+        generationHandlers.delete(subscriptionId);
+        const unregisterMessage = {
+          command: "ai-unregister-handler",
+          subscriptionId
+        };
+        postMessageToParent(unregisterMessage);
+      };
+      generationHandlers.set(subscriptionId, onStatusUpdate);
+      const registerMessage = {
+        command: "ai-register-handler",
+        messageId: generateMessageId(),
+        generatorId,
+        subscriptionId
+      };
+      try {
+        const response = await sendMessage(registerMessage);
+        if (!response.isOk) {
+          generationHandlers.delete(subscriptionId);
+          return response;
+        }
+        return { isOk: true, result: unregister };
+      } catch {
+        generationHandlers.delete(subscriptionId);
+        return {
+          isOk: false,
+          error: {
+            message: "Failed to register AI handler",
+            name: "SdkInternalError"
+          }
+        };
+      }
     }
   };
 }
@@ -385,6 +444,10 @@ var handleIncomingMessage = (event) => {
     statelessApi.dispatch(data.type, data.payload);
     return;
   }
+  if (isAIGenerationUpdatePushMessage(data)) {
+    dispatchAIGenerationUpdate(data.subscriptionId, data.update);
+    return;
+  }
 };
 var bridgeHandlers = {
   ai: createAIApiProxy(),

package/dist/kittl-sdk.js

@@ -10,6 +10,9 @@
   var isStatelessPushMessage = (data) => {
     return typeof data === "object" && data !== null && "command" in data && data.command === "stateless-message" && "type" in data && typeof data.type === "string" && "payload" in data && typeof data.payload === "object" && data.payload !== null;
   };
+  var isAIGenerationUpdatePushMessage = (data) => {
+    return typeof data === "object" && data !== null && "command" in data && data.command === "ai-generation-update" && "subscriptionId" in data && typeof data.subscriptionId === "string" && "update" in data && typeof data.update === "object" && data.update !== null;
+  };
 
   // ../../packages/editor-core/sdk/sdk-bridge/dist/bridge/shared/createApiProxyCore.js
   var buildMethodPath = (rootPrefix, pathSegments) => {
@@ -118,8 +121,11 @@
     }
     return Math.random().toString(36).substring(7);
   };
-  var sendMessage = (message) => {
+  var postMessageToParent = (message) => {
     window.parent.postMessage(message, getParentDomain());
+  };
+  var sendMessage = (message) => {
+    postMessageToParent(message);
     return new Promise((resolve, reject) => {
       pendingRequests.set(message.messageId, {
         resolve: (value) => {
@@ -135,7 +141,7 @@
       return;
     }
     const message = { command: "loaded" };
-    parent.postMessage(message, getParentDomain());
+    postMessageToParent(message);
   };
 
   // ../../packages/editor-core/sdk/sdk-bridge/dist/bridge/sandboxed/handlers/apiProxy/index.js
@@ -198,6 +204,14 @@
   }
 
   // ../../packages/editor-core/sdk/sdk-bridge/dist/bridge/sandboxed/handlers/apiProxy/aiApiProxy.js
+  var generationHandlers = /* @__PURE__ */ new Map();
+  var dispatchAIGenerationUpdate = (subscriptionId, update) => {
+    const handler = generationHandlers.get(subscriptionId);
+    if (!handler) {
+      return;
+    }
+    void handler(update);
+  };
   function createAIApiProxy() {
     return {
       spendCredits: async (options) => {
@@ -216,6 +230,51 @@
           onDecline?.();
         }
         return response;
+      },
+      startGeneration: (generatorId, inputSettings, output) => {
+        const message = {
+          command: "sdk-call",
+          dots: ["startGeneration"],
+          args: [generatorId, inputSettings, output],
+          messageId: generateMessageId(),
+          apiType: "ai"
+        };
+        return sendMessage(message);
+      },
+      registerHandler: async (generatorId, onStatusUpdate) => {
+        const subscriptionId = generateMessageId();
+        const unregister = () => {
+          generationHandlers.delete(subscriptionId);
+          const unregisterMessage = {
+            command: "ai-unregister-handler",
+            subscriptionId
+          };
+          postMessageToParent(unregisterMessage);
+        };
+        generationHandlers.set(subscriptionId, onStatusUpdate);
+        const registerMessage = {
+          command: "ai-register-handler",
+          messageId: generateMessageId(),
+          generatorId,
+          subscriptionId
+        };
+        try {
+          const response = await sendMessage(registerMessage);
+          if (!response.isOk) {
+            generationHandlers.delete(subscriptionId);
+            return response;
+          }
+          return { isOk: true, result: unregister };
+        } catch {
+          generationHandlers.delete(subscriptionId);
+          return {
+            isOk: false,
+            error: {
+              message: "Failed to register AI handler",
+              name: "SdkInternalError"
+            }
+          };
+        }
       }
     };
   }
@@ -386,6 +445,10 @@
       statelessApi.dispatch(data.type, data.payload);
       return;
     }
+    if (isAIGenerationUpdatePushMessage(data)) {
+      dispatchAIGenerationUpdate(data.subscriptionId, data.update);
+      return;
+    }
   };
   var bridgeHandlers = {
     ai: createAIApiProxy(),

package/dist/sdk.d.ts

@@ -193,6 +193,12 @@ declare const GUIDE_DEFAULT_VALUES: {
 	version: string;
 	type: ObjectType.Guide;
 };
+declare const GenerationStatus: {
+	readonly CREATED: "CREATED";
+	readonly STARTED: "STARTED";
+	readonly COMPLETE: "COMPLETE";
+	readonly FAILED: "FAILED";
+};
 declare const ILLUSTRATION_DEFAULT_VALUES: {
 	hiddenColors?: Record<string, NonNullable<Color>> | undefined;
 	clipPathMaskId?: string | undefined | null;
@@ -349,6 +355,11 @@ declare const RICH_TEXT_DEFAULT_VALUES: {
 	version: string;
 	type: ObjectType.RichText;
 };
+declare const ResultType: {
+	readonly VIDEO: "video";
+	readonly IMAGE: "image";
+	readonly ERROR: "error";
+};
 declare const backgroundType = "background";
 declare const clippingMaskType = "clippingMask";
 declare const pathType = "path";
@@ -523,8 +534,22 @@ declare global {
 	}
 }
 export declare const kittl: KittlSDK;
-export interface AIAPI {
-	spendCredits: (options: SpendCreditsOptions) => SdkResultAsync<SpendCreditsResult, Error>;
+export interface AIGenerationInputSettings {
+	prompt: string;
+	taskType?: AIGenerationModelTaskType;
+	promptStyleId?: number;
+	model: {
+		id: string;
+	};
+	additionalParams?: Record<string, unknown>;
+	type: AIGenerationContentType;
+}
+export interface AIGenerationOutputSettings {
+	id?: string;
+	dimensions: {
+		width: number;
+		height: number;
+	};
 }
 export interface AppStateAPI {
 	getSelectedObjectsIds(): string[];
@@ -546,7 +571,10 @@ export interface AppStateAPI {
 	setHighlightedObjectId(id: string | null): void;
 	setMany(fields: Partial<AppState>, origin?: Origin): void;
 }
-export interface AsyncAIAPI extends WithAsync<AIAPI> {
+export interface AsyncAIAPI {
+	spendCredits: (options: SpendCreditsOptions) => SdkResultAsync<SpendCreditsResult, Error>;
+	startGeneration: (generatorId: string, inputSettings: AIGenerationInputSettings, output: AIGenerationOutputSettings) => SdkResultAsync<StartGenerationResult, Error>;
+	registerHandler: (generatorId: string, onStatusUpdate: OnGenerationStatusUpdate) => SdkResultAsync<() => void, Error>;
 }
 export interface AsyncAppStateAPI extends WithAsync<AppStateAPI> {
 }
@@ -746,6 +774,11 @@ export interface DragAndDropStartDragImageEventInput {
 	img: HTMLImageElement;
 	persistImage?: boolean;
 }
+export interface ErrorGenerationResult {
+	type: typeof ResultType.ERROR;
+	message: string;
+	code?: string;
+}
 export interface FontAPI {
 	createFont: (params: {
 		name: string;
@@ -771,10 +804,22 @@ export interface GeneratableObject {
 		generatorKey: string;
 	};
 }
+export interface GenerationInputData {
+	prompt?: string;
+	style?: {
+		id: number;
+	};
+	model?: {
+		id: string;
+	};
+}
 export interface GenerationMeta {
 	generationEndsAt?: number;
 	pendingGenerationId: string;
 }
+export interface GenerationStartedResultCommonProps {
+	generationEndsAt?: number;
+}
 export interface GetExportOptions {
 	format: "png" | "jpg" | "pdf" | "svg" | "mp4";
 	target: {
@@ -853,6 +898,13 @@ export interface ImageAPI {
 	addImage(params: AddImageParams, opts?: DesignApiOptions): SdkResultAsync<NormalizedIllustrationImageObject, SdkError>;
 	updateImage(params: UpdateImageParams, opts?: DesignApiOptions): NormalizedIllustrationImageObject;
 }
+export interface ImageGenerationResult {
+	type: typeof ResultType.IMAGE;
+	objectName: string;
+}
+export interface ImageGenerationStartedResult extends GenerationStartedResultCommonProps {
+	type: typeof ResultType.IMAGE;
+}
 export interface KittlContext {
 	dragAndDrop: {
 		offset: DragAndDropOffset;
@@ -1003,8 +1055,12 @@ export interface SpendCreditsResult {
 }
 export interface StandardArtboardOptions extends BaseStandardArtboardOptions<ObjectType.Artboard> {
 }
+export interface StartGenerationResult {
+	generationId: string;
+}
 export interface StateAPI {
 	implementSubState(params: Partial<NormalizedDesignState>, opts?: DesignApiOptions): Partial<NormalizedDesignState>;
+	getState(): NormalizedDesignState;
 }
 export interface StructureObjectMeta {
 	name?: string;
@@ -1077,6 +1133,17 @@ export interface VideoAPI {
 	removePlaylistItem(params: RemoveVideoPlaylistItemParams, opts?: DesignApiOptions): NormalizedVideoObject;
 	updatePlaylistItem(params: UpdateVideoPlaylistItemParams, opts?: DesignApiOptions): Promise<NormalizedVideoObject>;
 }
+export interface VideoGenerationResult {
+	type: typeof ResultType.VIDEO;
+	status: "PROCESSING" | "READY" | "FAILED";
+	playbackId?: string;
+	duration?: number;
+	aspectRatio?: string;
+	hostingProvider?: "MUX";
+}
+export interface VideoGenerationStartedResult extends GenerationStartedResultCommonProps {
+	type: typeof ResultType.VIDEO;
+}
 export interface VideoboardAPI {
 	addVideoboard(params: AddVideoboardParams, opts?: DesignApiOptions): Promise<NormalizedStandardBoard<VideoboardOptions>>;
 	setVideoOnVideoboard(params: SetVideoOnVideoboardParams, opts?: DesignApiOptions): Promise<NormalizedStandardBoard<VideoboardOptions>>;
@@ -1101,6 +1168,8 @@ export interface WithObjectLayout {
 	flipX: boolean;
 	flipY: boolean;
 }
+export type AIGenerationContentType = "image" | "video";
+export type AIGenerationModelTaskType = "IMAGE_TO_IMAGE" | "IMAGE_INPAINT" | "TEXT_TO_IMAGE" | "IMAGE_TO_VIDEO";
 export type APIOptions<T extends Record<string, unknown>> = {
 	batchClient?: BatchClient<T>;
 } | {
@@ -1297,6 +1366,28 @@ export type FullColor = {
 	visible: boolean;
 };
 export type FunctionType = (...args: never) => unknown;
+export type GenerationStatus = (typeof GenerationStatus)[keyof typeof GenerationStatus];
+export type GenerationStatusUpdate = {
+	generationId: string;
+	status: typeof GenerationStatus.CREATED;
+	inputData: undefined;
+	result: undefined;
+} | {
+	generationId: string;
+	status: typeof GenerationStatus.STARTED;
+	inputData: GenerationInputData;
+	result: StartedGenerationResult;
+} | {
+	generationId: string;
+	status: typeof GenerationStatus.COMPLETE;
+	inputData: GenerationInputData;
+	result: SuccessGenerationResult;
+} | {
+	generationId: string;
+	status: typeof GenerationStatus.FAILED;
+	inputData: GenerationInputData | undefined;
+	result: ErrorGenerationResult;
+};
 export type GuideSerializedObject = typeof GUIDE_DEFAULT_VALUES & OrientationDir;
 export type ID = string;
 export type IllustrationImageSerializedObject = typeof DEFAULT_VALUES$1 & {
@@ -1439,6 +1530,7 @@ export type NormalizedVideoObject = Normalized<VideoSerializedObject>;
 export type NullablePathTextShadowOptions = PathTextShadowOptions | {
 	type: null;
 };
+export type OnGenerationStatusUpdate = (update: GenerationStatusUpdate) => void | Promise<void>;
 export type OrientationConditional = {
 	orientation: Orientation.HORIZONTAL;
 	top: number;
@@ -1541,6 +1633,7 @@ export type RenameParams = {
 	objectId: string;
 	newName: string;
 };
+export type ResultType = (typeof ResultType)[keyof typeof ResultType];
 export type RichTextBasePluginSerializedObject = {
 	id: string;
 	name: string;
@@ -1666,6 +1759,7 @@ export type SmartboardOptions = ConnectedArtboardOptions<ObjectType.Smartboard>
 } & GeneratableBoard<SmartboardGenerationSettings>;
 export type SmartboardQuality = "auto" | "high" | "medium" | "low";
 export type StandardSerializedObject = BasicShapeSerializedObject | CombinedShapeSerializedObject | IllustrationImageSerializedObject | IllustrationSerializedObject | LoadingCardSerializedObject | MaskSerializedObject | MockupDesignSerializedObject | PathTextSerializedObject | RichTextSerializedObject | VideoSerializedObject;
+export type StartedGenerationResult = VideoGenerationStartedResult | ImageGenerationStartedResult;
 export type StateGradientInfo = {
 	[key: string]: GradientInfo;
 };
@@ -1676,6 +1770,7 @@ export type StringColor = {
 };
 export type StringColorKeysType = (typeof stringColorKeys)[number];
 export type StructureObjectId = string;
+export type SuccessGenerationResult = VideoGenerationResult | ImageGenerationResult;
 export type TempUserImageUpload = {
 	objectId: string;
 	mimeType: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kittl/sdk",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "license": "Apache-2.0",
   "private": false,
   "type": "module",