@wix/editor-application 1.308.0 → 1.315.0

package/dist/types/environment-api/index.d.ts

@@ -3,25 +3,57 @@ import { IPlatformPrivateEvent, IPlatformAppEvent } from '@wix/public-editor-pla
 type IPrivateAPIFixMe = any;
 type IApplicationSpec = any;
 
-declare const PLATFORM_FRAME_API_TYPE = "PLATFORM_FRAME_API";
-declare class PlatformFrameAPI {
+declare enum PlatformConsumerEnvironmentAPIType {
+    Frame = "PLATFORM_FRAME_API",
+    Worker = "PLATFORM_WORKER_API"
+}
+/**
+ * rename these entities -> API to Env
+ */
+declare abstract class AbstractEnvironmentAPI<TEnv extends PlatformConsumerEnvironmentAPIType> {
+    protected env: TEnv;
+    /**
+     * NOTE: we can't `type` declare getter within current abstract class
+     * because then after transferring API between threads this getter becomes promise,
+     * which is not expected
+     *
+     *   get type() {
+     *     return this.env;
+     *   }
+     */
+    abstract type: TEnv;
+    protected constructor(env: TEnv);
+    abstract create(): void;
+    abstract initEnvironment(props: unknown): void;
+}
+
+declare class PlatformFrameAPI extends AbstractEnvironmentAPI<PlatformConsumerEnvironmentAPIType.Frame> {
     #private;
-    type: string;
-    initFrameEnvironment(appDefinitionId: string, privateAPI: IPrivateAPIFixMe, applicationPrivateAPI: any): Promise<void>;
+    type: PlatformConsumerEnvironmentAPIType.Frame;
+    constructor();
+    create(): void;
+    initEnvironment(props: {
+        appDefinitionId: string;
+        privateAPI: IPrivateAPIFixMe;
+        applicationPrivateAPI: any;
+    }): Promise<void>;
     notify(event: IPlatformPrivateEvent): void;
     subscribe(cb: (event: IPlatformAppEvent) => void): void;
 }
 
-declare const PLATFORM_WORKER_API_TYPE = "PLATFORM_WORKER_API";
-declare class PlatformWorkerAPI {
+declare class PlatformWorkerAPI extends AbstractEnvironmentAPI<PlatformConsumerEnvironmentAPIType.Worker> {
     #private;
-    type: string;
-    initWorkerEnvironment(buildPrivateAPI: (config: any) => IPrivateAPIFixMe): Promise<void>;
+    type: PlatformConsumerEnvironmentAPIType.Worker;
+    constructor();
+    create(): void;
+    initEnvironment(props: {
+        buildPrivateAPI: (config: any) => IPrivateAPIFixMe;
+    }): Promise<void>;
     notify(event: IPlatformPrivateEvent): Promise<void>;
     subscribe(cb: (event: IPlatformAppEvent) => void): void;
     runApplication(app: IApplicationSpec): Promise<void>;
     waitReady(): Promise<this>;
 }
 
-export { PLATFORM_FRAME_API_TYPE, PLATFORM_WORKER_API_TYPE, PlatformFrameAPI, PlatformWorkerAPI };
+export { PlatformConsumerEnvironmentAPIType, PlatformFrameAPI, PlatformWorkerAPI };
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts

@@ -229,25 +229,57 @@ declare class WixEditorPlatformAddon<TPublicAPI = unknown, TPrivateAPI = unknown
     private registerToolsPanel;
 }
 
-declare const PLATFORM_FRAME_API_TYPE = "PLATFORM_FRAME_API";
-declare class PlatformFrameAPI {
+declare enum PlatformConsumerEnvironmentAPIType {
+    Frame = "PLATFORM_FRAME_API",
+    Worker = "PLATFORM_WORKER_API"
+}
+/**
+ * rename these entities -> API to Env
+ */
+declare abstract class AbstractEnvironmentAPI<TEnv extends PlatformConsumerEnvironmentAPIType> {
+    protected env: TEnv;
+    /**
+     * NOTE: we can't `type` declare getter within current abstract class
+     * because then after transferring API between threads this getter becomes promise,
+     * which is not expected
+     *
+     *   get type() {
+     *     return this.env;
+     *   }
+     */
+    abstract type: TEnv;
+    protected constructor(env: TEnv);
+    abstract create(): void;
+    abstract initEnvironment(props: unknown): void;
+}
+
+declare class PlatformFrameAPI extends AbstractEnvironmentAPI<PlatformConsumerEnvironmentAPIType.Frame> {
     #private;
-    type: string;
-    initFrameEnvironment(appDefinitionId: string, privateAPI: IPrivateAPIFixMe, applicationPrivateAPI: any): Promise<void>;
+    type: PlatformConsumerEnvironmentAPIType.Frame;
+    constructor();
+    create(): void;
+    initEnvironment(props: {
+        appDefinitionId: string;
+        privateAPI: IPrivateAPIFixMe;
+        applicationPrivateAPI: any;
+    }): Promise<void>;
     notify(event: IPlatformPrivateEvent): void;
     subscribe(cb: (event: IPlatformAppEvent) => void): void;
 }
 
-declare const PLATFORM_WORKER_API_TYPE = "PLATFORM_WORKER_API";
-declare class PlatformWorkerAPI {
+declare class PlatformWorkerAPI extends AbstractEnvironmentAPI<PlatformConsumerEnvironmentAPIType.Worker> {
     #private;
-    type: string;
-    initWorkerEnvironment(buildPrivateAPI: (config: any) => IPrivateAPIFixMe): Promise<void>;
+    type: PlatformConsumerEnvironmentAPIType.Worker;
+    constructor();
+    create(): void;
+    initEnvironment(props: {
+        buildPrivateAPI: (config: any) => IPrivateAPIFixMe;
+    }): Promise<void>;
     notify(event: IPlatformPrivateEvent): Promise<void>;
     subscribe(cb: (event: IPlatformAppEvent) => void): void;
     runApplication(app: IApplicationSpec): Promise<void>;
     waitReady(): Promise<this>;
 }
 
-export { ApplicationType, EditorPlatformApplication, type IApplicationAPI, type IApplicationSpec, type IPrivateAPIFixMe, PLATFORM_FRAME_API_TYPE, PLATFORM_WORKER_API_TYPE, PlatformFrameAPI, PlatformWorkerAPI, WixEditorPlatformAddon, WixEditorPlatformApplication };
+export { ApplicationType, EditorPlatformApplication, type IApplicationAPI, type IApplicationSpec, type IPrivateAPIFixMe, PlatformConsumerEnvironmentAPIType, PlatformFrameAPI, PlatformWorkerAPI, WixEditorPlatformAddon, WixEditorPlatformApplication };
 //# sourceMappingURL=index.d.ts.map

package/dist/types/platform-frame/index.d.ts

@@ -3,25 +3,57 @@ import { IPlatformPrivateEvent, IPlatformAppEvent } from '@wix/public-editor-pla
 type IPrivateAPIFixMe = any;
 type IApplicationSpec = any;
 
-declare const PLATFORM_FRAME_API_TYPE = "PLATFORM_FRAME_API";
-declare class PlatformFrameAPI {
+declare enum PlatformConsumerEnvironmentAPIType {
+    Frame = "PLATFORM_FRAME_API",
+    Worker = "PLATFORM_WORKER_API"
+}
+/**
+ * rename these entities -> API to Env
+ */
+declare abstract class AbstractEnvironmentAPI<TEnv extends PlatformConsumerEnvironmentAPIType> {
+    protected env: TEnv;
+    /**
+     * NOTE: we can't `type` declare getter within current abstract class
+     * because then after transferring API between threads this getter becomes promise,
+     * which is not expected
+     *
+     *   get type() {
+     *     return this.env;
+     *   }
+     */
+    abstract type: TEnv;
+    protected constructor(env: TEnv);
+    abstract create(): void;
+    abstract initEnvironment(props: unknown): void;
+}
+
+declare class PlatformFrameAPI extends AbstractEnvironmentAPI<PlatformConsumerEnvironmentAPIType.Frame> {
     #private;
-    type: string;
-    initFrameEnvironment(appDefinitionId: string, privateAPI: IPrivateAPIFixMe, applicationPrivateAPI: any): Promise<void>;
+    type: PlatformConsumerEnvironmentAPIType.Frame;
+    constructor();
+    create(): void;
+    initEnvironment(props: {
+        appDefinitionId: string;
+        privateAPI: IPrivateAPIFixMe;
+        applicationPrivateAPI: any;
+    }): Promise<void>;
     notify(event: IPlatformPrivateEvent): void;
     subscribe(cb: (event: IPlatformAppEvent) => void): void;
 }
 
-declare const PLATFORM_WORKER_API_TYPE = "PLATFORM_WORKER_API";
-declare class PlatformWorkerAPI {
+declare class PlatformWorkerAPI extends AbstractEnvironmentAPI<PlatformConsumerEnvironmentAPIType.Worker> {
     #private;
-    type: string;
-    initWorkerEnvironment(buildPrivateAPI: (config: any) => IPrivateAPIFixMe): Promise<void>;
+    type: PlatformConsumerEnvironmentAPIType.Worker;
+    constructor();
+    create(): void;
+    initEnvironment(props: {
+        buildPrivateAPI: (config: any) => IPrivateAPIFixMe;
+    }): Promise<void>;
     notify(event: IPlatformPrivateEvent): Promise<void>;
     subscribe(cb: (event: IPlatformAppEvent) => void): void;
     runApplication(app: IApplicationSpec): Promise<void>;
     waitReady(): Promise<this>;
 }
 
-export { PLATFORM_FRAME_API_TYPE, PLATFORM_WORKER_API_TYPE, PlatformFrameAPI, PlatformWorkerAPI };
+export { PlatformConsumerEnvironmentAPIType, PlatformFrameAPI, PlatformWorkerAPI };
 //# sourceMappingURL=index.d.ts.map

package/dist/types/platform-frame-api/index.d.ts

@@ -3,25 +3,57 @@ import { IPlatformPrivateEvent, IPlatformAppEvent } from '@wix/public-editor-pla
 type IPrivateAPIFixMe = any;
 type IApplicationSpec = any;
 
-declare const PLATFORM_FRAME_API_TYPE = "PLATFORM_FRAME_API";
-declare class PlatformFrameAPI {
+declare enum PlatformConsumerEnvironmentAPIType {
+    Frame = "PLATFORM_FRAME_API",
+    Worker = "PLATFORM_WORKER_API"
+}
+/**
+ * rename these entities -> API to Env
+ */
+declare abstract class AbstractEnvironmentAPI<TEnv extends PlatformConsumerEnvironmentAPIType> {
+    protected env: TEnv;
+    /**
+     * NOTE: we can't `type` declare getter within current abstract class
+     * because then after transferring API between threads this getter becomes promise,
+     * which is not expected
+     *
+     *   get type() {
+     *     return this.env;
+     *   }
+     */
+    abstract type: TEnv;
+    protected constructor(env: TEnv);
+    abstract create(): void;
+    abstract initEnvironment(props: unknown): void;
+}
+
+declare class PlatformFrameAPI extends AbstractEnvironmentAPI<PlatformConsumerEnvironmentAPIType.Frame> {
     #private;
-    type: string;
-    initFrameEnvironment(appDefinitionId: string, privateAPI: IPrivateAPIFixMe, applicationPrivateAPI: any): Promise<void>;
+    type: PlatformConsumerEnvironmentAPIType.Frame;
+    constructor();
+    create(): void;
+    initEnvironment(props: {
+        appDefinitionId: string;
+        privateAPI: IPrivateAPIFixMe;
+        applicationPrivateAPI: any;
+    }): Promise<void>;
     notify(event: IPlatformPrivateEvent): void;
     subscribe(cb: (event: IPlatformAppEvent) => void): void;
 }
 
-declare const PLATFORM_WORKER_API_TYPE = "PLATFORM_WORKER_API";
-declare class PlatformWorkerAPI {
+declare class PlatformWorkerAPI extends AbstractEnvironmentAPI<PlatformConsumerEnvironmentAPIType.Worker> {
     #private;
-    type: string;
-    initWorkerEnvironment(buildPrivateAPI: (config: any) => IPrivateAPIFixMe): Promise<void>;
+    type: PlatformConsumerEnvironmentAPIType.Worker;
+    constructor();
+    create(): void;
+    initEnvironment(props: {
+        buildPrivateAPI: (config: any) => IPrivateAPIFixMe;
+    }): Promise<void>;
     notify(event: IPlatformPrivateEvent): Promise<void>;
     subscribe(cb: (event: IPlatformAppEvent) => void): void;
     runApplication(app: IApplicationSpec): Promise<void>;
     waitReady(): Promise<this>;
 }
 
-export { PLATFORM_FRAME_API_TYPE, PLATFORM_WORKER_API_TYPE, PlatformFrameAPI, PlatformWorkerAPI };
+export { PlatformConsumerEnvironmentAPIType, PlatformFrameAPI, PlatformWorkerAPI };
 //# sourceMappingURL=index.d.ts.map

package/dist/types/platform-worker/index.d.ts

@@ -3,25 +3,57 @@ import { IPlatformPrivateEvent, IPlatformAppEvent } from '@wix/public-editor-pla
 type IPrivateAPIFixMe = any;
 type IApplicationSpec = any;
 
-declare const PLATFORM_FRAME_API_TYPE = "PLATFORM_FRAME_API";
-declare class PlatformFrameAPI {
+declare enum PlatformConsumerEnvironmentAPIType {
+    Frame = "PLATFORM_FRAME_API",
+    Worker = "PLATFORM_WORKER_API"
+}
+/**
+ * rename these entities -> API to Env
+ */
+declare abstract class AbstractEnvironmentAPI<TEnv extends PlatformConsumerEnvironmentAPIType> {
+    protected env: TEnv;
+    /**
+     * NOTE: we can't `type` declare getter within current abstract class
+     * because then after transferring API between threads this getter becomes promise,
+     * which is not expected
+     *
+     *   get type() {
+     *     return this.env;
+     *   }
+     */
+    abstract type: TEnv;
+    protected constructor(env: TEnv);
+    abstract create(): void;
+    abstract initEnvironment(props: unknown): void;
+}
+
+declare class PlatformFrameAPI extends AbstractEnvironmentAPI<PlatformConsumerEnvironmentAPIType.Frame> {
     #private;
-    type: string;
-    initFrameEnvironment(appDefinitionId: string, privateAPI: IPrivateAPIFixMe, applicationPrivateAPI: any): Promise<void>;
+    type: PlatformConsumerEnvironmentAPIType.Frame;
+    constructor();
+    create(): void;
+    initEnvironment(props: {
+        appDefinitionId: string;
+        privateAPI: IPrivateAPIFixMe;
+        applicationPrivateAPI: any;
+    }): Promise<void>;
     notify(event: IPlatformPrivateEvent): void;
     subscribe(cb: (event: IPlatformAppEvent) => void): void;
 }
 
-declare const PLATFORM_WORKER_API_TYPE = "PLATFORM_WORKER_API";
-declare class PlatformWorkerAPI {
+declare class PlatformWorkerAPI extends AbstractEnvironmentAPI<PlatformConsumerEnvironmentAPIType.Worker> {
     #private;
-    type: string;
-    initWorkerEnvironment(buildPrivateAPI: (config: any) => IPrivateAPIFixMe): Promise<void>;
+    type: PlatformConsumerEnvironmentAPIType.Worker;
+    constructor();
+    create(): void;
+    initEnvironment(props: {
+        buildPrivateAPI: (config: any) => IPrivateAPIFixMe;
+    }): Promise<void>;
     notify(event: IPlatformPrivateEvent): Promise<void>;
     subscribe(cb: (event: IPlatformAppEvent) => void): void;
     runApplication(app: IApplicationSpec): Promise<void>;
     waitReady(): Promise<this>;
 }
 
-export { PLATFORM_FRAME_API_TYPE, PLATFORM_WORKER_API_TYPE, PlatformFrameAPI, PlatformWorkerAPI };
+export { PlatformConsumerEnvironmentAPIType, PlatformFrameAPI, PlatformWorkerAPI };
 //# sourceMappingURL=index.d.ts.map

package/dist/types/platform-worker-api/index.d.ts

@@ -3,25 +3,57 @@ import { IPlatformPrivateEvent, IPlatformAppEvent } from '@wix/public-editor-pla
 type IPrivateAPIFixMe = any;
 type IApplicationSpec = any;
 
-declare const PLATFORM_FRAME_API_TYPE = "PLATFORM_FRAME_API";
-declare class PlatformFrameAPI {
+declare enum PlatformConsumerEnvironmentAPIType {
+    Frame = "PLATFORM_FRAME_API",
+    Worker = "PLATFORM_WORKER_API"
+}
+/**
+ * rename these entities -> API to Env
+ */
+declare abstract class AbstractEnvironmentAPI<TEnv extends PlatformConsumerEnvironmentAPIType> {
+    protected env: TEnv;
+    /**
+     * NOTE: we can't `type` declare getter within current abstract class
+     * because then after transferring API between threads this getter becomes promise,
+     * which is not expected
+     *
+     *   get type() {
+     *     return this.env;
+     *   }
+     */
+    abstract type: TEnv;
+    protected constructor(env: TEnv);
+    abstract create(): void;
+    abstract initEnvironment(props: unknown): void;
+}
+
+declare class PlatformFrameAPI extends AbstractEnvironmentAPI<PlatformConsumerEnvironmentAPIType.Frame> {
     #private;
-    type: string;
-    initFrameEnvironment(appDefinitionId: string, privateAPI: IPrivateAPIFixMe, applicationPrivateAPI: any): Promise<void>;
+    type: PlatformConsumerEnvironmentAPIType.Frame;
+    constructor();
+    create(): void;
+    initEnvironment(props: {
+        appDefinitionId: string;
+        privateAPI: IPrivateAPIFixMe;
+        applicationPrivateAPI: any;
+    }): Promise<void>;
     notify(event: IPlatformPrivateEvent): void;
     subscribe(cb: (event: IPlatformAppEvent) => void): void;
 }
 
-declare const PLATFORM_WORKER_API_TYPE = "PLATFORM_WORKER_API";
-declare class PlatformWorkerAPI {
+declare class PlatformWorkerAPI extends AbstractEnvironmentAPI<PlatformConsumerEnvironmentAPIType.Worker> {
     #private;
-    type: string;
-    initWorkerEnvironment(buildPrivateAPI: (config: any) => IPrivateAPIFixMe): Promise<void>;
+    type: PlatformConsumerEnvironmentAPIType.Worker;
+    constructor();
+    create(): void;
+    initEnvironment(props: {
+        buildPrivateAPI: (config: any) => IPrivateAPIFixMe;
+    }): Promise<void>;
     notify(event: IPlatformPrivateEvent): Promise<void>;
     subscribe(cb: (event: IPlatformAppEvent) => void): void;
     runApplication(app: IApplicationSpec): Promise<void>;
     waitReady(): Promise<this>;
 }
 
-export { PLATFORM_FRAME_API_TYPE, PLATFORM_WORKER_API_TYPE, PlatformFrameAPI, PlatformWorkerAPI };
+export { PlatformConsumerEnvironmentAPIType, PlatformFrameAPI, PlatformWorkerAPI };
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/editor-application",
-  "version": "1.308.0",
+  "version": "1.315.0",
   "description": "",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -64,17 +64,16 @@
     "typescript": "~5.2.2"
   },
   "dependencies": {
-    "@wix/editor-platform-transport": "1.5.0",
-    "@wix/public-editor-platform-errors": "1.5.0",
-    "@wix/public-editor-platform-events": "1.284.0",
-    "@wix/public-editor-platform-interfaces": "1.0.0"
+    "@wix/editor-platform-transport": "1.8.0",
+    "@wix/public-editor-platform-errors": "1.8.0",
+    "@wix/public-editor-platform-events": "1.290.0",
+    "@wix/public-editor-platform-interfaces": "1.2.0"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "unpkg": true,
-  "publishScoped": true,
   "lint-staged": {
     "*.{js,ts}": "yarn run lint"
   },
@@ -92,5 +91,5 @@
       ]
     }
   },
-  "falconPackageHash": "908873eca5f2ef3f56dde3408ca8856888b34356e6f46fb98214e850"
+  "falconPackageHash": "0d952c23bcc1948a112b5f055f59d81eaa939bacd006ff6a8de12e34"
 }