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

package/src/common/SearchValidation.js

@@ -1,90 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateSearchFields = exports.SEARCH_VALIDATION_ERRORS = void 0;
-const SearchTypes_1 = require("./SearchTypes");
-const Validation_1 = require("./TypeParsing/Validation");
-const TypeInfo_1 = require("./TypeParsing/TypeInfo");
-const Routing_1 = require("./Routing");
-/**
- * Search validation errors.
- * */
-exports.SEARCH_VALIDATION_ERRORS = {
-    INVALID_TYPE_INFO: "INVALID_TYPE_INFO",
-    RELATIONAL_FIELDS_NOT_ALLOWED: "RELATIONAL_FIELDS_NOT_ALLOWED",
-    INVALID_FIELD: "INVALID_FIELD",
-    INVALID_VALUE_OPTION: "INVALID_VALUE_OPTION",
-    INVALID_OPERATOR: "INVALID_OPERATOR",
-};
-/**
- * Validate search fields against type info fields.
- * */
-const validateSearchFields = (typeInfoName, typeInfoMap, searchFields = [], disallowRelationalFields, customValidators) => {
-    const typeInfo = typeInfoMap[typeInfoName];
-    const results = {
-        typeName: typeInfoName,
-        valid: true,
-        error: "",
-        errorMap: {},
-    };
-    if (typeInfo) {
-        const { fields = {} } = typeInfo;
-        for (const f of searchFields) {
-            const { fieldName, operator, customOperator, value, valueOptions } = f;
-            if (!customOperator &&
-                (!operator || !Object.values(SearchTypes_1.ComparisonOperators).includes(operator))) {
-                results.valid = false;
-                results.errorMap[fieldName] = [
-                    exports.SEARCH_VALIDATION_ERRORS.INVALID_OPERATOR,
-                ];
-            }
-            else {
-                const tIF = fields[fieldName];
-                if (tIF) {
-                    const { typeReference, tags = {} } = tIF;
-                    const { deniedOperations: { READ: denyRead = false } = {} } = tags;
-                    if (denyRead) {
-                        results.valid = false;
-                        results.errorMap[fieldName] = [
-                            exports.SEARCH_VALIDATION_ERRORS.INVALID_FIELD,
-                        ];
-                    }
-                    else if (disallowRelationalFields && typeReference) {
-                        results.valid = false;
-                        results.errorMap[fieldName] = [
-                            exports.SEARCH_VALIDATION_ERRORS.RELATIONAL_FIELDS_NOT_ALLOWED,
-                        ];
-                    }
-                    else {
-                        const targetValueOptions = Array.isArray(valueOptions)
-                            ? valueOptions
-                            : [value];
-                        for (const tVO of targetValueOptions) {
-                            const { valid: valueIsValid, errorMap: valueErrorMap } = (0, Validation_1.validateTypeInfoFieldValue)(tVO, tIF, typeInfoMap, false, true, customValidators, TypeInfo_1.TypeOperation.READ, disallowRelationalFields
-                                ? Validation_1.RelationshipValidationType.STRICT_EXCLUDE
-                                : Validation_1.RelationshipValidationType.INCLUDE, true);
-                            if (!valueIsValid) {
-                                results.valid = false;
-                                for (const fE in valueErrorMap) {
-                                    results.errorMap[(0, Routing_1.getPathString)([fieldName, fE])] =
-                                        valueErrorMap[fE];
-                                }
-                            }
-                        }
-                    }
-                }
-                else {
-                    results.valid = false;
-                    results.errorMap[fieldName] = [
-                        exports.SEARCH_VALIDATION_ERRORS.INVALID_FIELD,
-                    ];
-                }
-            }
-        }
-    }
-    else {
-        results.valid = false;
-        results.error = exports.SEARCH_VALIDATION_ERRORS.INVALID_TYPE_INFO;
-    }
-    return results;
-};
-exports.validateSearchFields = validateSearchFields;

package/src/common/Storyboarding/Types.d.ts

@@ -1,25 +0,0 @@
-/**
- * A storyboard use case scenario.
- * */
-export type UseCase = {
-    targetExport: string;
-    description: string;
-    conditions: Record<string, any>;
-};
-/**
- * A storyboard for a component.
- * */
-export type Storyboard = {
-    targetFile: string;
-    useCases: UseCase[];
-};
-/**
- * A storyboard that has been loaded from a JSON file.
- * */
-export type LoadedStoryboard = {
-    path: string;
-} & Storyboard;
-/**
- * A map of {@link LoadedStoryboard}s.
- * */
-export type LoadedStoryboardMap = Record<string, LoadedStoryboard>;

package/src/common/Storyboarding/Types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/src/common/StringTransformers.d.ts

@@ -1,17 +0,0 @@
-import { TypeKeyword } from "./TypeParsing/TypeInfo";
-/**
- * A function that transforms a value into a string.
- * */
-export type StringTransformer = (value: any) => string;
-/**
- * A map of string transformers for each type keyword.
- * */
-export declare const STRING_TRANSFORMERS: Record<TypeKeyword, StringTransformer>;
-/**
- * A map of custom string transformers for each custom type.
- * */
-export declare const CUSTOM_STRING_TRANSFORMERS: Record<string, StringTransformer>;
-/**
- * Transform a value into a string based on the type keyword or custom type.
- * */
-export declare const transformValueToString: (value: any, typeKeyword: TypeKeyword, customType?: string) => string;

package/src/common/StringTransformers.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformValueToString = exports.CUSTOM_STRING_TRANSFORMERS = exports.STRING_TRANSFORMERS = void 0;
-/**
- * Transform a value into a string when a string is expected.
- * */
-const transformWhenStringExpected = (value) => (value ?? false) === false ? "" : `${value}`;
-/**
- * A map of string transformers for each type keyword.
- * */
-exports.STRING_TRANSFORMERS = {
-    string: transformWhenStringExpected,
-    number: transformWhenStringExpected,
-    boolean: (value) => (value ? "true" : "false"),
-};
-/**
- * A map of custom string transformers for each custom type.
- * */
-exports.CUSTOM_STRING_TRANSFORMERS = {
-    date: (value) => value.toISOString(),
-    time: (value) => value.toISOString(),
-    datetime: (value) => value.toISOString(),
-    duration: (value) => value.toString(),
-    reference: (value) => value.toString(),
-    unknown: (value) => value.toString(),
-};
-/**
- * Transform a value into a string based on the type keyword or custom type.
- * */
-const transformValueToString = (value, typeKeyword, customType) => {
-    const transformer = customType
-        ? exports.CUSTOM_STRING_TRANSFORMERS[customType]
-        : exports.STRING_TRANSFORMERS[typeKeyword];
-    return transformer ? transformer(value) : "";
-};
-exports.transformValueToString = transformValueToString;

package/src/common/Testing/CLI.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env ts-node
-export declare const main: () => Promise<void>;

package/src/common/Testing/CLI.js

@@ -1,56 +0,0 @@
-#!/usr/bin/env ts-node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.main = void 0;
-const Utils_1 = require("./Utils");
-const fast_glob_1 = __importDefault(require("fast-glob"));
-const picocolors_1 = __importDefault(require("picocolors"));
-const main = async () => {
-    const args = process.argv.slice(2);
-    const generateMode = args.includes("--generate");
-    const testPath = args.filter((arg) => arg !== "--generate")[0];
-    console.log(`${picocolors_1.default.bgMagenta(picocolors_1.default.whiteBright(" VEST "))}\n`);
-    if (!testPath) {
-        console.error("Usage: vest [--generate] <test-directory-path>");
-        process.exit(1);
-    }
-    const testFiles = await (0, fast_glob_1.default)(testPath);
-    if (testFiles.length === 0) {
-        console.warn(`No test files found in ${testPath}`);
-        process.exit(0);
-    }
-    let results = {
-        messages: [],
-        passes: [],
-        failures: [],
-        errors: [],
-    };
-    await (0, Utils_1.executeTestingCommand)(testFiles, generateMode, (latestResults) => {
-        const { messages = [], generated = [], passes = [], failures = [], errors = [], } = latestResults;
-        results = (0, Utils_1.mergeTestResults)(results, latestResults);
-        messages.forEach((message) => console.log(`${picocolors_1.default.blueBright("MESSAGE:")} ${message}\n`));
-        generated.forEach((generated) => console.log(`${picocolors_1.default.greenBright("GENERATED:")} ${generated}\n`));
-        passes.forEach((pass) => console.log(`${picocolors_1.default.greenBright("PASSED:")} ${pass}\n`));
-        failures.forEach((failure) => console.error(`${picocolors_1.default.redBright("FAILED:")} ${failure}\n`));
-        errors.forEach((error) => console.error(`${picocolors_1.default.redBright(picocolors_1.default.italic("ERROR:"))} ${error}\n`));
-    });
-    const { generated = [], passes = [], failures = [], errors = [] } = results;
-    const exitValue = failures.length + errors.length;
-    if (generateMode) {
-        console.log(`${picocolors_1.default.greenBright("GENERATED:")} ${generated.length}
-${picocolors_1.default.redBright(picocolors_1.default.italic("ERRORS:"))} ${errors.length}
-`);
-    }
-    else {
-        console.log(`${picocolors_1.default.greenBright("PASSES:")} ${passes.length}
-${picocolors_1.default.redBright("FAILURES:")} ${failures.length}
-${picocolors_1.default.redBright(picocolors_1.default.italic("ERRORS:"))} ${errors.length}
-`);
-    }
-    process.exit(exitValue);
-};
-exports.main = main;
-(0, exports.main)().then();

package/src/common/Testing/Types.d.ts

@@ -1,117 +0,0 @@
-/**
- * Operations used for comparison of during tests.
- * */
-export declare enum TestComparisonOperation {
-    EQUALS = "===",
-    NOT_EQUALS = "!==",
-    IN = "IN",
-    ARRAY_CONTAINS = "ARRAY_CONTAINS",
-    BETWEEN = "BETWEEN",
-    CONTAINS = "CONTAINS",
-    REGEX = "REGEX",
-    EXT_REGEX = "EXT_REGEX",
-    DEEP_EQUALS = "DEEP_EQUALS",
-    ARRAY_EQUALS = "ARRAY_EQUALS"
-}
-/**
- * A pattern definition object for use with extended regex expectations.
- * */
-export type PatternElement = {
-    value: string;
-    escaped?: boolean;
-};
-/**
- * An extended regex expectation with a patter structure, optional flags and
- * escaping properties that allow for clear and explicit declaration of regex
- * patterns in JSON.
- *
- * Used when a `TestCondition` `operation` is `TestComparisonOperation.EXT_REGEX`.
- * */
-export type EXTRegexExpectation = {
-    pattern: PatternElement[];
-    flags?: string;
-};
-/**
- * A regex expectation with a pattern and optional flags.
- *
- * Used when a `TestCondition` `operation` is `TestComparisonOperation.REGEX`.
- * */
-export type RegexExpectation = {
-    pattern: string;
-    flags?: string;
-};
-/**
- * A configuration used to acquire conditions from code instead of a JSON array.
- * */
-export type ConditionConfig = {
-    file: string;
-    export: string;
-};
-/**
- * Preparation for a test when some setup is required or a class needs to be instantiated.
- * */
-export type TestSetup = {
-    conditions: unknown[] | ConditionConfig;
-    export: string;
-    instantiate?: boolean;
-};
-/**
- * The basis for a test.
- * */
-export type BaseTest = {
-    export: string;
-    setup?: TestSetup;
-    conditions: unknown[] | ConditionConfig;
-    expectUndefined?: boolean;
-};
-/**
- * A singular test with specific types of expectations for a given operation.
- * */
-export type Test = BaseTest & ({
-    operation?: TestComparisonOperation.EQUALS | TestComparisonOperation.NOT_EQUALS;
-    expectation: string | number | boolean | null | undefined;
-} | {
-    operation: TestComparisonOperation.IN | TestComparisonOperation.ARRAY_CONTAINS;
-    expectation: unknown[];
-} | {
-    operation: TestComparisonOperation.BETWEEN;
-    expectation: [number, number];
-} | {
-    operation: TestComparisonOperation.CONTAINS;
-    expectation: string;
-} | {
-    operation: TestComparisonOperation.REGEX;
-    expectation: RegexExpectation;
-} | {
-    operation: TestComparisonOperation.EXT_REGEX;
-    expectation: EXTRegexExpectation;
-} | {
-    operation: TestComparisonOperation.DEEP_EQUALS;
-    expectation: Record<string, unknown>;
-} | {
-    operation: TestComparisonOperation.ARRAY_EQUALS;
-    expectation: unknown[];
-});
-/**
- * A configuration for a test. Designed to be used in JSON for declarative test files.
- * */
-export type TestConfig = {
-    file: string;
-    tests: Test[];
-};
-/**
- * A resolved test configuration with the module and tests.
- * */
-export type ResolvedTestConfig = {
-    targetModule: any;
-} & TestConfig;
-/**
- * The results from running one or more tests.
- * */
-export type TestResults = {
-    messages?: string[];
-    generated?: string[];
-    passes?: string[];
-    failures?: string[];
-    errors?: string[];
-};

package/src/common/Testing/Types.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestComparisonOperation = void 0;
-/**
- * Operations used for comparison of during tests.
- * */
-var TestComparisonOperation;
-(function (TestComparisonOperation) {
-    TestComparisonOperation["EQUALS"] = "===";
-    TestComparisonOperation["NOT_EQUALS"] = "!==";
-    TestComparisonOperation["IN"] = "IN";
-    TestComparisonOperation["ARRAY_CONTAINS"] = "ARRAY_CONTAINS";
-    TestComparisonOperation["BETWEEN"] = "BETWEEN";
-    TestComparisonOperation["CONTAINS"] = "CONTAINS";
-    TestComparisonOperation["REGEX"] = "REGEX";
-    TestComparisonOperation["EXT_REGEX"] = "EXT_REGEX";
-    TestComparisonOperation["DEEP_EQUALS"] = "DEEP_EQUALS";
-    TestComparisonOperation["ARRAY_EQUALS"] = "ARRAY_EQUALS";
-})(TestComparisonOperation || (exports.TestComparisonOperation = TestComparisonOperation = {}));

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

@@ -1,48 +0,0 @@
-import { ConditionConfig, ResolvedTestConfig, Test, TestComparisonOperation, TestConfig, TestResults } from "./Types";
-/**
- * A map of comparison functions for each `TestComparisonOperation`.
- * */
-export declare const OPERATIONS: Record<string, (a: unknown, b: unknown) => boolean>;
-/**
- * Compare a result with an expectation using a specified `TestComparisonOperation`.
- * */
-export declare const compare: (result: unknown, expectation: unknown, operation?: TestComparisonOperation) => boolean;
-/**
- * Get the target module for testing from a file being tested.
- * */
-export declare const getResolvedConditions: (testFilePath: string, targetTestIndex: number, targetTestExport: string, conditions: unknown[] | ConditionConfig, isSetup?: boolean) => unknown[];
-/**
- * Get the target base instance from a module, for a given test setup.
- * */
-export declare const getSetupInstance: (testFilePath: string, targetTestIndex: number, targetTestExport: string, test: Test, module: any) => Promise<any>;
-export declare const getTestFunction: (testFilePath: string, file: string, targetTestIndex: number, test: Test, targetModule: any) => Promise<(...args: unknown[]) => Promise<unknown> | unknown>;
-/**
- * Get the test configuration from a test file.
- * */
-export declare const getTestConfig: (testFilePath: string) => Promise<TestConfig>;
-/**
- * Get the target module for testing from a file being tested.
- * */
-export declare const getResolvedTestConfig: (testFilePath: string) => Promise<ResolvedTestConfig>;
-/**
- * Merge multiple test results into a single result.
- * */
-export declare const mergeTestResults: (...results: TestResults[]) => TestResults;
-/**
- * Run a test using a test function and a test condition.
- * */
-export declare const runTest: (testFilePath: string, testFunction: (...args: unknown[]) => Promise<unknown> | unknown, test: Test, index: number, targetExport: string, report: (results: TestResults) => void) => Promise<void>;
-/**
- * Generate tests for a file by running the tests, capturing the current result and storing it as the new expectation.
- * */
-export declare const generateTestsForFile: (testFilePath: string, report: (results: TestResults) => void) => Promise<void>;
-/**
- * Run the tests for a given test file.
- *
- * The test file content is expected to be a JSON in the structure of a `TestConfig`.
- * */
-export declare const runTestsForFile: (testFilePath: string, report: (results: TestResults) => void) => Promise<void>;
-/**
- * Run or generate all of the tests in the specified `testPath` glob.
- * */
-export declare const executeTestingCommand: (testFiles: string[], generateMode: boolean | undefined, report: (results: TestResults) => void) => Promise<void>;