@swagger-api/apidom-ns-json-schema-draft-7 0.68.1

package/types/dist.d.ts

@@ -0,0 +1,311 @@
+/// <reference types="@swagger-api/apidom-core/types/minim" />
+import { MediaTypes, NamespacePluginOptions, MemberElement, StringElement, Element, Meta, Attributes, BooleanElement, ObjectElement, ArrayElement } from '@swagger-api/apidom-core';
+export { isArrayElement, isBooleanElement, isElement, isLinkElement, isMemberElement, isNullElement, isNumberElement, isObjectElement, isRefElement, isStringElement } from '@swagger-api/apidom-core';
+import * as minim from 'minim';
+import * as stampit from 'stampit';
+import { JSONSchemaElement, JSONReferenceElement, MediaElement, LinkDescriptionElement } from '@swagger-api/apidom-ns-json-schema-draft-6';
+export { AlternatingVisitor, FallbackVisitor, FixedFieldsVisitor, JSONReferenceElement, MapVisitor, ParentSchemaAwareVisitor, PatternedFieldsVisitor, SpecificationVisitor, isJSONReferenceElement, isJSONReferenceLikeElement } from '@swagger-api/apidom-ns-json-schema-draft-6';
+
+type Format = 'generic' | 'json' | 'yaml';
+declare class JSONSchemaDraft7MediaTypes extends MediaTypes<string> {
+    filterByFormat(format?: Format): string[];
+    findBy(version?: string, format?: Format): string;
+    latest(format?: Format): string;
+}
+declare const mediaTypes: JSONSchemaDraft7MediaTypes;
+
+declare const jsonSchemaDraft7: {
+    namespace: (options: NamespacePluginOptions) => minim.Namespace;
+};
+
+declare const plugin: () => () => {
+    visitor: {
+        MemberElement(element: MemberElement, ...rest: any): MemberElement | undefined;
+        StringElement(element: StringElement, ...rest: any): any;
+    };
+};
+
+declare const refract: <T extends Element>(value: any, { specPath, plugins, specificationObj, }?: {
+    specPath?: string[] | undefined;
+    plugins?: never[] | undefined;
+    specificationObj?: {
+        visitors: {
+            value: stampit.default.Stamp<any>;
+            JSONSchemaOrJSONReferenceVisitor: stampit.default.Stamp<any>;
+            document: {
+                objects: {
+                    JSONSchema: {
+                        $visitor: stampit.default.Stamp<any>;
+                        fixedFields: {
+                            id: stampit.default.Stamp<any>;
+                            $schema: stampit.default.Stamp<any>;
+                            multipleOf: stampit.default.Stamp<any>;
+                            maximum: stampit.default.Stamp<any>;
+                            exclusiveMaximum: stampit.default.Stamp<any>;
+                            minimum: stampit.default.Stamp<any>;
+                            exclusiveMinimum: stampit.default.Stamp<any>;
+                            maxLength: stampit.default.Stamp<any>;
+                            minLength: stampit.default.Stamp<any>;
+                            pattern: stampit.default.Stamp<any>;
+                            additionalItems: stampit.default.Stamp<any>;
+                            items: stampit.default.Stamp<any>;
+                            maxItems: stampit.default.Stamp<any>;
+                            minItems: stampit.default.Stamp<any>;
+                            uniqueItems: stampit.default.Stamp<any>;
+                            maxProperties: stampit.default.Stamp<any>;
+                            minProperties: stampit.default.Stamp<any>;
+                            required: stampit.default.Stamp<any>;
+                            properties: stampit.default.Stamp<any>;
+                            additionalProperties: stampit.default.Stamp<any>;
+                            patternProperties: stampit.default.Stamp<any>;
+                            dependencies: stampit.default.Stamp<any>;
+                            enum: stampit.default.Stamp<any>;
+                            type: stampit.default.Stamp<any>;
+                            allOf: stampit.default.Stamp<any>;
+                            anyOf: stampit.default.Stamp<any>;
+                            oneOf: stampit.default.Stamp<any>;
+                            not: stampit.default.Stamp<any>;
+                            definitions: stampit.default.Stamp<any>;
+                            title: stampit.default.Stamp<any>;
+                            description: stampit.default.Stamp<any>;
+                            default: stampit.default.Stamp<any>;
+                            format: stampit.default.Stamp<any>;
+                            base: stampit.default.Stamp<any>;
+                            links: stampit.default.Stamp<any>;
+                            media: {
+                                $ref: string;
+                            };
+                            readOnly: stampit.default.Stamp<any>;
+                        };
+                    };
+                    JSONReference: {
+                        $visitor: stampit.default.Stamp<any>;
+                        fixedFields: {
+                            $ref: stampit.default.Stamp<any>;
+                        };
+                    };
+                    Media: {
+                        $visitor: stampit.default.Stamp<any>;
+                        fixedFields: {
+                            binaryEncoding: stampit.default.Stamp<any>;
+                            type: stampit.default.Stamp<any>;
+                        };
+                    };
+                    LinkDescription: {
+                        $visitor: stampit.default.Stamp<any>;
+                        fixedFields: {
+                            href: stampit.default.Stamp<any>;
+                            rel: stampit.default.Stamp<any>;
+                            title: stampit.default.Stamp<any>;
+                            targetSchema: stampit.default.Stamp<any>;
+                            mediaType: stampit.default.Stamp<any>;
+                            method: stampit.default.Stamp<any>;
+                            encType: stampit.default.Stamp<any>;
+                            schema: stampit.default.Stamp<any>;
+                        };
+                    };
+                };
+            };
+        };
+    } | undefined;
+}) => T;
+declare const createRefractor: (specPath: string[]) => (value: any, options?: {}) => Element;
+
+declare const _default: {
+    visitors: {
+        value: stampit.default.Stamp<any>;
+        JSONSchemaOrJSONReferenceVisitor: stampit.default.Stamp<any>;
+        document: {
+            objects: {
+                JSONSchema: {
+                    $visitor: stampit.default.Stamp<any>;
+                    fixedFields: {
+                        id: stampit.default.Stamp<any>;
+                        $schema: stampit.default.Stamp<any>;
+                        multipleOf: stampit.default.Stamp<any>;
+                        maximum: stampit.default.Stamp<any>;
+                        exclusiveMaximum: stampit.default.Stamp<any>;
+                        minimum: stampit.default.Stamp<any>;
+                        exclusiveMinimum: stampit.default.Stamp<any>;
+                        maxLength: stampit.default.Stamp<any>;
+                        minLength: stampit.default.Stamp<any>;
+                        pattern: stampit.default.Stamp<any>;
+                        additionalItems: stampit.default.Stamp<any>;
+                        items: stampit.default.Stamp<any>;
+                        maxItems: stampit.default.Stamp<any>;
+                        minItems: stampit.default.Stamp<any>;
+                        uniqueItems: stampit.default.Stamp<any>;
+                        maxProperties: stampit.default.Stamp<any>;
+                        minProperties: stampit.default.Stamp<any>;
+                        required: stampit.default.Stamp<any>;
+                        properties: stampit.default.Stamp<any>;
+                        additionalProperties: stampit.default.Stamp<any>;
+                        patternProperties: stampit.default.Stamp<any>;
+                        dependencies: stampit.default.Stamp<any>;
+                        enum: stampit.default.Stamp<any>;
+                        type: stampit.default.Stamp<any>;
+                        allOf: stampit.default.Stamp<any>;
+                        anyOf: stampit.default.Stamp<any>;
+                        oneOf: stampit.default.Stamp<any>;
+                        not: stampit.default.Stamp<any>;
+                        definitions: stampit.default.Stamp<any>;
+                        title: stampit.default.Stamp<any>;
+                        description: stampit.default.Stamp<any>;
+                        default: stampit.default.Stamp<any>;
+                        format: stampit.default.Stamp<any>;
+                        base: stampit.default.Stamp<any>;
+                        links: stampit.default.Stamp<any>;
+                        media: {
+                            $ref: string;
+                        };
+                        readOnly: stampit.default.Stamp<any>;
+                    };
+                };
+                JSONReference: {
+                    $visitor: stampit.default.Stamp<any>;
+                    fixedFields: {
+                        $ref: stampit.default.Stamp<any>;
+                    };
+                };
+                Media: {
+                    $visitor: stampit.default.Stamp<any>;
+                    fixedFields: {
+                        binaryEncoding: stampit.default.Stamp<any>;
+                        type: stampit.default.Stamp<any>;
+                    };
+                };
+                LinkDescription: {
+                    $visitor: stampit.default.Stamp<any>;
+                    fixedFields: {
+                        href: stampit.default.Stamp<any>;
+                        rel: stampit.default.Stamp<any>;
+                        title: stampit.default.Stamp<any>;
+                        targetSchema: stampit.default.Stamp<any>;
+                        mediaType: stampit.default.Stamp<any>;
+                        method: stampit.default.Stamp<any>;
+                        encType: stampit.default.Stamp<any>;
+                        schema: stampit.default.Stamp<any>;
+                    };
+                };
+            };
+        };
+    };
+};
+
+declare const isJSONSchemaElement: (element: any) => boolean;
+declare const isLinkDescriptionElement: (element: any) => boolean;
+
+declare const getNodeType: <T extends Element>(element: T) => string | undefined;
+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[];
+    JSONSchemaDraft7Element: string[];
+    JSONReferenceElement: string[];
+    LinkDescriptionElement: string[];
+};
+
+declare class JSONSchema extends JSONSchemaElement {
+    constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes);
+    /**
+     * Core vocabulary
+     *
+     * URI: https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-01
+     */
+    get $comment(): StringElement | undefined;
+    set $comment($comment: StringElement | undefined);
+    /**
+     * Validation vocabulary
+     *
+     * URI: https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-validation-01
+     */
+    /**
+     * Keywords for Applying Subschemas Conditionally
+     *
+     * URI: https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-validation-01#section-6.6
+     */
+    get if(): this | BooleanElement | JSONReferenceElement | undefined;
+    set if(ifValue: this | BooleanElement | JSONReferenceElement | undefined);
+    get then(): this | BooleanElement | JSONReferenceElement | undefined;
+    set then(then: this | BooleanElement | JSONReferenceElement | undefined);
+    get else(): this | BooleanElement | JSONReferenceElement | undefined;
+    set else(elseValue: this | BooleanElement | JSONReferenceElement | undefined);
+    /**
+     * String-Encoding Non-JSON Data
+     *
+     * URI: https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-validation-00#section-8
+     */
+    get contentEncoding(): StringElement | undefined;
+    set contentEncoding(contentEncoding: StringElement | undefined);
+    get contentMediaType(): StringElement | undefined;
+    set contentMediaType(contentMediaType: StringElement | undefined);
+    get media(): MediaElement | undefined;
+    set media(media: MediaElement | undefined);
+    /**
+     * Schema annotations
+     *
+     * URI: https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-validation-01#section-10
+     */
+    get writeOnly(): BooleanElement | undefined;
+    set writeOnly(writeOnly: BooleanElement | undefined);
+}
+
+/**
+ * URI: https://datatracker.ietf.org/doc/html/draft-wright-json-schema-hyperschema-01#section-6
+ */
+declare class LinkDescription extends LinkDescriptionElement {
+    /**
+     * Link context.
+     *
+     * URI: https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-hyperschema-01#section-6.1
+     */
+    get anchor(): StringElement | undefined;
+    set anchor(anchor: StringElement | undefined);
+    get anchorPointer(): StringElement | undefined;
+    set anchorPointer(anchorPointer: StringElement | undefined);
+    /**
+     * Adjusting URI Template Resolution.
+     *
+     * URI: https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-hyperschema-01#section-6.4
+     */
+    get templatePointers(): ObjectElement | undefined;
+    set templatePointers(templatePointers: ObjectElement | undefined);
+    get templateRequired(): ArrayElement | undefined;
+    set templateRequired(templateRequired: ArrayElement | undefined);
+    /**
+     * Link Target Attributes.
+     *
+     * URI: https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-hyperschema-01#section-6.5
+     */
+    get mediaType(): StringElement | undefined;
+    set mediaType(mediaType: StringElement | undefined);
+    get targetMediaType(): StringElement | undefined;
+    set targetMediaType(targetMediaType: StringElement | undefined);
+    get targetHints(): ObjectElement | undefined;
+    set targetHints(targetHints: ObjectElement | undefined);
+    get description(): StringElement | undefined;
+    set description(description: StringElement | undefined);
+    get $comment(): StringElement | undefined;
+    set $comment($comment: StringElement | undefined);
+    /**
+     *  Submitting Data for Processing.
+     *
+     *  URI: https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-hyperschema-01#section-6.6.4
+     */
+    get submissionEncType(): StringElement | undefined;
+    set submissionEncType(submissionEncType: StringElement | undefined);
+    get submissionMediaType(): StringElement | undefined;
+    set submissionMediaType(submissionMediaType: StringElement | undefined);
+}
+
+export { JSONSchemaDraft7MediaTypes, JSONSchema as JSONSchemaElement, LinkDescription as LinkDescriptionElement, createRefractor, jsonSchemaDraft7 as default, getNodeType, isJSONSchemaElement, isLinkDescriptionElement, keyMap, mediaTypes, refract, plugin as refractorPluginReplaceEmptyElement, _default as specificationObj };