@vectoriox/iox-ui 5.50.0 → 5.52.0

package/generation-core/index.d.ts

@@ -2854,6 +2854,8 @@ declare enum StepState {
 /** What a build creates, as Undo walks it. */
 declare enum CreatedKind {
     ContentType = "content-type",
+    /** Fields the build added to a content type it found (types are shared by every organization of a studio). */
+    ContentTypeFields = "content-type-fields",
     SampleImage = "sample-image",
     Item = "item",
     DataSource = "data-source",
@@ -2865,7 +2867,9 @@ declare enum CreatedKind {
 declare enum KeptReason {
     Edited = "edited",
     Published = "published",
-    InUse = "in-use"
+    InUse = "in-use",
+    /** Added to a content type every organization shares: removing a field is the studio owner's change. */
+    Shared = "shared"
 }
 interface BuildStepError {
     code: string;
@@ -2890,6 +2894,8 @@ interface CreatedRecord {
     contentType?: string;
     /** A sample image's public URL — what items and pages reference. */
     url?: string;
+    /** `content-type-fields`: the fields the build added. */
+    fields?: string[];
 }
 interface UndoKept {
     kind: CreatedKind;
@@ -2910,7 +2916,9 @@ interface UndoRecord {
 }
 declare enum BuildNoticeCode {
     /** Storage is not configured: sample items get the empty image box, and the run says so. */
-    NoStorage = "no-storage"
+    NoStorage = "no-storage",
+    /** A content type the build reuses is not public in this studio: the site will not show its items. */
+    ContentTypeNotPublic = "content-type-not-public"
 }
 interface BuildNotice {
     code: string;
@@ -2948,12 +2956,13 @@ declare enum PreflightRefusalCode {
     InvalidPlan = "invalid-plan",
     /** A route the plan wants is already a page of this organization. */
     RouteTaken = "route-taken",
-    /** A content type of that name exists in this instance (content types are instance-wide). */
-    ContentTypeTaken = "content-type-taken",
+    /** The studio's content type of that name stores a field the plan needs differently (type or control) —
+     *  types are shared by every organization, so the build reuses one it finds and adds what it lacks. */
+    ContentTypeConflict = "content-type-conflict",
     /** The name may not be a content type (a platform collection, or not a valid name). */
     ContentTypeName = "content-type-name",
-    /** Content types act on the whole instance: only the instance owner may create them (SEC1). */
-    ContentTypesNeedInstanceOwner = "content-types-need-instance-owner",
+    /** The plan creates a content type or adds fields to one, and the caller may not (an org owner/admin — schema_all). */
+    ContentTypesNeedPermission = "content-types-need-permission",
     /** The org library holds the alias with a different definition. */
     DataSourceConflict = "data-source-conflict",
     /** The studio has pages AND a header/footer: replace or keep them is the caller's choice (D7). */
@@ -2976,6 +2985,7 @@ interface PreflightRefusal {
  */
 declare const buildKeys: {
     readonly contentType: (name: string) => string;
+    readonly contentTypeFields: (name: string) => string;
     readonly item: (contentType: string, n: number) => string;
     readonly sampleImage: (n: number) => string;
     readonly dataSource: (alias: string) => string;
@@ -2989,10 +2999,20 @@ declare function builtHomePageId(run: Pick<SiteBuildRun, 'plan' | 'created'> | n
 declare function failedBuildStep(run: Pick<SiteBuildRun, 'steps'> | null | undefined): BuildStepRecord | null;
 /** A run still holding the org's slot (building or undoing) — a page that left it comes back to its progress. */
 declare function isActiveBuild(run: Pick<SiteBuildRun, 'status'> | null | undefined): boolean;
-/** What each step of a build of `plan` will make — the progress rows' words, from the plan alone. */
+/** What a build does with each content type its plan names (the preflight's `summary.contentTypes[].action`): content
+ *  types are shared by every organization of a studio, so one the studio already has is reused, or extended with the
+ *  fields it lacks — never created twice. */
+declare enum ContentTypeAction {
+    Create = "create",
+    Reuse = "reuse",
+    Extend = "extend"
+}
+/** What each step of a build of `plan` will make — the progress rows' words, from the plan (+ the preflight's actions). */
 interface BuildStepFacts {
-    /** Content types to create: their labels. */
+    /** The plan's content types: their labels (created, reused or extended — see `contentTypeActions`). */
     contentTypes: string[];
+    /** Per label, what the build does with it — known only once the preflight said so (absent = not known). */
+    contentTypeActions: Partial<Record<ContentTypeAction, string[]>>;
     /** Sample items, all types together. */
     items: number;
     /** Pages (template pages included) and their routes. */
@@ -3003,7 +3023,7 @@ interface BuildStepFacts {
     /** The look's flavor. */
     flavorId: string;
 }
-declare function buildStepFacts(plan: SitePlan): BuildStepFacts;
+declare function buildStepFacts(plan: SitePlan, actions?: Readonly<Record<string, `${ContentTypeAction}`>>): BuildStepFacts;
 
-export { ACTIVE_BUILD_STATUSES, BAR_ITEMS_MAX, BAR_ITEMS_MIN, BASELINE_ROLES, BUILD_STEPS, BaselineRole, BindScope, BuildNoticeCode, BuildStep, CardBindTarget, ComposeError, ComposeIssueCode, CreatedKind, DANGLING_LINK_CODES, DEFAULT_PHONE_MENU_BREAKPOINT, ENTRANCE_EASING, ENTRANCE_ORIGIN_LOOK, ENTRANCE_TRIGGER, EntrancePart, FACT_KEYS, GlobalSlot, KeptReason, NAV_PART_LABELS, NAV_SHAPE_COPY, NEUTRAL_STYLE_PROPS, NODE_BASELINES, NavPagesSource, NavRole, NavShape, NavShapeError, PRICING_PATTERN, PUBLISH_BLOCKING_PLACEHOLDERS, PageDataKind, PathIssueCollector, PatternDirective, PatternGlobalPosition, PatternOpens, PatternPlaceholder, PatternRecipe, PhoneMenuBreakpoint, PlaceholderKind, PlanDataSourceMode, PlanDataSourceType, PreflightRefusalCode, RelativeOp, SAMPLE_IMAGE_REF, SITE_FACT_LABELS, SITE_HEADER_PATTERN, SITE_PATTERNS, SITE_PLAN_VERSION, SITE_TEMPLATES, SPEC_SITE_FACTS, SPEC_SITE_LIBRARY, SPEC_SITE_PATTERNS, SPEC_SITE_PLAN_SHAPE, SPEC_SITE_TEMPLATES, STUDIO_TEMPLATE, SiteBuildKind, SiteBuildStatus, SitePlanError, SitePlanIssueCode, SitePlanSourceKind, SiteTemplateError, SiteTemplateId, StepState, addBarItem, altSourceScopes, assertStyleSlots, assertValidSitePlan, barIconForRoute, blocksPublish, buildKeys, buildStepFacts, builtHomePageId, composeNavHeader, composeSection, composeSite, createSerializedNode, describePlanData, entranceAction, entranceInteraction, failedBuildStep, findNavRoot, isActiveBuild, isNonEmptyString, isPlainObject, moveBarItem, navPages, navShapeBreakpoint, navShapeOf, nextSourceOf, nodeBindPaths, parseSampleImageRef, pathAt, patternById, patternNeedsBinding, patternNodes, patternOptionalParts, patternScopes, patternSlots, patternTakesBinding, phoneMenuPages, planFromTemplate, planNavShape, releasedLayoutDefaults, removeBarItem, requiredShapeKeys, routeParams, sampleImageRef, sectionEntrances, setStyleProps, shapeKeys, siteNavPages, staggerDelay, validateSitePlan, walkSerialized };
+export { ACTIVE_BUILD_STATUSES, BAR_ITEMS_MAX, BAR_ITEMS_MIN, BASELINE_ROLES, BUILD_STEPS, BaselineRole, BindScope, BuildNoticeCode, BuildStep, CardBindTarget, ComposeError, ComposeIssueCode, ContentTypeAction, CreatedKind, DANGLING_LINK_CODES, DEFAULT_PHONE_MENU_BREAKPOINT, ENTRANCE_EASING, ENTRANCE_ORIGIN_LOOK, ENTRANCE_TRIGGER, EntrancePart, FACT_KEYS, GlobalSlot, KeptReason, NAV_PART_LABELS, NAV_SHAPE_COPY, NEUTRAL_STYLE_PROPS, NODE_BASELINES, NavPagesSource, NavRole, NavShape, NavShapeError, PRICING_PATTERN, PUBLISH_BLOCKING_PLACEHOLDERS, PageDataKind, PathIssueCollector, PatternDirective, PatternGlobalPosition, PatternOpens, PatternPlaceholder, PatternRecipe, PhoneMenuBreakpoint, PlaceholderKind, PlanDataSourceMode, PlanDataSourceType, PreflightRefusalCode, RelativeOp, SAMPLE_IMAGE_REF, SITE_FACT_LABELS, SITE_HEADER_PATTERN, SITE_PATTERNS, SITE_PLAN_VERSION, SITE_TEMPLATES, SPEC_SITE_FACTS, SPEC_SITE_LIBRARY, SPEC_SITE_PATTERNS, SPEC_SITE_PLAN_SHAPE, SPEC_SITE_TEMPLATES, STUDIO_TEMPLATE, SiteBuildKind, SiteBuildStatus, SitePlanError, SitePlanIssueCode, SitePlanSourceKind, SiteTemplateError, SiteTemplateId, StepState, addBarItem, altSourceScopes, assertStyleSlots, assertValidSitePlan, barIconForRoute, blocksPublish, buildKeys, buildStepFacts, builtHomePageId, composeNavHeader, composeSection, composeSite, createSerializedNode, describePlanData, entranceAction, entranceInteraction, failedBuildStep, findNavRoot, isActiveBuild, isNonEmptyString, isPlainObject, moveBarItem, navPages, navShapeBreakpoint, navShapeOf, nextSourceOf, nodeBindPaths, parseSampleImageRef, pathAt, patternById, patternNeedsBinding, patternNodes, patternOptionalParts, patternScopes, patternSlots, patternTakesBinding, phoneMenuPages, planFromTemplate, planNavShape, releasedLayoutDefaults, removeBarItem, requiredShapeKeys, routeParams, sampleImageRef, sectionEntrances, setStyleProps, shapeKeys, siteNavPages, staggerDelay, validateSitePlan, walkSerialized };
 export type { AddBarItemResult, BarItemsEditResult, BuildNotice, BuildStepError, BuildStepFacts, BuildStepRecord, CmsDataSourcePlan, ComposeContext, ComposeIssue, ComposedDataSource, ComposedItem, ComposedNavHeader, ComposedPage, ComposedPlaceholder, ComposedRoute, ComposedSection, ComposedSite, ContentFieldPlan, ContentSeedPlan, ContentTypePlan, CreateNodeOptions, CreatedRecord, DataSourcePlan, EntranceAction, EntranceInteraction, EntranceSpec, FactKey, NavHeaderInput, NavHeaderOptions, NavPage, NavShapeOptions, NavShapeResult, NodeBaseline, PageData, PageDataLine, PagePlan, PageSectionPlan, PathIssue, PatternNode, PlainObject, PreflightRefusal, RelativeDataSourcePlan, SectionEntrances, SectionInput, SectionOptions, SerializedBinding, SerializedNode, SerializedResponsive, ShapeEntry, ShapeIssueCodes, SiteBuildRun, SiteBusiness, SitePageRef, SitePattern, SitePlan, SitePlanIssue, SitePlanSource, SitePlanValidation, SiteTemplate, TemplatePlanInput, UndoKept, UndoPreview, UndoRecord };