@jarenjs/refs 0.8.2 → 0.9.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Joham
+
+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

@@ -1,3 +1,21 @@
-# Jaren Schema References Package
+# @jarenjs/refs
 
-**this is a working package in need of documentation**
+The official JSON Schema meta-schemas for `draft-06`, `draft-07`, `draft 2019-09` and `draft 2020-12`, bundled for offline use with [Jaren](https://github.com/jklarenbeek/jarenjs).
+
+## Usage
+
+```javascript
+import { JarenValidator } from '@jarenjs/validate';
+import { getSchemaDraftByName, getSchemaDraftByVersion } from '@jarenjs/refs';
+
+const meta = getSchemaDraftByName('draft2020-12'); // or getSchemaDraftByVersion(2020)
+
+const jaren = new JarenValidator()
+  .addMetaSchema([...meta.schema], meta.draft);
+```
+
+`getSchemaDraftByVersion` accepts `6`, `7`, `2019` and `2020`; `getSchemaDraftByName` accepts the common spellings (`draft7`, `draft-07`, `2019-09`, `draft2020-12`, ...). Each returns `{ draft, schema }` where `schema` is the array of meta-schema documents for that draft (2019-09 and 2020-12 ship multiple vocabulary documents).
+
+The meta-schemas matter beyond `$ref` resolution: [`@jarenjs/validate`](../validate) uses them for draft detection, `$vocabulary`-aware keyword selection (including `format-assertion`), and cross-draft references — all offline, with no network fetches.
+
+See the repository [README](../../README.md) for full documentation and the [HOWTO](../../HOWTO.md) for multi-draft setups.

package/dist/types/index.d.ts

@@ -0,0 +1,44 @@
+export type SchemaDraftInfo = {
+    /**
+     * - The draft's canonical URI (e.g. 'http://json-schema.org/draft-07/schema')
+     */
+    draft: string;
+    /**
+     * - The meta-schema document(s) of the draft
+     */
+    schema: object[];
+};
+/**
+ * A JSON Schema draft specification bundle: the draft's canonical URI and
+ * the meta-schema document(s) that define it. For draft 2019-09 and
+ * 2020-12 the `schema` array holds the main meta-schema followed by its
+ * vocabulary meta-schemas; for draft-06/07 it holds the single meta-schema.
+ * @typedef {Object} SchemaDraftInfo
+ * @property {string} draft - The draft's canonical URI (e.g. 'http://json-schema.org/draft-07/schema')
+ * @property {object[]} schema - The meta-schema document(s) of the draft
+ */
+/**
+ * Gets a schema draft bundle by version number.
+ * @param {6 | 7 | 2019 | 2020} version - The draft version
+ * @returns {SchemaDraftInfo} The draft URI and its meta-schema document(s)
+ * @throws {Error} When the version is unknown
+ */
+export declare function getSchemaDraftByVersion(version: 6 | 7 | 2019 | 2020): SchemaDraftInfo;
+/**
+ * Gets a schema draft bundle by name. Accepts the common spellings of
+ * each draft name (e.g. 'draft-07', '2019-09', 'draft2020-12').
+ * @param {'6'|'draft6'|'draft-6'|'draft06'|'draft-06'
+ *   |'7'|'draft7'|'draft-7'|'draft07'|'draft-07'
+ *   |'draft2019'|'draft-2019'|'draft2019-09'|'2019'|'2019-09'
+ *   |'draft2020'|'draft-2020'|'draft2020-12'|'2020'|'2020-12'} name - The draft name variant
+ * @returns {SchemaDraftInfo} The draft URI and its meta-schema document(s)
+ * @throws {Error} When the name is unknown
+ */
+export declare function getSchemaDraftByName(name: '6' | 'draft6' | 'draft-6' | 'draft06' | 'draft-06' | '7' | 'draft7' | 'draft-7' | 'draft07' | 'draft-07' | 'draft2019' | 'draft-2019' | 'draft2019-09' | '2019' | '2019-09' | 'draft2020' | 'draft-2020' | 'draft2020-12' | '2020' | '2020-12'): SchemaDraftInfo;
+/**
+ * Gets a schema draft bundle by its canonical $id URI (case-insensitive).
+ * @param {string} schemaId - The schema $id URI
+ * @returns {SchemaDraftInfo} The draft URI and its meta-schema document(s)
+ * @throws {Error} When the schema id is not a string or not found
+ */
+export declare function getSchemaDraftById(schemaId: string): SchemaDraftInfo;

package/dist/types/index.import.no-lint.d.ts

@@ -0,0 +1,417 @@
+export declare const _draft6: {
+    $schema: string;
+    $id: string;
+    title: string;
+    definitions: {
+        schemaArray: {
+            type: string;
+            minItems: number;
+            items: {
+                $ref: string;
+            };
+        };
+        nonNegativeInteger: {
+            type: string;
+            minimum: number;
+        };
+        nonNegativeIntegerDefault0: {
+            allOf: ({
+                $ref: string;
+                default?: undefined;
+            } | {
+                default: number;
+                $ref?: undefined;
+            })[];
+        };
+        simpleTypes: {
+            enum: string[];
+        };
+        stringArray: {
+            type: string;
+            items: {
+                type: string;
+            };
+            uniqueItems: boolean;
+            default: never[];
+        };
+    };
+    type: string[];
+    properties: {
+        $id: {
+            type: string;
+            format: string;
+        };
+        $schema: {
+            type: string;
+            format: string;
+        };
+        $ref: {
+            type: string;
+            format: string;
+        };
+        title: {
+            type: string;
+        };
+        description: {
+            type: string;
+        };
+        default: {};
+        examples: {
+            type: string;
+            items: {};
+        };
+        multipleOf: {
+            type: string;
+            exclusiveMinimum: number;
+        };
+        maximum: {
+            type: string;
+        };
+        exclusiveMaximum: {
+            type: string;
+        };
+        minimum: {
+            type: string;
+        };
+        exclusiveMinimum: {
+            type: string;
+        };
+        maxLength: {
+            $ref: string;
+        };
+        minLength: {
+            $ref: string;
+        };
+        pattern: {
+            type: string;
+            format: string;
+        };
+        additionalItems: {
+            $ref: string;
+        };
+        items: {
+            anyOf: {
+                $ref: string;
+            }[];
+            default: {};
+        };
+        maxItems: {
+            $ref: string;
+        };
+        minItems: {
+            $ref: string;
+        };
+        uniqueItems: {
+            type: string;
+            default: boolean;
+        };
+        contains: {
+            $ref: string;
+        };
+        maxProperties: {
+            $ref: string;
+        };
+        minProperties: {
+            $ref: string;
+        };
+        required: {
+            $ref: string;
+        };
+        additionalProperties: {
+            $ref: string;
+        };
+        definitions: {
+            type: string;
+            additionalProperties: {
+                $ref: string;
+            };
+            default: {};
+        };
+        properties: {
+            type: string;
+            additionalProperties: {
+                $ref: string;
+            };
+            default: {};
+        };
+        patternProperties: {
+            type: string;
+            additionalProperties: {
+                $ref: string;
+            };
+            default: {};
+        };
+        dependencies: {
+            type: string;
+            additionalProperties: {
+                anyOf: {
+                    $ref: string;
+                }[];
+            };
+        };
+        propertyNames: {
+            $ref: string;
+        };
+        const: {};
+        enum: {
+            type: string;
+            minItems: number;
+            uniqueItems: boolean;
+        };
+        type: {
+            anyOf: ({
+                $ref: string;
+                type?: undefined;
+                items?: undefined;
+                minItems?: undefined;
+                uniqueItems?: undefined;
+            } | {
+                type: string;
+                items: {
+                    $ref: string;
+                };
+                minItems: number;
+                uniqueItems: boolean;
+                $ref?: undefined;
+            })[];
+        };
+        format: {
+            type: string;
+        };
+        allOf: {
+            $ref: string;
+        };
+        anyOf: {
+            $ref: string;
+        };
+        oneOf: {
+            $ref: string;
+        };
+        not: {
+            $ref: string;
+        };
+    };
+    default: {};
+};
+export declare const _draft7: {
+    $schema: string;
+    $id: string;
+    title: string;
+    definitions: {
+        schemaArray: {
+            type: string;
+            minItems: number;
+            items: {
+                $ref: string;
+            };
+        };
+        nonNegativeInteger: {
+            type: string;
+            minimum: number;
+        };
+        nonNegativeIntegerDefault0: {
+            allOf: ({
+                default?: undefined;
+                $ref: string;
+            } | {
+                default: number;
+                $ref?: undefined;
+            })[];
+        };
+        simpleTypes: {
+            enum: string[];
+        };
+        stringArray: {
+            type: string;
+            items: {
+                type: string;
+            };
+            uniqueItems: boolean;
+            default: never[];
+        };
+    };
+    type: string[];
+    properties: {
+        $id: {
+            type: string;
+            format: string;
+            pattern: string;
+        };
+        $schema: {
+            type: string;
+            format: string;
+        };
+        $ref: {
+            type: string;
+            format: string;
+        };
+        $comment: {
+            type: string;
+        };
+        title: {
+            type: string;
+        };
+        description: {
+            type: string;
+        };
+        default: boolean;
+        readOnly: {
+            type: string;
+            default: boolean;
+        };
+        examples: {
+            type: string;
+            items: boolean;
+        };
+        multipleOf: {
+            type: string;
+            exclusiveMinimum: number;
+        };
+        maximum: {
+            type: string;
+        };
+        exclusiveMaximum: {
+            type: string;
+        };
+        minimum: {
+            type: string;
+        };
+        exclusiveMinimum: {
+            type: string;
+        };
+        maxLength: {
+            $ref: string;
+        };
+        minLength: {
+            $ref: string;
+        };
+        pattern: {
+            type: string;
+            format: string;
+        };
+        additionalItems: {
+            $ref: string;
+        };
+        items: {
+            anyOf: {
+                $ref: string;
+            }[];
+            default: boolean;
+        };
+        maxItems: {
+            $ref: string;
+        };
+        minItems: {
+            $ref: string;
+        };
+        uniqueItems: {
+            type: string;
+            default: boolean;
+        };
+        contains: {
+            $ref: string;
+        };
+        maxProperties: {
+            $ref: string;
+        };
+        minProperties: {
+            $ref: string;
+        };
+        required: {
+            $ref: string;
+        };
+        additionalProperties: {
+            $ref: string;
+        };
+        definitions: {
+            type: string;
+            additionalProperties: {
+                $ref: string;
+            };
+            default: {};
+        };
+        properties: {
+            type: string;
+            additionalProperties: {
+                $ref: string;
+            };
+            default: {};
+        };
+        patternProperties: {
+            type: string;
+            additionalProperties: {
+                $ref: string;
+            };
+            propertyNames: {
+                format: string;
+            };
+            default: {};
+        };
+        dependencies: {
+            type: string;
+            additionalProperties: {
+                anyOf: {
+                    $ref: string;
+                }[];
+            };
+        };
+        propertyNames: {
+            $ref: string;
+        };
+        const: boolean;
+        enum: {
+            type: string;
+            items: boolean;
+            minItems: number;
+            uniqueItems: boolean;
+        };
+        type: {
+            anyOf: ({
+                $ref: string;
+                type?: undefined;
+                items?: undefined;
+                minItems?: undefined;
+                uniqueItems?: undefined;
+            } | {
+                type: string;
+                items: {
+                    $ref: string;
+                };
+                minItems: number;
+                uniqueItems: boolean;
+                $ref?: undefined;
+            })[];
+        };
+        format: {
+            type: string;
+        };
+        contentMediaType: {
+            type: string;
+        };
+        contentEncoding: {
+            type: string;
+        };
+        if: {
+            $ref: string;
+        };
+        then: {
+            $ref: string;
+        };
+        else: {
+            $ref: string;
+        };
+        allOf: {
+            $ref: string;
+        };
+        anyOf: {
+            $ref: string;
+        };
+        oneOf: {
+            $ref: string;
+        };
+        not: {
+            $ref: string;
+        };
+    };
+    default: boolean;
+};