wysiwyv 0.1.0

package/dist/hooks/index.js

@@ -0,0 +1,28 @@
+import andWyvern from "./and";
+import anyWyvern from "./any";
+import arrayWyvern from "./array";
+import boolWyvern from "./bool";
+import datetimeWyvern from "./datetime";
+import emailWyvern from "./email";
+import intWyvern from "./int";
+import numberWyvern from "./number";
+import objectWyvern from "./object";
+import orWyvern from "./or";
+import stringWyvern from "./string";
+import uuidWyvern from "./uuid";
+import valWyvern from "./val";
+export const defaultHooks = [
+    andWyvern,
+    anyWyvern,
+    arrayWyvern,
+    boolWyvern,
+    datetimeWyvern,
+    emailWyvern,
+    intWyvern,
+    numberWyvern,
+    objectWyvern,
+    orWyvern,
+    stringWyvern,
+    uuidWyvern,
+    valWyvern,
+];

package/dist/hooks/int.d.ts

@@ -0,0 +1,13 @@
+import type { ContextObject } from "../type/plugin";
+import type { HookKey } from "../type/plugin";
+import type { WyvPlugin } from "../type/plugin";
+export declare const WYV_KEY_INT: HookKey;
+type WyvParams = {
+    $min?: number;
+    $max?: number;
+};
+type WyvSetup = unknown;
+type WyvContext = ContextObject;
+declare const intWyvern: WyvPlugin<WyvParams, WyvSetup, WyvContext>;
+export default intWyvern;
+//# sourceMappingURL=int.d.ts.map

package/dist/hooks/int.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"int.d.ts","sourceRoot":"","sources":["../../src/hooks/int.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAKhD,eAAO,MAAM,WAAW,EAAE,OAAgB,CAAC;AAE3C,KAAK,SAAS,GAAG;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AACF,KAAK,QAAQ,GAAG,OAAO,CAAC;AACxB,KAAK,UAAU,GAAG,aAAa,CAAC;AAEhC,QAAA,MAAM,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,CA2BzD,CAAC;AAEF,eAAe,SAAS,CAAC"}

package/dist/hooks/int.js

@@ -0,0 +1,24 @@
+import { HookAssessor } from "../util/HookAssessment";
+import { errType, errAttr } from "../util/HookError";
+import { isDefined, isNumber, isObject } from "../util/types";
+export const WYV_KEY_INT = "$int";
+const intWyvern = {
+    handles: (value) => [WYV_KEY_INT].includes(value),
+    handlers: {
+        [WYV_KEY_INT]: (value, _expected, { path, params }) => {
+            if (!isNumber(value) || !Number.isInteger(value)) {
+                return HookAssessor.fault(errType("integer", value, path));
+            }
+            const errors = HookAssessor.start();
+            const { $min, $max } = isObject(params) ? params : {};
+            if (isDefined($min) && isNumber($min) && value < $min) {
+                errors.fault(errAttr(WYV_KEY_INT + "." + "$min", "≥" + $min, value, path));
+            }
+            if (isDefined($max) && isNumber($max) && value > $max) {
+                errors.fault(errAttr(WYV_KEY_INT + "." + "$max", "≤" + $max, value, path));
+            }
+            return errors;
+        },
+    },
+};
+export default intWyvern;

package/dist/hooks/number.d.ts

@@ -0,0 +1,15 @@
+import type { ContextObject } from "../type/plugin";
+import type { HookKey } from "../type/plugin";
+import type { WyvPlugin } from "../type/plugin";
+export declare const WYV_KEY_NUMBER: HookKey;
+type WyvParams = {
+    $min?: number;
+    $max?: number;
+    $gt?: number;
+    $lt?: number;
+};
+type WyvSetup = unknown;
+type WyvContext = ContextObject;
+declare const numberWyvern: WyvPlugin<WyvParams, WyvSetup, WyvContext>;
+export default numberWyvern;
+//# sourceMappingURL=number.d.ts.map

package/dist/hooks/number.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../../src/hooks/number.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAKhD,eAAO,MAAM,cAAc,EAAE,OAAmB,CAAC;AAEjD,KAAK,SAAS,GAAG;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AACF,KAAK,QAAQ,GAAG,OAAO,CAAC;AACxB,KAAK,UAAU,GAAG,aAAa,CAAC;AAEhC,QAAA,MAAM,YAAY,EAAE,SAAS,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,CAgC5D,CAAC;AAEF,eAAe,YAAY,CAAC"}

package/dist/hooks/number.js

@@ -0,0 +1,30 @@
+import { HookAssessor } from "../util/HookAssessment";
+import { errType, errAttr } from "../util/HookError";
+import { isDefined, isNumber, isObject } from "../util/types";
+export const WYV_KEY_NUMBER = "$number";
+const numberWyvern = {
+    handles: (value) => [WYV_KEY_NUMBER].includes(value),
+    handlers: {
+        [WYV_KEY_NUMBER]: (value, _expected, { path, params }) => {
+            if (!isNumber(value)) {
+                return HookAssessor.fault(errType("number", value, path));
+            }
+            const errors = HookAssessor.start();
+            const { $min, $max, $gt, $lt } = isObject(params) ? params : {};
+            if (isDefined($min) && value < $min) {
+                errors.fault(errAttr(WYV_KEY_NUMBER + "." + "$min", "≥" + $min, value, path));
+            }
+            if (isDefined($max) && value > $max) {
+                errors.fault(errAttr(WYV_KEY_NUMBER + "." + "$max", "≤" + $max, value, path));
+            }
+            if (isDefined($gt) && value <= $gt) {
+                errors.fault(errAttr(WYV_KEY_NUMBER + "." + "$gt", ">" + $gt, value, path));
+            }
+            if (isDefined($lt) && value >= $lt) {
+                errors.fault(errAttr(WYV_KEY_NUMBER + "." + "$lt", "<" + $lt, value, path));
+            }
+            return errors;
+        },
+    },
+};
+export default numberWyvern;

package/dist/hooks/object.d.ts

@@ -0,0 +1,14 @@
+import type { HookValue } from "../type/template";
+import type { ContextObject } from "../type/plugin";
+import type { WyvPlugin } from "../type/plugin";
+export declare const WYV_KEY_OBJECT = "$object";
+export declare const WYV_KEY_PLAINOBJECT = "$plainobject";
+type WyvParams = {
+    $partial?: HookValue;
+    $eachElement?: HookValue;
+};
+type WyvSetup = unknown;
+type WyvContext = ContextObject;
+declare const objectWyvern: WyvPlugin<WyvParams, WyvSetup, WyvContext>;
+export default objectWyvern;
+//# sourceMappingURL=object.d.ts.map

package/dist/hooks/object.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/hooks/object.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAAE,aAAa,EAAe,MAAM,gBAAgB,CAAC;AACjE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAKhD,eAAO,MAAM,cAAc,YAAY,CAAC;AACxC,eAAO,MAAM,mBAAmB,iBAAiB,CAAC;AAElD,KAAK,SAAS,GAAG;IACf,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,YAAY,CAAC,EAAE,SAAS,CAAC;CAC1B,CAAC;AACF,KAAK,QAAQ,GAAG,OAAO,CAAC;AACxB,KAAK,UAAU,GAAG,aAAa,CAAC;AA6HhC,QAAA,MAAM,YAAY,EAAE,SAAS,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,CAM5D,CAAC;AAEF,eAAe,YAAY,CAAC"}

package/dist/hooks/object.js

@@ -0,0 +1,80 @@
+import { HookAssessor } from "../util/HookAssessment";
+import { errConfig, errMissing, errType } from "../util/HookError";
+import { isDefined, isObject, isPlainObject } from "../util/types";
+export const WYV_KEY_OBJECT = "$object";
+export const WYV_KEY_PLAINOBJECT = "$plainobject";
+const validatePartial = ($partial, value, path, evaluate) => {
+    const errors = HookAssessor.start();
+    if (!isPlainObject($partial)) {
+        errors.fault(errConfig("$object.$partial option should be an object", path));
+    }
+    else {
+        for (const expectedKey in $partial) {
+            if (!(expectedKey in value)) {
+                errors.fault(errMissing(expectedKey, $partial[expectedKey], `${path}.${expectedKey}`));
+                continue;
+            }
+            const expectedSub = $partial[expectedKey]; // because it came from a hook object
+            const candidateSub = value[expectedKey];
+            const valueErrors = evaluate(expectedSub, candidateSub, `${path}.${expectedKey}`);
+            errors.include(valueErrors);
+        }
+    }
+    return errors;
+};
+const validateEachElement = ($eachElement, value, path, evaluate) => {
+    const errors = HookAssessor.start();
+    for (const valueKey in value) {
+        const eachErrors = evaluate($eachElement, value[valueKey], `${path}.${valueKey}`);
+        errors.include(eachErrors);
+    }
+    return errors;
+};
+const validateObject = (plainOnly) => (value, _expected, { path, params, evaluate }) => {
+    if (plainOnly) {
+        if (!isPlainObject(value)) {
+            return HookAssessor.fault(errType("plainobject", value, path));
+        }
+    }
+    else {
+        if (!isObject(value)) {
+            return HookAssessor.fault(errType("object", value, path));
+        }
+    }
+    const errors = HookAssessor.start();
+    const { $partial = undefined, $eachElement = undefined, ...rest } = isObject(params) ? params : {};
+    if (Object.keys(rest).length > 0) {
+        errors.fault(errConfig(`Unexpected $object parameters: ${Object.keys(rest)}`, path));
+    }
+    if (isDefined($partial) && isDefined($eachElement)) {
+        errors.fault(errConfig("$object options can specify $partial or $eachElement but not both", path));
+        return errors;
+    }
+    if (isDefined($partial)) {
+        if (!isPlainObject(value)) {
+            errors.fault(errType("plainobject for $partial", value, path));
+        }
+        else {
+            const entireErrors = validatePartial($partial, value, path, evaluate);
+            errors.include(entireErrors);
+        }
+    }
+    if (isDefined($eachElement)) {
+        if (!isPlainObject(value)) {
+            errors.fault(errType("plainobject for $eachElement", value, path));
+        }
+        else {
+            const eachErrors = validateEachElement($eachElement, value, path, evaluate);
+            errors.include(eachErrors);
+        }
+    }
+    return errors;
+};
+const objectWyvern = {
+    handles: (value) => [WYV_KEY_OBJECT, WYV_KEY_PLAINOBJECT].includes(value),
+    handlers: {
+        [WYV_KEY_OBJECT]: validateObject(false),
+        [WYV_KEY_PLAINOBJECT]: validateObject(true),
+    },
+};
+export default objectWyvern;

package/dist/hooks/or.d.ts

@@ -0,0 +1,10 @@
+import type { HookValue } from "../type/template";
+import type { ContextObject } from "../type/plugin";
+import type { WyvPlugin } from "../type/plugin";
+export declare const WYV_KEY_OR = "$or";
+type WyvParams = HookValue[];
+type WyvSetup = unknown;
+type WyvContext = ContextObject;
+declare const orWyvern: WyvPlugin<WyvParams, WyvSetup, WyvContext>;
+export default orWyvern;
+//# sourceMappingURL=or.d.ts.map

package/dist/hooks/or.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"or.d.ts","sourceRoot":"","sources":["../../src/hooks/or.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAIhD,eAAO,MAAM,UAAU,QAAQ,CAAC;AAEhC,KAAK,SAAS,GAAG,SAAS,EAAE,CAAC;AAC7B,KAAK,QAAQ,GAAG,OAAO,CAAC;AACxB,KAAK,UAAU,GAAG,aAAa,CAAC;AAEhC,QAAA,MAAM,QAAQ,EAAE,SAAS,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,CA+BxD,CAAC;AAEF,eAAe,QAAQ,CAAC"}

package/dist/hooks/or.js

@@ -0,0 +1,26 @@
+import { HookAssessor } from "../util/HookAssessment";
+import { errColl, errConfig } from "../util/HookError";
+export const WYV_KEY_OR = "$or";
+const orWyvern = {
+    handles: (value) => [WYV_KEY_OR].includes(value),
+    handlers: {
+        [WYV_KEY_OR]: (value, _expected, { path, params, evaluate }) => {
+            if (!Array.isArray(params)) {
+                return HookAssessor.fault(errConfig("$or value should be an array of templates", path));
+            }
+            if (params.length === 0) {
+                // OR(<no arguments>) is defined as FALSE for boolean algebra
+                return HookAssessor.fault(errConfig(`$or must take one or more predicates`, path));
+            }
+            const errors = HookAssessor.start();
+            for (const template of params) {
+                const templateErrors = evaluate(template, value, path);
+                if (templateErrors.success)
+                    return HookAssessor.SUCCESS;
+                errors.include(templateErrors);
+            }
+            return HookAssessor.fault(errColl("$or", path)).include(errors);
+        },
+    },
+};
+export default orWyvern;

package/dist/hooks/string.d.ts

@@ -0,0 +1,8 @@
+import type { ContextObject, WyvPlugin } from "../type/plugin";
+export declare const WYV_KEY_STRING = "$string";
+type WyvParams = unknown;
+type WyvSetup = unknown;
+type WyvContext = ContextObject;
+declare const stringWyvern: WyvPlugin<WyvParams, WyvSetup, WyvContext>;
+export default stringWyvern;
+//# sourceMappingURL=string.d.ts.map

package/dist/hooks/string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../src/hooks/string.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAK/D,eAAO,MAAM,cAAc,YAAY,CAAC;AAExC,KAAK,SAAS,GAAG,OAAO,CAAC;AACzB,KAAK,QAAQ,GAAG,OAAO,CAAC;AACxB,KAAK,UAAU,GAAG,aAAa,CAAC;AAEhC,QAAA,MAAM,YAAY,EAAE,SAAS,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,CAU5D,CAAC;AAEF,eAAe,YAAY,CAAC"}

package/dist/hooks/string.js

@@ -0,0 +1,16 @@
+import { HookAssessor } from "../util/HookAssessment";
+import { isString } from "../util/types";
+import { errType } from "../util/HookError";
+export const WYV_KEY_STRING = "$string";
+const stringWyvern = {
+    handles: (value) => [WYV_KEY_STRING].includes(value),
+    handlers: {
+        [WYV_KEY_STRING]: (value, _expected, { path }) => {
+            if (!isString(value)) {
+                return HookAssessor.fault(errType("string", value, path));
+            }
+            return HookAssessor.SUCCESS;
+        },
+    },
+};
+export default stringWyvern;

package/dist/hooks/uuid.d.ts

@@ -0,0 +1,9 @@
+import type { ContextObject, HookKey } from "../type/plugin";
+import type { WyvPlugin } from "../type/plugin";
+export declare const WYV_KEY_UUID: HookKey;
+type WyvParams = unknown;
+type WyvSetup = unknown;
+type WyvContext = ContextObject;
+declare const uuidWyvern: WyvPlugin<WyvParams, WyvSetup, WyvContext>;
+export default uuidWyvern;
+//# sourceMappingURL=uuid.d.ts.map

package/dist/hooks/uuid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uuid.d.ts","sourceRoot":"","sources":["../../src/hooks/uuid.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AA4ChD,eAAO,MAAM,YAAY,EAAE,OAAiB,CAAC;AA6B7C,KAAK,SAAS,GAAG,OAAO,CAAC;AACzB,KAAK,QAAQ,GAAG,OAAO,CAAC;AACxB,KAAK,UAAU,GAAG,aAAa,CAAC;AAEhC,QAAA,MAAM,UAAU,EAAE,SAAS,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,CA0B1D,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/hooks/uuid.js

@@ -0,0 +1,78 @@
+import { HookAssessor } from "../util/HookAssessment";
+import { errConfig, errType } from "../util/HookError";
+import { isEmptyObject, isNumber, isString } from "../util/types";
+const hex = "[0-9a-f]";
+const seg8 = `${hex}{8}`;
+const seg4 = `${hex}{4}`;
+const seg3 = `${hex}{3}`;
+const seg12 = `${hex}{12}`;
+const variant = "[89ab]";
+const RE_UUID_NIL_STR = `0{8}-0{4}-0{4}-0{4}-0{12}`;
+const RE_UUID_FFF_STR = `f{8}-f{4}-f{4}-f{4}-f{12}`;
+const makeFullRe = (pattern) => new RegExp(`^${pattern}$`, "i");
+const UUID_VERSIONS = [0, 1, 2, 3, 4, 5, 6, 7, 8, "F", null];
+const isVersion = (val) => UUID_VERSIONS.includes(val);
+const buildVersion = (version) => `${seg8}-${seg4}-${version}${seg3}-${variant}${seg3}-${seg12}`;
+const RE_UUID_V1 = makeFullRe(buildVersion(1));
+const RE_UUID_V2 = makeFullRe(buildVersion(2));
+const RE_UUID_V3 = makeFullRe(buildVersion(3));
+const RE_UUID_V4 = makeFullRe(buildVersion(4));
+const RE_UUID_V5 = makeFullRe(buildVersion(5));
+const RE_UUID_V6 = makeFullRe(buildVersion(6));
+const RE_UUID_V7 = makeFullRe(buildVersion(7));
+const RE_UUID_V8 = makeFullRe(buildVersion(8));
+const RE_UUID_NIL = makeFullRe(RE_UUID_NIL_STR);
+const RE_UUID_FFF = makeFullRe(RE_UUID_FFF_STR);
+const RE_UUID_ANY_VERSIONED = buildVersion("[1-8]");
+const RE_UUID_ANY = makeFullRe([RE_UUID_ANY_VERSIONED, RE_UUID_NIL_STR, RE_UUID_FFF_STR]
+    .map((s) => `(${s})`)
+    .join("|"));
+export const WYV_KEY_UUID = "$uuid";
+const testByVersion = (version, value) => {
+    switch (version) {
+        case 0:
+            return RE_UUID_NIL.test(value);
+        case 1:
+            return RE_UUID_V1.test(value);
+        case 2:
+            return RE_UUID_V2.test(value);
+        case 3:
+            return RE_UUID_V3.test(value);
+        case 4:
+            return RE_UUID_V4.test(value);
+        case 5:
+            return RE_UUID_V5.test(value);
+        case 6:
+            return RE_UUID_V6.test(value);
+        case 7:
+            return RE_UUID_V7.test(value);
+        case 8:
+            return RE_UUID_V8.test(value);
+        case "F":
+            return RE_UUID_FFF.test(value);
+        default:
+            return RE_UUID_ANY.test(value);
+    }
+};
+const uuidWyvern = {
+    handles: (value) => [WYV_KEY_UUID].includes(value),
+    handlers: {
+        $uuid: (value, _expected, { path, params }) => {
+            const version = isEmptyObject(params) ? null : params;
+            if (!isVersion(version)) {
+                return HookAssessor.fault(errConfig(`Unknown UUID version: '${version}'`, path));
+            }
+            if (!isString(value)) {
+                return HookAssessor.fault(errType("string", value, path));
+            }
+            if (!testByVersion(version, value)) {
+                const subMessage = isNumber(version) || isString(version)
+                    ? ` of version '${version}'`
+                    : "";
+                return HookAssessor.fault(errType(`UUID${subMessage}`, value, path));
+            }
+            return HookAssessor.SUCCESS;
+        },
+    },
+};
+export default uuidWyvern;

package/dist/hooks/val.d.ts

@@ -0,0 +1,10 @@
+import type { WyvPlugin } from "../type/plugin";
+type MatchDictionary = Record<string, unknown>;
+type WyvParams = string;
+type WyvSetup = MatchDictionary;
+type WyvContext = {
+    matches: MatchDictionary;
+};
+declare const valWyvern: WyvPlugin<WyvParams, WyvSetup, WyvContext>;
+export default valWyvern;
+//# sourceMappingURL=val.d.ts.map

package/dist/hooks/val.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"val.d.ts","sourceRoot":"","sources":["../../src/hooks/val.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAMhD,KAAK,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE/C,KAAK,SAAS,GAAG,MAAM,CAAC;AACxB,KAAK,QAAQ,GAAG,eAAe,CAAC;AAChC,KAAK,UAAU,GAAG;IAAE,OAAO,EAAE,eAAe,CAAA;CAAE,CAAC;AAE/C,QAAA,MAAM,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,CA4BzD,CAAC;AAEF,eAAe,SAAS,CAAC"}

package/dist/hooks/val.js

@@ -0,0 +1,24 @@
+import { HookAssessor } from "../util/HookAssessment";
+import { errMatch } from "../util/HookError";
+const WYV_KEY_VAL = "$val";
+const valWyvern = {
+    handles: (value) => [WYV_KEY_VAL].includes(value),
+    handlers: {
+        [WYV_KEY_VAL]: (value, _expected, { path, params: match, setup, context }) => {
+            if (context.matches === undefined) {
+                // initialize matches on first call
+                context.matches = setup ?? {};
+            }
+            if (!(match in context.matches)) {
+                // intentionally mutating passed-in object
+                context.matches[match] = value;
+                return HookAssessor.SUCCESS;
+            }
+            if (value !== context.matches[match]) {
+                return HookAssessor.fault(errMatch(context.matches[match], value, match, path));
+            }
+            return HookAssessor.SUCCESS;
+        },
+    },
+};
+export default valWyvern;

package/dist/type/engine.d.ts

@@ -0,0 +1,14 @@
+import type { HookValue } from "./template";
+import type { ContextObject, PluginList } from "./plugin";
+import type { HookAssessment } from "../util/HookAssessment";
+export type MultiContext = Record<string, ContextObject>;
+export type WysiwyvConfig = {
+    plugins?: PluginList;
+    pluginSetups?: MultiContext;
+};
+export type WysiwyvInstance = {
+    validate: (expected: HookValue, candidate: unknown) => HookAssessment;
+};
+export type WysiwyvFactory = (config?: WysiwyvConfig) => WysiwyvInstance;
+export type WysiwyvEvaluatorFunction = (expected: HookValue, candidate: unknown, path: string) => HookAssessment;
+//# sourceMappingURL=engine.d.ts.map

package/dist/type/engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../../src/type/engine.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC1D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAE7D,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAEzD,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC;AACF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,KAAK,cAAc,CAAC;CACvE,CAAC;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,CAAC,EAAE,aAAa,KAAK,eAAe,CAAC;AAGzE,MAAM,MAAM,wBAAwB,GAAG,CACrC,QAAQ,EAAE,SAAS,EACnB,SAAS,EAAE,OAAO,EAClB,IAAI,EAAE,MAAM,KACT,cAAc,CAAC"}

package/dist/type/engine.js

@@ -0,0 +1 @@
+export {};

package/dist/type/plugin.d.ts

@@ -0,0 +1,26 @@
+import type { WysiwyvEvaluatorFunction } from "./engine";
+import type { HookValue } from "./template";
+import type { HookAssessment } from "../util/HookAssessment";
+export type ContextObject = Record<string, unknown>;
+export type HookEnviron<ParamsType = unknown, SetupType = unknown, ContextType extends ContextObject = ContextObject> = {
+    path: string;
+    params: ParamsType;
+    setup: SetupType;
+    context: ContextType;
+    shared: Record<string, unknown>;
+    evaluate: WysiwyvEvaluatorFunction;
+};
+/**
+ * @example options: HookEnviron<string>
+ * @example options: HookEnviron<{...}>
+ */
+export type HookHandler<ParamsType = unknown, SetupType = unknown, ContextType extends ContextObject = ContextObject> = (candidate: unknown, expected: HookValue, options: HookEnviron<ParamsType, SetupType, ContextType>) => HookAssessment;
+export type HookKey = `$${string}${string}`;
+export type WyvPlugin<ParamsType = unknown, SetupType = unknown, ContextType extends ContextObject = ContextObject> = {
+    handles: (value: HookKey) => boolean;
+    handlers: {
+        [key: HookKey]: HookHandler<ParamsType, SetupType, ContextType>;
+    };
+};
+export type PluginList = WyvPlugin<any, any, any>[];
+//# sourceMappingURL=plugin.d.ts.map

package/dist/type/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../src/type/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC;AACzD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAE7D,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEpD,MAAM,MAAM,WAAW,CACrB,UAAU,GAAG,OAAO,EACpB,SAAS,GAAG,OAAO,EACnB,WAAW,SAAS,aAAa,GAAG,aAAa,IAC/C;IACF,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,UAAU,CAAC;IACnB,KAAK,EAAE,SAAS,CAAC;IACjB,OAAO,EAAE,WAAW,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,QAAQ,EAAE,wBAAwB,CAAC;CACpC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,WAAW,CACrB,UAAU,GAAG,OAAO,EACpB,SAAS,GAAG,OAAO,EACnB,WAAW,SAAS,aAAa,GAAG,aAAa,IAC/C,CACF,SAAS,EAAE,OAAO,EAClB,QAAQ,EAAE,SAAS,EACnB,OAAO,EAAE,WAAW,CAAC,UAAU,EAAE,SAAS,EAAE,WAAW,CAAC,KACrD,cAAc,CAAC;AAIpB,MAAM,MAAM,OAAO,GAAG,IAAI,MAAM,GAAG,MAAM,EAAE,CAAC;AAE5C,MAAM,MAAM,SAAS,CACnB,UAAU,GAAG,OAAO,EACpB,SAAS,GAAG,OAAO,EACnB,WAAW,SAAS,aAAa,GAAG,aAAa,IAC/C;IACF,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC;IACrC,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,OAAO,GAAG,WAAW,CAAC,UAAU,EAAE,SAAS,EAAE,WAAW,CAAC,CAAA;KAAE,CAAC;CAC/E,CAAC;AAGF,MAAM,MAAM,UAAU,GAAG,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC"}

package/dist/type/plugin.js

@@ -0,0 +1 @@
+export {};

package/dist/type/template.d.ts

@@ -0,0 +1,6 @@
+export type ScalarValue = string | number | boolean | null;
+export type HookValue = ScalarValue | HookObject | HookValue[];
+export interface HookObject {
+    [key: string]: HookValue;
+}
+//# sourceMappingURL=template.d.ts.map

package/dist/type/template.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.d.ts","sourceRoot":"","sources":["../../src/type/template.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAE3D,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,SAAS,EAAE,CAAC;AAE/D,MAAM,WAAW,UAAU;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B"}

package/dist/type/template.js

@@ -0,0 +1 @@
+export {};

package/dist/util/HookAssessment.d.ts

@@ -0,0 +1,13 @@
+import type { HookError } from "./HookError";
+export interface HookAssessment {
+    readonly fault: (error: HookError) => HookAssessment;
+    readonly include: (assessment: HookAssessment) => HookAssessment;
+    readonly errors: readonly HookError[];
+    readonly success: boolean;
+}
+export declare const HookAssessor: {
+    start: (errors?: readonly HookError[]) => HookAssessment;
+    SUCCESS: HookAssessment;
+    fault: (error: HookError) => HookAssessment;
+};
+//# sourceMappingURL=HookAssessment.d.ts.map

package/dist/util/HookAssessment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HookAssessment.d.ts","sourceRoot":"","sources":["../../src/util/HookAssessment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,cAAc,CAAC;IACrD,QAAQ,CAAC,OAAO,EAAE,CAAC,UAAU,EAAE,cAAc,KAAK,cAAc,CAAC;IACjE,QAAQ,CAAC,MAAM,EAAE,SAAS,SAAS,EAAE,CAAC;IACtC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAkDD,eAAO,MAAM,YAAY;qBA5BF,SAAS,SAAS,EAAE,KAAQ,cAAc;;mBA0B3C,SAAS;CAM9B,CAAC"}

package/dist/util/HookAssessment.js

@@ -0,0 +1,42 @@
+const EMPTY_ERRORS = Object.freeze([]);
+const SUCCESS = {
+    get success() {
+        return true;
+    },
+    get errors() {
+        return EMPTY_ERRORS;
+    },
+    fault(error) {
+        return start().fault(error);
+    },
+    include(newAssessment) {
+        return newAssessment;
+    },
+};
+const start = (errors = []) => {
+    const _errors = errors.length === 0 ? [] : [...errors];
+    const assessment = {
+        get success() {
+            return _errors.length === 0;
+        },
+        get errors() {
+            return [..._errors];
+        },
+        fault(error) {
+            _errors.push(error);
+            return assessment;
+        },
+        include(newAssessment) {
+            if (!newAssessment.success)
+                _errors.push(...newAssessment.errors);
+            return assessment;
+        },
+    };
+    return assessment;
+};
+const fault = (error) => start().fault(error);
+export const HookAssessor = {
+    start,
+    SUCCESS,
+    fault,
+};

package/dist/util/HookError.d.ts

@@ -0,0 +1,14 @@
+import type { HookValue } from "../type/template";
+export interface HookError {
+    message: string;
+    path: string;
+}
+export declare const errUnexpected: (key: string, candidate: unknown, path: string) => HookError;
+export declare const errMissing: (key: string, expected: HookValue | unknown, path: string) => HookError;
+export declare const errValue: (expected: HookValue, candidate: unknown, path: string) => HookError;
+export declare const errMatch: (expected: unknown, candidate: unknown, matcher: string, path: string) => HookError;
+export declare const errType: (expectedType: string, candidate: unknown, path: string) => HookError;
+export declare const errAttr: (attribute: string, expectedAttribute: unknown, candidateAttribute: unknown, path: string) => HookError;
+export declare const errConfig: (messageDetail: string, path: string) => HookError;
+export declare const errColl: (booleanFunction: string, path: string) => HookError;
+//# sourceMappingURL=HookError.d.ts.map

package/dist/util/HookError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HookError.d.ts","sourceRoot":"","sources":["../../src/util/HookError.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAGlD,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAOD,eAAO,MAAM,aAAa,GACxB,KAAK,MAAM,EACX,WAAW,OAAO,EAClB,MAAM,MAAM,KACX,SACqE,CAAC;AAEzE,eAAO,MAAM,UAAU,GACrB,KAAK,MAAM,EACX,UAAU,SAAS,GAAG,OAAO,EAC7B,MAAM,MAAM,KACX,SAKA,CAAC;AAEJ,eAAO,MAAM,QAAQ,GACnB,UAAU,SAAS,EACnB,WAAW,OAAO,EAClB,MAAM,MAAM,KACX,SACoE,CAAC;AAExE,eAAO,MAAM,QAAQ,GACnB,UAAU,OAAO,EACjB,WAAW,OAAO,EAClB,SAAS,MAAM,EACf,MAAM,MAAM,KACX,SAKA,CAAC;AAEJ,eAAO,MAAM,OAAO,GAClB,cAAc,MAAM,EACpB,WAAW,OAAO,EAClB,MAAM,MAAM,KACX,SAKA,CAAC;AAEJ,eAAO,MAAM,OAAO,GAClB,WAAW,MAAM,EACjB,mBAAmB,OAAO,EAC1B,oBAAoB,OAAO,EAC3B,MAAM,MAAM,KACX,SAKA,CAAC;AAEJ,eAAO,MAAM,SAAS,GAAI,eAAe,MAAM,EAAE,MAAM,MAAM,KAAG,SACK,CAAC;AAEtE,eAAO,MAAM,OAAO,GAAI,iBAAiB,MAAM,EAAE,MAAM,MAAM,KAAG,SACG,CAAC"}

package/dist/util/HookError.js

@@ -0,0 +1,13 @@
+import { repr } from "./stringify";
+const makeError = (messageTemplate, value, path) => ({
+    message: messageTemplate.replace("%s", repr(value)),
+    path,
+});
+export const errUnexpected = (key, candidate, path) => makeError(`Unexpected element at '${key}': got '%s'`, candidate, path);
+export const errMissing = (key, expected, path) => makeError(`Missing element at '${key}': expected '${expected}'`, undefined, path);
+export const errValue = (expected, candidate, path) => makeError(`Value: Expected '${expected}', got '%s'`, candidate, path);
+export const errMatch = (expected, candidate, matcher, path) => makeError(`Expected value '${expected}' for key '${matcher}', got '%s'`, candidate, path);
+export const errType = (expectedType, candidate, path) => makeError(`Type: Expected '${expectedType}', got value '%s'`, candidate, path);
+export const errAttr = (attribute, expectedAttribute, candidateAttribute, path) => makeError(`${attribute}: Expected '${expectedAttribute}', got '%s'`, candidateAttribute, path);
+export const errConfig = (messageDetail, path) => makeError(`Configuration Error: ${messageDetail}`, undefined, path);
+export const errColl = (booleanFunction, path) => makeError(`Aggregate Error: ${booleanFunction}`, undefined, path);

package/dist/util/parseHook.d.ts

@@ -0,0 +1,5 @@
+import type { HookValue } from "../type/template";
+import type { HookKey } from "../type/plugin";
+export declare const getHookKey: (val: HookValue) => HookKey | null;
+export declare const getHookParams: (hook: unknown, key: string) => unknown;
+//# sourceMappingURL=parseHook.d.ts.map

package/dist/util/parseHook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseHook.d.ts","sourceRoot":"","sources":["../../src/util/parseHook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAG9C,eAAO,MAAM,UAAU,GAAI,KAAK,SAAS,KAAG,OAAO,GAAG,IAgBrD,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,MAAM,OAAO,EAAE,KAAK,MAAM,KAAG,OAK1D,CAAC"}

package/dist/util/parseHook.js

@@ -0,0 +1,21 @@
+import { isPlainObject, isString } from "./types";
+export const getHookKey = (val) => {
+    if (isString(val)) {
+        if (val.startsWith("$") && !val.startsWith("$$")) {
+            return val;
+        }
+    }
+    if (isPlainObject(val) && Object.keys(val).length === 1) {
+        const key = Object.keys(val)[0];
+        if (key.startsWith("$") && !key.startsWith("$$")) {
+            return key;
+        }
+    }
+    return null;
+};
+export const getHookParams = (hook, key) => {
+    if (isPlainObject(hook)) {
+        return hook[key];
+    }
+    return null;
+};

package/dist/util/stringify.d.ts

@@ -0,0 +1,2 @@
+export declare const repr: (val: unknown) => string;
+//# sourceMappingURL=stringify.d.ts.map