@wix/public-editor-platform-interfaces 1.37.0 → 1.39.0

package/dist/Bindings.d.ts

@@ -1,83 +1,52 @@
-import { ProviderItem } from './Providers';
-export type UnbindAll = 'ALL';
-export interface BindingsMap {
-    [key: string]: PropertyBinding;
-}
-export type PropertyBinding = ContextItemBinding | MethodBinding;
-export declare enum BindingItemType {
-    ContextItem = "ContextItem",
-    Method = "Method"
+import { ProviderType } from './Providers';
+export declare const UNBIND_ALL: "ALL";
+export type UnbindAll = typeof UNBIND_ALL;
+export interface BindingProperties {
+    bindingsMap: ProviderBindingsMap;
+    displayName?: string;
+    providerIdentifier: string;
+    providerType: ProviderType;
 }
-export interface ContextItemBinding {
-    bindingItemType: BindingItemType.ContextItem;
+export type ProviderBindingsMap = Record<string, PropertyBinding>;
+export type PropertyBinding = MethodBinding | ProviderItemBinding;
+export interface ProviderItemBinding {
+    bindingItemType: BindingItemType.ItemBinding;
     displayName?: string;
     itemPath: string;
 }
 export interface MethodBinding {
-    bindingItemType: BindingItemType.Method;
+    bindingItemType: BindingItemType.MethodBinding;
     callOptions: CallOptions;
     displayName?: string;
     methodPath: string;
 }
-export type BindingArgument = ContextBindingArgument | FunctionBinding | StaticArgument;
+export declare enum BindingItemType {
+    ItemBinding = "ItemBinding",
+    MethodBinding = "MethodBinding"
+}
+export type BindingArgument = ProviderItemBindingArgument | StaticArgument;
 export interface CallOptions {
     arguments: BindingArgument[];
     asCallback: boolean;
 }
-export interface FunctionBinding extends CallOptions {
-    displayName?: string;
-    function: string;
-    functionLibraryType: string;
-    type: ArgumentType.FunctionBinding;
+export declare enum ArgumentType {
+    ProviderBinding = "ProviderBindingItem",
+    Static = "StaticArgItem"
 }
-export interface ContextBindingArgument {
-    contextItem: PropertyBinding;
-    contextProvider: string;
+export interface ProviderItemBindingArgument {
     displayName?: string;
-    type: ArgumentType.ContextBinding;
+    providerIdentifier: string;
+    providerItem: PropertyBinding;
+    providerType: ProviderType;
+    type: ArgumentType.ProviderBinding;
 }
 export interface StaticArgument {
     dataType: string;
     type: ArgumentType.Static;
     value: string;
 }
-export declare enum ArgumentType {
-    ContextBinding = "ContextBindingItem",
-    FunctionBinding = "FunctionBindingItem",
-    Static = "StaticArgItem"
-}
-export interface FunctionBindingsMap {
-    [key: string]: FunctionPropertyBinding;
-}
-export interface FunctionPropertyBinding {
-    callOptions: CallOptions;
-    function: string;
-}
-export interface BoundPropertiesPerProvider {
-    [key: string]: BoundProperties;
-}
-export type BoundProperties = ContextProviderBindings | FunctionLibraryBinding;
-export declare enum BindingType {
-    ContextProvider = "ContextProvider",
-    FunctionLibrary = "FunctionLibrary"
-}
-export interface ContextProviderBindings {
-    bindingsMap: BindingsMap;
-    bindingType: BindingType.ContextProvider;
-    displayName?: string;
-}
-export interface FunctionLibraryBinding {
-    bindingsMap: FunctionBindingsMap;
-    bindingType: BindingType.FunctionLibrary;
+export interface ListBindingsOptions {
+    includeDisplayNames?: boolean;
+    providerIdentifiers?: string[];
+    providerTypes?: ProviderType[];
 }
-export type Binding = {
-    bindings: BindingsMap;
-    providerType: string;
-};
-export type ListBindingsResponse = {
-    bindings: BoundProperties;
-    providerType: string;
-}[];
-export type BindingCandidate = ProviderItem & {
-    isBound: boolean;
-};

package/dist/Bindings.js

@@ -1,19 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BindingType = exports.ArgumentType = exports.BindingItemType = void 0;
+exports.ArgumentType = exports.BindingItemType = exports.UNBIND_ALL = void 0;
+exports.UNBIND_ALL = 'ALL';
 var BindingItemType;
 (function (BindingItemType) {
-    BindingItemType["ContextItem"] = "ContextItem";
-    BindingItemType["Method"] = "Method";
+    BindingItemType["ItemBinding"] = "ItemBinding";
+    BindingItemType["MethodBinding"] = "MethodBinding";
 })(BindingItemType || (exports.BindingItemType = BindingItemType = {}));
 var ArgumentType;
 (function (ArgumentType) {
-    ArgumentType["ContextBinding"] = "ContextBindingItem";
-    ArgumentType["FunctionBinding"] = "FunctionBindingItem";
+    ArgumentType["ProviderBinding"] = "ProviderBindingItem";
     ArgumentType["Static"] = "StaticArgItem";
 })(ArgumentType || (exports.ArgumentType = ArgumentType = {}));
-var BindingType;
-(function (BindingType) {
-    BindingType["ContextProvider"] = "ContextProvider";
-    BindingType["FunctionLibrary"] = "FunctionLibrary";
-})(BindingType || (exports.BindingType = BindingType = {}));

package/dist/Providers.d.ts

@@ -1,30 +1,53 @@
+import { DataType, EditorFunction, TextEnum } from '@wix/app-extensions/trusted';
+export declare enum ProviderType {
+    Context = "Context",
+    FunctionLibrary = "FunctionLibrary",
+    Template = "Template"
+}
 export type Provider = {
-    attachState?: AttachState;
-    contextDependencies?: string[];
     displayName: string;
     items?: Record<string, ProviderItem>;
-    providerType: string;
-};
+    providerIdentifier: string;
+} & ({
+    attachState?: AttachState.Above | AttachState.None | AttachState.Self;
+    contextDependencies?: string[];
+    providerType: ProviderType.Context;
+} | {
+    attachState?: AttachState.Above | AttachState.Self;
+    providerType: ProviderType.Template;
+} | {
+    attachState?: AttachState.System;
+    providerType: ProviderType.FunctionLibrary;
+});
 type ProviderItemBase = {
     displayName: string;
     itemName: string;
-    providerType: string;
 };
 export type ProviderArrayItem = ProviderItemBase & {
     arrayItem: ProviderItem;
-    dataType: String;
+    dataType: DataType.arrayItems;
 };
 export type ProviderObjectItem = ProviderItemBase & {
-    dataType: String;
+    dataType: DataType.data;
     objectItem: Record<string, ProviderItem>;
 };
+export type ProviderFunctionItem = ProviderItemBase & {
+    dataType: DataType.function;
+    function?: EditorFunction;
+};
+export type ProviderTextEnumItem = ProviderItemBase & {
+    dataType: DataType.textEnum;
+    textEnum: TextEnum;
+};
 export type ProviderSimpleItem = ProviderItemBase & {
-    dataType: String;
+    dataType: Exclude<DataType, DataType.arrayItems | DataType.data | DataType.function | DataType.textEnum>;
 };
-export type ProviderItem = ProviderArrayItem | ProviderObjectItem | ProviderSimpleItem;
-export type AttachState = 'above' | 'none' | 'self';
-export interface AttachedProvider extends Provider {
-    attachState: AttachState;
+export type ProviderItem = ProviderArrayItem | ProviderFunctionItem | ProviderObjectItem | ProviderSimpleItem | ProviderTextEnumItem;
+export declare enum AttachState {
+    Above = "above",
+    None = "none",
+    Self = "self",
+    System = "system"
 }
 export type AttachStateFilter = boolean | {
     filterAttachedState?: AttachState[];
@@ -33,6 +56,7 @@ export type ListProvidersOptions = {
     includeAttachState?: AttachStateFilter;
     includeDependencies?: boolean;
     includeItems?: boolean;
-    providerTypes?: string[];
+    providerIdentifiers?: string[];
+    providerTypes?: ProviderType[];
 };
 export {};

package/dist/Providers.js

@@ -1,2 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttachState = exports.ProviderType = void 0;
+var ProviderType;
+(function (ProviderType) {
+    ProviderType["Context"] = "Context";
+    ProviderType["FunctionLibrary"] = "FunctionLibrary";
+    ProviderType["Template"] = "Template";
+})(ProviderType || (exports.ProviderType = ProviderType = {}));
+var AttachState;
+(function (AttachState) {
+    AttachState["Above"] = "above";
+    AttachState["None"] = "none";
+    AttachState["Self"] = "self";
+    AttachState["System"] = "system";
+})(AttachState || (exports.AttachState = AttachState = {}));