@pixeasy/customizer 0.0.5-beta.0 → 0.0.7-beta.0

package/README.md

@@ -46,20 +46,31 @@ type PixeasyOpenOptions = {
 
 ### `PixeasyBuilder` events
 
-- `manifest-loaded`
-- `sdk-ready`
-- `design-change`
-- `design:created`
-- `error`
-- `closed`
+All events can be subscribed via `builder.on(name, handler)`.
+
+| Event | When it fires | Payload |
+| --- | --- | --- |
+| `manifest-loaded` | After the customizer manifest is loaded successfully for the current `productId`. | `ManifestLoadedEventDetail` |
+| `sdk-ready` | After the customizer finishes its initial load and is ready for interaction. | `SdkReadyEventDetail` |
+| `submission:success` | Fires when a submission request succeeds. | `SubmissionSuccessEventDetail` |
+| `submission:failed` | Fires when a submission request fails (API error or network/exception). | `SubmissionFailedEventDetail` |
+| `error` | When the runtime reports an error (invalid config, manifest load failure, asset load failure, or unexpected runtime error). | `ErrorEventDetail` |
+| `closed` | When you call `builder.close()` (the element is removed and listeners are detached). | `undefined` |
+
+Note: `manifest-loaded`, `sdk-ready`, `submission:success`, `submission:failed`, and `error` originate as DOM `CustomEvent`s from the `<pixeasy-customizer>` element; `closed` is emitted by `PixeasyBuilder`.
 
 Usage:
 
 ```ts
+import { SDK_EVENTS } from '@pixeasy/customizer';
+
 builder
-  .on('sdk-ready', (event) => console.log(event.productId))
-  .on('design:created', (event) => console.log(event.data.designs))
-  .on('error', (event) => console.error(event.code, event.message));
+  .on(SDK_EVENTS.MANIFEST_LOADED, (event) => console.log('manifest-loaded', event))
+  .on(SDK_EVENTS.SDK_READY, (event) => console.log(event.productId))
+  .on(SDK_EVENTS.SUBMISSION_SUCCESS, (event) => console.log(event.submissionNumber))
+  .on(SDK_EVENTS.SUBMISSION_FAILED, (event) => console.error(event.message))
+  .on(SDK_EVENTS.ERROR, (event) => console.error(event.code, event.message))
+  .on(SDK_EVENTS.CLOSED, () => console.log('closed'));
 ```
 
 ## Framework examples

package/index.d.ts

@@ -1,6 +1,7 @@
 export interface SdkElementConfig {
   apiKey: string;
   productId: string;
+  predesignId?: string;
   locale?: string;
   theme?: string;
   readonly?: boolean;
@@ -21,55 +22,59 @@ export interface SdkReadyEventDetail {
   productId: string;
 }
 
-export interface DesignChangeEventDetail {
-  productId: string;
-  placements: unknown[];
-  overlays: unknown[];
-}
-
 export interface ErrorEventDetail {
   code: 'INVALID_CONFIG' | 'MANIFEST_LOAD_FAILED' | 'ASSET_LOAD_FAILED' | 'RUNTIME_ERROR';
   message: string;
 }
 
-export interface DesignCreatedEventPayload {
-  data: {
-    productId?: string;
-    designs: unknown[];
-    overlays: unknown[];
-  };
+export interface SubmissionSuccessEventDetail {
+  productId?: string;
+  views?: string[];
+  submissionNumber: string;
+}
+
+export interface SubmissionFailedEventDetail {
+  productId?: string;
+  views?: string[];
+  message: string;
+  errors?: string[];
 }
 
-export type BuilderEventName =
-  | 'manifest-loaded'
-  | 'sdk-ready'
-  | 'design-change'
-  | 'design:created'
-  | 'error'
-  | 'closed';
+export const SDK_EVENTS: {
+  readonly MANIFEST_LOADED: 'manifest-loaded';
+  readonly SDK_READY: 'sdk-ready';
+  readonly SUBMISSION_SUCCESS: 'submission:success';
+  readonly SUBMISSION_FAILED: 'submission:failed';
+  readonly ERROR: 'error';
+  readonly CLOSED: 'closed';
+};
+
+export type BuilderEventName = (typeof SDK_EVENTS)[keyof typeof SDK_EVENTS];
+export type UrlOrText = { type: 'url'; value: string } | { type: 'text'; value: string };
+
 
 export class PixeasyBuilder {
   open(options: PixeasyOpenOptions): this;
   on<K extends BuilderEventName>(
     name: K,
     handler: (payload: {
-      'manifest-loaded': ManifestLoadedEventDetail;
-      'sdk-ready': SdkReadyEventDetail;
-      'design-change': DesignChangeEventDetail;
-      'design:created': DesignCreatedEventPayload;
-      error: ErrorEventDetail;
-      closed: undefined;
+      [typeof SDK_EVENTS.MANIFEST_LOADED]: ManifestLoadedEventDetail;
+      [typeof SDK_EVENTS.SDK_READY]: SdkReadyEventDetail;
+      [typeof SDK_EVENTS.SUBMISSION_SUCCESS]: SubmissionSuccessEventDetail;
+      [typeof SDK_EVENTS.SUBMISSION_FAILED]: SubmissionFailedEventDetail;
+      [typeof SDK_EVENTS.ERROR]: ErrorEventDetail;
+      [typeof SDK_EVENTS.CLOSED]: undefined;
     }[K]) => void,
   ): this;
   off<K extends BuilderEventName>(
     name: K,
     handler: (payload: {
-      'manifest-loaded': ManifestLoadedEventDetail;
-      'sdk-ready': SdkReadyEventDetail;
-      'design-change': DesignChangeEventDetail;
-      'design:created': DesignCreatedEventPayload;
-      error: ErrorEventDetail;
-      closed: undefined;
+      [typeof SDK_EVENTS.MANIFEST_LOADED]: ManifestLoadedEventDetail;
+      [typeof SDK_EVENTS.SDK_READY]: SdkReadyEventDetail;
+      [typeof SDK_EVENTS.SUBMISSION_SUCCESS]: SubmissionSuccessEventDetail;
+      [typeof SDK_EVENTS.SUBMISSION_FAILED]: SubmissionFailedEventDetail;
+      [typeof SDK_EVENTS.ERROR]: ErrorEventDetail;
+      [typeof SDK_EVENTS.CLOSED]: undefined;
     }[K]) => void,
   ): this;
   close(): this;
@@ -86,7 +91,7 @@ export interface GeneratedThumbnail {
 }
 
 export function generateThumbnails(
-  svgUrl: string,
-  objUrl: string,
-  mtlUrl: string,
+  svgUrl: UrlOrText,
+  objUrl: UrlOrText,
+  mtlUrl?: UrlOrText,
 ): Promise<GeneratedThumbnail[]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pixeasy/customizer",
-  "version": "0.0.5-beta.0",
+  "version": "0.0.7-beta.0",
   "type": "module",
   "license": "SEE LICENSE IN LICENSE",
   "publishConfig": {
@@ -15,7 +15,8 @@
       "import": "./pixeasy-customizer.min.js",
       "default": "./pixeasy-customizer.min.js"
     },
-    "./styles.css": "./pixeasy-customizer.css"
+    "./styles.css": "./pixeasy-customizer.css",
+    "./pixeasy-customizer.css": "./pixeasy-customizer.css"
   },
   "sideEffects": [
     "./pixeasy-customizer.min.js",