@fluid-app/portal-sdk 0.1.469 → 0.1.471

package/authoring/widget-api/sdk/src/widgets/worker.md

@@ -0,0 +1,3683 @@
+# sdk/src/widgets/worker
+
+## Classes
+
+### PortalFunctionError
+
+A stable, serializable failure reported by a Portal function call.
+
+#### Extends
+
+- `Error`
+
+#### Constructors
+
+##### Constructor
+
+> **new PortalFunctionError**(`code`, `message`): [`PortalFunctionError`](#portalfunctionerror)
+
+###### Parameters
+
+###### code
+
+[`PortalFunctionErrorCode`](#portalfunctionerrorcode-1)
+
+###### message
+
+`string`
+
+###### Returns
+
+[`PortalFunctionError`](#portalfunctionerror)
+
+###### Overrides
+
+`Error.constructor`
+
+#### Properties
+
+##### cause?
+
+> `optional` **cause?**: `unknown`
+
+###### Inherited from
+
+`Error.cause`
+
+##### code
+
+> `readonly` **code**: [`PortalFunctionErrorCode`](#portalfunctionerrorcode-1)
+
+##### message
+
+> **message**: `string`
+
+###### Inherited from
+
+`Error.message`
+
+##### name
+
+> **name**: `string`
+
+###### Inherited from
+
+`Error.name`
+
+##### stack?
+
+> `optional` **stack?**: `string`
+
+###### Inherited from
+
+`Error.stack`
+
+##### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+The `Error.stackTraceLimit` property specifies the number of stack frames
+collected by a stack trace (whether generated by `new Error().stack` or
+`Error.captureStackTrace(obj)`).
+
+The default value is `10` but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured _after_ the value has been changed.
+
+If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
+
+###### Inherited from
+
+`Error.stackTraceLimit`
+
+#### Methods
+
+##### captureStackTrace()
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Creates a `.stack` property on `targetObject`, which when accessed returns
+a string representing the location in the code at which
+`Error.captureStackTrace()` was called.
+
+```js
+const myObject = {};
+Error.captureStackTrace(myObject);
+myObject.stack; // Similar to `new Error().stack`
+```
+
+The first line of the trace will be prefixed with
+`${myObject.name}: ${myObject.message}`.
+
+The optional `constructorOpt` argument accepts a function. If given, all frames
+above `constructorOpt`, including `constructorOpt`, will be omitted from the
+generated stack trace.
+
+The `constructorOpt` argument is useful for hiding implementation
+details of error generation from the user. For instance:
+
+```js
+function a() {
+  b();
+}
+
+function b() {
+  c();
+}
+
+function c() {
+  // Create an error without stack trace to avoid calculating the stack trace twice.
+  const { stackTraceLimit } = Error;
+  Error.stackTraceLimit = 0;
+  const error = new Error();
+  Error.stackTraceLimit = stackTraceLimit;
+
+  // Capture the stack trace above function b
+  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
+  throw error;
+}
+
+a();
+```
+
+###### Parameters
+
+###### targetObject
+
+`object`
+
+###### constructorOpt?
+
+`Function`
+
+###### Returns
+
+`void`
+
+###### Inherited from
+
+`Error.captureStackTrace`
+
+##### prepareStackTrace()
+
+> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
+
+###### Parameters
+
+###### err
+
+`Error`
+
+###### stackTraces
+
+`CallSite`[]
+
+###### Returns
+
+`any`
+
+###### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+###### Inherited from
+
+`Error.prepareStackTrace`
+
+## Interfaces
+
+### DeclarativeCapabilityUse
+
+#### Properties
+
+##### \[DECLARATIVE_CAPABILITY_USE\]
+
+> `readonly` **\[DECLARATIVE_CAPABILITY_USE\]**: `true`
+
+##### name
+
+> `readonly` **name**: `string`
+
+##### version
+
+> `readonly` **version**: `string`
+
+---
+
+### DefineWidgetOptions
+
+Authoring options accepted by [defineWidget](#definewidget).
+
+#### Extended by
+
+- [`SourceWidget`](#sourcewidget)
+
+#### Type Parameters
+
+##### Name
+
+`Name` _extends_ `string` = `string`
+
+##### Props
+
+`Props` = [`WidgetSourceDefaultProps`](#widgetsourcedefaultprops)
+
+#### Properties
+
+##### category?
+
+> `readonly` `optional` **category?**: `string`
+
+Builder palette category.
+
+##### component
+
+> `readonly` **component**: `ComponentType`\<`Props` & `object`\>
+
+React component rendered by the Remote DOM worker.
+
+##### container?
+
+> `readonly` `optional` **container?**: `"inline"` \| `"block"` \| `"card"` \| `"fullscreen"`
+
+Host layout treatment for the widget.
+
+##### defaultProps?
+
+> `readonly` `optional` **defaultProps?**: `Partial`\<`Props`\>
+
+JSON-serializable props assigned to new widget instances.
+
+##### description?
+
+> `readonly` `optional` **description?**: `string`
+
+Builder palette description of the widget's purpose.
+
+##### displayName?
+
+> `readonly` `optional` **displayName?**: `string`
+
+Human-readable builder palette name.
+
+##### icon?
+
+> `readonly` `optional` **icon?**: `string`
+
+Icon identifier displayed in the builder palette.
+
+##### minSdkVersion?
+
+> `readonly` `optional` **minSdkVersion?**: `string`
+
+Oldest portal SDK version that can host the widget.
+
+##### name
+
+> `readonly` **name**: `Name`
+
+Stable URL-safe widget name used in the canonical widget type.
+
+##### propertySchema?
+
+> `readonly` `optional` **propertySchema?**: [`WidgetSourcePropertySchema`](#widgetsourcepropertyschema)
+
+JSON-serializable property editor schema.
+
+##### resizable?
+
+> `readonly` `optional` **resizable?**: [`WidgetSourceResizable`](#widgetsourceresizable)
+
+Builder resize behavior and optional minimum dimensions.
+
+##### uses?
+
+> `readonly` `optional` **uses?**: readonly ([`DeclarativeCapabilityUse`](#declarativecapabilityuse) \| `AnyPortalFunction`)[]
+
+Typed portal functions and declarative capabilities used by the widget.
+
+---
+
+### FluidSpacerWidgetProps
+
+#### Properties
+
+##### customHeight?
+
+> `readonly` `optional` **customHeight?**: `string`
+
+##### previewMode?
+
+> `readonly` `optional` **previewMode?**: `boolean`
+
+---
+
+### PortalFunctionDefinition
+
+#### Properties
+
+##### capability
+
+> `readonly` **capability**: `string`
+
+##### method
+
+> `readonly` **method**: `string`
+
+##### version
+
+> `readonly` **version**: `string`
+
+---
+
+### PortalFunctionImplementation
+
+#### Properties
+
+##### definition
+
+> `readonly` **definition**: [`PortalFunctionDefinition`](#portalfunctiondefinition)
+
+##### handler
+
+> `readonly` **handler**: (...`args`) => `unknown`
+
+###### Parameters
+
+###### args
+
+...`never`[]
+
+###### Returns
+
+`unknown`
+
+##### portalFunction
+
+> `readonly` **portalFunction**: `AnyPortalFunction`
+
+---
+
+### RemoteDomWidgetWorkerController
+
+#### Methods
+
+##### dispose()
+
+> **dispose**(): `void`
+
+###### Returns
+
+`void`
+
+---
+
+### RuntimeSourceWidget
+
+Generated runtime widget definition accepted by [startWidgetPackage](#startwidgetpackage).
+
+#### Properties
+
+##### capabilities?
+
+> `readonly` `optional` **capabilities?**: readonly [`WidgetSourceCapabilityDeclaration`](#widgetsourcecapabilitydeclaration)[]
+
+Capability declarations enforced for generated runtime widgets.
+
+##### component
+
+> `readonly` **component**: `ComponentType`\<`Record`\<`string`, `unknown`\>\>
+
+React component rendered for this runtime widget type.
+
+##### name?
+
+> `readonly` `optional` **name?**: `string`
+
+Source name retained by generated company worker entries.
+
+##### type
+
+> `readonly` **type**: `string`
+
+Fully qualified widget type registered with the worker runtime.
+
+---
+
+### SearchSortProps
+
+#### Extends
+
+- `FluidSearchSortElementProperties`
+
+#### Properties
+
+##### onSearchChange
+
+> `readonly` **onSearchChange**: (`value`) => `void`
+
+###### Parameters
+
+###### value
+
+`string`
+
+###### Returns
+
+`void`
+
+##### onSortChange?
+
+> `readonly` `optional` **onSortChange?**: (`value`) => `void`
+
+###### Parameters
+
+###### value
+
+`string`
+
+###### Returns
+
+`void`
+
+##### placeholder?
+
+> `readonly` `optional` **placeholder?**: `string`
+
+###### Inherited from
+
+`FluidSearchSortElementProperties.placeholder`
+
+##### searchValue
+
+> `readonly` **searchValue**: `string`
+
+###### Inherited from
+
+`FluidSearchSortElementProperties.searchValue`
+
+##### sortOptions?
+
+> `readonly` `optional` **sortOptions?**: readonly `FluidSearchSortOption`[]
+
+###### Inherited from
+
+`FluidSearchSortElementProperties.sortOptions`
+
+##### sortValue?
+
+> `readonly` `optional` **sortValue?**: `string`
+
+###### Inherited from
+
+`FluidSearchSortElementProperties.sortValue`
+
+---
+
+### SourceWidget
+
+Normalized source widget returned by [defineWidget](#definewidget).
+
+#### Extends
+
+- [`DefineWidgetOptions`](#definewidgetoptions)\<`Name`, `Props`\>
+
+#### Type Parameters
+
+##### Name
+
+`Name` _extends_ `string` = `string`
+
+##### Props
+
+`Props` = [`WidgetSourceDefaultProps`](#widgetsourcedefaultprops)
+
+#### Properties
+
+##### \_\_fluidSourceWidget
+
+> `readonly` **\_\_fluidSourceWidget**: `true`
+
+Internal marker that distinguishes normalized source widgets.
+
+##### capabilities
+
+> `readonly` **capabilities**: readonly [`WidgetSourceCapabilityDeclaration`](#widgetsourcecapabilitydeclaration)[]
+
+Capability declarations derived from [uses](#uses-1).
+
+##### category?
+
+> `readonly` `optional` **category?**: `string`
+
+Builder palette category.
+
+###### Inherited from
+
+[`DefineWidgetOptions`](#definewidgetoptions).[`category`](#category)
+
+##### component
+
+> `readonly` **component**: `ComponentType`\<`Props` & `object`\>
+
+React component rendered by the Remote DOM worker.
+
+###### Inherited from
+
+[`DefineWidgetOptions`](#definewidgetoptions).[`component`](#component)
+
+##### container?
+
+> `readonly` `optional` **container?**: `"inline"` \| `"block"` \| `"card"` \| `"fullscreen"`
+
+Host layout treatment for the widget.
+
+###### Inherited from
+
+[`DefineWidgetOptions`](#definewidgetoptions).[`container`](#container)
+
+##### defaultProps
+
+> `readonly` **defaultProps**: `Partial`\<`Props`\>
+
+Normalized defaults; an omitted author value becomes an empty object.
+
+###### Overrides
+
+[`DefineWidgetOptions`](#definewidgetoptions).[`defaultProps`](#defaultprops)
+
+##### description?
+
+> `readonly` `optional` **description?**: `string`
+
+Builder palette description of the widget's purpose.
+
+###### Inherited from
+
+[`DefineWidgetOptions`](#definewidgetoptions).[`description`](#description)
+
+##### displayName?
+
+> `readonly` `optional` **displayName?**: `string`
+
+Human-readable builder palette name.
+
+###### Inherited from
+
+[`DefineWidgetOptions`](#definewidgetoptions).[`displayName`](#displayname)
+
+##### icon?
+
+> `readonly` `optional` **icon?**: `string`
+
+Icon identifier displayed in the builder palette.
+
+###### Inherited from
+
+[`DefineWidgetOptions`](#definewidgetoptions).[`icon`](#icon)
+
+##### minSdkVersion?
+
+> `readonly` `optional` **minSdkVersion?**: `string`
+
+Oldest portal SDK version that can host the widget.
+
+###### Inherited from
+
+[`DefineWidgetOptions`](#definewidgetoptions).[`minSdkVersion`](#minsdkversion)
+
+##### name
+
+> `readonly` **name**: `Name`
+
+Stable URL-safe widget name used in the canonical widget type.
+
+###### Inherited from
+
+[`DefineWidgetOptions`](#definewidgetoptions).[`name`](#name-3)
+
+##### propertySchema?
+
+> `readonly` `optional` **propertySchema?**: [`WidgetSourcePropertySchema`](#widgetsourcepropertyschema)
+
+JSON-serializable property editor schema.
+
+###### Inherited from
+
+[`DefineWidgetOptions`](#definewidgetoptions).[`propertySchema`](#propertyschema)
+
+##### resizable?
+
+> `readonly` `optional` **resizable?**: [`WidgetSourceResizable`](#widgetsourceresizable)
+
+Builder resize behavior and optional minimum dimensions.
+
+###### Inherited from
+
+[`DefineWidgetOptions`](#definewidgetoptions).[`resizable`](#resizable)
+
+##### uses
+
+> `readonly` **uses**: readonly ([`DeclarativeCapabilityUse`](#declarativecapabilityuse) \| `AnyPortalFunction`)[]
+
+Normalized typed functions and declarative capability markers.
+
+###### Overrides
+
+[`DefineWidgetOptions`](#definewidgetoptions).[`uses`](#uses)
+
+---
+
+### SourceWidgetPackage
+
+Canonical source package returned by [defineWidgetPackage](#definewidgetpackage).
+
+#### Type Parameters
+
+##### Scope
+
+`Scope` _extends_ `string` = `string`
+
+##### StableId
+
+`StableId` _extends_ `string` = `string`
+
+#### Properties
+
+##### \_\_fluidSourceWidgetPackage
+
+> `readonly` **\_\_fluidSourceWidgetPackage**: `true`
+
+Internal marker that distinguishes normalized source packages.
+
+##### cssUrls
+
+> `readonly` **cssUrls**: readonly `string`[]
+
+Runtime stylesheet URLs included in the published descriptor.
+
+##### manifestVersion
+
+> `readonly` **manifestVersion**: `1`
+
+Widget package descriptor format version.
+
+##### packageId
+
+> `readonly` **packageId**: `` `${Scope}.${StableId}` ``
+
+Canonical `${scope}.${packageStableId}` package id.
+
+##### packageStableId
+
+> `readonly` **packageStableId**: `StableId`
+
+Stable company or droplet owner identifier.
+
+##### packageType
+
+> `readonly` **packageType**: `"company"` \| `"droplet"`
+
+Ownership model used for validation, consent, and publication.
+
+##### scope
+
+> `readonly` **scope**: `Scope`
+
+Namespace used as the first segment of the package id.
+
+##### version
+
+> `readonly` **version**: `string`
+
+Normalized SemVer package version.
+
+##### widgets
+
+> `readonly` **widgets**: readonly [`AnySourceWidget`](#anysourcewidget)[]
+
+Widgets included in the package.
+
+---
+
+### StartWidgetPackageOptions
+
+Generated-worker options accepted by [startWidgetPackage](#startwidgetpackage).
+
+#### Properties
+
+##### widgets
+
+> `readonly` **widgets**: readonly [`RuntimeSourceWidget`](#runtimesourcewidget)[]
+
+Generated runtime widgets to register when no source package is available.
+
+---
+
+### WidgetSourceCapabilityDeclaration
+
+#### Properties
+
+##### name
+
+> `readonly` **name**: `string`
+
+Stable capability name enforced by the worker and host.
+
+##### version
+
+> `readonly` **version**: `string`
+
+Capability contract version required by the widget.
+
+---
+
+### WidgetSourcePropertySchema
+
+JSON-serializable property editor schema accepted by widget source metadata.
+The build adds `widgetType`; authors must not supply it.
+
+#### Properties
+
+##### dataSourceTargetProps?
+
+> `readonly` `optional` **dataSourceTargetProps?**: readonly `string`[]
+
+Widget props that data sources can populate.
+
+##### fields
+
+> `readonly` **fields**: readonly (\{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `maxLength?`: `number`; `placeholder?`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `tokenSuggestions?`: readonly `object`[]; `type`: `"text"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `maxLength?`: `number`; `placeholder?`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `rows?`: `number`; `tab?`: `string`; `type`: `"textarea"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `max?`: `number`; `min?`: `number`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `step?`: `number`; `tab?`: `string`; `type`: `"number"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"boolean"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `string` \| `number`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `options`: `object`[]; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"select"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"color"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `max`: `number`; `min`: `number`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `step?`: `number`; `tab?`: `string`; `type`: `"range"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `targetProps?`: readonly `object`[]; `type`: `"dataSource"`; \} \| \{ `advanced?`: `boolean`; `allowedTypes?`: `string`[]; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"resource"`; \} \| \{ `accept?`: `"image"` \| `"video"` \| `"any"`; `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"image"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `AlignOptions`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `options`: \{ `horizontalEnabled`: `boolean`; `verticalEnabled`: `boolean`; \}; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"alignment"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `max`: `number`; `min`: `number`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `step?`: `number`; `tab?`: `string`; `type`: `"slider"`; `unit?`: `string`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `swatches?`: `string`[]; `tab?`: `string`; `type`: `"colorPicker"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `subtitle?`: `string`; `tab?`: `string`; `type`: `"sectionHeader"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"separator"`; \} \| `Omit`\<\{ `advanced?`: `boolean`; `defaultValue?`: `string` \| `number`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `options`: readonly `object`[]; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"buttonGroup"`; \}, `"options"`\> & `object` \| \{ `advanced?`: `boolean`; `defaultValue?`: `ColorOptions`; `description?`: `string`; `excludeColors?`: `ColorOptions`[]; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"colorSelect"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `"single-column"` \| `"2c-equal"` \| `"2c-left-wider"` \| `"2c-right-wider"` \| `"2c-left-narrow"` \| `"2c-right-narrow"` \| `"3c-equal"` \| `"3c-middle-wider"`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"sectionLayoutSelect"`; \} \| \{ `advanced?`: `boolean`; `allowedTypes?`: `string`[]; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"background"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `string`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"contentPosition"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `FontSizeOptions`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"textSizeSelect"`; \} \| \{ `advanced?`: `boolean`; `allowedUnits?`: [`CssUnit`](../../../core/src/registries/property-schema-types.md#cssunit)[]; `defaultUnit?`: [`CssUnit`](../../../core/src/registries/property-schema-types.md#cssunit); `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `maxByUnit?`: `Partial`\<`Record`\<[`CssUnit`](../../../core/src/registries/property-schema-types.md#cssunit), `number`\>\>; `minByUnit?`: `Partial`\<`Record`\<[`CssUnit`](../../../core/src/registries/property-schema-types.md#cssunit), `number`\>\>; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `stepByUnit?`: `Partial`\<`Record`\<[`CssUnit`](../../../core/src/registries/property-schema-types.md#cssunit), `number`\>\>; `tab?`: `string`; `type`: `"cssUnit"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `placeholder?`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"fontPicker"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `string`[]; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `placeholder?`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"stringArray"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `BorderRadiusOptions`; `description?`: `string`; `group?`: `string`; `key`: `string`; `keys`: \{ `bottomLeft`: `string`; `bottomRight`: `string`; `topLeft`: `string`; `topRight`: `string`; \}; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"borderRadius"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `includeSystemItems?`: `boolean`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"screenPicker"`; \})[]
+
+Editable fields shown in the property editor.
+
+##### itemConfigSchema?
+
+> `readonly` `optional` **itemConfigSchema?**: `object`
+
+Optional per-item fields for custom data-source selections.
+
+###### description?
+
+> `readonly` `optional` **description?**: `string`
+
+Help text shown above the per-item editor.
+
+###### fields
+
+> `readonly` **fields**: readonly (\{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `maxLength?`: `number`; `placeholder?`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `tokenSuggestions?`: readonly `object`[]; `type`: `"text"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `maxLength?`: `number`; `placeholder?`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `rows?`: `number`; `tab?`: `string`; `type`: `"textarea"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `max?`: `number`; `min?`: `number`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `step?`: `number`; `tab?`: `string`; `type`: `"number"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"boolean"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `string` \| `number`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `options`: `object`[]; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"select"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"color"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `max`: `number`; `min`: `number`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `step?`: `number`; `tab?`: `string`; `type`: `"range"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `targetProps?`: readonly `object`[]; `type`: `"dataSource"`; \} \| \{ `advanced?`: `boolean`; `allowedTypes?`: `string`[]; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"resource"`; \} \| \{ `accept?`: `"image"` \| `"video"` \| `"any"`; `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"image"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `AlignOptions`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `options`: \{ `horizontalEnabled`: `boolean`; `verticalEnabled`: `boolean`; \}; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"alignment"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `max`: `number`; `min`: `number`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `step?`: `number`; `tab?`: `string`; `type`: `"slider"`; `unit?`: `string`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `swatches?`: `string`[]; `tab?`: `string`; `type`: `"colorPicker"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `subtitle?`: `string`; `tab?`: `string`; `type`: `"sectionHeader"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"separator"`; \} \| `Omit`\<\{ `advanced?`: `boolean`; `defaultValue?`: `string` \| `number`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `options`: readonly `object`[]; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"buttonGroup"`; \}, `"options"`\> & `object` \| \{ `advanced?`: `boolean`; `defaultValue?`: `ColorOptions`; `description?`: `string`; `excludeColors?`: `ColorOptions`[]; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"colorSelect"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `"single-column"` \| `"2c-equal"` \| `"2c-left-wider"` \| `"2c-right-wider"` \| `"2c-left-narrow"` \| `"2c-right-narrow"` \| `"3c-equal"` \| `"3c-middle-wider"`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"sectionLayoutSelect"`; \} \| \{ `advanced?`: `boolean`; `allowedTypes?`: `string`[]; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"background"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `string`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"contentPosition"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `FontSizeOptions`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"textSizeSelect"`; \} \| \{ `advanced?`: `boolean`; `allowedUnits?`: [`CssUnit`](../../../core/src/registries/property-schema-types.md#cssunit)[]; `defaultUnit?`: [`CssUnit`](../../../core/src/registries/property-schema-types.md#cssunit); `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `maxByUnit?`: `Partial`\<`Record`\<[`CssUnit`](../../../core/src/registries/property-schema-types.md#cssunit), `number`\>\>; `minByUnit?`: `Partial`\<`Record`\<[`CssUnit`](../../../core/src/registries/property-schema-types.md#cssunit), `number`\>\>; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `stepByUnit?`: `Partial`\<`Record`\<[`CssUnit`](../../../core/src/registries/property-schema-types.md#cssunit), `number`\>\>; `tab?`: `string`; `type`: `"cssUnit"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `placeholder?`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"fontPicker"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `string`[]; `description?`: `string`; `group?`: `string`; `key`: `string`; `label`: `string`; `placeholder?`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"stringArray"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `BorderRadiusOptions`; `description?`: `string`; `group?`: `string`; `key`: `string`; `keys`: \{ `bottomLeft`: `string`; `bottomRight`: `string`; `topLeft`: `string`; `topRight`: `string`; \}; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"borderRadius"`; \} \| \{ `advanced?`: `boolean`; `defaultValue?`: `JsonValue`; `description?`: `string`; `group?`: `string`; `includeSystemItems?`: `boolean`; `key`: `string`; `label`: `string`; `requiresKeyToBeTrue?`: `string`; `requiresKeyValue?`: \{ `key`: `string`; `value`: `JsonValue`; \} \| readonly `object`[]; `tab?`: `string`; `type`: `"screenPicker"`; \})[]
+
+Fields available for each selected item.
+
+##### tabsConfig?
+
+> `readonly` `optional` **tabsConfig?**: readonly `object`[]
+
+Optional tabs used to organize the property editor.
+
+## Type Aliases
+
+### AddContentMediaProductInput
+
+> **AddContentMediaProductInput** = `object`
+
+#### Properties
+
+##### mediaId
+
+> `readonly` **mediaId**: `number`
+
+##### productId
+
+> `readonly` **productId**: `number`
+
+---
+
+### AddContentPlaylistItemInput
+
+> **AddContentPlaylistItemInput** = `object`
+
+#### Properties
+
+##### contentId
+
+> `readonly` **contentId**: `number`
+
+##### contentType
+
+> `readonly` **contentType**: `"media"` \| `"page"` \| `"product"` \| `"enrollmentPack"`
+
+##### playlistId
+
+> `readonly` **playlistId**: `number`
+
+##### position?
+
+> `readonly` `optional` **position?**: `number` \| `null`
+
+---
+
+### AddMySiteFavoriteInput
+
+> **AddMySiteFavoriteInput** = `object`
+
+#### Properties
+
+##### productId
+
+> `readonly` **productId**: `number`
+
+---
+
+### AnySourceWidget
+
+> **AnySourceWidget** = [`SourceWidget`](#sourcewidget)\<`string`, `any`\>
+
+Heterogeneous source widget type used by package arrays.
+
+---
+
+### CreateContentMediaInput
+
+> **CreateContentMediaInput** = `object`
+
+#### Properties
+
+##### contentFormat?
+
+> `readonly` `optional` **contentFormat?**: `"image"` \| `"video"` \| `"pdf"` \| `"ppt"`
+
+##### description?
+
+> `readonly` `optional` **description?**: `string` \| `null`
+
+##### mediaType
+
+> `readonly` **mediaType**: `string`
+
+##### title
+
+> `readonly` **title**: `string`
+
+##### url?
+
+> `readonly` `optional` **url?**: `string` \| `null`
+
+---
+
+### CreateContentPlaylistInput
+
+> **CreateContentPlaylistInput** = `object`
+
+#### Properties
+
+##### description?
+
+> `readonly` `optional` **description?**: `string` \| `null`
+
+##### title
+
+> `readonly` **title**: `string`
+
+---
+
+### CreateContentShareInput
+
+> **CreateContentShareInput** = `object`
+
+#### Properties
+
+##### shareableId
+
+> `readonly` **shareableId**: `number`
+
+##### shareableType
+
+> `readonly` **shareableType**: `"media"` \| `"product"` \| `"library"` \| `"page"`
+
+---
+
+### CreateDamAssetInput
+
+> **CreateDamAssetInput** = `object`
+
+#### Properties
+
+##### description?
+
+> `readonly` `optional` **description?**: `string` \| `null`
+
+##### name
+
+> `readonly` **name**: `string`
+
+---
+
+### CreateDamAssetPathInput
+
+> **CreateDamAssetPathInput** = `object`
+
+#### Properties
+
+##### assetCode
+
+> `readonly` **assetCode**: `string`
+
+##### path
+
+> `readonly` **path**: `string`
+
+---
+
+### CreateMySiteLinkInput
+
+> **CreateMySiteLinkInput** = `object`
+
+#### Properties
+
+##### title
+
+> `readonly` **title**: `string`
+
+##### url
+
+> `readonly` **url**: `string`
+
+---
+
+### CreateTodoInput
+
+> **CreateTodoInput** = `object`
+
+#### Properties
+
+##### body
+
+> `readonly` **body**: `string`
+
+##### dueAt?
+
+> `readonly` `optional` **dueAt?**: `string` \| `null`
+
+---
+
+### DefineWidgetPackageOptions
+
+> **DefineWidgetPackageOptions**\<`Scope`, `StableId`\> = `DefineWidgetPackageBase`\<`Scope`\> & \{ `packageStableId`: `StableId`; `packageType?`: `"company"`; \} \| \{ `packageStableId?`: `StableId`; `packageType`: `"droplet"`; \}
+
+Authoring options accepted by [defineWidgetPackage](#definewidgetpackage).
+
+#### Type Parameters
+
+##### Scope
+
+`Scope` _extends_ `string` = `string`
+
+##### StableId
+
+`StableId` _extends_ `string` = `string`
+
+---
+
+### DeleteContentMediaInput
+
+> **DeleteContentMediaInput** = `object`
+
+#### Properties
+
+##### id
+
+> `readonly` **id**: `number`
+
+---
+
+### DeleteContentPlaylistInput
+
+> **DeleteContentPlaylistInput** = `object`
+
+#### Properties
+
+##### id
+
+> `readonly` **id**: `number`
+
+---
+
+### DeleteMySiteFavoriteInput
+
+> **DeleteMySiteFavoriteInput** = `object`
+
+#### Properties
+
+##### id
+
+> `readonly` **id**: `number`
+
+---
+
+### DeleteMySiteLinkInput
+
+> **DeleteMySiteLinkInput** = `object`
+
+#### Properties
+
+##### id
+
+> `readonly` **id**: `number`
+
+---
+
+### FullscreenState
+
+> **FullscreenState** = `object`
+
+#### Properties
+
+##### available
+
+> `readonly` **available**: `boolean`
+
+##### fullscreen
+
+> `readonly` **fullscreen**: `boolean`
+
+---
+
+### GetAddressFieldsInput
+
+> **GetAddressFieldsInput** = `object`
+
+#### Properties
+
+##### countryCode
+
+> `readonly` **countryCode**: `string`
+
+##### languageIso?
+
+> `readonly` `optional` **languageIso?**: `string`
+
+---
+
+### GetContentMediaInput
+
+> **GetContentMediaInput** = `object`
+
+#### Properties
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### languageIso?
+
+> `readonly` `optional` **languageIso?**: `string`
+
+---
+
+### GetEnrollmentPackInput
+
+> **GetEnrollmentPackInput** = `object`
+
+#### Properties
+
+##### id
+
+> `readonly` **id**: `number`
+
+---
+
+### GetPageInput
+
+> **GetPageInput** = `object`
+
+#### Properties
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### languageIso?
+
+> `readonly` `optional` **languageIso?**: `string`
+
+---
+
+### GetPlaylistInput
+
+> **GetPlaylistInput** = `object`
+
+#### Properties
+
+##### id
+
+> `readonly` **id**: `number`
+
+---
+
+### GetProductInput
+
+> **GetProductInput** = `object`
+
+#### Properties
+
+##### id
+
+> `readonly` **id**: `string` \| `number`
+
+---
+
+### ListContentMediaInput
+
+> **ListContentMediaInput** = [`PortalPageInput`](#portalpageinput) & `object`
+
+#### Type Declaration
+
+##### contentFormat?
+
+> `readonly` `optional` **contentFormat?**: `"video"` \| `"image"` \| `"pdf"` \| `"ppt"`
+
+##### languageIso?
+
+> `readonly` `optional` **languageIso?**: `string`
+
+##### ownership?
+
+> `readonly` `optional` **ownership?**: `"all"` \| `"mine"` \| `"company"`
+
+##### sort?
+
+> `readonly` `optional` **sort?**: `"title_asc"` \| `"title_desc"`
+
+##### title?
+
+> `readonly` `optional` **title?**: `string`
+
+---
+
+### ListContentMediaProductsInput
+
+> **ListContentMediaProductsInput** = [`PortalPageInput`](#portalpageinput) & `object`
+
+#### Type Declaration
+
+##### languageIso?
+
+> `readonly` `optional` **languageIso?**: `string`
+
+##### mediaId
+
+> `readonly` **mediaId**: `number`
+
+---
+
+### ListContentMetricsInput
+
+> **ListContentMetricsInput** = `ListContentMetricsBaseInput` & `object` \| `ListContentMetricsBaseInput` & `object`
+
+---
+
+### ListCountriesInput
+
+> **ListCountriesInput** = [`PortalPageInput`](#portalpageinput) & `object`
+
+#### Type Declaration
+
+##### languageIso?
+
+> `readonly` `optional` **languageIso?**: `string`
+
+---
+
+### ListDamAssetPathsInput
+
+> **ListDamAssetPathsInput** = [`PortalPageInput`](#portalpageinput) & `object`
+
+#### Type Declaration
+
+##### assetCode
+
+> `readonly` **assetCode**: `string`
+
+---
+
+### ListPagesInput
+
+> **ListPagesInput** = [`PortalPageInput`](#portalpageinput) & `object`
+
+#### Type Declaration
+
+##### languageIso?
+
+> `readonly` `optional` **languageIso?**: `string`
+
+##### sort?
+
+> `readonly` `optional` **sort?**: `"title_asc"` \| `"title_desc"`
+
+##### title?
+
+> `readonly` `optional` **title?**: `string`
+
+---
+
+### ListPlaylistItemsInput
+
+> **ListPlaylistItemsInput** = [`PortalPageInput`](#portalpageinput) & `object`
+
+#### Type Declaration
+
+##### languageIso?
+
+> `readonly` `optional` **languageIso?**: `string`
+
+##### playlistId
+
+> `readonly` **playlistId**: `number`
+
+---
+
+### ListPlaylistsInput
+
+> **ListPlaylistsInput** = [`PortalPageInput`](#portalpageinput) & `object`
+
+#### Type Declaration
+
+##### ownership?
+
+> `readonly` `optional` **ownership?**: `"all"` \| `"mine"` \| `"company"`
+
+##### sort?
+
+> `readonly` `optional` **sort?**: `"title_asc"` \| `"title_desc"` \| `"created_at_asc"` \| `"created_at_desc"`
+
+##### title?
+
+> `readonly` `optional` **title?**: `string`
+
+---
+
+### ListProductMediaInput
+
+> **ListProductMediaInput** = `object`
+
+#### Properties
+
+##### productId
+
+> `readonly` **productId**: `string` \| `number`
+
+---
+
+### ListProductMetricsInput
+
+> **ListProductMetricsInput** = `object`
+
+#### Properties
+
+##### kind
+
+> `readonly` **kind**: `"visits"` \| `"shareVisits"`
+
+##### limit?
+
+> `readonly` `optional` **limit?**: `number`
+
+##### period?
+
+> `readonly` `optional` **period?**: [`PortalMetricsPeriod`](#portalmetricsperiod)
+
+---
+
+### ListProductsInput
+
+> **ListProductsInput** = [`PortalPageInput`](#portalpageinput) & `object`
+
+#### Type Declaration
+
+##### sort?
+
+> `readonly` `optional` **sort?**: `"title_asc"` \| `"title_desc"` \| `"price_asc"` \| `"price_desc"` \| `"created_at_asc"` \| `"created_at_desc"`
+
+---
+
+### ListTodosInput
+
+> **ListTodosInput** = `object`
+
+#### Properties
+
+##### state?
+
+> `readonly` `optional` **state?**: `"incomplete"` \| `"completed"` \| `"all"`
+
+---
+
+### MutateDamAssetInput
+
+> **MutateDamAssetInput** = `object`
+
+#### Properties
+
+##### assetCode
+
+> `readonly` **assetCode**: `string`
+
+---
+
+### PortalAddressFields
+
+> **PortalAddressFields** = `object`
+
+#### Properties
+
+##### countryCode
+
+> `readonly` **countryCode**: `string`
+
+##### countryName
+
+> `readonly` **countryName**: `string`
+
+##### fields
+
+> `readonly` **fields**: readonly `object`[]
+
+---
+
+### PortalAppSummary
+
+> **PortalAppSummary** = `object`
+
+#### Properties
+
+##### definitionId
+
+> `readonly` **definitionId**: [`PortalEntityId`](#portalentityid) \| `null`
+
+##### profile
+
+> `readonly` **profile**: [`PortalProfileSummary`](#portalprofilesummary) \| `null`
+
+##### publishedVersion
+
+> `readonly` **publishedVersion**: `number` \| `null`
+
+##### screens
+
+> `readonly` **screens**: [`PortalSummaryCollection`](#portalsummarycollection)\<[`PortalScreenSummary`](#portalscreensummary)\>
+
+---
+
+### PortalCalendarEvent
+
+> **PortalCalendarEvent** = `object`
+
+#### Properties
+
+##### color
+
+> `readonly` **color**: `string` \| `null`
+
+##### countries
+
+> `readonly` **countries**: readonly `string`[]
+
+##### description
+
+> `readonly` **description**: `string` \| `null`
+
+##### end
+
+> `readonly` **end**: `string`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### imageUrl
+
+> `readonly` **imageUrl**: `string` \| `null`
+
+##### isAllDay
+
+> `readonly` **isAllDay**: `boolean`
+
+##### start
+
+> `readonly` **start**: `string`
+
+##### status
+
+> `readonly` **status**: `string` \| `null`
+
+##### timeZone
+
+> `readonly` **timeZone**: `string` \| `null`
+
+##### title
+
+> `readonly` **title**: `string`
+
+##### url
+
+> `readonly` **url**: `string` \| `null`
+
+##### venue
+
+> `readonly` **venue**: `string` \| `null`
+
+---
+
+### PortalContentFavoriteState
+
+> **PortalContentFavoriteState** = `object`
+
+#### Properties
+
+##### favoriteableId
+
+> `readonly` **favoriteableId**: `number`
+
+##### favoriteableType
+
+> `readonly` **favoriteableType**: `ContentFavoriteType`
+
+##### isFavorited
+
+> `readonly` **isFavorited**: `boolean`
+
+---
+
+### PortalCountry
+
+> **PortalCountry** = `object`
+
+#### Properties
+
+##### code
+
+> `readonly` **code**: `string`
+
+##### currencyCode
+
+> `readonly` **currencyCode**: `string`
+
+##### name
+
+> `readonly` **name**: `string`
+
+##### states
+
+> `readonly` **states**: readonly `object`[]
+
+---
+
+### PortalDamAsset
+
+> **PortalDamAsset** = `object`
+
+#### Properties
+
+##### canonicalPath
+
+> `readonly` **canonicalPath**: `string` \| `null`
+
+##### category
+
+> `readonly` **category**: `string` \| `null`
+
+##### code
+
+> `readonly` **code**: `string`
+
+##### createdAt
+
+> `readonly` **createdAt**: `string`
+
+##### defaultVariantUrl
+
+> `readonly` **defaultVariantUrl**: `string` \| `null`
+
+##### description
+
+> `readonly` **description**: `string` \| `null`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### name
+
+> `readonly` **name**: `string`
+
+##### updatedAt
+
+> `readonly` **updatedAt**: `string` \| `null`
+
+---
+
+### PortalDamAssetPath
+
+> **PortalDamAssetPath** = `object`
+
+#### Properties
+
+##### assetCode
+
+> `readonly` **assetCode**: `string`
+
+##### createdAt
+
+> `readonly` **createdAt**: `string`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### path
+
+> `readonly` **path**: `string`
+
+---
+
+### PortalEnrollmentPack
+
+> **PortalEnrollmentPack** = `object`
+
+#### Properties
+
+##### canonicalUrl
+
+> `readonly` **canonicalUrl**: `string` \| `null`
+
+##### description
+
+> `readonly` **description**: `string` \| `null`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### images
+
+> `readonly` **images**: readonly [`PortalImage`](#portalimage)[]
+
+##### slug
+
+> `readonly` **slug**: `string` \| `null`
+
+##### title
+
+> `readonly` **title**: `string`
+
+##### url
+
+> `readonly` **url**: `string` \| `null`
+
+---
+
+### PortalEntityId
+
+> **PortalEntityId** = `string` \| `number`
+
+---
+
+### PortalFunction
+
+> **PortalFunction**\<`Output`, `Input`\> = \[`Input`\] _extends_ \[`void`\] ? () => `Promise`\<`Output`\> : (`input`) => `Promise`\<`Output`\>
+
+#### Type Parameters
+
+##### Output
+
+`Output`
+
+##### Input
+
+`Input` = `void`
+
+---
+
+### PortalFunctionErrorCode
+
+> **PortalFunctionErrorCode** = `"NOT_MOUNTED"` \| `"NOT_DECLARED"` \| `"INVALID_ARGUMENT"` \| `"UNAVAILABLE"` \| `"UNSUPPORTED"` \| `"HOST_FAILURE"` \| `"INVALID_RESPONSE"`
+
+---
+
+### PortalFunctionHandler
+
+> **PortalFunctionHandler**\<`Output`, `Input`\> = \[`Input`\] _extends_ \[`void`\] ? () => `Output` \| `Promise`\<`Output`\> : (`input`) => `Output` \| `Promise`\<`Output`\>
+
+#### Type Parameters
+
+##### Output
+
+`Output`
+
+##### Input
+
+`Input` = `void`
+
+---
+
+### PortalFunctionJsonValue
+
+> **PortalFunctionJsonValue** = `RemoteDomSerializableValue`
+
+---
+
+### PortalImage
+
+> **PortalImage** = `object`
+
+#### Properties
+
+##### alt
+
+> `readonly` **alt**: `string` \| `null`
+
+##### url
+
+> `readonly` **url**: `string` \| `null`
+
+---
+
+### PortalLanguage
+
+> **PortalLanguage** = `object`
+
+#### Properties
+
+##### code
+
+> `readonly` **code**: `string`
+
+##### name
+
+> `readonly` **name**: `string`
+
+---
+
+### PortalMedia
+
+> **PortalMedia** = `object`
+
+#### Properties
+
+##### contentFormat
+
+> `readonly` **contentFormat**: `string` \| `null`
+
+##### createdAt
+
+> `readonly` **createdAt**: `string`
+
+##### cta
+
+> `readonly` **cta**: [`PortalMediaCta`](#portalmediacta-1) \| `null`
+
+##### description
+
+> `readonly` **description**: `string` \| `null`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### seo
+
+> `readonly` **seo**: \{ `blockCrawler`: `boolean`; `description`: `string` \| `null`; `imageUrl`: `string` \| `null`; `title`: `string` \| `null`; \} \| `null`
+
+##### status
+
+> `readonly` **status**: `string` \| `null`
+
+##### thumbnailUrl
+
+> `readonly` **thumbnailUrl**: `string` \| `null`
+
+##### title
+
+> `readonly` **title**: `string`
+
+##### updatedAt
+
+> `readonly` **updatedAt**: `string`
+
+##### url
+
+> `readonly` **url**: `string` \| `null`
+
+---
+
+### PortalMediaCta
+
+> **PortalMediaCta** = `object`
+
+#### Properties
+
+##### actionUrl
+
+> `readonly` **actionUrl**: `string` \| `null`
+
+##### buttonColor
+
+> `readonly` **buttonColor**: `string` \| `null`
+
+##### buttonDescription
+
+> `readonly` **buttonDescription**: `string` \| `null`
+
+##### buttonText
+
+> `readonly` **buttonText**: `string` \| `null`
+
+##### enabled
+
+> `readonly` **enabled**: `boolean`
+
+##### type
+
+> `readonly` **type**: `"link"` \| `"cart"` \| `"email"` \| `"phone"` \| `null`
+
+---
+
+### PortalMediaProduct
+
+> **PortalMediaProduct** = `object`
+
+#### Properties
+
+##### addedAt
+
+> `readonly` **addedAt**: `string` \| `null`
+
+##### currency
+
+> `readonly` **currency**: `string` \| `null`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### imageUrl
+
+> `readonly` **imageUrl**: `string` \| `null`
+
+##### name
+
+> `readonly` **name**: `string` \| `null`
+
+##### price
+
+> `readonly` **price**: `string` \| `null`
+
+##### slug
+
+> `readonly` **slug**: `string` \| `null`
+
+---
+
+### PortalMemberAccess
+
+> **PortalMemberAccess** = `object`
+
+#### Properties
+
+##### canAccessRepSurfaces
+
+> `readonly` **canAccessRepSurfaces**: `boolean`
+
+##### memberType
+
+> `readonly` **memberType**: `"customer"` \| `"rep"`
+
+##### name
+
+> `readonly` **name**: `string` \| `null`
+
+##### permissions
+
+> `readonly` **permissions**: `Readonly`\<`Record`\<`string`, `boolean`\>\>
+
+##### slug
+
+> `readonly` **slug**: `string`
+
+---
+
+### PortalMetric
+
+> **PortalMetric** = `object`
+
+#### Properties
+
+##### id
+
+> `readonly` **id**: `number` \| `null`
+
+##### total
+
+> `readonly` **total**: `number`
+
+---
+
+### PortalMetricsPeriod
+
+> **PortalMetricsPeriod** = `"7d"` \| `"30d"` \| `"90d"` \| `"1y"` \| `"all"`
+
+---
+
+### PortalMySiteFavorite
+
+> **PortalMySiteFavorite** = `object`
+
+#### Properties
+
+##### createdAt
+
+> `readonly` **createdAt**: `string` \| `null`
+
+##### favoriteableId
+
+> `readonly` **favoriteableId**: `number`
+
+##### favoriteableType
+
+> `readonly` **favoriteableType**: `string`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### imageUrl
+
+> `readonly` **imageUrl**: `string` \| `null`
+
+##### name
+
+> `readonly` **name**: `string` \| `null`
+
+##### position
+
+> `readonly` **position**: `number`
+
+---
+
+### PortalMySiteLink
+
+> **PortalMySiteLink** = `object`
+
+#### Properties
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### position
+
+> `readonly` **position**: `number`
+
+##### title
+
+> `readonly` **title**: `string`
+
+##### url
+
+> `readonly` **url**: `string`
+
+---
+
+### PortalMySiteProfile
+
+> **PortalMySiteProfile** = `object`
+
+#### Properties
+
+##### avatarUrl
+
+> `readonly` **avatarUrl**: `string` \| `null`
+
+##### bio
+
+> `readonly` **bio**: `string` \| `null`
+
+##### displayName
+
+> `readonly` **displayName**: `string` \| `null`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### leads
+
+> `readonly` **leads**: `number`
+
+##### slug
+
+> `readonly` **slug**: `string` \| `null`
+
+##### themeId
+
+> `readonly` **themeId**: `number` \| `null`
+
+##### url
+
+> `readonly` **url**: `string` \| `null`
+
+##### views
+
+> `readonly` **views**: `number`
+
+---
+
+### PortalMySiteTheme
+
+> **PortalMySiteTheme** = `object`
+
+#### Properties
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### name
+
+> `readonly` **name**: `string`
+
+##### previewUrl
+
+> `readonly` **previewUrl**: `string` \| `null`
+
+---
+
+### PortalNamedEntitySummary
+
+> **PortalNamedEntitySummary** = `object`
+
+#### Properties
+
+##### definitionId
+
+> `readonly` **definitionId**: [`PortalEntityId`](#portalentityid) \| `null`
+
+##### id
+
+> `readonly` **id**: [`PortalEntityId`](#portalentityid) \| `null`
+
+##### name
+
+> `readonly` **name**: `string` \| `null`
+
+##### slug
+
+> `readonly` **slug**: `string` \| `null`
+
+---
+
+### PortalNavigationItem
+
+> **PortalNavigationItem** = `object`
+
+#### Properties
+
+##### children
+
+> `readonly` **children**: readonly [`PortalNavigationItem`](#portalnavigationitem)[]
+
+##### icon
+
+> `readonly` **icon**: `string` \| `null`
+
+##### id
+
+> `readonly` **id**: `number` \| `null`
+
+##### label
+
+> `readonly` **label**: `string`
+
+##### parentId
+
+> `readonly` **parentId**: `number` \| `null`
+
+##### position
+
+> `readonly` **position**: `number` \| `null`
+
+##### screenId
+
+> `readonly` **screenId**: `number` \| `null`
+
+##### section
+
+> `readonly` **section**: `string` \| `null`
+
+##### slug
+
+> `readonly` **slug**: `string` \| `null`
+
+##### source
+
+> `readonly` **source**: `"user"` \| `"system"` \| `"code"` \| `null`
+
+---
+
+### PortalNavigationState
+
+> **PortalNavigationState** = `object`
+
+#### Properties
+
+##### basePath
+
+> `readonly` **basePath**: `string`
+
+##### currentSlug
+
+> `readonly` **currentSlug**: `string`
+
+##### navItems
+
+> `readonly` **navItems**: readonly [`PortalNavigationItem`](#portalnavigationitem)[]
+
+##### previousSlug
+
+> `readonly` **previousSlug**: `string` \| `null`
+
+---
+
+### PortalNavigationSummary
+
+> **PortalNavigationSummary** = `object`
+
+#### Properties
+
+##### definitionId
+
+> `readonly` **definitionId**: [`PortalEntityId`](#portalentityid) \| `null`
+
+##### id
+
+> `readonly` **id**: [`PortalEntityId`](#portalentityid) \| `null`
+
+##### name
+
+> `readonly` **name**: `string` \| `null`
+
+##### navigationItemCount
+
+> `readonly` **navigationItemCount**: `number`
+
+##### screenCount
+
+> `readonly` **screenCount**: `number`
+
+---
+
+### PortalNavigationTarget
+
+> **PortalNavigationTarget** = `string` \| \{ `slug`: `string`; \} \| \{ `href`: `string`; \}
+
+---
+
+### PortalPage
+
+> **PortalPage**\<`Item`\> = `object`
+
+#### Type Parameters
+
+##### Item
+
+`Item`
+
+#### Properties
+
+##### items
+
+> `readonly` **items**: readonly `Item`[]
+
+##### nextCursor
+
+> `readonly` **nextCursor**: `string` \| `null`
+
+---
+
+### PortalPageContent
+
+> **PortalPageContent** = `object`
+
+#### Properties
+
+##### countries
+
+> `readonly` **countries**: readonly [`PortalCountry`](#portalcountry)[]
+
+##### description
+
+> `readonly` **description**: `string` \| `null`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### imageUrl
+
+> `readonly` **imageUrl**: `string` \| `null`
+
+##### slug
+
+> `readonly` **slug**: `string` \| `null`
+
+##### source
+
+> `readonly` **source**: `"code"` \| `"builder"` \| `null`
+
+##### status
+
+> `readonly` **status**: `"published"` \| `"unpublished"`
+
+##### title
+
+> `readonly` **title**: `string` \| `null`
+
+---
+
+### PortalPageDetail
+
+> **PortalPageDetail** = `object`
+
+#### Properties
+
+##### page
+
+> `readonly` **page**: [`PortalPageContent`](#portalpagecontent)
+
+##### shareLink
+
+> `readonly` **shareLink**: `string` \| `null`
+
+---
+
+### PortalPageInput
+
+> **PortalPageInput** = `object`
+
+#### Properties
+
+##### cursor?
+
+> `readonly` `optional` **cursor?**: `string`
+
+##### limit?
+
+> `readonly` `optional` **limit?**: `number`
+
+---
+
+### PortalPlaylist
+
+> **PortalPlaylist** = `object`
+
+#### Properties
+
+##### createdAt
+
+> `readonly` **createdAt**: `string`
+
+##### description
+
+> `readonly` **description**: `string` \| `null`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### imageUrl
+
+> `readonly` **imageUrl**: `string` \| `null`
+
+##### isFavorited
+
+> `readonly` **isFavorited**: `boolean`
+
+##### itemsCount
+
+> `readonly` **itemsCount**: `number`
+
+##### title
+
+> `readonly` **title**: `string`
+
+##### updatedAt
+
+> `readonly` **updatedAt**: `string`
+
+---
+
+### PortalPlaylistItem
+
+> **PortalPlaylistItem** = `object`
+
+#### Properties
+
+##### content
+
+> `readonly` **content**: [`PortalPlaylistItemContent`](#portalplaylistitemcontent-1)
+
+##### contentId
+
+> `readonly` **contentId**: `number`
+
+##### contentType
+
+> `readonly` **contentType**: `"media"` \| `"page"` \| `"product"` \| `"enrollmentPack"`
+
+##### createdAt
+
+> `readonly` **createdAt**: `string`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### position
+
+> `readonly` **position**: `number` \| `null`
+
+---
+
+### PortalPlaylistItemContent
+
+> **PortalPlaylistItemContent** = \{ `description`: `string` \| `null`; `id`: `number`; `thumbnailUrl`: `string` \| `null`; `title`: `string`; `type`: `"media"`; `url`: `string` \| `null`; \} \| \{ `description`: `string` \| `null`; `id`: `number`; `imageUrl`: `string` \| `null`; `slug`: `string` \| `null`; `status`: `"published"` \| `"unpublished"`; `title`: `string` \| `null`; `type`: `"page"`; \} \| \{ `product`: [`PortalPlaylistProduct`](#portalplaylistproduct); `type`: `"product"`; \} \| \{ `description`: `string` \| `null`; `id`: `number`; `images`: readonly [`PortalImage`](#portalimage)[]; `slug`: `string` \| `null`; `title`: `string`; `type`: `"enrollmentPack"`; `url`: `string` \| `null`; \}
+
+---
+
+### PortalPlaylistProduct
+
+> **PortalPlaylistProduct** = `object`
+
+#### Properties
+
+##### createdAt
+
+> `readonly` **createdAt**: `string` \| `null`
+
+##### currency
+
+> `readonly` **currency**: `string` \| `null`
+
+##### description
+
+> `readonly` **description**: `string` \| `null`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### images
+
+> `readonly` **images**: readonly [`PortalImage`](#portalimage)[]
+
+##### mediaCount
+
+> `readonly` **mediaCount**: `number` \| `null`
+
+##### name
+
+> `readonly` **name**: `string`
+
+##### price
+
+> `readonly` **price**: `string` \| `null`
+
+##### slug
+
+> `readonly` **slug**: `string` \| `null`
+
+##### status
+
+> `readonly` **status**: `string` \| `null`
+
+##### wholesalePrice
+
+> `readonly` **wholesalePrice**: `string` \| `null`
+
+---
+
+### PortalPointsLedger
+
+> **PortalPointsLedger** = `object`
+
+#### Properties
+
+##### balance
+
+> `readonly` **balance**: `number`
+
+##### entries
+
+> `readonly` **entries**: readonly [`PortalPointsLedgerEntry`](#portalpointsledgerentry)[]
+
+---
+
+### PortalPointsLedgerEntry
+
+> **PortalPointsLedgerEntry** = `object`
+
+#### Properties
+
+##### amount
+
+> `readonly` **amount**: `number`
+
+##### createdAt
+
+> `readonly` **createdAt**: `string`
+
+##### hasSource
+
+> `readonly` **hasSource**: `boolean`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### transactionType
+
+> `readonly` **transactionType**: `string` \| `null`
+
+---
+
+### PortalProduct
+
+> **PortalProduct** = `object`
+
+#### Properties
+
+##### createdAt
+
+> `readonly` **createdAt**: `string` \| `null`
+
+##### currency
+
+> `readonly` **currency**: `string` \| `null`
+
+##### cv
+
+> `readonly` **cv**: `string` \| `null`
+
+##### description
+
+> `readonly` **description**: `string` \| `null`
+
+##### hasCustomizations
+
+> `readonly` **hasCustomizations**: `boolean` \| `null`
+
+##### id
+
+> `readonly` **id**: `number` \| `null`
+
+##### images
+
+> `readonly` **images**: readonly [`PortalImage`](#portalimage)[]
+
+##### isBundle
+
+> `readonly` **isBundle**: `boolean`
+
+##### mediaCount
+
+> `readonly` **mediaCount**: `number` \| `null`
+
+##### name
+
+> `readonly` **name**: `string` \| `null`
+
+##### price
+
+> `readonly` **price**: `string` \| `null`
+
+##### priceRange
+
+> `readonly` **priceRange**: \{ `max`: `string`; `min`: `string`; \} \| `null`
+
+##### qv
+
+> `readonly` **qv**: `string` \| `null`
+
+##### shopLink
+
+> `readonly` **shopLink**: `string` \| `null`
+
+##### slug
+
+> `readonly` **slug**: `string` \| `null`
+
+##### status
+
+> `readonly` **status**: `string` \| `null`
+
+##### subscriptionPriceRange
+
+> `readonly` **subscriptionPriceRange**: \{ `max`: `string`; `min`: `string`; \} \| `null`
+
+##### variants
+
+> `readonly` **variants**: readonly [`PortalProductVariant`](#portalproductvariant)[]
+
+##### wholesalePrice
+
+> `readonly` **wholesalePrice**: `string` \| `null`
+
+---
+
+### PortalProductMedia
+
+> **PortalProductMedia** = `object`
+
+#### Properties
+
+##### id
+
+> `readonly` **id**: `number` \| `null`
+
+##### mediaType
+
+> `readonly` **mediaType**: `string` \| `null`
+
+##### title
+
+> `readonly` **title**: `string` \| `null`
+
+##### url
+
+> `readonly` **url**: `string` \| `null`
+
+---
+
+### PortalProductVariant
+
+> **PortalProductVariant** = `object`
+
+#### Properties
+
+##### available
+
+> `readonly` **available**: `boolean` \| `null`
+
+##### currency
+
+> `readonly` **currency**: `string` \| `null`
+
+##### cv
+
+> `readonly` **cv**: `string` \| `null`
+
+##### id
+
+> `readonly` **id**: `number` \| `null`
+
+##### images
+
+> `readonly` **images**: readonly [`PortalImage`](#portalimage)[]
+
+##### isMaster
+
+> `readonly` **isMaster**: `boolean` \| `null`
+
+##### position
+
+> `readonly` **position**: `number` \| `null`
+
+##### price
+
+> `readonly` **price**: `string` \| `null`
+
+##### qv
+
+> `readonly` **qv**: `string` \| `null`
+
+##### sku
+
+> `readonly` **sku**: `string` \| `null`
+
+##### title
+
+> `readonly` **title**: `string` \| `null`
+
+##### wholesalePrice
+
+> `readonly` **wholesalePrice**: `string` \| `null`
+
+---
+
+### PortalProfileSummary
+
+> **PortalProfileSummary** = `object`
+
+#### Properties
+
+##### activeThemeId
+
+> `readonly` **activeThemeId**: `string` \| `null`
+
+##### definitionId
+
+> `readonly` **definitionId**: [`PortalEntityId`](#portalentityid) \| `null`
+
+##### mobileNavigation
+
+> `readonly` **mobileNavigation**: [`PortalNavigationSummary`](#portalnavigationsummary) \| `null`
+
+##### name
+
+> `readonly` **name**: `string` \| `null`
+
+##### navigation
+
+> `readonly` **navigation**: [`PortalNavigationSummary`](#portalnavigationsummary) \| `null`
+
+##### themes
+
+> `readonly` **themes**: [`PortalSummaryCollection`](#portalsummarycollection)\<[`PortalNamedEntitySummary`](#portalnamedentitysummary)\>
+
+---
+
+### PortalScreenSummary
+
+> **PortalScreenSummary** = [`PortalNamedEntitySummary`](#portalnamedentitysummary) & `object`
+
+#### Type Declaration
+
+##### componentCount
+
+> `readonly` **componentCount**: `number`
+
+---
+
+### PortalShare
+
+> **PortalShare** = `object`
+
+#### Properties
+
+##### createdAt
+
+> `readonly` **createdAt**: `string`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### shareableId
+
+> `readonly` **shareableId**: `number`
+
+##### shareableType
+
+> `readonly` **shareableType**: `"media"` \| `"product"` \| `"library"` \| `"page"`
+
+##### url
+
+> `readonly` **url**: `string`
+
+---
+
+### PortalStore
+
+> **PortalStore** = `object`
+
+#### Properties
+
+##### appStoreUrl
+
+> `readonly` **appStoreUrl**: `string` \| `null`
+
+##### bundleSubscriptionsEnabled
+
+> `readonly` **bundleSubscriptionsEnabled**: `boolean`
+
+##### iconUrl
+
+> `readonly` **iconUrl**: `string` \| `null`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### logoUrl
+
+> `readonly` **logoUrl**: `string` \| `null`
+
+##### name
+
+> `readonly` **name**: `string`
+
+##### playStoreUrl
+
+> `readonly` **playStoreUrl**: `string` \| `null`
+
+##### rewardPointsLabelPlural
+
+> `readonly` **rewardPointsLabelPlural**: `string`
+
+##### rewardPointsLabelSingular
+
+> `readonly` **rewardPointsLabelSingular**: `string`
+
+##### subdomain
+
+> `readonly` **subdomain**: `string`
+
+---
+
+### PortalSummaryCollection
+
+> **PortalSummaryCollection**\<`Item`\> = `object`
+
+#### Type Parameters
+
+##### Item
+
+`Item`
+
+#### Properties
+
+##### count
+
+> `readonly` **count**: `number`
+
+##### items
+
+> `readonly` **items**: readonly `Item`[]
+
+---
+
+### PortalTodo
+
+> **PortalTodo** = [`PortalTodoSummary`](#portaltodosummary) & `object`
+
+#### Type Declaration
+
+##### body
+
+> `readonly` **body**: `string`
+
+---
+
+### PortalTodoSummary
+
+> **PortalTodoSummary** = `object`
+
+#### Properties
+
+##### completedAt
+
+> `readonly` **completedAt**: `string` \| `null`
+
+##### createdAt
+
+> `readonly` **createdAt**: `string`
+
+##### dueAt
+
+> `readonly` **dueAt**: `string` \| `null`
+
+##### id
+
+> `readonly` **id**: `number`
+
+---
+
+### RemoveContentMediaProductInput
+
+> **RemoveContentMediaProductInput** = [`AddContentMediaProductInput`](#addcontentmediaproductinput)
+
+---
+
+### RemoveContentPlaylistItemInput
+
+> **RemoveContentPlaylistItemInput** = `object`
+
+#### Properties
+
+##### itemId
+
+> `readonly` **itemId**: `number`
+
+##### playlistId
+
+> `readonly` **playlistId**: `number`
+
+---
+
+### ReorderContentPlaylistItemsInput
+
+> **ReorderContentPlaylistItemsInput** = `object`
+
+#### Properties
+
+##### items
+
+> `readonly` **items**: readonly `object`[]
+
+##### playlistId
+
+> `readonly` **playlistId**: `number`
+
+---
+
+### ReorderMySiteFavoritesInput
+
+> **ReorderMySiteFavoritesInput** = `object`
+
+#### Properties
+
+##### orderedIds
+
+> `readonly` **orderedIds**: readonly `number`[]
+
+---
+
+### ReorderMySiteLinksInput
+
+> **ReorderMySiteLinksInput** = `object`
+
+#### Properties
+
+##### orderedIds
+
+> `readonly` **orderedIds**: readonly `number`[]
+
+---
+
+### SearchProductsInput
+
+> **SearchProductsInput** = [`PortalPageInput`](#portalpageinput) & `object`
+
+#### Type Declaration
+
+##### query
+
+> `readonly` **query**: `string`
+
+---
+
+### ToggleContentFavoriteInput
+
+> **ToggleContentFavoriteInput** = `object`
+
+#### Properties
+
+##### favoriteableId
+
+> `readonly` **favoriteableId**: `number`
+
+##### favoriteableType
+
+> `readonly` **favoriteableType**: `ContentFavoriteType`
+
+---
+
+### UpdateContentMediaInput
+
+> **UpdateContentMediaInput** = `object`
+
+#### Properties
+
+##### contentFormat?
+
+> `readonly` `optional` **contentFormat?**: `"image"` \| `"video"` \| `"pdf"` \| `"ppt"`
+
+##### cta?
+
+> `readonly` `optional` **cta?**: `object`
+
+###### actionUrl?
+
+> `readonly` `optional` **actionUrl?**: `string` \| `null`
+
+###### buttonColor?
+
+> `readonly` `optional` **buttonColor?**: `string` \| `null`
+
+###### buttonDescription?
+
+> `readonly` `optional` **buttonDescription?**: `string` \| `null`
+
+###### buttonText?
+
+> `readonly` `optional` **buttonText?**: `string` \| `null`
+
+###### enabled?
+
+> `readonly` `optional` **enabled?**: `boolean`
+
+###### type?
+
+> `readonly` `optional` **type?**: `"link"` \| `"cart"`
+
+##### description?
+
+> `readonly` `optional` **description?**: `string` \| `null`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### languageIso?
+
+> `readonly` `optional` **languageIso?**: `string`
+
+##### seo?
+
+> `readonly` `optional` **seo?**: `object`
+
+###### blockCrawler?
+
+> `readonly` `optional` **blockCrawler?**: `boolean`
+
+###### description?
+
+> `readonly` `optional` **description?**: `string` \| `null`
+
+###### imageUrl?
+
+> `readonly` `optional` **imageUrl?**: `string` \| `null`
+
+###### title?
+
+> `readonly` `optional` **title?**: `string` \| `null`
+
+##### status?
+
+> `readonly` `optional` **status?**: `"active"` \| `"draft"`
+
+##### thumbnailUrl?
+
+> `readonly` `optional` **thumbnailUrl?**: `string` \| `null`
+
+##### title?
+
+> `readonly` `optional` **title?**: `string`
+
+##### url?
+
+> `readonly` `optional` **url?**: `string` \| `null`
+
+---
+
+### UpdateContentPlaylistInput
+
+> **UpdateContentPlaylistInput** = `object`
+
+#### Properties
+
+##### description?
+
+> `readonly` `optional` **description?**: `string` \| `null`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### title?
+
+> `readonly` `optional` **title?**: `string`
+
+---
+
+### UpdateMySiteLinkInput
+
+> **UpdateMySiteLinkInput** = `object`
+
+#### Properties
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### title?
+
+> `readonly` `optional` **title?**: `string`
+
+##### url?
+
+> `readonly` `optional` **url?**: `string`
+
+---
+
+### UpdateMySiteProfileInput
+
+> **UpdateMySiteProfileInput** = `object`
+
+#### Properties
+
+##### avatarUrl?
+
+> `readonly` `optional` **avatarUrl?**: `string`
+
+##### bio?
+
+> `readonly` `optional` **bio?**: `string`
+
+##### displayName?
+
+> `readonly` `optional` **displayName?**: `string`
+
+---
+
+### UpdateMySiteSettingsInput
+
+> **UpdateMySiteSettingsInput** = `object`
+
+#### Properties
+
+##### slug?
+
+> `readonly` `optional` **slug?**: `string`
+
+##### themeId?
+
+> `readonly` `optional` **themeId?**: `number`
+
+---
+
+### UpdateUserAccountInput
+
+> **UpdateUserAccountInput** = `object`
+
+#### Properties
+
+##### avatarUrl?
+
+> `readonly` `optional` **avatarUrl?**: `string`
+
+##### bio?
+
+> `readonly` `optional` **bio?**: `string`
+
+##### firstName?
+
+> `readonly` `optional` **firstName?**: `string`
+
+##### languageIso?
+
+> `readonly` `optional` **languageIso?**: `string`
+
+##### lastName?
+
+> `readonly` `optional` **lastName?**: `string`
+
+##### socialLinks?
+
+> `readonly` `optional` **socialLinks?**: `Readonly`\<`Record`\<`string`, `string`\>\>
+
+---
+
+### UserAccount
+
+> **UserAccount** = `object`
+
+#### Properties
+
+##### avatarUrl
+
+> `readonly` **avatarUrl**: `string` \| `null`
+
+##### bio
+
+> `readonly` **bio**: `string` \| `null`
+
+##### defaultCountryIso
+
+> `readonly` **defaultCountryIso**: `string` \| `null`
+
+##### displayName
+
+> `readonly` **displayName**: `string`
+
+##### email
+
+> `readonly` **email**: `string`
+
+##### firstName
+
+> `readonly` **firstName**: `string`
+
+##### id
+
+> `readonly` **id**: `number`
+
+##### lastName
+
+> `readonly` **lastName**: `string`
+
+##### marketCountryIso
+
+> `readonly` **marketCountryIso**: `string` \| `null`
+
+##### memberType
+
+> `readonly` **memberType**: `"customer"` \| `"rep"`
+
+##### publicId
+
+> `readonly` **publicId**: `string`
+
+##### slug
+
+> `readonly` **slug**: `string`
+
+##### socialLinks
+
+> `readonly` **socialLinks**: `Readonly`\<`Record`\<`string`, `string`\>\> \| `null`
+
+---
+
+### WidgetSourceDefaultProps
+
+> **WidgetSourceDefaultProps** = `Readonly`\<`Record`\<`string`, `JsonValue`\>\>
+
+JSON-serializable default props accepted by a source widget.
+
+---
+
+### WidgetSourcePropertyField
+
+> **WidgetSourcePropertyField** = [`PropertyField`](../../../core/src/registries/property-schema-types.md#propertyfield) _extends_ infer Field ? `Field` _extends_ [`ButtonGroupFieldSchema`](../../../core/src/registries/property-schema-types.md#buttongroupfieldschema) ? `Omit`\<`SerializableValue`\<`Field`\>, `"options"`\> & `object` : `SerializableValue`\<`Field`\> : `never`
+
+A property field that can be included in published widget metadata.
+
+The legacy `color` field is deprecated. Use `colorSelect` so the value is a
+semantic color token supplied by the portal theme.
+
+---
+
+### WidgetSourceResizable
+
+> **WidgetSourceResizable** = `boolean` \| `"horizontal"` \| `"vertical"` \| `"both"` \| \{ `horizontal?`: `boolean`; `minHeight?`: `number`; `minWidth?`: `number`; `vertical?`: `boolean`; \}
+
+Builder resize behavior declared by a source widget.
+
+## Variables
+
+### addContentMediaProduct
+
+> `const` **addContentMediaProduct**: [`PortalFunction`](#portalfunction-1)\<[`PortalMediaProduct`](#portalmediaproduct), [`AddContentMediaProductInput`](#addcontentmediaproductinput)\>
+
+---
+
+### addContentPlaylistItem
+
+> `const` **addContentPlaylistItem**: [`PortalFunction`](#portalfunction-1)\<[`PortalPlaylistItem`](#portalplaylistitem), [`AddContentPlaylistItemInput`](#addcontentplaylistiteminput)\>
+
+---
+
+### addMySiteFavorite
+
+> `const` **addMySiteFavorite**: [`PortalFunction`](#portalfunction-1)\<[`PortalMySiteFavorite`](#portalmysitefavorite), [`AddMySiteFavoriteInput`](#addmysitefavoriteinput)\>
+
+---
+
+### allowAnchorUrl
+
+> `const` **allowAnchorUrl**: [`PortalFunction`](#portalfunction-1)\<`string`, `string`\>
+
+Registers one exact absolute HTTP(S) URL for use by an anchor in this mount.
+
+---
+
+### buildPortalHref
+
+> `const` **buildPortalHref**: [`PortalFunction`](#portalfunction-1)\<`string`, [`PortalNavigationTarget`](#portalnavigationtarget)\>
+
+---
+
+### createContentMedia
+
+> `const` **createContentMedia**: [`PortalFunction`](#portalfunction-1)\<[`PortalMedia`](#portalmedia), [`CreateContentMediaInput`](#createcontentmediainput)\>
+
+---
+
+### createContentPlaylist
+
+> `const` **createContentPlaylist**: [`PortalFunction`](#portalfunction-1)\<[`PortalPlaylist`](#portalplaylist), [`CreateContentPlaylistInput`](#createcontentplaylistinput)\>
+
+---
+
+### createContentShare
+
+> `const` **createContentShare**: [`PortalFunction`](#portalfunction-1)\<[`PortalShare`](#portalshare), [`CreateContentShareInput`](#createcontentshareinput)\>
+
+---
+
+### createDamAsset
+
+> `const` **createDamAsset**: [`PortalFunction`](#portalfunction-1)\<[`PortalDamAsset`](#portaldamasset), [`CreateDamAssetInput`](#createdamassetinput)\>
+
+---
+
+### createDamAssetPath
+
+> `const` **createDamAssetPath**: [`PortalFunction`](#portalfunction-1)\<[`PortalDamAssetPath`](#portaldamassetpath), [`CreateDamAssetPathInput`](#createdamassetpathinput)\>
+
+---
+
+### createMySiteLink
+
+> `const` **createMySiteLink**: [`PortalFunction`](#portalfunction-1)\<[`PortalMySiteLink`](#portalmysitelink), [`CreateMySiteLinkInput`](#createmysitelinkinput)\>
+
+---
+
+### createTodo
+
+> `const` **createTodo**: [`PortalFunction`](#portalfunction-1)\<[`PortalTodo`](#portaltodo), [`CreateTodoInput`](#createtodoinput)\>
+
+---
+
+### deleteContentMedia
+
+> `const` **deleteContentMedia**: [`PortalFunction`](#portalfunction-1)\<`null`, [`DeleteContentMediaInput`](#deletecontentmediainput)\>
+
+---
+
+### deleteContentPlaylist
+
+> `const` **deleteContentPlaylist**: [`PortalFunction`](#portalfunction-1)\<`null`, [`DeleteContentPlaylistInput`](#deletecontentplaylistinput)\>
+
+---
+
+### deleteDamAsset
+
+> `const` **deleteDamAsset**: [`PortalFunction`](#portalfunction-1)\<`null`, [`MutateDamAssetInput`](#mutatedamassetinput)\>
+
+---
+
+### deleteMySiteFavorite
+
+> `const` **deleteMySiteFavorite**: [`PortalFunction`](#portalfunction-1)\<`null`, [`DeleteMySiteFavoriteInput`](#deletemysitefavoriteinput)\>
+
+---
+
+### deleteMySiteLink
+
+> `const` **deleteMySiteLink**: [`PortalFunction`](#portalfunction-1)\<`null`, [`DeleteMySiteLinkInput`](#deletemysitelinkinput)\>
+
+---
+
+### discardDamAsset
+
+> `const` **discardDamAsset**: [`PortalFunction`](#portalfunction-1)\<[`PortalDamAsset`](#portaldamasset), [`MutateDamAssetInput`](#mutatedamassetinput)\>
+
+---
+
+### exitFullscreen
+
+> `const` **exitFullscreen**: [`PortalFunction`](#portalfunction-1)\<`void`\>
+
+---
+
+### getAddressFields
+
+> `const` **getAddressFields**: [`PortalFunction`](#portalfunction-1)\<[`PortalAddressFields`](#portaladdressfields), [`GetAddressFieldsInput`](#getaddressfieldsinput)\>
+
+---
+
+### getContentMedia
+
+> `const` **getContentMedia**: [`PortalFunction`](#portalfunction-1)\<[`PortalMedia`](#portalmedia), [`GetContentMediaInput`](#getcontentmediainput)\>
+
+---
+
+### getEnrollmentPack
+
+> `const` **getEnrollmentPack**: [`PortalFunction`](#portalfunction-1)\<[`PortalEnrollmentPack`](#portalenrollmentpack), [`GetEnrollmentPackInput`](#getenrollmentpackinput)\>
+
+---
+
+### getFullscreenState
+
+> `const` **getFullscreenState**: [`PortalFunction`](#portalfunction-1)\<[`FullscreenState`](#fullscreenstate)\>
+
+---
+
+### getMemberAccess
+
+> `const` **getMemberAccess**: [`PortalFunction`](#portalfunction-1)\<[`PortalMemberAccess`](#portalmemberaccess)\>
+
+---
+
+### getMySiteProfile
+
+> `const` **getMySiteProfile**: [`PortalFunction`](#portalfunction-1)\<[`PortalMySiteProfile`](#portalmysiteprofile)\>
+
+---
+
+### getNavigationState
+
+> `const` **getNavigationState**: [`PortalFunction`](#portalfunction-1)\<[`PortalNavigationState`](#portalnavigationstate)\>
+
+---
+
+### getPage
+
+> `const` **getPage**: [`PortalFunction`](#portalfunction-1)\<[`PortalPageDetail`](#portalpagedetail), [`GetPageInput`](#getpageinput)\>
+
+---
+
+### getPlaylist
+
+> `const` **getPlaylist**: [`PortalFunction`](#portalfunction-1)\<[`PortalPlaylist`](#portalplaylist), [`GetPlaylistInput`](#getplaylistinput)\>
+
+---
+
+### getPointsLedger
+
+> `const` **getPointsLedger**: [`PortalFunction`](#portalfunction-1)\<[`PortalPointsLedger`](#portalpointsledger)\>
+
+---
+
+### getPortalApp
+
+> `const` **getPortalApp**: [`PortalFunction`](#portalfunction-1)\<[`PortalAppSummary`](#portalappsummary)\>
+
+---
+
+### getPortalProfile
+
+> `const` **getPortalProfile**: [`PortalFunction`](#portalfunction-1)\<[`PortalProfileSummary`](#portalprofilesummary)\>
+
+---
+
+### getProduct
+
+> `const` **getProduct**: [`PortalFunction`](#portalfunction-1)\<[`PortalProduct`](#portalproduct), [`GetProductInput`](#getproductinput)\>
+
+---
+
+### getStore
+
+> `const` **getStore**: [`PortalFunction`](#portalfunction-1)\<[`PortalStore`](#portalstore)\>
+
+---
+
+### getUserAccount
+
+> `const` **getUserAccount**: [`PortalFunction`](#portalfunction-1)\<[`UserAccount`](#useraccount)\>
+
+---
+
+### listCalendarEvents
+
+> `const` **listCalendarEvents**: [`PortalFunction`](#portalfunction-1)\<readonly [`PortalCalendarEvent`](#portalcalendarevent)[]\>
+
+---
+
+### listContentMedia
+
+> `const` **listContentMedia**: [`PortalFunction`](#portalfunction-1)\<[`PortalPage`](#portalpage)\<[`PortalMedia`](#portalmedia)\>, [`ListContentMediaInput`](#listcontentmediainput)\>
+
+---
+
+### listContentMediaProducts
+
+> `const` **listContentMediaProducts**: [`PortalFunction`](#portalfunction-1)\<[`PortalPage`](#portalpage)\<[`PortalMediaProduct`](#portalmediaproduct)\>, [`ListContentMediaProductsInput`](#listcontentmediaproductsinput)\>
+
+---
+
+### listContentMetrics
+
+> `const` **listContentMetrics**: [`PortalFunction`](#portalfunction-1)\<readonly [`PortalMetric`](#portalmetric)[], [`ListContentMetricsInput`](#listcontentmetricsinput)\>
+
+---
+
+### listCountries
+
+> `const` **listCountries**: [`PortalFunction`](#portalfunction-1)\<[`PortalPage`](#portalpage)\<[`PortalCountry`](#portalcountry)\>, [`ListCountriesInput`](#listcountriesinput)\>
+
+---
+
+### listDamAssetPaths
+
+> `const` **listDamAssetPaths**: [`PortalFunction`](#portalfunction-1)\<[`PortalPage`](#portalpage)\<[`PortalDamAssetPath`](#portaldamassetpath)\>, [`ListDamAssetPathsInput`](#listdamassetpathsinput)\>
+
+---
+
+### listDamAssets
+
+> `const` **listDamAssets**: [`PortalFunction`](#portalfunction-1)\<[`PortalPage`](#portalpage)\<[`PortalDamAsset`](#portaldamasset)\>, [`PortalPageInput`](#portalpageinput)\>
+
+---
+
+### listEnrollmentPacks
+
+> `const` **listEnrollmentPacks**: [`PortalFunction`](#portalfunction-1)\<[`PortalPage`](#portalpage)\<[`PortalEnrollmentPack`](#portalenrollmentpack)\>, [`PortalPageInput`](#portalpageinput)\>
+
+---
+
+### listLanguages
+
+> `const` **listLanguages**: [`PortalFunction`](#portalfunction-1)\<[`PortalPage`](#portalpage)\<[`PortalLanguage`](#portallanguage)\>, [`PortalPageInput`](#portalpageinput)\>
+
+---
+
+### listMySiteFavorites
+
+> `const` **listMySiteFavorites**: [`PortalFunction`](#portalfunction-1)\<readonly [`PortalMySiteFavorite`](#portalmysitefavorite)[]\>
+
+---
+
+### listMySiteLinks
+
+> `const` **listMySiteLinks**: [`PortalFunction`](#portalfunction-1)\<readonly [`PortalMySiteLink`](#portalmysitelink)[]\>
+
+---
+
+### listMySiteThemes
+
+> `const` **listMySiteThemes**: [`PortalFunction`](#portalfunction-1)\<readonly [`PortalMySiteTheme`](#portalmysitetheme)[]\>
+
+---
+
+### listPages
+
+> `const` **listPages**: [`PortalFunction`](#portalfunction-1)\<[`PortalPage`](#portalpage)\<[`PortalPageContent`](#portalpagecontent)\>, [`ListPagesInput`](#listpagesinput)\>
+
+---
+
+### listPlaylistItems
+
+> `const` **listPlaylistItems**: [`PortalFunction`](#portalfunction-1)\<[`PortalPage`](#portalpage)\<[`PortalPlaylistItem`](#portalplaylistitem)\>, [`ListPlaylistItemsInput`](#listplaylistitemsinput)\>
+
+---
+
+### listPlaylists
+
+> `const` **listPlaylists**: [`PortalFunction`](#portalfunction-1)\<[`PortalPage`](#portalpage)\<[`PortalPlaylist`](#portalplaylist)\>, [`ListPlaylistsInput`](#listplaylistsinput)\>
+
+---
+
+### listProductMedia
+
+> `const` **listProductMedia**: [`PortalFunction`](#portalfunction-1)\<readonly [`PortalProductMedia`](#portalproductmedia)[], [`ListProductMediaInput`](#listproductmediainput)\>
+
+---
+
+### listProductMetrics
+
+> `const` **listProductMetrics**: [`PortalFunction`](#portalfunction-1)\<readonly [`PortalMetric`](#portalmetric)[], [`ListProductMetricsInput`](#listproductmetricsinput)\>
+
+---
+
+### listProducts
+
+> `const` **listProducts**: [`PortalFunction`](#portalfunction-1)\<[`PortalPage`](#portalpage)\<[`PortalProduct`](#portalproduct)\>, [`ListProductsInput`](#listproductsinput)\>
+
+---
+
+### listShares
+
+> `const` **listShares**: [`PortalFunction`](#portalfunction-1)\<[`PortalPage`](#portalpage)\<[`PortalShare`](#portalshare)\>, [`PortalPageInput`](#portalpageinput)\>
+
+---
+
+### listTodos
+
+> `const` **listTodos**: [`PortalFunction`](#portalfunction-1)\<readonly [`PortalTodoSummary`](#portaltodosummary)[], [`ListTodosInput`](#listtodosinput)\>
+
+---
+
+### navigateTo
+
+> `const` **navigateTo**: [`PortalFunction`](#portalfunction-1)\<`void`, [`PortalNavigationTarget`](#portalnavigationtarget)\>
+
+---
+
+### networkAccess
+
+> `const` **networkAccess**: [`DeclarativeCapabilityUse`](#declarativecapabilityuse)
+
+---
+
+### removeContentMediaProduct
+
+> `const` **removeContentMediaProduct**: [`PortalFunction`](#portalfunction-1)\<`null`, [`RemoveContentMediaProductInput`](#removecontentmediaproductinput)\>
+
+---
+
+### removeContentPlaylistItem
+
+> `const` **removeContentPlaylistItem**: [`PortalFunction`](#portalfunction-1)\<`null`, [`RemoveContentPlaylistItemInput`](#removecontentplaylistiteminput)\>
+
+---
+
+### reorderContentPlaylistItems
+
+> `const` **reorderContentPlaylistItems**: [`PortalFunction`](#portalfunction-1)\<`null`, [`ReorderContentPlaylistItemsInput`](#reordercontentplaylistitemsinput)\>
+
+---
+
+### reorderMySiteFavorites
+
+> `const` **reorderMySiteFavorites**: [`PortalFunction`](#portalfunction-1)\<readonly [`PortalMySiteFavorite`](#portalmysitefavorite)[], [`ReorderMySiteFavoritesInput`](#reordermysitefavoritesinput)\>
+
+---
+
+### reorderMySiteLinks
+
+> `const` **reorderMySiteLinks**: [`PortalFunction`](#portalfunction-1)\<readonly [`PortalMySiteLink`](#portalmysitelink)[], [`ReorderMySiteLinksInput`](#reordermysitelinksinput)\>
+
+---
+
+### requestFullscreen
+
+> `const` **requestFullscreen**: [`PortalFunction`](#portalfunction-1)\<`void`\>
+
+---
+
+### searchProducts
+
+> `const` **searchProducts**: [`PortalFunction`](#portalfunction-1)\<[`PortalPage`](#portalpage)\<[`PortalProduct`](#portalproduct)\>, [`SearchProductsInput`](#searchproductsinput)\>
+
+---
+
+### toggleContentFavorite
+
+> `const` **toggleContentFavorite**: [`PortalFunction`](#portalfunction-1)\<[`PortalContentFavoriteState`](#portalcontentfavoritestate), [`ToggleContentFavoriteInput`](#togglecontentfavoriteinput)\>
+
+---
+
+### updateContentMedia
+
+> `const` **updateContentMedia**: [`PortalFunction`](#portalfunction-1)\<[`PortalMedia`](#portalmedia), [`UpdateContentMediaInput`](#updatecontentmediainput)\>
+
+---
+
+### updateContentPlaylist
+
+> `const` **updateContentPlaylist**: [`PortalFunction`](#portalfunction-1)\<[`PortalPlaylist`](#portalplaylist), [`UpdateContentPlaylistInput`](#updatecontentplaylistinput)\>
+
+---
+
+### updateMySiteLink
+
+> `const` **updateMySiteLink**: [`PortalFunction`](#portalfunction-1)\<[`PortalMySiteLink`](#portalmysitelink), [`UpdateMySiteLinkInput`](#updatemysitelinkinput)\>
+
+---
+
+### updateMySiteProfile
+
+> `const` **updateMySiteProfile**: [`PortalFunction`](#portalfunction-1)\<[`PortalMySiteProfile`](#portalmysiteprofile), [`UpdateMySiteProfileInput`](#updatemysiteprofileinput)\>
+
+---
+
+### updateMySiteSettings
+
+> `const` **updateMySiteSettings**: [`PortalFunction`](#portalfunction-1)\<`null`, [`UpdateMySiteSettingsInput`](#updatemysitesettingsinput)\>
+
+---
+
+### updateUserAccount
+
+> `const` **updateUserAccount**: [`PortalFunction`](#portalfunction-1)\<[`UserAccount`](#useraccount), [`UpdateUserAccountInput`](#updateuseraccountinput)\>
+
+## Functions
+
+### definePortalFunction()
+
+> **definePortalFunction**\<`Output`, `Input`\>(`definition`, ...`_contractErrors`): [`PortalFunction`](#portalfunction-1)\<`Output`, `Input`\>
+
+#### Type Parameters
+
+##### Output
+
+`Output`
+
+##### Input
+
+`Input` = `void`
+
+#### Parameters
+
+##### definition
+
+[`PortalFunctionDefinition`](#portalfunctiondefinition)
+
+##### \_contractErrors
+
+...`PortalFunctionContractErrors`\<`Output`, `Input`\>
+
+#### Returns
+
+[`PortalFunction`](#portalfunction-1)\<`Output`, `Input`\>
+
+---
+
+### defineWidget()
+
+> **defineWidget**\<`Name`, `Props`\>(`options`): [`SourceWidget`](#sourcewidget)\<`Name`, `Props`\>
+
+Defines one widget and derives its enforced capability declarations.
+
+#### Type Parameters
+
+##### Name
+
+`Name` _extends_ `string`
+
+##### Props
+
+`Props` = `Readonly`\<`Record`\<`string`, `JsonValue`\>\>
+
+#### Parameters
+
+##### options
+
+[`DefineWidgetOptions`](#definewidgetoptions)\<`Name`, `Props`\>
+
+Component, builder metadata, defaults, property schema, and typed capability uses.
+
+#### Returns
+
+[`SourceWidget`](#sourcewidget)\<`Name`, `Props`\>
+
+The normalized widget used by [defineWidgetPackage](#definewidgetpackage).
+
+#### Throws
+
+If `uses` contains an invalid entry or conflicting capability versions.
+
+---
+
+### defineWidgetPackage()
+
+> **defineWidgetPackage**\<`Scope`, `StableId`\>(`options`): [`SourceWidgetPackage`](#sourcewidgetpackage)\<`Scope`, `StableId`\>
+
+Defines a company- or droplet-owned widget package.
+
+#### Type Parameters
+
+##### Scope
+
+`Scope` _extends_ `string`
+
+##### StableId
+
+`StableId` _extends_ `string`
+
+#### Parameters
+
+##### options
+
+[`DefineWidgetPackageOptions`](#definewidgetpackageoptions)\<`Scope`, `StableId`\>
+
+Package identity, SemVer version, widgets, and optional runtime stylesheets.
+
+#### Returns
+
+[`SourceWidgetPackage`](#sourcewidgetpackage)\<`Scope`, `StableId`\>
+
+A canonical source package descriptor. Build and dev replace runtime artifact URLs.
+
+#### Throws
+
+If a company package omits `packageStableId`.
+
+---
+
+### FluidSpacerWidget()
+
+> **FluidSpacerWidget**(`props`): `ReactElement`
+
+#### Parameters
+
+##### props
+
+[`FluidSpacerWidgetProps`](#fluidspacerwidgetprops)
+
+#### Returns
+
+`ReactElement`
+
+---
+
+### implementPortalFunction()
+
+> **implementPortalFunction**\<`Output`, `Input`\>(`portalFunction`, `handler`): [`PortalFunctionImplementation`](#portalfunctionimplementation)
+
+#### Type Parameters
+
+##### Output
+
+`Output`
+
+##### Input
+
+`Input` = `void`
+
+#### Parameters
+
+##### portalFunction
+
+[`PortalFunction`](#portalfunction-1)\<`Output`, `Input`\>
+
+##### handler
+
+[`PortalFunctionHandler`](#portalfunctionhandler)\<`NoInfer`\<`Output`\>, `NoInfer`\<`Input`\>\>
+
+#### Returns
+
+[`PortalFunctionImplementation`](#portalfunctionimplementation)
+
+---
+
+### prepareRemoteDomWidgetWorker()
+
+> **prepareRemoteDomWidgetWorker**(): `void`
+
+#### Returns
+
+`void`
+
+---
+
+### SearchSort()
+
+> **SearchSort**(`__namedParameters`): `ReactElement`
+
+#### Parameters
+
+##### \_\_namedParameters
+
+[`SearchSortProps`](#searchsortprops)
+
+#### Returns
+
+`ReactElement`
+
+---
+
+### startWidgetPackage()
+
+> **startWidgetPackage**(`widgetPackage`): [`RemoteDomWidgetWorkerController`](#remotedomwidgetworkercontroller)
+
+Starts one Remote DOM worker containing every widget in the source package.
+
+#### Parameters
+
+##### widgetPackage
+
+[`SourceWidgetPackage`](#sourcewidgetpackage)\<`string`, `string`\> \| [`StartWidgetPackageOptions`](#startwidgetpackageoptions)
+
+A source package or generated runtime widget list.
+
+#### Returns
+
+[`RemoteDomWidgetWorkerController`](#remotedomwidgetworkercontroller)
+
+A controller that owns the worker connection and registered widget definitions.