@wix/editor-platform-contexts 1.0.0

package/README.md

@@ -0,0 +1 @@
+tbd

package/dist/cjs/index.js

@@ -0,0 +1,278 @@
+'use strict';
+
+var publicEditorPlatformErrors = require('@wix/public-editor-platform-errors');
+var publicEditorPlatformEvents = require('@wix/public-editor-platform-events');
+
+var EditorPlatformContextErrorCode = /* @__PURE__ */ ((EditorPlatformContextErrorCode2) => {
+  EditorPlatformContextErrorCode2["IncorrectEnvironment"] = "IncorrectEnvironment";
+  return EditorPlatformContextErrorCode2;
+})(EditorPlatformContextErrorCode || {});
+class EditorPlatformContextError extends publicEditorPlatformErrors.BaseError {
+  state = {};
+  constructor(message, code) {
+    super(message, code, "EP Context Error");
+  }
+  withUrl(url) {
+    this.state = { ...this.state, url };
+    return this;
+  }
+  withAppDefinitionId(appDefinitionId) {
+    this.state = { ...this.state, appDefinitionId };
+    return this;
+  }
+}
+const createEditorPlatformContextError = publicEditorPlatformErrors.createErrorBuilder(EditorPlatformContextError);
+
+async function transformEventPayload(eventPayload, privateAPI) {
+  if (!eventPayload?.type) {
+    return eventPayload;
+  }
+  switch (eventPayload.type) {
+    case "componentSelectionChanged":
+      const componentRefs = eventPayload.componentRefs || [];
+      const components = await Promise.all(
+        componentRefs.map((ref) => {
+          return privateAPI.components.getComponent(ref);
+        })
+      );
+      return {
+        type: eventPayload.type,
+        components
+      };
+    default:
+      return eventPayload;
+  }
+}
+
+class ApplicationBoundEvents {
+  constructor(appDefinitionId, events, privateAPI) {
+    this.appDefinitionId = appDefinitionId;
+    this.privateAPI = privateAPI;
+    this.events = events;
+    this.subscribe = events.subscribe.bind(events);
+    this.commit = events.commit.bind(events);
+    this.startTransaction = events.startTransaction.bind(events);
+    this.silent = events.silent.bind(events);
+  }
+  events;
+  subscribe;
+  commit;
+  startTransaction;
+  silent;
+  notify(event) {
+    this.events.notify({
+      type: event.type,
+      payload: event.payload,
+      meta: {
+        appDefinitionId: this.appDefinitionId
+      }
+    });
+  }
+  notifyCustomEvent(type, payload) {
+    this.notify({
+      type: publicEditorPlatformEvents.PlatformAppEvent.CustomEvent,
+      payload: {
+        ...payload,
+        type
+      }
+    });
+  }
+  /**
+   * TODO: we should use same interface for all events
+   * (subscribe vs addEventListener)
+   */
+  addEventListener(eventType, fn) {
+    return this.events.subscribe(async (event) => {
+      const isAppMatch = event.meta?.appDefinitionId === this.appDefinitionId || event.meta?.appDefinitionId === null;
+      const transformPayload = () => transformEventPayload(event.payload, this.privateAPI);
+      if (eventType === "*") {
+        fn(await transformPayload());
+      } else if (event.type === publicEditorPlatformEvents.PlatformAppEvent.CustomEvent) {
+        if (eventType === event.payload?.type && !isAppMatch) {
+          fn(await transformPayload());
+        }
+      } else if (event.type === publicEditorPlatformEvents.PlatformAppEvent.HostEvent) {
+        if (eventType === event.payload?.type && isAppMatch) {
+          fn(await transformPayload());
+        }
+      }
+    });
+  }
+}
+
+const WAIT_INJECTED_TIMEOUT = 200;
+const WAIT_INJECTED_RETRY_COUNT = 50;
+class ContextInjectionStatus {
+  _resolveContextInjected = () => {
+  };
+  _isInjected = false;
+  key;
+  constructor(uuid) {
+    this.key = `__${uuid}_CONTEXT_INJECTION_STATUS_KEY`;
+    if (!globalThis[this.key]) {
+      globalThis[this.key] = new Promise((resolve) => {
+        this._resolveContextInjected = () => {
+          this._isInjected = true;
+          resolve();
+        };
+      });
+    }
+  }
+  isInjected() {
+    return !!this._isInjected;
+  }
+  resolveInjected() {
+    this._resolveContextInjected?.();
+  }
+  waitInjected() {
+    return new Promise((resolve, reject) => {
+      let injected = false;
+      let timeoutId;
+      let retryCount = 0;
+      const timeout = () => {
+        if (injected) {
+          return;
+        }
+        timeoutId = setTimeout(() => {
+          retryCount++;
+          if (retryCount < WAIT_INJECTED_RETRY_COUNT) {
+            if (retryCount % 10 === 0) {
+              console.log(
+                createEditorPlatformContextError(
+                  EditorPlatformContextErrorCode.IncorrectEnvironment,
+                  "contexts are not resolved, still re-trying"
+                ).withMessage(`try number ${retryCount}`).message
+              );
+            }
+            timeout();
+            return;
+          }
+          if (!injected) {
+            const error = createEditorPlatformContextError(
+              EditorPlatformContextErrorCode.IncorrectEnvironment,
+              "contexts are not resolved, threw by timeout"
+            );
+            reject(error);
+          }
+        }, WAIT_INJECTED_TIMEOUT);
+      };
+      timeout();
+      const _waitContextInjectedPromise = globalThis[this.key];
+      _waitContextInjectedPromise.then(() => {
+        injected = true;
+        clearTimeout(timeoutId);
+        resolve();
+      });
+    });
+  }
+}
+
+const ENVIRONMENT_CONTEXT_KEY = "__ENVIRONMENT_CONTEXT_KEY";
+var PlatformEnvironment = /* @__PURE__ */ ((PlatformEnvironment2) => {
+  PlatformEnvironment2["Worker"] = "Worker";
+  PlatformEnvironment2["Frame"] = "Frame";
+  PlatformEnvironment2["ComponentPanel"] = "ComponentPanel";
+  return PlatformEnvironment2;
+})(PlatformEnvironment || {});
+class EnvironmentContext {
+  constructor(environmentContext) {
+    this.environmentContext = environmentContext;
+  }
+  static status = new ContextInjectionStatus("environment");
+  static async inject(context) {
+    if (globalThis[ENVIRONMENT_CONTEXT_KEY]) {
+      throw createEditorPlatformContextError(
+        EditorPlatformContextErrorCode.IncorrectEnvironment,
+        "Environment context already exists and should not be overridden"
+      );
+    }
+    globalThis[ENVIRONMENT_CONTEXT_KEY] = new EnvironmentContext(context);
+    this.status.resolveInjected();
+  }
+  static async getInstance() {
+    await this.status.waitInjected();
+    return globalThis[ENVIRONMENT_CONTEXT_KEY];
+  }
+  getPrivateAPI() {
+    return this.environmentContext.privateApi;
+  }
+  getEvents() {
+    return this.environmentContext.events;
+  }
+  getApplicationAPIs() {
+    return this.environmentContext.applicationAPIs ?? {};
+  }
+  getEnvironment() {
+    return this.environmentContext.environment;
+  }
+}
+
+const APPLICATION_CONTEXT_KEY = "__APPLICATION_CONTEXT_KEY";
+class ApplicationContext {
+  constructor(applicationContext, environment) {
+    this.applicationContext = applicationContext;
+    this.environment = environment;
+    this.events = new ApplicationBoundEvents(
+      this.applicationContext.appDefinitionId,
+      this.environment.getEvents(),
+      this.environment.getPrivateAPI()
+    );
+  }
+  static status = new ContextInjectionStatus("application");
+  /**
+   * TODO: use generics for context type
+   * - application
+   * - editor
+   */
+  static async inject(context) {
+    if (globalThis[APPLICATION_CONTEXT_KEY]) {
+      throw createEditorPlatformContextError(
+        EditorPlatformContextErrorCode.IncorrectEnvironment,
+        "Application context already exists and should not be overridden"
+      );
+    }
+    globalThis[APPLICATION_CONTEXT_KEY] = new ApplicationContext(
+      context,
+      await EnvironmentContext.getInstance()
+    );
+    this.status.resolveInjected();
+  }
+  static async getInstance() {
+    if (typeof __APPLICATION_CONTEXT_KEY !== "undefined") {
+      return __APPLICATION_CONTEXT_KEY;
+    }
+    await this.status.waitInjected();
+    return globalThis[APPLICATION_CONTEXT_KEY];
+  }
+  events;
+  getAppDefinitionId() {
+    return this.applicationContext.appDefinitionId;
+  }
+  getBindings() {
+    return this.applicationContext;
+  }
+  getEvents() {
+    return this.events;
+  }
+  getPrivateAPI() {
+    return this.environment.getPrivateAPI();
+  }
+  getPrivateApplicationAPI() {
+    const appDefinitionId = this.getAppDefinitionId();
+    if (!appDefinitionId) {
+      throw createEditorPlatformContextError(
+        EditorPlatformContextErrorCode.IncorrectEnvironment,
+        "appDefinitionId is not available"
+      );
+    }
+    return this.environment.getApplicationAPIs()[appDefinitionId];
+  }
+}
+
+exports.APPLICATION_CONTEXT_KEY = APPLICATION_CONTEXT_KEY;
+exports.ApplicationBoundEvents = ApplicationBoundEvents;
+exports.ApplicationContext = ApplicationContext;
+exports.ENVIRONMENT_CONTEXT_KEY = ENVIRONMENT_CONTEXT_KEY;
+exports.EnvironmentContext = EnvironmentContext;
+exports.PlatformEnvironment = PlatformEnvironment;
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/errors.ts","../../src/ApplicationBoundEvents/transformEventPayload.ts","../../src/ApplicationBoundEvents/ApplicationBoundEvents.ts","../../src/contexts/ContextInjectionStatus.ts","../../src/contexts/EnvironmentContext.ts","../../src/contexts/ApplicationContext.ts"],"sourcesContent":["import {\n  BaseError,\n  createErrorBuilder,\n} from '@wix/public-editor-platform-errors';\n\nexport enum EditorPlatformContextErrorCode {\n  IncorrectEnvironment = 'IncorrectEnvironment',\n}\n\nclass EditorPlatformContextError extends BaseError<EditorPlatformContextErrorCode> {\n  state: Partial<{\n    url: string;\n    appDefinitionId: string;\n  }> = {};\n\n  constructor(message: string, code: EditorPlatformContextErrorCode) {\n    super(message, code, 'EP Context Error');\n  }\n\n  withUrl(url: string) {\n    this.state = { ...this.state, url };\n    return this;\n  }\n\n  withAppDefinitionId(appDefinitionId: string) {\n    this.state = { ...this.state, appDefinitionId };\n    return this;\n  }\n}\n\nexport const createEditorPlatformContextError = createErrorBuilder<\n  EditorPlatformContextErrorCode,\n  EditorPlatformContextError\n>(EditorPlatformContextError);\n","import type { ComponentRef } from '@wix/public-editor-platform-interfaces';\nimport {\n  AllowedEvents,\n  AppEventPayload,\n  IComponent,\n  PrivateAPIFixMe,\n} from './types';\n\nexport async function transformEventPayload<T extends AllowedEvents>(\n  eventPayload: Record<string, string>,\n  privateAPI: PrivateAPIFixMe,\n): Promise<AppEventPayload<T>> {\n  if (!eventPayload?.type) {\n    return eventPayload as AppEventPayload<T>;\n  }\n\n  switch (eventPayload.type) {\n    case 'componentSelectionChanged':\n      const componentRefs = (eventPayload.componentRefs ||\n        []) as unknown as ComponentRef[];\n\n      const components = (await Promise.all(\n        componentRefs.map((ref) => {\n          return privateAPI.components.getComponent(ref);\n        }),\n      )) as IComponent[];\n\n      return {\n        type: eventPayload.type,\n        components,\n      } as AppEventPayload<T>;\n\n    default:\n      return eventPayload as AppEventPayload<T>;\n  }\n}\n","import {\n  PlatformAppEvent,\n  PlatformAppEventEmitter,\n  IPlatformAppEvent,\n} from '@wix/public-editor-platform-events';\nimport { AllowedEvents, AppEventPayload, PrivateAPIFixMe } from './types';\nimport { transformEventPayload } from './transformEventPayload';\n\nexport type OmitEventMeta<T> = T extends { meta: any } ? Omit<T, 'meta'> : T;\n\n/**\n * TODO: should not be in this package\n */\nexport class ApplicationBoundEvents {\n  private events: PlatformAppEventEmitter;\n  public subscribe;\n  public commit;\n  public startTransaction;\n  public silent;\n\n  constructor(\n    private appDefinitionId: string,\n    events: PlatformAppEventEmitter,\n    private privateAPI: PrivateAPIFixMe,\n  ) {\n    this.events = events;\n    this.subscribe = events.subscribe.bind(events);\n    this.commit = events.commit.bind(events);\n    this.startTransaction = events.startTransaction.bind(events);\n    this.silent = events.silent.bind(events);\n  }\n\n  public notify(event: OmitEventMeta<IPlatformAppEvent>) {\n    this.events.notify({\n      type: event.type,\n      payload: event.payload,\n      meta: {\n        appDefinitionId: this.appDefinitionId,\n      },\n    } as IPlatformAppEvent);\n  }\n\n  notifyCustomEvent(type: string, payload: Record<string, string>) {\n    this.notify({\n      type: PlatformAppEvent.CustomEvent,\n      payload: {\n        ...payload,\n        type,\n      },\n    });\n  }\n\n  /**\n   * TODO: we should use same interface for all events\n   * (subscribe vs addEventListener)\n   */\n  public addEventListener<EventType extends AllowedEvents>(\n    eventType: EventType,\n    fn: (payload: AppEventPayload<EventType>) => void,\n  ) {\n    return this.events.subscribe(async (event) => {\n      const isAppMatch =\n        event.meta?.appDefinitionId === this.appDefinitionId ||\n        event.meta?.appDefinitionId === null;\n\n      const transformPayload = () =>\n        transformEventPayload<EventType>(event.payload, this.privateAPI);\n\n      // as an exception to skip autocomplete\n      if ((eventType as string) === '*') {\n        fn(await transformPayload());\n        /**\n         * We need to check for app match here to not listen app's own events\n         */\n      } else if (event.type === PlatformAppEvent.CustomEvent) {\n        if (eventType === event.payload?.type && !isAppMatch) {\n          fn(await transformPayload());\n        }\n      } else if (event.type === PlatformAppEvent.HostEvent) {\n        if (eventType === event.payload?.type && isAppMatch) {\n          fn(await transformPayload());\n        }\n      }\n    });\n  }\n}\n","import {\n  createEditorPlatformContextError,\n  EditorPlatformContextErrorCode,\n} from '../errors';\n\nconst WAIT_INJECTED_TIMEOUT = 200;\nconst WAIT_INJECTED_RETRY_COUNT = 50;\n\nexport class ContextInjectionStatus {\n  private _resolveContextInjected = () => {};\n  private _isInjected = false;\n  private key: string;\n\n  constructor(uuid: string) {\n    this.key = `__${uuid}_CONTEXT_INJECTION_STATUS_KEY`;\n\n    // @ts-expect-error xxx\n    if (!globalThis[this.key]) {\n      // @ts-expect-error xxx\n      globalThis[this.key] = new Promise<void>((resolve) => {\n        this._resolveContextInjected = () => {\n          this._isInjected = true;\n          resolve();\n        };\n      });\n    }\n  }\n\n  isInjected() {\n    return !!this._isInjected;\n  }\n\n  resolveInjected() {\n    this._resolveContextInjected?.();\n  }\n\n  waitInjected() {\n    return new Promise<void>((resolve, reject) => {\n      let injected = false;\n      let timeoutId: ReturnType<typeof setTimeout>;\n      let retryCount = 0;\n\n      const timeout = () => {\n        if (injected) {\n          return;\n        }\n\n        timeoutId = setTimeout(() => {\n          retryCount++;\n\n          if (retryCount < WAIT_INJECTED_RETRY_COUNT) {\n            /**\n             * just log that we are re-trying to connect (each 2 sec+-)\n             */\n            if (retryCount % 10 === 0) {\n              console.log(\n                createEditorPlatformContextError(\n                  EditorPlatformContextErrorCode.IncorrectEnvironment,\n                  'contexts are not resolved, still re-trying',\n                ).withMessage(`try number ${retryCount}`).message,\n              );\n            }\n\n            timeout();\n\n            return;\n          }\n\n          if (!injected) {\n            const error = createEditorPlatformContextError(\n              EditorPlatformContextErrorCode.IncorrectEnvironment,\n              'contexts are not resolved, threw by timeout',\n            );\n\n            reject(error);\n          }\n        }, WAIT_INJECTED_TIMEOUT);\n      };\n\n      timeout();\n\n      // @ts-expect-error xxx\n      const _waitContextInjectedPromise = globalThis[this.key];\n      _waitContextInjectedPromise.then(() => {\n        injected = true;\n        clearTimeout(timeoutId);\n        resolve();\n      });\n    });\n  }\n}\n","import { PlatformAppEventEmitter } from '@wix/public-editor-platform-events';\nimport { WithPromiseFunctions } from '@wix/editor-platform-transport';\nimport {\n  createEditorPlatformContextError,\n  EditorPlatformContextErrorCode,\n} from '../errors';\nimport { ContextInjectionStatus } from './ContextInjectionStatus';\n\nexport type IPrivateAPIFixMe = any; // TODO: replace with the real type\n\nexport const ENVIRONMENT_CONTEXT_KEY = '__ENVIRONMENT_CONTEXT_KEY';\n\ndeclare global {\n  // eslint-disable-next-line no-var\n  var __ENVIRONMENT_CONTEXT_KEY: EnvironmentContext;\n}\n\nexport enum PlatformEnvironment {\n  Worker = 'Worker',\n  Frame = 'Frame',\n  // TODO - rename to MainThread\n  ComponentPanel = 'ComponentPanel',\n}\n\nexport interface IEnvironmentContext {\n  environment: PlatformEnvironment;\n  privateApi: WithPromiseFunctions<IPrivateAPIFixMe>;\n  events: PlatformAppEventEmitter;\n  /**\n   * Probably, we need to rename this prop\n   */\n  applicationAPIs?: Record<string, any>;\n}\n\nexport class EnvironmentContext {\n  private static status = new ContextInjectionStatus('environment');\n\n  static async inject(context: IEnvironmentContext) {\n    if (globalThis[ENVIRONMENT_CONTEXT_KEY]) {\n      throw createEditorPlatformContextError(\n        EditorPlatformContextErrorCode.IncorrectEnvironment,\n        'Environment context already exists and should not be overridden',\n      );\n    }\n\n    globalThis[ENVIRONMENT_CONTEXT_KEY] = new EnvironmentContext(context);\n    this.status.resolveInjected();\n  }\n\n  static async getInstance(): Promise<EnvironmentContext> {\n    await this.status.waitInjected();\n    return globalThis[ENVIRONMENT_CONTEXT_KEY];\n  }\n\n  constructor(private environmentContext: IEnvironmentContext) {}\n\n  getPrivateAPI() {\n    return this.environmentContext.privateApi;\n  }\n\n  getEvents() {\n    return this.environmentContext.events;\n  }\n\n  getApplicationAPIs() {\n    return this.environmentContext.applicationAPIs ?? {};\n  }\n\n  getEnvironment() {\n    return this.environmentContext.environment;\n  }\n}\n","import {\n  createEditorPlatformContextError,\n  EditorPlatformContextErrorCode,\n} from '../errors';\n\nimport { ApplicationBoundEvents } from '../ApplicationBoundEvents';\nimport { EnvironmentContext, PlatformEnvironment } from './EnvironmentContext';\nimport { ContextInjectionStatus } from './ContextInjectionStatus';\n\nexport const APPLICATION_CONTEXT_KEY = '__APPLICATION_CONTEXT_KEY';\ndeclare global {\n  // eslint-disable-next-line no-var\n  var __APPLICATION_CONTEXT_KEY: ApplicationContext<IApplicationContext>;\n}\n\nexport type IEditorApplicationContext = {\n  appDefinitionId: string;\n};\n\nexport type IAddonContext = {\n  appDefinitionId: string;\n  appDefinitionName: string;\n  data: {\n    toolPanelConfig: {\n      url: string;\n      width: string;\n      height: string;\n      initialPosition: {\n        x: string;\n        y: string;\n      };\n    };\n  };\n};\n\nexport type IApplicationContext = IEditorApplicationContext | IAddonContext;\nexport class ApplicationContext<TContext extends IApplicationContext> {\n  private static status = new ContextInjectionStatus('application');\n\n  /**\n   * TODO: use generics for context type\n   * - application\n   * - editor\n   */\n  static async inject<TContext extends IApplicationContext>(context: TContext) {\n    // const environment = await EnvironmentContext.getInstance();\n\n    // if (environment.getEnvironment() !== PlatformEnvironment.Frame) {\n    //   throw createEditorPlatformContextError(\n    //     EditorPlatformContextErrorCode.IncorrectEnvironment,\n    //     'Application context can be injected only in frame environment',\n    //   );\n    // }\n\n    if (globalThis[APPLICATION_CONTEXT_KEY]) {\n      throw createEditorPlatformContextError(\n        EditorPlatformContextErrorCode.IncorrectEnvironment,\n        'Application context already exists and should not be overridden',\n      );\n    }\n\n    globalThis[APPLICATION_CONTEXT_KEY] = new ApplicationContext(\n      context,\n      await EnvironmentContext.getInstance(),\n    );\n\n    this.status.resolveInjected();\n  }\n\n  static async getInstance<TContext extends IApplicationContext>() {\n    if (typeof __APPLICATION_CONTEXT_KEY !== 'undefined') {\n      /**\n       * NOTE it is taken not from global\n       * __APPLICATION_CONTEXT_KEY is the variable which set during\n       * application bundle execution using new Function() approach\n       */\n      return __APPLICATION_CONTEXT_KEY as ApplicationContext<TContext>;\n    }\n\n    await this.status.waitInjected();\n\n    return globalThis[APPLICATION_CONTEXT_KEY] as ApplicationContext<TContext>;\n\n    // const environment = await EnvironmentContext.getInstance();\n\n    // if (environment.getEnvironment() === PlatformEnvironment.Frame) {\n    //   await this.status.waitInjected();\n    //   return globalThis[\n    //     APPLICATION_CONTEXT_KEY\n    //   ] as ApplicationContext<TContext>;\n    // } else {\n    //   /**\n    //    * NOTE it is taken not from global\n    //    * __APPLICATION_CONTEXT_KEY is the variable which set during\n    //    * application bundle execution using new Function() approach\n    //    */\n    //   return __APPLICATION_CONTEXT_KEY as ApplicationContext<TContext>;\n    // }\n  }\n\n  private events: ApplicationBoundEvents;\n\n  constructor(\n    private applicationContext: TContext,\n    private environment: EnvironmentContext,\n  ) {\n    this.events = new ApplicationBoundEvents(\n      this.applicationContext.appDefinitionId,\n      this.environment.getEvents(),\n      this.environment.getPrivateAPI(),\n    );\n  }\n\n  getAppDefinitionId() {\n    return this.applicationContext.appDefinitionId;\n  }\n\n  getBindings() {\n    return this.applicationContext;\n  }\n\n  getEvents() {\n    return this.events;\n  }\n\n  getPrivateAPI() {\n    return this.environment.getPrivateAPI();\n  }\n\n  getPrivateApplicationAPI() {\n    const appDefinitionId = this.getAppDefinitionId();\n\n    if (!appDefinitionId) {\n      throw createEditorPlatformContextError(\n        EditorPlatformContextErrorCode.IncorrectEnvironment,\n        'appDefinitionId is not available',\n      );\n    }\n\n    return this.environment.getApplicationAPIs()[appDefinitionId];\n  }\n}\n"],"names":["EditorPlatformContextErrorCode","BaseError","createErrorBuilder","PlatformAppEvent","PlatformEnvironment"],"mappings":";;;;;AAKY,IAAA,8BAAA,qBAAAA,+BAAL,KAAA;AACL,EAAAA,gCAAA,sBAAuB,CAAA,GAAA,sBAAA,CAAA;AADb,EAAAA,OAAAA,+BAAAA,CAAAA;AAAA,CAAA,EAAA,8BAAA,IAAA,EAAA,CAAA,CAAA;AAIZ,MAAM,mCAAmCC,oCAA0C,CAAA;AAAA,EACjF,QAGK,EAAC,CAAA;AAAA,EAEN,WAAA,CAAY,SAAiB,IAAsC,EAAA;AACjE,IAAM,KAAA,CAAA,OAAA,EAAS,MAAM,kBAAkB,CAAA,CAAA;AAAA,GACzC;AAAA,EAEA,QAAQ,GAAa,EAAA;AACnB,IAAA,IAAA,CAAK,KAAQ,GAAA,EAAE,GAAG,IAAA,CAAK,OAAO,GAAI,EAAA,CAAA;AAClC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEA,oBAAoB,eAAyB,EAAA;AAC3C,IAAA,IAAA,CAAK,KAAQ,GAAA,EAAE,GAAG,IAAA,CAAK,OAAO,eAAgB,EAAA,CAAA;AAC9C,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AACF,CAAA;AAEa,MAAA,gCAAA,GAAmCC,8CAG9C,0BAA0B,CAAA;;ACzBN,eAAA,qBAAA,CACpB,cACA,UAC6B,EAAA;AAC7B,EAAI,IAAA,CAAC,cAAc,IAAM,EAAA;AACvB,IAAO,OAAA,YAAA,CAAA;AAAA,GACT;AAEA,EAAA,QAAQ,aAAa,IAAM;AAAA,IACzB,KAAK,2BAAA;AACH,MAAM,MAAA,aAAA,GAAiB,YAAa,CAAA,aAAA,IAClC,EAAC,CAAA;AAEH,MAAM,MAAA,UAAA,GAAc,MAAM,OAAQ,CAAA,GAAA;AAAA,QAChC,aAAA,CAAc,GAAI,CAAA,CAAC,GAAQ,KAAA;AACzB,UAAO,OAAA,UAAA,CAAW,UAAW,CAAA,YAAA,CAAa,GAAG,CAAA,CAAA;AAAA,SAC9C,CAAA;AAAA,OACH,CAAA;AAEA,MAAO,OAAA;AAAA,QACL,MAAM,YAAa,CAAA,IAAA;AAAA,QACnB,UAAA;AAAA,OACF,CAAA;AAAA,IAEF;AACE,MAAO,OAAA,YAAA,CAAA;AAAA,GACX;AACF;;ACtBO,MAAM,sBAAuB,CAAA;AAAA,EAOlC,WAAA,CACU,eACR,EAAA,MAAA,EACQ,UACR,EAAA;AAHQ,IAAA,IAAA,CAAA,eAAA,GAAA,eAAA,CAAA;AAEA,IAAA,IAAA,CAAA,UAAA,GAAA,UAAA,CAAA;AAER,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAA,IAAA,CAAK,SAAY,GAAA,MAAA,CAAO,SAAU,CAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAC7C,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAO,MAAO,CAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AACvC,IAAA,IAAA,CAAK,gBAAmB,GAAA,MAAA,CAAO,gBAAiB,CAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAC3D,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAO,MAAO,CAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAAA,GACzC;AAAA,EAhBQ,MAAA,CAAA;AAAA,EACD,SAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EAcA,OAAO,KAAyC,EAAA;AACrD,IAAA,IAAA,CAAK,OAAO,MAAO,CAAA;AAAA,MACjB,MAAM,KAAM,CAAA,IAAA;AAAA,MACZ,SAAS,KAAM,CAAA,OAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,iBAAiB,IAAK,CAAA,eAAA;AAAA,OACxB;AAAA,KACoB,CAAA,CAAA;AAAA,GACxB;AAAA,EAEA,iBAAA,CAAkB,MAAc,OAAiC,EAAA;AAC/D,IAAA,IAAA,CAAK,MAAO,CAAA;AAAA,MACV,MAAMC,2CAAiB,CAAA,WAAA;AAAA,MACvB,OAAS,EAAA;AAAA,QACP,GAAG,OAAA;AAAA,QACH,IAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,gBAAA,CACL,WACA,EACA,EAAA;AACA,IAAA,OAAO,IAAK,CAAA,MAAA,CAAO,SAAU,CAAA,OAAO,KAAU,KAAA;AAC5C,MAAM,MAAA,UAAA,GACJ,MAAM,IAAM,EAAA,eAAA,KAAoB,KAAK,eACrC,IAAA,KAAA,CAAM,MAAM,eAAoB,KAAA,IAAA,CAAA;AAElC,MAAA,MAAM,mBAAmB,MACvB,qBAAA,CAAiC,KAAM,CAAA,OAAA,EAAS,KAAK,UAAU,CAAA,CAAA;AAGjE,MAAA,IAAK,cAAyB,GAAK,EAAA;AACjC,QAAG,EAAA,CAAA,MAAM,kBAAkB,CAAA,CAAA;AAAA,OAIlB,MAAA,IAAA,KAAA,CAAM,IAAS,KAAAA,2CAAA,CAAiB,WAAa,EAAA;AACtD,QAAA,IAAI,SAAc,KAAA,KAAA,CAAM,OAAS,EAAA,IAAA,IAAQ,CAAC,UAAY,EAAA;AACpD,UAAG,EAAA,CAAA,MAAM,kBAAkB,CAAA,CAAA;AAAA,SAC7B;AAAA,OACS,MAAA,IAAA,KAAA,CAAM,IAAS,KAAAA,2CAAA,CAAiB,SAAW,EAAA;AACpD,QAAA,IAAI,SAAc,KAAA,KAAA,CAAM,OAAS,EAAA,IAAA,IAAQ,UAAY,EAAA;AACnD,UAAG,EAAA,CAAA,MAAM,kBAAkB,CAAA,CAAA;AAAA,SAC7B;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF;;AChFA,MAAM,qBAAwB,GAAA,GAAA,CAAA;AAC9B,MAAM,yBAA4B,GAAA,EAAA,CAAA;AAE3B,MAAM,sBAAuB,CAAA;AAAA,EAC1B,0BAA0B,MAAM;AAAA,GAAC,CAAA;AAAA,EACjC,WAAc,GAAA,KAAA,CAAA;AAAA,EACd,GAAA,CAAA;AAAA,EAER,YAAY,IAAc,EAAA;AACxB,IAAK,IAAA,CAAA,GAAA,GAAM,KAAK,IAAI,CAAA,6BAAA,CAAA,CAAA;AAGpB,IAAA,IAAI,CAAC,UAAA,CAAW,IAAK,CAAA,GAAG,CAAG,EAAA;AAEzB,MAAA,UAAA,CAAW,KAAK,GAAG,CAAA,GAAI,IAAI,OAAA,CAAc,CAAC,OAAY,KAAA;AACpD,QAAA,IAAA,CAAK,0BAA0B,MAAM;AACnC,UAAA,IAAA,CAAK,WAAc,GAAA,IAAA,CAAA;AACnB,UAAQ,OAAA,EAAA,CAAA;AAAA,SACV,CAAA;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACF;AAAA,EAEA,UAAa,GAAA;AACX,IAAO,OAAA,CAAC,CAAC,IAAK,CAAA,WAAA,CAAA;AAAA,GAChB;AAAA,EAEA,eAAkB,GAAA;AAChB,IAAA,IAAA,CAAK,uBAA0B,IAAA,CAAA;AAAA,GACjC;AAAA,EAEA,YAAe,GAAA;AACb,IAAA,OAAO,IAAI,OAAA,CAAc,CAAC,OAAA,EAAS,MAAW,KAAA;AAC5C,MAAA,IAAI,QAAW,GAAA,KAAA,CAAA;AACf,MAAI,IAAA,SAAA,CAAA;AACJ,MAAA,IAAI,UAAa,GAAA,CAAA,CAAA;AAEjB,MAAA,MAAM,UAAU,MAAM;AACpB,QAAA,IAAI,QAAU,EAAA;AACZ,UAAA,OAAA;AAAA,SACF;AAEA,QAAA,SAAA,GAAY,WAAW,MAAM;AAC3B,UAAA,UAAA,EAAA,CAAA;AAEA,UAAA,IAAI,aAAa,yBAA2B,EAAA;AAI1C,YAAI,IAAA,UAAA,GAAa,OAAO,CAAG,EAAA;AACzB,cAAQ,OAAA,CAAA,GAAA;AAAA,gBACN,gCAAA;AAAA,kBACE,8BAA+B,CAAA,oBAAA;AAAA,kBAC/B,4CAAA;AAAA,iBACA,CAAA,WAAA,CAAY,CAAc,WAAA,EAAA,UAAU,EAAE,CAAE,CAAA,OAAA;AAAA,eAC5C,CAAA;AAAA,aACF;AAEA,YAAQ,OAAA,EAAA,CAAA;AAER,YAAA,OAAA;AAAA,WACF;AAEA,UAAA,IAAI,CAAC,QAAU,EAAA;AACb,YAAA,MAAM,KAAQ,GAAA,gCAAA;AAAA,cACZ,8BAA+B,CAAA,oBAAA;AAAA,cAC/B,6CAAA;AAAA,aACF,CAAA;AAEA,YAAA,MAAA,CAAO,KAAK,CAAA,CAAA;AAAA,WACd;AAAA,WACC,qBAAqB,CAAA,CAAA;AAAA,OAC1B,CAAA;AAEA,MAAQ,OAAA,EAAA,CAAA;AAGR,MAAM,MAAA,2BAAA,GAA8B,UAAW,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AACvD,MAAA,2BAAA,CAA4B,KAAK,MAAM;AACrC,QAAW,QAAA,GAAA,IAAA,CAAA;AACX,QAAA,YAAA,CAAa,SAAS,CAAA,CAAA;AACtB,QAAQ,OAAA,EAAA,CAAA;AAAA,OACT,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF;;AChFO,MAAM,uBAA0B,GAAA,4BAAA;AAO3B,IAAA,mBAAA,qBAAAC,oBAAL,KAAA;AACL,EAAAA,qBAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,qBAAA,OAAQ,CAAA,GAAA,OAAA,CAAA;AAER,EAAAA,qBAAA,gBAAiB,CAAA,GAAA,gBAAA,CAAA;AAJP,EAAAA,OAAAA,oBAAAA,CAAAA;AAAA,CAAA,EAAA,mBAAA,IAAA,EAAA,EAAA;AAiBL,MAAM,kBAAmB,CAAA;AAAA,EAoB9B,YAAoB,kBAAyC,EAAA;AAAzC,IAAA,IAAA,CAAA,kBAAA,GAAA,kBAAA,CAAA;AAAA,GAA0C;AAAA,EAnB9D,OAAe,MAAA,GAAS,IAAI,sBAAA,CAAuB,aAAa,CAAA,CAAA;AAAA,EAEhE,aAAa,OAAO,OAA8B,EAAA;AAChD,IAAI,IAAA,UAAA,CAAW,uBAAuB,CAAG,EAAA;AACvC,MAAM,MAAA,gCAAA;AAAA,QACJ,8BAA+B,CAAA,oBAAA;AAAA,QAC/B,iEAAA;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAA,UAAA,CAAW,uBAAuB,CAAA,GAAI,IAAI,kBAAA,CAAmB,OAAO,CAAA,CAAA;AACpE,IAAA,IAAA,CAAK,OAAO,eAAgB,EAAA,CAAA;AAAA,GAC9B;AAAA,EAEA,aAAa,WAA2C,GAAA;AACtD,IAAM,MAAA,IAAA,CAAK,OAAO,YAAa,EAAA,CAAA;AAC/B,IAAA,OAAO,WAAW,uBAAuB,CAAA,CAAA;AAAA,GAC3C;AAAA,EAIA,aAAgB,GAAA;AACd,IAAA,OAAO,KAAK,kBAAmB,CAAA,UAAA,CAAA;AAAA,GACjC;AAAA,EAEA,SAAY,GAAA;AACV,IAAA,OAAO,KAAK,kBAAmB,CAAA,MAAA,CAAA;AAAA,GACjC;AAAA,EAEA,kBAAqB,GAAA;AACnB,IAAO,OAAA,IAAA,CAAK,kBAAmB,CAAA,eAAA,IAAmB,EAAC,CAAA;AAAA,GACrD;AAAA,EAEA,cAAiB,GAAA;AACf,IAAA,OAAO,KAAK,kBAAmB,CAAA,WAAA,CAAA;AAAA,GACjC;AACF;;AC9DO,MAAM,uBAA0B,GAAA,4BAAA;AA2BhC,MAAM,kBAAyD,CAAA;AAAA,EAkEpE,WAAA,CACU,oBACA,WACR,EAAA;AAFQ,IAAA,IAAA,CAAA,kBAAA,GAAA,kBAAA,CAAA;AACA,IAAA,IAAA,CAAA,WAAA,GAAA,WAAA,CAAA;AAER,IAAA,IAAA,CAAK,SAAS,IAAI,sBAAA;AAAA,MAChB,KAAK,kBAAmB,CAAA,eAAA;AAAA,MACxB,IAAA,CAAK,YAAY,SAAU,EAAA;AAAA,MAC3B,IAAA,CAAK,YAAY,aAAc,EAAA;AAAA,KACjC,CAAA;AAAA,GACF;AAAA,EA1EA,OAAe,MAAA,GAAS,IAAI,sBAAA,CAAuB,aAAa,CAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOhE,aAAa,OAA6C,OAAmB,EAAA;AAU3E,IAAI,IAAA,UAAA,CAAW,uBAAuB,CAAG,EAAA;AACvC,MAAM,MAAA,gCAAA;AAAA,QACJ,8BAA+B,CAAA,oBAAA;AAAA,QAC/B,iEAAA;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAW,UAAA,CAAA,uBAAuB,IAAI,IAAI,kBAAA;AAAA,MACxC,OAAA;AAAA,MACA,MAAM,mBAAmB,WAAY,EAAA;AAAA,KACvC,CAAA;AAEA,IAAA,IAAA,CAAK,OAAO,eAAgB,EAAA,CAAA;AAAA,GAC9B;AAAA,EAEA,aAAa,WAAoD,GAAA;AAC/D,IAAI,IAAA,OAAO,8BAA8B,WAAa,EAAA;AAMpD,MAAO,OAAA,yBAAA,CAAA;AAAA,KACT;AAEA,IAAM,MAAA,IAAA,CAAK,OAAO,YAAa,EAAA,CAAA;AAE/B,IAAA,OAAO,WAAW,uBAAuB,CAAA,CAAA;AAAA,GAiB3C;AAAA,EAEQ,MAAA,CAAA;AAAA,EAaR,kBAAqB,GAAA;AACnB,IAAA,OAAO,KAAK,kBAAmB,CAAA,eAAA,CAAA;AAAA,GACjC;AAAA,EAEA,WAAc,GAAA;AACZ,IAAA,OAAO,IAAK,CAAA,kBAAA,CAAA;AAAA,GACd;AAAA,EAEA,SAAY,GAAA;AACV,IAAA,OAAO,IAAK,CAAA,MAAA,CAAA;AAAA,GACd;AAAA,EAEA,aAAgB,GAAA;AACd,IAAO,OAAA,IAAA,CAAK,YAAY,aAAc,EAAA,CAAA;AAAA,GACxC;AAAA,EAEA,wBAA2B,GAAA;AACzB,IAAM,MAAA,eAAA,GAAkB,KAAK,kBAAmB,EAAA,CAAA;AAEhD,IAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,MAAM,MAAA,gCAAA;AAAA,QACJ,8BAA+B,CAAA,oBAAA;AAAA,QAC/B,kCAAA;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAA,OAAO,IAAK,CAAA,WAAA,CAAY,kBAAmB,EAAA,CAAE,eAAe,CAAA,CAAA;AAAA,GAC9D;AACF;;;;;;;;;"}

package/dist/esm/index.js

@@ -0,0 +1,271 @@
+import { createErrorBuilder, BaseError } from '@wix/public-editor-platform-errors';
+import { PlatformAppEvent } from '@wix/public-editor-platform-events';
+
+var EditorPlatformContextErrorCode = /* @__PURE__ */ ((EditorPlatformContextErrorCode2) => {
+  EditorPlatformContextErrorCode2["IncorrectEnvironment"] = "IncorrectEnvironment";
+  return EditorPlatformContextErrorCode2;
+})(EditorPlatformContextErrorCode || {});
+class EditorPlatformContextError extends BaseError {
+  state = {};
+  constructor(message, code) {
+    super(message, code, "EP Context Error");
+  }
+  withUrl(url) {
+    this.state = { ...this.state, url };
+    return this;
+  }
+  withAppDefinitionId(appDefinitionId) {
+    this.state = { ...this.state, appDefinitionId };
+    return this;
+  }
+}
+const createEditorPlatformContextError = createErrorBuilder(EditorPlatformContextError);
+
+async function transformEventPayload(eventPayload, privateAPI) {
+  if (!eventPayload?.type) {
+    return eventPayload;
+  }
+  switch (eventPayload.type) {
+    case "componentSelectionChanged":
+      const componentRefs = eventPayload.componentRefs || [];
+      const components = await Promise.all(
+        componentRefs.map((ref) => {
+          return privateAPI.components.getComponent(ref);
+        })
+      );
+      return {
+        type: eventPayload.type,
+        components
+      };
+    default:
+      return eventPayload;
+  }
+}
+
+class ApplicationBoundEvents {
+  constructor(appDefinitionId, events, privateAPI) {
+    this.appDefinitionId = appDefinitionId;
+    this.privateAPI = privateAPI;
+    this.events = events;
+    this.subscribe = events.subscribe.bind(events);
+    this.commit = events.commit.bind(events);
+    this.startTransaction = events.startTransaction.bind(events);
+    this.silent = events.silent.bind(events);
+  }
+  events;
+  subscribe;
+  commit;
+  startTransaction;
+  silent;
+  notify(event) {
+    this.events.notify({
+      type: event.type,
+      payload: event.payload,
+      meta: {
+        appDefinitionId: this.appDefinitionId
+      }
+    });
+  }
+  notifyCustomEvent(type, payload) {
+    this.notify({
+      type: PlatformAppEvent.CustomEvent,
+      payload: {
+        ...payload,
+        type
+      }
+    });
+  }
+  /**
+   * TODO: we should use same interface for all events
+   * (subscribe vs addEventListener)
+   */
+  addEventListener(eventType, fn) {
+    return this.events.subscribe(async (event) => {
+      const isAppMatch = event.meta?.appDefinitionId === this.appDefinitionId || event.meta?.appDefinitionId === null;
+      const transformPayload = () => transformEventPayload(event.payload, this.privateAPI);
+      if (eventType === "*") {
+        fn(await transformPayload());
+      } else if (event.type === PlatformAppEvent.CustomEvent) {
+        if (eventType === event.payload?.type && !isAppMatch) {
+          fn(await transformPayload());
+        }
+      } else if (event.type === PlatformAppEvent.HostEvent) {
+        if (eventType === event.payload?.type && isAppMatch) {
+          fn(await transformPayload());
+        }
+      }
+    });
+  }
+}
+
+const WAIT_INJECTED_TIMEOUT = 200;
+const WAIT_INJECTED_RETRY_COUNT = 50;
+class ContextInjectionStatus {
+  _resolveContextInjected = () => {
+  };
+  _isInjected = false;
+  key;
+  constructor(uuid) {
+    this.key = `__${uuid}_CONTEXT_INJECTION_STATUS_KEY`;
+    if (!globalThis[this.key]) {
+      globalThis[this.key] = new Promise((resolve) => {
+        this._resolveContextInjected = () => {
+          this._isInjected = true;
+          resolve();
+        };
+      });
+    }
+  }
+  isInjected() {
+    return !!this._isInjected;
+  }
+  resolveInjected() {
+    this._resolveContextInjected?.();
+  }
+  waitInjected() {
+    return new Promise((resolve, reject) => {
+      let injected = false;
+      let timeoutId;
+      let retryCount = 0;
+      const timeout = () => {
+        if (injected) {
+          return;
+        }
+        timeoutId = setTimeout(() => {
+          retryCount++;
+          if (retryCount < WAIT_INJECTED_RETRY_COUNT) {
+            if (retryCount % 10 === 0) {
+              console.log(
+                createEditorPlatformContextError(
+                  EditorPlatformContextErrorCode.IncorrectEnvironment,
+                  "contexts are not resolved, still re-trying"
+                ).withMessage(`try number ${retryCount}`).message
+              );
+            }
+            timeout();
+            return;
+          }
+          if (!injected) {
+            const error = createEditorPlatformContextError(
+              EditorPlatformContextErrorCode.IncorrectEnvironment,
+              "contexts are not resolved, threw by timeout"
+            );
+            reject(error);
+          }
+        }, WAIT_INJECTED_TIMEOUT);
+      };
+      timeout();
+      const _waitContextInjectedPromise = globalThis[this.key];
+      _waitContextInjectedPromise.then(() => {
+        injected = true;
+        clearTimeout(timeoutId);
+        resolve();
+      });
+    });
+  }
+}
+
+const ENVIRONMENT_CONTEXT_KEY = "__ENVIRONMENT_CONTEXT_KEY";
+var PlatformEnvironment = /* @__PURE__ */ ((PlatformEnvironment2) => {
+  PlatformEnvironment2["Worker"] = "Worker";
+  PlatformEnvironment2["Frame"] = "Frame";
+  PlatformEnvironment2["ComponentPanel"] = "ComponentPanel";
+  return PlatformEnvironment2;
+})(PlatformEnvironment || {});
+class EnvironmentContext {
+  constructor(environmentContext) {
+    this.environmentContext = environmentContext;
+  }
+  static status = new ContextInjectionStatus("environment");
+  static async inject(context) {
+    if (globalThis[ENVIRONMENT_CONTEXT_KEY]) {
+      throw createEditorPlatformContextError(
+        EditorPlatformContextErrorCode.IncorrectEnvironment,
+        "Environment context already exists and should not be overridden"
+      );
+    }
+    globalThis[ENVIRONMENT_CONTEXT_KEY] = new EnvironmentContext(context);
+    this.status.resolveInjected();
+  }
+  static async getInstance() {
+    await this.status.waitInjected();
+    return globalThis[ENVIRONMENT_CONTEXT_KEY];
+  }
+  getPrivateAPI() {
+    return this.environmentContext.privateApi;
+  }
+  getEvents() {
+    return this.environmentContext.events;
+  }
+  getApplicationAPIs() {
+    return this.environmentContext.applicationAPIs ?? {};
+  }
+  getEnvironment() {
+    return this.environmentContext.environment;
+  }
+}
+
+const APPLICATION_CONTEXT_KEY = "__APPLICATION_CONTEXT_KEY";
+class ApplicationContext {
+  constructor(applicationContext, environment) {
+    this.applicationContext = applicationContext;
+    this.environment = environment;
+    this.events = new ApplicationBoundEvents(
+      this.applicationContext.appDefinitionId,
+      this.environment.getEvents(),
+      this.environment.getPrivateAPI()
+    );
+  }
+  static status = new ContextInjectionStatus("application");
+  /**
+   * TODO: use generics for context type
+   * - application
+   * - editor
+   */
+  static async inject(context) {
+    if (globalThis[APPLICATION_CONTEXT_KEY]) {
+      throw createEditorPlatformContextError(
+        EditorPlatformContextErrorCode.IncorrectEnvironment,
+        "Application context already exists and should not be overridden"
+      );
+    }
+    globalThis[APPLICATION_CONTEXT_KEY] = new ApplicationContext(
+      context,
+      await EnvironmentContext.getInstance()
+    );
+    this.status.resolveInjected();
+  }
+  static async getInstance() {
+    if (typeof __APPLICATION_CONTEXT_KEY !== "undefined") {
+      return __APPLICATION_CONTEXT_KEY;
+    }
+    await this.status.waitInjected();
+    return globalThis[APPLICATION_CONTEXT_KEY];
+  }
+  events;
+  getAppDefinitionId() {
+    return this.applicationContext.appDefinitionId;
+  }
+  getBindings() {
+    return this.applicationContext;
+  }
+  getEvents() {
+    return this.events;
+  }
+  getPrivateAPI() {
+    return this.environment.getPrivateAPI();
+  }
+  getPrivateApplicationAPI() {
+    const appDefinitionId = this.getAppDefinitionId();
+    if (!appDefinitionId) {
+      throw createEditorPlatformContextError(
+        EditorPlatformContextErrorCode.IncorrectEnvironment,
+        "appDefinitionId is not available"
+      );
+    }
+    return this.environment.getApplicationAPIs()[appDefinitionId];
+  }
+}
+
+export { APPLICATION_CONTEXT_KEY, ApplicationBoundEvents, ApplicationContext, ENVIRONMENT_CONTEXT_KEY, EnvironmentContext, PlatformEnvironment };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/errors.ts","../../src/ApplicationBoundEvents/transformEventPayload.ts","../../src/ApplicationBoundEvents/ApplicationBoundEvents.ts","../../src/contexts/ContextInjectionStatus.ts","../../src/contexts/EnvironmentContext.ts","../../src/contexts/ApplicationContext.ts"],"sourcesContent":["import {\n  BaseError,\n  createErrorBuilder,\n} from '@wix/public-editor-platform-errors';\n\nexport enum EditorPlatformContextErrorCode {\n  IncorrectEnvironment = 'IncorrectEnvironment',\n}\n\nclass EditorPlatformContextError extends BaseError<EditorPlatformContextErrorCode> {\n  state: Partial<{\n    url: string;\n    appDefinitionId: string;\n  }> = {};\n\n  constructor(message: string, code: EditorPlatformContextErrorCode) {\n    super(message, code, 'EP Context Error');\n  }\n\n  withUrl(url: string) {\n    this.state = { ...this.state, url };\n    return this;\n  }\n\n  withAppDefinitionId(appDefinitionId: string) {\n    this.state = { ...this.state, appDefinitionId };\n    return this;\n  }\n}\n\nexport const createEditorPlatformContextError = createErrorBuilder<\n  EditorPlatformContextErrorCode,\n  EditorPlatformContextError\n>(EditorPlatformContextError);\n","import type { ComponentRef } from '@wix/public-editor-platform-interfaces';\nimport {\n  AllowedEvents,\n  AppEventPayload,\n  IComponent,\n  PrivateAPIFixMe,\n} from './types';\n\nexport async function transformEventPayload<T extends AllowedEvents>(\n  eventPayload: Record<string, string>,\n  privateAPI: PrivateAPIFixMe,\n): Promise<AppEventPayload<T>> {\n  if (!eventPayload?.type) {\n    return eventPayload as AppEventPayload<T>;\n  }\n\n  switch (eventPayload.type) {\n    case 'componentSelectionChanged':\n      const componentRefs = (eventPayload.componentRefs ||\n        []) as unknown as ComponentRef[];\n\n      const components = (await Promise.all(\n        componentRefs.map((ref) => {\n          return privateAPI.components.getComponent(ref);\n        }),\n      )) as IComponent[];\n\n      return {\n        type: eventPayload.type,\n        components,\n      } as AppEventPayload<T>;\n\n    default:\n      return eventPayload as AppEventPayload<T>;\n  }\n}\n","import {\n  PlatformAppEvent,\n  PlatformAppEventEmitter,\n  IPlatformAppEvent,\n} from '@wix/public-editor-platform-events';\nimport { AllowedEvents, AppEventPayload, PrivateAPIFixMe } from './types';\nimport { transformEventPayload } from './transformEventPayload';\n\nexport type OmitEventMeta<T> = T extends { meta: any } ? Omit<T, 'meta'> : T;\n\n/**\n * TODO: should not be in this package\n */\nexport class ApplicationBoundEvents {\n  private events: PlatformAppEventEmitter;\n  public subscribe;\n  public commit;\n  public startTransaction;\n  public silent;\n\n  constructor(\n    private appDefinitionId: string,\n    events: PlatformAppEventEmitter,\n    private privateAPI: PrivateAPIFixMe,\n  ) {\n    this.events = events;\n    this.subscribe = events.subscribe.bind(events);\n    this.commit = events.commit.bind(events);\n    this.startTransaction = events.startTransaction.bind(events);\n    this.silent = events.silent.bind(events);\n  }\n\n  public notify(event: OmitEventMeta<IPlatformAppEvent>) {\n    this.events.notify({\n      type: event.type,\n      payload: event.payload,\n      meta: {\n        appDefinitionId: this.appDefinitionId,\n      },\n    } as IPlatformAppEvent);\n  }\n\n  notifyCustomEvent(type: string, payload: Record<string, string>) {\n    this.notify({\n      type: PlatformAppEvent.CustomEvent,\n      payload: {\n        ...payload,\n        type,\n      },\n    });\n  }\n\n  /**\n   * TODO: we should use same interface for all events\n   * (subscribe vs addEventListener)\n   */\n  public addEventListener<EventType extends AllowedEvents>(\n    eventType: EventType,\n    fn: (payload: AppEventPayload<EventType>) => void,\n  ) {\n    return this.events.subscribe(async (event) => {\n      const isAppMatch =\n        event.meta?.appDefinitionId === this.appDefinitionId ||\n        event.meta?.appDefinitionId === null;\n\n      const transformPayload = () =>\n        transformEventPayload<EventType>(event.payload, this.privateAPI);\n\n      // as an exception to skip autocomplete\n      if ((eventType as string) === '*') {\n        fn(await transformPayload());\n        /**\n         * We need to check for app match here to not listen app's own events\n         */\n      } else if (event.type === PlatformAppEvent.CustomEvent) {\n        if (eventType === event.payload?.type && !isAppMatch) {\n          fn(await transformPayload());\n        }\n      } else if (event.type === PlatformAppEvent.HostEvent) {\n        if (eventType === event.payload?.type && isAppMatch) {\n          fn(await transformPayload());\n        }\n      }\n    });\n  }\n}\n","import {\n  createEditorPlatformContextError,\n  EditorPlatformContextErrorCode,\n} from '../errors';\n\nconst WAIT_INJECTED_TIMEOUT = 200;\nconst WAIT_INJECTED_RETRY_COUNT = 50;\n\nexport class ContextInjectionStatus {\n  private _resolveContextInjected = () => {};\n  private _isInjected = false;\n  private key: string;\n\n  constructor(uuid: string) {\n    this.key = `__${uuid}_CONTEXT_INJECTION_STATUS_KEY`;\n\n    // @ts-expect-error xxx\n    if (!globalThis[this.key]) {\n      // @ts-expect-error xxx\n      globalThis[this.key] = new Promise<void>((resolve) => {\n        this._resolveContextInjected = () => {\n          this._isInjected = true;\n          resolve();\n        };\n      });\n    }\n  }\n\n  isInjected() {\n    return !!this._isInjected;\n  }\n\n  resolveInjected() {\n    this._resolveContextInjected?.();\n  }\n\n  waitInjected() {\n    return new Promise<void>((resolve, reject) => {\n      let injected = false;\n      let timeoutId: ReturnType<typeof setTimeout>;\n      let retryCount = 0;\n\n      const timeout = () => {\n        if (injected) {\n          return;\n        }\n\n        timeoutId = setTimeout(() => {\n          retryCount++;\n\n          if (retryCount < WAIT_INJECTED_RETRY_COUNT) {\n            /**\n             * just log that we are re-trying to connect (each 2 sec+-)\n             */\n            if (retryCount % 10 === 0) {\n              console.log(\n                createEditorPlatformContextError(\n                  EditorPlatformContextErrorCode.IncorrectEnvironment,\n                  'contexts are not resolved, still re-trying',\n                ).withMessage(`try number ${retryCount}`).message,\n              );\n            }\n\n            timeout();\n\n            return;\n          }\n\n          if (!injected) {\n            const error = createEditorPlatformContextError(\n              EditorPlatformContextErrorCode.IncorrectEnvironment,\n              'contexts are not resolved, threw by timeout',\n            );\n\n            reject(error);\n          }\n        }, WAIT_INJECTED_TIMEOUT);\n      };\n\n      timeout();\n\n      // @ts-expect-error xxx\n      const _waitContextInjectedPromise = globalThis[this.key];\n      _waitContextInjectedPromise.then(() => {\n        injected = true;\n        clearTimeout(timeoutId);\n        resolve();\n      });\n    });\n  }\n}\n","import { PlatformAppEventEmitter } from '@wix/public-editor-platform-events';\nimport { WithPromiseFunctions } from '@wix/editor-platform-transport';\nimport {\n  createEditorPlatformContextError,\n  EditorPlatformContextErrorCode,\n} from '../errors';\nimport { ContextInjectionStatus } from './ContextInjectionStatus';\n\nexport type IPrivateAPIFixMe = any; // TODO: replace with the real type\n\nexport const ENVIRONMENT_CONTEXT_KEY = '__ENVIRONMENT_CONTEXT_KEY';\n\ndeclare global {\n  // eslint-disable-next-line no-var\n  var __ENVIRONMENT_CONTEXT_KEY: EnvironmentContext;\n}\n\nexport enum PlatformEnvironment {\n  Worker = 'Worker',\n  Frame = 'Frame',\n  // TODO - rename to MainThread\n  ComponentPanel = 'ComponentPanel',\n}\n\nexport interface IEnvironmentContext {\n  environment: PlatformEnvironment;\n  privateApi: WithPromiseFunctions<IPrivateAPIFixMe>;\n  events: PlatformAppEventEmitter;\n  /**\n   * Probably, we need to rename this prop\n   */\n  applicationAPIs?: Record<string, any>;\n}\n\nexport class EnvironmentContext {\n  private static status = new ContextInjectionStatus('environment');\n\n  static async inject(context: IEnvironmentContext) {\n    if (globalThis[ENVIRONMENT_CONTEXT_KEY]) {\n      throw createEditorPlatformContextError(\n        EditorPlatformContextErrorCode.IncorrectEnvironment,\n        'Environment context already exists and should not be overridden',\n      );\n    }\n\n    globalThis[ENVIRONMENT_CONTEXT_KEY] = new EnvironmentContext(context);\n    this.status.resolveInjected();\n  }\n\n  static async getInstance(): Promise<EnvironmentContext> {\n    await this.status.waitInjected();\n    return globalThis[ENVIRONMENT_CONTEXT_KEY];\n  }\n\n  constructor(private environmentContext: IEnvironmentContext) {}\n\n  getPrivateAPI() {\n    return this.environmentContext.privateApi;\n  }\n\n  getEvents() {\n    return this.environmentContext.events;\n  }\n\n  getApplicationAPIs() {\n    return this.environmentContext.applicationAPIs ?? {};\n  }\n\n  getEnvironment() {\n    return this.environmentContext.environment;\n  }\n}\n","import {\n  createEditorPlatformContextError,\n  EditorPlatformContextErrorCode,\n} from '../errors';\n\nimport { ApplicationBoundEvents } from '../ApplicationBoundEvents';\nimport { EnvironmentContext, PlatformEnvironment } from './EnvironmentContext';\nimport { ContextInjectionStatus } from './ContextInjectionStatus';\n\nexport const APPLICATION_CONTEXT_KEY = '__APPLICATION_CONTEXT_KEY';\ndeclare global {\n  // eslint-disable-next-line no-var\n  var __APPLICATION_CONTEXT_KEY: ApplicationContext<IApplicationContext>;\n}\n\nexport type IEditorApplicationContext = {\n  appDefinitionId: string;\n};\n\nexport type IAddonContext = {\n  appDefinitionId: string;\n  appDefinitionName: string;\n  data: {\n    toolPanelConfig: {\n      url: string;\n      width: string;\n      height: string;\n      initialPosition: {\n        x: string;\n        y: string;\n      };\n    };\n  };\n};\n\nexport type IApplicationContext = IEditorApplicationContext | IAddonContext;\nexport class ApplicationContext<TContext extends IApplicationContext> {\n  private static status = new ContextInjectionStatus('application');\n\n  /**\n   * TODO: use generics for context type\n   * - application\n   * - editor\n   */\n  static async inject<TContext extends IApplicationContext>(context: TContext) {\n    // const environment = await EnvironmentContext.getInstance();\n\n    // if (environment.getEnvironment() !== PlatformEnvironment.Frame) {\n    //   throw createEditorPlatformContextError(\n    //     EditorPlatformContextErrorCode.IncorrectEnvironment,\n    //     'Application context can be injected only in frame environment',\n    //   );\n    // }\n\n    if (globalThis[APPLICATION_CONTEXT_KEY]) {\n      throw createEditorPlatformContextError(\n        EditorPlatformContextErrorCode.IncorrectEnvironment,\n        'Application context already exists and should not be overridden',\n      );\n    }\n\n    globalThis[APPLICATION_CONTEXT_KEY] = new ApplicationContext(\n      context,\n      await EnvironmentContext.getInstance(),\n    );\n\n    this.status.resolveInjected();\n  }\n\n  static async getInstance<TContext extends IApplicationContext>() {\n    if (typeof __APPLICATION_CONTEXT_KEY !== 'undefined') {\n      /**\n       * NOTE it is taken not from global\n       * __APPLICATION_CONTEXT_KEY is the variable which set during\n       * application bundle execution using new Function() approach\n       */\n      return __APPLICATION_CONTEXT_KEY as ApplicationContext<TContext>;\n    }\n\n    await this.status.waitInjected();\n\n    return globalThis[APPLICATION_CONTEXT_KEY] as ApplicationContext<TContext>;\n\n    // const environment = await EnvironmentContext.getInstance();\n\n    // if (environment.getEnvironment() === PlatformEnvironment.Frame) {\n    //   await this.status.waitInjected();\n    //   return globalThis[\n    //     APPLICATION_CONTEXT_KEY\n    //   ] as ApplicationContext<TContext>;\n    // } else {\n    //   /**\n    //    * NOTE it is taken not from global\n    //    * __APPLICATION_CONTEXT_KEY is the variable which set during\n    //    * application bundle execution using new Function() approach\n    //    */\n    //   return __APPLICATION_CONTEXT_KEY as ApplicationContext<TContext>;\n    // }\n  }\n\n  private events: ApplicationBoundEvents;\n\n  constructor(\n    private applicationContext: TContext,\n    private environment: EnvironmentContext,\n  ) {\n    this.events = new ApplicationBoundEvents(\n      this.applicationContext.appDefinitionId,\n      this.environment.getEvents(),\n      this.environment.getPrivateAPI(),\n    );\n  }\n\n  getAppDefinitionId() {\n    return this.applicationContext.appDefinitionId;\n  }\n\n  getBindings() {\n    return this.applicationContext;\n  }\n\n  getEvents() {\n    return this.events;\n  }\n\n  getPrivateAPI() {\n    return this.environment.getPrivateAPI();\n  }\n\n  getPrivateApplicationAPI() {\n    const appDefinitionId = this.getAppDefinitionId();\n\n    if (!appDefinitionId) {\n      throw createEditorPlatformContextError(\n        EditorPlatformContextErrorCode.IncorrectEnvironment,\n        'appDefinitionId is not available',\n      );\n    }\n\n    return this.environment.getApplicationAPIs()[appDefinitionId];\n  }\n}\n"],"names":["EditorPlatformContextErrorCode","PlatformEnvironment"],"mappings":";;;AAKY,IAAA,8BAAA,qBAAAA,+BAAL,KAAA;AACL,EAAAA,gCAAA,sBAAuB,CAAA,GAAA,sBAAA,CAAA;AADb,EAAAA,OAAAA,+BAAAA,CAAAA;AAAA,CAAA,EAAA,8BAAA,IAAA,EAAA,CAAA,CAAA;AAIZ,MAAM,mCAAmC,SAA0C,CAAA;AAAA,EACjF,QAGK,EAAC,CAAA;AAAA,EAEN,WAAA,CAAY,SAAiB,IAAsC,EAAA;AACjE,IAAM,KAAA,CAAA,OAAA,EAAS,MAAM,kBAAkB,CAAA,CAAA;AAAA,GACzC;AAAA,EAEA,QAAQ,GAAa,EAAA;AACnB,IAAA,IAAA,CAAK,KAAQ,GAAA,EAAE,GAAG,IAAA,CAAK,OAAO,GAAI,EAAA,CAAA;AAClC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEA,oBAAoB,eAAyB,EAAA;AAC3C,IAAA,IAAA,CAAK,KAAQ,GAAA,EAAE,GAAG,IAAA,CAAK,OAAO,eAAgB,EAAA,CAAA;AAC9C,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AACF,CAAA;AAEa,MAAA,gCAAA,GAAmC,mBAG9C,0BAA0B,CAAA;;ACzBN,eAAA,qBAAA,CACpB,cACA,UAC6B,EAAA;AAC7B,EAAI,IAAA,CAAC,cAAc,IAAM,EAAA;AACvB,IAAO,OAAA,YAAA,CAAA;AAAA,GACT;AAEA,EAAA,QAAQ,aAAa,IAAM;AAAA,IACzB,KAAK,2BAAA;AACH,MAAM,MAAA,aAAA,GAAiB,YAAa,CAAA,aAAA,IAClC,EAAC,CAAA;AAEH,MAAM,MAAA,UAAA,GAAc,MAAM,OAAQ,CAAA,GAAA;AAAA,QAChC,aAAA,CAAc,GAAI,CAAA,CAAC,GAAQ,KAAA;AACzB,UAAO,OAAA,UAAA,CAAW,UAAW,CAAA,YAAA,CAAa,GAAG,CAAA,CAAA;AAAA,SAC9C,CAAA;AAAA,OACH,CAAA;AAEA,MAAO,OAAA;AAAA,QACL,MAAM,YAAa,CAAA,IAAA;AAAA,QACnB,UAAA;AAAA,OACF,CAAA;AAAA,IAEF;AACE,MAAO,OAAA,YAAA,CAAA;AAAA,GACX;AACF;;ACtBO,MAAM,sBAAuB,CAAA;AAAA,EAOlC,WAAA,CACU,eACR,EAAA,MAAA,EACQ,UACR,EAAA;AAHQ,IAAA,IAAA,CAAA,eAAA,GAAA,eAAA,CAAA;AAEA,IAAA,IAAA,CAAA,UAAA,GAAA,UAAA,CAAA;AAER,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAA,IAAA,CAAK,SAAY,GAAA,MAAA,CAAO,SAAU,CAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAC7C,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAO,MAAO,CAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AACvC,IAAA,IAAA,CAAK,gBAAmB,GAAA,MAAA,CAAO,gBAAiB,CAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAC3D,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAO,MAAO,CAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAAA,GACzC;AAAA,EAhBQ,MAAA,CAAA;AAAA,EACD,SAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EAcA,OAAO,KAAyC,EAAA;AACrD,IAAA,IAAA,CAAK,OAAO,MAAO,CAAA;AAAA,MACjB,MAAM,KAAM,CAAA,IAAA;AAAA,MACZ,SAAS,KAAM,CAAA,OAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,iBAAiB,IAAK,CAAA,eAAA;AAAA,OACxB;AAAA,KACoB,CAAA,CAAA;AAAA,GACxB;AAAA,EAEA,iBAAA,CAAkB,MAAc,OAAiC,EAAA;AAC/D,IAAA,IAAA,CAAK,MAAO,CAAA;AAAA,MACV,MAAM,gBAAiB,CAAA,WAAA;AAAA,MACvB,OAAS,EAAA;AAAA,QACP,GAAG,OAAA;AAAA,QACH,IAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,gBAAA,CACL,WACA,EACA,EAAA;AACA,IAAA,OAAO,IAAK,CAAA,MAAA,CAAO,SAAU,CAAA,OAAO,KAAU,KAAA;AAC5C,MAAM,MAAA,UAAA,GACJ,MAAM,IAAM,EAAA,eAAA,KAAoB,KAAK,eACrC,IAAA,KAAA,CAAM,MAAM,eAAoB,KAAA,IAAA,CAAA;AAElC,MAAA,MAAM,mBAAmB,MACvB,qBAAA,CAAiC,KAAM,CAAA,OAAA,EAAS,KAAK,UAAU,CAAA,CAAA;AAGjE,MAAA,IAAK,cAAyB,GAAK,EAAA;AACjC,QAAG,EAAA,CAAA,MAAM,kBAAkB,CAAA,CAAA;AAAA,OAIlB,MAAA,IAAA,KAAA,CAAM,IAAS,KAAA,gBAAA,CAAiB,WAAa,EAAA;AACtD,QAAA,IAAI,SAAc,KAAA,KAAA,CAAM,OAAS,EAAA,IAAA,IAAQ,CAAC,UAAY,EAAA;AACpD,UAAG,EAAA,CAAA,MAAM,kBAAkB,CAAA,CAAA;AAAA,SAC7B;AAAA,OACS,MAAA,IAAA,KAAA,CAAM,IAAS,KAAA,gBAAA,CAAiB,SAAW,EAAA;AACpD,QAAA,IAAI,SAAc,KAAA,KAAA,CAAM,OAAS,EAAA,IAAA,IAAQ,UAAY,EAAA;AACnD,UAAG,EAAA,CAAA,MAAM,kBAAkB,CAAA,CAAA;AAAA,SAC7B;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF;;AChFA,MAAM,qBAAwB,GAAA,GAAA,CAAA;AAC9B,MAAM,yBAA4B,GAAA,EAAA,CAAA;AAE3B,MAAM,sBAAuB,CAAA;AAAA,EAC1B,0BAA0B,MAAM;AAAA,GAAC,CAAA;AAAA,EACjC,WAAc,GAAA,KAAA,CAAA;AAAA,EACd,GAAA,CAAA;AAAA,EAER,YAAY,IAAc,EAAA;AACxB,IAAK,IAAA,CAAA,GAAA,GAAM,KAAK,IAAI,CAAA,6BAAA,CAAA,CAAA;AAGpB,IAAA,IAAI,CAAC,UAAA,CAAW,IAAK,CAAA,GAAG,CAAG,EAAA;AAEzB,MAAA,UAAA,CAAW,KAAK,GAAG,CAAA,GAAI,IAAI,OAAA,CAAc,CAAC,OAAY,KAAA;AACpD,QAAA,IAAA,CAAK,0BAA0B,MAAM;AACnC,UAAA,IAAA,CAAK,WAAc,GAAA,IAAA,CAAA;AACnB,UAAQ,OAAA,EAAA,CAAA;AAAA,SACV,CAAA;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACF;AAAA,EAEA,UAAa,GAAA;AACX,IAAO,OAAA,CAAC,CAAC,IAAK,CAAA,WAAA,CAAA;AAAA,GAChB;AAAA,EAEA,eAAkB,GAAA;AAChB,IAAA,IAAA,CAAK,uBAA0B,IAAA,CAAA;AAAA,GACjC;AAAA,EAEA,YAAe,GAAA;AACb,IAAA,OAAO,IAAI,OAAA,CAAc,CAAC,OAAA,EAAS,MAAW,KAAA;AAC5C,MAAA,IAAI,QAAW,GAAA,KAAA,CAAA;AACf,MAAI,IAAA,SAAA,CAAA;AACJ,MAAA,IAAI,UAAa,GAAA,CAAA,CAAA;AAEjB,MAAA,MAAM,UAAU,MAAM;AACpB,QAAA,IAAI,QAAU,EAAA;AACZ,UAAA,OAAA;AAAA,SACF;AAEA,QAAA,SAAA,GAAY,WAAW,MAAM;AAC3B,UAAA,UAAA,EAAA,CAAA;AAEA,UAAA,IAAI,aAAa,yBAA2B,EAAA;AAI1C,YAAI,IAAA,UAAA,GAAa,OAAO,CAAG,EAAA;AACzB,cAAQ,OAAA,CAAA,GAAA;AAAA,gBACN,gCAAA;AAAA,kBACE,8BAA+B,CAAA,oBAAA;AAAA,kBAC/B,4CAAA;AAAA,iBACA,CAAA,WAAA,CAAY,CAAc,WAAA,EAAA,UAAU,EAAE,CAAE,CAAA,OAAA;AAAA,eAC5C,CAAA;AAAA,aACF;AAEA,YAAQ,OAAA,EAAA,CAAA;AAER,YAAA,OAAA;AAAA,WACF;AAEA,UAAA,IAAI,CAAC,QAAU,EAAA;AACb,YAAA,MAAM,KAAQ,GAAA,gCAAA;AAAA,cACZ,8BAA+B,CAAA,oBAAA;AAAA,cAC/B,6CAAA;AAAA,aACF,CAAA;AAEA,YAAA,MAAA,CAAO,KAAK,CAAA,CAAA;AAAA,WACd;AAAA,WACC,qBAAqB,CAAA,CAAA;AAAA,OAC1B,CAAA;AAEA,MAAQ,OAAA,EAAA,CAAA;AAGR,MAAM,MAAA,2BAAA,GAA8B,UAAW,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AACvD,MAAA,2BAAA,CAA4B,KAAK,MAAM;AACrC,QAAW,QAAA,GAAA,IAAA,CAAA;AACX,QAAA,YAAA,CAAa,SAAS,CAAA,CAAA;AACtB,QAAQ,OAAA,EAAA,CAAA;AAAA,OACT,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF;;AChFO,MAAM,uBAA0B,GAAA,4BAAA;AAO3B,IAAA,mBAAA,qBAAAC,oBAAL,KAAA;AACL,EAAAA,qBAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,qBAAA,OAAQ,CAAA,GAAA,OAAA,CAAA;AAER,EAAAA,qBAAA,gBAAiB,CAAA,GAAA,gBAAA,CAAA;AAJP,EAAAA,OAAAA,oBAAAA,CAAAA;AAAA,CAAA,EAAA,mBAAA,IAAA,EAAA,EAAA;AAiBL,MAAM,kBAAmB,CAAA;AAAA,EAoB9B,YAAoB,kBAAyC,EAAA;AAAzC,IAAA,IAAA,CAAA,kBAAA,GAAA,kBAAA,CAAA;AAAA,GAA0C;AAAA,EAnB9D,OAAe,MAAA,GAAS,IAAI,sBAAA,CAAuB,aAAa,CAAA,CAAA;AAAA,EAEhE,aAAa,OAAO,OAA8B,EAAA;AAChD,IAAI,IAAA,UAAA,CAAW,uBAAuB,CAAG,EAAA;AACvC,MAAM,MAAA,gCAAA;AAAA,QACJ,8BAA+B,CAAA,oBAAA;AAAA,QAC/B,iEAAA;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAA,UAAA,CAAW,uBAAuB,CAAA,GAAI,IAAI,kBAAA,CAAmB,OAAO,CAAA,CAAA;AACpE,IAAA,IAAA,CAAK,OAAO,eAAgB,EAAA,CAAA;AAAA,GAC9B;AAAA,EAEA,aAAa,WAA2C,GAAA;AACtD,IAAM,MAAA,IAAA,CAAK,OAAO,YAAa,EAAA,CAAA;AAC/B,IAAA,OAAO,WAAW,uBAAuB,CAAA,CAAA;AAAA,GAC3C;AAAA,EAIA,aAAgB,GAAA;AACd,IAAA,OAAO,KAAK,kBAAmB,CAAA,UAAA,CAAA;AAAA,GACjC;AAAA,EAEA,SAAY,GAAA;AACV,IAAA,OAAO,KAAK,kBAAmB,CAAA,MAAA,CAAA;AAAA,GACjC;AAAA,EAEA,kBAAqB,GAAA;AACnB,IAAO,OAAA,IAAA,CAAK,kBAAmB,CAAA,eAAA,IAAmB,EAAC,CAAA;AAAA,GACrD;AAAA,EAEA,cAAiB,GAAA;AACf,IAAA,OAAO,KAAK,kBAAmB,CAAA,WAAA,CAAA;AAAA,GACjC;AACF;;AC9DO,MAAM,uBAA0B,GAAA,4BAAA;AA2BhC,MAAM,kBAAyD,CAAA;AAAA,EAkEpE,WAAA,CACU,oBACA,WACR,EAAA;AAFQ,IAAA,IAAA,CAAA,kBAAA,GAAA,kBAAA,CAAA;AACA,IAAA,IAAA,CAAA,WAAA,GAAA,WAAA,CAAA;AAER,IAAA,IAAA,CAAK,SAAS,IAAI,sBAAA;AAAA,MAChB,KAAK,kBAAmB,CAAA,eAAA;AAAA,MACxB,IAAA,CAAK,YAAY,SAAU,EAAA;AAAA,MAC3B,IAAA,CAAK,YAAY,aAAc,EAAA;AAAA,KACjC,CAAA;AAAA,GACF;AAAA,EA1EA,OAAe,MAAA,GAAS,IAAI,sBAAA,CAAuB,aAAa,CAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOhE,aAAa,OAA6C,OAAmB,EAAA;AAU3E,IAAI,IAAA,UAAA,CAAW,uBAAuB,CAAG,EAAA;AACvC,MAAM,MAAA,gCAAA;AAAA,QACJ,8BAA+B,CAAA,oBAAA;AAAA,QAC/B,iEAAA;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAW,UAAA,CAAA,uBAAuB,IAAI,IAAI,kBAAA;AAAA,MACxC,OAAA;AAAA,MACA,MAAM,mBAAmB,WAAY,EAAA;AAAA,KACvC,CAAA;AAEA,IAAA,IAAA,CAAK,OAAO,eAAgB,EAAA,CAAA;AAAA,GAC9B;AAAA,EAEA,aAAa,WAAoD,GAAA;AAC/D,IAAI,IAAA,OAAO,8BAA8B,WAAa,EAAA;AAMpD,MAAO,OAAA,yBAAA,CAAA;AAAA,KACT;AAEA,IAAM,MAAA,IAAA,CAAK,OAAO,YAAa,EAAA,CAAA;AAE/B,IAAA,OAAO,WAAW,uBAAuB,CAAA,CAAA;AAAA,GAiB3C;AAAA,EAEQ,MAAA,CAAA;AAAA,EAaR,kBAAqB,GAAA;AACnB,IAAA,OAAO,KAAK,kBAAmB,CAAA,eAAA,CAAA;AAAA,GACjC;AAAA,EAEA,WAAc,GAAA;AACZ,IAAA,OAAO,IAAK,CAAA,kBAAA,CAAA;AAAA,GACd;AAAA,EAEA,SAAY,GAAA;AACV,IAAA,OAAO,IAAK,CAAA,MAAA,CAAA;AAAA,GACd;AAAA,EAEA,aAAgB,GAAA;AACd,IAAO,OAAA,IAAA,CAAK,YAAY,aAAc,EAAA,CAAA;AAAA,GACxC;AAAA,EAEA,wBAA2B,GAAA;AACzB,IAAM,MAAA,eAAA,GAAkB,KAAK,kBAAmB,EAAA,CAAA;AAEhD,IAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,MAAM,MAAA,gCAAA;AAAA,QACJ,8BAA+B,CAAA,oBAAA;AAAA,QAC/B,kCAAA;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAA,OAAO,IAAK,CAAA,WAAA,CAAY,kBAAmB,EAAA,CAAE,eAAe,CAAA,CAAA;AAAA,GAC9D;AACF;;;;"}

package/dist/types/index.d.ts

@@ -0,0 +1,127 @@
+import * as _wix_editor_platform_transport from '@wix/editor-platform-transport';
+import { WithPromiseFunctions } from '@wix/editor-platform-transport';
+import { IPlatformAppEvent, PlatformAppEventEmitter } 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;
+/**
+ * TODO: should not be in this package
+ */
+declare class ApplicationBoundEvents {
+    private appDefinitionId;
+    private privateAPI;
+    private events;
+    subscribe: (callback: (event: IPlatformAppEvent) => void) => () => void;
+    commit: () => void;
+    startTransaction: () => void;
+    silent: (isSilent?: boolean) => 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 = any;
+declare const ENVIRONMENT_CONTEXT_KEY = "__ENVIRONMENT_CONTEXT_KEY";
+declare global {
+    var __ENVIRONMENT_CONTEXT_KEY: EnvironmentContext;
+}
+declare enum PlatformEnvironment {
+    Worker = "Worker",
+    Frame = "Frame",
+    ComponentPanel = "ComponentPanel"
+}
+interface IEnvironmentContext {
+    environment: PlatformEnvironment;
+    privateApi: WithPromiseFunctions<IPrivateAPIFixMe>;
+    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 const APPLICATION_CONTEXT_KEY = "__APPLICATION_CONTEXT_KEY";
+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;
+}
+
+export { APPLICATION_CONTEXT_KEY, type AllowedEvents, type AppEventPayload, ApplicationBoundEvents, ApplicationContext, ENVIRONMENT_CONTEXT_KEY, EnvironmentContext, type IAddonContext, type IApplicationContext, type IComponent, type IEditorApplicationContext, type IEnvironmentContext, type IPrivateAPIFixMe, type OmitEventMeta, PlatformEnvironment, type PrivateAPIFixMe };
+//# 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/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@wix/editor-platform-contexts",
+  "version": "1.0.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"
+  },
+  "keywords": [],
+  "files": [
+    "dist/cjs",
+    "dist/esm",
+    "dist/types"
+  ],
+  "author": {
+    "name": "Editor Platform <editor-platform-dev@wix.com>",
+    "email": "editor-platform-dev@wix.com"
+  },
+  "license": "UNLICENSED",
+  "devDependencies": {
+    "esbuild": "^0.24.2",
+    "eslint": "^8.57.1",
+    "prettier": "^3.4.2",
+    "rollup": "^3.29.5",
+    "rollup-plugin-dts": "^6.1.1",
+    "rollup-plugin-esbuild": "^5.0.0",
+    "typescript": "^5.7.2"
+  },
+  "dependencies": {
+    "@wix/editor-platform-transport": "1.11.0",
+    "@wix/public-editor-platform-errors": "1.8.0",
+    "@wix/public-editor-platform-events": "1.304.0",
+    "@wix/public-editor-platform-interfaces": "1.15.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "unpkg": true,
+  "lint-staged": {
+    "*.{js,ts}": "yarn run lint"
+  },
+  "wix": {
+    "artifact": {
+      "groupId": "com.wixpress",
+      "artifactId": "editor-platform-contexts",
+      "targets": {
+        "static": true
+      }
+    },
+    "validations": {
+      "postDependenciesBuild": [
+        "lint"
+      ]
+    }
+  },
+  "falconPackageHash": "e4afa6af68f165bda7414a67c17edf737680f01c344dd59e0ec865b0"
+}