@builder-builder/builder 0.0.6 → 0.0.7

package/dist/resolve/validate.d.ts

@@ -1,33 +1,37 @@
 import type { BuilderData, BuilderModel } from '../model';
-import type { BuilderGeneric } from '../core/index';
+import type { BuilderValidated } from '../core/validate';
 declare const validated: unique symbol;
 export type BuilderDataValidated = BuilderData & {
     readonly [validated]: true;
 };
-export type BuilderErrorComponentMissing = {
-    readonly type: 'missing-component';
+export type BuilderDataErrorComponentMissing = {
+    readonly kind: 'missing-component';
     readonly component: string;
 };
-export type BuilderErrorComponentUnexpected = {
-    readonly type: 'unexpected-component';
+export type BuilderDataErrorComponentUnexpected = {
+    readonly kind: 'unexpected-component';
     readonly component: string;
 };
-export type BuilderErrorVariantMissing = {
-    readonly type: 'missing-variant';
+export type BuilderDataErrorVariantMissing = {
+    readonly kind: 'missing-variant';
     readonly component: string;
     readonly model: BuilderModel;
 };
-export type BuilderErrorVariantInvalid = {
-    readonly type: 'invalid-variant';
+export type BuilderDataErrorVariantInvalid = {
+    readonly kind: 'invalid-variant';
     readonly component: string;
     readonly model: BuilderModel;
 };
-export type BuilderErrorValidate = BuilderErrorComponentMissing | BuilderErrorComponentUnexpected | BuilderErrorVariantMissing | BuilderErrorVariantInvalid;
-export type BuilderErrorsValidate = ReadonlyArray<BuilderErrorValidate>;
-export type BuilderValidateResult = readonly [BuilderDataValidated, BuilderErrorsValidate];
-export declare const validate: typeof validateBuilder & {
-    strict: typeof validateStrict;
+export type BuilderDataError = BuilderDataErrorComponentMissing | BuilderDataErrorComponentUnexpected | BuilderDataErrorVariantMissing | BuilderDataErrorVariantInvalid;
+export type BuilderDataErrors = ReadonlyArray<BuilderDataError>;
+export type BuilderDataValidateResult = readonly [BuilderDataValidated, BuilderDataErrors];
+export type BuilderDataValidateOptions = {
+    readonly strict: true;
 };
-declare function validateBuilder(builder: BuilderGeneric, builderModels: BuilderData): BuilderValidateResult;
-declare function validateStrict(builder: BuilderGeneric, builderModels: BuilderData): BuilderValidateResult;
+export declare class BuilderDataValidateError extends Error {
+    readonly errors: BuilderDataErrors;
+    constructor(errors: BuilderDataErrors);
+}
+export declare const validate: typeof validateData;
+declare function validateData(builder: BuilderValidated, builderData: BuilderData, options?: BuilderDataValidateOptions): BuilderDataValidateResult;
 export {};

package/dist/resolve/validate.js

@@ -1,12 +1,19 @@
 import { models } from './models.js';
-export const validate = Object.assign(validateBuilder, { strict: validateStrict });
-function validateBuilder(builder, builderModels) {
+export class BuilderDataValidateError extends Error {
+    errors;
+    constructor(errors) {
+        super('data validation failed');
+        this.errors = errors;
+    }
+}
+export const validate = validateData;
+function validateData(builder, builderData, options) {
     const expected = models(builder);
     let errors = [];
     Object.entries(expected).forEach(([component, expectedModels]) => {
-        const componentModels = builderModels[component];
+        const componentModels = builderData[component];
         if (!componentModels) {
-            errors = [...errors, { type: 'missing-component', component }];
+            errors = [...errors, { kind: 'missing-component', component }];
             return;
         }
         const expectedKeys = new Map(expectedModels.map((variant) => [sortedKey(variant.model), variant.model]));
@@ -15,37 +22,26 @@ function validateBuilder(builder, builderModels) {
             const key = sortedKey(variant.model);
             actualKeys.add(key);
             if (!expectedKeys.has(key)) {
-                errors = [...errors, { type: 'invalid-variant', component, model: variant.model }];
+                errors = [...errors, { kind: 'invalid-variant', component, model: variant.model }];
             }
         });
         expectedKeys.forEach((model, key) => {
             if (!actualKeys.has(key)) {
-                errors = [...errors, { type: 'missing-variant', component, model }];
+                errors = [...errors, { kind: 'missing-variant', component, model }];
             }
         });
     });
-    Object.keys(builderModels).forEach((component) => {
+    Object.keys(builderData).forEach((component) => {
         if (!expected[component]) {
-            errors = [...errors, { type: 'unexpected-component', component }];
+            errors = [...errors, { kind: 'unexpected-component', component }];
         }
     });
-    return [builderModels, errors];
-}
-function validateStrict(builder, builderModels) {
-    const [data, errors] = validateBuilder(builder, builderModels);
-    if (errors.length > 0) {
-        throw new ValidateException(errors);
+    if (options?.strict && errors.length > 0) {
+        throw new BuilderDataValidateError(errors);
     }
-    return [data, []];
+    return [builderData, errors];
 }
 function sortedKey(model) {
     const entries = Object.entries(model).filter(([, value]) => value != null);
     return JSON.stringify(entries.sort(([keyA], [keyB]) => keyA.localeCompare(keyB)));
 }
-class ValidateException extends Error {
-    errors;
-    constructor(errors) {
-        super(`Builder validation failed with ${String(errors.length)} error(s)`);
-        this.errors = errors;
-    }
-}

package/dist/serialise/deserialise.d.ts

@@ -1,9 +1,14 @@
 import type { BuilderGeneric } from '../core/index';
 import type { BuilderUIGeneric } from '../ui';
+import type { BuilderSelectTypeSerialised } from './schemas';
+import { Builder, BuilderSelectType } from '../core/index.js';
 export declare const deserialise: {
     builder: typeof deserialiseBuilder;
+    select: typeof deserialiseSelect;
     ui: typeof deserialiseUI;
+    validate: (data: unknown, options?: import("./validate.js").BuilderSerialisedValidateOptions) => import("./validate.js").BuilderSerialisedValidateResult;
 };
-declare function deserialiseBuilder(data: unknown): BuilderGeneric;
+declare function deserialiseBuilder(data: unknown): Builder;
 declare function deserialiseUI(builder: BuilderGeneric, data: unknown): BuilderUIGeneric;
+declare function deserialiseSelect(data: BuilderSelectTypeSerialised): BuilderSelectType;
 export {};

package/dist/serialise/deserialise.js

@@ -1,23 +1,26 @@
 import * as v from 'valibot';
-import { BuilderCollection, BuilderComponent, BuilderExpectation, BuilderOption, Builder, BuilderParameter, BuilderSelectType, BuilderToggleType } from '../core/index.js';
-import { BuilderSerialisedSchema, BuilderUIItemsSerialisedSchema } from './schemas.js';
+import { Builder, BuilderCollection, BuilderComponent, BuilderExpectation, BuilderOption, BuilderParameter, BuilderSelectType, BuilderToggleType } from '../core/index.js';
 import { BuilderUI } from '../ui.js';
+import { BuilderSerialisedSchema, BuilderUISerialisedSchema } from './schemas.js';
+import { validate as validateSerialised } from './validate.js';
 export const deserialise = {
     builder: deserialiseBuilder,
-    ui: deserialiseUI
+    select: deserialiseSelect,
+    ui: deserialiseUI,
+    validate: validateSerialised
 };
 function deserialiseBuilder(data) {
-    return buildBuilder(v.parse(BuilderSerialisedSchema, data));
+    const builderSerialised = v.parse(BuilderSerialisedSchema, data);
+    const options = builderSerialised.options.map(deserialiseOption);
+    const components = builderSerialised.components.map(deserialiseComponent);
+    const collections = builderSerialised.collections.map(deserialiseCollection);
+    const expectations = builderSerialised.expectations.map((expectation) => new BuilderExpectation(expectation.name, expectation.kind));
+    return new Builder(options, components, collections, expectations);
 }
 function deserialiseUI(builder, data) {
-    return new BuilderUI(builder, v.parse(BuilderUIItemsSerialisedSchema, data));
-}
-function buildBuilder(data) {
-    const options = data.options.map(deserialiseOption);
-    const components = data.components.map(deserialiseComponent);
-    const collections = data.collections.map(deserialiseCollection);
-    const expectations = data.expectations.map((expectation) => new BuilderExpectation(expectation.name, expectation.kind));
-    return new Builder(options, collections, components, expectations);
+    const parsed = v.parse(BuilderUISerialisedSchema, data);
+    const expectations = parsed.expectations.map((expectation) => new BuilderExpectation(expectation.name, expectation.kind));
+    return new BuilderUI(builder, parsed.items, expectations);
 }
 function deserialiseOption(data) {
     const values = deserialiseValues(data.values);
@@ -28,29 +31,29 @@ function deserialiseComponent(data) {
     return new BuilderComponent(data.name, data.paths, data.dependencies);
 }
 function deserialiseCollection(data) {
-    const built = buildBuilder(data.builder);
+    const builder = deserialiseBuilder(data.builder);
     const config = deserialiseCollectionWhenConfig(data.config);
-    return new BuilderCollection(data.name, built, data.min, data.max, data.gatePaths, config);
+    return new BuilderCollection(data.name, builder, data.min, data.max, data.gatePaths, config);
+}
+function deserialiseSelect(data) {
+    const { optional, options, defaultValue, labels } = data;
+    const valueSchema = v.union(options.map((value) => v.literal(value)));
+    return new BuilderSelectType(options, optional ? v.nullable(valueSchema) : valueSchema, defaultValue, optional, labels);
 }
 function deserialiseValues(data) {
     if (data.type === 'parameter') {
         return new BuilderParameter();
     }
     if (data.type === 'select') {
-        const { optional, options, defaultValue, labels } = data;
-        const valueSchema = v.union(options.map((value) => v.literal(value)));
-        return new BuilderSelectType(options, optional ? v.nullable(valueSchema) : valueSchema, defaultValue, optional, labels);
+        return deserialiseSelect(data);
     }
-    const valueSchema = deserialiseToggleValueSchema(data.valueType, data.optional);
-    return new BuilderToggleType(valueSchema, data.defaultValue, data.optional);
-}
-function deserialiseToggleValueSchema(valueType, optional) {
-    const base = valueType.includes('boolean')
+    const baseSchema = data.valueType === 'boolean'
         ? v.boolean()
-        : valueType.includes('string')
+        : data.valueType === 'string'
             ? v.string()
             : v.number();
-    return optional ? v.nullable(base) : base;
+    const valueSchema = data.optional ? v.nullable(baseSchema) : baseSchema;
+    return new BuilderToggleType(data.valueType, valueSchema, data.defaultValue, data.optional);
 }
 function deserialiseOptionWhenConfig(data) {
     if (data === null) {
@@ -88,26 +91,29 @@ function deserialiseCollectionWhenConfig(data) {
     switch (data.type) {
         case 'enable': {
             const { max, min, builder: builderData, type } = data;
-            return { type, builder: buildBuilder(builderData), min, max };
+            return { type, builder: deserialiseBuilder(builderData), min, max };
         }
         case 'match': {
-            const { matchPath, selectMap, type } = data;
-            const deserialisedSelectMap = Object.fromEntries(Object.entries(selectMap).map(([key, value]) => {
+            const { matchPath, type } = data;
+            const deserialisedSelectMap = Object.fromEntries(Object.entries(data.selectMap).map(([key, value]) => {
                 if (!value) {
                     return [key, null];
                 }
                 const { builder: builderData, min, max } = value;
-                return [key, { builder: buildBuilder(builderData), min, max }];
+                return [key, { builder: deserialiseBuilder(builderData), min, max }];
             }));
-            return {
-                type,
-                matchPath,
-                selectMap: deserialisedSelectMap
-            };
+            return { type, matchPath, selectMap: deserialisedSelectMap };
         }
         case 'unless': {
             const { disabledValues, max, min, builder: builderData, type, unlessPath } = data;
-            return { type, unlessPath, disabledValues, builder: buildBuilder(builderData), min, max };
+            return {
+                type,
+                unlessPath,
+                disabledValues,
+                builder: deserialiseBuilder(builderData),
+                min,
+                max
+            };
         }
     }
 }

package/dist/serialise/index.d.ts

@@ -1,4 +1,6 @@
 export type { BuilderCollectionSerialised, BuilderCollectionConfigSerialised, BuilderCollectionEnableConfigSerialised, BuilderCollectionMatchConfigSerialised, BuilderCollectionUnlessConfigSerialised, BuilderCollectionWhenConfigSerialised, BuilderComponentSerialised, BuilderExpectationSerialised, BuilderOptionSerialised, BuilderOptionEnableConfigSerialised, BuilderOptionMatchConfigSerialised, BuilderOptionUnlessConfigSerialised, BuilderOptionWhenConfigSerialised, BuilderSerialised, BuilderSelectTypeSerialised, BuilderToggleTypeSerialised, BuilderUISerialised, BuilderUICollectionSerialised, BuilderUIDescribeSerialised, BuilderUIItemSerialised, BuilderUIItemsSerialised, BuilderUIPageSerialised, BuilderParameterSerialised, BuilderValuesSerialised } from './schemas';
-export { BuilderCollectionConfigSerialisedSchema, BuilderCollectionEnableConfigSerialisedSchema, BuilderCollectionMatchConfigSerialisedSchema, BuilderCollectionSerialisedSchema, BuilderCollectionUnlessConfigSerialisedSchema, BuilderCollectionWhenConfigSerialisedSchema, BuilderComponentSerialisedSchema, BuilderExpectationSerialisedSchema, BuilderOptionEnableConfigSerialisedSchema, BuilderOptionMatchConfigSerialisedSchema, BuilderOptionSerialisedSchema, BuilderOptionUnlessConfigSerialisedSchema, BuilderOptionWhenConfigSerialisedSchema, BuilderSerialisedSchema, BuilderSelectTypeSerialisedSchema, BuilderToggleTypeSerialisedSchema, BuilderUICollectionSerialisedSchema, BuilderUIDescribeSerialisedSchema, BuilderUIItemSerialisedSchema, BuilderUIItemsSerialisedSchema, BuilderUIPageSerialisedSchema, BuilderValuesSerialisedSchema } from './schemas.js';
+export { BuilderCollectionConfigSerialisedSchema, BuilderCollectionEnableConfigSerialisedSchema, BuilderCollectionMatchConfigSerialisedSchema, BuilderCollectionSerialisedSchema, BuilderCollectionUnlessConfigSerialisedSchema, BuilderCollectionWhenConfigSerialisedSchema, BuilderComponentSerialisedSchema, BuilderExpectationSerialisedSchema, BuilderOptionEnableConfigSerialisedSchema, BuilderOptionMatchConfigSerialisedSchema, BuilderOptionSerialisedSchema, BuilderOptionUnlessConfigSerialisedSchema, BuilderOptionWhenConfigSerialisedSchema, BuilderSerialisedSchema, BuilderSelectTypeSerialisedSchema, BuilderToggleTypeSerialisedSchema, BuilderUICollectionSerialisedSchema, BuilderUIDescribeSerialisedSchema, BuilderUIItemSerialisedSchema, BuilderUIItemsSerialisedSchema, BuilderUIPageSerialisedSchema, BuilderUISerialisedSchema, BuilderValuesSerialisedSchema } from './schemas.js';
+export type { BuilderSerialisedValidated, BuilderSerialisedError, BuilderSerialisedErrors, BuilderSerialisedValidateOptions, BuilderSerialisedValidateResult } from './validate';
 export { deserialise } from './deserialise.js';
 export { serialise } from './serialise.js';
+export { BuilderSerialisedValidateError } from './validate.js';

package/dist/serialise/index.js

@@ -1,3 +1,4 @@
-export { BuilderCollectionConfigSerialisedSchema, BuilderCollectionEnableConfigSerialisedSchema, BuilderCollectionMatchConfigSerialisedSchema, BuilderCollectionSerialisedSchema, BuilderCollectionUnlessConfigSerialisedSchema, BuilderCollectionWhenConfigSerialisedSchema, BuilderComponentSerialisedSchema, BuilderExpectationSerialisedSchema, BuilderOptionEnableConfigSerialisedSchema, BuilderOptionMatchConfigSerialisedSchema, BuilderOptionSerialisedSchema, BuilderOptionUnlessConfigSerialisedSchema, BuilderOptionWhenConfigSerialisedSchema, BuilderSerialisedSchema, BuilderSelectTypeSerialisedSchema, BuilderToggleTypeSerialisedSchema, BuilderUICollectionSerialisedSchema, BuilderUIDescribeSerialisedSchema, BuilderUIItemSerialisedSchema, BuilderUIItemsSerialisedSchema, BuilderUIPageSerialisedSchema, BuilderValuesSerialisedSchema } from './schemas.js';
+export { BuilderCollectionConfigSerialisedSchema, BuilderCollectionEnableConfigSerialisedSchema, BuilderCollectionMatchConfigSerialisedSchema, BuilderCollectionSerialisedSchema, BuilderCollectionUnlessConfigSerialisedSchema, BuilderCollectionWhenConfigSerialisedSchema, BuilderComponentSerialisedSchema, BuilderExpectationSerialisedSchema, BuilderOptionEnableConfigSerialisedSchema, BuilderOptionMatchConfigSerialisedSchema, BuilderOptionSerialisedSchema, BuilderOptionUnlessConfigSerialisedSchema, BuilderOptionWhenConfigSerialisedSchema, BuilderSerialisedSchema, BuilderSelectTypeSerialisedSchema, BuilderToggleTypeSerialisedSchema, BuilderUICollectionSerialisedSchema, BuilderUIDescribeSerialisedSchema, BuilderUIItemSerialisedSchema, BuilderUIItemsSerialisedSchema, BuilderUIPageSerialisedSchema, BuilderUISerialisedSchema, BuilderValuesSerialisedSchema } from './schemas.js';
 export { deserialise } from './deserialise.js';
 export { serialise } from './serialise.js';
+export { BuilderSerialisedValidateError } from './validate.js';