@vectoriox/iox-ui 5.52.0 → 5.53.0

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

@@ -9979,6 +9979,147 @@ function buildStepFacts(plan, actions = {}) {
     };
 }
 
+/**
+ * The AI pipeline's WIRE vocabulary (AI plan §3c, §3n, M0): what iox-cms's `ai` API answers and what every client
+ * of it reads — the steps a model works on, who pays (IOX credits or the studio's own key), a model of the vetted
+ * list with its price per token class, the one cost → credits rule (1 credit = 1 US cent of what the AI cost, D4),
+ * the refusals (board 11) and a generation's stages. ONE definition: iox-cms meters and refuses with it, the
+ * Settings ▸ AI screen and the wizard show it. Pure types, enums and helpers; no transport, no prices typed here.
+ */
+var AiProviderId;
+(function (AiProviderId) {
+    AiProviderId["Anthropic"] = "anthropic";
+    AiProviderId["OpenRouter"] = "openrouter";
+})(AiProviderId || (AiProviderId = {}));
+/** Who pays: the platform's credits, or the studio's own provider key (metered for display, never charged). */
+var AiKeyMode;
+(function (AiKeyMode) {
+    AiKeyMode["Platform"] = "platform";
+    AiKeyMode["Own"] = "own";
+})(AiKeyMode || (AiKeyMode = {}));
+/** The steps a model works on (board 9's rows), in screen order. */
+var AiStep;
+(function (AiStep) {
+    AiStep["ReadMessage"] = "read";
+    AiStep["PlanSite"] = "plan";
+    AiStep["ChangePlan"] = "change";
+    AiStep["MakePictures"] = "pictures";
+    AiStep["NameStructures"] = "scan";
+})(AiStep || (AiStep = {}));
+const AI_STEPS = Object.values(AiStep);
+/** What a model must be able to do for a step to run on it. */
+var AiCapability;
+(function (AiCapability) {
+    AiCapability["StructuredOutput"] = "structured-output";
+    AiCapability["ImageInput"] = "image-input";
+    AiCapability["ImageOutput"] = "image-output";
+})(AiCapability || (AiCapability = {}));
+const AI_STEP_NEEDS = {
+    [AiStep.ReadMessage]: [AiCapability.StructuredOutput, AiCapability.ImageInput],
+    [AiStep.PlanSite]: [AiCapability.StructuredOutput],
+    [AiStep.ChangePlan]: [AiCapability.StructuredOutput],
+    [AiStep.MakePictures]: [AiCapability.ImageOutput],
+    [AiStep.NameStructures]: [AiCapability.StructuredOutput],
+};
+/** Tokens a typical use of a step reads and writes (plan §3d "Where credits go") — what a shown estimate is made of. */
+const AI_STEP_TYPICAL_TOKENS = {
+    [AiStep.ReadMessage]: { input: 8_800, output: 1_500, cacheWrite: 0, cacheRead: 0 },
+    [AiStep.PlanSite]: { input: 12_000, output: 7_000, cacheWrite: 0, cacheRead: 0 },
+    [AiStep.ChangePlan]: { input: 6_000, output: 500, cacheWrite: 0, cacheRead: 0 },
+    [AiStep.MakePictures]: { input: 1_120, output: 0, cacheWrite: 0, cacheRead: 0 },
+    [AiStep.NameStructures]: { input: 80_000, output: 10_000, cacheWrite: 0, cacheRead: 0 },
+};
+/** 1 credit = 1 US cent of what the AI actually cost (decision D4). */
+const CREDITS_PER_USD = 100;
+const TOKENS_PER_PRICE_UNIT = 1_000_000;
+const CREDIT_PRECISION = 1e6;
+const NO_TOKENS = Object.freeze({ input: 0, output: 0, cacheWrite: 0, cacheRead: 0 });
+/** What `tokens` cost at `price`, in US dollars. */
+function costUsd(tokens, price) {
+    const perToken = (perMillion, fallback) => (perMillion ?? fallback) / TOKENS_PER_PRICE_UNIT;
+    return tokens.input * perToken(price.input, 0)
+        + tokens.output * perToken(price.output, 0)
+        + tokens.cacheWrite * perToken(price.cacheWrite, price.input)
+        + tokens.cacheRead * perToken(price.cacheRead, price.input);
+}
+/** Dollars → credits, kept to a millionth of a credit (a short read costs a fraction of one). */
+function creditsOfUsd(usd) {
+    return Math.round(usd * CREDITS_PER_USD * CREDIT_PRECISION) / CREDIT_PRECISION;
+}
+/** The credits a typical use of `step` costs on a model of `price` — never typed, always computed (§3d). */
+function estimateStepCredits(step, price, tokens = AI_STEP_TYPICAL_TOKENS[step]) {
+    return creditsOfUsd(costUsd(tokens, price));
+}
+/** Can `model` do `step`? The step's needs against the model's capabilities. */
+function modelCanDo(model, step) {
+    return AI_STEP_NEEDS[step].every(need => model.capabilities.includes(need));
+}
+/** Why AI did not run (board 11). The server refuses with these BEFORE any model call. */
+var AiRefusalCode;
+(function (AiRefusalCode) {
+    AiRefusalCode["NotInPlan"] = "ai.notInPlan";
+    AiRefusalCode["OutOfCredits"] = "ai.outOfCredits";
+    AiRefusalCode["CapReached"] = "ai.capReached";
+    AiRefusalCode["NotConnected"] = "ai.notConnected";
+    AiRefusalCode["KeyInvalid"] = "ai.keyInvalid";
+    AiRefusalCode["PlanUnknown"] = "ai.planUnknown";
+})(AiRefusalCode || (AiRefusalCode = {}));
+/** The HTTP status each refusal answers with (board 11). */
+const AI_REFUSAL_STATUS = {
+    [AiRefusalCode.NotInPlan]: 403,
+    [AiRefusalCode.OutOfCredits]: 402,
+    [AiRefusalCode.CapReached]: 402,
+    [AiRefusalCode.NotConnected]: 409,
+    [AiRefusalCode.KeyInvalid]: 409,
+    [AiRefusalCode.PlanUnknown]: 503,
+};
+/** What a refusal offers next. */
+var AiNextKind;
+(function (AiNextKind) {
+    /** Ask IOX (a prefilled email to the operator, until a plan can be bought — D2). */
+    AiNextKind["Contact"] = "contact";
+    /** Open Settings ▸ AI. */
+    AiNextKind["Settings"] = "settings";
+    /** Try again later, or with less. */
+    AiNextKind["Retry"] = "retry";
+})(AiNextKind || (AiNextKind = {}));
+const AI_REFUSAL_NEXT = {
+    [AiRefusalCode.NotInPlan]: AiNextKind.Contact,
+    [AiRefusalCode.OutOfCredits]: AiNextKind.Contact,
+    [AiRefusalCode.CapReached]: AiNextKind.Retry,
+    [AiRefusalCode.NotConnected]: AiNextKind.Settings,
+    [AiRefusalCode.KeyInvalid]: AiNextKind.Settings,
+    [AiRefusalCode.PlanUnknown]: AiNextKind.Retry,
+};
+/** A generation's stages (§3d). The runner works while `task` is set; otherwise the owner has the next move. */
+var AiGenerationStage;
+(function (AiGenerationStage) {
+    AiGenerationStage["Reading"] = "reading";
+    AiGenerationStage["Analysis"] = "analysis";
+    AiGenerationStage["Design"] = "design";
+    AiGenerationStage["Plan"] = "plan";
+    AiGenerationStage["Build"] = "build";
+    AiGenerationStage["Done"] = "done";
+    AiGenerationStage["Failed"] = "failed";
+    AiGenerationStage["Cancelled"] = "cancelled";
+})(AiGenerationStage || (AiGenerationStage = {}));
+/** The stages nothing advances any more. */
+const FINAL_GENERATION_STAGES = [AiGenerationStage.Done, AiGenerationStage.Failed, AiGenerationStage.Cancelled];
+/** How one model call ended — a ledger row's status. */
+var AiCallStatus;
+(function (AiCallStatus) {
+    /** Written before the call: a reservation at the estimate until the call settles. */
+    AiCallStatus["Started"] = "started";
+    AiCallStatus["Ok"] = "ok";
+    /** The answer came back and the shared validator refused it (with a path). */
+    AiCallStatus["Invalid"] = "invalid";
+    /** The model declined (a provider refusal) — charged what the provider reports. */
+    AiCallStatus["Refused"] = "refused";
+    AiCallStatus["Error"] = "error";
+    /** The process died during the call: charged at the estimate, since what it cost was never reported. */
+    AiCallStatus["Interrupted"] = "interrupted";
+})(AiCallStatus || (AiCallStatus = {}));
+
 /**
  * @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
@@ -9995,5 +10136,5 @@ function buildStepFacts(plan, actions = {}) {
  * Generated bundle index. Do not edit.
  */
 
-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 { ACTIVE_BUILD_STATUSES, AI_REFUSAL_NEXT, AI_REFUSAL_STATUS, AI_STEPS, AI_STEP_NEEDS, AI_STEP_TYPICAL_TOKENS, AiCallStatus, AiCapability, AiGenerationStage, AiKeyMode, AiNextKind, AiProviderId, AiRefusalCode, AiStep, BAR_ITEMS_MAX, BAR_ITEMS_MIN, BASELINE_ROLES, BUILD_STEPS, BaselineRole, BindScope, BuildNoticeCode, BuildStep, CREDITS_PER_USD, CardBindTarget, ComposeError, ComposeIssueCode, ContentTypeAction, CreatedKind, DANGLING_LINK_CODES, DEFAULT_PHONE_MENU_BREAKPOINT, ENTRANCE_EASING, ENTRANCE_ORIGIN_LOOK, ENTRANCE_TRIGGER, EntrancePart, FACT_KEYS, FINAL_GENERATION_STAGES, GlobalSlot, KeptReason, NAV_PART_LABELS, NAV_SHAPE_COPY, NEUTRAL_STYLE_PROPS, NODE_BASELINES, NO_TOKENS, 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, costUsd, createSerializedNode, creditsOfUsd, describePlanData, entranceAction, entranceInteraction, estimateStepCredits, failedBuildStep, findNavRoot, isActiveBuild, isNonEmptyString, isPlainObject, modelCanDo, 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