@phis/ui 0.4.1 → 0.4.3

package/plugins/runtime-modules/core/widgets/card/config.d.ts

@@ -1,6 +1,8 @@
+import type { PhiCmsConfigField } from "../../../../../types/cms-plugins";
 import type { PhiImageAssetVariantKeyValue } from "../../../../../types/media";
 import { type PhiLinkTarget } from "../../../../../types/references";
-import { type PhiCardHeadingLevel, type PhiCardHoverEffect, type PhiCardIconPlacement, type PhiCardTextAlign, type PhiCardVariant, type PhiCardWidgetBody } from "../../../../../components/widgets/shared/card-vocabulary";
+import { type PhiBulletListEntry, type PhiBulletListStyle } from "../../../../../components/widgets/shared/bullet-list-vocabulary";
+import { type PhiCardBillingPeriod, type PhiCardHeadingLevel, type PhiCardHoverEffect, type PhiCardIconPlacement, type PhiCardTextAlign, type PhiCardVariant, type PhiCardWidgetBody } from "../../../../../components/widgets/shared/card-vocabulary";
 import { type PhiSignalRouteSet } from "../../../../../types/signals";
 import { type PhiCmsWidgetConfigBase } from "../../../../../components/widgets/config/parser-primitives";
 type PhiCardImageSource = {
@@ -21,6 +23,21 @@ export type PhiCmsCardWidgetConfig = PhiCmsWidgetConfigBase & PhiCardImageSource
     body?: PhiCardWidgetBody;
     /** The figure a `stat` body draws. Never translated, whatever the node's `NoTranslate` flag says. */
     value?: string;
+    /** The words on the band at the card's end edge; any body may carry one. */
+    badge?: string;
+    /** The band's colour; absent, the Theme's primary. */
+    badgeColor?: string;
+    /** A `plan` body's prices, never translated, and what each is paid per (`/ month`), which is. */
+    price?: string;
+    pricePeriod?: string;
+    priceYearly?: string;
+    pricePeriodYearly?: string;
+    /** Which of the two prices a `plan` shows until the page sends another. Absent is `monthly`. */
+    billingPeriod?: PhiCardBillingPeriod;
+    /** What a `plan` includes and what it does not, each entry with its state. */
+    features?: PhiBulletListEntry[];
+    /** How the features list is set (`bullet-list-vocabulary.ts`). */
+    featureList?: PhiBulletListStyle;
     /** The tag of the heading; how large it is drawn is the variant's business. */
     headingLevel?: PhiCardHeadingLevel;
     textAlign?: PhiCardTextAlign;
@@ -64,7 +81,7 @@ export declare const PHI_CARD_WIDGET_DEFINITION: {
     icon: string;
     iconFamily: string;
     translatesOwnText: true;
-    slotSizePolicy: "fill-inline";
+    slotSizePolicy: "fill";
     surface: "own";
     runtimeSignals: {
         emits: {
@@ -114,292 +131,317 @@ export declare const PHI_CARD_WIDGET_DEFINITION: {
         headingLevel: "h3";
         textAlign: "start";
     };
-    fields: ({
+    fields: (({
         key: string;
-        type: "choice";
-        heading: string;
         label: string;
-        options: {
-            value: string;
-            label: string;
-        }[];
-        visibleWhen?: undefined;
-        presentation?: undefined;
-        min?: undefined;
-        max?: undefined;
-        step?: undefined;
-        suffix?: undefined;
-        mode?: undefined;
-        defaultToken?: undefined;
-        clearsWhenEmpty?: undefined;
-        emptyValue?: undefined;
-    } | {
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "string" | "url" | "icon";
+        emptyValue?: "";
+    }) | ({
         key: string;
-        type: "choice";
         label: string;
-        visibleWhen: {
-            field: string;
-            notEquals: string;
-            equals?: undefined;
-        };
-        presentation: "segmented";
-        options: {
-            value: string;
-            label: string;
-        }[];
-        heading?: undefined;
-        min?: undefined;
-        max?: undefined;
-        step?: undefined;
-        suffix?: undefined;
-        mode?: undefined;
-        defaultToken?: undefined;
-        clearsWhenEmpty?: undefined;
-        emptyValue?: undefined;
-    } | {
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "link-target";
+        clearsWhenEmpty?: readonly string[];
+    }) | ({
         key: string;
-        type: "image";
-        heading: string;
         label: string;
-        options?: undefined;
-        visibleWhen?: undefined;
-        presentation?: undefined;
-        min?: undefined;
-        max?: undefined;
-        step?: undefined;
-        suffix?: undefined;
-        mode?: undefined;
-        defaultToken?: undefined;
-        clearsWhenEmpty?: undefined;
-        emptyValue?: undefined;
-    } | {
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "readonly";
+    }) | ({
         key: string;
-        type: "number";
         label: string;
-        presentation: "slider";
-        min: number;
-        max: number;
-        step: number;
-        suffix: string;
-        heading?: undefined;
-        options?: undefined;
-        visibleWhen?: undefined;
-        mode?: undefined;
-        defaultToken?: undefined;
-        clearsWhenEmpty?: undefined;
-        emptyValue?: undefined;
-    } | {
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "data-provider";
+        providerKind?: import("../../../../../types").PhiRuntimeDataProviderKind;
+        providerKey?: import("@phis/contracts/controls").PhiRuntimeDataProviderKey;
+    }) | ({
         key: string;
-        type: "icon";
-        heading: string;
         label: string;
-        options?: undefined;
-        visibleWhen?: undefined;
-        presentation?: undefined;
-        min?: undefined;
-        max?: undefined;
-        step?: undefined;
-        suffix?: undefined;
-        mode?: undefined;
-        defaultToken?: undefined;
-        clearsWhenEmpty?: undefined;
-        emptyValue?: undefined;
-    } | {
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "calendar-adapter";
+    }) | ({
         key: string;
-        type: "choice";
         label: string;
-        options: {
-            value: string;
-            label: string;
-        }[];
-        visibleWhen: ({
-            field: string;
-            notEquals: null;
-        } | {
-            field: string;
-            notEquals: string;
-        })[];
-        heading?: undefined;
-        presentation?: undefined;
-        min?: undefined;
-        max?: undefined;
-        step?: undefined;
-        suffix?: undefined;
-        mode?: undefined;
-        defaultToken?: undefined;
-        clearsWhenEmpty?: undefined;
-        emptyValue?: undefined;
-    } | {
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "video-provider";
+    }) | ({
         key: string;
-        type: "color";
         label: string;
-        mode: "single";
-        defaultToken: "colorTextSecondary";
-        visibleWhen: {
-            field: string;
-            notEquals: null;
-            equals?: undefined;
-        };
-        heading?: undefined;
-        options?: undefined;
-        presentation?: undefined;
-        min?: undefined;
-        max?: undefined;
-        step?: undefined;
-        suffix?: undefined;
-        clearsWhenEmpty?: undefined;
-        emptyValue?: undefined;
-    } | {
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "dimension";
+        widthKey?: string;
+        heightKey?: string;
+        widthPlaceholder?: string;
+        heightPlaceholder?: string;
+        patchOnChange?: Record<string, unknown>;
+    }) | ({
+        key: string;
+        label: string;
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "length";
+        min?: number;
+        max?: number;
+        step?: number;
+        precision?: number;
+    }) | ({
         key: string;
+        label: string;
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "radius";
+        topLeftKey: string;
+        topRightKey: string;
+        bottomLeftKey: string;
+        bottomRightKey: string;
+    }) | ({
+        key: string;
+        label: string;
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "padding";
+        paddingKey?: string;
+        gapKey?: string;
+        paddingTopKey?: string;
+        paddingRightKey?: string;
+        paddingBottomKey?: string;
+        paddingLeftKey?: string;
+        section?: string;
+    }) | ({
+        key: string;
+        label: string;
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
         type: "color";
+        mode?: import("../../../../../types").PhiCmsConfigFieldColorMode;
+        defaultToken?: import("../../../../../theme/phi-theme-tokens").PhiThemeTokenKey;
+        section?: string;
+    }) | ({
+        key: string;
         label: string;
-        mode: "single";
-        defaultToken: "colorFillQuaternary";
-        visibleWhen: {
-            field: string;
-            notEquals: null;
-            equals?: undefined;
-        };
-        heading?: undefined;
-        options?: undefined;
-        presentation?: undefined;
-        min?: undefined;
-        max?: undefined;
-        step?: undefined;
-        suffix?: undefined;
-        clearsWhenEmpty?: undefined;
-        emptyValue?: undefined;
-    } | {
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "boolean";
+    }) | ({
         key: string;
-        type: "link-target";
-        heading: string;
         label: string;
-        clearsWhenEmpty: string[];
-        options?: undefined;
-        visibleWhen?: undefined;
-        presentation?: undefined;
-        min?: undefined;
-        max?: undefined;
-        step?: undefined;
-        suffix?: undefined;
-        mode?: undefined;
-        defaultToken?: undefined;
-        emptyValue?: undefined;
-    } | {
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "image";
+    }) | ({
         key: string;
-        type: "choice";
         label: string;
-        presentation: "segmented";
-        visibleWhen: {
-            field: string;
-            notEquals: null;
-            equals?: undefined;
-        };
-        options: {
-            value: string;
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "slot-texts";
+    }) | ({
+        key: string;
+        label: string;
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "number-list";
+        min?: number;
+    }) | ({
+        key: string;
+        label: string;
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "flags";
+        options: readonly {
+            value: number;
             label: string;
         }[];
-        heading?: undefined;
-        min?: undefined;
-        max?: undefined;
-        step?: undefined;
-        suffix?: undefined;
-        mode?: undefined;
-        defaultToken?: undefined;
-        clearsWhenEmpty?: undefined;
-        emptyValue?: undefined;
-    } | {
+    }) | ({
         key: string;
-        type: "boolean";
-        heading: string;
         label: string;
-        options?: undefined;
-        visibleWhen?: undefined;
-        presentation?: undefined;
-        min?: undefined;
-        max?: undefined;
-        step?: undefined;
-        suffix?: undefined;
-        mode?: undefined;
-        defaultToken?: undefined;
-        clearsWhenEmpty?: undefined;
-        emptyValue?: undefined;
-    } | {
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "number";
+        min?: number;
+        max?: number;
+        step?: number;
+        precision?: number;
+        prefix?: string;
+        presentation?: "slider";
+        suffix?: string;
+    }) | ({
         key: string;
-        type: "string";
         label: string;
-        emptyValue: "";
-        visibleWhen: {
-            field: string;
-            equals: true;
-            notEquals?: undefined;
-        };
-        heading?: undefined;
-        options?: undefined;
-        presentation?: undefined;
-        min?: undefined;
-        max?: undefined;
-        step?: undefined;
-        suffix?: undefined;
-        mode?: undefined;
-        defaultToken?: undefined;
-        clearsWhenEmpty?: undefined;
-    } | {
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "choice";
+        valueType: "number";
+        options: import("@phis/contracts/controls").PhiControlOption<number>[];
+        emptyOption?: import("@phis/contracts/controls").PhiControlOption;
+        emptyValue?: null | undefined;
+        placeholder?: string;
+        mode?: never;
+        presentation?: never;
+        optionsProvider?: never;
+        allowCustom?: never;
+        createBehavior?: never;
+        filter?: never;
+        patchOnChange?: never;
+        optionPresets?: never;
+    }) | ({
         key: string;
-        type: "icon";
         label: string;
-        visibleWhen: {
-            field: string;
-            equals: true;
-            notEquals?: undefined;
-        };
-        heading?: undefined;
-        options?: undefined;
-        presentation?: undefined;
-        min?: undefined;
-        max?: undefined;
-        step?: undefined;
-        suffix?: undefined;
-        mode?: undefined;
-        defaultToken?: undefined;
-        clearsWhenEmpty?: undefined;
-        emptyValue?: undefined;
-    } | {
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "choice";
+        mode?: import("../../../../../types").PhiCmsConfigFieldChoiceMode;
+        valueType?: Exclude<import("../../../../../types").PhiCmsConfigFieldChoiceValueType, "number">;
+        presentation?: import("../../../../../types").PhiCmsConfigFieldChoicePresentation;
+        options?: import("@phis/contracts/controls").PhiControlOption[];
+        optionsProvider?: import("@phis/contracts/controls").PhiControlOptionsProviderConfig;
+        allowCustom?: boolean;
+        createBehavior?: import("../../../../../types").PhiCmsConfigFieldChoiceCreateBehavior;
+        placeholder?: string;
+        filter?: import("../../../../../types").PhiCmsConfigFieldChoiceFilter;
+        emptyOption?: import("@phis/contracts/controls").PhiControlOption;
+        emptyValue?: null | undefined;
+        patchOnChange?: Record<string, unknown>;
+        optionPresets?: import("../../../../../types/cms-plugins").PhiCmsConfigFieldOptionPresets;
+    }) | ({
         key: string;
-        type: "link-target";
         label: string;
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "collection";
+        itemKeyField: string;
+        itemLabelField?: string;
+        itemFields: PhiCmsConfigField[];
+        defaultItem?: Record<string, unknown>;
+        addLabel?: string;
+        emptyLabel?: string;
+        minItems?: number;
+        maxItems?: number;
+        reorderable?: boolean;
+        presentation?: import("../../../../../types").PhiCmsConfigFieldCollectionPresentation;
+        editLabel?: string;
+    }) | ({
+        key: string;
+        label: string;
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "surface";
+        tone?: false;
+    }) | ({
+        key: string;
+        label: string;
+        description?: string;
+        required?: boolean;
+        editorPlacement?: "inspector" | "geometry" | "toolbar";
+        visibleWhen?: import("../../../../../types").PhiCmsConfigFieldVisibilityRule | readonly import("../../../../../types").PhiCmsConfigFieldVisibilityRule[];
+        heading?: string;
+    } & {
+        type: "grid-placement" | "column-count";
+        section?: string;
+    }) | {
+        key: string;
+        type: "choice";
+        label: string;
+        presentation: "segmented";
+        options: {
+            value: "h2" | "h3" | "h4";
+            label: string;
+        }[];
         visibleWhen: {
             field: string;
-            equals: true;
-            notEquals?: undefined;
+            notEquals: null;
         };
-        heading?: undefined;
-        options?: undefined;
-        presentation?: undefined;
-        min?: undefined;
-        max?: undefined;
-        step?: undefined;
-        suffix?: undefined;
-        mode?: undefined;
-        defaultToken?: undefined;
-        clearsWhenEmpty?: undefined;
-        emptyValue?: undefined;
-    } | {
-        key: string;
-        type: "boolean";
-        label: string;
-        heading?: undefined;
-        options?: undefined;
-        visibleWhen?: undefined;
-        presentation?: undefined;
-        min?: undefined;
-        max?: undefined;
-        step?: undefined;
-        suffix?: undefined;
-        mode?: undefined;
-        defaultToken?: undefined;
-        clearsWhenEmpty?: undefined;
-        emptyValue?: undefined;
     })[];
     parseConfig: typeof parsePhiCmsCardWidgetConfig;
 };