@wix/editor-react-types 1.0.1 → 1.0.13

package/README.md

@@ -1,3 +1,46 @@
-# editor-react-types
+# @wix/editor-react-types
 
-React types for Wix Editor components and context
+TypeScript types for [Editor React Component](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/editor-react-components/about-editor-react-components) props.
+
+## Installation
+
+```bash
+npm install @wix/editor-react-types
+```
+
+## Usage
+
+Import the types you need and use them to type your component's props:
+
+```tsx
+import type { Image, Link, Wix } from '@wix/editor-react-types';
+
+interface MyComponentProps {
+  className: string;
+  image?: Image;
+  link?: Link;
+  wix?: Wix;
+}
+```
+
+## Available types
+
+| Type | Description |
+|------|-------------|
+| `Image` | An image from Wix Media. |
+| `Video` | A video from Wix Media. |
+| `Audio` | An audio track from Wix Media. |
+| `BuilderAudio` | An audio track with metadata and multiple quality sources. |
+| `Link` | A navigation link. |
+| `VectorArt` | An SVG vector art asset from Wix Media. |
+| `MenuItems` | A list of navigation menu items. |
+| `A11y` | Accessibility attributes. |
+| `Wix` | Wix framework props. |
+| `RichText` | Rich text content. |
+| `Direction` | Text direction. |
+| `Text`, `NumberType`, `BooleanValue` | Primitive data types. |
+| `WebUrl`, `Email`, `Phone`, `Hostname` | Validated string formats. |
+| `LocalDate`, `LocalTime`, `LocalDateTime` | ISO-8601 date and time strings. |
+| `Guid`, `Regex`, `Schema` | Additional primitive types. |
+
+For full documentation on each type and how to use them in your component, see the [Props Reference](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/editor-react-components/props).

package/dist/a11y.d.ts

@@ -1,28 +1,73 @@
+/**
+ * Accessibility attributes.
+ *
+ * @example
+ * ```tsx
+ * import type { A11y } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   a11y?: A11y;
+ * }
+ *
+ * const MyComponent = ({ a11y }: MyComponentProps) => (
+ *   <div
+ *     tabIndex={a11y?.tabIndex}
+ *     role={a11y?.role}
+ *     aria-label={a11y?.ariaLabel}
+ *   />
+ * );
+ * ```
+ */
 export interface A11y {
+    /** The `tabindex` attribute. Controls the component's position in keyboard focus order. */
     tabIndex?: number;
+    /** The `aria-level` attribute. Defines the hierarchical level of a component within a structure. */
     ariaLevel?: number;
+    /** The `aria-expanded` attribute. Indicates whether a collapsible component is expanded or collapsed. */
     ariaExpanded?: boolean | 'false' | 'true';
+    /** The `aria-disabled` attribute. Indicates that the component is perceivable but disabled. */
     ariaDisabled?: boolean | 'false' | 'true';
+    /** The `aria-atomic` attribute. Indicates whether assistive technologies should present the entire region as a whole. */
     ariaAtomic?: boolean | 'false' | 'true';
+    /** The `aria-hidden` attribute. Hides the component from assistive technologies. */
     ariaHidden?: boolean | 'false' | 'true';
+    /** The `aria-busy` attribute. Indicates the component is being modified and assistive technologies should wait. */
     ariaBusy?: boolean | 'false' | 'true';
+    /** Whether the component supports multiline input. */
     multiline?: boolean;
+    /** The `aria-autocomplete` attribute. Indicates the type of autocomplete behavior for an input. */
     ariaAutocomplete?: 'none' | 'inline' | 'list' | 'both';
+    /** The `aria-pressed` attribute. Indicates the current "pressed" state of a toggle button. */
     ariaPressed?: boolean | 'false' | 'mixed' | 'true';
+    /** The `aria-haspopup` attribute. Indicates the availability and type of an interactive popup component. */
     ariaHaspopup?: boolean | 'false' | 'true' | 'menu' | 'listbox' | 'tree' | 'grid' | 'dialog';
+    /** The `aria-relevant` attribute. Indicates what notifications the user agent will trigger when the accessibility tree is modified. */
     ariaRelevant?: 'additions' | 'additions text' | 'all' | 'removals' | 'text';
+    /** The `role` attribute. Defines the semantic role of the component. */
     role?: string;
+    /** The `aria-live` attribute. Indicates that the component will be updated and describes the types of updates. */
     ariaLive?: 'off' | 'assertive' | 'polite';
+    /** The `aria-current` attribute. Indicates the component that represents the current item within a container or set. */
     ariaCurrent?: boolean | 'false' | 'true' | 'page' | 'step' | 'location' | 'date' | 'time';
+    /** The `aria-label` attribute. Defines a string value that labels the component. */
     ariaLabel?: string;
+    /** The `aria-roledescription` attribute. Defines a human-readable description for the role of the component. */
     ariaRoledescription?: string;
+    /** The `aria-describedby` attribute. Identifies the element that describes this component. */
     ariaDescribedby?: string;
+    /** The `aria-labelledby` attribute. Identifies the element that labels this component. */
     ariaLabelledby?: string;
+    /** The `aria-errormessage` attribute. Identifies the element that provides an error message for this component. */
     ariaErrormessage?: string;
+    /** The `aria-owns` attribute. Identifies a component to define a visual, functional, or contextual parent/child relationship. */
     ariaOwns?: string;
+    /** The `aria-controls` attribute. Identifies the element whose contents or presence are controlled by this component. */
     ariaControls?: string;
+    /** The HTML tag to render the component as (e.g. `'h1'`, `'button'`). */
     tag?: string;
+    /** The `aria-multiline` attribute. Indicates whether a text box accepts multiple lines of input. */
     ariaMultiline?: boolean | 'false' | 'true';
+    /** The `aria-invalid` attribute. Indicates the entered value does not conform to the expected format. */
     ariaInvalid?: boolean | 'false' | 'true' | 'grammar' | 'spelling';
 }
 //# sourceMappingURL=a11y.d.ts.map

package/dist/a11y.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"a11y.d.ts","sourceRoot":"","sources":["../src/a11y.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,IAAI;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;IACzC,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;IACzC,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;IACvC,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;IACvC,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;IACrC,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,gBAAgB,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAA;IACtD,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;IAClD,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAA;IAC3F,YAAY,CAAC,EAAE,WAAW,GAAG,gBAAgB,GAAG,KAAK,GAAG,UAAU,GAAG,MAAM,CAAA;IAC3E,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,KAAK,GAAG,WAAW,GAAG,QAAQ,CAAA;IACzC,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAA;IACzF,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;IAC1C,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,UAAU,CAAA;CACpE"}
+{"version":3,"file":"a11y.d.ts","sourceRoot":"","sources":["../src/a11y.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,IAAI;IACjB,2FAA2F;IAC3F,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,oGAAoG;IACpG,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,yGAAyG;IACzG,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;IACzC,+FAA+F;IAC/F,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;IACzC,yHAAyH;IACzH,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;IACvC,oFAAoF;IACpF,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;IACvC,mHAAmH;IACnH,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;IACrC,sDAAsD;IACtD,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,mGAAmG;IACnG,gBAAgB,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAA;IACtD,8FAA8F;IAC9F,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;IAClD,4GAA4G;IAC5G,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAA;IAC3F,uIAAuI;IACvI,YAAY,CAAC,EAAE,WAAW,GAAG,gBAAgB,GAAG,KAAK,GAAG,UAAU,GAAG,MAAM,CAAA;IAC3E,wEAAwE;IACxE,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,kHAAkH;IAClH,QAAQ,CAAC,EAAE,KAAK,GAAG,WAAW,GAAG,QAAQ,CAAA;IACzC,wHAAwH;IACxH,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAA;IACzF,oFAAoF;IACpF,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,gHAAgH;IAChH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,8FAA8F;IAC9F,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,0FAA0F;IAC1F,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,mHAAmH;IACnH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,iIAAiI;IACjI,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,yHAAyH;IACzH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,yEAAyE;IACzE,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,oGAAoG;IACpG,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;IAC1C,yGAAyG;IACzG,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,UAAU,CAAA;CACpE"}

package/dist/audio.d.ts

@@ -1,8 +1,38 @@
+/** A single audio source file at a specific quality and format. */
+export type AudioSource = {
+    /** The audio bitrate in kbps. */
+    audioBitrate: number;
+    /** The audio format (e.g. `'mp3'`, `'ogg'`). */
+    format: string;
+    /** The audio quality label. */
+    quality: string;
+    /** The fully resolved audio URL. */
+    url: string;
+};
+/**
+ * An audio track from Wix Media.
+ *
+ * @example
+ * ```tsx
+ * import type { Audio } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   audio?: Audio;
+ * }
+ * ```
+ */
 export type Audio = {
-    id: string;
+    /** The fully resolved audio URL. */
     url: string;
-    filename: string;
-    duration: number;
-    title: string;
+    /** The audio artist name. */
+    artist?: string;
+    /** The audio track title. */
+    title?: string;
+    /** The audio duration in seconds. */
+    duration?: number;
+    /** The audio file name. */
+    name?: string;
+    /** All available audio sources at different quality levels and formats. */
+    audio?: Array<AudioSource>;
 };
 //# sourceMappingURL=audio.d.ts.map

package/dist/audio.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"audio.d.ts","sourceRoot":"","sources":["../src/audio.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,KAAK,GAAG;IAEhB,EAAE,EAAE,MAAM,CAAA;IAEV,GAAG,EAAE,MAAM,CAAA;IAEX,QAAQ,EAAE,MAAM,CAAA;IAEhB,QAAQ,EAAE,MAAM,CAAA;IAEhB,KAAK,EAAE,MAAM,CAAA;CAChB,CAAA"}
+{"version":3,"file":"audio.d.ts","sourceRoot":"","sources":["../src/audio.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,MAAM,MAAM,WAAW,GAAG;IACtB,iCAAiC;IACjC,YAAY,EAAE,MAAM,CAAA;IACpB,gDAAgD;IAChD,MAAM,EAAE,MAAM,CAAA;IACd,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,oCAAoC;IACpC,GAAG,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,KAAK,GAAG;IAChB,oCAAoC;IACpC,GAAG,EAAE,MAAM,CAAA;IACX,6BAA6B;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,6BAA6B;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,qCAAqC;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,2EAA2E;IAC3E,KAAK,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAA;CAC7B,CAAA"}

package/dist/base.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module
+ * Primitive and base data types for component props.
+ */
 import type { ReactNode, FC } from 'react';
 import type { Link } from './links';
 import type { Image } from './image';
@@ -5,28 +9,274 @@ import type { Video } from './video';
 import type { VectorArt } from './vectorArt';
 import type { A11y } from './a11y';
 import type { Audio } from './audio';
+/**
+ * A plain text string.
+ *
+ * @example
+ * ```tsx
+ * import type { Text } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   label?: Text;
+ * }
+ * ```
+ */
 export type Text = string;
+/**
+ * The value selected by the Wix user from a predefined set of options.
+ *
+ * @example
+ * ```tsx
+ * import type { TextEnum } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   alignment?: TextEnum; // e.g. 'left' | 'center' | 'right'
+ * }
+ * ```
+ */
 export type TextEnum = string;
+/**
+ * Any numeric value.
+ *
+ * @example
+ * ```tsx
+ * import type { NumberType } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   rating?: NumberType;
+ * }
+ * ```
+ */
 export type NumberType = number;
+/**
+ * A boolean `true` or `false` value.
+ *
+ * @example
+ * ```tsx
+ * import type { BooleanValue } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   showLabel?: BooleanValue;
+ * }
+ * ```
+ */
 export type BooleanValue = boolean;
+/**
+ * A JSON Schema definition.
+ *
+ * @example
+ * ```tsx
+ * import type { Schema } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   schema?: Schema;
+ * }
+ * ```
+ */
 export type Schema = Record<string, unknown>;
+/**
+ * A local date string in ISO-8601 extended format (`YYYY-MM-DD`).
+ *
+ * @example
+ * ```tsx
+ * import type { LocalDate } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   startDate?: LocalDate; // e.g. '2024-03-15'
+ * }
+ * ```
+ */
 export type LocalDate = string;
+/**
+ * A local time string in ISO-8601 extended format (`hh:mm[:ss][.sss]`).
+ *
+ * @example
+ * ```tsx
+ * import type { LocalTime } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   openingTime?: LocalTime; // e.g. '09:00'
+ * }
+ * ```
+ */
 export type LocalTime = string;
+/**
+ * A local date-time string in ISO-8601 extended format (`YYYY-MM-DDThh:mm[:ss][.sss]`).
+ *
+ * @example
+ * ```tsx
+ * import type { LocalDateTime } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   eventStart?: LocalDateTime; // e.g. '2024-03-15T09:00'
+ * }
+ * ```
+ */
 export type LocalDateTime = string;
+/**
+ * A URL with an `http` or `https` scheme.
+ *
+ * @example
+ * ```tsx
+ * import type { WebUrl } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   website?: WebUrl;
+ * }
+ * ```
+ */
 export type WebUrl = string;
+/**
+ * A standard email address according to RFC 5321, section 4.1.2.
+ *
+ * @example
+ * ```tsx
+ * import type { Email } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   contactEmail?: Email;
+ * }
+ * ```
+ */
 export type Email = string;
+/**
+ * A phone number string, accepting common phone number characters.
+ *
+ * @example
+ * ```tsx
+ * import type { Phone } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   phoneNumber?: Phone;
+ * }
+ * ```
+ */
 export type Phone = string;
+/**
+ * A hostname according to IANA standards.
+ *
+ * @example
+ * ```tsx
+ * import type { Hostname } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   host?: Hostname; // e.g. 'www.example.com'
+ * }
+ * ```
+ */
 export type Hostname = string;
+/**
+ * A valid regular expression pattern provided by the Wix user.
+ *
+ * @example
+ * ```tsx
+ * import type { Regex } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   validationPattern?: Regex; // e.g. '^[a-z]+$'
+ * }
+ * ```
+ */
 export type Regex = string;
+/**
+ * A unique identifier (UUID).
+ *
+ * @example
+ * ```tsx
+ * import type { Guid } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   itemId?: Guid;
+ * }
+ * ```
+ */
 export type Guid = string;
+/**
+ * Rich text content with resolved links.
+ *
+ * @example
+ * ```tsx
+ * import type { RichText } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   description?: RichText;
+ * }
+ *
+ * const MyComponent = ({ description }: MyComponentProps) => (
+ *   <div>
+ *     {description?.html}
+ *     {description?.linkList.map((link) => (
+ *       <a key={link.href} href={link.href}>{link.href}</a>
+ *     ))}
+ *   </div>
+ * );
+ * ```
+ */
 export type RichText = {
+    /** The original rich text content. */
     text: string;
+    /** The HTML content with all links resolved. */
     html: string;
+    /** All links present in the rich text content. */
     linkList: Array<Link>;
 };
+/**
+ * A container slot in the component.
+ *
+ * Can be either a `ReactNode` passed as `children`, or a function component
+ * used as a render prop.
+ *
+ * @example
+ * ```tsx
+ * import type { Container } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   content?: Container;
+ * }
+ *
+ * const MyComponent = ({ content }: MyComponentProps) => (
+ *   <div>
+ *     {typeof content === 'function' ? content({}) : content}
+ *   </div>
+ * );
+ * ```
+ */
 export type Container = ReactNode | FC<Record<string, unknown>>;
 export type Data = Record<string, DataType>;
+/**
+ * An array of data values or data records.
+ *
+ * @example
+ * ```tsx
+ * import type { ArrayItems } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   items?: ArrayItems;
+ * }
+ * ```
+ */
 export type ArrayItems = Array<DataType | Data>;
+/**
+ * The text direction of the component.
+ * Maps to the HTML `dir` attribute.
+ * - `'ltr'` — left to right.
+ * - `'rtl'` — right to left.
+ * - `'auto'` — determined by content.
+ *
+ * @example
+ * ```tsx
+ * import type { Direction } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   direction?: Direction;
+ * }
+ *
+ * const MyComponent = ({ direction = 'ltr' }: MyComponentProps) => (
+ *   <div dir={direction}>...</div>
+ * );
+ * ```
+ */
 export type Direction = 'rtl' | 'ltr' | 'auto';
+/** A union of all supported data types that can be used as component props. */
 export type DataType = Text | TextEnum | NumberType | BooleanValue | Schema | LocalDate | LocalTime | LocalDateTime | WebUrl | Email | Phone | Hostname | Regex | Guid | RichText | Container | ArrayItems | Direction | A11y | Image | Video | VectorArt | Audio | Link;
 //# sourceMappingURL=base.d.ts.map

package/dist/base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,OAAO,CAAA;AAE1C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AACnC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAClC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAEpC,MAAM,MAAM,IAAI,GAAG,MAAM,CAAA;AAEzB,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAA;AAC7B,MAAM,MAAM,UAAU,GAAG,MAAM,CAAA;AAC/B,MAAM,MAAM,YAAY,GAAG,OAAO,CAAA;AAElC,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAC5C,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA;AAC9B,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA;AAC9B,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAClC,MAAM,MAAM,MAAM,GAAG,MAAM,CAAA;AAC3B,MAAM,MAAM,KAAK,GAAG,MAAM,CAAA;AAC1B,MAAM,MAAM,KAAK,GAAG,MAAM,CAAA;AAC1B,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAA;AAC7B,MAAM,MAAM,KAAK,GAAG,MAAM,CAAA;AAC1B,MAAM,MAAM,IAAI,GAAG,MAAM,CAAA;AACzB,MAAM,MAAM,QAAQ,GAAG;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;CACxB,CAAA;AACD,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;AAC/D,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;AAC3C,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAA;AAC/C,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAA;AAE9C,MAAM,MAAM,QAAQ,GACd,IAAI,GACJ,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,MAAM,GACN,SAAS,GACT,SAAS,GACT,aAAa,GACb,MAAM,GACN,KAAK,GACL,KAAK,GACL,QAAQ,GACR,KAAK,GACL,IAAI,GACJ,QAAQ,GACR,SAAS,GACT,UAAU,GACV,SAAS,GACT,IAAI,GACJ,KAAK,GACL,KAAK,GACL,SAAS,GACT,KAAK,GACL,IAAI,CAAA"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,OAAO,CAAA;AAE1C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AACnC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAClC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAEpC;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,IAAI,GAAG,MAAM,CAAA;AAEzB;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAA;AAE7B;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAA;AAE/B;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,CAAA;AAElC;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAE5C;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA;AAE9B;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA;AAE9B;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAElC;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,CAAA;AAE3B;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,KAAK,GAAG,MAAM,CAAA;AAE1B;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,KAAK,GAAG,MAAM,CAAA;AAE1B;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAA;AAE7B;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,KAAK,GAAG,MAAM,CAAA;AAE1B;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,IAAI,GAAG,MAAM,CAAA;AAEzB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,QAAQ,GAAG;IACnB,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAA;IACZ,kDAAkD;IAClD,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;CACxB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;AAE/D,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;AAE3C;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAA;AAE9C,+EAA+E;AAC/E,MAAM,MAAM,QAAQ,GACd,IAAI,GACJ,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,MAAM,GACN,SAAS,GACT,SAAS,GACT,aAAa,GACb,MAAM,GACN,KAAK,GACL,KAAK,GACL,QAAQ,GACR,KAAK,GACL,IAAI,GACJ,QAAQ,GACR,SAAS,GACT,UAAU,GACV,SAAS,GACT,IAAI,GACJ,KAAK,GACL,KAAK,GACL,SAAS,GACT,KAAK,GACL,IAAI,CAAA"}

package/dist/base.js

@@ -1,2 +1,6 @@
+/**
+ * @module
+ * Primitive and base data types for component props.
+ */
 export {};
 //# sourceMappingURL=base.js.map

package/dist/base.js.map

@@ -1 +1 @@
-{"version":3,"file":"base.js","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":""}
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/dist/builderAudio.d.ts

@@ -1,15 +1,4 @@
-export type AudioSource = {
-    audioBitrate: number;
-    format: string;
-    quality: string;
-    url: string;
-};
-export type BuilderAudio = {
-    url: string;
-    artist?: string;
-    title?: string;
-    duration?: number;
-    name?: string;
-    audio?: Array<AudioSource>;
-};
+import type { Audio } from './audio';
+/** @deprecated Use Audio instead (should be deleted) */
+export type BuilderAudio = Audio;
 //# sourceMappingURL=builderAudio.d.ts.map

package/dist/builderAudio.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"builderAudio.d.ts","sourceRoot":"","sources":["../src/builderAudio.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG;IAEtB,YAAY,EAAE,MAAM,CAAA;IAEpB,MAAM,EAAE,MAAM,CAAA;IAEd,OAAO,EAAE,MAAM,CAAA;IAEf,GAAG,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IAEvB,GAAG,EAAE,MAAM,CAAA;IAEX,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,KAAK,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAA;CAC7B,CAAA"}
+{"version":3,"file":"builderAudio.d.ts","sourceRoot":"","sources":["../src/builderAudio.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAEpC,wDAAwD;AACxD,MAAM,MAAM,YAAY,GAAG,KAAK,CAAA"}

package/dist/image.d.ts

@@ -6,15 +6,40 @@ type Crop = Point & {
     width: number;
     height: number;
 };
+/**
+ * An image from Wix Media.
+ *
+ * @example
+ * ```tsx
+ * import type { Image } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   image?: Image;
+ * }
+ *
+ * const MyComponent = ({ image }: MyComponentProps) => (
+ *   <img src={image?.url} alt={image?.alt} />
+ * );
+ * ```
+ */
 export type Image = {
+    /** The image URI. */
     uri?: string;
+    /** The image URL. */
     url: string;
+    /** The image file name. */
     name?: string;
+    /** The image height in pixels. */
     height?: number;
+    /** The image width in pixels. */
     width?: number;
+    /** Whether the image is animated (e.g. GIF). */
     animated?: boolean;
+    /** The crop region applied to the image. */
     crop?: Crop;
+    /** The image quality, as a percentage from 0 to 100. */
     quality?: number;
+    /** The image alt text for accessibility. */
     alt?: string;
 };
 export {};

package/dist/image.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../src/image.ts"],"names":[],"mappings":"AAAA,KAAK,KAAK,GAAG;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACZ,CAAA;AACD,KAAK,IAAI,GAAG,KAAK,GAAG;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,KAAK,GAAG;IAEhB,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ,GAAG,EAAE,MAAM,CAAA;IAEX,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB,IAAI,CAAC,EAAE,IAAI,CAAA;IAEX,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB,GAAG,CAAC,EAAE,MAAM,CAAA;CACf,CAAA"}
+{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../src/image.ts"],"names":[],"mappings":"AAAA,KAAK,KAAK,GAAG;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACZ,CAAA;AACD,KAAK,IAAI,GAAG,KAAK,GAAG;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,KAAK,GAAG;IAChB,qBAAqB;IACrB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,qBAAqB;IACrB,GAAG,EAAE,MAAM,CAAA;IACX,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,kCAAkC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,iCAAiC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,gDAAgD;IAChD,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,4CAA4C;IAC5C,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,4CAA4C;IAC5C,GAAG,CAAC,EAAE,MAAM,CAAA;CACf,CAAA"}

package/dist/index.d.ts

@@ -3,8 +3,8 @@ export type { Image } from './image';
 export type { Video, VideoSource, AdaptiveVideoSource, VideoSourceType } from './video';
 export type { VectorArt } from './vectorArt';
 export type { A11y } from './a11y';
-export type { Audio } from './audio';
-export type { BuilderAudio, AudioSource } from './builderAudio';
+export type { Audio, AudioSource } from './audio';
+export type { BuilderAudio } from './builderAudio';
 export type { MenuItems, MenuItem } from './menuItems';
 export type { Wix } from './wix';
 export type { Schema, Text, TextEnum, NumberType, BooleanValue, LocalDate, LocalTime, LocalDateTime, WebUrl, Email, Phone, Hostname, Regex, Guid, RichText, Container, ArrayItems, DataType, Direction, } from './base';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AACnC,YAAY,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AACpC,YAAY,EAAE,KAAK,EAAE,WAAW,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AACvF,YAAY,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAClC,YAAY,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AACpC,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAC/D,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AACtD,YAAY,EAAE,GAAG,EAAE,MAAM,OAAO,CAAA;AAChC,YAAY,EACR,MAAM,EACN,IAAI,EACJ,QAAQ,EACR,UAAU,EACV,YAAY,EACZ,SAAS,EACT,SAAS,EACT,aAAa,EACb,MAAM,EACN,KAAK,EACL,KAAK,EACL,QAAQ,EACR,KAAK,EACL,IAAI,EACJ,QAAQ,EACR,SAAS,EACT,UAAU,EACV,QAAQ,EACR,SAAS,GACZ,MAAM,QAAQ,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AACnC,YAAY,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AACpC,YAAY,EAAE,KAAK,EAAE,WAAW,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AACvF,YAAY,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAClC,YAAY,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACjD,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAClD,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AACtD,YAAY,EAAE,GAAG,EAAE,MAAM,OAAO,CAAA;AAChC,YAAY,EACR,MAAM,EACN,IAAI,EACJ,QAAQ,EACR,UAAU,EACV,YAAY,EACZ,SAAS,EACT,SAAS,EACT,aAAa,EACb,MAAM,EACN,KAAK,EACL,KAAK,EACL,QAAQ,EACR,KAAK,EACL,IAAI,EACJ,QAAQ,EACR,SAAS,EACT,UAAU,EACV,QAAQ,EACR,SAAS,GACZ,MAAM,QAAQ,CAAA"}

package/dist/links.d.ts

@@ -1,7 +1,26 @@
 type LinkTarget = '_self' | '_blank';
+/**
+ * A link to a URL, used for navigation within components.
+ *
+ * @example
+ * ```tsx
+ * import type { Link } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   link?: Link;
+ * }
+ * ```
+ */
 export type Link = {
+    /** The link URL. */
     href?: string;
+    /**
+     * Where this link should open.
+     * - `'_self'` — opens in the same page.
+     * - `'_blank'` — opens in a new tab.
+     */
     target?: LinkTarget;
+    /** The `rel` attribute of the link. Accepts LinkRel values separated by a space. */
     rel?: string;
 };
 export {};

package/dist/links.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"links.d.ts","sourceRoot":"","sources":["../src/links.ts"],"names":[],"mappings":"AAAA,KAAK,UAAU,GAAG,OAAO,GAAG,QAAQ,CAAA;AAEpC,MAAM,MAAM,IAAI,GAAG;IAEf,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,MAAM,CAAC,EAAE,UAAU,CAAA;IAEnB,GAAG,CAAC,EAAE,MAAM,CAAA;CACf,CAAA"}
+{"version":3,"file":"links.d.ts","sourceRoot":"","sources":["../src/links.ts"],"names":[],"mappings":"AAAA,KAAK,UAAU,GAAG,OAAO,GAAG,QAAQ,CAAA;AAEpC;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,IAAI,GAAG;IACf,oBAAoB;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,oFAAoF;IACpF,GAAG,CAAC,EAAE,MAAM,CAAA;CACf,CAAA"}

package/dist/menuItems.d.ts

@@ -1,11 +1,31 @@
 import type { ReactElement } from 'react';
 import type { Link } from './links';
+/**
+ * A single item in a menu, optionally containing nested sub-items.
+ */
 export type MenuItem = {
+    /** A unique identifier for the menu item. */
     id: string;
+    /** The display label shown to the user. */
     label: string;
+    /** The navigation link for this menu item. */
     link?: Link;
+    /** An optional container element rendered alongside the menu item. */
     container?: ReactElement;
+    /** Nested child menu items, for building multi-level menus. */
     items?: Array<MenuItem>;
 };
+/**
+ * A list of menu items.
+ *
+ * @example
+ * ```tsx
+ * import type { MenuItems } from '@wix/editor-react-types';
+ *
+ * interface MyComponentProps {
+ *   items?: MenuItems;
+ * }
+ * ```
+ */
 export type MenuItems = Array<MenuItem>;
 //# sourceMappingURL=menuItems.d.ts.map

package/dist/menuItems.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"menuItems.d.ts","sourceRoot":"","sources":["../src/menuItems.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAA;AACzC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAEnC,MAAM,MAAM,QAAQ,GAAG;IAEnB,EAAE,EAAE,MAAM,CAAA;IAEV,KAAK,EAAE,MAAM,CAAA;IAEb,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,SAAS,CAAC,EAAE,YAAY,CAAA;IACxB,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAA"}
+{"version":3,"file":"menuItems.d.ts","sourceRoot":"","sources":["../src/menuItems.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAA;AACzC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAEnC;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACnB,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAA;IACV,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,8CAA8C;IAC9C,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,sEAAsE;IACtE,SAAS,CAAC,EAAE,YAAY,CAAA;IACxB,+DAA+D;IAC/D,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAA;CAC1B,CAAA;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAA"}