@jarenjs/formats 0.8.4 → 0.34.0

package/dist/types/string.d.ts

@@ -0,0 +1,355 @@
+export type JSONSchema = {
+    format?: string;
+    formatMinimum?: string;
+    formatExclusiveMinimum?: string;
+    formatMaximum?: string;
+    formatExclusiveMaximum?: string;
+};
+export type ValidationObject = {
+    options: {
+        skipErrors: boolean;
+    };
+    createErrorHandler: (expected: any, key: string, ...details: any[]) => (data: any, dataPath?: string) => boolean;
+};
+/**
+ * @typedef {{format?: string, formatMinimum?: string, formatExclusiveMinimum?: string, formatMaximum?: string, formatExclusiveMaximum?: string}} JSONSchema
+ * @typedef {{
+ *   options: {skipErrors: boolean},
+ *   createErrorHandler: (expected: any, key: string, ...details: any[]) => (data: any, dataPath?: string) => boolean
+ * }} ValidationObject
+ */
+/**
+ * Creates a string format compiler function.
+ *
+ * @param {string} formatName - The name of the format (e.g., 'email', 'uri')
+ * @param {(value: string) => boolean} isFormatTest - The function to test if a string matches the format
+ * @returns {(schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean} A compiler function that creates format validators
+ * @example
+ * const compiler = createStringFormatCompiler('email', isValidEmail);
+ * const validator = compiler(schemaObj, { format: 'email' });
+ * validator('user@example.com'); // true
+ */
+export declare function createStringFormatCompiler(formatName: string, isFormatTest: (value: string) => boolean): (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'alpha' format.
+ * Validates strings containing only alphabetic characters (a-z, A-Z).
+ *
+ * @param {ValidationObject} schemaObj - The validation object for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ * @example
+ * compileAlphaFormat(schemaObj, { format: 'alpha' })('HelloWorld'); // true
+ * compileAlphaFormat(schemaObj, { format: 'alpha' })('Hello123'); // false (with error)
+ */
+export declare const compileAlphaFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'alphanumeric' format.
+ * Validates strings containing only alphabetic characters and digits (a-z, A-Z, 0-9).
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ * @example
+ * compileAlphaNumericFormat(schemaObj, { format: 'alphanumeric' })('Hello123'); // true
+ */
+export declare const compileAlphaNumericFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'uppercase' format.
+ * Validates strings containing only uppercase characters.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileUppercaseFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'lowercase' format.
+ * Validates strings containing only lowercase characters.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileLowercaseFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'identifier' format.
+ * Validates general identifier strings (variable names, etc.).
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileIdentifierFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'html-identifier' format.
+ * Validates HTML element and attribute identifiers.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileHtmlIdentifierFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'css-identifier' format.
+ * Validates CSS class and ID selectors.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileCssIdentifierFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'hexadecimal' format.
+ * Validates hexadecimal number strings (0-9, a-f, A-F).
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileHexadecimalFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'numeric' format.
+ * Validates numeric strings containing only digits.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileNumericFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'color' format.
+ * Validates hexadecimal color codes (e.g., #FFF, #FFFFFF).
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileColorFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'regex' format.
+ * Validates that a string is a valid regular expression pattern.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileRegexFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'iregexp' format.
+ * Validates that a string is a valid I-Regexp (RFC 9485) pattern - the
+ * interoperable subset that carries the same meaning across regexp
+ * dialects. Stricter than 'regex': shorthand classes (\d, \w), lazy
+ * quantifiers, anchors and lookaround are all rejected.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileIRegexpFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'uri' format.
+ * Validates absolute URI strings per RFC 3986.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ * @example
+ * compileUriFormat(schemaObj, { format: 'uri' })('https://example.com'); // true
+ */
+export declare const compileUriFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'uri-reference' format.
+ * Validates URI reference strings (absolute or relative) per RFC 3986.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileUriReferenceFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'uri-template' format.
+ * Validates URI template strings per RFC 6570.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileUriTemplateFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'url' format.
+ * Validates URL strings per the WHATWG URL Standard.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileUrlFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'iri' format.
+ * Validates IRI strings per RFC 3987.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileIriFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'iri-reference' format.
+ * Validates IRI reference strings (absolute or relative) per RFC 3987.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileIriReferenceFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'email' format.
+ * Validates email address strings per RFC 5321.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ * @example
+ * compileEmailFormat(schemaObj, { format: 'email' })('user@example.com'); // true
+ */
+export declare const compileEmailFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'idn-email' format.
+ * Validates internationalized email addresses (EAI) per RFC 6531.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileIdnEmailFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'hostname' format.
+ * Validates hostname strings per RFC 1123.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileHostnameFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'idn-hostname' format.
+ * Validates internationalized domain names (IDN) per RFC 5890.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileIdnHostnameFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'ipv4' format.
+ * Validates IPv4 address strings.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ * @example
+ * compileIpv4Format(schemaObj, { format: 'ipv4' })('192.168.1.1'); // true
+ */
+export declare const compileIpv4Format: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'ipv6' format.
+ * Validates IPv6 address strings.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileIpv6Format: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'uuid' format.
+ * Validates UUID strings per RFC 4122.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ * @example
+ * compileUuidFormat(schemaObj, { format: 'uuid' })('550e8400-e29b-41d4-a716-446655440000'); // true
+ */
+export declare const compileUuidFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'guid' format.
+ * Validates GUID strings (Microsoft format).
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileGuidFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'isbn10' format.
+ * Validates ISBN-10 identifier strings.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileIsbn10Format: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'isbn13' format.
+ * Validates ISBN-13 identifier strings.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileIsbn13Format: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'mac' format.
+ * Validates MAC address strings.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileMacFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'base64' format.
+ * Validates Base64 encoded strings.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileBase64Format: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'byte' format.
+ * Alias for 'base64' format.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileByteFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'country2' format.
+ * Validates ISO 3166-1 alpha-2 country codes.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ * @example
+ * compileCountry2Format(schemaObj, { format: 'country2' })('US'); // true
+ * compileCountry2Format(schemaObj, { format: 'country2' })('XX'); // false (with error)
+ */
+export declare const compileCountry2Format: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Compiles a validator for the 'iban' format.
+ * Validates IBAN (International Bank Account Number) strings.
+ *
+ * @param {ValidationObject} schemaObj - The validation JSONSchema for error handling and options
+ * @param {JSONSchema} jsonSchema - The JSON schema containing the format definition
+ * @returns {(data: unknown, dataPath?: string) => boolean} A validator function
+ */
+export declare const compileIbanFormat: (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean;
+/**
+ * Object mapping format names to their compiler functions.
+ * Used for backward compatibility and aggregate imports.
+ *
+ * @type {Record<string, (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean>}
+ */
+export declare const formatValidators: Record<string, (schemaObj: ValidationObject, jsonSchema: JSONSchema) => (data: unknown, dataPath?: string) => boolean>;

package/dist/types/testers.d.ts

@@ -0,0 +1,39 @@
+export type StringFormatTester = (value: string) => boolean;
+export type NumberFormatTester = (value: number) => boolean;
+/** @typedef {(value: string) => boolean} StringFormatTester */
+/** @typedef {(value: number) => boolean} NumberFormatTester */
+/**
+ * String format testers (the string.js compiler group).
+ * @type {Record<string, StringFormatTester>}
+ */
+export declare const stringFormatTesters: Record<string, StringFormatTester>;
+/**
+ * JSON addressing format testers (the json.js compiler group).
+ * @type {Record<string, StringFormatTester>}
+ */
+export declare const jsonFormatTesters: Record<string, StringFormatTester>;
+/**
+ * Date and time format testers - the boolean twins of the parse-based
+ * compilers in datetime.js.
+ * @type {Record<string, StringFormatTester>}
+ */
+export declare const dateTimeFormatTesters: Record<string, StringFormatTester>;
+/**
+ * Geospatial format testers (the geo.js compiler group). `geohash` and
+ * `wkt` take strings; `geojson` takes the OBJECT value — the quick
+ * yes-or-no twin of the GeoJSON meta-schema artifacts in `@jarenjs/json`,
+ * including the ring-closure invariant JSON Schema cannot express.
+ * @type {Record<string, (value: any) => boolean>}
+ */
+export declare const geoFormatTesters: Record<string, (value: any) => boolean>;
+/**
+ * Number format testers (the number.js compiler group). These take the
+ * NUMBER value, not a string.
+ * @type {Record<string, NumberFormatTester>}
+ */
+export declare const numberFormatTesters: Record<string, NumberFormatTester>;
+/**
+ * Every format tester this package knows, in one flat registry.
+ * @type {Record<string, (value: any) => boolean>}
+ */
+export declare const formatTesters: Record<string, (value: any) => boolean>;

package/package.json

@@ -1,29 +1,49 @@
 {
   "name": "@jarenjs/formats",
   "private": false,
-  "version": "0.8.4",
+  "version": "0.34.0",
   "type": "module",
-  "main": "./dist/index.js",
+  "main": "./src/index.js",
+  "types": "./dist/types/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "default": "./src/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "files": [
-    "dist"
+    "dist/types/",
+    "src/"
   ],
   "description": "Jaren Formats for JSON Schema Validation",
   "author": "joham",
   "repository": {
     "type": "git",
-    "url": "https://github.com/jklarenbeek/jarenjs.git",
+    "url": "git+https://github.com/jklarenbeek/jarenjs.git",
     "directory": "packages/formats"
   },
   "license": "MIT",
+  "engines": {
+    "node": ">=24"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
   "keywords": [
     "jaren",
-    "json schema",
+    "json-schema",
     "formats"
   ],
   "scripts": {
-    "build": "node esbuild.config.js"
+    "build": "node esbuild.config.js && npm run build:types",
+    "build:types": "tsc -p tsconfig.json",
+    "prepack": "npm run build:types"
   },
-  "devDependencies": {
-    "esbuild": "^0.23.1"
+  "dependencies": {
+    "@jarenjs/core": "^0.34.0",
+    "@jarenjs/json": "^0.34.0"
   }
 }