@wix/public-editor-platform-interfaces 1.26.0 → 1.27.0

package/dist/sdk/data.d.ts

@@ -0,0 +1,95 @@
+import type * as DmTypes from '../generated/dm-types';
+import { DataType } from '../generated/dm-types';
+export { DataType } from '../generated/dm-types';
+/**
+ * Viewer-derived fields added by the SDK to all link types.
+ * - `displayName`: human-readable label resolved by editor
+ * - `href`: resolved URL (viewer concern, not stored in DM)
+ * - `rel`: normalized to space-separated string (DM stores as enum array)
+ */
+type ElementLinkExtension = {
+    displayName: string;
+    href?: string;
+    rel?: string;
+};
+export type ElementPageLink = DmTypes.PageLink & ElementLinkExtension & {
+    type: 'PageLink';
+};
+export type ElementExternalLink = DmTypes.ExternalLink & ElementLinkExtension & {
+    type: 'ExternalLink';
+};
+export type ElementEmailLink = DmTypes.EmailLink & ElementLinkExtension & {
+    type: 'EmailLink';
+};
+export type ElementPhoneLink = DmTypes.PhoneLink & ElementLinkExtension & {
+    type: 'PhoneLink';
+};
+export type ElementWhatsAppLink = DmTypes.WhatsAppLink & ElementLinkExtension & {
+    type: 'WhatsAppLink';
+};
+export type ElementAddressLink = DmTypes.AddressLink & ElementLinkExtension & {
+    type: 'AddressLink';
+};
+export type ElementAnchorLink = DmTypes.AnchorLink & ElementLinkExtension & {
+    type: 'AnchorLink';
+};
+export type ElementDocumentLink = DmTypes.DocumentLink & ElementLinkExtension & {
+    type: 'DocumentLink';
+};
+export type ElementDynamicPageLink = DmTypes.DynamicPageLink & ElementLinkExtension & {
+    type: 'DynamicPageLink';
+};
+export type ElementTpaPageLink = DmTypes.TpaPageLink & ElementLinkExtension & {
+    type: 'TpaPageLink';
+};
+export type ElementLoginToWixLink = DmTypes.LoginToWixLink & ElementLinkExtension & {
+    type: 'LoginToWixLink';
+};
+export type ElementTextLink = DmTypes.TextLink & ElementLinkExtension & {
+    type: 'TextLink';
+};
+export type ElementLink = ElementPageLink | ElementExternalLink | ElementEmailLink | ElementPhoneLink | ElementWhatsAppLink | ElementAddressLink | ElementAnchorLink | ElementDocumentLink | ElementDynamicPageLink | ElementTpaPageLink | ElementLoginToWixLink | ElementTextLink;
+export type ElementImage = DmTypes.Image;
+export type ElementVideo = DmTypes.Video;
+export type ElementAudio = DmTypes.Audio;
+export type ElementVectorArt = DmTypes.VectorArt;
+export type ElementMenuItems = DmTypes.MenuItems;
+export type ElementA11y = DmTypes.A11y;
+export type ElementRichText = DmTypes.RichText;
+export type ElementDirection = DmTypes.Direction;
+export type ElementDataValue = string | number | boolean | ElementLink | ElementImage | ElementVideo | ElementAudio | ElementVectorArt | ElementMenuItems | ElementA11y | ElementRichText | ElementDirection | ElementDataObject | ElementDataValue[] | null | undefined;
+export type ElementDataObject = {
+    [key: string]: ElementDataValue;
+};
+export type ElementData = ElementDataObject;
+export type ElementDataInput = Partial<ElementData>;
+export type ElementDataTypeMap = {
+    [DataType.TEXT]: string;
+    [DataType.TEXT_ENUM]: string;
+    [DataType.NUMBER]: number;
+    [DataType.BOOLEAN_VALUE]: boolean;
+    [DataType.A11Y]: ElementA11y;
+    [DataType.LINK]: ElementLink;
+    [DataType.IMAGE]: ElementImage;
+    [DataType.VIDEO]: ElementVideo;
+    [DataType.VECTOR_ART]: ElementVectorArt;
+    [DataType.AUDIO]: ElementAudio;
+    [DataType.LOCAL_DATE]: string;
+    [DataType.LOCAL_TIME]: string;
+    [DataType.LOCAL_DATE_TIME]: string;
+    [DataType.WEB_URL]: string;
+    [DataType.EMAIL]: string;
+    [DataType.PHONE]: string;
+    [DataType.HOSTNAME]: string;
+    [DataType.REGEX]: string;
+    [DataType.GUID]: string;
+    [DataType.RICH_TEXT]: ElementRichText;
+    [DataType.CONTAINER]: ElementDataObject | string;
+    [DataType.ARRAY_ITEMS]: ElementDataValue[];
+    [DataType.DIRECTION]: ElementDirection;
+    [DataType.MENU_ITEMS]: ElementMenuItems;
+    [DataType.DATA]: ElementDataObject;
+    [DataType.SCHEMA]: ElementDataValue;
+    [DataType.UNKNOWN_DATA_TYPE]: ElementDataValue;
+};
+export type ElementDefaultValueFor<TypeKey extends keyof ElementDataTypeMap> = ElementDataTypeMap[TypeKey];

package/dist/sdk/data.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataType = void 0;
+const dm_types_1 = require("../generated/dm-types");
+var dm_types_2 = require("../generated/dm-types");
+Object.defineProperty(exports, "DataType", { enumerable: true, get: function () { return dm_types_2.DataType; } });

package/dist/sdk/definitions.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Simplified types for definition getters.
+ * These expose only the commonly-used fields from the internal manifest types.
+ */
+import type { DataType } from '../generated/dm-types';
+import type { ElementDataTypeMap, ElementDataValue } from './data';
+import type { CssPropertyType, CssPropertyOptions } from './css-properties';
+import type { ElementStyleValue, CssPropertyKey } from './styles';
+export { DataType } from '../generated/dm-types';
+export type ElementStyleDefinition = {
+    displayName?: string | null;
+    defaultValue?: ElementStyleValue;
+    statesDefaultValues?: Record<string, ElementStyleValue>;
+    /** Only for cssCustomProperties */
+    cssPropertyType?: CssPropertyType;
+    /** Configuration options for specific CSS property types (filter, display, etc.) */
+    cssPropertyOptions?: CssPropertyOptions;
+};
+export type ElementStyleDefinitions = {
+    cssProperties: Partial<Record<CssPropertyKey, ElementStyleDefinition>>;
+    cssCustomProperties: Record<string, ElementStyleDefinition>;
+};
+export type ElementStyleDefaultValues = {
+    cssProperties: Partial<Record<CssPropertyKey, ElementStyleValue>>;
+    cssCustomProperties: Record<string, ElementStyleValue>;
+};
+export type ElementPresetDefinition = {
+    displayName?: string;
+    thumbnailUrl?: string | null;
+    initialSize?: {
+        width?: number | null;
+        height?: number | null;
+    };
+};
+export type ElementPresetDefinitions = Record<string, ElementPresetDefinition>;
+export type NativeStateType = 'hover' | 'focus' | 'disabled' | 'invalid';
+export type ElementStateDefinition = {
+    displayName?: string | null;
+    className?: string | null;
+    pseudoClass?: NativeStateType;
+    props?: Record<string, unknown>;
+};
+export type ElementStateDefinitions = Record<string, ElementStateDefinition>;
+export type ElementDataDefinition<TypeKey extends DataType = DataType> = {
+    dataType?: TypeKey;
+    displayName?: string | null;
+    defaultValue?: TypeKey extends keyof ElementDataTypeMap ? ElementDataTypeMap[TypeKey] : ElementDataValue;
+};
+export type ElementDataDefinitions = Record<string, ElementDataDefinition>;
+export type ElementDataDefaultValues = Partial<{
+    [Key in DataType]: ElementDataTypeMap[Key];
+}>;

package/dist/sdk/definitions.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Simplified types for definition getters.
+ * These expose only the commonly-used fields from the internal manifest types.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataType = void 0;
+var dm_types_1 = require("../generated/dm-types");
+Object.defineProperty(exports, "DataType", { enumerable: true, get: function () { return dm_types_1.DataType; } });

package/dist/sdk/index.d.ts

@@ -0,0 +1,4 @@
+export * from './data';
+export * from './styles';
+export * from './definitions';
+export * from './css-properties';

package/dist/sdk/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./data"), exports);
+__exportStar(require("./styles"), exports);
+__exportStar(require("./definitions"), exports);
+__exportStar(require("./css-properties"), exports);

package/dist/sdk/styles.d.ts

@@ -0,0 +1,19 @@
+import type { CssPropertyType } from './css-properties';
+export type ElementStyleValue = string;
+/**
+ * Union type that extracts string literal values from CssPropertyType enum.
+ * This provides backward compatibility - accepts both enum values and string literals.
+ */
+export type CssPropertyKey = `${CssPropertyType}`;
+export type ElementStyles = {
+    cssProperties: Partial<Record<CssPropertyKey, ElementStyleValue>>;
+    cssCustomProperties: Record<string, ElementStyleValue>;
+};
+export type ElementStylesUpdate = {
+    cssProperties?: Partial<Record<CssPropertyKey, ElementStyleValue>>;
+    cssCustomProperties?: Record<string, ElementStyleValue>;
+};
+export type ElementStylesRemoval = {
+    cssPropertiesKeys?: CssPropertyKey[];
+    cssCustomPropertiesKeys?: string[];
+};

package/dist/sdk/styles.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/public-editor-platform-interfaces",
-  "version": "1.26.0",
+  "version": "1.27.0",
   "license": "UNLICENSED",
   "contributors": [
     {
@@ -51,5 +51,5 @@
       ]
     }
   },
-  "falconPackageHash": "86cda0637b4a76f3d8f52c4f5fdbe7b924dd71c71830de8223b46c39"
+  "falconPackageHash": "ac7a6d50948d2e5bc9a401415282ab3c4facd215884cbd1d835f6297"
 }