@based/schema 4.1.1 → 5.0.0-alpha.1

package/README.md

@@ -0,0 +1,152 @@
+# @based/schema
+
+## Display & format WIP
+
+Using `display` will not validate or transform and will purely change how the value is shown in UI and API.
+
+Use `format` to specify in which format the value has to represented and modified. This may impose some validation and will influence how the UI shows the value.
+
+### For example
+
+```ts
+{
+    types: {
+        article: {
+            props: {
+                price: {
+                    type: 'int32',
+                    display: 'euro',
+                },
+                authorEmail: {
+                    type: 'string',
+                    format: 'email',
+                    display: 'lowercase',
+                },
+                lastModified: {
+                    type: 'timestamp',
+                    display: 'date-time'
+                }
+            }
+        }
+    }
+}
+```
+
+### Display options
+
+#### Timestamp
+
+```
+'date',
+'date-time',
+'date-time-text',
+'human',
+'time',
+'time-precise',
+```
+
+#### Number
+
+```
+'short',
+'human',
+'ratio',
+'bytes',
+'euro',
+'dollar',
+'pound',
+
+'round-short',
+'round-human',
+'round-ratio',
+'round-bytes',
+'round-euro',
+'round-dollar',
+'round-pound',
+```
+
+#### String
+
+```
+'lowercase',
+'uppercase',
+'capitalize',
+```
+
+### Format options
+
+#### String
+
+```
+'email',
+'URL',
+'MACAddress',
+'IP',
+'IPRange',
+'FQDN',
+'IBAN',
+'BIC',
+'alpha',
+'alphaLocales',
+'alphanumeric',
+'alphanumericLocales',
+'passportNumber',
+'port',
+'lowercase',
+'uppercase',
+'ascii',
+'semVer',
+'surrogatePair',
+'IMEI',
+'hexadecimal',
+'octal',
+'hexColor',
+'rgbColor',
+'HSL',
+'ISRC',
+'MD5',
+'JWT',
+'UUID',
+'luhnNumber',
+'creditCard',
+'identityCard',
+'EAN',
+'ISIN',
+'ISBN',
+'ISSN',
+'mobilePhone',
+'mobilePhoneLocales',
+'postalCode',
+'postalCodeLocales',
+'ethereumAddress',
+'currency',
+'btcAddress',
+'ISO6391',
+'ISO8601',
+'RFC3339',
+'ISO31661Alpha2',
+'ISO31661Alpha3',
+'ISO4217',
+'base32',
+'base58',
+'base64',
+'dataURI',
+'magnetURI',
+'mimeType',
+'latLong',
+'slug',
+'strongPassword',
+'taxID',
+'licensePlate',
+'VAT',
+'code',
+'typescript',
+'javascript',
+'python',
+'rust',
+'css',
+'html',
+'json',
+'markdown',
+'clike'
+```

package/dist/index.d.ts

@@ -1,3 +1,5 @@
 export * from './types.js';
 export * from './parse/index.js';
+export * from './lang.js';
+export * from './mermaid.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,3 +1,5 @@
 export * from './types.js';
 export * from './parse/index.js';
+export * from './lang.js';
+export * from './mermaid.js';
 //# sourceMappingURL=index.js.map

package/dist/lang.d.ts

@@ -0,0 +1,153 @@
+declare const langCodes: {
+    readonly none: 0;
+    readonly aa: 1;
+    readonly ab: 2;
+    readonly af: 3;
+    readonly ak: 4;
+    readonly sq: 5;
+    readonly am: 6;
+    readonly ar: 7;
+    readonly an: 8;
+    readonly hy: 9;
+    readonly as: 10;
+    readonly av: 11;
+    readonly ae: 12;
+    readonly ay: 13;
+    readonly az: 14;
+    readonly eu: 15;
+    readonly be: 16;
+    readonly bn: 17;
+    readonly bi: 18;
+    readonly bs: 19;
+    readonly br: 20;
+    readonly bg: 21;
+    readonly my: 22;
+    readonly ca: 23;
+    readonly km: 24;
+    readonly ce: 25;
+    readonly zh: 26;
+    readonly cv: 27;
+    readonly kw: 28;
+    readonly co: 29;
+    readonly hr: 30;
+    readonly cs: 31;
+    readonly da: 32;
+    readonly dv: 33;
+    readonly nl: 34;
+    readonly dz: 35;
+    readonly en: 36;
+    readonly et: 37;
+    readonly fo: 38;
+    readonly fi: 39;
+    readonly fr: 40;
+    readonly ff: 41;
+    readonly gd: 42;
+    readonly gl: 43;
+    readonly de: 44;
+    readonly gsw: 45;
+    readonly el: 46;
+    readonly kl: 47;
+    readonly gu: 48;
+    readonly ht: 49;
+    readonly ha: 50;
+    readonly he: 51;
+    readonly hi: 52;
+    readonly hu: 53;
+    readonly is: 54;
+    readonly ig: 55;
+    readonly id: 56;
+    readonly ia: 57;
+    readonly iu: 58;
+    readonly ik: 59;
+    readonly ga: 60;
+    readonly it: 61;
+    readonly ja: 62;
+    readonly kn: 63;
+    readonly ks: 64;
+    readonly kk: 65;
+    readonly rw: 66;
+    readonly ko: 67;
+    readonly ku: 68;
+    readonly ky: 69;
+    readonly lo: 70;
+    readonly la: 71;
+    readonly lv: 72;
+    readonly lb: 73;
+    readonly li: 74;
+    readonly ln: 75;
+    readonly lt: 76;
+    readonly mk: 77;
+    readonly mg: 78;
+    readonly ms: 79;
+    readonly ml: 80;
+    readonly mt: 81;
+    readonly gv: 82;
+    readonly mi: 83;
+    readonly ro: 84;
+    readonly mn: 85;
+    readonly ne: 86;
+    readonly se: 87;
+    readonly no: 88;
+    readonly nb: 89;
+    readonly nn: 90;
+    readonly oc: 91;
+    readonly or: 92;
+    readonly om: 93;
+    readonly os: 94;
+    readonly pa: 95;
+    readonly ps: 96;
+    readonly fa: 97;
+    readonly pl: 98;
+    readonly pt: 99;
+    readonly qu: 100;
+    readonly rm: 101;
+    readonly ru: 102;
+    readonly sm: 103;
+    readonly sa: 104;
+    readonly sc: 105;
+    readonly sr: 106;
+    readonly sd: 107;
+    readonly si: 108;
+    readonly sk: 109;
+    readonly sl: 110;
+    readonly so: 111;
+    readonly st: 112;
+    readonly nr: 113;
+    readonly es: 114;
+    readonly sw: 115;
+    readonly ss: 116;
+    readonly sv: 117;
+    readonly tl: 118;
+    readonly tg: 119;
+    readonly ta: 120;
+    readonly tt: 121;
+    readonly te: 122;
+    readonly th: 123;
+    readonly bo: 124;
+    readonly ti: 125;
+    readonly to: 126;
+    readonly ts: 127;
+    readonly tn: 128;
+    readonly tr: 129;
+    readonly tk: 130;
+    readonly ug: 131;
+    readonly uk: 132;
+    readonly ur: 133;
+    readonly uz: 134;
+    readonly ve: 135;
+    readonly vi: 136;
+    readonly wa: 137;
+    readonly cy: 138;
+    readonly fy: 139;
+    readonly wo: 140;
+    readonly xh: 141;
+    readonly yi: 142;
+    readonly yo: 143;
+    readonly zu: 144;
+};
+export declare const langCodesMap: Map<string, 0 | 2 | 1 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144>;
+export declare const inverseLangMap: Map<any, any>;
+export type LangName = keyof typeof langCodes;
+export type LangCode = (typeof langCodes)[LangName];
+export {};
+//# sourceMappingURL=lang.d.ts.map

package/dist/lang.js

@@ -0,0 +1,153 @@
+const langCodes = {
+    none: 0,
+    aa: 1,
+    ab: 2,
+    af: 3,
+    ak: 4,
+    sq: 5,
+    am: 6,
+    ar: 7,
+    an: 8,
+    hy: 9,
+    as: 10,
+    av: 11,
+    ae: 12,
+    ay: 13,
+    az: 14,
+    eu: 15,
+    be: 16,
+    bn: 17,
+    bi: 18,
+    bs: 19,
+    br: 20,
+    bg: 21,
+    my: 22,
+    ca: 23,
+    km: 24,
+    ce: 25,
+    zh: 26,
+    cv: 27,
+    kw: 28,
+    co: 29,
+    hr: 30,
+    cs: 31,
+    da: 32,
+    dv: 33,
+    nl: 34,
+    dz: 35,
+    en: 36,
+    et: 37,
+    fo: 38,
+    fi: 39,
+    fr: 40,
+    ff: 41,
+    gd: 42,
+    gl: 43,
+    de: 44,
+    gsw: 45,
+    el: 46,
+    kl: 47,
+    gu: 48,
+    ht: 49,
+    ha: 50,
+    he: 51,
+    hi: 52,
+    hu: 53,
+    is: 54,
+    ig: 55,
+    id: 56,
+    ia: 57,
+    iu: 58,
+    ik: 59,
+    ga: 60,
+    it: 61,
+    ja: 62,
+    kn: 63,
+    ks: 64,
+    kk: 65,
+    rw: 66,
+    ko: 67,
+    ku: 68,
+    ky: 69,
+    lo: 70,
+    la: 71,
+    lv: 72,
+    lb: 73,
+    li: 74,
+    ln: 75,
+    lt: 76,
+    mk: 77,
+    mg: 78,
+    ms: 79,
+    ml: 80,
+    mt: 81,
+    gv: 82,
+    mi: 83,
+    ro: 84,
+    mn: 85,
+    ne: 86,
+    se: 87,
+    no: 88,
+    nb: 89,
+    nn: 90,
+    oc: 91,
+    or: 92,
+    om: 93,
+    os: 94,
+    pa: 95,
+    ps: 96,
+    fa: 97,
+    pl: 98,
+    pt: 99,
+    qu: 100,
+    rm: 101,
+    ru: 102,
+    sm: 103,
+    sa: 104,
+    sc: 105,
+    sr: 106,
+    sd: 107,
+    si: 108,
+    sk: 109,
+    sl: 110,
+    so: 111,
+    st: 112,
+    nr: 113,
+    es: 114,
+    sw: 115,
+    ss: 116,
+    sv: 117,
+    tl: 118,
+    tg: 119,
+    ta: 120,
+    tt: 121,
+    te: 122,
+    th: 123,
+    bo: 124,
+    ti: 125,
+    to: 126,
+    ts: 127,
+    tn: 128,
+    tr: 129,
+    tk: 130,
+    ug: 131,
+    uk: 132,
+    ur: 133,
+    uz: 134,
+    ve: 135,
+    vi: 136,
+    wa: 137,
+    cy: 138,
+    fy: 139,
+    wo: 140,
+    xh: 141,
+    yi: 142,
+    yo: 143,
+    zu: 144,
+};
+export const langCodesMap = new Map(Object.entries(langCodes));
+export const inverseLangMap = new Map();
+langCodesMap.forEach((v, k) => {
+    inverseLangMap.set(v, k);
+});
+//# sourceMappingURL=lang.js.map

package/dist/mermaid.d.ts

@@ -0,0 +1,3 @@
+import { StrictSchema } from './types.js';
+export declare const mermaid: (schema: StrictSchema) => string;
+//# sourceMappingURL=mermaid.d.ts.map

package/dist/mermaid.js

@@ -0,0 +1,24 @@
+import { getPropType } from './parse/utils.js';
+import { isPropType } from './types.js';
+export const mermaid = (schema) => {
+    let mermaid = 'classDiagram';
+    if (schema.types) {
+        for (const type in schema.types) {
+            for (const key in schema.types[type].props) {
+                const prop = schema.types[type].props[key];
+                const propType = getPropType(prop);
+                if (isPropType('reference', prop)) {
+                    mermaid += `\n${type} --> ${prop.ref} : ${key}`;
+                }
+                else if (isPropType('references', prop)) {
+                    mermaid += `\n${type} --> ${prop.items.ref} : ${key}[]`;
+                }
+                else {
+                    mermaid += `\n${type} : ${propType} ${key}`;
+                }
+            }
+        }
+    }
+    return mermaid;
+};
+//# sourceMappingURL=mermaid.js.map

package/dist/parse/assert.d.ts

@@ -1,4 +1,5 @@
-export declare const expectObject: (obj: any) => void;
+export declare const expectObject: (obj: any, msg?: string) => void;
+export declare const expectFloat32Array: (arr: any) => void;
 export declare const expectString: (obj: any) => void;
 export declare const expectBoolean: (v: any) => void;
 export declare const expectFunction: (v: any) => void;

package/dist/parse/assert.js

@@ -1,7 +1,13 @@
-import { EXPECTED_BOOL, EXPECTED_FN, EXPECTED_NUM, EXPECTED_OBJ, EXPECTED_STR, } from './errors.js';
-export const expectObject = (obj) => {
+import { isFloat32Array } from 'util/types';
+import { EXPECTED_ARR, EXPECTED_BOOL, EXPECTED_FN, EXPECTED_NUM, EXPECTED_OBJ, EXPECTED_STR, } from './errors.js';
+export const expectObject = (obj, msg) => {
     if (typeof obj !== 'object' || obj === null) {
-        throw Error(EXPECTED_OBJ);
+        throw Error(msg || EXPECTED_OBJ);
+    }
+};
+export const expectFloat32Array = (arr) => {
+    if (!isFloat32Array(arr)) {
+        throw Error(EXPECTED_ARR);
     }
 };
 export const expectString = (obj) => {

package/dist/parse/errors.d.ts

@@ -9,6 +9,7 @@ export declare const EXPECTED_STR = "Expected string";
 export declare const EXPECTED_FN = "Expected function";
 export declare const EXPECTED_PRIMITIVE = "Expected primitive value";
 export declare const INVALID_VALUE = "Invalid value";
+export declare const INVALID_KEY = "Invalid key";
 export declare const INVALID_SCHEMA = "Invalid schema";
 export declare const MIN_MAX = "Max value must be larger than min value";
 export declare const UNKNOWN_PROP = "Unknown property";
@@ -16,4 +17,5 @@ export declare const MISSING_TYPE = "Missing type";
 export declare const INVALID_TYPE = "Invalid type";
 export declare const TEXT_REQUIRES_LOCALES = "Type text requires locales";
 export declare const TYPE_MISMATCH = "Types do not match";
+export declare const NOT_ALLOWED_IN_ITEMS = "Property not allowed in items definition";
 //# sourceMappingURL=errors.d.ts.map

package/dist/parse/errors.js

@@ -9,6 +9,7 @@ export const EXPECTED_STR = 'Expected string';
 export const EXPECTED_FN = 'Expected function';
 export const EXPECTED_PRIMITIVE = 'Expected primitive value';
 export const INVALID_VALUE = 'Invalid value';
+export const INVALID_KEY = 'Invalid key';
 export const INVALID_SCHEMA = 'Invalid schema';
 export const MIN_MAX = 'Max value must be larger than min value';
 export const UNKNOWN_PROP = 'Unknown property';
@@ -16,4 +17,5 @@ export const MISSING_TYPE = 'Missing type';
 export const INVALID_TYPE = 'Invalid type';
 export const TEXT_REQUIRES_LOCALES = 'Type text requires locales';
 export const TYPE_MISMATCH = 'Types do not match';
+export const NOT_ALLOWED_IN_ITEMS = 'Property not allowed in items definition';
 //# sourceMappingURL=errors.js.map

package/dist/parse/index.d.ts

@@ -1,20 +1,21 @@
-import { Schema, SchemaType } from '../types.js';
+import { Schema, SchemaType, StrictSchema } from '../types.js';
 import { getPropType } from './utils.js';
 export { getPropType };
 export declare class SchemaParser {
     constructor(schema: Schema);
+    isItems: boolean;
     inQuery: boolean;
     schema: Schema;
     type: SchemaType;
-    parseType(type: SchemaType): void;
+    path: string[];
+    lvl: number;
     parseTypes(): void;
     parseProps(props: any, schemaType?: SchemaType): void;
     parseLocales(): void;
     parse(): void;
 }
 export declare const print: (schema: Schema, path: string[]) => string;
-export declare const debug: (schema: Schema) => void;
 export declare const parse: (schema: Schema) => {
-    schema: Schema;
+    schema: StrictSchema;
 };
 //# sourceMappingURL=index.d.ts.map