vovk-ajv 0.0.0-beta.10

package/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2023-present Andrey Gubanov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+

package/README.md

@@ -0,0 +1,49 @@
+<p align="center">
+  <a href="https://vovk.dev">
+    <picture>
+      <source width="300" media="(prefers-color-scheme: dark)" srcset="https://vovk.dev/vovk-logo-white.svg">
+      <source width="300" media="(prefers-color-scheme: light)" srcset="https://vovk.dev/vovk-logo.svg">
+      <img width="300" alt="vovk" src="https://vovk.dev/vovk-logo.svg">
+    </picture>
+  </a>
+  <br>
+  <strong>Back-end Framework for Next.js App Router</strong>
+  <br />
+  <a href="https://vovk.dev/">Documentation</a>
+  &nbsp;&nbsp;
+  <a href="https://vovk.dev/quick-install">Quick Start</a>
+  &nbsp;&nbsp;
+  <a href="https://vovk.dev/performance">Performance</a>
+</p>
+
+---
+
+## vovk-ajv [![npm version](https://badge.fury.io/js/vovk-ajv.svg)](https://www.npmjs.com/package/vovk-ajv)
+
+[Ajv](https://ajv.js.org/) [client-side validation](https://vovk.dev/validation/client) for Vovk.ts. Exports `validateOnClient` function that can be injected into `createRPC` function at the generated RPC client by modifying [imports config](https://vovk.dev/imports#validateonclient).
+
+```sh
+npm install vovk-ajv
+```
+
+```ts
+/** @type {import('vovk').VovkConfig} */
+const config = {
+  outputConfig: {
+    imports: {
+      validateOnClient: 'vovk-ajv',
+    },
+  },
+  libs: {
+    /** @type {import('vovk-ajv').VovkAjvConfig} */
+    ajv: {
+      options: {
+        strict: false,
+      },
+      localize: 'de',
+    },
+  },
+};
+
+export default config;
+```

package/index.d.ts

@@ -0,0 +1,12 @@
+import { type Options } from 'ajv';
+import { type VovkValidateOnClient } from 'vovk/createValidateOnClient';
+type Lang = 'en' | 'ar' | 'ca' | 'cs' | 'de' | 'es' | 'fi' | 'fr' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'nb' | 'nl' | 'pl' | 'pt-BR' | 'ru' | 'sk' | 'sv' | 'th' | 'zh' | 'zh-TW';
+export type VovkAjvConfig = {
+    options?: Options;
+    localize?: Lang;
+    target?: 'draft-2020-12' | 'draft-07';
+};
+export declare const validateOnClient: VovkValidateOnClient<unknown> & {
+    configure: ({ options: givenOptions, localize: givenLocalize, target: givenTarget, }: VovkAjvConfig) => VovkValidateOnClient<unknown>;
+};
+export {};

package/index.js

@@ -0,0 +1,105 @@
+import { Ajv } from 'ajv';
+import _Ajv2020 from 'ajv/dist/2020.js';
+import _ajvFormats from 'ajv-formats';
+import _ajvLocalize from 'ajv-i18n';
+import _ajvErrors from 'ajv-errors';
+import { createValidateOnClient, HttpException, HttpStatus, } from 'vovk/createValidateOnClient';
+// Handle ESM/CJS interop - these packages export CJS and may have .default wrapper
+const Ajv2020 = (_Ajv2020.default ?? _Ajv2020);
+const ajvFormats = (_ajvFormats.default ?? _ajvFormats);
+const ajvErrors = (_ajvErrors.default ?? _ajvErrors);
+const ajvLocalize = (_ajvLocalize.default ??
+    _ajvLocalize);
+const createAjv = (options, target) => {
+    const AjvClass = target === 'draft-2020-12' ? Ajv2020 : Ajv;
+    const ajv = new AjvClass({ allErrors: true, ...options });
+    ajvFormats(ajv);
+    ajvErrors(ajv);
+    ajv.addKeyword('x-isForm');
+    ajv.addKeyword('x-tsType');
+    return ajv;
+};
+const validate = ({ input, schema, localize = 'en', type, endpoint, options, target, }) => {
+    if (input && schema) {
+        const schemaTarget = schema.$schema?.includes('://json-schema.org/draft-07/schema') ? 'draft-07' : 'draft-2020-12';
+        const ajv = createAjv(options ?? {}, target ?? schemaTarget);
+        const isFormData = input instanceof FormData;
+        if (input instanceof FormData) {
+            const formDataEntries = Array.from(input.entries());
+            const result = {};
+            formDataEntries.forEach(([key, value]) => {
+                // Process the value (handle Blobs/Files)
+                let processedValue;
+                if (value instanceof Blob) {
+                    processedValue = '<binary>';
+                }
+                else if (Array.isArray(value)) {
+                    processedValue = value.map((item) => (item instanceof Blob ? '<binary>' : item));
+                }
+                else {
+                    processedValue = value;
+                }
+                // Handle duplicate keys
+                if (key in result) {
+                    // If the key already exists
+                    if (Array.isArray(result[key])) {
+                        // If it's already an array, push to it
+                        result[key].push(processedValue);
+                    }
+                    else {
+                        // If it's not an array yet, convert it to an array with both values
+                        result[key] = [result[key], processedValue];
+                    }
+                }
+                else {
+                    // First occurrence of this key
+                    result[key] = processedValue;
+                }
+            });
+            input = result;
+        }
+        const isValid = ajv.validate(schema, input);
+        if (!isValid) {
+            ajvLocalize[localize](ajv.errors);
+            throw new HttpException(HttpStatus.NULL, `Client-side validation failed. Invalid ${isFormData ? 'form' : type} on client: ${ajv.errorsText()}`, { input, errors: ajv.errors, endpoint });
+        }
+    }
+};
+const getConfig = (schema) => {
+    const config = schema.meta?.config?.libs?.ajv;
+    const options = config?.options ?? {};
+    const localize = config?.localize ?? 'en';
+    const target = config?.target;
+    return { options, localize, target };
+};
+const validateOnClientAjv = createValidateOnClient({
+    validate: (input, schema, { endpoint, type, fullSchema }) => {
+        const { options, localize, target } = getConfig(fullSchema);
+        validate({
+            input,
+            schema,
+            target,
+            localize,
+            endpoint,
+            options,
+            type,
+        });
+    },
+});
+const configure = ({ options: givenOptions, localize: givenLocalize, target: givenTarget, }) => createValidateOnClient({
+    validate: (input, schema, { endpoint, type, fullSchema }) => {
+        const { options, localize, target } = getConfig(fullSchema);
+        validate({
+            input,
+            schema,
+            target: givenTarget ?? target,
+            localize: givenLocalize ?? localize,
+            endpoint,
+            options: givenOptions ?? options,
+            type,
+        });
+    },
+});
+export const validateOnClient = Object.assign(validateOnClientAjv, {
+    configure,
+});

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "vovk-ajv",
+  "version": "0.0.0-beta.10",
+  "description": "Client-side JSON Schema validation library for Vovk.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "default": "./index.js",
+      "types": "./index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "tsc": "tsc --noEmit",
+    "npm-publish": "npm publish",
+    "ncu": "npm-check-updates -u"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/finom/vovk.git"
+  },
+  "keywords": [
+    "vovk",
+    "json",
+    "ajv",
+    "validation"
+  ],
+  "author": "Andrey Gubanov",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/finom/vovk/issues"
+  },
+  "homepage": "https://vovk.dev/imports",
+  "peerDependencies": {
+    "vovk": "^3.0.0-beta.111"
+  },
+  "dependencies": {
+    "ajv": "^8.17.1",
+    "ajv-errors": "^3.0.0",
+    "ajv-formats": "^3.0.1",
+    "ajv-i18n": "^4.2.0"
+  }
+}