@fluid-app/portal-sdk 0.1.474 → 0.1.476

package/dist/widgets/worker.d.cts

@@ -1,14 +1,33 @@
-import { a as PortalFunctionErrorCode, at as JsonValue, c as PortalFunctionJsonValue, ct as WidgetSourcePropertyField, i as PortalFunctionError, l as definePortalFunction, lt as WidgetSourcePropertySchema, n as PortalFunction, o as PortalFunctionHandler, r as PortalFunctionDefinition, s as PortalFunctionImplementation, t as AnyPortalFunction, u as implementPortalFunction } from "../portal-function-DYWFgeRx.cjs";
+import { a as PortalFunctionErrorCode, at as JsonValue, c as PortalFunctionJsonValue, ct as WidgetSourcePropertyField, i as PortalFunctionError, l as definePortalFunction, lt as WidgetSourcePropertySchema, n as PortalFunction, o as PortalFunctionHandler, r as PortalFunctionDefinition, s as PortalFunctionImplementation, t as AnyPortalFunction, u as implementPortalFunction } from "../portal-function-DUOB0Ykd.cjs";
 import { ComponentType, ReactElement } from "react";
 import { RemoteDomWidgetWorkerController, prepareRemoteDomWidgetWorker } from "@fluid-app/widget-runtime/worker";
 
 //#region src/widgets/remote/worker/capability-use.d.ts
 declare const DECLARATIVE_CAPABILITY_USE: unique symbol;
+/** A capability declaration that does not expose individual Portal functions. */
 interface DeclarativeCapabilityUse {
+  /** Internal marker used to validate `uses` entries. */
   readonly [DECLARATIVE_CAPABILITY_USE]: true;
+  /** Stable capability name. */
   readonly name: string;
+  /** Required capability contract version. */
   readonly version: string;
 }
+/**
+* Declares that a widget can make direct network requests.
+* Add this marker to the widget's `uses` list. The portal host can require user
+* consent before mounting a package that declares network access. This marker
+* does not bypass browser CORS, Content Security Policy, or host network policy.
+*
+* @example
+* ```ts
+* const widget = defineWidget({
+*   name: "remote-data",
+*   component: RemoteData,
+*   uses: [networkAccess],
+* });
+* ```
+*/
 declare const networkAccess: DeclarativeCapabilityUse;
 //#endregion
 //#region src/widgets/remote/worker/widget-package.d.ts
@@ -18,11 +37,12 @@ declare const SOURCE_WIDGET_PACKAGE_MARKER = "__fluidSourceWidgetPackage";
 type WidgetSourceDefaultProps = Readonly<Record<string, JsonValue>>;
 /** Builder resize behavior declared by a source widget. */
 type WidgetSourceResizable = boolean | "horizontal" | "vertical" | "both" | {
-  readonly horizontal?: boolean;
-  readonly vertical?: boolean;
-  readonly minWidth?: number;
+  /** Allow horizontal resizing. */readonly horizontal?: boolean; /** Allow vertical resizing. */
+  readonly vertical?: boolean; /** Minimum width in builder layout units. */
+  readonly minWidth?: number; /** Minimum height in builder layout units. */
   readonly minHeight?: number;
 };
+/** Versioned host capability required by a widget. */
 interface WidgetSourceCapabilityDeclaration {
   /** Stable capability name enforced by the worker and host. */
   readonly name: string;
@@ -81,10 +101,10 @@ interface DefineWidgetPackageBase<Scope extends string = string> {
 }
 /** Authoring options accepted by {@link defineWidgetPackage}. */
 type DefineWidgetPackageOptions<Scope extends string = string, StableId extends string = string> = DefineWidgetPackageBase<Scope> & ({
-  readonly packageType?: "company";
+  /** Company-owned package. This is the default package type. */readonly packageType?: "company"; /** Stable company owner identifier. */
   readonly packageStableId: StableId;
 } | {
-  readonly packageType: "droplet";
+  /** Standalone package owned by a Droplet. */readonly packageType: "droplet"; /** Stable Droplet identifier; the CLI can inject it during publication. */
   readonly packageStableId?: StableId;
 });
 /** Canonical source package returned by {@link defineWidgetPackage}. */
@@ -130,6 +150,18 @@ interface StartWidgetPackageOptions {
 * @param options - Component, builder metadata, defaults, property schema, and typed capability uses.
 * @returns The normalized widget used by {@link defineWidgetPackage}.
 * @throws If `uses` contains an invalid entry or conflicting capability versions.
+* @remarks Call during worker module initialization. Default props and property values must cross the worker boundary as JSON values. Every Portal function the component calls must appear in `uses`.
+*
+* @example
+* ```tsx
+* const greeting = defineWidget({
+*   name: "greeting",
+*   displayName: "Greeting",
+*   component: Greeting,
+*   defaultProps: { message: "Hello" },
+*   uses: [getUserAccount],
+* });
+* ```
 */
 declare function defineWidget<const Name extends string, Props = WidgetSourceDefaultProps>(options: DefineWidgetOptions<Name, Props>): SourceWidget<Name, Props>;
 /**
@@ -138,6 +170,17 @@ declare function defineWidget<const Name extends string, Props = WidgetSourceDef
 * @param options - Package identity, SemVer version, widgets, and optional runtime stylesheets.
 * @returns A canonical source package descriptor. Build and dev replace runtime artifact URLs.
 * @throws If a company package omits `packageStableId`.
+* @remarks Define one package during worker module initialization. Company packages require a stable company identifier; Droplet publication can inject its stable identifier through the CLI.
+*
+* @example
+* ```ts
+* const widgetPackage = defineWidgetPackage({
+*   scope: "acme",
+*   packageStableId: "company-public-id",
+*   version: "1.0.0",
+*   widgets: [greeting],
+* });
+* ```
 */
 declare function defineWidgetPackage<const Scope extends string, const StableId extends string>(options: DefineWidgetPackageOptions<Scope, StableId>): SourceWidgetPackage<Scope, StableId>;
 /**
@@ -145,439 +188,902 @@ declare function defineWidgetPackage<const Scope extends string, const StableId
 *
 * @param widgetPackage - A source package or generated runtime widget list.
 * @returns A controller that owns the worker connection and registered widget definitions.
+* @throws If generated widgets cannot be matched to an unambiguous source `uses` declaration.
+* @remarks Call once from the worker entry after all widgets and the package are defined. The returned controller owns the active Remote DOM connection.
+*
+* @example
+* ```ts
+* startWidgetPackage(widgetPackage);
+* ```
 */
 declare function startWidgetPackage(widgetPackage: SourceWidgetPackage | StartWidgetPackageOptions): RemoteDomWidgetWorkerController;
 //#endregion
 //#region src/widgets/remote/contract/capabilities/built-in.d.ts
+/** Identifier used by portal resources. IDs can be numeric or string-backed. */
 type PortalEntityId = string | number;
+/** Signed-in portal account details available to a widget. */
 type UserAccount = {
-  readonly id: number;
-  readonly publicId: string;
-  readonly memberType: "customer" | "rep";
-  readonly firstName: string;
-  readonly lastName: string;
-  readonly displayName: string;
-  readonly email: string;
-  readonly bio: string | null;
-  readonly avatarUrl: string | null;
-  readonly slug: string;
-  readonly socialLinks: Readonly<Record<string, string>> | null;
-  readonly defaultCountryIso: string | null;
+  /** Numeric account identifier. */readonly id: number; /** Public account identifier. */
+  readonly publicId: string; /** Customer or representative account role. */
+  readonly memberType: "customer" | "rep"; /** Given name. */
+  readonly firstName: string; /** Family name. */
+  readonly lastName: string; /** Name intended for display. */
+  readonly displayName: string; /** Account email address. */
+  readonly email: string; /** Profile biography, if set. */
+  readonly bio: string | null; /** Profile avatar URL, if set. */
+  readonly avatarUrl: string | null; /** Public account slug. */
+  readonly slug: string; /** Social network names mapped to profile URLs. */
+  readonly socialLinks: Readonly<Record<string, string>> | null; /** Default ISO country code, if set. */
+  readonly defaultCountryIso: string | null; /** Active market ISO country code, if set. */
   readonly marketCountryIso: string | null;
 };
+/** Store identity, branding, app links, and reward-point labels. */
 type PortalStore = {
-  readonly id: number;
-  readonly name: string;
-  readonly subdomain: string;
-  readonly logoUrl: string | null;
-  readonly iconUrl: string | null;
-  readonly appStoreUrl: string | null;
-  readonly playStoreUrl: string | null;
-  readonly bundleSubscriptionsEnabled: boolean;
-  readonly rewardPointsLabelSingular: string;
+  /** Numeric store identifier. */readonly id: number; /** Store name. */
+  readonly name: string; /** Store subdomain. */
+  readonly subdomain: string; /** Store logo URL, if configured. */
+  readonly logoUrl: string | null; /** Store icon URL, if configured. */
+  readonly iconUrl: string | null; /** Apple App Store URL, if configured. */
+  readonly appStoreUrl: string | null; /** Google Play Store URL, if configured. */
+  readonly playStoreUrl: string | null; /** Whether bundle subscriptions are enabled. */
+  readonly bundleSubscriptionsEnabled: boolean; /** Singular reward-points label. */
+  readonly rewardPointsLabelSingular: string; /** Plural reward-points label. */
   readonly rewardPointsLabelPlural: string;
 };
+/** Common identity fields for resources in a portal definition summary. */
 type PortalNamedEntitySummary = {
-  readonly id: PortalEntityId | null;
-  readonly definitionId: PortalEntityId | null;
-  readonly name: string | null;
+  /** Persisted entity identifier, if available. */readonly id: PortalEntityId | null; /** Definition resource identifier, if available. */
+  readonly definitionId: PortalEntityId | null; /** Entity name, if available. */
+  readonly name: string | null; /** Entity route slug, if available. */
   readonly slug: string | null;
 };
+/** Screen identity and component count returned with a portal summary. */
 type PortalScreenSummary = PortalNamedEntitySummary & {
-  readonly componentCount: number;
+  /** Number of component nodes on the screen. */readonly componentCount: number;
 };
+/** Navigation identity and aggregate counts returned with a portal summary. */
 type PortalNavigationSummary = {
-  readonly id: PortalEntityId | null;
-  readonly definitionId: PortalEntityId | null;
-  readonly name: string | null;
-  readonly navigationItemCount: number;
+  /** Persisted navigation identifier, if available. */readonly id: PortalEntityId | null; /** Definition resource identifier, if available. */
+  readonly definitionId: PortalEntityId | null; /** Navigation name, if available. */
+  readonly name: string | null; /** Number of navigation items. */
+  readonly navigationItemCount: number; /** Number of linked screens. */
   readonly screenCount: number;
 };
+/** Counted, immutable collection used by portal summary responses. */
 type PortalSummaryCollection<Item> = {
-  readonly count: number;
+  /** Total item count. */readonly count: number; /** Summary items. */
   readonly items: readonly Item[];
 };
+/** Active profile, theme, and navigation summary for the current portal. */
 type PortalProfileSummary = {
-  readonly name: string | null;
-  readonly definitionId: PortalEntityId | null;
-  readonly activeThemeId: string | null;
-  readonly themes: PortalSummaryCollection<PortalNamedEntitySummary>;
-  readonly navigation: PortalNavigationSummary | null;
+  /** Profile name, if available. */readonly name: string | null; /** Definition resource identifier, if available. */
+  readonly definitionId: PortalEntityId | null; /** Active theme identifier, if available. */
+  readonly activeThemeId: string | null; /** Themes available to the profile. */
+  readonly themes: PortalSummaryCollection<PortalNamedEntitySummary>; /** Primary navigation summary, if configured. */
+  readonly navigation: PortalNavigationSummary | null; /** Mobile navigation summary, if configured. */
   readonly mobileNavigation: PortalNavigationSummary | null;
 };
+/** Published portal definition, profile, and screen summary. */
 type PortalAppSummary = {
-  readonly definitionId: PortalEntityId | null;
-  readonly publishedVersion: number | null;
-  readonly profile: PortalProfileSummary | null;
+  /** Current definition identifier, if available. */readonly definitionId: PortalEntityId | null; /** Active immutable version number, if published. */
+  readonly publishedVersion: number | null; /** Active profile summary, if configured. */
+  readonly profile: PortalProfileSummary | null; /** Screen summaries. */
   readonly screens: PortalSummaryCollection<PortalScreenSummary>;
 };
+/** One resolved navigation item, including its nested children. */
 type PortalNavigationItem = {
-  readonly id: number | null;
-  readonly slug: string | null;
-  readonly label: string;
-  readonly icon: string | null;
-  readonly section: string | null;
-  readonly screenId: number | null;
-  readonly position: number | null;
-  readonly parentId: number | null;
-  readonly source: "user" | "system" | "code" | null;
+  /** Persisted navigation-item identifier, if available. */readonly id: number | null; /** Destination slug, if the item targets a screen. */
+  readonly slug: string | null; /** Visible navigation label. */
+  readonly label: string; /** Icon identifier, if configured. */
+  readonly icon: string | null; /** Navigation section, if configured. */
+  readonly section: string | null; /** Target screen identifier, if configured. */
+  readonly screenId: number | null; /** Sort position, if available. */
+  readonly position: number | null; /** Parent item identifier, if nested. */
+  readonly parentId: number | null; /** Origin of the navigation item. */
+  readonly source: "user" | "system" | "code" | null; /** Nested child items. */
   readonly children: readonly PortalNavigationItem[];
 };
+/** Current route and resolved navigation tree for the mounted portal. */
 type PortalNavigationState = {
-  readonly currentSlug: string;
-  readonly previousSlug: string | null;
-  readonly basePath: string;
+  /** Slug of the current route. */readonly currentSlug: string; /** Slug of the previous route, if known. */
+  readonly previousSlug: string | null; /** Portal base path used to build hrefs. */
+  readonly basePath: string; /** Resolved navigation tree. */
   readonly navItems: readonly PortalNavigationItem[];
 };
+/** Route target accepted by {@link buildPortalHref} and {@link navigateTo}. */
 type PortalNavigationTarget = string | {
-  readonly slug: string;
+  /** Portal screen slug. */readonly slug: string;
 } | {
-  readonly href: string;
+  /** Portal-relative or allowed absolute href. */readonly href: string;
 };
+/** Whether fullscreen is supported and active for the current widget mount. */
 type FullscreenState = {
-  readonly fullscreen: boolean;
+  /** Whether the widget is currently fullscreen. */readonly fullscreen: boolean; /** Whether the current host can enter fullscreen. */
   readonly available: boolean;
 };
+/**
+* Gets the signed-in account from the mounted Portal host.
+*
+* @returns The current {@link UserAccount}.
+* @throws {@link PortalFunctionError} when the function is undeclared, unavailable, or fails in the host.
+* @remarks Declare `getUserAccount` in the widget's `uses` list. Call it only after the widget mounts.
+* @example const account = await getUserAccount();
+*/
 declare const getUserAccount: PortalFunction<UserAccount>;
+/**
+* Gets the store that owns the mounted Portal.
+* @returns The current {@link PortalStore}.
+* @throws {@link PortalFunctionError} when undeclared, unavailable, or rejected by the host.
+* @remarks Declare `getStore` in `uses` and call it only after mount.
+* @example const store = await getStore();
+*/
 declare const getStore: PortalFunction<PortalStore>;
+/**
+* Gets the current Portal Definition summary.
+* @returns The current {@link PortalAppSummary}.
+* @throws {@link PortalFunctionError} when undeclared, unavailable, or rejected by the host.
+* @remarks Declare `getPortalApp` in `uses` and call it only after mount.
+* @example const app = await getPortalApp();
+*/
 declare const getPortalApp: PortalFunction<PortalAppSummary>;
+/**
+* Gets the active Portal profile summary.
+* @returns The active {@link PortalProfileSummary}.
+* @throws {@link PortalFunctionError} when undeclared, unavailable, or rejected by the host.
+* @remarks Declare `getPortalProfile` in `uses` and call it only after mount.
+* @example const profile = await getPortalProfile();
+*/
 declare const getPortalProfile: PortalFunction<PortalProfileSummary>;
+/**
+* Gets the current route and resolved navigation tree.
+* @returns The current {@link PortalNavigationState}.
+* @throws {@link PortalFunctionError} when undeclared, unavailable, or rejected by the host.
+* @remarks Declare `getNavigationState` in `uses` and call it only after mount.
+* @example const navigation = await getNavigationState();
+*/
 declare const getNavigationState: PortalFunction<PortalNavigationState>;
+/**
+* Converts a Portal navigation target to an href for the current mount.
+* @param target - Screen slug, href, or shorthand string target.
+* @returns A host-approved href.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `buildPortalHref` in `uses` and call it only after mount.
+* @example const href = await buildPortalHref({ slug: "shop" });
+*/
 declare const buildPortalHref: PortalFunction<string, PortalNavigationTarget>;
+/**
+* Navigates the mounted Portal to a target.
+* @param target - Screen slug, href, or shorthand string target.
+* @returns A promise that resolves after the host accepts the navigation.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `navigateTo` in `uses`. It changes host navigation and requires a mounted widget.
+* @example await navigateTo({ slug: "shop" });
+*/
 declare const navigateTo: PortalFunction<void, PortalNavigationTarget>;
+/**
+* Gets fullscreen availability and state for the current widget mount.
+* @returns The current {@link FullscreenState}.
+* @throws {@link PortalFunctionError} when undeclared, unavailable, or rejected by the host.
+* @remarks Declare `getFullscreenState` in `uses` and call it only after mount.
+* @example const state = await getFullscreenState();
+*/
 declare const getFullscreenState: PortalFunction<FullscreenState>;
+/**
+* Requests fullscreen for the current widget mount.
+* @returns A promise that resolves when the host completes the request.
+* @throws {@link PortalFunctionError} when undeclared, unsupported, unavailable, or rejected by the host.
+* @remarks Declare `requestFullscreen` in `uses`. Browser policy can require a user gesture.
+* @example await requestFullscreen();
+*/
 declare const requestFullscreen: PortalFunction<void>;
+/**
+* Exits fullscreen for the current widget mount.
+* @returns A promise that resolves when the host completes the request.
+* @throws {@link PortalFunctionError} when undeclared, unsupported, unavailable, or rejected by the host.
+* @remarks Declare `exitFullscreen` in `uses` and call it only after mount.
+* @example await exitFullscreen();
+*/
 declare const exitFullscreen: PortalFunction<void>;
-/** Registers one exact absolute HTTP(S) URL for use by an anchor in this mount. */
+/**
+* Allows one exact absolute HTTP(S) URL for an anchor in the current mount.
+* Declare this function in `uses` and call it before rendering or changing the link.
+*
+* @param url - Exact absolute URL to allow.
+* @returns The allowed URL for assignment to the anchor.
+* @throws {@link PortalFunctionError} for invalid or disallowed URLs and host failures.
+* @remarks Declare `allowAnchorUrl` in `uses`. Approval is scoped to the current mount and exact URL.
+*
+* @example
+* ```ts
+* const href = await allowAnchorUrl("https://example.com/help");
+* ```
+*/
 declare const allowAnchorUrl: PortalFunction<string, string>;
 //#endregion
 //#region src/widgets/remote/contract/capabilities/read.d.ts
+/** Cursor pagination accepted by Portal list functions. */
 type PortalPageInput = {
-  readonly cursor?: string;
+  /** Opaque cursor returned as {@link PortalPage.nextCursor} by the previous call. */readonly cursor?: string; /** Maximum number of items to request. The host can enforce a smaller limit. */
   readonly limit?: number;
 };
+/** One page of Portal resources. */
 type PortalPage<Item> = {
-  readonly items: readonly Item[];
+  /** Resources in this page. */readonly items: readonly Item[]; /** Opaque cursor for the next page, or `null` when this is the last page. */
   readonly nextCursor: string | null;
 };
+/** Country and state data available in the current Portal. */
 type PortalCountry = {
-  readonly code: string;
-  readonly name: string;
-  readonly currencyCode: string;
+  /** ISO country code. */readonly code: string; /** Localized country name. */
+  readonly name: string; /** ISO currency code used by the country. */
+  readonly currencyCode: string; /** States or other first-level administrative areas in the country. */
   readonly states: readonly {
-    readonly code: string;
+    /** State or administrative-area code. */readonly code: string; /** Localized state or administrative-area name. */
     readonly name: string;
   }[];
 };
+/** Filters and pagination for {@link listCountries}. */
 type ListCountriesInput = PortalPageInput & {
-  readonly languageIso?: string;
+  /** ISO language code used to localize returned names. */readonly languageIso?: string;
 };
+/** Language available in the current Portal. */
 type PortalLanguage = {
-  readonly code: string;
+  /** ISO language code. */readonly code: string; /** Display name of the language. */
   readonly name: string;
 };
+/** Country and language used by {@link getAddressFields}. */
 type GetAddressFieldsInput = {
-  readonly countryCode: string;
+  /** ISO code of the country whose address form is requested. */readonly countryCode: string; /** ISO language code used to localize field labels. */
   readonly languageIso?: string;
 };
+/** Localized address-field configuration for a country. */
 type PortalAddressFields = {
-  readonly countryCode: string;
-  readonly countryName: string;
+  /** ISO code of the requested country. */readonly countryCode: string; /** Localized country name. */
+  readonly countryName: string; /** Address fields in display order. */
   readonly fields: readonly {
-    readonly field: string;
-    readonly label: string;
+    /** Stable address-field key. */readonly field: string; /** Localized label for the field. */
+    readonly label: string; /** Whether the address requires the field. */
     readonly required: boolean;
   }[];
 };
+/** Image metadata returned with a product or enrollment pack. */
 type PortalImage = {
-  readonly url: string | null;
+  /** Absolute image URL, or `null` when no image URL is available. */readonly url: string | null; /** Alternative text, or `null` when none is available. */
   readonly alt: string | null;
 };
+/** Purchasable variant of a Portal product. */
 type PortalProductVariant = {
-  readonly id: number | null;
-  readonly available: boolean | null;
-  readonly currency: string | null;
-  readonly images: readonly PortalImage[];
-  readonly isMaster: boolean | null;
-  readonly position: number | null;
-  readonly price: string | null;
-  readonly sku: string | null;
-  readonly title: string | null;
-  readonly wholesalePrice: string | null;
-  readonly cv: string | null;
+  /** Variant identifier, or `null` when the source has no identifier. */readonly id: number | null; /** Whether the variant can currently be purchased. */
+  readonly available: boolean | null; /** ISO currency code for monetary fields. */
+  readonly currency: string | null; /** Variant images. */
+  readonly images: readonly PortalImage[]; /** Whether this is the product's master variant. */
+  readonly isMaster: boolean | null; /** Variant display position. */
+  readonly position: number | null; /** Retail price serialized as a decimal string. */
+  readonly price: string | null; /** Stock-keeping unit. */
+  readonly sku: string | null; /** Variant display title. */
+  readonly title: string | null; /** Wholesale price serialized as a decimal string. */
+  readonly wholesalePrice: string | null; /** Commission volume serialized as a decimal string. */
+  readonly cv: string | null; /** Qualifying volume serialized as a decimal string. */
   readonly qv: string | null;
 };
+/** Product data available to a widget. */
 type PortalProduct = {
-  readonly id: number | null;
-  readonly name: string | null;
-  readonly slug: string | null;
-  readonly description: string | null;
-  readonly price: string | null;
-  readonly wholesalePrice: string | null;
-  readonly currency: string | null;
-  readonly status: string | null;
-  readonly images: readonly PortalImage[];
-  readonly variants: readonly PortalProductVariant[];
-  readonly mediaCount: number | null;
-  readonly createdAt: string | null;
-  readonly isBundle: boolean;
+  /** Product identifier, or `null` when the source has no identifier. */readonly id: number | null; /** Product display name. */
+  readonly name: string | null; /** URL-safe product slug. */
+  readonly slug: string | null; /** Product description. */
+  readonly description: string | null; /** Retail price serialized as a decimal string. */
+  readonly price: string | null; /** Wholesale price serialized as a decimal string. */
+  readonly wholesalePrice: string | null; /** ISO currency code for monetary fields. */
+  readonly currency: string | null; /** Product publication or availability status. */
+  readonly status: string | null; /** Product images. */
+  readonly images: readonly PortalImage[]; /** Purchasable product variants. */
+  readonly variants: readonly PortalProductVariant[]; /** Number of associated media items. */
+  readonly mediaCount: number | null; /** ISO 8601 creation timestamp. */
+  readonly createdAt: string | null; /** Whether the product represents a bundle. */
+  readonly isBundle: boolean; /** Minimum and maximum one-time prices as decimal strings. */
   readonly priceRange: {
-    readonly min: string;
+    /** Minimum one-time price. */readonly min: string; /** Maximum one-time price. */
     readonly max: string;
-  } | null;
+  } | null; /** Minimum and maximum subscription prices as decimal strings. */
   readonly subscriptionPriceRange: {
-    readonly min: string;
+    /** Minimum subscription price. */readonly min: string; /** Maximum subscription price. */
     readonly max: string;
-  } | null;
-  readonly shopLink: string | null;
-  readonly hasCustomizations: boolean | null;
-  readonly cv: string | null;
+  } | null; /** Absolute URL of the product in the shop. */
+  readonly shopLink: string | null; /** Whether purchasing the product requires customization choices. */
+  readonly hasCustomizations: boolean | null; /** Commission volume serialized as a decimal string. */
+  readonly cv: string | null; /** Qualifying volume serialized as a decimal string. */
   readonly qv: string | null;
 };
+/** Pagination and ordering for {@link listProducts}. */
 type ListProductsInput = PortalPageInput & {
-  readonly sort?: "title_asc" | "title_desc" | "price_asc" | "price_desc" | "created_at_asc" | "created_at_desc";
+  /** Product ordering. */readonly sort?: "title_asc" | "title_desc" | "price_asc" | "price_desc" | "created_at_asc" | "created_at_desc";
 };
+/** Product identifier accepted by {@link getProduct}. */
 type GetProductInput = {
-  readonly id: string | number;
+  /** Product identifier. */readonly id: string | number;
 };
+/** Query and pagination for {@link searchProducts}. */
 type SearchProductsInput = PortalPageInput & {
-  readonly query: string;
+  /** Text to match against searchable product data. */readonly query: string;
 };
+/** Media associated with a product. */
 type PortalProductMedia = {
-  readonly id: number | null;
-  readonly title: string | null;
-  readonly mediaType: string | null;
+  /** Media identifier. */readonly id: number | null; /** Media display title. */
+  readonly title: string | null; /** Media format or type. */
+  readonly mediaType: string | null; /** Absolute media URL. */
   readonly url: string | null;
 };
+/** Product identifier accepted by {@link listProductMedia}. */
 type ListProductMediaInput = {
-  readonly productId: string | number;
+  /** Product whose media is requested. */readonly productId: string | number;
 };
+/** Supported aggregation windows for product and content metrics. */
 type PortalMetricsPeriod = "7d" | "30d" | "90d" | "1y" | "all";
+/** Metric selection for {@link listProductMetrics}. */
 type ListProductMetricsInput = {
-  readonly kind: "visits" | "shareVisits";
-  readonly period?: PortalMetricsPeriod;
+  /** Whether to return direct visits or visits attributed to shares. */readonly kind: "visits" | "shareVisits"; /** Aggregation window. */
+  readonly period?: PortalMetricsPeriod; /** Maximum number of metric rows to return. */
   readonly limit?: number;
 };
+/** Aggregated metric value for a Portal resource. */
 type PortalMetric = {
-  readonly id: number | null;
+  /** Resource identifier, or `null` for an aggregate without one resource. */readonly id: number | null; /** Metric total for the requested period. */
   readonly total: number;
 };
+/** Calendar event visible to the signed-in Portal user. */
 type PortalCalendarEvent = {
-  readonly id: number;
-  readonly title: string;
-  readonly description: string | null;
-  readonly color: string | null;
-  readonly url: string | null;
-  readonly start: string;
-  readonly end: string;
-  readonly timeZone: string | null;
-  readonly status: string | null;
-  readonly imageUrl: string | null;
-  readonly venue: string | null;
-  readonly countries: readonly string[];
+  /** Event identifier. */readonly id: number; /** Event title. */
+  readonly title: string; /** Event description. */
+  readonly description: string | null; /** Event color value supplied by the host. */
+  readonly color: string | null; /** Absolute event URL. */
+  readonly url: string | null; /** ISO 8601 event start. */
+  readonly start: string; /** ISO 8601 event end. */
+  readonly end: string; /** IANA time-zone name. */
+  readonly timeZone: string | null; /** Event status. */
+  readonly status: string | null; /** Absolute event image URL. */
+  readonly imageUrl: string | null; /** Event venue. */
+  readonly venue: string | null; /** ISO country codes where the event is available. */
+  readonly countries: readonly string[]; /** Whether the event spans a whole day rather than explicit times. */
   readonly isAllDay: boolean;
 };
+/** Call-to-action configuration attached to content media. */
 type PortalMediaCta = {
-  readonly enabled: boolean;
-  readonly type: "link" | "cart" | "email" | "phone" | null;
-  readonly buttonText: string | null;
-  readonly buttonColor: string | null;
-  readonly buttonDescription: string | null;
+  /** Whether the call to action is enabled. */readonly enabled: boolean; /** Action behavior, or `null` when no behavior is configured. */
+  readonly type: "link" | "cart" | "email" | "phone" | null; /** Text shown on the action button. */
+  readonly buttonText: string | null; /** Button color value supplied by the host. */
+  readonly buttonColor: string | null; /** Accessible or supporting description of the action. */
+  readonly buttonDescription: string | null; /** URL or URI used by the action. */
   readonly actionUrl: string | null;
 };
+/** Content-library media item available to a widget. */
 type PortalMedia = {
-  readonly id: number;
-  readonly title: string;
-  readonly description: string | null;
-  readonly contentFormat: string | null;
-  readonly status: string | null;
-  readonly url: string | null;
-  readonly thumbnailUrl: string | null;
-  readonly cta: PortalMediaCta | null;
+  /** Media identifier. */readonly id: number; /** Media title. */
+  readonly title: string; /** Media description. */
+  readonly description: string | null; /** Media format supplied by the content library. */
+  readonly contentFormat: string | null; /** Publication or processing status. */
+  readonly status: string | null; /** Absolute content URL. */
+  readonly url: string | null; /** Absolute thumbnail URL. */
+  readonly thumbnailUrl: string | null; /** Configured call to action. */
+  readonly cta: PortalMediaCta | null; /** Search-engine metadata for the media item. */
   readonly seo: {
-    readonly title: string | null;
-    readonly description: string | null;
-    readonly imageUrl: string | null;
+    /** Search result title. */readonly title: string | null; /** Search result description. */
+    readonly description: string | null; /** Absolute social or search preview image URL. */
+    readonly imageUrl: string | null; /** Whether crawlers should be asked not to index the item. */
     readonly blockCrawler: boolean;
-  } | null;
-  readonly createdAt: string;
+  } | null; /** ISO 8601 creation timestamp. */
+  readonly createdAt: string; /** ISO 8601 last-update timestamp. */
   readonly updatedAt: string;
 };
+/** Filters, localization, ordering, and pagination for {@link listContentMedia}. */
 type ListContentMediaInput = PortalPageInput & {
-  readonly title?: string;
-  readonly ownership?: "all" | "mine" | "company";
-  readonly contentFormat?: "video" | "image" | "pdf" | "ppt";
-  readonly sort?: "title_asc" | "title_desc";
+  /** Text to match against media titles. */readonly title?: string; /** Ownership scope for the returned media. */
+  readonly ownership?: "all" | "mine" | "company"; /** Media format to return. */
+  readonly contentFormat?: "video" | "image" | "pdf" | "ppt"; /** Media ordering. */
+  readonly sort?: "title_asc" | "title_desc"; /** ISO language code for localized content. */
   readonly languageIso?: string;
 };
+/** Media identifier and localization for {@link getContentMedia}. */
 type GetContentMediaInput = {
-  readonly id: number;
+  /** Content-media identifier. */readonly id: number; /** ISO language code for localized content. */
   readonly languageIso?: string;
 };
+/** Content playlist available to a widget. */
 type PortalPlaylist = {
-  readonly id: number;
-  readonly title: string;
-  readonly description: string | null;
-  readonly itemsCount: number;
-  readonly isFavorited: boolean;
-  readonly imageUrl: string | null;
-  readonly createdAt: string;
+  /** Playlist identifier. */readonly id: number; /** Playlist title. */
+  readonly title: string; /** Playlist description. */
+  readonly description: string | null; /** Number of items in the playlist. */
+  readonly itemsCount: number; /** Whether the signed-in user has favorited the playlist. */
+  readonly isFavorited: boolean; /** Absolute playlist image URL. */
+  readonly imageUrl: string | null; /** ISO 8601 creation timestamp. */
+  readonly createdAt: string; /** ISO 8601 last-update timestamp. */
   readonly updatedAt: string;
 };
+/** Filters, ordering, and pagination for {@link listPlaylists}. */
 type ListPlaylistsInput = PortalPageInput & {
-  readonly title?: string;
-  readonly ownership?: "all" | "mine" | "company";
+  /** Text to match against playlist titles. */readonly title?: string; /** Ownership scope for the returned playlists. */
+  readonly ownership?: "all" | "mine" | "company"; /** Playlist ordering. */
   readonly sort?: "title_asc" | "title_desc" | "created_at_asc" | "created_at_desc";
 };
+/** Playlist identifier accepted by {@link getPlaylist}. */
 type GetPlaylistInput = {
-  readonly id: number;
+  /** Playlist identifier. */readonly id: number;
 };
+/** Product summary embedded in a playlist item. */
 type PortalPlaylistProduct = {
-  readonly id: number;
-  readonly name: string;
-  readonly slug: string | null;
-  readonly description: string | null;
-  readonly price: string | null;
-  readonly wholesalePrice: string | null;
-  readonly currency: string | null;
-  readonly status: string | null;
-  readonly images: readonly PortalImage[];
-  readonly mediaCount: number | null;
+  /** Product identifier. */readonly id: number; /** Product display name. */
+  readonly name: string; /** URL-safe product slug. */
+  readonly slug: string | null; /** Product description. */
+  readonly description: string | null; /** Retail price serialized as a decimal string. */
+  readonly price: string | null; /** Wholesale price serialized as a decimal string. */
+  readonly wholesalePrice: string | null; /** ISO currency code for monetary fields. */
+  readonly currency: string | null; /** Product publication or availability status. */
+  readonly status: string | null; /** Product images. */
+  readonly images: readonly PortalImage[]; /** Number of associated media items. */
+  readonly mediaCount: number | null; /** ISO 8601 creation timestamp. */
   readonly createdAt: string | null;
 };
+/**
+* Content embedded in a playlist item.
+*
+* Narrow on `type` before accessing fields specific to media, pages, products,
+* or enrollment packs.
+*/
 type PortalPlaylistItemContent = {
-  readonly type: "media";
-  readonly id: number;
-  readonly title: string;
-  readonly description: string | null;
-  readonly url: string | null;
+  /** Identifies content-library media. */readonly type: "media"; /** Media identifier. */
+  readonly id: number; /** Media title. */
+  readonly title: string; /** Media description. */
+  readonly description: string | null; /** Absolute media URL. */
+  readonly url: string | null; /** Absolute thumbnail URL. */
   readonly thumbnailUrl: string | null;
 } | {
-  readonly type: "page";
-  readonly id: number;
-  readonly title: string | null;
-  readonly slug: string | null;
-  readonly status: "published" | "unpublished";
-  readonly description: string | null;
+  /** Identifies a content page. */readonly type: "page"; /** Page identifier. */
+  readonly id: number; /** Page title. */
+  readonly title: string | null; /** URL-safe page slug. */
+  readonly slug: string | null; /** Page publication status. */
+  readonly status: "published" | "unpublished"; /** Page description. */
+  readonly description: string | null; /** Absolute page image URL. */
   readonly imageUrl: string | null;
 } | {
-  readonly type: "product";
+  /** Identifies a product. */readonly type: "product"; /** Embedded product summary. */
   readonly product: PortalPlaylistProduct;
 } | {
-  readonly type: "enrollmentPack";
-  readonly id: number;
-  readonly title: string;
-  readonly slug: string | null;
-  readonly description: string | null;
-  readonly url: string | null;
+  /** Identifies an enrollment pack. */readonly type: "enrollmentPack"; /** Enrollment-pack identifier. */
+  readonly id: number; /** Enrollment-pack title. */
+  readonly title: string; /** URL-safe enrollment-pack slug. */
+  readonly slug: string | null; /** Enrollment-pack description. */
+  readonly description: string | null; /** Absolute enrollment-pack URL. */
+  readonly url: string | null; /** Enrollment-pack images. */
   readonly images: readonly PortalImage[];
 };
+/** One positioned resource in a content playlist. */
 type PortalPlaylistItem = {
-  readonly id: number;
-  readonly contentType: "media" | "page" | "product" | "enrollmentPack";
-  readonly contentId: number;
-  readonly position: number | null;
-  readonly createdAt: string;
+  /** Playlist-item identifier. */readonly id: number; /** Kind of resource referenced by the item. */
+  readonly contentType: "media" | "page" | "product" | "enrollmentPack"; /** Identifier of the referenced resource. */
+  readonly contentId: number; /** Display position within the playlist. */
+  readonly position: number | null; /** ISO 8601 creation timestamp. */
+  readonly createdAt: string; /** Embedded resource data. Narrow the {@link PortalPlaylistItemContent} value on its `type` field. */
   readonly content: PortalPlaylistItemContent;
 };
+/** Playlist, localization, and pagination for {@link listPlaylistItems}. */
 type ListPlaylistItemsInput = PortalPageInput & {
-  readonly playlistId: number;
+  /** Playlist whose items are requested. */readonly playlistId: number; /** ISO language code for localized item content. */
   readonly languageIso?: string;
 };
+/** Content-page summary available to a widget. */
 type PortalPageContent = {
-  readonly id: number;
-  readonly title: string | null;
-  readonly slug: string | null;
-  readonly source: "code" | "builder" | null;
-  readonly status: "published" | "unpublished";
-  readonly description: string | null;
-  readonly imageUrl: string | null;
+  /** Page identifier. */readonly id: number; /** Page title. */
+  readonly title: string | null; /** URL-safe page slug. */
+  readonly slug: string | null; /** Whether code or the visual builder owns the page. */
+  readonly source: "code" | "builder" | null; /** Page publication status. */
+  readonly status: "published" | "unpublished"; /** Page description. */
+  readonly description: string | null; /** Absolute page image URL. */
+  readonly imageUrl: string | null; /** Countries where the page is available. */
   readonly countries: readonly PortalCountry[];
 };
+/** Filters, localization, ordering, and pagination for {@link listPages}. */
 type ListPagesInput = PortalPageInput & {
-  readonly title?: string;
-  readonly sort?: "title_asc" | "title_desc";
+  /** Text to match against page titles. */readonly title?: string; /** Page ordering. */
+  readonly sort?: "title_asc" | "title_desc"; /** ISO language code for localized page content. */
   readonly languageIso?: string;
 };
+/** Page identifier and localization for {@link getPage}. */
 type GetPageInput = {
-  readonly id: number;
+  /** Page identifier. */readonly id: number; /** ISO language code for localized page content. */
   readonly languageIso?: string;
 };
+/** Content page together with its share URL. */
 type PortalPageDetail = {
-  readonly page: PortalPageContent;
+  /** Page data. */readonly page: PortalPageContent; /** Absolute URL for sharing the page. */
   readonly shareLink: string | null;
 };
+/** Enrollment pack available to a widget. */
 type PortalEnrollmentPack = {
-  readonly id: number;
-  readonly title: string;
-  readonly slug: string | null;
-  readonly description: string | null;
-  readonly url: string | null;
-  readonly canonicalUrl: string | null;
+  /** Enrollment-pack identifier. */readonly id: number; /** Enrollment-pack title. */
+  readonly title: string; /** URL-safe enrollment-pack slug. */
+  readonly slug: string | null; /** Enrollment-pack description. */
+  readonly description: string | null; /** Absolute enrollment-pack URL. */
+  readonly url: string | null; /** Canonical absolute URL. */
+  readonly canonicalUrl: string | null; /** Enrollment-pack images. */
   readonly images: readonly PortalImage[];
 };
+/** Enrollment-pack identifier accepted by {@link getEnrollmentPack}. */
 type GetEnrollmentPackInput = {
-  readonly id: number;
+  /** Enrollment-pack identifier. */readonly id: number;
 };
 type ListContentMetricsBaseInput = {
-  readonly kind: "visits" | "shareVisits";
-  readonly period?: PortalMetricsPeriod;
+  /** Whether to return direct visits or visits attributed to shares. */readonly kind: "visits" | "shareVisits"; /** Aggregation window. */
+  readonly period?: PortalMetricsPeriod; /** Maximum number of metric rows to return. */
   readonly limit?: number;
 };
+/** Resource and metric selection for {@link listContentMetrics}. */
 type ListContentMetricsInput = (ListContentMetricsBaseInput & {
-  readonly resource: "media" | "pages";
+  /** Content resource to aggregate. */readonly resource: "media" | "pages"; /** ISO language code for localized media or pages. */
   readonly languageIso?: string;
 }) | (ListContentMetricsBaseInput & {
-  readonly resource: "playlists";
+  /** Aggregate playlist metrics. Playlists do not accept `languageIso`. */readonly resource: "playlists";
 });
+/** Share record created for a Portal resource. */
 type PortalShare = {
-  readonly id: number;
-  readonly url: string;
-  readonly shareableType: "media" | "product" | "library" | "page";
-  readonly shareableId: number;
+  /** Share identifier. */readonly id: number; /** Absolute share URL. */
+  readonly url: string; /** Kind of shared resource. */
+  readonly shareableType: "media" | "product" | "library" | "page"; /** Identifier of the shared resource. */
+  readonly shareableId: number; /** ISO 8601 creation timestamp. */
   readonly createdAt: string;
 };
+/** Digital asset available from the Portal content library. */
 type PortalDamAsset = {
-  readonly id: number;
-  readonly code: string;
-  readonly name: string;
-  readonly description: string | null;
-  readonly category: string | null;
-  readonly defaultVariantUrl: string | null;
-  readonly canonicalPath: string | null;
-  readonly createdAt: string;
+  /** Asset identifier. */readonly id: number; /** Stable asset code used to query its paths. */
+  readonly code: string; /** Asset display name. */
+  readonly name: string; /** Asset description. */
+  readonly description: string | null; /** Asset category. */
+  readonly category: string | null; /** Absolute URL of the default asset variant. */
+  readonly defaultVariantUrl: string | null; /** Canonical path for the asset. */
+  readonly canonicalPath: string | null; /** ISO 8601 creation timestamp. */
+  readonly createdAt: string; /** ISO 8601 last-update timestamp. */
   readonly updatedAt: string | null;
 };
+/** Asset and pagination selection for {@link listDamAssetPaths}. */
 type ListDamAssetPathsInput = PortalPageInput & {
-  readonly assetCode: string;
+  /** Stable asset code from {@link PortalDamAsset.code}. */readonly assetCode: string;
 };
+/** One accessible path for a digital asset. */
 type PortalDamAssetPath = {
-  readonly id: number;
-  readonly assetCode: string;
-  readonly path: string;
+  /** Asset-path identifier. */readonly id: number; /** Stable code of the parent asset. */
+  readonly assetCode: string; /** Asset path supplied by the content library. */
+  readonly path: string; /** ISO 8601 creation timestamp. */
   readonly createdAt: string;
 };
+/**
+* Lists countries and their states in the requested language.
+*
+* Declare `listCountries` in the widget's `uses` list before calling it.
+*
+* @param input - Optional localization and cursor pagination.
+* @returns A page of countries and a cursor for the next page.
+* @throws {@link PortalFunctionError} when `listCountries` is not declared, the input is invalid, the localization capability is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const page = await listCountries({ languageIso: "en", limit: 50 });
+* ```
+*/
 declare const listCountries: PortalFunction<PortalPage<PortalCountry>, ListCountriesInput>;
+/**
+* Lists languages available in the current Portal.
+*
+* Declare `listLanguages` in the widget's `uses` list before calling it.
+*
+* @param input - Optional cursor pagination.
+* @returns A page of available languages and a cursor for the next page.
+* @throws {@link PortalFunctionError} when `listLanguages` is not declared, the input is invalid, the localization capability is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const languages = await listLanguages({ limit: 20 });
+* ```
+*/
 declare const listLanguages: PortalFunction<PortalPage<PortalLanguage>, PortalPageInput>;
+/**
+* Gets the localized address-field configuration for a country.
+*
+* Declare `getAddressFields` in the widget's `uses` list before calling it.
+*
+* @param input - Country code and optional label language.
+* @returns The country and its ordered address fields.
+* @throws {@link PortalFunctionError} when `getAddressFields` is not declared, the input is invalid, the localization capability is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const address = await getAddressFields({ countryCode: "US", languageIso: "en" });
+* ```
+*/
 declare const getAddressFields: PortalFunction<PortalAddressFields, GetAddressFieldsInput>;
+/**
+* Lists products available in the current Portal.
+*
+* Declare `listProducts` in the widget's `uses` list before calling it.
+*
+* @param input - Optional ordering and cursor pagination.
+* @returns A page of products and a cursor for the next page.
+* @throws {@link PortalFunctionError} when `listProducts` is not declared, the input is invalid, the products capability is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const products = await listProducts({ sort: "title_asc", limit: 20 });
+* ```
+*/
 declare const listProducts: PortalFunction<PortalPage<PortalProduct>, ListProductsInput>;
+/**
+* Gets one product by identifier.
+*
+* Declare `getProduct` in the widget's `uses` list before calling it.
+*
+* @param input - Product identifier.
+* @returns The requested product.
+* @throws {@link PortalFunctionError} when `getProduct` is not declared, the identifier is invalid or unavailable, the products capability is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const product = await getProduct({ id: 42 });
+* ```
+*/
 declare const getProduct: PortalFunction<PortalProduct, GetProductInput>;
+/**
+* Searches products using Portal product search.
+*
+* Declare `searchProducts` in the widget's `uses` list before calling it.
+*
+* @param input - Search text and optional cursor pagination.
+* @returns A page of matching products and a cursor for the next page.
+* @throws {@link PortalFunctionError} when `searchProducts` is not declared, the input is invalid, product search is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const matches = await searchProducts({ query: "starter kit", limit: 10 });
+* ```
+*/
 declare const searchProducts: PortalFunction<PortalPage<PortalProduct>, SearchProductsInput>;
+/**
+* Lists media associated with a product.
+*
+* Declare `listProductMedia` in the widget's `uses` list before calling it.
+*
+* @param input - Product identifier.
+* @returns The product's media items.
+* @throws {@link PortalFunctionError} when `listProductMedia` is not declared, the product identifier is invalid or unavailable, the products capability is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const media = await listProductMedia({ productId: 42 });
+* ```
+*/
 declare const listProductMedia: PortalFunction<readonly PortalProductMedia[], ListProductMediaInput>;
+/**
+* Lists visit metrics for products.
+*
+* Declare `listProductMetrics` in the widget's `uses` list before calling it.
+*
+* @param input - Metric kind, optional period, and optional result limit.
+* @returns Metric totals grouped by product.
+* @throws {@link PortalFunctionError} when `listProductMetrics` is not declared, the input is invalid, product metrics are unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const metrics = await listProductMetrics({ kind: "visits", period: "30d" });
+* ```
+*/
 declare const listProductMetrics: PortalFunction<readonly PortalMetric[], ListProductMetricsInput>;
+/**
+* Lists calendar events visible to the signed-in Portal user.
+*
+* Declare `listCalendarEvents` in the widget's `uses` list before calling it.
+*
+* @returns All events supplied by the Portal calendar capability.
+* @throws {@link PortalFunctionError} when `listCalendarEvents` is not declared, the calendar capability is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const events = await listCalendarEvents();
+* ```
+*/
 declare const listCalendarEvents: PortalFunction<readonly PortalCalendarEvent[]>;
+/**
+* Lists media from the Portal content library.
+*
+* Declare `listContentMedia` in the widget's `uses` list before calling it.
+*
+* @param input - Optional filters, localization, ordering, and cursor pagination.
+* @returns A page of content media and a cursor for the next page.
+* @throws {@link PortalFunctionError} when `listContentMedia` is not declared, the input is invalid, content access is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const media = await listContentMedia({ contentFormat: "video", limit: 20 });
+* ```
+*/
 declare const listContentMedia: PortalFunction<PortalPage<PortalMedia>, ListContentMediaInput>;
+/**
+* Gets one content-library media item by identifier.
+*
+* Declare `getContentMedia` in the widget's `uses` list before calling it.
+*
+* @param input - Media identifier and optional content language.
+* @returns The requested media item.
+* @throws {@link PortalFunctionError} when `getContentMedia` is not declared, the input is invalid or unavailable, content access is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const media = await getContentMedia({ id: 42, languageIso: "en" });
+* ```
+*/
 declare const getContentMedia: PortalFunction<PortalMedia, GetContentMediaInput>;
+/**
+* Lists playlists from the Portal content library.
+*
+* Declare `listPlaylists` in the widget's `uses` list before calling it.
+*
+* @param input - Optional filters, ordering, and cursor pagination.
+* @returns A page of playlists and a cursor for the next page.
+* @throws {@link PortalFunctionError} when `listPlaylists` is not declared, the input is invalid, content access is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const playlists = await listPlaylists({ ownership: "company", limit: 20 });
+* ```
+*/
 declare const listPlaylists: PortalFunction<PortalPage<PortalPlaylist>, ListPlaylistsInput>;
+/**
+* Gets one content playlist by identifier.
+*
+* Declare `getPlaylist` in the widget's `uses` list before calling it.
+*
+* @param input - Playlist identifier.
+* @returns The requested playlist.
+* @throws {@link PortalFunctionError} when `getPlaylist` is not declared, the identifier is invalid or unavailable, content access is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const playlist = await getPlaylist({ id: 42 });
+* ```
+*/
 declare const getPlaylist: PortalFunction<PortalPlaylist, GetPlaylistInput>;
+/**
+* Lists the ordered items in a content playlist.
+*
+* Declare `listPlaylistItems` in the widget's `uses` list before calling it.
+*
+* @param input - Playlist identifier, optional language, and cursor pagination.
+* @returns A page of playlist items and a cursor for the next page.
+* @throws {@link PortalFunctionError} when `listPlaylistItems` is not declared, the input is invalid, the playlist is unavailable, content access is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const items = await listPlaylistItems({ playlistId: 42, limit: 20 });
+* ```
+*/
 declare const listPlaylistItems: PortalFunction<PortalPage<PortalPlaylistItem>, ListPlaylistItemsInput>;
+/**
+* Lists content pages available to the signed-in Portal user.
+*
+* Declare `listPages` in the widget's `uses` list before calling it.
+*
+* @param input - Optional filters, localization, ordering, and cursor pagination.
+* @returns A page of content-page summaries and a cursor for the next page.
+* @throws {@link PortalFunctionError} when `listPages` is not declared, the input is invalid, content access is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const pages = await listPages({ sort: "title_asc", limit: 20 });
+* ```
+*/
 declare const listPages: PortalFunction<PortalPage<PortalPageContent>, ListPagesInput>;
+/**
+* Gets one content page and its share URL.
+*
+* Declare `getPage` in the widget's `uses` list before calling it.
+*
+* @param input - Page identifier and optional content language.
+* @returns The requested page and its share URL.
+* @throws {@link PortalFunctionError} when `getPage` is not declared, the input is invalid or unavailable, content access is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const detail = await getPage({ id: 42, languageIso: "en" });
+* ```
+*/
 declare const getPage: PortalFunction<PortalPageDetail, GetPageInput>;
+/**
+* Lists enrollment packs available in the Portal content library.
+*
+* Declare `listEnrollmentPacks` in the widget's `uses` list before calling it.
+*
+* @param input - Optional cursor pagination.
+* @returns A page of enrollment packs and a cursor for the next page.
+* @throws {@link PortalFunctionError} when `listEnrollmentPacks` is not declared, the input is invalid, content access is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const packs = await listEnrollmentPacks({ limit: 20 });
+* ```
+*/
 declare const listEnrollmentPacks: PortalFunction<PortalPage<PortalEnrollmentPack>, PortalPageInput>;
+/**
+* Gets one enrollment pack by identifier.
+*
+* Declare `getEnrollmentPack` in the widget's `uses` list before calling it.
+*
+* @param input - Enrollment-pack identifier.
+* @returns The requested enrollment pack.
+* @throws {@link PortalFunctionError} when `getEnrollmentPack` is not declared, the identifier is invalid or unavailable, content access is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const pack = await getEnrollmentPack({ id: 42 });
+* ```
+*/
 declare const getEnrollmentPack: PortalFunction<PortalEnrollmentPack, GetEnrollmentPackInput>;
+/**
+* Lists visit metrics for Portal content resources.
+*
+* Declare `listContentMetrics` in the widget's `uses` list before calling it.
+*
+* @param input - Resource, metric kind, and optional aggregation settings.
+* @returns Metric totals grouped by content resource.
+* @throws {@link PortalFunctionError} when `listContentMetrics` is not declared, the input is invalid, content metrics are unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const metrics = await listContentMetrics({
+*   resource: "media",
+*   kind: "shareVisits",
+*   period: "30d",
+* });
+* ```
+*/
 declare const listContentMetrics: PortalFunction<readonly PortalMetric[], ListContentMetricsInput>;
+/**
+* Lists share records created by the signed-in Portal user.
+*
+* Declare `listShares` in the widget's `uses` list before calling it.
+*
+* @param input - Optional cursor pagination.
+* @returns A page of share records and a cursor for the next page.
+* @throws {@link PortalFunctionError} when `listShares` is not declared, the input is invalid, content access is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const shares = await listShares({ limit: 20 });
+* ```
+*/
 declare const listShares: PortalFunction<PortalPage<PortalShare>, PortalPageInput>;
+/**
+* Lists digital assets available from the Portal content library.
+*
+* Declare `listDamAssets` in the widget's `uses` list before calling it.
+*
+* @param input - Optional cursor pagination.
+* @returns A page of digital assets and a cursor for the next page.
+* @throws {@link PortalFunctionError} when `listDamAssets` is not declared, the input is invalid, digital-asset access is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const assets = await listDamAssets({ limit: 20 });
+* ```
+*/
 declare const listDamAssets: PortalFunction<PortalPage<PortalDamAsset>, PortalPageInput>;
+/**
+* Lists accessible paths for one digital asset.
+*
+* Declare `listDamAssetPaths` in the widget's `uses` list before calling it.
+*
+* @param input - Asset code and optional cursor pagination.
+* @returns A page of asset paths and a cursor for the next page.
+* @throws {@link PortalFunctionError} when `listDamAssetPaths` is not declared, the input or asset code is invalid, digital-asset access is unavailable, or the host call or response fails.
+*
+* @example
+* ```ts
+* const paths = await listDamAssetPaths({ assetCode: "hero-image", limit: 20 });
+* ```
+*/
 declare const listDamAssetPaths: PortalFunction<PortalPage<PortalDamAssetPath>, ListDamAssetPathsInput>;
 //#endregion
 //#region ../../shareables/core/src/favorites-api.d.ts
@@ -591,254 +1097,576 @@ declare const CONTENT_FAVORITE_TYPES: readonly ["Product", "Medium", "Promotion"
 type ContentFavoriteType = (typeof CONTENT_FAVORITE_TYPES)[number];
 //#endregion
 //#region src/widgets/remote/contract/capabilities/content-mutation.d.ts
+/** Fields used to create a content-media record. */
 type CreateContentMediaInput = {
-  readonly title: string;
-  readonly description?: string | null;
-  readonly mediaType: string;
-  readonly url?: string | null;
+  /** Media title. */readonly title: string; /** Optional description. */
+  readonly description?: string | null; /** Host media category. */
+  readonly mediaType: string; /** Media URL, if already available. */
+  readonly url?: string | null; /** Content file format. */
   readonly contentFormat?: "image" | "video" | "pdf" | "ppt";
 };
+/** Editable fields for a content-media record. */
 type UpdateContentMediaInput = {
-  readonly id: number;
-  readonly title?: string;
-  readonly description?: string | null;
-  readonly status?: "active" | "draft";
-  readonly url?: string | null;
-  readonly contentFormat?: "image" | "video" | "pdf" | "ppt";
-  readonly thumbnailUrl?: string | null;
-  readonly languageIso?: string;
+  /** Media identifier. */readonly id: number; /** Replacement title. */
+  readonly title?: string; /** Replacement description. */
+  readonly description?: string | null; /** Publication state. */
+  readonly status?: "active" | "draft"; /** Replacement media URL. */
+  readonly url?: string | null; /** Replacement file format. */
+  readonly contentFormat?: "image" | "video" | "pdf" | "ppt"; /** Replacement thumbnail URL. */
+  readonly thumbnailUrl?: string | null; /** ISO language code for localized content. */
+  readonly languageIso?: string; /** Call-to-action settings. */
   readonly cta?: {
-    readonly enabled?: boolean;
-    readonly type?: "link" | "cart";
-    readonly buttonText?: string | null;
-    readonly buttonColor?: string | null;
-    readonly buttonDescription?: string | null;
+    /** Whether the call to action is enabled. */readonly enabled?: boolean; /** Link or cart action. */
+    readonly type?: "link" | "cart"; /** Button label. */
+    readonly buttonText?: string | null; /** Button color value. */
+    readonly buttonColor?: string | null; /** Accessible button description. */
+    readonly buttonDescription?: string | null; /** Action destination URL. */
     readonly actionUrl?: string | null;
-  };
+  }; /** Search-engine metadata. */
   readonly seo?: {
-    readonly title?: string | null;
-    readonly description?: string | null;
-    readonly imageUrl?: string | null;
+    /** Search result title. */readonly title?: string | null; /** Search result description. */
+    readonly description?: string | null; /** Search result image URL. */
+    readonly imageUrl?: string | null; /** Whether crawlers should be blocked. */
     readonly blockCrawler?: boolean;
   };
 };
+/** Identifies content media to delete. */
 type DeleteContentMediaInput = {
-  readonly id: number;
+  /** Media identifier. */readonly id: number;
 };
+/** Product associated with a content-media record. */
 type PortalMediaProduct = {
-  readonly id: number;
-  readonly name: string | null;
-  readonly slug: string | null;
-  readonly imageUrl: string | null;
-  readonly price: string | null;
-  readonly currency: string | null;
+  /** Product identifier. */readonly id: number; /** Product name, if available. */
+  readonly name: string | null; /** Product slug, if available. */
+  readonly slug: string | null; /** Product image URL, if available. */
+  readonly imageUrl: string | null; /** Retail price, if available. */
+  readonly price: string | null; /** Currency code, if available. */
+  readonly currency: string | null; /** ISO association timestamp, if available. */
   readonly addedAt: string | null;
 };
+/** Pagination and localization for content-media products. */
 type ListContentMediaProductsInput = PortalPageInput & {
-  readonly mediaId: number;
+  /** Media identifier. */readonly mediaId: number; /** ISO language code. */
   readonly languageIso?: string;
 };
+/** Identifies media and product records to associate. */
 type AddContentMediaProductInput = {
-  readonly mediaId: number;
+  /** Media identifier. */readonly mediaId: number; /** Product identifier. */
   readonly productId: number;
 };
+/** Identifies a media-product association to remove. */
 type RemoveContentMediaProductInput = AddContentMediaProductInput;
+/** Fields used to create a content playlist. */
 type CreateContentPlaylistInput = {
-  readonly title: string;
+  /** Playlist title. */readonly title: string; /** Optional playlist description. */
   readonly description?: string | null;
 };
+/** Editable fields for a content playlist. */
 type UpdateContentPlaylistInput = {
-  readonly id: number;
-  readonly title?: string;
+  /** Playlist identifier. */readonly id: number; /** Replacement title. */
+  readonly title?: string; /** Replacement description. */
   readonly description?: string | null;
 };
+/** Identifies a content playlist to delete. */
 type DeleteContentPlaylistInput = {
-  readonly id: number;
+  /** Playlist identifier. */readonly id: number;
 };
+/** Identifies content to insert into a playlist. */
 type AddContentPlaylistItemInput = {
-  readonly playlistId: number;
-  readonly contentType: "media" | "page" | "product" | "enrollmentPack";
-  readonly contentId: number;
+  /** Playlist identifier. */readonly playlistId: number; /** Kind of content to add. */
+  readonly contentType: "media" | "page" | "product" | "enrollmentPack"; /** Content resource identifier. */
+  readonly contentId: number; /** Requested insertion position. */
   readonly position?: number | null;
 };
+/** Identifies a playlist item to remove. */
 type RemoveContentPlaylistItemInput = {
-  readonly playlistId: number;
+  /** Playlist identifier. */readonly playlistId: number; /** Playlist-item identifier. */
   readonly itemId: number;
 };
+/** Defines playlist-item positions. */
 type ReorderContentPlaylistItemsInput = {
-  readonly playlistId: number;
+  /** Playlist identifier. */readonly playlistId: number; /** Item identifiers paired with their desired order. */
   readonly items: readonly {
-    readonly id: number;
+    /** Playlist-item identifier. */readonly id: number; /** Desired zero-based order. */
     readonly order: number;
   }[];
 };
+/** Identifies content for which to create a share link. */
 type CreateContentShareInput = {
-  readonly shareableType: "media" | "product" | "library" | "page";
+  /** Kind of resource to share. */readonly shareableType: "media" | "product" | "library" | "page"; /** Shared resource identifier. */
   readonly shareableId: number;
 };
+/** Identifies content whose favorite state should be toggled. */
 type ToggleContentFavoriteInput = {
-  readonly favoriteableType: ContentFavoriteType;
+  /** Favorite resource category. */readonly favoriteableType: ContentFavoriteType; /** Favorite resource identifier. */
   readonly favoriteableId: number;
 };
+/** Current favorite state returned after a toggle. */
 type PortalContentFavoriteState = {
-  readonly favoriteableType: ContentFavoriteType;
-  readonly favoriteableId: number;
+  /** Favorite resource category. */readonly favoriteableType: ContentFavoriteType; /** Favorite resource identifier. */
+  readonly favoriteableId: number; /** Resulting favorite state. */
   readonly isFavorited: boolean;
 };
+/** Fields used to create a digital-asset record. */
 type CreateDamAssetInput = {
-  readonly name: string;
+  /** Asset name. */readonly name: string; /** Optional asset description. */
   readonly description?: string | null;
 };
+/** Fields used to add a path to a digital asset. */
 type CreateDamAssetPathInput = {
-  readonly assetCode: string;
+  /** Stable asset code. */readonly assetCode: string; /** New asset path. */
   readonly path: string;
 };
+/** Identifies a digital asset for mutation. */
 type MutateDamAssetInput = {
-  readonly assetCode: string;
+  /** Stable asset code. */readonly assetCode: string;
 };
+/**
+* Creates content media in the Portal host.
+* @param input - Media metadata and optional source URL.
+* @returns The created {@link PortalMedia}.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `createContentMedia` in `uses`. This mutates host content after mount.
+* @example const media = await createContentMedia({ title: "Guide", mediaType: "document" });
+*/
 declare const createContentMedia: PortalFunction<PortalMedia, CreateContentMediaInput>;
+/**
+* Updates an existing content-media record.
+* @param input - Media identifier and fields to replace.
+* @returns The updated {@link PortalMedia}.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `updateContentMedia` in `uses`. This mutates host content after mount.
+* @example const media = await updateContentMedia({ id: 12, title: "Updated guide" });
+*/
 declare const updateContentMedia: PortalFunction<PortalMedia, UpdateContentMediaInput>;
+/**
+* Deletes a content-media record.
+* @param input - Media identifier to delete.
+* @returns `null` after deletion.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `deleteContentMedia` in `uses`. This permanently mutates host content after mount.
+* @example await deleteContentMedia({ id: 12 });
+*/
 declare const deleteContentMedia: PortalFunction<null, DeleteContentMediaInput>;
+/**
+* Lists products associated with one content-media record.
+* @param input - Media identifier, pagination, and optional locale.
+* @returns A page of associated products.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `listContentMediaProducts` in `uses` and call it only after mount.
+* @example const products = await listContentMediaProducts({ mediaId: 12, limit: 20 });
+*/
 declare const listContentMediaProducts: PortalFunction<PortalPage<PortalMediaProduct>, ListContentMediaProductsInput>;
+/**
+* Associates a product with content media.
+* @param input - Media and product identifiers.
+* @returns The created {@link PortalMediaProduct} association.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `addContentMediaProduct` in `uses`. This mutates host content after mount.
+* @example const product = await addContentMediaProduct({ mediaId: 12, productId: 42 });
+*/
 declare const addContentMediaProduct: PortalFunction<PortalMediaProduct, AddContentMediaProductInput>;
+/**
+* Removes a product association from content media.
+* @param input - Media and product identifiers.
+* @returns `null` after removal.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `removeContentMediaProduct` in `uses`. This mutates host content after mount.
+* @example await removeContentMediaProduct({ mediaId: 12, productId: 42 });
+*/
 declare const removeContentMediaProduct: PortalFunction<null, RemoveContentMediaProductInput>;
+/**
+* Creates a content playlist.
+* @param input - Playlist title and optional description.
+* @returns The created {@link PortalPlaylist}.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `createContentPlaylist` in `uses`. This mutates host content after mount.
+* @example const playlist = await createContentPlaylist({ title: "Launch" });
+*/
 declare const createContentPlaylist: PortalFunction<PortalPlaylist, CreateContentPlaylistInput>;
+/**
+* Updates a content playlist.
+* @param input - Playlist identifier and fields to replace.
+* @returns The updated {@link PortalPlaylist}.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `updateContentPlaylist` in `uses`. This mutates host content after mount.
+* @example const playlist = await updateContentPlaylist({ id: 5, title: "New launch" });
+*/
 declare const updateContentPlaylist: PortalFunction<PortalPlaylist, UpdateContentPlaylistInput>;
+/**
+* Deletes a content playlist.
+* @param input - Playlist identifier to delete.
+* @returns `null` after deletion.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `deleteContentPlaylist` in `uses`. This permanently mutates host content after mount.
+* @example await deleteContentPlaylist({ id: 5 });
+*/
 declare const deleteContentPlaylist: PortalFunction<null, DeleteContentPlaylistInput>;
+/**
+* Adds a content resource to a playlist.
+* @param input - Playlist, resource kind, resource identifier, and optional position.
+* @returns The created {@link PortalPlaylistItem}.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `addContentPlaylistItem` in `uses`. This mutates host content after mount.
+* @example const item = await addContentPlaylistItem({ playlistId: 5, contentType: "media", contentId: 12 });
+*/
 declare const addContentPlaylistItem: PortalFunction<PortalPlaylistItem, AddContentPlaylistItemInput>;
+/**
+* Removes an item from a content playlist.
+* @param input - Playlist and playlist-item identifiers.
+* @returns `null` after removal.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `removeContentPlaylistItem` in `uses`. This mutates host content after mount.
+* @example await removeContentPlaylistItem({ playlistId: 5, itemId: 8 });
+*/
 declare const removeContentPlaylistItem: PortalFunction<null, RemoveContentPlaylistItemInput>;
+/**
+* Replaces the item order of a content playlist.
+* @param input - Playlist identifier and item-order pairs.
+* @returns `null` after reordering.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `reorderContentPlaylistItems` in `uses`. Send the complete desired order after mount.
+* @example await reorderContentPlaylistItems({ playlistId: 5, items: [{ id: 8, order: 0 }] });
+*/
 declare const reorderContentPlaylistItems: PortalFunction<null, ReorderContentPlaylistItemsInput>;
+/**
+* Creates a share link for a content resource.
+* @param input - Resource kind and identifier to share.
+* @returns The created {@link PortalShare}.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `createContentShare` in `uses`. This creates host data after mount.
+* @example const share = await createContentShare({ shareableType: "media", shareableId: 12 });
+*/
 declare const createContentShare: PortalFunction<PortalShare, CreateContentShareInput>;
+/**
+* Toggles the signed-in member's favorite state for content.
+* @param input - Favorite resource kind and identifier.
+* @returns The resulting {@link PortalContentFavoriteState}.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `toggleContentFavorite` in `uses`. This mutates host data after mount.
+* @example const state = await toggleContentFavorite({ favoriteableType: "Medium", favoriteableId: 12 });
+*/
 declare const toggleContentFavorite: PortalFunction<PortalContentFavoriteState, ToggleContentFavoriteInput>;
+/**
+* Creates a digital-asset record.
+* @param input - Asset name and optional description.
+* @returns The created {@link PortalDamAsset}.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `createDamAsset` in `uses`. This mutates host content after mount.
+* @example const asset = await createDamAsset({ name: "Hero image" });
+*/
 declare const createDamAsset: PortalFunction<PortalDamAsset, CreateDamAssetInput>;
+/**
+* Adds a path to a digital asset.
+* @param input - Stable asset code and path.
+* @returns The created {@link PortalDamAssetPath}.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `createDamAssetPath` in `uses`. This mutates host content after mount.
+* @example const path = await createDamAssetPath({ assetCode: "hero", path: "/images/hero.png" });
+*/
 declare const createDamAssetPath: PortalFunction<PortalDamAssetPath, CreateDamAssetPathInput>;
+/**
+* Marks a digital asset as discarded.
+* @param input - Stable asset code.
+* @returns The updated {@link PortalDamAsset}.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `discardDamAsset` in `uses`. This mutates host content after mount.
+* @example const asset = await discardDamAsset({ assetCode: "hero" });
+*/
 declare const discardDamAsset: PortalFunction<PortalDamAsset, MutateDamAssetInput>;
+/**
+* Permanently deletes a digital asset.
+* @param input - Stable asset code.
+* @returns `null` after deletion.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `deleteDamAsset` in `uses`. This permanently mutates host content after mount.
+* @example await deleteDamAsset({ assetCode: "hero" });
+*/
 declare const deleteDamAsset: PortalFunction<null, MutateDamAssetInput>;
 //#endregion
 //#region src/widgets/remote/contract/capabilities/self.d.ts
+/** Membership identity, representative access, and granted permissions. */
 type PortalMemberAccess = {
-  readonly memberType: "customer" | "rep";
-  readonly slug: string;
-  readonly name: string | null;
-  readonly canAccessRepSurfaces: boolean;
+  /** Customer or representative role. */readonly memberType: "customer" | "rep"; /** Public member slug. */
+  readonly slug: string; /** Display name, if available. */
+  readonly name: string | null; /** Whether representative-only surfaces are available. */
+  readonly canAccessRepSurfaces: boolean; /** Permission names mapped to their granted state. */
   readonly permissions: Readonly<Record<string, boolean>>;
 };
+/** Editable fields for the signed-in account. */
 type UpdateUserAccountInput = {
-  readonly firstName?: string;
-  readonly lastName?: string;
-  readonly bio?: string;
-  readonly avatarUrl?: string;
-  readonly socialLinks?: Readonly<Record<string, string>>;
+  /** New given name. */readonly firstName?: string; /** New family name. */
+  readonly lastName?: string; /** New biography. */
+  readonly bio?: string; /** New avatar URL. */
+  readonly avatarUrl?: string; /** Replacement social-link map. */
+  readonly socialLinks?: Readonly<Record<string, string>>; /** Preferred ISO language code. */
   readonly languageIso?: string;
 };
+/** Todo identity and lifecycle timestamps. */
 type PortalTodoSummary = {
-  readonly id: number;
-  readonly dueAt: string | null;
-  readonly completedAt: string | null;
+  /** Todo identifier. */readonly id: number; /** ISO due timestamp, if set. */
+  readonly dueAt: string | null; /** ISO completion timestamp, if complete. */
+  readonly completedAt: string | null; /** ISO creation timestamp. */
   readonly createdAt: string;
 };
+/** Full todo record. */
 type PortalTodo = PortalTodoSummary & {
-  readonly body: string;
+  /** Todo text. */readonly body: string;
 };
+/** Filters accepted by {@link listTodos}. */
 type ListTodosInput = {
-  readonly state?: "incomplete" | "completed" | "all";
+  /** Completion state to include. */readonly state?: "incomplete" | "completed" | "all";
 };
+/** Fields used to create a todo. */
 type CreateTodoInput = {
-  readonly body: string;
+  /** Todo text. */readonly body: string; /** Optional ISO due timestamp; `null` clears the due date. */
   readonly dueAt?: string | null;
 };
+/** One reward-points ledger transaction. */
 type PortalPointsLedgerEntry = {
-  readonly id: number;
-  readonly amount: number;
-  readonly createdAt: string;
-  readonly transactionType: string | null;
+  /** Ledger entry identifier. */readonly id: number; /** Signed point amount. */
+  readonly amount: number; /** ISO creation timestamp. */
+  readonly createdAt: string; /** Host-defined transaction category, if available. */
+  readonly transactionType: string | null; /** Whether the entry links to a source record. */
   readonly hasSource: boolean;
 };
+/** Current reward-points balance and ledger entries. */
 type PortalPointsLedger = {
-  readonly balance: number;
+  /** Current points balance. */readonly balance: number; /** Ledger entries in host-defined order. */
   readonly entries: readonly PortalPointsLedgerEntry[];
 };
+/** Public MySite profile and aggregate performance values. */
 type PortalMySiteProfile = {
-  readonly id: number;
-  readonly url: string | null;
-  readonly views: number;
-  readonly leads: number;
-  readonly themeId: number | null;
-  readonly bio: string | null;
-  readonly avatarUrl: string | null;
-  readonly displayName: string | null;
+  /** MySite profile identifier. */readonly id: number; /** Public MySite URL, if published. */
+  readonly url: string | null; /** Recorded view count. */
+  readonly views: number; /** Recorded lead count. */
+  readonly leads: number; /** Active theme identifier, if set. */
+  readonly themeId: number | null; /** Profile biography, if set. */
+  readonly bio: string | null; /** Profile avatar URL, if set. */
+  readonly avatarUrl: string | null; /** Public display name, if set. */
+  readonly displayName: string | null; /** Public route slug, if set. */
   readonly slug: string | null;
 };
+/** Editable MySite profile fields. */
 type UpdateMySiteProfileInput = {
-  readonly bio?: string;
-  readonly avatarUrl?: string;
+  /** New biography. */readonly bio?: string; /** New avatar URL. */
+  readonly avatarUrl?: string; /** New display name. */
   readonly displayName?: string;
 };
+/** Editable MySite publication settings. */
 type UpdateMySiteSettingsInput = {
-  readonly themeId?: number;
+  /** Theme identifier to activate. */readonly themeId?: number; /** Public route slug. */
   readonly slug?: string;
 };
+/** Link displayed on a MySite profile. */
 type PortalMySiteLink = {
-  readonly id: number;
-  readonly url: string;
-  readonly title: string;
+  /** Link identifier. */readonly id: number; /** Destination URL. */
+  readonly url: string; /** Visible link title. */
+  readonly title: string; /** Display position. */
   readonly position: number;
 };
+/** Fields used to create a MySite link. */
 type CreateMySiteLinkInput = {
-  readonly url: string;
+  /** Destination URL. */readonly url: string; /** Visible link title. */
   readonly title: string;
 };
+/** Fields used to update a MySite link. */
 type UpdateMySiteLinkInput = {
-  readonly id: number;
-  readonly url?: string;
+  /** Link identifier. */readonly id: number; /** Replacement destination URL. */
+  readonly url?: string; /** Replacement title. */
   readonly title?: string;
 };
+/** Identifies a MySite link to delete. */
 type DeleteMySiteLinkInput = {
-  readonly id: number;
+  /** Link identifier. */readonly id: number;
 };
+/** Defines the complete display order for MySite links. */
 type ReorderMySiteLinksInput = {
-  readonly orderedIds: readonly number[];
+  /** Link identifiers in desired display order. */readonly orderedIds: readonly number[];
 };
+/** Product favorite displayed on a MySite profile. */
 type PortalMySiteFavorite = {
-  readonly id: number;
-  readonly favoriteableId: number;
-  readonly favoriteableType: string;
-  readonly name: string | null;
-  readonly imageUrl: string | null;
-  readonly position: number;
+  /** Favorite record identifier. */readonly id: number; /** Favorited resource identifier. */
+  readonly favoriteableId: number; /** Host resource type. */
+  readonly favoriteableType: string; /** Resource name, if available. */
+  readonly name: string | null; /** Resource image URL, if available. */
+  readonly imageUrl: string | null; /** Display position. */
+  readonly position: number; /** ISO creation timestamp, if available. */
   readonly createdAt: string | null;
 };
+/** Identifies a product to add to MySite favorites. */
 type AddMySiteFavoriteInput = {
-  readonly productId: number;
+  /** Product identifier. */readonly productId: number;
 };
+/** Identifies a MySite favorite to delete. */
 type DeleteMySiteFavoriteInput = {
-  readonly id: number;
+  /** Favorite record identifier. */readonly id: number;
 };
+/** Defines the complete display order for MySite favorites. */
 type ReorderMySiteFavoritesInput = {
-  readonly orderedIds: readonly number[];
+  /** Favorite identifiers in desired display order. */readonly orderedIds: readonly number[];
 };
+/** MySite theme available to the signed-in member. */
 type PortalMySiteTheme = {
-  readonly id: number;
-  readonly name: string;
+  /** Theme identifier. */readonly id: number; /** Theme name. */
+  readonly name: string; /** Theme preview URL, if available. */
   readonly previewUrl: string | null;
 };
+/**
+* Gets access and permissions for the signed-in member.
+* @returns The current {@link PortalMemberAccess}.
+* @throws {@link PortalFunctionError} when undeclared, unavailable, or rejected by the host.
+* @remarks Declare `getMemberAccess` in `uses` and call it only after mount.
+* @example const access = await getMemberAccess();
+*/
 declare const getMemberAccess: PortalFunction<PortalMemberAccess>;
+/**
+* Updates editable fields on the signed-in account.
+* @param input - Account fields to update.
+* @returns The updated {@link UserAccount}.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `updateUserAccount` in `uses`. This mutates host account data after mount.
+* @example const account = await updateUserAccount({ bio: "Hello" });
+*/
 declare const updateUserAccount: PortalFunction<UserAccount, UpdateUserAccountInput>;
+/**
+* Lists todos for the signed-in member.
+* @param input - Optional completion-state filter.
+* @returns Todo summaries matching the filter.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `listTodos` in `uses` and call it only after mount.
+* @example const todos = await listTodos({ state: "incomplete" });
+*/
 declare const listTodos: PortalFunction<readonly PortalTodoSummary[], ListTodosInput>;
+/**
+* Creates a todo for the signed-in member.
+* @param input - Todo text and optional due timestamp.
+* @returns The created {@link PortalTodo}.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `createTodo` in `uses`. This mutates host data after mount.
+* @example const todo = await createTodo({ body: "Follow up" });
+*/
 declare const createTodo: PortalFunction<PortalTodo, CreateTodoInput>;
+/**
+* Gets the reward-points ledger for the signed-in member.
+* @returns The current {@link PortalPointsLedger}.
+* @throws {@link PortalFunctionError} when undeclared, unavailable, or rejected by the host.
+* @remarks Declare `getPointsLedger` in `uses` and call it only after mount.
+* @example const ledger = await getPointsLedger();
+*/
 declare const getPointsLedger: PortalFunction<PortalPointsLedger>;
+/**
+* Gets the MySite profile for the signed-in member.
+* @returns The current {@link PortalMySiteProfile}.
+* @throws {@link PortalFunctionError} when undeclared, unavailable, or rejected by the host.
+* @remarks Declare `getMySiteProfile` in `uses` and call it only after mount.
+* @example const profile = await getMySiteProfile();
+*/
 declare const getMySiteProfile: PortalFunction<PortalMySiteProfile>;
+/**
+* Updates editable MySite profile fields.
+* @param input - Profile fields to update.
+* @returns The updated {@link PortalMySiteProfile}.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `updateMySiteProfile` in `uses`. This mutates host data after mount.
+* @example const profile = await updateMySiteProfile({ displayName: "Ari" });
+*/
 declare const updateMySiteProfile: PortalFunction<PortalMySiteProfile, UpdateMySiteProfileInput>;
+/**
+* Updates MySite publication settings.
+* @param input - Theme or public slug settings to update.
+* @returns `null` after the host applies the settings.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `updateMySiteSettings` in `uses`. This mutates host data after mount.
+* @example await updateMySiteSettings({ themeId: 42 });
+*/
 declare const updateMySiteSettings: PortalFunction<null, UpdateMySiteSettingsInput>;
+/**
+* Lists links on the signed-in member's MySite.
+* @returns MySite links in display order.
+* @throws {@link PortalFunctionError} when undeclared, unavailable, or rejected by the host.
+* @remarks Declare `listMySiteLinks` in `uses` and call it only after mount.
+* @example const links = await listMySiteLinks();
+*/
 declare const listMySiteLinks: PortalFunction<readonly PortalMySiteLink[]>;
+/**
+* Creates a link on the signed-in member's MySite.
+* @param input - Destination URL and visible title.
+* @returns The created {@link PortalMySiteLink}.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `createMySiteLink` in `uses`. This mutates host data after mount.
+* @example const link = await createMySiteLink({ title: "Shop", url: "https://example.com" });
+*/
 declare const createMySiteLink: PortalFunction<PortalMySiteLink, CreateMySiteLinkInput>;
+/**
+* Updates a link on the signed-in member's MySite.
+* @param input - Link identifier and fields to replace.
+* @returns The updated {@link PortalMySiteLink}.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `updateMySiteLink` in `uses`. This mutates host data after mount.
+* @example const link = await updateMySiteLink({ id: 7, title: "New title" });
+*/
 declare const updateMySiteLink: PortalFunction<PortalMySiteLink, UpdateMySiteLinkInput>;
+/**
+* Deletes a link from the signed-in member's MySite.
+* @param input - Link identifier to delete.
+* @returns `null` after deletion.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `deleteMySiteLink` in `uses`. This permanently mutates host data after mount.
+* @example await deleteMySiteLink({ id: 7 });
+*/
 declare const deleteMySiteLink: PortalFunction<null, DeleteMySiteLinkInput>;
+/**
+* Replaces the display order of all MySite links.
+* @param input - Link identifiers in the desired order.
+* @returns Updated links in display order.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `reorderMySiteLinks` in `uses`. Supply the complete order after mount.
+* @example const links = await reorderMySiteLinks({ orderedIds: [7, 3] });
+*/
 declare const reorderMySiteLinks: PortalFunction<readonly PortalMySiteLink[], ReorderMySiteLinksInput>;
+/**
+* Lists product favorites on the signed-in member's MySite.
+* @returns Favorites in display order.
+* @throws {@link PortalFunctionError} when undeclared, unavailable, or rejected by the host.
+* @remarks Declare `listMySiteFavorites` in `uses` and call it only after mount.
+* @example const favorites = await listMySiteFavorites();
+*/
 declare const listMySiteFavorites: PortalFunction<readonly PortalMySiteFavorite[]>;
+/**
+* Adds a product to MySite favorites.
+* @param input - Product identifier to add.
+* @returns The created {@link PortalMySiteFavorite}.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `addMySiteFavorite` in `uses`. This mutates host data after mount.
+* @example const favorite = await addMySiteFavorite({ productId: 42 });
+*/
 declare const addMySiteFavorite: PortalFunction<PortalMySiteFavorite, AddMySiteFavoriteInput>;
+/**
+* Deletes a MySite favorite.
+* @param input - Favorite record identifier to delete.
+* @returns `null` after deletion.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `deleteMySiteFavorite` in `uses`. This permanently mutates host data after mount.
+* @example await deleteMySiteFavorite({ id: 9 });
+*/
 declare const deleteMySiteFavorite: PortalFunction<null, DeleteMySiteFavoriteInput>;
+/**
+* Replaces the display order of all MySite favorites.
+* @param input - Favorite identifiers in the desired order.
+* @returns Updated favorites in display order.
+* @throws {@link PortalFunctionError} when undeclared, invalid, unavailable, or rejected by the host.
+* @remarks Declare `reorderMySiteFavorites` in `uses`. Supply the complete order after mount.
+* @example const favorites = await reorderMySiteFavorites({ orderedIds: [9, 4] });
+*/
 declare const reorderMySiteFavorites: PortalFunction<readonly PortalMySiteFavorite[], ReorderMySiteFavoritesInput>;
+/**
+* Lists themes available to the signed-in member's MySite.
+* @returns Available {@link PortalMySiteTheme} records.
+* @throws {@link PortalFunctionError} when undeclared, unavailable, or rejected by the host.
+* @remarks Declare `listMySiteThemes` in `uses` and call it only after mount.
+* @example const themes = await listMySiteThemes();
+*/
 declare const listMySiteThemes: PortalFunction<readonly PortalMySiteTheme[]>;
 //#endregion
 //#region src/widgets/remote/contract/elements/search-sort.d.ts
@@ -847,17 +1675,39 @@ interface FluidSearchSortOption {
   readonly value: string;
 }
 interface FluidSearchSortElementProperties {
+  /** Current search text displayed by the control. */
   readonly searchValue: string;
+  /** Search-input placeholder. */
   readonly placeholder?: string;
+  /** Sort choices displayed by the control. */
   readonly sortOptions?: readonly FluidSearchSortOption[];
+  /** Value of the selected sort choice. */
   readonly sortValue?: string;
 }
 //#endregion
 //#region src/widgets/remote/worker/elements/SearchSort.d.ts
+/** Props for the worker-safe Portal search and sort control. */
 interface SearchSortProps extends FluidSearchSortElementProperties {
+  /** Called when the search value changes. */
   readonly onSearchChange: (value: string) => void;
+  /** Called when the selected sort value changes. */
   readonly onSortChange?: (value: string) => void;
 }
+/**
+* Renders the Portal-provided search and sort control in a Remote DOM widget.
+*
+* @param props - Search, sort, option, and change-handler configuration.
+* @returns A worker-safe React element backed by the Portal custom element.
+* @remarks Render this component only inside a started Remote DOM widget worker. The Portal host owns its visual implementation.
+* @example
+* ```tsx
+* <SearchSort
+*   searchValue={query}
+*   placeholder="Search products"
+*   onSearchChange={setQuery}
+* />
+* ```
+*/
 declare function SearchSort({
   onSearchChange,
   onSortChange,
@@ -871,10 +1721,24 @@ interface FluidSpacerWidgetElementProperties {
 }
 //#endregion
 //#region src/widgets/remote/worker/elements/FluidSpacerWidget.d.ts
+/** Props for the worker-safe Portal spacer element. */
 interface FluidSpacerWidgetProps {
+  /** Explicit spacer height accepted by the Portal element. */
   readonly customHeight?: FluidSpacerWidgetElementProperties["customHeight"];
+  /** Whether the spacer is rendered in builder preview mode. */
   readonly previewMode?: FluidSpacerWidgetElementProperties["previewMode"];
 }
+/**
+* Renders a Portal spacer inside a Remote DOM widget.
+*
+* @param props - Spacer height and preview state.
+* @returns A worker-safe React element backed by the Portal custom element.
+* @remarks Render this component only inside a started Remote DOM widget worker. The Portal host determines the final layout behavior.
+* @example
+* ```tsx
+* <FluidSpacerWidget customHeight={24} />
+* ```
+*/
 declare function FluidSpacerWidget(props: FluidSpacerWidgetProps): ReactElement;
 //#endregion
 export { type AddContentMediaProductInput, type AddContentPlaylistItemInput, type AddMySiteFavoriteInput, type AnySourceWidget, type CreateContentMediaInput, type CreateContentPlaylistInput, type CreateContentShareInput, type CreateDamAssetInput, type CreateDamAssetPathInput, type CreateMySiteLinkInput, type CreateTodoInput, type DeclarativeCapabilityUse, type DefineWidgetOptions, type DefineWidgetPackageOptions, type DeleteContentMediaInput, type DeleteContentPlaylistInput, type DeleteMySiteFavoriteInput, type DeleteMySiteLinkInput, FluidSpacerWidget, type FluidSpacerWidgetProps, type FullscreenState, type GetAddressFieldsInput, type GetContentMediaInput, type GetEnrollmentPackInput, type GetPageInput, type GetPlaylistInput, type GetProductInput, type ListContentMediaInput, type ListContentMediaProductsInput, type ListContentMetricsInput, type ListCountriesInput, type ListDamAssetPathsInput, type ListPagesInput, type ListPlaylistItemsInput, type ListPlaylistsInput, type ListProductMediaInput, type ListProductMetricsInput, type ListProductsInput, type ListTodosInput, type MutateDamAssetInput, type PortalAddressFields, type PortalAppSummary, type PortalCalendarEvent, type PortalContentFavoriteState, type PortalCountry, type PortalDamAsset, type PortalDamAssetPath, type PortalEnrollmentPack, type PortalEntityId, type PortalFunction, type PortalFunctionDefinition, PortalFunctionError, type PortalFunctionErrorCode, type PortalFunctionHandler, type PortalFunctionImplementation, type PortalFunctionJsonValue, type PortalImage, type PortalLanguage, type PortalMedia, type PortalMediaCta, type PortalMediaProduct, type PortalMemberAccess, type PortalMetric, type PortalMetricsPeriod, type PortalMySiteFavorite, type PortalMySiteLink, type PortalMySiteProfile, type PortalMySiteTheme, type PortalNamedEntitySummary, type PortalNavigationItem, type PortalNavigationState, type PortalNavigationSummary, type PortalNavigationTarget, type PortalPage, type PortalPageContent, type PortalPageDetail, type PortalPageInput, type PortalPlaylist, type PortalPlaylistItem, type PortalPlaylistItemContent, type PortalPlaylistProduct, type PortalPointsLedger, type PortalPointsLedgerEntry, type PortalProduct, type PortalProductMedia, type PortalProductVariant, type PortalProfileSummary, type PortalScreenSummary, type PortalShare, type PortalStore, type PortalSummaryCollection, type PortalTodo, type PortalTodoSummary, type RemoteDomWidgetWorkerController, type RemoveContentMediaProductInput, type RemoveContentPlaylistItemInput, type ReorderContentPlaylistItemsInput, type ReorderMySiteFavoritesInput, type ReorderMySiteLinksInput, type RuntimeSourceWidget, type SearchProductsInput, SearchSort, type SearchSortProps, type SourceWidget, type SourceWidgetPackage, type StartWidgetPackageOptions, type ToggleContentFavoriteInput, type UpdateContentMediaInput, type UpdateContentPlaylistInput, type UpdateMySiteLinkInput, type UpdateMySiteProfileInput, type UpdateMySiteSettingsInput, type UpdateUserAccountInput, type UserAccount, type WidgetSourceCapabilityDeclaration, type WidgetSourceDefaultProps, type WidgetSourcePropertyField, type WidgetSourcePropertySchema, type WidgetSourceResizable, addContentMediaProduct, addContentPlaylistItem, addMySiteFavorite, allowAnchorUrl, buildPortalHref, createContentMedia, createContentPlaylist, createContentShare, createDamAsset, createDamAssetPath, createMySiteLink, createTodo, definePortalFunction, defineWidget, defineWidgetPackage, deleteContentMedia, deleteContentPlaylist, deleteDamAsset, deleteMySiteFavorite, deleteMySiteLink, discardDamAsset, exitFullscreen, getAddressFields, getContentMedia, getEnrollmentPack, getFullscreenState, getMemberAccess, getMySiteProfile, getNavigationState, getPage, getPlaylist, getPointsLedger, getPortalApp, getPortalProfile, getProduct, getStore, getUserAccount, implementPortalFunction, listCalendarEvents, listContentMedia, listContentMediaProducts, listContentMetrics, listCountries, listDamAssetPaths, listDamAssets, listEnrollmentPacks, listLanguages, listMySiteFavorites, listMySiteLinks, listMySiteThemes, listPages, listPlaylistItems, listPlaylists, listProductMedia, listProductMetrics, listProducts, listShares, listTodos, navigateTo, networkAccess, prepareRemoteDomWidgetWorker, removeContentMediaProduct, removeContentPlaylistItem, reorderContentPlaylistItems, reorderMySiteFavorites, reorderMySiteLinks, requestFullscreen, searchProducts, startWidgetPackage, toggleContentFavorite, updateContentMedia, updateContentPlaylist, updateMySiteLink, updateMySiteProfile, updateMySiteSettings, updateUserAccount };