@vectoriox/iox-ui 5.49.0 → 5.51.0

package/fesm2022/vectoriox-iox-ui-generation-core.mjs

@@ -9832,6 +9832,153 @@ function describePlanData(plan) {
     return plan.pages.map(page => ({ pageKey: page.key, lines: pageLines(page, plan, label) }));
 }
 
+/**
+ * A site build's WIRE vocabulary (AI plan §3b, W2): what iox-cms's `site-builds` API answers and what every
+ * client of it reads — the run's statuses and steps, what it created, why Undo kept something, the preflight's
+ * refusals, and the one spelling of each document's `buildKey`. ONE definition: iox-cms stores and answers it,
+ * the website wizard (W3) polls it. Pure types, enums and helpers; no transport.
+ */
+var SiteBuildKind;
+(function (SiteBuildKind) {
+    SiteBuildKind["Build"] = "build";
+})(SiteBuildKind || (SiteBuildKind = {}));
+var SiteBuildStatus;
+(function (SiteBuildStatus) {
+    SiteBuildStatus["Running"] = "running";
+    SiteBuildStatus["Done"] = "done";
+    SiteBuildStatus["Failed"] = "failed";
+    SiteBuildStatus["Undoing"] = "undoing";
+    SiteBuildStatus["Undone"] = "undone";
+})(SiteBuildStatus || (SiteBuildStatus = {}));
+/** The statuses a runner advances — and the ones that hold the org's single-run slot. */
+const ACTIVE_BUILD_STATUSES = [SiteBuildStatus.Running, SiteBuildStatus.Undoing];
+/** The steps of a build, in the order they run. */
+var BuildStep;
+(function (BuildStep) {
+    BuildStep["Preflight"] = "preflight";
+    BuildStep["ContentTypes"] = "content-types";
+    BuildStep["SampleImages"] = "sample-images";
+    BuildStep["Items"] = "items";
+    BuildStep["DataSources"] = "data-sources";
+    BuildStep["Pages"] = "pages";
+    BuildStep["Globals"] = "globals";
+    BuildStep["Look"] = "look";
+})(BuildStep || (BuildStep = {}));
+const BUILD_STEPS = Object.values(BuildStep);
+var StepState;
+(function (StepState) {
+    StepState["Wait"] = "wait";
+    StepState["Run"] = "run";
+    StepState["Done"] = "done";
+    StepState["Failed"] = "failed";
+})(StepState || (StepState = {}));
+/** What a build creates, as Undo walks it. */
+var CreatedKind;
+(function (CreatedKind) {
+    CreatedKind["ContentType"] = "content-type";
+    /** Fields the build added to a content type it found (types are shared by every organization of a studio). */
+    CreatedKind["ContentTypeFields"] = "content-type-fields";
+    CreatedKind["SampleImage"] = "sample-image";
+    CreatedKind["Item"] = "item";
+    CreatedKind["DataSource"] = "data-source";
+    CreatedKind["Page"] = "page";
+    CreatedKind["Global"] = "global";
+    CreatedKind["Look"] = "look";
+})(CreatedKind || (CreatedKind = {}));
+/** Why Undo left something in place. */
+var KeptReason;
+(function (KeptReason) {
+    KeptReason["Edited"] = "edited";
+    KeptReason["Published"] = "published";
+    KeptReason["InUse"] = "in-use";
+    /** Added to a content type every organization shares: removing a field is the studio owner's change. */
+    KeptReason["Shared"] = "shared";
+})(KeptReason || (KeptReason = {}));
+var BuildNoticeCode;
+(function (BuildNoticeCode) {
+    /** Storage is not configured: sample items get the empty image box, and the run says so. */
+    BuildNoticeCode["NoStorage"] = "no-storage";
+    /** A content type the build reuses is not public in this studio: the site will not show its items. */
+    BuildNoticeCode["ContentTypeNotPublic"] = "content-type-not-public";
+})(BuildNoticeCode || (BuildNoticeCode = {}));
+var PreflightRefusalCode;
+(function (PreflightRefusalCode) {
+    /** The Site Plan itself is invalid (`validateSitePlan`); `issue` is the validator's code. */
+    PreflightRefusalCode["InvalidPlan"] = "invalid-plan";
+    /** A route the plan wants is already a page of this organization. */
+    PreflightRefusalCode["RouteTaken"] = "route-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. */
+    PreflightRefusalCode["ContentTypeConflict"] = "content-type-conflict";
+    /** The name may not be a content type (a platform collection, or not a valid name). */
+    PreflightRefusalCode["ContentTypeName"] = "content-type-name";
+    /** The plan creates a content type or adds fields to one, and the caller may not (an org owner/admin — schema_all). */
+    PreflightRefusalCode["ContentTypesNeedPermission"] = "content-types-need-permission";
+    /** The org library holds the alias with a different definition. */
+    PreflightRefusalCode["DataSourceConflict"] = "data-source-conflict";
+    /** The studio has pages AND a header/footer: replace or keep them is the caller's choice (D7). */
+    PreflightRefusalCode["GlobalsNeedDecision"] = "globals-need-decision";
+    /** A global the plan adds has the id of one the studio keeps. */
+    PreflightRefusalCode["GlobalTaken"] = "global-taken";
+})(PreflightRefusalCode || (PreflightRefusalCode = {}));
+/**
+ * The stable key each written document carries beside `siteBuildId`: a step that runs twice looks it up first and
+ * skips what exists (so a restart or a Retry continues without duplicates), and a reader finds what the run made
+ * by it — the wizard opens the HOME page by `page(<its key>)`. One builder per kind.
+ */
+const buildKeys = {
+    contentType: (name) => `schema:${name}`,
+    contentTypeFields: (name) => `schema-fields:${name}`,
+    item: (contentType, n) => `item:${contentType}:${n}`,
+    sampleImage: (n) => `sample-image:${n}`,
+    dataSource: (alias) => `data-source:${alias}`,
+    page: (key) => `page:${key}`,
+    global: (nodeId) => `global:${nodeId}`,
+    look: () => 'look',
+};
+/** The id of the page a run made for the plan's home page, or null (not made yet, or no home page). */
+function builtHomePageId(run) {
+    const home = run?.plan?.pages?.find(p => p.isHome) ?? run?.plan?.pages?.[0];
+    if (!home)
+        return null;
+    const key = buildKeys.page(home.key);
+    return run.created?.find(c => c.kind === CreatedKind.Page && c.buildKey === key)?.id ?? null;
+}
+/** The step a run stopped at, or null. */
+function failedBuildStep(run) {
+    return run?.steps?.find(s => s.state === StepState.Failed) ?? null;
+}
+/** A run still holding the org's slot (building or undoing) — a page that left it comes back to its progress. */
+function isActiveBuild(run) {
+    return !!run && ACTIVE_BUILD_STATUSES.includes(run.status);
+}
+/** 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. */
+var ContentTypeAction;
+(function (ContentTypeAction) {
+    ContentTypeAction["Create"] = "create";
+    ContentTypeAction["Reuse"] = "reuse";
+    ContentTypeAction["Extend"] = "extend";
+})(ContentTypeAction || (ContentTypeAction = {}));
+function buildStepFacts(plan, actions = {}) {
+    const contentTypeActions = {};
+    for (const t of plan.contentTypes) {
+        const action = actions[t.name];
+        if (action)
+            (contentTypeActions[action] ??= []).push(t.label);
+    }
+    return {
+        contentTypes: plan.contentTypes.map(t => t.label),
+        contentTypeActions,
+        items: plan.contentTypes.reduce((n, t) => n + (t.seed?.count ?? 0), 0),
+        pages: plan.pages.length,
+        routes: plan.pages.map(p => p.route),
+        navLinks: plan.pages.filter(p => p.inNav).length,
+        flavorId: plan.design.flavorId,
+    };
+}
+
 /**
  * @vectoriox/iox-ui/generation-core — the shared, FRAMEWORK-FREE site-plan core (design-system plan
  * §6b, W1): the Site Plan shape + its validator, the pattern library and the Studio template (both
@@ -9848,5 +9995,5 @@ function describePlanData(plan) {
  * Generated bundle index. Do not edit.
  */
 
-export { BAR_ITEMS_MAX, BAR_ITEMS_MIN, BASELINE_ROLES, BaselineRole, BindScope, CardBindTarget, ComposeError, ComposeIssueCode, DANGLING_LINK_CODES, DEFAULT_PHONE_MENU_BREAKPOINT, ENTRANCE_EASING, ENTRANCE_ORIGIN_LOOK, ENTRANCE_TRIGGER, EntrancePart, FACT_KEYS, GlobalSlot, 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, 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, SitePlanError, SitePlanIssueCode, SitePlanSourceKind, SiteTemplateError, SiteTemplateId, addBarItem, altSourceScopes, assertStyleSlots, assertValidSitePlan, barIconForRoute, blocksPublish, composeNavHeader, composeSection, composeSite, createSerializedNode, describePlanData, entranceAction, entranceInteraction, findNavRoot, 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 };
 //# sourceMappingURL=vectoriox-iox-ui-generation-core.mjs.map