@speclynx/apidom-ns-json-schema-draft-6 1.12.2 → 2.1.0

package/types/apidom-ns-json-schema-draft-6.d.ts

@@ -4,38 +4,23 @@ import { AlternatingVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { AlternatingVisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { AnyOfVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { AnyOfVisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-4';
-import { ArrayElement } from '@speclynx/apidom-core';
-import { Attributes } from '@speclynx/apidom-core';
-import { BooleanElement } from '@speclynx/apidom-core';
+import { ArrayElement } from '@speclynx/apidom-datamodel';
+import { Attributes } from '@speclynx/apidom-datamodel';
+import { BooleanElement } from '@speclynx/apidom-datamodel';
 import { DefinitionsVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { DefinitionsVisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { DependenciesVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { DependenciesVisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-4';
-import { Element as Element_2 } from '@speclynx/apidom-core';
-import { ElementPredicate } from '@speclynx/apidom-core';
-import { EnumVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
+import { Element as Element_2 } from '@speclynx/apidom-datamodel';
 import { FallbackVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { FallbackVisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { FixedFieldsVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { FixedFieldsVisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-4';
-import { getNodeType } from '@speclynx/apidom-ns-json-schema-draft-4';
-import { isArrayElement } from '@speclynx/apidom-core';
-import { isBooleanElement } from '@speclynx/apidom-core';
-import { isElement } from '@speclynx/apidom-core';
 import { isJSONReferenceElement } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { isJSONReferenceLikeElement } from '@speclynx/apidom-ns-json-schema-draft-4';
-import { isLinkElement } from '@speclynx/apidom-core';
 import { isMediaElement } from '@speclynx/apidom-ns-json-schema-draft-4';
-import { isMemberElement } from '@speclynx/apidom-core';
-import { isNullElement } from '@speclynx/apidom-core';
-import { isNumberElement } from '@speclynx/apidom-core';
-import { isObjectElement } from '@speclynx/apidom-core';
-import { isRefElement } from '@speclynx/apidom-core';
-import { isStringElement } from '@speclynx/apidom-core';
 import { ItemsVisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-4';
-import { JSONReference$RefVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { JSONReferenceElement } from '@speclynx/apidom-ns-json-schema-draft-4';
-import { JSONReferenceVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { ItemsVisitor as JSONSchemaDraft4ItemsVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { JSONSchemaElement as JSONSchemaElement_2 } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { JSONSchemaVisitor as JSONSchemaVisitor_2 } from '@speclynx/apidom-ns-json-schema-draft-4';
@@ -43,36 +28,33 @@ import { JSONSchemaVisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-
 import { LinkDescriptionElement as LinkDescriptionElement_2 } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { LinkDescriptionVisitor as LinkDescriptionVisitor_2 } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { LinkDescriptionVisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-4';
-import { LinksVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { MapVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { MapVisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { MediaElement } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { MediaTypes } from '@speclynx/apidom-core';
-import { MediaVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
-import { Meta } from '@speclynx/apidom-core';
-import { Namespace } from 'minim';
-import { NamespacePluginOptions } from '@speclynx/apidom-core';
-import { NumberElement } from '@speclynx/apidom-core';
-import { ObjectElement } from '@speclynx/apidom-core';
+import { Meta } from '@speclynx/apidom-datamodel';
+import { Namespace } from '@speclynx/apidom-datamodel';
+import { NamespacePlugin } from '@speclynx/apidom-datamodel';
+import { NumberElement } from '@speclynx/apidom-datamodel';
+import { ObjectElement } from '@speclynx/apidom-datamodel';
 import { OneOfVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { OneOfVisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { ParentSchemaAwareVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { ParentSchemaAwareVisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-4';
+import { Path } from '@speclynx/apidom-traverse';
 import { PatternedFieldsVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { PatternedFieldsVisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { PatternPropertiesVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { PatternPropertiesVisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { PropertiesVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { PropertiesVisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-4';
-import { RequiredVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { SchemaOrReferenceVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { SchemaOrReferenceVisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { specificationObj as specificationObj_2 } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { SpecificationVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { SpecificationVisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { SpecPath } from '@speclynx/apidom-ns-json-schema-draft-4';
-import { StringElement } from '@speclynx/apidom-core';
-import { TypeVisitor } from '@speclynx/apidom-ns-json-schema-draft-4';
+import { StringElement } from '@speclynx/apidom-datamodel';
 import { Visitor } from '@speclynx/apidom-ns-json-schema-draft-4';
 import { VisitorOptions } from '@speclynx/apidom-ns-json-schema-draft-4';
 
@@ -88,11 +70,6 @@ export { AnyOfVisitor }
 
 export { AnyOfVisitorOptions }
 
-/**
- * @public
- */
-export declare const createRefractor: (specPath: string[]) => (value: unknown, options?: {}) => Element_2;
-
 export { DefinitionsVisitor }
 
 export { DefinitionsVisitorOptions }
@@ -105,8 +82,9 @@ export { DependenciesVisitorOptions }
  * @public
  */
 export declare class ExamplesVisitor extends FallbackVisitor {
+    // @ts-ignore
     readonly element: ArrayElement;
-    ArrayElement(arrayElement: ArrayElement): {};
+    ArrayElement(path: Path<ArrayElement>): void;
 }
 
 export { FallbackVisitor }
@@ -114,6 +92,15 @@ export { FallbackVisitor }
 export { FallbackVisitorOptions as ExamplesVisitorOptions }
 export { FallbackVisitorOptions }
 
+/**
+ * @public
+ */
+export declare interface FixedField {
+    name: string;
+    alias?: string;
+    $visitor: unknown;
+}
+
 export { FixedFieldsVisitor }
 
 export { FixedFieldsVisitorOptions }
@@ -123,14 +110,6 @@ export { FixedFieldsVisitorOptions }
  */
 export declare type Format = 'generic' | 'json' | 'yaml';
 
-export { getNodeType }
-
-export { isArrayElement }
-
-export { isBooleanElement }
-
-export { isElement }
-
 export { isJSONReferenceElement }
 
 export { isJSONReferenceLikeElement }
@@ -138,34 +117,20 @@ export { isJSONReferenceLikeElement }
 /**
  * @public
  */
-export declare const isJSONSchemaElement: ElementPredicate<JSONSchemaElement>;
+export declare const isJSONSchemaElement: (element: unknown) => element is JSONSchemaElement;
 
 /**
  * @public
  */
-export declare const isLinkDescriptionElement: ElementPredicate<LinkDescriptionElement>;
-
-export { isLinkElement }
+export declare const isLinkDescriptionElement: (element: unknown) => element is LinkDescriptionElement;
 
 export { isMediaElement }
 
-export { isMemberElement }
-
-export { isNullElement }
-
-export { isNumberElement }
-
-export { isObjectElement }
-
-export { isRefElement }
-
-export { isStringElement }
-
 /**
  * @public
  */
 export declare class ItemsVisitor extends JSONSchemaDraft4ItemsVisitor {
-    BooleanElement(booleanElement: BooleanElement): {};
+    BooleanElement(path: Path<BooleanElement>): void;
 }
 
 export { ItemsVisitorOptions }
@@ -177,9 +142,7 @@ export { JSONSchemaDraft4ItemsVisitor }
 /**
  * @public
  */
-declare const jsonSchemaDraft6: {
-    namespace: (options: NamespacePluginOptions) => Namespace;
-};
+declare const jsonSchemaDraft6: NamespacePlugin;
 export default jsonSchemaDraft6;
 
 /**
@@ -201,8 +164,8 @@ export declare class JSONSchemaElement extends JSONSchemaElement_2 {
      *
      * URI: https://datatracker.ietf.org/doc/html/draft-wright-json-schema-01
      */
-    get idProp(): StringElement | undefined;
-    set idProp(id: StringElement | undefined);
+    get idField(): StringElement | undefined;
+    set idField(id: StringElement | undefined);
     get $id(): StringElement | undefined;
     set $id($id: StringElement | undefined);
     /**
@@ -220,10 +183,12 @@ export declare class JSONSchemaElement extends JSONSchemaElement_2 {
     /**
      * Validation keywords for arrays
      */
-    get containsProp(): this | BooleanElement | JSONReferenceElement | undefined;
-    set containsProp(contains: this | BooleanElement | JSONReferenceElement | undefined);
-    get items(): this | BooleanElement | JSONReferenceElement | ArrayElement | undefined | any;
-    set items(items: this | BooleanElement | JSONReferenceElement | ArrayElement | undefined | any);
+    get containsField(): this | BooleanElement | JSONReferenceElement | undefined;
+    set containsField(contains: this | BooleanElement | JSONReferenceElement | undefined);
+    // @ts-ignore
+    get itemsField(): this | BooleanElement | JSONReferenceElement | ArrayElement<this | BooleanElement | JSONReferenceElement> | undefined;
+    // @ts-ignore
+    set itemsField(items: this | BooleanElement | JSONReferenceElement | ArrayElement<this | BooleanElement | JSONReferenceElement> | undefined);
     /**
      * Validation keywords for objects
      */
@@ -234,53 +199,33 @@ export declare class JSONSchemaElement extends JSONSchemaElement_2 {
      */
     get const(): Element_2 | undefined;
     set const(constValue: Element_2 | undefined);
-    get not(): this | BooleanElement | JSONReferenceElement | undefined | any;
-    set not(not: this | BooleanElement | JSONReferenceElement | undefined | any);
+    // @ts-ignore
+    get not(): this | BooleanElement | JSONReferenceElement | undefined;
+    // @ts-ignore
+    set not(not: this | BooleanElement | JSONReferenceElement | undefined);
     /**
      * Metadata keywords
      *
      * URI: https://datatracker.ietf.org/doc/html/draft-wright-json-schema-validation-01#section-7
      */
-    get examples(): ArrayElement | undefined;
-    set examples(examples: ArrayElement | undefined);
+    get examples(): ArrayElement<Element_2> | undefined;
+    set examples(examples: ArrayElement<Element_2> | undefined);
 }
 
 /**
  * @public
  */
 export declare class JSONSchemaVisitor extends JSONSchemaVisitor_2 {
-    element: JSONSchemaElement;
+    // @ts-ignore
+    element: JSONSchemaElement | BooleanElement;
     constructor(options: JSONSchemaVisitorOptions);
     get defaultDialectIdentifier(): string;
-    BooleanElement(booleanElement: BooleanElement): {};
+    BooleanElement(path: Path<BooleanElement>): void;
     handleSchemaIdentifier(objectElement: ObjectElement, identifierKeyword?: string): void;
 }
 
 export { JSONSchemaVisitorOptions }
 
-/**
- * @public
- */
-export declare const keyMap: {
-    ObjectElement: string[];
-    ArrayElement: string[];
-    MemberElement: string[];
-    StringElement: never[];
-    BooleanElement: never[];
-    NumberElement: never[];
-    NullElement: never[];
-    RefElement: never[];
-    LinkElement: never[];
-    Annotation: never[];
-    Comment: never[];
-    ParseResultElement: string[];
-    SourceMap: string[];
-    JSONSchemaDraft6Element: string[];
-    JSONReferenceElement: string[];
-    MediaElement: string[];
-    LinkDescriptionElement: string[];
-};
-
 /**
  * URI: https://datatracker.ietf.org/doc/html/draft-wright-json-schema-hyperschema-01#section-6
  * @public
@@ -288,10 +233,12 @@ export declare const keyMap: {
 export declare class LinkDescriptionElement extends LinkDescriptionElement_2 {
     get hrefSchema(): JSONSchemaElement | BooleanElement | JSONReferenceElement | undefined;
     set hrefSchema(hrefSchema: JSONSchemaElement | BooleanElement | JSONReferenceElement | undefined);
-    get targetSchema(): JSONSchemaElement | BooleanElement | JSONReferenceElement | undefined | any;
-    set targetSchema(targetSchema: JSONSchemaElement | BooleanElement | JSONReferenceElement | undefined | any);
-    get schema(): JSONSchemaElement | JSONReferenceElement | undefined;
-    set schema(schema: JSONSchemaElement | JSONReferenceElement | undefined);
+    // @ts-ignore
+    get targetSchema(): JSONSchemaElement | BooleanElement | JSONReferenceElement | undefined;
+    // @ts-ignore
+    set targetSchema(targetSchema: JSONSchemaElement | BooleanElement | JSONReferenceElement | undefined);
+    get schema(): JSONSchemaElement_2 | JSONReferenceElement | undefined;
+    set schema(schema: JSONSchemaElement_2 | JSONReferenceElement | undefined);
     get submissionSchema(): JSONSchemaElement | BooleanElement | JSONReferenceElement | undefined;
     set submissionSchema(submissionSchema: JSONSchemaElement | BooleanElement | JSONReferenceElement | undefined);
     get method(): StringElement | undefined;
@@ -306,6 +253,7 @@ export declare class LinkDescriptionElement extends LinkDescriptionElement_2 {
  * @public
  */
 export declare class LinkDescriptionVisitor extends LinkDescriptionVisitor_2 {
+    // @ts-ignore
     readonly element: LinkDescriptionElement;
     constructor(options: LinkDescriptionVisitorOptions);
 }
@@ -346,155 +294,44 @@ export { PropertiesVisitorOptions }
 /**
  * @public
  */
-export declare const refract: <T extends Element_2>(value: unknown, { specPath, plugins, specificationObj, }?: {
-    specPath?: string[] | undefined;
-    plugins?: never[] | undefined;
-    specificationObj?: {
-        visitors: {
-            value: FallbackVisitor;
-            JSONSchemaOrJSONReferenceVisitor: SchemaOrReferenceVisitor;
-            document: {
-                objects: {
-                    JSONSchema: {
-                        $visitor: JSONSchemaVisitor_2;
-                        fixedFields: {
-                            id: {
-                                $ref: string;
-                            };
-                            $schema: {
-                                $ref: string;
-                            };
-                            multipleOf: {
-                                $ref: string;
-                            };
-                            maximum: {
-                                $ref: string;
-                            };
-                            exclusiveMaximum: {
-                                $ref: string;
-                            };
-                            minimum: {
-                                $ref: string;
-                            };
-                            exclusiveMinimum: {
-                                $ref: string;
-                            };
-                            maxLength: {
-                                $ref: string;
-                            };
-                            minLength: {
-                                $ref: string;
-                            };
-                            pattern: {
-                                $ref: string;
-                            };
-                            additionalItems: SchemaOrReferenceVisitor;
-                            items: JSONSchemaDraft4ItemsVisitor;
-                            maxItems: {
-                                $ref: string;
-                            };
-                            minItems: {
-                                $ref: string;
-                            };
-                            uniqueItems: {
-                                $ref: string;
-                            };
-                            maxProperties: {
-                                $ref: string;
-                            };
-                            minProperties: {
-                                $ref: string;
-                            };
-                            required: RequiredVisitor;
-                            properties: PropertiesVisitor;
-                            additionalProperties: SchemaOrReferenceVisitor;
-                            patternProperties: PatternPropertiesVisitor;
-                            dependencies: DependenciesVisitor;
-                            enum: EnumVisitor;
-                            type: TypeVisitor;
-                            allOf: AllOfVisitor;
-                            anyOf: AnyOfVisitor;
-                            oneOf: OneOfVisitor;
-                            not: SchemaOrReferenceVisitor;
-                            definitions: DefinitionsVisitor;
-                            title: {
-                                $ref: string;
-                            };
-                            description: {
-                                $ref: string;
-                            };
-                            default: {
-                                $ref: string;
-                            };
-                            format: {
-                                $ref: string;
-                            };
-                            base: {
-                                $ref: string;
-                            };
-                            links: LinksVisitor;
-                            media: {
-                                $ref: string;
-                            };
-                            readOnly: {
-                                $ref: string;
-                            };
-                        };
-                    };
-                    JSONReference: {
-                        $visitor: JSONReferenceVisitor;
-                        fixedFields: {
-                            $ref: JSONReference$RefVisitor;
-                        };
-                    };
-                    Media: {
-                        $visitor: MediaVisitor;
-                        fixedFields: {
-                            binaryEncoding: {
-                                $ref: string;
-                            };
-                            type: {
-                                $ref: string;
-                            };
-                        };
-                    };
-                    LinkDescription: {
-                        $visitor: LinkDescriptionVisitor_2;
-                        fixedFields: {
-                            href: {
-                                $ref: string;
-                            };
-                            rel: {
-                                $ref: string;
-                            };
-                            title: {
-                                $ref: string;
-                            };
-                            targetSchema: SchemaOrReferenceVisitor;
-                            mediaType: {
-                                $ref: string;
-                            };
-                            method: {
-                                $ref: string;
-                            };
-                            encType: {
-                                $ref: string;
-                            };
-                            schema: SchemaOrReferenceVisitor;
-                        };
-                    };
-                };
-            };
-        };
-    } | undefined;
-}) => T;
+export declare const refract: <T extends Element_2>(value: unknown, { element, plugins, specificationObj, }?: RefractorOptions) => T;
+
+/**
+ * Refracts a value into a JSONSchemaElement.
+ * @public
+ */
+export declare const refractJSONSchema: <T extends Element_2 = JSONSchemaElement>(value: unknown, options?: Omit<RefractorOptions, "element">) => T;
+
+/**
+ * Refracts a value into a LinkDescriptionElement.
+ * @public
+ */
+export declare const refractLinkDescription: <T extends Element_2 = LinkDescriptionElement>(value: unknown, options?: Omit<RefractorOptions, "element">) => T;
+
+/**
+ * @public
+ */
+export declare interface RefractorOptions {
+    readonly element?: string;
+    readonly plugins?: RefractorPlugin[];
+    readonly specificationObj?: typeof specificationObj;
+}
+
+/**
+ * @public
+ */
+export declare type RefractorPlugin = (toolbox: Toolbox) => {
+    visitor?: object;
+    pre?: () => void;
+    post?: () => void;
+};
 
 /**
  * @public
  */
 export declare const refractorPluginReplaceEmptyElement: () => () => {
     visitor: {
-        StringElement(element: StringElement, key: any, parent: any, path: any, ancestors: any[]): any;
+        StringElement(path: Path<StringElement>): void;
     };
 };
 
@@ -510,6 +347,14 @@ export { SpecificationVisitorOptions }
 
 export { SpecPath }
 
+/**
+ * @public
+ */
+export declare interface Toolbox {
+    predicates: Record<string, (...args: any[]) => boolean>;
+    namespace: Namespace;
+}
+
 export { Visitor }
 
 export { VisitorOptions }

package/src/refractor/registration.cjs

@@ -1,13 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-var _JSONSchema = _interopRequireDefault(require("../elements/JSONSchema.cjs"));
-exports.JSONSchemaElement = _JSONSchema.default;
-var _LinkDescription = _interopRequireDefault(require("../elements/LinkDescription.cjs"));
-exports.LinkDescriptionElement = _LinkDescription.default;
-var _index = require("./index.cjs");
-// register refractors specific to element types
-
-_JSONSchema.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'JSONSchema', '$visitor']);
-_LinkDescription.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'LinkDescription', '$visitor']);

package/src/refractor/registration.mjs

@@ -1,6 +0,0 @@
-import JSONSchemaElement from "../elements/JSONSchema.mjs";
-import LinkDescriptionElement from "../elements/LinkDescription.mjs";
-import { createRefractor } from "./index.mjs"; // register refractors specific to element types
-JSONSchemaElement.refract = createRefractor(['visitors', 'document', 'objects', 'JSONSchema', '$visitor']);
-LinkDescriptionElement.refract = createRefractor(['visitors', 'document', 'objects', 'LinkDescription', '$visitor']);
-export { JSONSchemaElement, LinkDescriptionElement };

package/src/traversal/visitor.cjs

@@ -1,17 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.keyMap = exports.getNodeType = void 0;
-var _apidomCore = require("@speclynx/apidom-core");
-var _apidomNsJsonSchemaDraft = require("@speclynx/apidom-ns-json-schema-draft-4");
-exports.getNodeType = _apidomNsJsonSchemaDraft.getNodeType;
-/**
- * @public
- */
-const keyMap = exports.keyMap = {
-  JSONSchemaDraft6Element: ['content'],
-  JSONReferenceElement: ['content'],
-  MediaElement: ['content'],
-  LinkDescriptionElement: ['content'],
-  ..._apidomCore.keyMap
-};

package/src/traversal/visitor.mjs

@@ -1,13 +0,0 @@
-import { keyMap as keyMapBase } from '@speclynx/apidom-core';
-export { getNodeType } from '@speclynx/apidom-ns-json-schema-draft-4';
-
-/**
- * @public
- */
-export const keyMap = {
-  JSONSchemaDraft6Element: ['content'],
-  JSONReferenceElement: ['content'],
-  MediaElement: ['content'],
-  LinkDescriptionElement: ['content'],
-  ...keyMapBase
-};