@wix/editor-application 1.308.0

package/dist/types/index.d.ts

@@ -0,0 +1,253 @@
+import * as _wix_public_editor_platform_errors from '@wix/public-editor-platform-errors';
+import * as _wix_editor_platform_transport from '@wix/editor-platform-transport';
+import { WithPromiseFunctions } from '@wix/editor-platform-transport';
+import { PlatformAppEventEmitter, IPlatformAppEvent, IPlatformEditorReadyEvent, IPlatformPrivateEvent } from '@wix/public-editor-platform-events';
+import { ComponentRef } from '@wix/public-editor-platform-interfaces';
+
+type PrivateAPIFixMe = any;
+interface Component<TComponentType extends string> {
+    compRef: ComponentRef;
+    type: TComponentType;
+}
+interface TextComponent extends Component<'text'> {
+    text(): Promise<string>;
+    text(content: string): Promise<void>;
+}
+interface ImageComponent extends Component<'image'> {
+    src(src?: string): Promise<void>;
+}
+interface UnknownComponent extends Component<'unknown'> {
+}
+type IComponent = TextComponent | ImageComponent | UnknownComponent;
+type EventsToAutocomplete = 'componentSelectionChanged';
+type AllowedEvents = Omit<string, EventsToAutocomplete> | EventsToAutocomplete;
+type AppEventPayload<EventType extends AllowedEvents> = EventType extends 'componentSelectionChanged' ? {
+    type: EventType;
+    components: IComponent[];
+} : Record<string, string>;
+
+type OmitEventMeta<T> = T extends {
+    meta: any;
+} ? Omit<T, 'meta'> : T;
+declare class ApplicationBoundEvents {
+    private appDefinitionId;
+    private privateAPI;
+    private events;
+    subscribe: (callback: (event: IPlatformAppEvent) => void) => () => void;
+    commit: () => void;
+    startTransaction: () => void;
+    silent: (isSilent?: boolean | undefined) => void;
+    constructor(appDefinitionId: string, events: PlatformAppEventEmitter, privateAPI: PrivateAPIFixMe);
+    notify(event: OmitEventMeta<IPlatformAppEvent>): void;
+    notifyCustomEvent(type: string, payload: Record<string, string>): void;
+    /**
+     * TODO: we should use same interface for all events
+     * (subscribe vs addEventListener)
+     */
+    addEventListener<EventType extends AllowedEvents>(eventType: EventType, fn: (payload: AppEventPayload<EventType>) => void): () => void;
+}
+
+type IPrivateAPIFixMe$1 = any;
+declare global {
+    var __ENVIRONMENT_CONTEXT_KEY: EnvironmentContext;
+}
+declare enum PlatformEnvironment {
+    Worker = "Worker",
+    Frame = "Frame"
+}
+interface IEnvironmentContext {
+    environment: PlatformEnvironment;
+    privateApi: WithPromiseFunctions<IPrivateAPIFixMe$1>;
+    events: PlatformAppEventEmitter;
+    /**
+     * Probably, we need to rename this prop
+     */
+    applicationAPIs?: Record<string, any>;
+}
+declare class EnvironmentContext {
+    private environmentContext;
+    private static status;
+    static inject(context: IEnvironmentContext): Promise<void>;
+    static getInstance(): Promise<EnvironmentContext>;
+    constructor(environmentContext: IEnvironmentContext);
+    getPrivateAPI(): WithPromiseFunctions<any>;
+    getEvents(): PlatformAppEventEmitter;
+    getApplicationAPIs(): Record<string, any>;
+    getEnvironment(): PlatformEnvironment;
+}
+declare global {
+    var __APPLICATION_CONTEXT_KEY: ApplicationContext<IApplicationContext>;
+}
+type IEditorApplicationContext = {
+    appDefinitionId: string;
+};
+type IAddonContext = {
+    appDefinitionId: string;
+    appDefinitionName: string;
+    data: {
+        toolPanelConfig: {
+            url: string;
+            width: string;
+            height: string;
+            initialPosition: {
+                x: string;
+                y: string;
+            };
+        };
+    };
+};
+type IApplicationContext = IEditorApplicationContext | IAddonContext;
+declare class ApplicationContext<TContext extends IApplicationContext> {
+    private applicationContext;
+    private environment;
+    private static status;
+    /**
+     * TODO: use generics for context type
+     * - application
+     * - editor
+     */
+    static inject<TContext extends IApplicationContext>(context: TContext): Promise<void>;
+    static getInstance<TContext extends IApplicationContext>(): Promise<ApplicationContext<TContext>>;
+    private events;
+    constructor(applicationContext: TContext, environment: EnvironmentContext);
+    getAppDefinitionId(): string;
+    getBindings(): TContext;
+    getEvents(): ApplicationBoundEvents;
+    getPrivateAPI(): _wix_editor_platform_transport.WithPromiseFunctions<any>;
+    getPrivateApplicationAPI(): any;
+}
+//# sourceMappingURL=index.d.ts.map
+
+declare class ApplicationLifecycle {
+    private events;
+    private callbacks;
+    constructor(events: ApplicationBoundEvents);
+    private subscribe;
+    private addCallback;
+    /**
+     * NOTE: currently, we return function to unsubscribe from the event,
+     * probably it is better to return `this` to allow chaining
+     * and provide another way to unsubscribe from events.
+     */
+    onEditorReady(fn: (payload: IPlatformEditorReadyEvent['payload']) => void): () => void;
+}
+
+declare enum EditorPlatformApplicationErrorCode {
+    ApplicationRuntimeError = "ApplicationRuntimeError",
+    ApplicationCreationError = "ApplicationCreationError",
+    ApplicationLoadError = "ApplicationLoadError",
+    ApplicationFetchError = "ApplicationFetchError",
+    ApplicationExecuteError = "ApplicationExecuteError",
+    ApplicationWasRemoved = "ApplicationWasRemoved",
+    UndefinedApiMethod = "UndefinedApiMethod",
+    ApplicationIsNotMutable = "ApplicationIsNotMutable",
+    FailedToGetPrivateAPI = "FailedToGetPrivateAPI"
+}
+
+type IPrivateAPIFixMe = any;
+type IApplicationSpec = any;
+declare enum ApplicationType {
+    EditorAddon = "EDITOR_ADDON",
+    Platform = "PLATFORM"
+}
+
+/**
+ * TODO: duplicated type to get rid of extra dependency
+ */
+type IApplicationRegistry = (instance: EditorPlatformApplication) => void;
+declare global {
+    var __APPLICATION_REGISTRY_KEY: IApplicationRegistry;
+}
+interface IApplicationAPI<TPublicAPI, TPrivateAPI> {
+    public?: TPublicAPI;
+    private?: TPrivateAPI;
+}
+declare class ChainAPIConfiguration<TPublicAPI, TPrivateAPI> {
+    private api;
+    constructor(api: IApplicationAPI<TPublicAPI, TPrivateAPI>);
+    exposePublicAPI(api: TPublicAPI): this;
+    exposePrivateAPI(api: TPrivateAPI): this;
+}
+/**
+ * TODO: should accept generic type
+ */
+declare abstract class EditorPlatformApplication<TContext extends IApplicationContext = IApplicationContext, TPublicAPI = unknown, TPrivateAPI = unknown> {
+    #private;
+    readonly type: ApplicationType;
+    appDefinitionId: string;
+    state: 'READY' | 'REMOVED';
+    lifecycle: ApplicationLifecycle;
+    protected constructor(type: ApplicationType, context: ApplicationContext<TContext>);
+    protected get context(): ApplicationContext<TContext>;
+    get events(): ApplicationBoundEvents;
+    setManifest(manifest: any): void;
+    getManifest(): any;
+    exposePublicAPI(api: TPublicAPI): ChainAPIConfiguration<TPublicAPI, TPrivateAPI>;
+    exposePrivateAPI(api: TPrivateAPI): ChainAPIConfiguration<TPublicAPI, TPrivateAPI>;
+    getPublicAPI(): TPublicAPI | undefined;
+    getPrivateAPI(): TPrivateAPI | undefined;
+    ready(): void;
+    buildApplicationError(message: string): {
+        state: Partial<{
+            url: string;
+            appDefinitionId: string;
+            apiMethod: string;
+            apiType: string;
+        }>;
+        withUrl(url: string): any;
+        withAppDefinitionId(appDefinitionId: string): any;
+        withApiMethod(apiMethod: string): any;
+        withApiType(apiType: string): any;
+        displayName: string;
+        prefix: string;
+        errorMessage: string;
+        parent: _wix_public_editor_platform_errors.BaseError<EditorPlatformApplicationErrorCode> | Error | undefined;
+        messages: string[][];
+        code: EditorPlatformApplicationErrorCode;
+        readonly parentError: _wix_public_editor_platform_errors.BaseError<any> | null;
+        getDisplayMessage(): string;
+        getMessage(): string;
+        getBreadcrumbs(): string[];
+        withParentError(e: Error | _wix_public_editor_platform_errors.BaseError<any>): any;
+        withMessage(...messages: string[]): any;
+        name: string;
+        message: string;
+        stack?: string | undefined;
+        cause?: unknown;
+    };
+}
+
+declare class WixEditorPlatformApplication<TPublicAPI = unknown, TPrivateAPI = unknown> extends EditorPlatformApplication<IEditorApplicationContext, TPublicAPI, TPrivateAPI> {
+    static create<TPublicAPI = unknown, TPrivateAPI = unknown>(): Promise<WixEditorPlatformApplication<TPublicAPI, TPrivateAPI>>;
+    constructor(context: ApplicationContext<IEditorApplicationContext>);
+}
+
+declare class WixEditorPlatformAddon<TPublicAPI = unknown, TPrivateAPI = unknown> extends EditorPlatformApplication<IAddonContext, TPublicAPI, TPrivateAPI> {
+    static create<TPublicAPI = unknown, TPrivateAPI = unknown>(): Promise<WixEditorPlatformAddon<TPublicAPI, TPrivateAPI>>;
+    constructor(context: ApplicationContext<IAddonContext>);
+    private init;
+    private registerToolsPanel;
+}
+
+declare const PLATFORM_FRAME_API_TYPE = "PLATFORM_FRAME_API";
+declare class PlatformFrameAPI {
+    #private;
+    type: string;
+    initFrameEnvironment(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 {
+    #private;
+    type: string;
+    initWorkerEnvironment(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 };
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

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

@@ -0,0 +1,27 @@
+import { IPlatformPrivateEvent, IPlatformAppEvent } from '@wix/public-editor-platform-events';
+
+type IPrivateAPIFixMe = any;
+type IApplicationSpec = any;
+
+declare const PLATFORM_FRAME_API_TYPE = "PLATFORM_FRAME_API";
+declare class PlatformFrameAPI {
+    #private;
+    type: string;
+    initFrameEnvironment(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 {
+    #private;
+    type: string;
+    initWorkerEnvironment(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 };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

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

@@ -0,0 +1,27 @@
+import { IPlatformPrivateEvent, IPlatformAppEvent } from '@wix/public-editor-platform-events';
+
+type IPrivateAPIFixMe = any;
+type IApplicationSpec = any;
+
+declare const PLATFORM_FRAME_API_TYPE = "PLATFORM_FRAME_API";
+declare class PlatformFrameAPI {
+    #private;
+    type: string;
+    initFrameEnvironment(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 {
+    #private;
+    type: string;
+    initWorkerEnvironment(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 };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

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

@@ -0,0 +1,27 @@
+import { IPlatformPrivateEvent, IPlatformAppEvent } from '@wix/public-editor-platform-events';
+
+type IPrivateAPIFixMe = any;
+type IApplicationSpec = any;
+
+declare const PLATFORM_FRAME_API_TYPE = "PLATFORM_FRAME_API";
+declare class PlatformFrameAPI {
+    #private;
+    type: string;
+    initFrameEnvironment(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 {
+    #private;
+    type: string;
+    initWorkerEnvironment(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 };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

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

@@ -0,0 +1,27 @@
+import { IPlatformPrivateEvent, IPlatformAppEvent } from '@wix/public-editor-platform-events';
+
+type IPrivateAPIFixMe = any;
+type IApplicationSpec = any;
+
+declare const PLATFORM_FRAME_API_TYPE = "PLATFORM_FRAME_API";
+declare class PlatformFrameAPI {
+    #private;
+    type: string;
+    initFrameEnvironment(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 {
+    #private;
+    type: string;
+    initWorkerEnvironment(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 };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "@wix/editor-application",
+  "version": "1.308.0",
+  "description": "",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "scripts": {
+    "start": "exit 0",
+    "build": "yarn typecheck && rollup -c",
+    "test": "exit 0",
+    "lint": "prettier --check ./src",
+    "lint:fix": "prettier --write ./src",
+    "typecheck": "tsc --noEmit"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts"
+    },
+    "./platform-frame": {
+      "import": "./dist/esm/platform-frame/index.js",
+      "require": "./dist/cjs/platform-frame/index.js"
+    },
+    "./platform-worker": {
+      "import": "./dist/esm/platform-worker/index.js",
+      "require": "./dist/cjs/platform-worker/index.js"
+    },
+    "./environment-api": {
+      "import": "./dist/esm/environment-api/index.js",
+      "require": "./dist/cjs/environment-api/index.js",
+      "types": "./dist/types/environment-api/index.d.ts"
+    },
+    "./platform-frame-api": {
+      "import": "./dist/esm/platform-frame-api/index.js",
+      "require": "./dist/cjs/platform-frame-api/index.js",
+      "types": "./dist/types/platform-frame-api/index.d.ts"
+    },
+    "./platform-worker-api": {
+      "import": "./dist/esm/platform-worker-api/index.js",
+      "require": "./dist/cjs/platform-worker-api/index.js",
+      "types": "./dist/types/platform-worker-api/index.d.ts"
+    }
+  },
+  "keywords": [],
+  "files": [
+    "dist"
+  ],
+  "author": {
+    "name": "Editor Platform <editor-platform-dev@wix.com>",
+    "email": "editor-platform-dev@wix.com"
+  },
+  "license": "UNLICENSED",
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@wix/editor-application-context": "^1.0.0",
+    "esbuild": "^0.19.5",
+    "eslint": "^8.54.0",
+    "prettier": "^3.1.0",
+    "rollup": "^3.29.4",
+    "rollup-plugin-dts": "^6.1.0",
+    "rollup-plugin-esbuild": "^5.0.0",
+    "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"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "unpkg": true,
+  "publishScoped": true,
+  "lint-staged": {
+    "*.{js,ts}": "yarn run lint"
+  },
+  "wix": {
+    "artifact": {
+      "groupId": "com.wixpress",
+      "artifactId": "public-editor-platform-application-runtime",
+      "targets": {
+        "static": true
+      }
+    },
+    "validations": {
+      "postDependenciesBuild": [
+        "lint"
+      ]
+    }
+  },
+  "falconPackageHash": "908873eca5f2ef3f56dde3408ca8856888b34356e6f46fb98214e850"
+}