@archbase/core 3.0.0

package/dist/validator/validation/Validator.d.ts

@@ -0,0 +1,37 @@
+import { ValidationError } from './ValidationError';
+import { ValidatorOptions } from './ValidatorOptions';
+/**
+ * Validator performs validation of the given object based on its metadata.
+ */
+export declare class Validator {
+    /**
+     * Performs validation of the given object based on decorators used in given object class.
+     */
+    validate(object: object, options?: ValidatorOptions): Promise<ValidationError[]>;
+    /**
+     * Performs validation of the given object based on validation schema.
+     */
+    validate(schemaName: string, object: object, options?: ValidatorOptions): Promise<ValidationError[]>;
+    /**
+     * Performs validation of the given object based on decorators used in given object class and reject on error.
+     */
+    validateOrReject(object: object, options?: ValidatorOptions): Promise<void>;
+    /**
+     * Performs validation of the given object based on validation schema and reject on error.
+     */
+    validateOrReject(schemaName: string, object: object, options?: ValidatorOptions): Promise<void>;
+    /**
+     * Performs validation of the given object based on decorators used in given object class.
+     * NOTE: This method completely ignores all async validations.
+     */
+    validateSync(object: object, options?: ValidatorOptions): ValidationError[];
+    /**
+     * Performs validation of the given object based on validation schema.
+     */
+    validateSync(schemaName: string, object: object, options?: ValidatorOptions): ValidationError[];
+    /**
+     * Performs validation of the given object based on decorators or validation schema.
+     * Common method for `validateOrReject` and `validate` methods.
+     */
+    private coreValidate;
+}

package/dist/validator/validation/ValidatorConstraintInterface.d.ts

@@ -0,0 +1,14 @@
+import { ValidationArguments } from './ValidationArguments';
+/**
+ * Custom validators must implement this interface to provide custom validation logic.
+ */
+export interface ValidatorConstraintInterface {
+    /**
+     * Method to be called to perform custom validation over given value.
+     */
+    validate(value: any, validationArguments?: ValidationArguments): Promise<boolean> | boolean;
+    /**
+     * Gets default message when validation for this constraint fail.
+     */
+    defaultMessage?(validationArguments?: ValidationArguments): string;
+}

package/dist/validator/validation/ValidatorOptions.d.ts

@@ -0,0 +1,75 @@
+/**
+ * Options passed to validator during validation.
+ */
+export interface ValidatorOptions {
+    /**
+     * If set to true then class-validator will print extra warning messages to the console when something is not right.
+     */
+    enableDebugMessages?: boolean;
+    /**
+     * If set to true then validator will skip validation of all properties that are undefined in the validating object.
+     */
+    skipUndefinedProperties?: boolean;
+    /**
+     * If set to true then validator will skip validation of all properties that are null in the validating object.
+     */
+    skipNullProperties?: boolean;
+    /**
+     * If set to true then validator will skip validation of all properties that are null or undefined in the validating object.
+     */
+    skipMissingProperties?: boolean;
+    /**
+     * If set to true validator will strip validated object of any properties that do not have any decorators.
+     *
+     * Tip: if no other decorator is suitable for your property use @Allow decorator.
+     */
+    whitelist?: boolean;
+    /**
+     * If set to true, instead of stripping non-whitelisted properties validator will throw an error
+     */
+    forbidNonWhitelisted?: boolean;
+    /**
+     * Groups to be used during validation of the object.
+     */
+    groups?: string[];
+    /**
+     * Set default for `always` option of decorators. Default can be overridden in decorator options.
+     */
+    always?: boolean;
+    /**
+     * If [groups]{@link ValidatorOptions#groups} is not given or is empty,
+     * ignore decorators with at least one group.
+     */
+    strictGroups?: boolean;
+    /**
+     * If set to true, the validation will not use default messages.
+     * Error message always will be undefined if its not explicitly set.
+     */
+    dismissDefaultMessages?: boolean;
+    /**
+     * ValidationError special options.
+     */
+    validationError?: {
+        /**
+         * Indicates if target should be exposed in ValidationError.
+         */
+        target?: boolean;
+        /**
+         * Indicates if validated value should be exposed in ValidationError.
+         */
+        value?: boolean;
+    };
+    /**
+     * Fails validation for objects unknown to class-validator. Defaults to false.
+     *
+     * For instance, since a plain empty object has no annotations used for validation:
+     * - `validate({})` // passes
+     * - `validate({}, { forbidUnknownValues: true })` // fails.
+     * - `validate(new SomeAnnotatedEmptyClass(), { forbidUnknownValues: true })` // passes.
+     */
+    forbidUnknownValues?: boolean;
+    /**
+     * When set to true, validation of the given property will stop after encountering the first error. Defaults to false.
+     */
+    stopAtFirstError?: boolean;
+}

package/dist/validator/validation-schema/ValidationSchema.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Validation schema is a decorator-free way of validation of your objects.
+ * Also using validation schemas makes this library to be easily used with es6/es5.
+ */
+export interface ValidationSchema {
+    /**
+     * Schema name. This is required, because we tell validator to validate by this schema using its name.
+     */
+    name: string;
+    /**
+     * Validated properties.
+     */
+    properties: {
+        /**
+         * Name of the object's property to be validated which holds an array of validation constraints.
+         */
+        [propertyName: string]: {
+            /**
+             * Validation type. Should be one of the ValidationTypes value.
+             */
+            type: string;
+            /**
+             * Validator name.
+             */
+            name?: string;
+            /**
+             * Constraints set by validation type.
+             */
+            constraints?: any[];
+            /**
+             * Error message used to be used on validation fail.
+             * You can use "$value" to use value that was failed by validation.
+             * You can use "$constraint1" and "$constraint2" keys in the message string,
+             * and they will be replaced with constraint values if they exist.
+             * Message can be either string, either a function that returns a string.
+             * Second option allows to use values and custom messages depend of them.
+             */
+            message?: string | ((value?: any, constraint1?: any, constraint2?: any) => string);
+            /**
+             * Specifies if validated value is an array and each of its item must be validated.
+             */
+            each?: boolean;
+            /**
+             * Indicates if validation must be performed always, no matter of validation groups used.
+             */
+            always?: boolean;
+            /**
+             * Validation groups used for this validation.
+             */
+            groups?: string[];
+            /**
+             * Specific validation type options.
+             */
+            options?: any;
+        }[];
+    };
+}

package/dist/validator/validation-schema/ValidationSchemaToMetadataTransformer.d.ts

@@ -0,0 +1,8 @@
+import { ValidationSchema } from './ValidationSchema';
+import { ValidationMetadata } from '../metadata/ValidationMetadata';
+/**
+ * Used to transform validation schemas to validation metadatas.
+ */
+export declare class ValidationSchemaToMetadataTransformer {
+    transform(schema: ValidationSchema): ValidationMetadata[];
+}

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "@archbase/core",
+  "version": "3.0.0",
+  "description": "Core utilities and foundation for Archbase React v3",
+  "author": "Edson Martins <edsonmartins2005@gmail.com>",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "source": "./src/index.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./utils": {
+      "types": "./dist/utils/index.d.ts",
+      "import": "./dist/utils/index.js",
+      "require": "./dist/utils/index.js"
+    },
+    "./styles": {
+      "import": "./dist/styles.css"
+    },
+    "./dist/index.css": "./dist/index.css"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "@mantine/core": "8.3.12",
+    "@mantine/dates": "8.3.12",
+    "@mantine/hooks": "8.3.12",
+    "@mantine/modals": "8.3.12",
+    "@mantine/notifications": "8.3.12",
+    "@mantine/spotlight": "8.3.12",
+    "react": "^18.3.0 || ^19.0.0",
+    "react-dom": "^18.3.0 || ^19.0.0"
+  },
+  "dependencies": {
+    "@juggle/resize-observer": "^3.4.0",
+    "@tanstack/react-query": "^5.25.0",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.0",
+    "date-fns": "^2.30.0",
+    "dayjs": "^1.11.10",
+    "dot-prop": "^8.0.2",
+    "i18next": "^23.10.0",
+    "i18next-browser-languagedetector": "^7.2.0",
+    "inversify": "^6.2.0",
+    "inversify-react": "^1.2.0",
+    "lodash": "^4.17.21",
+    "lz-string": "^1.5.0",
+    "query-string": "^8.2.0",
+    "react-i18next": "^13.5.0",
+    "react-pro-sidebar": "^1.1.0",
+    "react-router-dom": "^6.22.0",
+    "react-use": "^17.5.0",
+    "reflect-metadata": "^0.2.2",
+    "use-query-params": "^2.2.1",
+    "usehooks-ts": "^2.16.0",
+    "uuid": "^9.0.1",
+    "validator": "^13.11.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.0.4",
+    "@types/react-dom": "^19.0.2",
+    "@types/validator": "^13.15.10",
+    "@vitejs/plugin-react": "^4.3.4",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "typescript": "~5.7.2",
+    "vite": "^6.0.3",
+    "vite-plugin-external": "^6.2.2",
+    "vitest": "^2.1.8"
+  },
+  "scripts": {
+    "dev": "NODE_OPTIONS=\"--max-old-space-size=16384\" vite build --watch",
+    "build": "NODE_OPTIONS=\"--max-old-space-size=16384\" vite build && tsc --emitDeclarationOnly || true",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint . --max-warnings 0",
+    "clean": "rm -rf dist .turbo node_modules"
+  }
+}