@based/schema 4.1.0 → 5.0.0-alpha.0

package/dist/src/compat/index.js

@@ -1,217 +0,0 @@
-const oldToNewType = {
-    id: { type: 'string', format: 'basedId' },
-    int: { type: 'integer' },
-    url: { type: 'string', format: 'URL' },
-    email: { type: 'string', format: 'email' },
-    float: { type: 'number' },
-    phone: { type: 'string', format: 'mobilePhone' },
-    digest: { type: 'string', format: 'strongPassword' },
-};
-const newToOldType = {
-    mobilePhone: { type: 'phone' },
-    basedId: { type: 'id' },
-    integer: { type: 'int' },
-    URL: { type: 'url' },
-    email: { type: 'email' },
-    strongPassword: { type: 'digest' },
-};
-const convertNewToOldMeta = (props) => {
-    let meta;
-    for (const i in props) {
-        if (i[0] !== '$') {
-            const v = props[i];
-            meta ??= {};
-            if (i === 'allowedType') {
-                meta.refTypes = v;
-            }
-            else if (i === 'display' && v === 'bytes') {
-                meta.format = v;
-            }
-            else if (i === 'title') {
-                meta.name = v;
-            }
-            else {
-                meta[i] = v;
-            }
-        }
-    }
-    return meta;
-};
-const convertOldToNewMeta = (props) => {
-    const meta = {};
-    for (const i in props) {
-        const v = props[i];
-        if (i === 'refTypes') {
-            meta.allowedType = v; // TODO
-        }
-        else if (i === 'format' && v === 'bytes') {
-            meta.display = 'bytes';
-        }
-        else if (i === 'name') {
-            meta.title = v;
-        }
-        else {
-            meta[i] = v;
-        }
-    }
-    return meta;
-};
-const convertNewFieldToOldField = (newField) => {
-    // @ts-ignore
-    const { type, bidirectional, properties, values, items, ...props } = newField;
-    const meta = convertNewToOldMeta(props);
-    // @ts-ignore
-    const overwrite = newToOldType[type] || newToOldType[props.format];
-    const oldField = overwrite
-        ? { ...overwrite }
-        : {
-            type,
-        };
-    if (meta) {
-        oldField.meta = meta;
-    }
-    if (bidirectional) {
-        // @ts-ignore
-        oldField.bidirectional = bidirectional;
-    }
-    if (properties) {
-        // @ts-ignore
-        oldField.properties = {};
-        for (const key in properties) {
-            // @ts-ignore
-            oldField.properties[key] = convertNewFieldToOldField(properties[key]);
-        }
-    }
-    if (values) {
-        // @ts-ignore
-        oldField.values = convertNewFieldToOldField(values);
-    }
-    if (items) {
-        // @ts-ignore
-        oldField.items = convertNewFieldToOldField(items);
-    }
-    return oldField;
-};
-const convertNewTypeToOldType = (newType) => {
-    const { prefix, fields, ...props } = newType;
-    const oldType = {};
-    const meta = convertNewToOldMeta(props);
-    if (prefix) {
-        oldType.prefix = prefix;
-    }
-    if (meta) {
-        oldType.meta = meta;
-    }
-    if (fields) {
-        oldType.fields = {};
-        for (const key in fields) {
-            // @ts-ignore
-            oldType.fields[key] = convertNewFieldToOldField(fields[key]);
-        }
-    }
-    return oldType;
-};
-export const convertNewToOld = (newSchema) => {
-    const { root, types, language, translations, prefixToTypeMapping } = newSchema;
-    const oldSchema = {};
-    if (prefixToTypeMapping) {
-        oldSchema.prefixToTypeMapping = prefixToTypeMapping;
-    }
-    if (language) {
-        oldSchema.languages = [language];
-    }
-    if (translations) {
-        oldSchema.languages ??= [];
-        oldSchema.languages.push(...translations);
-    }
-    if (root) {
-        oldSchema.rootType = convertNewTypeToOldType(root);
-    }
-    if (types) {
-        oldSchema.types = {};
-        for (const key in types) {
-            oldSchema.types[key] = convertNewTypeToOldType(types[key]);
-        }
-    }
-    return oldSchema;
-};
-const convertOldFieldToNewField = (oldField) => {
-    // @ts-ignore
-    const { type, bidirectional, properties, values, items, meta = {} } = oldField;
-    const overwrite = oldToNewType[type] || oldToNewType[meta.format];
-    const newField = overwrite
-        ? {
-            ...overwrite,
-            ...convertOldToNewMeta(meta),
-        }
-        : {
-            type,
-            ...convertOldToNewMeta(meta),
-        };
-    if (bidirectional) {
-        // @ts-ignore
-        newField.bidirectional = bidirectional;
-    }
-    if (properties) {
-        // @ts-ignore
-        newField.properties = {};
-        for (const key in properties) {
-            // @ts-ignore
-            newField.properties[key] = convertOldFieldToNewField(properties[key]);
-        }
-    }
-    if (values) {
-        // @ts-ignore
-        newField.values = convertOldFieldToNewField(values);
-    }
-    if (items) {
-        // @ts-ignore
-        newField.items = convertOldFieldToNewField(items);
-    }
-    return newField;
-};
-const convertOldTypeToNewType = (oldType) => {
-    const { prefix, fields, meta } = oldType;
-    const newType = {
-        fields: {},
-    };
-    if (prefix) {
-        newType.prefix = prefix;
-    }
-    if (meta) {
-        Object.assign(newType, convertOldToNewMeta(meta));
-    }
-    if (fields) {
-        for (const key in fields) {
-            newType.fields[key] = convertOldFieldToNewField(fields[key]);
-        }
-    }
-    return newType;
-};
-export const convertOldToNew = (oldSchema) => {
-    const { rootType, types, languages, prefixToTypeMapping } = oldSchema;
-    const newSchema = {};
-    if (prefixToTypeMapping) {
-        newSchema.prefixToTypeMapping = prefixToTypeMapping;
-    }
-    if (languages?.length) {
-        // @ts-ignore
-        newSchema.language = languages[0];
-        const translations = languages.slice(1);
-        if (translations.length) {
-            // @ts-ignore
-            newSchema.translations = translations;
-        }
-    }
-    if (rootType) {
-        newSchema.root = convertOldTypeToNewType(rootType);
-    }
-    if (types) {
-        newSchema.types = {};
-        for (const key in types) {
-            newSchema.types[key] = convertOldTypeToNewType(types[key]);
-        }
-    }
-    return newSchema;
-};
-//# sourceMappingURL=index.js.map

package/dist/src/compat/oldSchemaType.d.ts

@@ -1,93 +0,0 @@
-type FieldType = 'float' | 'boolean' | 'number' | 'int' | 'string' | 'text' | 'id' | 'digest' | 'url' | 'email' | 'phone' | 'geo' | 'type' | 'timestamp';
-export type FieldSchemaObject = {
-    type: 'object';
-    properties: {
-        [key: string]: FieldSchema;
-    };
-    meta?: any;
-    timeseries?: boolean;
-};
-type FieldSchemaJson = {
-    type: 'json';
-    properties?: {
-        [key: string]: FieldSchema;
-    };
-    meta?: any;
-    timeseries?: boolean;
-};
-type FieldSchemaRecord = {
-    type: 'record';
-    values: FieldSchema;
-    meta?: any;
-    timeseries?: boolean;
-};
-type FieldSchemaReferences = {
-    type: 'reference' | 'references';
-    bidirectional?: {
-        fromField: string;
-    };
-    meta?: any;
-    timeseries?: boolean;
-};
-type FieldSchemaOther = {
-    type: FieldType;
-    meta?: any;
-    timeseries?: boolean;
-};
-export type FieldSchemaArrayLike = {
-    type: 'set' | 'array';
-    items: FieldSchema;
-    meta?: any;
-    timeseries?: boolean;
-};
-export type FieldSchema = FieldSchemaObject | FieldSchemaRecord | FieldSchemaArrayLike | FieldSchemaJson | FieldSchemaReferences | FieldSchemaOther;
-type FieldInputSchemaArrayLike = {
-    type: 'set' | 'array';
-    items: FieldInputSchema;
-    meta?: any;
-    timeseries?: boolean;
-};
-type FieldInputSchemaRecord = {
-    type: 'record';
-    values: FieldInputSchema;
-    meta?: any;
-    timeseries?: boolean;
-};
-export type FieldInputSchemaObject = {
-    type: 'object';
-    properties: {
-        [key: string]: FieldInputSchema;
-    };
-    meta?: any;
-    timeseries?: boolean;
-};
-type FieldInputSchema = FieldSchema | FieldInputSchemaArrayLike | FieldInputSchemaRecord | FieldInputSchemaObject | DeleteField;
-type DeleteField = {
-    $delete: boolean;
-};
-type Fields = Record<string, FieldSchema>;
-type HierarchySchema = false | {
-    [key: string]: false | {
-        excludeAncestryWith: string[];
-    } | {
-        includeAncestryWith: string[];
-    };
-};
-export type TypeSchema = {
-    prefix?: string;
-    hierarchy?: HierarchySchema;
-    fields?: Fields;
-    meta?: any;
-};
-type Types = {
-    [key: string]: TypeSchema;
-};
-export type BasedOldSchema = {
-    sha?: string;
-    languages?: string[];
-    types: Types;
-    rootType?: Pick<TypeSchema, 'fields' | 'prefix' | 'meta'>;
-    idSeedCounter?: number;
-    prefixToTypeMapping?: Record<string, string>;
-};
-export {};

package/dist/src/compat/oldSchemaType.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=oldSchemaType.js.map

package/dist/src/display/index.d.ts

@@ -1,2 +0,0 @@
-import { BasedSchemaField } from '../types.js';
-export declare const display: (value: string | number | undefined, field: BasedSchemaField) => string | number | undefined;

package/dist/src/display/index.js

@@ -1,16 +0,0 @@
-import timestampDisplay from './timestamp.js';
-import numberDisplay from './number.js';
-import stringDisplay from './string.js';
-export const display = (value, field) => {
-    if (field.type === 'timestamp' && typeof value === 'number') {
-        return timestampDisplay(value, field.display);
-    }
-    if (field.type === 'number' && typeof value === 'number') {
-        return numberDisplay(value, field.display);
-    }
-    if (field.type === 'string' && typeof value === 'string') {
-        return stringDisplay(value, field.display);
-    }
-    return value;
-};
-//# sourceMappingURL=index.js.map

package/dist/src/display/number.d.ts

@@ -1,4 +0,0 @@
-export declare const basedSchemaNumberFormats: readonly [any, "short", "human", "ratio", "bytes", "euro", "dollar", "pound"];
-export type NumberFormat = (typeof basedSchemaNumberFormats)[number] | `round-${number}`;
-declare const parseNumber: (nr: number | string, format?: NumberFormat) => string | number;
-export default parseNumber;

package/dist/src/display/number.js

@@ -1,97 +0,0 @@
-export const basedSchemaNumberFormats = [
-    ,
-    'short',
-    'human',
-    'ratio',
-    'bytes',
-    'euro',
-    'dollar',
-    'pound',
-];
-const parseNumber = (nr, format) => {
-    if (!format) {
-        return nr;
-    }
-    if (typeof nr === 'number') {
-        if (format === 'euro' || format === 'dollar' || format === 'pound') {
-            const p = String(parseNumber(nr, 'short'));
-            const fraction = format === 'euro' ? ',' : '.';
-            const [s, f] = p.split('.');
-            return `${format === 'euro'
-                ? '€'
-                : format === 'pound'
-                    ? '£'
-                    : format === 'dollar'
-                        ? '$'
-                        : ''}${s}${f ? `${fraction}${f}` : ''}`;
-        }
-        else if (format.startsWith('round-')) {
-            const [, fixed] = format.split('round-');
-            const n = Number(fixed);
-            if (!n) {
-                return `${nr.toFixed()}`;
-            }
-            return `${nr.toFixed(n)}`;
-        }
-        else if (format === 'bytes') {
-            const kb = nr / 1024;
-            const mb = kb / 1024;
-            const gb = mb / 1024;
-            if (gb >= 1) {
-                return `${gb.toFixed(2)} gb`;
-            }
-            else if (mb >= 1) {
-                return `${mb.toFixed(2)} mb`;
-            }
-            else if (kb >= 1) {
-                return `${kb.toFixed(2)} kb`;
-            }
-            else {
-                return `${nr} ${nr === 1 ? 'byte' : 'bytes'}`;
-            }
-        }
-        else if (format === 'ratio') {
-            return `${Math.round(nr * 10000) / 100}%`;
-        }
-        else if (format === 'short') {
-            if (nr >= 10e9) {
-                nr = nr / 1e9;
-                nr = nr.toFixed(1);
-                if (nr[nr.length - 1] === '0') {
-                    nr = nr.slice(0, -2);
-                }
-                return nr + 'b';
-            }
-            else if (nr >= 10e6) {
-                nr = nr / 1e6;
-                nr = nr.toFixed(1);
-                if (nr[nr.length - 1] === '0') {
-                    nr = nr.slice(0, -2);
-                }
-                return nr + 'm';
-            }
-            else if (nr >= 10e3) {
-                nr = nr / 1e3;
-                nr = nr.toFixed(1);
-                if (nr[nr.length - 1] === '0') {
-                    nr = nr.slice(0, -2);
-                }
-                return nr + 'k';
-            }
-            nr = nr.toFixed(2);
-            if (nr[nr.length - 1] === '0') {
-                nr = nr.slice(0, -3);
-            }
-            return String(nr);
-        }
-        else if (format === 'human') {
-            return nr.toFixed(2);
-        }
-        return String(nr);
-    }
-    else {
-        return nr;
-    }
-};
-export default parseNumber;
-//# sourceMappingURL=number.js.map

package/dist/src/display/string.d.ts

@@ -1,5 +0,0 @@
-export declare const basedSchemaDisplayFormats: readonly ["lowercase", "uppercase", "capitalize"];
-export type basedSchemaDisplayFormat = (typeof basedSchemaDisplayFormats)[number];
-export type StringFormat = basedSchemaDisplayFormat;
-declare const parseString: (value?: string, format?: StringFormat) => string;
-export default parseString;

package/dist/src/display/string.js

@@ -1,26 +0,0 @@
-export const basedSchemaDisplayFormats = [
-    'lowercase',
-    'uppercase',
-    'capitalize',
-];
-const parseString = (value, format) => {
-    if (!format) {
-        return value;
-    }
-    if (!value) {
-        return value;
-    }
-    if (format === 'lowercase') {
-        return value.toLowerCase();
-    }
-    if (format === 'uppercase') {
-        return value.toUpperCase();
-    }
-    if (format === 'capitalize') {
-        const a = value[0];
-        return a.toUpperCase() + (value ? value.slice(1) : '');
-    }
-    return value;
-};
-export default parseString;
-//# sourceMappingURL=string.js.map

package/dist/src/display/timestamp.d.ts

@@ -1,5 +0,0 @@
-export declare const basedSchemaDateFormats: readonly [any, "date", "date-time", "date-time-text", "human", "time", "time-precise"];
-export type BasedSchemaDateFormat = (typeof basedSchemaDateFormats)[number];
-export type DateFormat = BasedSchemaDateFormat;
-declare const _default: (nr: number | string, format?: DateFormat) => string | number;
-export default _default;

package/dist/src/display/timestamp.js

@@ -1,134 +0,0 @@
-export const basedSchemaDateFormats = [
-    ,
-    'date',
-    'date-time',
-    'date-time-text',
-    'human',
-    'time',
-    'time-precise',
-];
-const addZero = (d) => {
-    const s = d + '';
-    if (s.length === 1) {
-        return '0' + s;
-    }
-    return s;
-};
-export default (nr, format) => {
-    if (!format) {
-        return nr;
-    }
-    if (typeof nr === 'number') {
-        const thenDate = new Date(nr);
-        if (format === 'date') {
-            return (thenDate.getDate() +
-                '/' +
-                (thenDate.getMonth() + 1) +
-                '/' +
-                thenDate.getFullYear());
-        }
-        else if (format === 'time') {
-            return thenDate.getHours() + ':' + addZero(thenDate.getMinutes());
-        }
-        else if (format === 'time-precise') {
-            return (thenDate.getHours() +
-                ':' +
-                addZero(thenDate.getMinutes()) +
-                ':' +
-                addZero(thenDate.getSeconds()));
-        }
-        else if (format === 'date-time-text') {
-            return `${thenDate.toLocaleDateString('default', {
-                day: 'numeric',
-                month: 'long',
-                year: 'numeric',
-            })}, ${thenDate.toLocaleTimeString()}`;
-        }
-        else if (format === 'date-time') {
-            return (thenDate.getHours() +
-                ':' +
-                addZero(thenDate.getMinutes()) +
-                ' ' +
-                thenDate.getDate() +
-                '/' +
-                (thenDate.getMonth() + 1) +
-                '/' +
-                thenDate.getFullYear());
-        }
-        else if (format === 'human') {
-            const nowDate = new Date();
-            if (nowDate.getTime() > thenDate.getTime()) {
-                var secondsSince = Math.floor((nowDate.getTime() - thenDate.getTime()) / 1000);
-                var interval = secondsSince / 31536000; // seconds in a year
-                if (interval > 1) {
-                    const x = Math.floor(interval);
-                    return `${x} ${x > 1 ? 'years' : 'year'} ago`;
-                }
-                interval = secondsSince / 2592000; // seconds in a month
-                if (interval > 1) {
-                    const x = Math.floor(interval);
-                    return `${x} ${x > 1 ? 'months' : 'month'} ago`;
-                }
-                interval = secondsSince / 86400; // seconds in a day
-                if (interval > 1) {
-                    const x = Math.floor(interval);
-                    return `${x} ${x > 1 ? 'days' : 'day'} ago`;
-                }
-                interval = secondsSince / 3600; // seconds in an hour
-                if (interval > 1) {
-                    const x = Math.floor(interval);
-                    return `${x} ${x > 1 ? 'hours' : 'hour'} ago`;
-                }
-                interval = secondsSince / 60; // seconds in a minute :)
-                if (interval > 1) {
-                    const x = Math.floor(interval);
-                    return `${x} ${x > 1 ? 'minutes' : 'minute'} ago`;
-                }
-                if (secondsSince > 10) {
-                    const x = Math.floor(secondsSince);
-                    return `${x} ${x > 1 ? 'seconds' : 'second'} ago`;
-                }
-                return 'Now';
-            }
-            else {
-                // in the future
-                var secondsSince = Math.floor((thenDate.getTime() - nowDate.getTime()) / 1000);
-                var interval = secondsSince / 31536000; // seconds in a year
-                if (interval > 1) {
-                    const x = Math.floor(interval);
-                    return `${x} ${x > 1 ? 'years' : 'year'} from now`;
-                }
-                interval = secondsSince / 2592000; // seconds in a month
-                if (interval > 1) {
-                    const x = Math.floor(interval);
-                    return `${x} ${x > 1 ? 'months' : 'month'} from now`;
-                }
-                interval = secondsSince / 86400; // seconds in a day
-                if (interval > 1) {
-                    const x = Math.floor(interval);
-                    return `${x} ${x > 1 ? 'days' : 'day'} from now`;
-                }
-                interval = secondsSince / 3600; // seconds in an hour
-                if (interval > 1) {
-                    const x = Math.floor(interval);
-                    return `${x} ${x > 1 ? 'hours' : 'hour'} from now`;
-                }
-                interval = secondsSince / 60; // seconds in a minute :)
-                if (interval > 1) {
-                    const x = Math.floor(interval);
-                    return `${x} ${x > 1 ? 'minutes' : 'minute'} from now`;
-                }
-                if (secondsSince > 10) {
-                    const x = Math.floor(secondsSince);
-                    return `${x} ${x > 1 ? 'seconds' : 'second'} from now`;
-                }
-                return 'Now';
-            }
-        }
-        return String(nr);
-    }
-    else {
-        return nr;
-    }
-};
-//# sourceMappingURL=timestamp.js.map

package/dist/src/error.d.ts

@@ -1,21 +0,0 @@
-export declare enum ParseError {
-    'incorrectFieldType' = 0,
-    'incorrectNodeType' = 1,
-    'exceedsMaximum' = 2,
-    'subceedsMinimum' = 3,
-    'fieldDoesNotExist' = 4,
-    'incorrectFormat' = 5,
-    'referenceIsIncorrectType' = 6,
-    'valueAndDefault' = 7,
-    'defaultNotSupported' = 8,
-    'multipleOperationsNotAllowed' = 9,
-    'requiredFieldNotDefined' = 10,
-    'languageNotSupported' = 11,
-    'invalidJSON' = 12,
-    'noLanguageFound' = 13,
-    'cannotDeleteNodeFromModify' = 14,
-    'nestedModifyObjectNotAllowed' = 15,
-    'infinityNotSupported' = 16,
-    'invalidSchemaFormat' = 17,
-    'invalidProperty' = 18
-}

package/dist/src/error.js

@@ -1,23 +0,0 @@
-export var ParseError;
-(function (ParseError) {
-    ParseError[ParseError["incorrectFieldType"] = 0] = "incorrectFieldType";
-    ParseError[ParseError["incorrectNodeType"] = 1] = "incorrectNodeType";
-    ParseError[ParseError["exceedsMaximum"] = 2] = "exceedsMaximum";
-    ParseError[ParseError["subceedsMinimum"] = 3] = "subceedsMinimum";
-    ParseError[ParseError["fieldDoesNotExist"] = 4] = "fieldDoesNotExist";
-    ParseError[ParseError["incorrectFormat"] = 5] = "incorrectFormat";
-    ParseError[ParseError["referenceIsIncorrectType"] = 6] = "referenceIsIncorrectType";
-    ParseError[ParseError["valueAndDefault"] = 7] = "valueAndDefault";
-    ParseError[ParseError["defaultNotSupported"] = 8] = "defaultNotSupported";
-    ParseError[ParseError["multipleOperationsNotAllowed"] = 9] = "multipleOperationsNotAllowed";
-    ParseError[ParseError["requiredFieldNotDefined"] = 10] = "requiredFieldNotDefined";
-    ParseError[ParseError["languageNotSupported"] = 11] = "languageNotSupported";
-    ParseError[ParseError["invalidJSON"] = 12] = "invalidJSON";
-    ParseError[ParseError["noLanguageFound"] = 13] = "noLanguageFound";
-    ParseError[ParseError["cannotDeleteNodeFromModify"] = 14] = "cannotDeleteNodeFromModify";
-    ParseError[ParseError["nestedModifyObjectNotAllowed"] = 15] = "nestedModifyObjectNotAllowed";
-    ParseError[ParseError["infinityNotSupported"] = 16] = "infinityNotSupported";
-    ParseError[ParseError["invalidSchemaFormat"] = 17] = "invalidSchemaFormat";
-    ParseError[ParseError["invalidProperty"] = 18] = "invalidProperty";
-})(ParseError || (ParseError = {}));
-//# sourceMappingURL=error.js.map

package/dist/src/index.d.ts

@@ -1,6 +0,0 @@
-export * from './types.js';
-export * from './validateSchema/index.js';
-export * from './walker/index.js';
-export * from './set/index.js';
-export * from './display/index.js';
-export * from './compat/index.js';

package/dist/src/index.js

@@ -1,7 +0,0 @@
-export * from './types.js';
-export * from './validateSchema/index.js';
-export * from './walker/index.js';
-export * from './set/index.js';
-export * from './display/index.js';
-export * from './compat/index.js';
-//# sourceMappingURL=index.js.map