@wix/public-editor-platform-interfaces 1.34.0 → 1.36.0

package/dist/Bindings.d.ts

@@ -0,0 +1,80 @@
+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"
+}
+export interface ContextItemBinding {
+    bindingItemType: BindingItemType.ContextItem;
+    displayName?: string;
+    itemPath: string;
+}
+export interface MethodBinding {
+    bindingItemType: BindingItemType.Method;
+    callOptions: CallOptions;
+    displayName?: string;
+    methodPath: string;
+}
+export type BindingArgument = ContextBindingArgument | FunctionBinding | StaticArgument;
+export interface CallOptions {
+    arguments: BindingArgument[];
+    asCallback: boolean;
+}
+export interface FunctionBinding extends CallOptions {
+    displayName?: string;
+    function: string;
+    functionLibraryType: string;
+    type: ArgumentType.FunctionBinding;
+}
+export interface ContextBindingArgument {
+    contextItem: PropertyBinding;
+    contextProvider: string;
+    displayName?: string;
+    type: ArgumentType.ContextBinding;
+}
+export interface StaticArgument {
+    dataType: string;
+    type: ArgumentType.Static;
+    value: string;
+}
+export declare enum ArgumentType {
+    ContextBinding = "ContextBindingItem",
+    FunctionBinding = "FunctionBindingItem",
+    Static = "StaticArgItem"
+}
+export interface FunctionBindingConfig {
+    functionBindingItem: FunctionBinding;
+    propertyName: 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 {
+    binding: FunctionBindingConfig;
+    bindingType: BindingType.FunctionLibrary;
+}
+export type Binding = {
+    bindings: BindingsMap;
+    providerType: string;
+};
+export type ListBindingsResponse = {
+    bindings: BoundProperties;
+    providerType: string;
+}[];
+export type BindingCandidate = ProviderItem & {
+    isBound: boolean;
+};

package/dist/Bindings.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BindingType = exports.ArgumentType = exports.BindingItemType = void 0;
+var BindingItemType;
+(function (BindingItemType) {
+    BindingItemType["ContextItem"] = "ContextItem";
+    BindingItemType["Method"] = "Method";
+})(BindingItemType || (exports.BindingItemType = BindingItemType = {}));
+var ArgumentType;
+(function (ArgumentType) {
+    ArgumentType["ContextBinding"] = "ContextBindingItem";
+    ArgumentType["FunctionBinding"] = "FunctionBindingItem";
+    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

@@ -0,0 +1,38 @@
+export type Provider = {
+    attachState?: AttachState;
+    contextDependencies?: string[];
+    displayName: string;
+    items?: Record<string, ProviderItem>;
+    providerType: string;
+};
+type ProviderItemBase = {
+    displayName: string;
+    itemName: string;
+    providerType: string;
+};
+export type ProviderArrayItem = ProviderItemBase & {
+    arrayItem: ProviderItem;
+    dataType: String;
+};
+export type ProviderObjectItem = ProviderItemBase & {
+    dataType: String;
+    objectItem: Record<string, ProviderItem>;
+};
+export type ProviderSimpleItem = ProviderItemBase & {
+    dataType: String;
+};
+export type ProviderItem = ProviderArrayItem | ProviderObjectItem | ProviderSimpleItem;
+export type AttachState = 'above' | 'none' | 'self';
+export interface AttachedProvider extends Provider {
+    attachState: AttachState;
+}
+export type AttachStateFilter = boolean | {
+    filterAttachedState?: AttachState[];
+};
+export type ListProvidersOptions = {
+    includeAttachState?: AttachStateFilter;
+    includeDependencies?: boolean;
+    includeItems?: boolean;
+    providerTypes?: string[];
+};
+export {};

package/dist/Providers.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -6,6 +6,8 @@ export { EventType } from './EventType';
 export { AccessToken } from './Token';
 export { DsItem } from './DataItem';
 export { BuilderStyle, Style, StyleRef } from './StyleData';
+export * from './Providers';
+export * from './Bindings';
 export { OpenColorPickerFn, OpenLinkPanelFn, BasePickerOptions, BackgroundFillValue, BackgroundPickerOptions, ColorPickerOptions, ColorPickerMode, } from './Inputs';
 export * as PublicDmTypes from './generated/dm-types';
 export * from './sdk';

package/dist/index.js

@@ -41,5 +41,7 @@ const WixSDKTypes = __importStar(require("@wix/sdk-types"));
 exports.WixSDKTypes = WixSDKTypes;
 var EventType_1 = require("./EventType");
 Object.defineProperty(exports, "EventType", { enumerable: true, get: function () { return EventType_1.EventType; } });
+__exportStar(require("./Providers"), exports);
+__exportStar(require("./Bindings"), exports);
 exports.PublicDmTypes = __importStar(require("./generated/dm-types"));
 __exportStar(require("./sdk"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/public-editor-platform-interfaces",
-  "version": "1.34.0",
+  "version": "1.36.0",
   "license": "UNLICENSED",
   "contributors": [
     {
@@ -51,5 +51,5 @@
       ]
     }
   },
-  "falconPackageHash": "5765130e74e5115dbc074a85f7db2922f69abc70bc25e617e653c475"
+  "falconPackageHash": "69c78dac57df661f8b682bbd7cfa51afa990ffb2091364065eb68fdb"
 }