@bettercms-ai/types 1.47.0 → 1.49.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +41 -7
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -364,8 +364,12 @@ type ContentModelFieldPlacement = "cover" | "title" | "excerpt" | "body" | "inli
|
|
|
364
364
|
*/
|
|
365
365
|
interface ShowIfRule {
|
|
366
366
|
field: string;
|
|
367
|
-
/**
|
|
368
|
-
|
|
367
|
+
/**
|
|
368
|
+
* `notEmpty` ≡ `isSet`; `empty` passes while the source holds nothing. Neither reads `value`.
|
|
369
|
+
* `notIn` is `in` negated. `gt` / `lt` compare numbers: `value` is one number as a string, and a
|
|
370
|
+
* source that holds no number fails the rule.
|
|
371
|
+
*/
|
|
372
|
+
op: "eq" | "neq" | "in" | "notIn" | "gt" | "lt" | "isSet" | "notEmpty" | "empty";
|
|
369
373
|
value?: string | string[];
|
|
370
374
|
}
|
|
371
375
|
interface ShowIf {
|
|
@@ -2305,6 +2309,21 @@ interface ComponentPropDef {
|
|
|
2305
2309
|
config?: {
|
|
2306
2310
|
/** `slot` — a pick allowlist. */
|
|
2307
2311
|
componentIds?: string[];
|
|
2312
|
+
/** `slot` — the V2 `of.allow` block names it takes (`textBlock`), kept as written; the dock resolves them to components. */
|
|
2313
|
+
allow?: string[];
|
|
2314
|
+
/**
|
|
2315
|
+
* `array` — the V2 item field's own settings (`of[0]`): help under each item, the locale chip,
|
|
2316
|
+
* required, and a text / rich text item's length (a text item's pattern). Stored markers.
|
|
2317
|
+
*/
|
|
2318
|
+
item?: {
|
|
2319
|
+
helpText?: string;
|
|
2320
|
+
localized?: boolean;
|
|
2321
|
+
required?: boolean;
|
|
2322
|
+
minLength?: number;
|
|
2323
|
+
maxLength?: number;
|
|
2324
|
+
pattern?: string;
|
|
2325
|
+
patternMessage?: string;
|
|
2326
|
+
};
|
|
2308
2327
|
/** `slot` — the value is a list of instances, not one. @see slotItems */
|
|
2309
2328
|
multiple?: boolean;
|
|
2310
2329
|
/** `slot` with `multiple` — bounds on the list. `maxItems` defaults to {@link SLOT_MAX_ITEMS}. */
|
|
@@ -2431,10 +2450,9 @@ interface ComponentSubField {
|
|
|
2431
2450
|
* No `form`: a form in a table row would mean N form documents per component with no way to
|
|
2432
2451
|
* author them — the second field model this design exists to avoid. A `slot` sub-field IS
|
|
2433
2452
|
* accepted by the API (V2 kit entries: an instance in an object or a row, `{ componentId,
|
|
2434
|
-
* overrides? }` at its key, the slot prop's config keys)
|
|
2435
|
-
* assignable to the `packages/db` schema mirror, and widens together with it.
|
|
2453
|
+
* overrides? }` at its key, the slot prop's config keys), and the `packages/db` schema mirror widened with it.
|
|
2436
2454
|
*/
|
|
2437
|
-
type: Exclude<ComponentPropDef["type"], "
|
|
2455
|
+
type: Exclude<ComponentPropDef["type"], "form">;
|
|
2438
2456
|
defaultValue?: unknown;
|
|
2439
2457
|
/** The same editor hints as the prop above, one level down. @see ComponentPropDef */
|
|
2440
2458
|
required?: boolean;
|
|
@@ -2496,6 +2514,8 @@ interface SlotItem extends SlotValue {
|
|
|
2496
2514
|
declare const SLOT_MAX_ITEMS = 12;
|
|
2497
2515
|
/** The most `config.maxItems` may ask for: one placement never expands into more blocks than this. */
|
|
2498
2516
|
declare const SLOT_ITEMS_CAP = 50;
|
|
2517
|
+
/** The most a `table` prop's rows or an `array` prop's items may be bounded to (`config.maxItems`). */
|
|
2518
|
+
declare const LIST_ITEMS_CAP = 500;
|
|
2499
2519
|
/**
|
|
2500
2520
|
* A slot value as a list of its instances, whichever shape it was stored in: `[]` for nothing,
|
|
2501
2521
|
* one item for a single `{ componentId, overrides }`, the array's own items for a `multiple`
|
|
@@ -2525,7 +2545,8 @@ type ComponentStatus = "draft" | "published";
|
|
|
2525
2545
|
/**
|
|
2526
2546
|
* How ONE instance of a component reads as a ROW in a parent's slot list ("Open Rosa Delgado,
|
|
2527
2547
|
* 2 of 5"): the V2 /kit schema's document-level `preview`. `title`, `subtitle` and `media` each
|
|
2528
|
-
* name a TOP-LEVEL prop key
|
|
2548
|
+
* name a TOP-LEVEL prop key, or a dotted path into one (`slides.0.heading`; the API refuses any
|
|
2549
|
+
* other with `preview_key_unknown`); `fallback` is
|
|
2529
2550
|
* the literal row label while the title prop is empty; `icon` the row's icon while it has no media.
|
|
2530
2551
|
* Draft-only authoring chrome: never part of the publish snapshot.
|
|
2531
2552
|
*/
|
|
@@ -2536,6 +2557,17 @@ interface ComponentPreview {
|
|
|
2536
2557
|
fallback?: string;
|
|
2537
2558
|
icon?: DockIconName;
|
|
2538
2559
|
}
|
|
2560
|
+
/**
|
|
2561
|
+
* A V2 /kit schema tab (a `groups` entry) NO top-level prop sits in, declared on the component so
|
|
2562
|
+
* the schema round-trips: V2 hides a tab with no visible top-level field, and so does the dock. A
|
|
2563
|
+
* tab a prop sits in is defined on that prop (`ui.tab`). `order` places it among all the tabs.
|
|
2564
|
+
*/
|
|
2565
|
+
interface ComponentTab {
|
|
2566
|
+
id: string;
|
|
2567
|
+
label: string;
|
|
2568
|
+
icon?: DockIconName;
|
|
2569
|
+
order?: number;
|
|
2570
|
+
}
|
|
2539
2571
|
interface Component {
|
|
2540
2572
|
id: string;
|
|
2541
2573
|
workspaceId: string;
|
|
@@ -2562,6 +2594,8 @@ interface Component {
|
|
|
2562
2594
|
preview?: ComponentPreview | null;
|
|
2563
2595
|
/** The block icon (a /kit schema's document-level `icon`): root crumb, slot rows, slot child frames. Null/absent = unset. */
|
|
2564
2596
|
icon?: DockIconName | null;
|
|
2597
|
+
/** Declared tabs no top-level prop sits in. Null/absent = none. @see ComponentTab */
|
|
2598
|
+
tabs?: ComponentTab[] | null;
|
|
2565
2599
|
status: ComponentStatus;
|
|
2566
2600
|
/** When it left the working set, or null/absent while active. @see ComponentStatus */
|
|
2567
2601
|
archivedAt?: string | Date | null;
|
|
@@ -3777,4 +3811,4 @@ type SectionPlanItem<B> = {
|
|
|
3777
3811
|
*/
|
|
3778
3812
|
declare function planSections<B>(slots: readonly string[], blocks: readonly B[] | null | undefined): SectionPlanItem<B>[];
|
|
3779
3813
|
|
|
3780
|
-
export { type AlignToken, type ApiError, type ApiKey, type ApiKeyPermission, type ApiKeyTokenType, type ArrayZoneConfig, type AssertEqual, type AuthResponse, type AuthSession, type AuthUser, BLOCK_BINDINGS, BREAKPOINTS, BUTTON_ACTIONS, BUTTON_FULL_WIDTH_INVALID, BUTTON_ICONS, BUTTON_ICON_NAMES, BUTTON_LOOK_KEYS, BUTTON_PLACEMENT_KEYS, BUTTON_SIZES, BUTTON_VARIANTS, type BetterCMSErrorCode, type BgToken, type BindingKind, type BlockBinding, type BlockHoverStyle, type BlockStyle, type BlockType, type ButtonAction, type ButtonBlock, type ButtonIcon, type ButtonLinkCandidate, type ButtonLookKey, type ButtonProps, type ButtonSiteLook, type ButtonSizeName, type ButtonValue, type ButtonVariant, CODE_SLOT_PREFIX, COMPONENT_PROP_TYPES, type CanonicalInputDefinition, type ChoiceOption, type CollectionBlock, type CollectionFilter, type CollectionProps, type ColorToken, type ColumnsBlock, type ColumnsProps, type Component, type ComponentBlock, type ComponentCategory, type ComponentFormPropRef, type ComponentPreview, type ComponentPropDef, type ComponentPropType, type ComponentPropUi, type ComponentProps, type ComponentSubField, type ComponentVariantGroup, type Content, type ContentBlock, type ContentEntry, type ContentModel, type ContentModelField, type ContentModelFieldType, type ContentModelFieldUi, type ContentPageResult, type ContentResponse, type ContentWidthToken, type CornerToken, DIALOG_SELECTOR, DOCK_BUDGET, DOCK_ICON_NAMES, DOCK_ICON_NAME_SET, type DeepReadonly, type DeliveredLayout, type DeliveryComponent, type DeliveryEntry, type DeliveryEntrySeo, type DeliveryList, type DeliveryPage, type DerivedLocator, type DockBudget, type DockFieldLike, type DockFieldsetLike, type DockIconName, type DockInputRef, type DockLane, type DockNode, type DockPropGroupLike, type DockScreen, type ElementLike, type ExpandedBinding, FIELD_SIZE_ZOOM, FIELD_STYLE_KEYS, FOOTER_SECTION_ID, type FieldConfig, type FieldSize, type FieldStyle, type FieldStyleKey, type FieldStyles, type Fieldset, type FieldsetKind, type FieldsetUiBefore, type FontSizeToken, type FooterBlock, type FooterColumn, type FooterProps, type Form, type FormBlock, type FormField, type FormProps, type FormSubmission, type HeadingBlock, type HeadingProps, IMAGE_ASPECTS, IMAGE_FRAME_RADIUS, type ImageAspect, type ImageBlock, type ImageProps, LANDMARK_SELECTOR, LAYOUT_SECTION_ICONS, LAYOUT_SECTION_ICON_SET, LINK_RELS, LINK_VALUE_TYPES, type LandmarkChainElement, type LandmarkElement, type LayoutComponentItem, type LayoutDataDocument, type LayoutFieldDefinition, type LayoutFieldItem, type LayoutFieldType, type LayoutScalarFieldType, type LayoutSection, type LayoutSectionIcon, type LayoutSectionItem, type LayoutStructureDocument, type LayoutZone, type LinkRel, type LinkValue, type LinkValueType, type LocatorGrammar, MAIN_SELECTOR, type ManagementLayoutCommand, type MediaAsset, type MediaCaptionTrack, type MediaFieldValue, NAVIGATION_SECTION_ID, type NavLink, type NavbarBlock, type NavbarProps, type NumberFieldFormat, type NumberScale, OPTION_DESCRIPTION_MAX, type OpenMode, PAGE_CONTENT_ANCHOR_ID, type Page, type PageLayoutOverrideDataDocument, type PageLayoutOverrideDocument, type PageLayoutOverrideState, type PageLayoutOverrideStructureDocument, type PageLayoutSectionOverride, type PageLayoutSectionStructureOverride, type PageMetaJson, type PageOnlyLayoutSection, type PageSectionPlacement, type PaginatedResult, type Perspective, type PortableTextDocument, type PortableTextNode, type PropGroup, type PropTab, RESPONSIVE_CSS, type RadiusToken, type ReadButtonValue, type Redirect, type ReservedLayoutSection, type ResolvedLayoutNode, type RichTextBlock, type RichTextProps, SECTION_DOCTRINE, SECTION_SPACE_TOKENS, SIDE_SPACE_MIN_PX, SIDE_SPACE_TOKENS, SLOT_CHILD_KEYS, SLOT_ITEMS_CAP, SLOT_MAX_ITEMS, SPACE_BOTTOM_TOKENS, SPACE_STEP_TOKENS, type ScaleUnit, type SectionBlock, type SectionPlanItem, type SectionProps, type SectionSpaceToken, type ShadowToken, type ShowIf, type ShowIfRule, type SignInInput, type SignUpInput, type SiteSeoDefaults, type SlideItem, type SliderBlock, type SliderProps, type SlotChild, type SlotItem, type SlotShapeOptions, type SlotShapeProblem, type SlotValue, type SpaceStepToken, type SpaceToken, type SpacerBlock, type SpacerProps, TABLE_COLUMN_TYPES, TABLE_JSONLD_TYPES, TABLE_LIMITS, TABLE_RESPONSIVE, TAG_HEADS, type TabItem, type TableCell, type TableCellObject, type TableCellValue, type TableCheckOptions, type TableColumn, type TableColumnType, type TableFieldOptions, type TableFootnote, type TableGroup, type TableLink, type TableProblem, type TableRef, type TableRefResolved, type TableRow, type TableValue, type TabsBlock, type TabsProps, type TextBlock, type TextProps, type ThemeToken, type UiBefore, type UiOrigin, VIDEO_TRANSCRIPT_MAX, VIDEO_VALUE_KEYS, type VariantInputMapping, type VideoBlock, type VideoProps, type VideoValue, type VisibilityWindow, type WeightToken, type WindowState, type Workspace, type ZoneField, anchorTargetRel, blockStyleToColumnCss, blockStyleToCss, blockStyleToInnerCss, buttonBlockProps, buttonFullWidthProblem, buttonIconOf, buttonIconSvg, buttonLinkPairs, buttonLookValue, buttonSiteLookOf, buttonValueOfInstance, buttonValueProblem, buttonVariantOf, candidateRole, componentInstanceAddresses, componentPropTargetKey, derivedPairs, dockBudget, dockScreens, expandBlockBindings, fieldGroupOf, fieldStyleCssText, fieldStyleToCss, formatNumber, formatPropsAttribute, getBlockType, headingPaintCss, hiddenEverywhere, hideOnAttr, imageFrameCss, inWindow, isBlock, isButtonLookValue, isChromeLandmark, isCodeButton, isLinkObject, isScriptHref, isSlotChild, isTableValue, keyWords, landmarkRegions, linkAnchorOf, linkHref, linkRefOf, linkValueProblem, locatorFor, normalizeLinkValue, normalizeTableValue, normalizeWindow, parseNumberText, parsePropsAttribute, pickFieldStyle, placementBindOf, planSections, readButtonValue, readNumberFormat, readPath, regionOf, renderTableHtml, safeCssUrl, sideFloorApplies, sideSpaceCss, slotBindOf, slotChildValues, slotItems, slotPathString, slotShapeProblems, spaceTokenCss, splitButtonStyle, tableCellText, tablePathString, tableRefCells, tableSearchText, tableToMarkdown, tableValueProblems, topFieldKeyOf, usesHideOn, videoUrlOf, videoValueProblem, visibleBlocks, visibleDeliveredLayout, visibleLayoutStructure, windowState, withButtonLookProps };
|
|
3814
|
+
export { type AlignToken, type ApiError, type ApiKey, type ApiKeyPermission, type ApiKeyTokenType, type ArrayZoneConfig, type AssertEqual, type AuthResponse, type AuthSession, type AuthUser, BLOCK_BINDINGS, BREAKPOINTS, BUTTON_ACTIONS, BUTTON_FULL_WIDTH_INVALID, BUTTON_ICONS, BUTTON_ICON_NAMES, BUTTON_LOOK_KEYS, BUTTON_PLACEMENT_KEYS, BUTTON_SIZES, BUTTON_VARIANTS, type BetterCMSErrorCode, type BgToken, type BindingKind, type BlockBinding, type BlockHoverStyle, type BlockStyle, type BlockType, type ButtonAction, type ButtonBlock, type ButtonIcon, type ButtonLinkCandidate, type ButtonLookKey, type ButtonProps, type ButtonSiteLook, type ButtonSizeName, type ButtonValue, type ButtonVariant, CODE_SLOT_PREFIX, COMPONENT_PROP_TYPES, type CanonicalInputDefinition, type ChoiceOption, type CollectionBlock, type CollectionFilter, type CollectionProps, type ColorToken, type ColumnsBlock, type ColumnsProps, type Component, type ComponentBlock, type ComponentCategory, type ComponentFormPropRef, type ComponentPreview, type ComponentPropDef, type ComponentPropType, type ComponentPropUi, type ComponentProps, type ComponentSubField, type ComponentTab, type ComponentVariantGroup, type Content, type ContentBlock, type ContentEntry, type ContentModel, type ContentModelField, type ContentModelFieldType, type ContentModelFieldUi, type ContentPageResult, type ContentResponse, type ContentWidthToken, type CornerToken, DIALOG_SELECTOR, DOCK_BUDGET, DOCK_ICON_NAMES, DOCK_ICON_NAME_SET, type DeepReadonly, type DeliveredLayout, type DeliveryComponent, type DeliveryEntry, type DeliveryEntrySeo, type DeliveryList, type DeliveryPage, type DerivedLocator, type DockBudget, type DockFieldLike, type DockFieldsetLike, type DockIconName, type DockInputRef, type DockLane, type DockNode, type DockPropGroupLike, type DockScreen, type ElementLike, type ExpandedBinding, FIELD_SIZE_ZOOM, FIELD_STYLE_KEYS, FOOTER_SECTION_ID, type FieldConfig, type FieldSize, type FieldStyle, type FieldStyleKey, type FieldStyles, type Fieldset, type FieldsetKind, type FieldsetUiBefore, type FontSizeToken, type FooterBlock, type FooterColumn, type FooterProps, type Form, type FormBlock, type FormField, type FormProps, type FormSubmission, type HeadingBlock, type HeadingProps, IMAGE_ASPECTS, IMAGE_FRAME_RADIUS, type ImageAspect, type ImageBlock, type ImageProps, LANDMARK_SELECTOR, LAYOUT_SECTION_ICONS, LAYOUT_SECTION_ICON_SET, LINK_RELS, LINK_VALUE_TYPES, LIST_ITEMS_CAP, type LandmarkChainElement, type LandmarkElement, type LayoutComponentItem, type LayoutDataDocument, type LayoutFieldDefinition, type LayoutFieldItem, type LayoutFieldType, type LayoutScalarFieldType, type LayoutSection, type LayoutSectionIcon, type LayoutSectionItem, type LayoutStructureDocument, type LayoutZone, type LinkRel, type LinkValue, type LinkValueType, type LocatorGrammar, MAIN_SELECTOR, type ManagementLayoutCommand, type MediaAsset, type MediaCaptionTrack, type MediaFieldValue, NAVIGATION_SECTION_ID, type NavLink, type NavbarBlock, type NavbarProps, type NumberFieldFormat, type NumberScale, OPTION_DESCRIPTION_MAX, type OpenMode, PAGE_CONTENT_ANCHOR_ID, type Page, type PageLayoutOverrideDataDocument, type PageLayoutOverrideDocument, type PageLayoutOverrideState, type PageLayoutOverrideStructureDocument, type PageLayoutSectionOverride, type PageLayoutSectionStructureOverride, type PageMetaJson, type PageOnlyLayoutSection, type PageSectionPlacement, type PaginatedResult, type Perspective, type PortableTextDocument, type PortableTextNode, type PropGroup, type PropTab, RESPONSIVE_CSS, type RadiusToken, type ReadButtonValue, type Redirect, type ReservedLayoutSection, type ResolvedLayoutNode, type RichTextBlock, type RichTextProps, SECTION_DOCTRINE, SECTION_SPACE_TOKENS, SIDE_SPACE_MIN_PX, SIDE_SPACE_TOKENS, SLOT_CHILD_KEYS, SLOT_ITEMS_CAP, SLOT_MAX_ITEMS, SPACE_BOTTOM_TOKENS, SPACE_STEP_TOKENS, type ScaleUnit, type SectionBlock, type SectionPlanItem, type SectionProps, type SectionSpaceToken, type ShadowToken, type ShowIf, type ShowIfRule, type SignInInput, type SignUpInput, type SiteSeoDefaults, type SlideItem, type SliderBlock, type SliderProps, type SlotChild, type SlotItem, type SlotShapeOptions, type SlotShapeProblem, type SlotValue, type SpaceStepToken, type SpaceToken, type SpacerBlock, type SpacerProps, TABLE_COLUMN_TYPES, TABLE_JSONLD_TYPES, TABLE_LIMITS, TABLE_RESPONSIVE, TAG_HEADS, type TabItem, type TableCell, type TableCellObject, type TableCellValue, type TableCheckOptions, type TableColumn, type TableColumnType, type TableFieldOptions, type TableFootnote, type TableGroup, type TableLink, type TableProblem, type TableRef, type TableRefResolved, type TableRow, type TableValue, type TabsBlock, type TabsProps, type TextBlock, type TextProps, type ThemeToken, type UiBefore, type UiOrigin, VIDEO_TRANSCRIPT_MAX, VIDEO_VALUE_KEYS, type VariantInputMapping, type VideoBlock, type VideoProps, type VideoValue, type VisibilityWindow, type WeightToken, type WindowState, type Workspace, type ZoneField, anchorTargetRel, blockStyleToColumnCss, blockStyleToCss, blockStyleToInnerCss, buttonBlockProps, buttonFullWidthProblem, buttonIconOf, buttonIconSvg, buttonLinkPairs, buttonLookValue, buttonSiteLookOf, buttonValueOfInstance, buttonValueProblem, buttonVariantOf, candidateRole, componentInstanceAddresses, componentPropTargetKey, derivedPairs, dockBudget, dockScreens, expandBlockBindings, fieldGroupOf, fieldStyleCssText, fieldStyleToCss, formatNumber, formatPropsAttribute, getBlockType, headingPaintCss, hiddenEverywhere, hideOnAttr, imageFrameCss, inWindow, isBlock, isButtonLookValue, isChromeLandmark, isCodeButton, isLinkObject, isScriptHref, isSlotChild, isTableValue, keyWords, landmarkRegions, linkAnchorOf, linkHref, linkRefOf, linkValueProblem, locatorFor, normalizeLinkValue, normalizeTableValue, normalizeWindow, parseNumberText, parsePropsAttribute, pickFieldStyle, placementBindOf, planSections, readButtonValue, readNumberFormat, readPath, regionOf, renderTableHtml, safeCssUrl, sideFloorApplies, sideSpaceCss, slotBindOf, slotChildValues, slotItems, slotPathString, slotShapeProblems, spaceTokenCss, splitButtonStyle, tableCellText, tablePathString, tableRefCells, tableSearchText, tableToMarkdown, tableValueProblems, topFieldKeyOf, usesHideOn, videoUrlOf, videoValueProblem, visibleBlocks, visibleDeliveredLayout, visibleLayoutStructure, windowState, withButtonLookProps };
|
package/dist/index.js
CHANGED
|
@@ -593,6 +593,7 @@ var COMPONENT_PROP_TYPES = [
|
|
|
593
593
|
];
|
|
594
594
|
var SLOT_MAX_ITEMS = 12;
|
|
595
595
|
var SLOT_ITEMS_CAP = 50;
|
|
596
|
+
var LIST_ITEMS_CAP = 500;
|
|
596
597
|
function slotItems(value) {
|
|
597
598
|
const list = Array.isArray(value) ? value : [value];
|
|
598
599
|
const out = [];
|
|
@@ -4321,6 +4322,7 @@ export {
|
|
|
4321
4322
|
LAYOUT_SECTION_ICON_SET,
|
|
4322
4323
|
LINK_RELS,
|
|
4323
4324
|
LINK_VALUE_TYPES,
|
|
4325
|
+
LIST_ITEMS_CAP,
|
|
4324
4326
|
MAIN_SELECTOR,
|
|
4325
4327
|
NAVIGATION_SECTION_ID,
|
|
4326
4328
|
OPTION_DESCRIPTION_MAX,
|