@wix/editor 1.287.0

package/dist/types/index.d.ts

@@ -0,0 +1,224 @@
+import * as _wix_sdk_types from '@wix/sdk-types';
+import * as _wix_editor_platform_transport from '@wix/editor-platform-transport';
+import { WithPromiseFunctions } from '@wix/editor-platform-transport';
+import { PlatformAppEventEmitter, IPlatformAppEvent } from '@wix/public-editor-platform-events';
+import { ComponentRef } from '@wix/public-editor-platform-interfaces';
+
+declare const _default$5: {
+    __type: "host";
+    create: () => {
+        getPrivateAPI: <TApplicationPrivateAPI = any>() => Promise<TApplicationPrivateAPI>;
+        getPublicAPI: <TApplicationPrivateAPI_1 = any>(appDefinitionId: string) => Promise<TApplicationPrivateAPI_1>;
+        getAppInstance: () => Promise<any>;
+    };
+};
+
+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 = any;
+declare global {
+    var __ENVIRONMENT_CONTEXT_KEY: EnvironmentContext;
+}
+declare enum PlatformEnvironment {
+    Worker = "Worker",
+    Frame = "Frame"
+}
+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 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 const _default$4: {
+    __type: "host";
+    create: () => {
+        getSelectedComponents(): Promise<IComponent[]>;
+    };
+};
+
+declare const _default$3: {
+    __type: "host";
+    create: () => {
+        addEventListener: (name: any, cb: (payload: AppEventPayload<AllowedEvents>) => void) => Promise<() => void>;
+    };
+};
+
+declare const _default$2: {
+    __type: "host";
+    create: () => {
+        getViewMode(): Promise<any>;
+        getLanguageCode(): Promise<any>;
+    };
+};
+
+declare const _default$1: {
+    __type: "host";
+    create: () => {
+        getProp(propName: string): Promise<string>;
+        setProp(propName: string, value: string): Promise<void>;
+    };
+};
+
+declare const _default: {
+    __type: "host";
+    create: () => {
+        selectMedia(options: {
+            mediaType: "IMAGE" | "VIDEO" | "DOCUMENT";
+            isMultiSelect?: boolean | undefined;
+        }): Promise<any>;
+        selectLink<TResponse = object>(options: {
+            value?: object | undefined;
+            showLinkTargetSection?: boolean | undefined;
+        }): Promise<TResponse>;
+        selectColor(options: {
+            color?: string | undefined;
+            position?: {
+                x: number;
+                y: number;
+            } | undefined;
+        }, onColorChange: (value: {
+            color: string;
+            theme: string;
+            isHover: boolean;
+        }) => void): Promise<void>;
+        selectFont(options: {
+            position?: {
+                x: number;
+                y: number;
+            } | undefined;
+            title?: string | undefined;
+            panelSectionsDefinition?: Partial<{
+                theme: "hidden" | "enabled";
+                font: "hidden" | "enabled";
+                size: "hidden" | "enabled";
+                style: "hidden" | "enabled";
+                htmlTag: "hidden" | "enabled";
+            }> | undefined;
+            fontMaxSize?: number | undefined;
+            fontMinSize?: number | undefined;
+            componentStyle?: {
+                family: string;
+                style: {
+                    bold: boolean;
+                    italic: boolean;
+                    underline: boolean;
+                };
+                size: number;
+                preset: string;
+                editorKey: string;
+                htmlTag?: string | undefined;
+            } | undefined;
+        }, onFontChange: (value: [string, string | number | boolean, string] | [string, string]) => void): Promise<void>;
+    };
+};
+
+declare const editor: {
+    host: () => _wix_sdk_types.Host;
+    auth: () => {
+        getAuthHeaders: () => Promise<{
+            headers: {
+                Authorization: any;
+            };
+        }>;
+    };
+};
+
+export { _default$5 as application, _default$4 as components, editor, _default$3 as events, _default$2 as info, _default as inputs, _default$1 as widget };

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@wix/editor",
+  "version": "1.287.0",
+  "license": "UNLICENSED",
+  "author": {
+    "name": "Editor Platform <editor-platform-dev@wix.com>",
+    "email": "editor-platform-dev@wix.com"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "sideEffects": false,
+  "types": "dist/types/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "unpkg": true,
+  "publishScoped": true,
+  "scripts": {
+    "start": "exit 0",
+    "build": "yarn typecheck && rollup -c",
+    "test": "exit 0",
+    "lint": "prettier --check ./src",
+    "lint:fix": "prettier --write ./src",
+    "typecheck": "tsc --noEmit"
+  },
+  "lint-staged": {
+    "*.{js,ts}": "yarn lint"
+  },
+  "dependencies": {
+    "@wix/editor-application": "1.308.0",
+    "@wix/editor-application-context": "1.231.0",
+    "@wix/editor-platform-transport": "1.5.0",
+    "@wix/public-editor-platform-errors": "1.5.0",
+    "@wix/public-editor-platform-interfaces": "1.0.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "esbuild": "^0.19.5",
+    "eslint": "^8.54.0",
+    "lint-staged": "^13.3.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"
+  },
+  "wix": {
+    "artifact": {
+      "groupId": "com.wixpress",
+      "artifactId": "editor-platform-sdk"
+    },
+    "validations": {
+      "postDependenciesBuild": [
+        "lint"
+      ]
+    }
+  },
+  "falconPackageHash": "d18cc23a51f40fbab2185dac80a95a394bb1903d2277bde31776132b"
+}