@resistdesign/voltra 3.0.0-alpha.3 → 3.0.0-alpha.4

package/src/common/TypeParsing/TypeInfo.d.ts

@@ -1,142 +0,0 @@
-/**
- * A set of possible operations for a type or field value.
- * */
-export declare enum TypeOperation {
-    CREATE = "CREATE",
-    READ = "READ",
-    UPDATE = "UPDATE",
-    DELETE = "DELETE"
-}
-/**
- * A map of denied operations for a type or field value.
- * */
-export type DeniedOperations = Partial<Record<TypeOperation, boolean>>;
-/**
- * Voltra supported `TypeInfo` tags.
- * */
-export type SupportedTags = Partial<{
-    /**
-     * The human-readable label for the type.
-     * */
-    label: string;
-    /**
-     * Operations that will be denied at the type level.
-     * */
-    deniedOperations: DeniedOperations;
-    /**
-     * Whether a pagination UI should enable full paging or just expect cursor-based paging.
-     * */
-    fullPaging: boolean;
-    /**
-     * Whether this type will be persisted in a storage solution.
-     * */
-    persisted: boolean;
-}>;
-/**
- * Voltra supported `TypeInfoField` tags.
- * */
-export type SupportedFieldTags = Partial<{
-    /**
-     * Is this field the primary (uniquely identifying) field for the type?
-     * */
-    primaryField: boolean;
-    /**
-     * The human-readable label for the field.
-     * */
-    label: string;
-    /**
-     * The format or "type" for the field inout.
-     * Example: "number", "email", "tel", etc.
-     * */
-    format: string;
-    /**
-     * Allows a custom entry in a select input.
-     * */
-    allowCustomSelection: boolean;
-    /**
-     * A custom type name used to process the field value with custom validators and/or other custom application features.
-     * */
-    customType: string;
-    /**
-     * Whether this field is displayed in forms, information displays, lists, etc.
-     * */
-    hidden: boolean;
-    /**
-     * Whether a pagination UI should enable full paging or just expect cursor-based paging.
-     * NOTE: This is only used when the field has type reference.
-     * */
-    fullPaging: boolean;
-    /**
-     * A set of constraints for the field value.
-     * */
-    constraints: Partial<{
-        /**
-         * The default value for the field.
-         */
-        defaultValue: any;
-        /**
-         * The step increment for the field.
-         * */
-        step: number;
-        /**
-         * The minimum value for the field.
-         * */
-        min: number;
-        /**
-         * The maximum value for the field.
-         * */
-        max: number;
-        /**
-         * A regex pattern used to validate the field value.
-         * */
-        pattern: string;
-    }>;
-    /**
-     * Operations that will be denied at the field level.
-     * */
-    deniedOperations: DeniedOperations;
-}>;
-/**
- * The set of acceptable literal value types.
- */
-export type LiteralValue = string | number | boolean | null;
-/**
- * The set of acceptable type keywords.
- */
-export type TypeKeyword = "string" | "number" | "boolean";
-/**
- * Information about a field in a type definition.
- */
-export type TypeInfoField = {
-    type: TypeKeyword;
-    typeReference?: string;
-    array: boolean;
-    readonly: boolean;
-    optional: boolean;
-    possibleValues?: LiteralValue[];
-    tags?: SupportedFieldTags;
-};
-/**
- * Information about a type definition.
- */
-export type TypeInfo = {
-    primaryField?: string;
-    fields?: Record<string, TypeInfoField>;
-    tags?: SupportedTags;
-    unionFieldSets?: string[][];
-};
-/**
- * A map of type information maps.
- */
-export type TypeInfoMap = Record<string, TypeInfo>;
-/**
- * The necessary information to use a {@link TypeInfo} with the entire {@link TypeInfoMap} containing it.
- * */
-export type TypeInfoPack = {
-    entryTypeName: string;
-    typeInfoMap: TypeInfoMap;
-};
-/**
- * An actual data item described by type info.
- * */
-export type TypeInfoDataItem = Record<string, LiteralValue | LiteralValue[]>;

package/src/common/TypeParsing/TypeInfo.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeOperation = void 0;
-/**
- * A set of possible operations for a type or field value.
- * */
-var TypeOperation;
-(function (TypeOperation) {
-    TypeOperation["CREATE"] = "CREATE";
-    TypeOperation["READ"] = "READ";
-    TypeOperation["UPDATE"] = "UPDATE";
-    TypeOperation["DELETE"] = "DELETE";
-})(TypeOperation || (exports.TypeOperation = TypeOperation = {}));

package/src/common/TypeParsing/TypeMapping.d.ts

@@ -1,9 +0,0 @@
-import { Node, TypeAliasDeclaration } from "typescript";
-/**
- * A map of type aliases in the TypeScript AST.
- */
-export type TypeMap = Record<string, TypeAliasDeclaration>;
-/**
- * Converts a TypeScript AST to a map of type aliases.
- */
-export declare const convertASTToMap: (node: Node, map?: Record<string, TypeAliasDeclaration>, parentName?: string) => TypeMap;

package/src/common/TypeParsing/TypeMapping.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertASTToMap = void 0;
-const typescript_1 = require("typescript");
-/**
- * Converts a TypeScript AST to a map of type aliases.
- */
-const convertASTToMap = (node, map = {}, parentName) => {
-    node.forEachChild((child) => {
-        const { kind: childKind } = child;
-        if (childKind === typescript_1.SyntaxKind.ModuleDeclaration) {
-            const moduleNode = child;
-            const { name: moduleName } = moduleNode;
-            const textModuleName = moduleName.getText();
-            const fullModuleName = parentName
-                ? `${parentName}.${textModuleName}`
-                : textModuleName;
-            (0, exports.convertASTToMap)(moduleNode, map, fullModuleName);
-        }
-        if (childKind === typescript_1.SyntaxKind.ModuleBlock) {
-            (0, exports.convertASTToMap)(child, map, parentName);
-        }
-        if (childKind === typescript_1.SyntaxKind.TypeAliasDeclaration) {
-            const typeAliasDec = child;
-            const { name: { text: typeName }, } = typeAliasDec;
-            const fullTypeName = parentName ? `${parentName}.${typeName}` : typeName;
-            map[fullTypeName] = typeAliasDec;
-        }
-    });
-    return map;
-};
-exports.convertASTToMap = convertASTToMap;

package/src/common/TypeParsing/TypeParsing.d.ts

@@ -1,5 +0,0 @@
-import { TypeInfoMap } from "./TypeInfo";
-/**
- * Extracts type information from TypeScript content.
- */
-export declare const getTypeInfoMapFromTypeScript: (source: string) => TypeInfoMap;

package/src/common/TypeParsing/TypeParsing.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTypeInfoMapFromTypeScript = void 0;
-const typescript_1 = require("typescript");
-const TypeMapping_1 = require("./TypeMapping");
-const getTypeInfoFromTypeAlias_1 = require("./ParsingUtils/getTypeInfoFromTypeAlias");
-const getPrimaryFieldForTypeInfo_1 = require("./ParsingUtils/getPrimaryFieldForTypeInfo");
-/**
- * Extracts type information from TypeScript content.
- */
-const getTypeInfoMapFromTypeScript = (source) => {
-    const typeScriptNode = (0, typescript_1.createSourceFile)("x.ts", source, typescript_1.ScriptTarget.Latest, true);
-    const typeMap = (0, TypeMapping_1.convertASTToMap)(typeScriptNode, {});
-    const typeInfoMap = {};
-    for (const key in typeMap) {
-        const typeAliasDec = typeMap[key];
-        const { modifiers } = typeAliasDec;
-        let outputTypeInfo = false;
-        if (modifiers) {
-            modifiers.forEach((modifier) => {
-                const { kind } = modifier;
-                if (kind === typescript_1.SyntaxKind.ExportKeyword) {
-                    outputTypeInfo = true;
-                }
-            });
-        }
-        if (outputTypeInfo) {
-            const typeInfo = (0, getTypeInfoFromTypeAlias_1.getTypeInfoFromTypeAlias)(typeAliasDec, typeMap);
-            if (typeInfo) {
-                typeInfoMap[key] = {
-                    ...typeInfo,
-                    primaryField: (0, getPrimaryFieldForTypeInfo_1.getPrimaryFieldForTypeInfo)(typeInfo),
-                };
-            }
-        }
-    }
-    return typeInfoMap;
-};
-exports.getTypeInfoMapFromTypeScript = getTypeInfoMapFromTypeScript;

package/src/common/TypeParsing/Utils.d.ts

@@ -1,21 +0,0 @@
-import { TypeInfo, TypeInfoDataItem } from "./TypeInfo";
-/**
- * Remove all fields, from a list of selected fields, that are not in the type info.
- * */
-export declare const removeNonexistentFieldsFromSelectedFields: <ItemType extends TypeInfoDataItem>(typeInfo?: TypeInfo, selectedFields?: (keyof ItemType)[]) => (keyof ItemType)[] | undefined;
-/**
- * Remove all fields, from a list of selected fields, that are a type reference.
- * */
-export declare const removeTypeReferenceFieldsFromSelectedFields: <ItemType>(typeInfo?: TypeInfo, selectedFields?: (keyof ItemType)[]) => (keyof ItemType)[] | undefined;
-/**
- * Remove all fields, from a data item, that are a type reference.
- * */
-export declare const removeTypeReferenceFieldsFromDataItem: (typeInfo?: TypeInfo, dataItem?: Partial<TypeInfoDataItem>) => Partial<TypeInfoDataItem>;
-/**
- * Remove all fields, from a data item, that are not in the type info.
- * */
-export declare const removeNonexistentFieldsFromDataItem: (typeInfo?: TypeInfo, dataItem?: Partial<TypeInfoDataItem>) => Partial<TypeInfoDataItem>;
-/**
- * Remove all fields, from a data item, that are not selected.
- * */
-export declare const removeUnselectedFieldsFromDataItem: <ItemType extends TypeInfoDataItem>(dataItem?: Partial<ItemType>, selectedFields?: (keyof ItemType)[]) => Partial<ItemType>;

package/src/common/TypeParsing/Utils.js

@@ -1,94 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeUnselectedFieldsFromDataItem = exports.removeNonexistentFieldsFromDataItem = exports.removeTypeReferenceFieldsFromDataItem = exports.removeTypeReferenceFieldsFromSelectedFields = exports.removeNonexistentFieldsFromSelectedFields = void 0;
-/**
- * Remove all fields, from a list of selected fields, that are not in the type info.
- * */
-const removeNonexistentFieldsFromSelectedFields = (typeInfo = {}, selectedFields) => {
-    if (Array.isArray(selectedFields)) {
-        const { fields = {} } = typeInfo;
-        const cleanSelectFields = [];
-        for (const tIF in fields) {
-            if (selectedFields.includes(tIF)) {
-                cleanSelectFields.push(tIF);
-            }
-        }
-        return cleanSelectFields;
-    }
-    else {
-        return selectedFields;
-    }
-};
-exports.removeNonexistentFieldsFromSelectedFields = removeNonexistentFieldsFromSelectedFields;
-/**
- * Remove all fields, from a list of selected fields, that are a type reference.
- * */
-const removeTypeReferenceFieldsFromSelectedFields = (typeInfo = {}, selectedFields) => {
-    if (Array.isArray(selectedFields)) {
-        const { fields = {} } = typeInfo;
-        const cleanSelectFields = [];
-        for (const tIF in fields) {
-            const { typeReference } = fields[tIF];
-            if (typeof typeReference === "undefined" &&
-                selectedFields.includes(tIF)) {
-                cleanSelectFields.push(tIF);
-            }
-        }
-        return cleanSelectFields;
-    }
-    else {
-        return selectedFields;
-    }
-};
-exports.removeTypeReferenceFieldsFromSelectedFields = removeTypeReferenceFieldsFromSelectedFields;
-/**
- * Remove all fields, from a data item, that are a type reference.
- * */
-const removeTypeReferenceFieldsFromDataItem = (typeInfo = {}, dataItem = {}) => {
-    const { fields = {} } = typeInfo;
-    const cleanItem = {};
-    for (const tIF in fields) {
-        const { typeReference } = fields[tIF];
-        if (typeof typeReference === "undefined" &&
-            typeof dataItem[tIF] !== "undefined") {
-            cleanItem[tIF] = dataItem[tIF];
-        }
-    }
-    return cleanItem;
-};
-exports.removeTypeReferenceFieldsFromDataItem = removeTypeReferenceFieldsFromDataItem;
-/**
- * Remove all fields, from a data item, that are not in the type info.
- * */
-const removeNonexistentFieldsFromDataItem = (typeInfo = {}, dataItem = {}) => {
-    const { fields = {} } = typeInfo;
-    const cleanItem = {};
-    for (const tIF in dataItem) {
-        if (fields[tIF]) {
-            cleanItem[tIF] = dataItem[tIF];
-        }
-    }
-    return cleanItem;
-};
-exports.removeNonexistentFieldsFromDataItem = removeNonexistentFieldsFromDataItem;
-/**
- * Remove all fields, from a data item, that are not selected.
- * */
-const removeUnselectedFieldsFromDataItem = (dataItem = {}, selectedFields) => {
-    if (!selectedFields) {
-        return dataItem;
-    }
-    else {
-        const cleanInitialDataItem = typeof dataItem === "object" && dataItem !== null
-            ? dataItem
-            : {};
-        const cleanItem = {};
-        for (const f in cleanInitialDataItem) {
-            if (selectedFields.includes(f)) {
-                cleanItem[f] = dataItem[f];
-            }
-        }
-        return cleanItem;
-    }
-};
-exports.removeUnselectedFieldsFromDataItem = removeUnselectedFieldsFromDataItem;

package/src/common/TypeParsing/Validation.d.ts

@@ -1,92 +0,0 @@
-import { TypeInfo, TypeInfoField, TypeInfoMap, TypeKeyword, TypeOperation } from "./TypeInfo";
-export declare enum RelationshipValidationType {
-    INCLUDE = "INCLUDE",
-    EXCLUDE = "EXCLUDE",
-    STRICT_EXCLUDE = "STRICT_EXCLUDE"
-}
-/**
- * A custom type info field validator.
- * */
-export type CustomTypeInfoFieldValidator = (value: any) => boolean;
-/**
- * A map of custom type info field validators.
- * */
-export type CustomTypeInfoFieldValidatorMap = Record<string, CustomTypeInfoFieldValidator>;
-/**
- * A map of errors.
- * */
-export type ErrorMap = {
-    [key: string]: string[];
-};
-/**
- * The validation results for type info fields.
- */
-export type TypeInfoValidationResults = {
-    typeName: string | null;
-    valid: boolean;
-    error: string;
-    errorMap: ErrorMap;
-};
-export declare const INVALID_CUSTOM_TYPE = "INVALID_CUSTOM_TYPE";
-export declare const PRIMITIVE_ERROR_MESSAGE_CONSTANTS: Record<TypeKeyword, string>;
-export declare const ERROR_MESSAGE_CONSTANTS: {
-    MISSING: string;
-    INVALID_OPTION: string;
-    INVALID_FIELD: string;
-    RELATIONSHIP_VALUES_ARE_STRICTLY_EXCLUDED: string;
-    INVALID_TYPE: string;
-    NO_UNION_TYPE_MATCHED: string;
-    TYPE_DOES_NOT_EXIST: string;
-    INVALID_PATTERN: string;
-    VALUE_DOES_NOT_MATCH_PATTERN: string;
-};
-export declare const DENIED_TYPE_OPERATIONS: Record<TypeOperation, string>;
-/**
- * Validates a value against a pattern.
- *
- * `value` must be a string or not supplied.
- * `pattern` must be a string or not supplied.
- *
- * If either are not supplied, the result is valid.
- * */
-export declare const validateValueMatchesPattern: (typeName: string, value?: any, pattern?: string) => TypeInfoValidationResults;
-/**
- * Gets the validity value.
- */
-export declare const getValidityValue: (existing: boolean, pending: boolean) => boolean;
-/**
- * The validators for primitive values.
- */
-export declare const TYPE_KEYWORD_VALIDATORS: Record<TypeKeyword, (value: any) => boolean>;
-/**
- * Checks if a value has a value.
- */
-export declare const hasValue: (value: any) => boolean;
-/**
- * Validates a primitive value.
- */
-export declare const validateKeywordType: (value: any, type: string) => boolean;
-/**
- * Validates a custom type.
- */
-export declare const validateCustomType: (value: any, customType?: string, customValidators?: CustomTypeInfoFieldValidatorMap) => boolean;
-/**
- * Validates a type info field value.
- */
-export declare const validateTypeInfoFieldValue: (value: any, typeInfoField: TypeInfoField, typeInfoMap: TypeInfoMap, ignoreArray?: boolean, strict?: boolean, customValidators?: CustomTypeInfoFieldValidatorMap, typeOperation?: TypeOperation, relationshipValidationType?: RelationshipValidationType, itemIsPartial?: boolean) => TypeInfoValidationResults;
-/**
- * Validates an array of type info field values.
- */
-export declare const validateArrayOfTypeInfoFieldValues: (values: any[] | undefined, typeInfoField: TypeInfoField, typeInfoMap: TypeInfoMap, strict?: boolean, customValidators?: CustomTypeInfoFieldValidatorMap, typeOperation?: TypeOperation, relationshipValidationType?: RelationshipValidationType, itemIsPartial?: boolean) => TypeInfoValidationResults;
-/**
- * Validates a type info field operation.
- * */
-export declare const validateTypeInfoFieldOperationAllowed: (fieldName: string, fieldOperation?: TypeOperation, typeInfoField?: TypeInfoField) => TypeInfoValidationResults;
-/**
- * Validates a type info operation.
- * */
-export declare const validateTypeOperationAllowed: (typeName: string, valueFields: string[], typeOperation: TypeOperation, typeInfo: TypeInfo) => TypeInfoValidationResults;
-/**
- * Validates a type info value.
- */
-export declare const validateTypeInfoValue: (value: any, typeInfoFullName: string, typeInfoMap: TypeInfoMap, strict?: boolean, customValidators?: CustomTypeInfoFieldValidatorMap, typeOperation?: TypeOperation, relationshipValidationType?: RelationshipValidationType, itemIsPartial?: boolean) => TypeInfoValidationResults;