@builder-builder/builder 0.0.13 → 0.0.15

package/dist/entities/ui/page.js

@@ -1,19 +1,26 @@
 import * as v from 'valibot';
-import { BuilderPathsSchema } from '../../paths.js';
 import { paramable } from '../../references.js';
 import { serialisable } from '../../serialisable.js';
+import { BuilderTagsSchema } from '../tags.js';
+import { BuilderUIInputsSerialisedSchema } from './input.js';
 export class BuilderUIPage {
     type = 'page';
     label;
-    paths;
-    constructor(label, paths) {
+    inputs;
+    tags;
+    constructor(label, inputs, tags) {
         this.label = label;
-        this.paths = paths;
+        this.inputs = inputs;
+        this.tags = tags;
+    }
+    tag(...tags) {
+        return new BuilderUIPage(this.label, this.inputs, tags);
     }
 }
 export const BuilderUIPageSchema = v.instance(BuilderUIPage);
 export const BuilderUIPageSerialisedSchema = serialisable(v.object({
     type: v.literal('page'),
     label: paramable(v.string()),
-    paths: paramable(BuilderPathsSchema)
+    inputs: paramable(BuilderUIInputsSerialisedSchema),
+    tags: v.optional(BuilderTagsSchema)
 }));

package/dist/entities/ui/pages.d.ts

@@ -1,4 +1,5 @@
 import type { Paramable, ParamableSerialised } from '../../references';
+import type { BuilderTags } from '../tags';
 import type { BuilderUIDescribe, BuilderUIDescribeSerialised } from './describe';
 import type { BuilderUIPage, BuilderUIPageSerialised } from './page';
 import * as v from 'valibot';
@@ -9,7 +10,9 @@ export declare class BuilderUIPages<const Name extends string = string, const La
     readonly name: Name;
     readonly label: Label;
     readonly items: Items;
-    constructor(name: Name, label: Label, items: Items);
+    readonly tags?: BuilderTags;
+    constructor(name: Name, label: Label, items: Items, tags?: BuilderTags);
+    tag(...tags: Array<string>): BuilderUIPages<Name, Label, Items>;
 }
 export declare const BuilderUIPagesSchema: v.InstanceSchema<typeof BuilderUIPages, undefined>;
 export type BuilderUIPagesSerialised = {
@@ -17,6 +20,7 @@ export type BuilderUIPagesSerialised = {
     readonly name: string;
     readonly label: ParamableSerialised<string>;
     readonly items: ParamableSerialised<BuilderUIItemsSerialised>;
+    readonly tags?: BuilderTags;
 };
 export type BuilderUIItemSerialised = BuilderUIPageSerialised | BuilderUIDescribeSerialised | BuilderUIPagesSerialised;
 export type BuilderUIItemsSerialised = ReadonlyArray<ParamableSerialised<BuilderUIItemSerialised>>;

package/dist/entities/ui/pages.js

@@ -1,6 +1,7 @@
 import * as v from 'valibot';
 import { paramable } from '../../references.js';
 import { serialisable } from '../../serialisable.js';
+import { BuilderTagsSchema } from '../tags.js';
 import { BuilderUIDescribeSerialisedSchema } from './describe.js';
 import { BuilderUIPageSerialisedSchema } from './page.js';
 export class BuilderUIPages {
@@ -8,10 +9,15 @@ export class BuilderUIPages {
     name;
     label;
     items;
-    constructor(name, label, items) {
+    tags;
+    constructor(name, label, items, tags) {
         this.name = name;
         this.label = label;
         this.items = items;
+        this.tags = tags;
+    }
+    tag(...tags) {
+        return new BuilderUIPages(this.name, this.label, this.items, tags);
     }
 }
 export const BuilderUIPagesSchema = v.instance(BuilderUIPages);
@@ -19,7 +25,8 @@ export const BuilderUIPagesSerialisedSchema = serialisable(v.object({
     type: v.literal('pages'),
     name: v.string(),
     label: paramable(v.string()),
-    items: paramable(v.lazy(() => BuilderUIItemsSerialisedSchema))
+    items: paramable(v.lazy(() => BuilderUIItemsSerialisedSchema)),
+    tags: v.optional(BuilderTagsSchema)
 }));
 export const BuilderUIItemSerialisedSchema = v.union([
     BuilderUIPageSerialisedSchema,

package/dist/entities/ui/ui.d.ts

@@ -3,27 +3,32 @@ import type { BuilderExpectation, BuilderExpectations, BuilderExpectationsSerial
 import type { CollectionNamesOf } from '../collection/index';
 import type { BuilderModel, BuilderModelGeneric, BuilderModelStateOf } from '../model/model';
 import type { BuilderModelStateAsserted } from '../model/expectation';
-import type { BuilderValidPathsOf } from '../when';
+import type { BuilderTags } from '../tags';
+import type { BuilderUIValidInputsOf } from './input';
 import type { BuilderUIItems, BuilderUIItemsSerialised } from './pages';
 import * as v from 'valibot';
 export type BuilderUIs = ReadonlyArray<Paramable<BuilderUI>>;
 export type BuilderUIsSerialised = ReadonlyArray<ParamableSerialised<BuilderUISerialised>>;
 export declare class BuilderUI<Model extends BuilderModelGeneric = BuilderModelGeneric> {
+    #private;
     readonly type: 'ui';
     readonly model: Model;
     readonly uis: BuilderUIs;
     readonly items: BuilderUIItems;
     readonly expectations: BuilderExpectations;
-    constructor(uis: BuilderUIs, items: BuilderUIItems, expectations: BuilderExpectations);
+    readonly tags?: BuilderTags;
+    constructor(uis: BuilderUIs, items: BuilderUIItems, expectations: BuilderExpectations, tags?: BuilderTags);
     expect<const Exps extends readonly [BuilderExpectation, ...ReadonlyArray<BuilderExpectation>]>(...expectations: Exps): BuilderUI<BuilderModel<BuilderModelStateAsserted<BuilderModelStateOf<Model>, Exps>>>;
-    page(label: Paramable<string>, paths: Paramable<BuilderValidPathsOf<Model>>): BuilderUI<Model>;
-    describe(label: Paramable<string>, paths: Paramable<BuilderValidPathsOf<Model>>): BuilderUI<Model>;
+    page(label: Paramable<string>, inputs: Paramable<BuilderUIValidInputsOf<Model>>): BuilderUI<Model>;
+    describe(label: Paramable<string>, inputs: Paramable<BuilderUIValidInputsOf<Model>>): BuilderUI<Model>;
     pages<const Name extends CollectionNamesOf<BuilderModelStateOf<Model>>>(name: Name, label: Paramable<string>, itemUI: Paramable<BuilderUI<BuilderModelGeneric>>): BuilderUI<Model>;
+    tag(...tags: Array<string>): BuilderUI<Model>;
 }
 export declare const BuilderUISchema: v.InstanceSchema<typeof BuilderUI, undefined>;
 export interface BuilderUISerialised {
     readonly uis: BuilderUIsSerialised;
     readonly items: BuilderUIItemsSerialised;
     readonly expectations: BuilderExpectationsSerialised;
+    readonly tags?: BuilderTags;
 }
 export declare const BuilderUISerialisedSchema: v.GenericSchema<BuilderUISerialised>;

package/dist/entities/ui/ui.js

@@ -3,6 +3,7 @@ import { check } from '../../check.js';
 import { paramable } from '../../references.js';
 import { serialisable } from '../../serialisable.js';
 import { BuilderExpectationsSerialisedSchema } from '../expectation.js';
+import { BuilderTagsSchema } from '../tags.js';
 import { BuilderUIDescribe } from './describe.js';
 import { BuilderUIPage } from './page.js';
 import { BuilderUIItemsSerialisedSchema, BuilderUIPages } from './pages.js';
@@ -10,31 +11,48 @@ export class BuilderUI {
     uis;
     items;
     expectations;
-    constructor(uis, items, expectations) {
+    tags;
+    constructor(uis, items, expectations, tags) {
         this.uis = uis;
         this.items = items;
         this.expectations = expectations;
+        this.tags = tags;
+    }
+    #next(patch) {
+        return new BuilderUI(this.uis, patch.items ?? this.items, patch.expectations ?? this.expectations, patch.tags ?? this.tags);
     }
     expect(...expectations) {
-        return new BuilderUI(this.uis, this.items, [
-            ...this.expectations,
-            ...expectations
-        ]);
+        return this.#next({
+            expectations: [...this.expectations, ...expectations]
+        });
     }
-    page(label, paths) {
-        return new BuilderUI(this.uis, [...this.items, new BuilderUIPage(label, paths)], this.expectations);
+    page(label, inputs) {
+        return this.#next({
+            items: [...this.items, new BuilderUIPage(label, inputs)]
+        });
     }
-    describe(label, paths) {
-        return new BuilderUI(this.uis, [...this.items, new BuilderUIDescribe(label, paths)], this.expectations);
+    describe(label, inputs) {
+        return this.#next({
+            items: [
+                ...this.items,
+                new BuilderUIDescribe(label, inputs)
+            ]
+        });
     }
     pages(name, label, itemUI) {
         const items = check.is(BuilderUISchema, itemUI) ? itemUI.items : itemUI;
-        return new BuilderUI(this.uis, [...this.items, new BuilderUIPages(name, label, items)], this.expectations);
+        return this.#next({
+            items: [...this.items, new BuilderUIPages(name, label, items)]
+        });
+    }
+    tag(...tags) {
+        return this.#next({ tags });
     }
 }
 export const BuilderUISchema = v.instance(BuilderUI);
 export const BuilderUISerialisedSchema = serialisable(v.object({
     uis: v.pipe(v.array(paramable(v.lazy(() => BuilderUISerialisedSchema))), v.readonly()),
     items: BuilderUIItemsSerialisedSchema,
-    expectations: BuilderExpectationsSerialisedSchema
+    expectations: BuilderExpectationsSerialisedSchema,
+    tags: v.optional(BuilderTagsSchema)
 }));

package/dist/entities/validated.d.ts

@@ -4,11 +4,12 @@ import type { Prettify } from '../prettify';
 import type { BuilderParameter, BuilderParameterSerialised, BuilderRef, BuilderRefSerialised } from '../references';
 import type { BuilderSerialised } from './builder/index';
 import type { BuilderCollectionConfigSerialised, BuilderCollectionSerialised, BuilderCollectionsSerialised } from './collection/index';
-import type { BuilderComponentSerialised, BuilderComponentsSerialised } from './component/index';
+import type { BuilderComponentDetailsSerialised, BuilderComponentSerialised, BuilderComponentsSerialised } from './component/index';
 import type { BuilderModelSerialised } from './model/index';
-import type { BuilderOptionSerialised, BuilderOptionsSerialised } from './option/index';
+import type { BuilderOptionSerialised, BuilderOptionsSerialised, BuilderOptionValuesSerialised } from './option/index';
+import type { BuilderPricing } from './pricing';
 import type { BuilderUIDescribeSerialised, BuilderUIItemsSerialised, BuilderUIPageSerialised, BuilderUISerialised } from './ui/index';
-export type Validated<Input> = Input extends BuilderComponentVariants | BuilderInstance | BuilderModelSerialised | BuilderSerialised | BuilderUISerialised ? Validate<Input> & BuilderValidatedBrand : Validate<Input>;
+export type Validated<Input> = Input extends BuilderComponentVariants | BuilderInstance | BuilderModelSerialised | BuilderPricing | BuilderSerialised | BuilderUISerialised ? Validate<Input> & BuilderValidatedBrand : Validate<Input>;
 type Validate<Input> = Input extends BuilderParameter<string> | BuilderParameterSerialised | BuilderRef | BuilderRefSerialised ? never : Input extends ReadonlyArray<unknown> ? ValidatedTuple<Input> : Input extends object ? {
     readonly [Key in keyof Input]: Validated<Input[Key]>;
 } : Input;
@@ -24,11 +25,14 @@ export type BuilderInstancesValidated = Prettify<Validated<BuilderInstances>>;
 export type BuilderComponentVariantsValidated = Prettify<Validated<BuilderComponentVariants>>;
 export type BuilderOptionValidated = Prettify<Validated<BuilderOptionSerialised>>;
 export type BuilderOptionsValidated = Prettify<Validated<BuilderOptionsSerialised>>;
+export type BuilderOptionValuesValidated = Prettify<Validated<BuilderOptionValuesSerialised>>;
 export type BuilderComponentValidated = Prettify<Validated<BuilderComponentSerialised>>;
 export type BuilderComponentsValidated = Prettify<Validated<BuilderComponentsSerialised>>;
+export type BuilderComponentDetailsValidated = Prettify<Validated<BuilderComponentDetailsSerialised>>;
 export type BuilderCollectionValidated = Prettify<Validated<BuilderCollectionSerialised>>;
 export type BuilderCollectionsValidated = Prettify<Validated<BuilderCollectionsSerialised>>;
 export type BuilderCollectionConfigValidated = Prettify<Validated<BuilderCollectionConfigSerialised>>;
+export type BuilderPricingValidated = Prettify<Validated<BuilderPricing>>;
 export type BuilderUIItemsValidated = Prettify<Validated<BuilderUIItemsSerialised>>;
 export type BuilderUIPageValidated = Prettify<Validated<BuilderUIPageSerialised>>;
 export type BuilderUIDescribeValidated = Prettify<Validated<BuilderUIDescribeSerialised>>;

package/dist/exception.d.ts

@@ -1,11 +1,11 @@
-import type { BuilderErrorDuplicateName, BuilderErrorInvalidCollection, BuilderErrorInvalidCollectionBounds, BuilderErrorInvalidDetail, BuilderErrorInvalidInput, BuilderErrorInvalidOption, BuilderErrorInvalidPath, BuilderErrorInvalidSelectMapKey, BuilderErrorInvalidVariant, BuilderErrorMissingComponent, BuilderErrorMissingDetail, BuilderErrorMissingReference, BuilderErrorMissingVariant, BuilderErrorUnboundParameter, BuilderErrorUnexpectedComponent, BuilderErrorUnexpectedDetail, BuilderErrorUnmetExpectation, BuilderErrorUnvalidated } from './validate/index';
+import type { BuilderErrorDuplicateName, BuilderErrorInvalidCollection, BuilderErrorInvalidCollectionBounds, BuilderErrorInvalidDetail, BuilderErrorInvalidInput, BuilderErrorInvalidOption, BuilderErrorInvalidPath, BuilderErrorInvalidPricing, BuilderErrorInvalidSelectMapKey, BuilderErrorInvalidVariant, BuilderErrorMissingComponent, BuilderErrorMissingDetail, BuilderErrorMissingReference, BuilderErrorMissingVariant, BuilderErrorUnboundParameter, BuilderErrorUnexpectedComponent, BuilderErrorUnexpectedDetail, BuilderErrorUnmetExpectation, BuilderErrorUnvalidated } from './validate/index';
 export type BuilderErrorLocation = ReadonlyArray<string | number>;
 export declare function builderError<Kind extends string>(kind: Kind, location: BuilderErrorLocation): {
     kind: Kind;
     location: BuilderErrorLocation;
 };
 export type BuilderErrorBase = ReturnType<typeof builderError>;
-export type BuilderError = BuilderErrorUnmetExpectation | BuilderErrorUnboundParameter | BuilderErrorMissingReference | BuilderErrorInvalidPath | BuilderErrorInvalidSelectMapKey | BuilderErrorDuplicateName | BuilderErrorInvalidCollectionBounds | BuilderErrorInvalidOption | BuilderErrorInvalidCollection | BuilderErrorMissingComponent | BuilderErrorUnexpectedComponent | BuilderErrorMissingVariant | BuilderErrorInvalidVariant | BuilderErrorMissingDetail | BuilderErrorUnexpectedDetail | BuilderErrorInvalidDetail | BuilderErrorInvalidInput | BuilderErrorUnvalidated;
+export type BuilderError = BuilderErrorUnmetExpectation | BuilderErrorUnboundParameter | BuilderErrorMissingReference | BuilderErrorInvalidPath | BuilderErrorInvalidPricing | BuilderErrorInvalidSelectMapKey | BuilderErrorDuplicateName | BuilderErrorInvalidCollectionBounds | BuilderErrorInvalidOption | BuilderErrorInvalidCollection | BuilderErrorMissingComponent | BuilderErrorUnexpectedComponent | BuilderErrorMissingVariant | BuilderErrorInvalidVariant | BuilderErrorMissingDetail | BuilderErrorUnexpectedDetail | BuilderErrorInvalidDetail | BuilderErrorInvalidInput | BuilderErrorUnvalidated;
 export type BuilderErrors = ReadonlyArray<BuilderError>;
 export declare class BuilderException extends globalThis.Error {
     readonly errors: BuilderErrors;

package/dist/index.d.ts

@@ -1,14 +1,14 @@
 export type { BB, BBOptions } from './bb';
-export type { BuilderBindings, BuilderBindingsSerialised, BuilderCollection, BuilderCollectionConfig, BuilderCollectionConfigSerialised, BuilderCollections, BuilderCollectionSerialised, BuilderCollectionsSerialised, BuilderCollectionWhen, BuilderCollectionWhenSerialised, BuilderComponent, BuilderComponentDetails, BuilderComponentDetailsSerialised, BuilderComponentField, BuilderComponentFields, BuilderComponentFieldSerialised, BuilderComponentFieldsSerialised, BuilderComponentFieldValueType, BuilderComponents, BuilderComponentSerialised, BuilderComponentsSerialised, BuilderComponentWhen, BuilderComponentWhenSerialised, BuilderDescription, BuilderDescriptionItem, BuilderEntityKind, BuilderEntitySerialised, BuilderExpectation, BuilderExpectationKind, BuilderExpectations, BuilderExpectationSerialised, BuilderExpectationsSerialised, BuilderInstanceOf, BuilderModel, BuilderModels, BuilderModelSerialised, BuilderModelValidated, BuilderOption, BuilderOptions, BuilderOptionSerialised, BuilderOptionsSerialised, BuilderOptionValues, BuilderOptionValuesSerialised, BuilderOptionWhen, BuilderOptionWhenSerialised, BuilderRefEntities, BuilderRefEntity, BuilderSelectType, BuilderSelectTypeLabels, BuilderSelectTypeSerialised, BuilderSelectTypeValues, BuilderSerialised, BuilderToggleType, BuilderToggleTypeSerialised, BuilderToggleValueType, BuilderUI, BuilderUIDescribe, BuilderUIDescribeSerialised, BuilderUIItem, BuilderUIItems, BuilderUIItemsSerialised, BuilderUIPage, BuilderUIPages, BuilderUIPageSerialised, BuilderUIPagesSerialised, BuilderUIs, BuilderUIsSerialised, BuilderUISerialised, BuilderUIValidated, BuilderValidated, BuilderComponentVariantsValidated, BuilderInstanceValidated, BuilderEnableConfig, BuilderMatchConfig, BuilderMatchSelectMap, BuilderUnlessConfig, BuilderWhen, BuilderWhenConfig, BuilderWhenSerialised } from './entities/index';
+export type { BuilderBindings, BuilderBindingsSerialised, BuilderCollection, BuilderCollectionConfig, BuilderCollectionConfigSerialised, BuilderCollections, BuilderCollectionSerialised, BuilderCollectionsSerialised, BuilderCollectionWhen, BuilderCollectionWhenSerialised, BuilderComponent, BuilderComponentDetails, BuilderComponentDetailsSerialised, BuilderComponentField, BuilderComponentFields, BuilderComponentFieldSerialised, BuilderComponentFieldsSerialised, BuilderComponentFieldValueType, BuilderComponents, BuilderComponentSerialised, BuilderComponentsSerialised, BuilderComponentWhen, BuilderComponentWhenSerialised, BuilderDescription, BuilderDescriptionItem, BuilderEntityKind, BuilderEntitySerialised, BuilderExpectation, BuilderExpectationKind, BuilderExpectations, BuilderExpectationSerialised, BuilderExpectationsSerialised, BuilderInstanceOf, BuilderModel, BuilderModels, BuilderModelSerialised, BuilderModelValidated, BuilderOption, BuilderOptions, BuilderOptionSerialised, BuilderOptionsSerialised, BuilderOptionValues, BuilderOptionValuesSerialised, BuilderOptionWhen, BuilderOptionWhenSerialised, BuilderRefEntities, BuilderRefEntity, BuilderSelectType, BuilderSelectTypeLabels, BuilderSelectTypeSerialised, BuilderSelectTypeValues, BuilderPricing, BuilderPricingExpression, BuilderPricingReduce, BuilderPricingTagExpression, BuilderSerialised, BuilderTags, BuilderToggleType, BuilderToggleTypeSerialised, BuilderToggleValueType, BuilderUI, BuilderUIDescribe, BuilderUIDescribeSerialised, BuilderUIInput, BuilderUIInputMetadata, BuilderUIInputMetadataSerialised, BuilderUIInputs, BuilderUIInputsSerialised, BuilderUIInputSerialised, BuilderUIItem, BuilderUIItems, BuilderUIItemsSerialised, BuilderUIPage, BuilderUIPages, BuilderUIPageSerialised, BuilderUIPagesSerialised, BuilderUIs, BuilderUIsSerialised, BuilderUISerialised, BuilderUIValidated, BuilderValidated, BuilderComponentVariantsValidated, BuilderInstanceValidated, BuilderEnableConfig, BuilderMatchConfig, BuilderMatchSelectMap, BuilderUnlessConfig, BuilderWhen, BuilderWhenConfig, BuilderWhenSerialised } from './entities/index';
 export type { BuilderEnvironment } from './environment';
 export type { BuilderError, BuilderErrorBase, BuilderErrorLocation, BuilderErrors } from './exception';
-export type { BuilderComponentVariantsValidationResult, BuilderErrorDuplicateName, BuilderErrorInvalidCollection, BuilderErrorInvalidCollectionBounds, BuilderErrorInvalidDetail, BuilderErrorInvalidInput, BuilderErrorInvalidOption, BuilderErrorInvalidPath, BuilderErrorInvalidPathReason, BuilderErrorInvalidSelectMapKey, BuilderErrorInvalidVariant, BuilderErrorMissingComponent, BuilderErrorMissingDetail, BuilderErrorMissingReference, BuilderErrorMissingVariant, BuilderErrorUnboundParameter, BuilderErrorUnexpectedComponent, BuilderErrorUnexpectedDetail, BuilderErrorUnmetExpectation, BuilderErrorUnvalidated, BuilderInstanceValidationResult, BuilderModelValidationResult, BuilderOrder, BuilderRenderOption, BuilderRenderOptions, BuilderRenderPage, BuilderRenderPages, BuilderRenderResult, BuilderRenderUpdate, BuilderUIValidationResult, BuilderValidationResult, BuilderVariantsValidationOptions } from './mappers/index';
+export type { BuilderComponentVariantsValidationResult, BuilderErrorDuplicateName, BuilderErrorInvalidCollection, BuilderErrorInvalidCollectionBounds, BuilderErrorInvalidDetail, BuilderErrorInvalidInput, BuilderErrorInvalidOption, BuilderErrorInvalidPath, BuilderErrorInvalidPathReason, BuilderErrorInvalidPricing, BuilderErrorInvalidPricingReason, BuilderErrorInvalidSelectMapKey, BuilderErrorInvalidVariant, BuilderErrorMissingComponent, BuilderErrorMissingDetail, BuilderErrorMissingReference, BuilderErrorMissingVariant, BuilderErrorUnboundParameter, BuilderErrorUnexpectedComponent, BuilderErrorUnexpectedDetail, BuilderErrorUnmetExpectation, BuilderErrorUnvalidated, BuilderInstanceValidationResult, BuilderModelValidationResult, BuilderOrder, BuilderRenderMetadata, BuilderRenderOption, BuilderRenderOptions, BuilderRenderPage, BuilderRenderPages, BuilderRenderResult, BuilderRenderUpdate, BuilderUIValidationResult, BuilderValidationResult, BuilderVariantsValidationOptions } from './mappers/index';
 export type { BuilderComponentVariants, BuilderInstance, BuilderInstanceInput, BuilderInstances, BuilderVariant, BuilderVariants } from './instance';
 export type { BuilderPath, BuilderPaths } from './paths';
 export type { BuilderPrimitive, BuilderPrimitives } from './primitive';
 export type { BuilderParameter, BuilderParameterSerialised, BuilderRef, Paramable, ParamableSerialised } from './references';
 export { bb } from './bb.js';
-export { Builder, builder, detailBoolean, detailNumber, detailString, model, parameter, ref, select, serialise, toggleBoolean, toggleNumber, toggleString } from './entities/index.js';
+export { Builder, builder, detailBoolean, detailNumber, detailString, input, model, parameter, ref, select, serialise, toggleBoolean, toggleNumber, toggleString } from './entities/index.js';
 export { BuilderException } from './exception.js';
 export { ordinal } from './mappers/index.js';
 import { collectionConfig, collectionExpectation, componentDetails, componentExpectation, optionExpectation, uis } from './entities/index.js';

package/dist/index.js

@@ -1,5 +1,5 @@
 export { bb } from './bb.js';
-export { Builder, builder, detailBoolean, detailNumber, detailString, model, parameter, ref, select, serialise, toggleBoolean, toggleNumber, toggleString } from './entities/index.js';
+export { Builder, builder, detailBoolean, detailNumber, detailString, input, model, parameter, ref, select, serialise, toggleBoolean, toggleNumber, toggleString } from './entities/index.js';
 export { BuilderException } from './exception.js';
 export { ordinal } from './mappers/index.js';
 import { collectionConfig, collectionExpectation, collectionWhen, componentDetails, componentExpectation, componentWhen, optionExpectation, optionWhen, uis } from './entities/index.js';

package/dist/instance.d.ts

@@ -10,47 +10,56 @@ export type BuilderInstanceInput = Readonly<Record<string, unknown>>;
 export declare const BuilderVariantSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     readonly instance: v.GenericSchema<BuilderInstance>;
     readonly details: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.NullableSchema<v.UnionSchema<[v.StringSchema<undefined>, v.BooleanSchema<undefined>, v.NumberSchema<undefined>], undefined>, undefined>, undefined>, undefined>;
+    readonly tags: v.OptionalSchema<v.SchemaWithPipe<readonly [v.ArraySchema<v.StringSchema<undefined>, undefined>, v.ReadonlyAction<string[]>]>, undefined>;
 }, undefined>, v.ReadonlyAction<{
     instance: BuilderInstance;
     details?: {
         [x: string]: string | number | boolean | null;
     } | undefined;
+    tags?: readonly string[] | undefined;
 }>]>;
 export type BuilderVariant = v.InferOutput<typeof BuilderVariantSchema>;
 export declare const BuilderVariantsSchema: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
     readonly instance: v.GenericSchema<BuilderInstance>;
     readonly details: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.NullableSchema<v.UnionSchema<[v.StringSchema<undefined>, v.BooleanSchema<undefined>, v.NumberSchema<undefined>], undefined>, undefined>, undefined>, undefined>;
+    readonly tags: v.OptionalSchema<v.SchemaWithPipe<readonly [v.ArraySchema<v.StringSchema<undefined>, undefined>, v.ReadonlyAction<string[]>]>, undefined>;
 }, undefined>, v.ReadonlyAction<{
     instance: BuilderInstance;
     details?: {
         [x: string]: string | number | boolean | null;
     } | undefined;
+    tags?: readonly string[] | undefined;
 }>]>, undefined>, v.ReadonlyAction<Readonly<{
     instance: BuilderInstance;
     details?: {
         [x: string]: string | number | boolean | null;
     } | undefined;
+    tags?: readonly string[] | undefined;
 }>[]>]>;
 export type BuilderVariants = v.InferOutput<typeof BuilderVariantsSchema>;
 export declare const BuilderComponentVariantsSchema: v.SchemaWithPipe<readonly [v.RecordSchema<v.StringSchema<undefined>, v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
     readonly instance: v.GenericSchema<BuilderInstance>;
     readonly details: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.NullableSchema<v.UnionSchema<[v.StringSchema<undefined>, v.BooleanSchema<undefined>, v.NumberSchema<undefined>], undefined>, undefined>, undefined>, undefined>;
+    readonly tags: v.OptionalSchema<v.SchemaWithPipe<readonly [v.ArraySchema<v.StringSchema<undefined>, undefined>, v.ReadonlyAction<string[]>]>, undefined>;
 }, undefined>, v.ReadonlyAction<{
     instance: BuilderInstance;
     details?: {
         [x: string]: string | number | boolean | null;
     } | undefined;
+    tags?: readonly string[] | undefined;
 }>]>, undefined>, v.ReadonlyAction<Readonly<{
     instance: BuilderInstance;
     details?: {
         [x: string]: string | number | boolean | null;
     } | undefined;
+    tags?: readonly string[] | undefined;
 }>[]>]>, undefined>, v.ReadonlyAction<{
     readonly [x: string]: readonly Readonly<{
         instance: BuilderInstance;
         details?: {
             [x: string]: string | number | boolean | null;
         } | undefined;
+        tags?: readonly string[] | undefined;
     }>[];
 }>]>;
 export type BuilderComponentVariants = v.InferOutput<typeof BuilderComponentVariantsSchema>;

package/dist/instance.js

@@ -1,10 +1,12 @@
 import * as v from 'valibot';
 import { BuilderPrimitiveSchema } from './primitive.js';
+import { BuilderTagsSchema } from './entities/tags.js';
 export const BuilderInstanceSchema = v.pipe(v.record(v.string(), v.union([BuilderPrimitiveSchema, v.lazy(() => BuilderInstancesSchema)])), v.readonly());
 export const BuilderInstancesSchema = v.pipe(v.array(BuilderInstanceSchema), v.readonly());
 export const BuilderVariantSchema = v.pipe(v.object({
     instance: BuilderInstanceSchema,
-    details: v.optional(v.record(v.string(), BuilderPrimitiveSchema))
+    details: v.optional(v.record(v.string(), BuilderPrimitiveSchema)),
+    tags: v.optional(BuilderTagsSchema)
 }), v.readonly());
 export const BuilderVariantsSchema = v.pipe(v.array(BuilderVariantSchema), v.readonly());
 export const BuilderComponentVariantsSchema = v.pipe(v.record(v.string(), BuilderVariantsSchema), v.readonly());

package/dist/mappers/index.d.ts

@@ -1,9 +1,11 @@
-export type { BuilderComponentVariantsValidationResult, BuilderErrorDuplicateName, BuilderErrorInvalidCollection, BuilderErrorInvalidCollectionBounds, BuilderErrorInvalidDetail, BuilderErrorInvalidInput, BuilderErrorInvalidOption, BuilderErrorInvalidPath, BuilderErrorInvalidPathReason, BuilderErrorInvalidSelectMapKey, BuilderErrorInvalidVariant, BuilderErrorMissingComponent, BuilderErrorMissingDetail, BuilderErrorMissingReference, BuilderErrorMissingVariant, BuilderErrorUnboundParameter, BuilderErrorUnexpectedComponent, BuilderErrorUnexpectedDetail, BuilderErrorUnmetExpectation, BuilderErrorUnvalidated, BuilderInstanceValidationResult, BuilderModelValidationResult, BuilderUIValidationResult, BuilderValidationResult, BuilderVariantsValidationOptions } from '../validate/index';
+export type { BuilderComponentVariantsValidationResult, BuilderErrorDuplicateName, BuilderErrorInvalidCollection, BuilderErrorInvalidCollectionBounds, BuilderErrorInvalidDetail, BuilderErrorInvalidInput, BuilderErrorInvalidOption, BuilderErrorInvalidPath, BuilderErrorInvalidPathReason, BuilderErrorInvalidPricing, BuilderErrorInvalidPricingReason, BuilderErrorInvalidSelectMapKey, BuilderErrorInvalidVariant, BuilderErrorMissingComponent, BuilderErrorMissingDetail, BuilderErrorMissingReference, BuilderErrorMissingVariant, BuilderErrorUnboundParameter, BuilderErrorUnexpectedComponent, BuilderErrorUnexpectedDetail, BuilderErrorUnmetExpectation, BuilderErrorUnvalidated, BuilderInstanceValidationResult, BuilderModelValidationResult, BuilderPricingValidationResult, BuilderUIValidationResult, BuilderValidationResult, BuilderVariantsValidationOptions } from '../validate/index';
 export type { BuilderOrder } from './order';
-export type { BuilderRenderOption, BuilderRenderOptions, BuilderRenderPage, BuilderRenderPages, BuilderRenderResult, BuilderRenderUpdate } from './render/index';
-export { assertValidated, validateBuilder, validateInstance, validateModel, validateUI, validateVariants } from '../validate/index.js';
+export type { BuilderRenderMetadata, BuilderRenderOption, BuilderRenderOptions, BuilderRenderPage, BuilderRenderPages, BuilderRenderResult, BuilderRenderUpdate } from './render/index';
+export { assertValidated, validateBuilder, validateInstance, validateModel, validatePricing, validateUI, validateVariants } from '../validate/index.js';
+export type { BuilderOptionGraph } from './variants/index.js';
 export { createInstance } from './instance.js';
-export { createVariants } from './variants/index.js';
+export { createVariants, optionGraph, variantsFor } from './variants/index.js';
 export { order } from './order.js';
+export { pricing } from './pricing.js';
 export { ordinal, render } from './render/index.js';
 export { resolveCollection, resolveComponent, resolveOption } from './resolve.js';

package/dist/mappers/index.js

@@ -1,6 +1,7 @@
-export { assertValidated, validateBuilder, validateInstance, validateModel, validateUI, validateVariants } from '../validate/index.js';
+export { assertValidated, validateBuilder, validateInstance, validateModel, validatePricing, validateUI, validateVariants } from '../validate/index.js';
 export { createInstance } from './instance.js';
-export { createVariants } from './variants/index.js';
+export { createVariants, optionGraph, variantsFor } from './variants/index.js';
 export { order } from './order.js';
+export { pricing } from './pricing.js';
 export { ordinal, render } from './render/index.js';
 export { resolveCollection, resolveComponent, resolveOption } from './resolve.js';

package/dist/mappers/pricing.d.ts

@@ -0,0 +1,3 @@
+import type { BuilderModelValidated, BuilderRefEntities } from '../entities/index';
+import type { BuilderOrder } from './order';
+export declare function pricing(model: BuilderModelValidated, pricingInput: unknown, order: BuilderOrder, refs?: BuilderRefEntities): number;

package/dist/mappers/pricing.js

@@ -0,0 +1,101 @@
+import * as v from 'valibot';
+import { check } from '../check.js';
+import { BuilderPricingSchema } from '../entities/index.js';
+import { BuilderVariantSchema } from '../instance.js';
+import { resolveRef } from './resolve.js';
+export function pricing(model, pricingInput, order, refs = []) {
+    const resolved = resolveRef(pricingInput, refs);
+    check.assert(BuilderPricingSchema, resolved, 'Pricing did not resolve to a pricing entity! ❌');
+    const { rates, formula } = resolved;
+    const modelTags = model.tags ?? [];
+    const variants = collectVariants(order);
+    return evaluate(formula);
+    function evaluate(expression, currentVariant = null) {
+        switch (expression.kind) {
+            case 'num':
+                return expression.value;
+            case 'variantPrice':
+                return variantPrice(currentVariant);
+            case 'rate':
+                return evaluateRate(expression, currentVariant);
+            case 'variants':
+                return evaluateVariants(expression);
+            case 'add':
+                return (evaluate(expression.left, currentVariant) + evaluate(expression.right, currentVariant));
+            case 'sub':
+                return (evaluate(expression.left, currentVariant) - evaluate(expression.right, currentVariant));
+            case 'mul':
+                return (evaluate(expression.left, currentVariant) * evaluate(expression.right, currentVariant));
+            case 'div':
+                return (evaluate(expression.left, currentVariant) / evaluate(expression.right, currentVariant));
+        }
+    }
+    function evaluateRate(expression, currentVariant) {
+        const table = rates[expression.rate];
+        check.truthy(table, `Pricing: rate '${expression.rate}' not found! ❌`);
+        const tagOrTags = resolveTagExpression(expression.tag, currentVariant);
+        const keys = Array.isArray(tagOrTags) ? tagOrTags : [tagOrTags];
+        const matches = keys
+            .map((key) => table[key])
+            .filter((value) => typeof value === 'number');
+        check.truthy(matches.length > 0, `Pricing: rate '${expression.rate}' has no entry for keys [${keys.join(', ')}]! ❌`);
+        return reduceValues(matches, expression.reduce ?? 'product');
+    }
+    function evaluateVariants(expression) {
+        const { tag } = expression;
+        const candidates = tag ? variants.filter((variant) => matchesFilter(variant, tag)) : variants;
+        const results = candidates.map((variant) => evaluate(expression.expression, variant));
+        return reduceValues(results, expression.reduce ?? 'sum');
+    }
+    function resolveTagExpression(tag, currentVariant) {
+        switch (tag.kind) {
+            case 'tag':
+                return tag.value;
+            case 'modelTags':
+                return modelTags;
+            case 'variantTags':
+                check.truthy(currentVariant, 'Pricing: variantTags used outside variants iteration! ❌');
+                return currentVariant.tags ?? [];
+        }
+    }
+    function matchesFilter(variant, filter) {
+        if (filter.kind === 'tag') {
+            return (variant.tags ?? []).includes(filter.value);
+        }
+        if (filter.kind === 'modelTags') {
+            return (variant.tags ?? []).some((tag) => modelTags.includes(tag));
+        }
+        check.falsy(true, 'Pricing: variantTags is not a valid variants.tag filter! ❌');
+        return false;
+    }
+}
+function reduceValues(values, mode) {
+    if (mode === 'product') {
+        return values.reduce((accumulator, value) => accumulator * value, 1);
+    }
+    if (mode === 'sum') {
+        return values.reduce((accumulator, value) => accumulator + value, 0);
+    }
+    check.truthy(values.length > 0, 'Pricing: cannot reduce empty set with "first"! ❌');
+    return values[0];
+}
+function variantPrice(variant) {
+    check.truthy(variant, 'Pricing: variantPrice used outside variants iteration! ❌');
+    const price = variant.details?.price;
+    check.assert(v.number(), price, 'Pricing: variant missing numeric price detail! ❌');
+    return price;
+}
+function collectVariants(order) {
+    return Object.values(order).flatMap((value) => {
+        if (value == null) {
+            return [];
+        }
+        if (check.is(BuilderVariantSchema, value)) {
+            return [value];
+        }
+        if (Array.isArray(value)) {
+            return value.flatMap(collectVariants);
+        }
+        return collectVariants(value);
+    });
+}

package/dist/mappers/render/index.d.ts

@@ -1,4 +1,4 @@
-export type { BuilderRenderOption, BuilderRenderOptions, BuilderRenderPage, BuilderRenderPages, BuilderRenderUpdate } from './pages';
+export type { BuilderRenderMetadata, BuilderRenderOption, BuilderRenderOptions, BuilderRenderPage, BuilderRenderPages, BuilderRenderUpdate } from './pages';
 export type { BuilderRenderResult } from './render';
 export { render } from './render.js';
 export { ordinal } from './ordinal.js';

package/dist/mappers/render/pages.d.ts

@@ -1,12 +1,20 @@
 import type { BuilderOptionValuesSerialised } from '../../entities/index';
 import type { BuilderPrimitive } from '../../primitive';
 import type { BuilderInstance } from '../../instance';
+import * as v from 'valibot';
 export type BuilderRenderUpdate = (model: BuilderInstance, primitive: BuilderPrimitive) => BuilderInstance;
+export declare const BuilderRenderMetadataSchema: v.SchemaWithPipe<readonly [v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, v.ReadonlyAction<{
+    [x: string]: unknown;
+}>]>;
+export type BuilderRenderMetadata = v.InferOutput<typeof BuilderRenderMetadataSchema>;
 export type BuilderRenderOption = Readonly<{
     name: string;
     value: BuilderPrimitive;
     update: BuilderRenderUpdate;
     option: BuilderOptionValuesSerialised;
+    displayName?: string;
+    kind?: string;
+    metadata?: BuilderRenderMetadata;
 }>;
 export type BuilderRenderOptions = ReadonlyArray<BuilderRenderOption>;
 export type BuilderRenderPage = Readonly<{

package/dist/mappers/render/pages.js

@@ -1 +1,2 @@
-export {};
+import * as v from 'valibot';
+export const BuilderRenderMetadataSchema = v.pipe(v.record(v.string(), v.unknown()), v.readonly());

package/dist/mappers/render/render.js

@@ -1,3 +1,4 @@
+import { BuilderRenderMetadataSchema } from './pages.js';
 import * as v from 'valibot';
 import { check } from '../../check.js';
 import { BuilderInstancesSchema } from '../../instance.js';
@@ -37,7 +38,8 @@ export function render(builder, instance, refs = []) {
         });
     }
     function emitPage(page, model, collectionPath, labelContext, currentInstance) {
-        const options = page.paths.flatMap((path) => {
+        const options = page.inputs.flatMap((input) => {
+            const { path } = input;
             const found = resolvePath(model, currentInstance, path, refs);
             if (found == null) {
                 return [];
@@ -49,7 +51,10 @@ export function render(builder, instance, refs = []) {
                     name: found.name,
                     option: found.payload,
                     value: found.value,
-                    update: (updateInstance, updateValue) => createInstance(builder, setPath(updateInstance, fullPath, updateValue), refs)
+                    update: (updateInstance, updateValue) => createInstance(builder, setPath(updateInstance, fullPath, updateValue), refs),
+                    displayName: input.displayName && composeString(input.displayName, 'displayName'),
+                    kind: input.kind && composeString(input.kind, 'kind'),
+                    metadata: input.metadata && composeMetadata(input.metadata)
                 }
             ];
         });
@@ -60,7 +65,8 @@ export function render(builder, instance, refs = []) {
     }
     function emitDescribe(describe, model, labelContext, currentInstance) {
         const composedLabel = composeLabel(describe.label, labelContext);
-        const values = describe.paths.flatMap((path) => {
+        const values = describe.inputs.flatMap((input) => {
+            const { path } = input;
             const found = resolvePath(model, currentInstance, path, refs);
             if (found?.value == null) {
                 return [];
@@ -84,6 +90,16 @@ export function render(builder, instance, refs = []) {
         }
         return `${labelContext.join(', ')}, ${resolved}`;
     }
+    function composeString(value, fieldLabel) {
+        const resolved = resolveRef(value, refs);
+        check.assert(v.string(), resolved, `Input ${fieldLabel} did not resolve to a string! ❌`);
+        return resolved;
+    }
+    function composeMetadata(value) {
+        const resolved = resolveRef(value, refs);
+        check.assert(BuilderRenderMetadataSchema, resolved, 'Input metadata did not resolve to an object! ❌');
+        return Object.fromEntries(Object.entries(resolved).map(([key, entry]) => [key, resolveRef(entry, refs)]));
+    }
     function findCollection(model, instance, collectionName) {
         const entry = model.collections.find((candidate) => candidate.name === collectionName);
         return entry == null ? null : resolveCollection(entry, model, instance, refs);

package/dist/mappers/resolve.d.ts

@@ -1,13 +1,13 @@
-import type { BuilderCollectionConfigValidated, BuilderCollectionValidated, BuilderComponentDetailsSerialised, BuilderComponentValidated, BuilderModelValidated, BuilderOptionValidated, BuilderOptionValuesSerialised, BuilderRefEntities } from '../entities/index';
+import type { BuilderCollectionConfigValidated, BuilderCollectionValidated, BuilderComponentDetailsValidated, BuilderComponentValidated, BuilderModelValidated, BuilderOptionValidated, BuilderOptionValuesValidated, BuilderRefEntities } from '../entities/index';
 import type { BuilderInstance } from '../instance';
 import type { BuilderPath } from '../paths';
-export declare function resolveOption(option: BuilderOptionValidated, model: BuilderModelValidated, instance: unknown, refs?: BuilderRefEntities): BuilderOptionValuesSerialised | null;
-export declare function resolveComponent(component: BuilderComponentValidated, model: BuilderModelValidated, instance: unknown, refs?: BuilderRefEntities): BuilderComponentDetailsSerialised | null;
+export declare function resolveOption(option: BuilderOptionValidated, model: BuilderModelValidated, instance: unknown, refs?: BuilderRefEntities): BuilderOptionValuesValidated | null;
+export declare function resolveComponent(component: BuilderComponentValidated, model: BuilderModelValidated, instance: unknown, refs?: BuilderRefEntities): BuilderComponentDetailsValidated | null;
 export declare function resolveCollection(collection: BuilderCollectionValidated, model: BuilderModelValidated, instance: unknown, refs?: BuilderRefEntities): BuilderCollectionConfigValidated | null;
 export declare function resolveRef(value: unknown, refs: BuilderRefEntities): unknown;
 export type ResolvedPath = {
     readonly name: string;
-    readonly payload: BuilderOptionValuesSerialised;
+    readonly payload: BuilderOptionValuesValidated;
     readonly value: unknown;
 };
 export declare function resolvePath(model: BuilderModelValidated, instance: unknown, path: BuilderPath, refs?: BuilderRefEntities): ResolvedPath | null;

package/dist/mappers/variants/index.d.ts

@@ -1 +1,2 @@
-export { createVariants } from './variants.js';
+export { BuilderOptionGraph } from './option-graph.js';
+export { createVariants, optionGraph, variantsFor } from './variants.js';

package/dist/mappers/variants/index.js

@@ -1 +1,2 @@
-export { createVariants } from './variants.js';
+export { BuilderOptionGraph } from './option-graph.js';
+export { createVariants, optionGraph, variantsFor } from './variants.js';

package/dist/mappers/variants/variants.d.ts

@@ -1,3 +1,6 @@
-import type { BuilderModelValidated, BuilderValidated } from '../../entities/index';
-import type { BuilderComponentVariants } from '../../instance';
+import type { BuilderCollectionValidated, BuilderComponentValidated, BuilderModelValidated, BuilderValidated } from '../../entities/index';
+import type { BuilderComponentVariants, BuilderInstances } from '../../instance';
+import { BuilderOptionGraph } from './option-graph.js';
 export declare function createVariants(entity: BuilderValidated | BuilderModelValidated): BuilderComponentVariants;
+export declare function optionGraph(model: BuilderModelValidated): BuilderOptionGraph;
+export declare function variantsFor(entity: BuilderComponentValidated | BuilderCollectionValidated, options: BuilderOptionGraph): BuilderInstances;