@scalar/openapi-parser 0.4.0 → 0.5.0

package/dist/lib/Validator/Validator.d.ts

@@ -0,0 +1,33 @@
+import Ajv04 from 'ajv-draft-04';
+import Ajv2020 from 'ajv/dist/2020';
+import { OpenApiVersion } from '../../configuration.js';
+import { AnyObject, Filesystem, ValidateResult } from '../../types/index.js';
+
+/**
+ * Configure available JSON Schema versions
+ */
+declare const jsonSchemaVersions: {
+    'http://json-schema.org/draft-04/schema#': typeof Ajv04;
+    'https://json-schema.org/draft/2020-12/schema': typeof Ajv2020;
+};
+declare class Validator {
+    version: string;
+    static supportedVersions: ("2.0" | "3.0" | "3.1")[];
+    protected ajvValidators: Record<string, ((specification: AnyObject) => boolean) & {
+        errors: string;
+    }>;
+    protected errors: string;
+    protected specificationVersion: string;
+    protected specificationType: string;
+    specification: AnyObject;
+    /**
+     * Checks whether a specification is valid and all references can be resolved.
+     */
+    validate(filesystem: Filesystem): Promise<ValidateResult>;
+    /**
+     * Ajv JSON schema validator
+     */
+    getAjvValidator(version: OpenApiVersion): Promise<any>;
+}
+
+export { Validator, jsonSchemaVersions };

package/dist/pipeline.d.ts

@@ -0,0 +1,445 @@
+import { AnyObject, Filesystem, ErrorObject } from './types/index.js';
+import { filter } from './utils/filter.js';
+import { load, LoadPlugin } from './utils/load/load.js';
+import { upgrade } from './utils/upgrade.js';
+import { OpenAPI } from './types/openapi.js';
+
+/**
+ * A queuable action for the pipeline
+ */
+type Action = {
+    action: typeof load | typeof upgrade | typeof filter;
+    options?: AnyObject;
+};
+/**
+ * A queue of tasks to run on an OpenAPI specification
+ */
+type Queue = {
+    specification: AnyApiDefinitionFormat;
+    tasks: Action[];
+};
+/**
+ * JSON, YAML or object representation of an OpenAPI API definition
+ */
+type AnyApiDefinitionFormat = string | AnyObject;
+/**
+ * Creates a new pipeline
+ */
+declare function openapi(): {
+    load: typeof loadAction;
+};
+/**
+ * Load an OpenAPI specification.
+ *
+ * Example: await openapi().load({ openapi: '3.0.0' })
+ */
+declare function loadAction(specification: AnyApiDefinitionFormat, options?: {
+    plugins: LoadPlugin[];
+}): {
+    get: () => Promise<AnyObject>;
+    files: () => Promise<Filesystem>;
+    details: () => Promise<{
+        version: "2.0" | "3.0" | "3.1";
+        specificationType: string;
+        specificationVersion: string;
+    }>;
+    filter: (callback: (Specification: AnyObject) => boolean) => {
+        get: () => Promise<AnyObject>;
+        files: () => Promise<Filesystem>;
+        details: () => Promise<{
+            version: "2.0" | "3.0" | "3.1";
+            specificationType: string;
+            specificationVersion: string;
+        }>;
+        filter: () => any;
+        upgrade: () => {
+            get: () => Promise<AnyObject>;
+            files: () => Promise<Filesystem>;
+            details: () => Promise<{
+                version: "2.0" | "3.0" | "3.1";
+                specificationType: string;
+                specificationVersion: string;
+            }>;
+            filter: (callback: (Specification: AnyObject) => boolean) => any;
+            validate: () => Promise<{
+                filter: (callback: (Specification: AnyObject) => boolean) => any;
+                get: () => Promise<AnyObject>;
+                files: () => Promise<Filesystem>;
+                details: () => Promise<{
+                    version: "2.0" | "3.0" | "3.1";
+                    specificationType: string;
+                    specificationVersion: string;
+                }>;
+                dereference: () => {
+                    get: () => Promise<AnyObject>;
+                    files: () => Promise<Filesystem>;
+                    filter: (callback: (Specification: AnyObject) => boolean) => any;
+                    toJson: () => Promise<string>;
+                    toYaml: () => Promise<string>;
+                };
+                toJson: () => Promise<string>;
+                toYaml: () => Promise<string>;
+                valid: boolean;
+                specification?: OpenAPI.Document<{}>;
+                version?: string;
+                errors?: ErrorObject[];
+                schema?: OpenAPI.Document<{}>;
+            }>;
+            dereference: () => {
+                get: () => Promise<AnyObject>;
+                files: () => Promise<Filesystem>;
+                filter: (callback: (Specification: AnyObject) => boolean) => any;
+                toJson: () => Promise<string>;
+                toYaml: () => Promise<string>;
+            };
+            toJson: () => Promise<string>;
+            toYaml: () => Promise<string>;
+        };
+        validate: () => Promise<{
+            filter: (callback: (Specification: AnyObject) => boolean) => any;
+            get: () => Promise<AnyObject>;
+            files: () => Promise<Filesystem>;
+            details: () => Promise<{
+                version: "2.0" | "3.0" | "3.1";
+                specificationType: string;
+                specificationVersion: string;
+            }>;
+            dereference: () => {
+                get: () => Promise<AnyObject>;
+                files: () => Promise<Filesystem>;
+                filter: (callback: (Specification: AnyObject) => boolean) => any;
+                toJson: () => Promise<string>;
+                toYaml: () => Promise<string>;
+            };
+            toJson: () => Promise<string>;
+            toYaml: () => Promise<string>;
+            valid: boolean;
+            specification?: OpenAPI.Document<{}>;
+            version?: string;
+            errors?: ErrorObject[];
+            schema?: OpenAPI.Document<{}>;
+        }>;
+        dereference: () => {
+            get: () => Promise<AnyObject>;
+            files: () => Promise<Filesystem>;
+            filter: (callback: (Specification: AnyObject) => boolean) => any;
+            toJson: () => Promise<string>;
+            toYaml: () => Promise<string>;
+        };
+        toJson: () => Promise<string>;
+        toYaml: () => Promise<string>;
+    };
+    upgrade: () => {
+        get: () => Promise<AnyObject>;
+        files: () => Promise<Filesystem>;
+        details: () => Promise<{
+            version: "2.0" | "3.0" | "3.1";
+            specificationType: string;
+            specificationVersion: string;
+        }>;
+        filter: (callback: (Specification: AnyObject) => boolean) => {
+            get: () => Promise<AnyObject>;
+            files: () => Promise<Filesystem>;
+            details: () => Promise<{
+                version: "2.0" | "3.0" | "3.1";
+                specificationType: string;
+                specificationVersion: string;
+            }>;
+            filter: () => any;
+            upgrade: () => any;
+            validate: () => Promise<{
+                filter: (callback: (Specification: AnyObject) => boolean) => any;
+                get: () => Promise<AnyObject>;
+                files: () => Promise<Filesystem>;
+                details: () => Promise<{
+                    version: "2.0" | "3.0" | "3.1";
+                    specificationType: string;
+                    specificationVersion: string;
+                }>;
+                dereference: () => {
+                    get: () => Promise<AnyObject>;
+                    files: () => Promise<Filesystem>;
+                    filter: (callback: (Specification: AnyObject) => boolean) => any;
+                    toJson: () => Promise<string>;
+                    toYaml: () => Promise<string>;
+                };
+                toJson: () => Promise<string>;
+                toYaml: () => Promise<string>;
+                valid: boolean;
+                specification?: OpenAPI.Document<{}>;
+                version?: string;
+                errors?: ErrorObject[];
+                schema?: OpenAPI.Document<{}>;
+            }>;
+            dereference: () => {
+                get: () => Promise<AnyObject>;
+                files: () => Promise<Filesystem>;
+                filter: (callback: (Specification: AnyObject) => boolean) => any;
+                toJson: () => Promise<string>;
+                toYaml: () => Promise<string>;
+            };
+            toJson: () => Promise<string>;
+            toYaml: () => Promise<string>;
+        };
+        validate: () => Promise<{
+            filter: (callback: (Specification: AnyObject) => boolean) => {
+                get: () => Promise<AnyObject>;
+                files: () => Promise<Filesystem>;
+                details: () => Promise<{
+                    version: "2.0" | "3.0" | "3.1";
+                    specificationType: string;
+                    specificationVersion: string;
+                }>;
+                filter: () => any;
+                upgrade: () => any;
+                validate: () => Promise<any>;
+                dereference: () => {
+                    get: () => Promise<AnyObject>;
+                    files: () => Promise<Filesystem>;
+                    filter: (callback: (Specification: AnyObject) => boolean) => any;
+                    toJson: () => Promise<string>;
+                    toYaml: () => Promise<string>;
+                };
+                toJson: () => Promise<string>;
+                toYaml: () => Promise<string>;
+            };
+            get: () => Promise<AnyObject>;
+            files: () => Promise<Filesystem>;
+            details: () => Promise<{
+                version: "2.0" | "3.0" | "3.1";
+                specificationType: string;
+                specificationVersion: string;
+            }>;
+            dereference: () => {
+                get: () => Promise<AnyObject>;
+                files: () => Promise<Filesystem>;
+                filter: (callback: (Specification: AnyObject) => boolean) => {
+                    get: () => Promise<AnyObject>;
+                    files: () => Promise<Filesystem>;
+                    details: () => Promise<{
+                        version: "2.0" | "3.0" | "3.1";
+                        specificationType: string;
+                        specificationVersion: string;
+                    }>;
+                    filter: () => any;
+                    upgrade: () => any;
+                    validate: () => Promise<any>;
+                    dereference: () => any;
+                    toJson: () => Promise<string>;
+                    toYaml: () => Promise<string>;
+                };
+                toJson: () => Promise<string>;
+                toYaml: () => Promise<string>;
+            };
+            toJson: () => Promise<string>;
+            toYaml: () => Promise<string>;
+            valid: boolean;
+            specification?: OpenAPI.Document<{}>;
+            version?: string;
+            errors?: ErrorObject[];
+            schema?: OpenAPI.Document<{}>;
+        }>;
+        dereference: () => {
+            get: () => Promise<AnyObject>;
+            files: () => Promise<Filesystem>;
+            filter: (callback: (Specification: AnyObject) => boolean) => {
+                get: () => Promise<AnyObject>;
+                files: () => Promise<Filesystem>;
+                details: () => Promise<{
+                    version: "2.0" | "3.0" | "3.1";
+                    specificationType: string;
+                    specificationVersion: string;
+                }>;
+                filter: () => any;
+                upgrade: () => any;
+                validate: () => Promise<{
+                    filter: (callback: (Specification: AnyObject) => boolean) => any;
+                    get: () => Promise<AnyObject>;
+                    files: () => Promise<Filesystem>;
+                    details: () => Promise<{
+                        version: "2.0" | "3.0" | "3.1";
+                        specificationType: string;
+                        specificationVersion: string;
+                    }>;
+                    dereference: () => any;
+                    toJson: () => Promise<string>;
+                    toYaml: () => Promise<string>;
+                    valid: boolean;
+                    specification?: OpenAPI.Document<{}>;
+                    version?: string;
+                    errors?: ErrorObject[];
+                    schema?: OpenAPI.Document<{}>;
+                }>;
+                dereference: () => any;
+                toJson: () => Promise<string>;
+                toYaml: () => Promise<string>;
+            };
+            toJson: () => Promise<string>;
+            toYaml: () => Promise<string>;
+        };
+        toJson: () => Promise<string>;
+        toYaml: () => Promise<string>;
+    };
+    validate: () => Promise<{
+        filter: (callback: (Specification: AnyObject) => boolean) => {
+            get: () => Promise<AnyObject>;
+            files: () => Promise<Filesystem>;
+            details: () => Promise<{
+                version: "2.0" | "3.0" | "3.1";
+                specificationType: string;
+                specificationVersion: string;
+            }>;
+            filter: () => any;
+            upgrade: () => {
+                get: () => Promise<AnyObject>;
+                files: () => Promise<Filesystem>;
+                details: () => Promise<{
+                    version: "2.0" | "3.0" | "3.1";
+                    specificationType: string;
+                    specificationVersion: string;
+                }>;
+                filter: (callback: (Specification: AnyObject) => boolean) => any;
+                validate: () => Promise<any>;
+                dereference: () => {
+                    get: () => Promise<AnyObject>;
+                    files: () => Promise<Filesystem>;
+                    filter: (callback: (Specification: AnyObject) => boolean) => any;
+                    toJson: () => Promise<string>;
+                    toYaml: () => Promise<string>;
+                };
+                toJson: () => Promise<string>;
+                toYaml: () => Promise<string>;
+            };
+            validate: () => Promise<any>;
+            dereference: () => {
+                get: () => Promise<AnyObject>;
+                files: () => Promise<Filesystem>;
+                filter: (callback: (Specification: AnyObject) => boolean) => any;
+                toJson: () => Promise<string>;
+                toYaml: () => Promise<string>;
+            };
+            toJson: () => Promise<string>;
+            toYaml: () => Promise<string>;
+        };
+        get: () => Promise<AnyObject>;
+        files: () => Promise<Filesystem>;
+        details: () => Promise<{
+            version: "2.0" | "3.0" | "3.1";
+            specificationType: string;
+            specificationVersion: string;
+        }>;
+        dereference: () => {
+            get: () => Promise<AnyObject>;
+            files: () => Promise<Filesystem>;
+            filter: (callback: (Specification: AnyObject) => boolean) => {
+                get: () => Promise<AnyObject>;
+                files: () => Promise<Filesystem>;
+                details: () => Promise<{
+                    version: "2.0" | "3.0" | "3.1";
+                    specificationType: string;
+                    specificationVersion: string;
+                }>;
+                filter: () => any;
+                upgrade: () => {
+                    get: () => Promise<AnyObject>;
+                    files: () => Promise<Filesystem>;
+                    details: () => Promise<{
+                        version: "2.0" | "3.0" | "3.1";
+                        specificationType: string;
+                        specificationVersion: string;
+                    }>;
+                    filter: (callback: (Specification: AnyObject) => boolean) => any;
+                    validate: () => Promise<any>;
+                    dereference: () => any;
+                    toJson: () => Promise<string>;
+                    toYaml: () => Promise<string>;
+                };
+                validate: () => Promise<any>;
+                dereference: () => any;
+                toJson: () => Promise<string>;
+                toYaml: () => Promise<string>;
+            };
+            toJson: () => Promise<string>;
+            toYaml: () => Promise<string>;
+        };
+        toJson: () => Promise<string>;
+        toYaml: () => Promise<string>;
+        valid: boolean;
+        specification?: OpenAPI.Document<{}>;
+        version?: string;
+        errors?: ErrorObject[];
+        schema?: OpenAPI.Document<{}>;
+    }>;
+    dereference: () => {
+        get: () => Promise<AnyObject>;
+        files: () => Promise<Filesystem>;
+        filter: (callback: (Specification: AnyObject) => boolean) => {
+            get: () => Promise<AnyObject>;
+            files: () => Promise<Filesystem>;
+            details: () => Promise<{
+                version: "2.0" | "3.0" | "3.1";
+                specificationType: string;
+                specificationVersion: string;
+            }>;
+            filter: () => any;
+            upgrade: () => {
+                get: () => Promise<AnyObject>;
+                files: () => Promise<Filesystem>;
+                details: () => Promise<{
+                    version: "2.0" | "3.0" | "3.1";
+                    specificationType: string;
+                    specificationVersion: string;
+                }>;
+                filter: (callback: (Specification: AnyObject) => boolean) => any;
+                validate: () => Promise<{
+                    filter: (callback: (Specification: AnyObject) => boolean) => any;
+                    get: () => Promise<AnyObject>;
+                    files: () => Promise<Filesystem>;
+                    details: () => Promise<{
+                        version: "2.0" | "3.0" | "3.1";
+                        specificationType: string;
+                        specificationVersion: string;
+                    }>;
+                    dereference: () => any;
+                    toJson: () => Promise<string>;
+                    toYaml: () => Promise<string>;
+                    valid: boolean;
+                    specification?: OpenAPI.Document<{}>;
+                    version?: string;
+                    errors?: ErrorObject[];
+                    schema?: OpenAPI.Document<{}>;
+                }>;
+                dereference: () => any;
+                toJson: () => Promise<string>;
+                toYaml: () => Promise<string>;
+            };
+            validate: () => Promise<{
+                filter: (callback: (Specification: AnyObject) => boolean) => any;
+                get: () => Promise<AnyObject>;
+                files: () => Promise<Filesystem>;
+                details: () => Promise<{
+                    version: "2.0" | "3.0" | "3.1";
+                    specificationType: string;
+                    specificationVersion: string;
+                }>;
+                dereference: () => any;
+                toJson: () => Promise<string>;
+                toYaml: () => Promise<string>;
+                valid: boolean;
+                specification?: OpenAPI.Document<{}>;
+                version?: string;
+                errors?: ErrorObject[];
+                schema?: OpenAPI.Document<{}>;
+            }>;
+            dereference: () => any;
+            toJson: () => Promise<string>;
+            toYaml: () => Promise<string>;
+        };
+        toJson: () => Promise<string>;
+        toYaml: () => Promise<string>;
+    };
+    toJson: () => Promise<string>;
+    toYaml: () => Promise<string>;
+};
+
+export { type Action, type AnyApiDefinitionFormat, type Queue, openapi };