oas-normalize 8.1.3 → 8.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/index.d.ts +3 -75
  2. package/dist/index.js +1 -1
  3. package/dist/lib/utils.d.ts +2 -2
  4. package/package.json +1 -1
  5. package/tsconfig.json +1 -0
package/dist/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import type { OpenAPI } from 'openapi-types';
2
2
  import openapiParser from '@readme/openapi-parser';
3
3
  import * as utils from './lib/utils';
4
- export declare type Options = {
4
+ export type Options = {
5
5
  colorizeErrors?: boolean;
6
6
  enablePaths?: boolean;
7
7
  };
@@ -29,84 +29,12 @@ export default class OASNormalize {
29
29
  * Bundle up the given API definition, resolving any external `$ref` pointers in the process.
30
30
  *
31
31
  */
32
- bundle(): Promise<import("openapi-types").OpenAPIV2.Document<{}> | import("openapi-types").OpenAPIV3.Document<{}> | (Omit<Omit<import("openapi-types").OpenAPIV3.Document<{}>, "paths" | "components">, "paths" | "components" | "info" | "servers" | "webhooks" | "jsonSchemaDialect"> & {
33
- info: import("openapi-types").OpenAPIV3_1.InfoObject;
34
- jsonSchemaDialect?: string;
35
- servers?: import("openapi-types").OpenAPIV3_1.ServerObject[];
36
- } & Pick<{
37
- paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
38
- webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
39
- components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
40
- }, "paths"> & Omit<Partial<{
41
- paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
42
- webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
43
- components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
44
- }>, "paths">) | (Omit<Omit<import("openapi-types").OpenAPIV3.Document<{}>, "paths" | "components">, "paths" | "components" | "info" | "servers" | "webhooks" | "jsonSchemaDialect"> & {
45
- info: import("openapi-types").OpenAPIV3_1.InfoObject;
46
- jsonSchemaDialect?: string;
47
- servers?: import("openapi-types").OpenAPIV3_1.ServerObject[];
48
- } & Pick<{
49
- paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
50
- webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
51
- components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
52
- }, "webhooks"> & Omit<Partial<{
53
- paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
54
- webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
55
- components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
56
- }>, "webhooks">) | (Omit<Omit<import("openapi-types").OpenAPIV3.Document<{}>, "paths" | "components">, "paths" | "components" | "info" | "servers" | "webhooks" | "jsonSchemaDialect"> & {
57
- info: import("openapi-types").OpenAPIV3_1.InfoObject;
58
- jsonSchemaDialect?: string;
59
- servers?: import("openapi-types").OpenAPIV3_1.ServerObject[];
60
- } & Pick<{
61
- paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
62
- webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
63
- components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
64
- }, "components"> & Omit<Partial<{
65
- paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
66
- webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
67
- components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
68
- }>, "components">)>;
32
+ bundle(): Promise<OpenAPI.Document<{}>>;
69
33
  /**
70
34
  * Dereference the given API definition.
71
35
  *
72
36
  */
73
- deref(): Promise<import("openapi-types").OpenAPIV2.Document<{}> | import("openapi-types").OpenAPIV3.Document<{}> | (Omit<Omit<import("openapi-types").OpenAPIV3.Document<{}>, "paths" | "components">, "paths" | "components" | "info" | "servers" | "webhooks" | "jsonSchemaDialect"> & {
74
- info: import("openapi-types").OpenAPIV3_1.InfoObject;
75
- jsonSchemaDialect?: string;
76
- servers?: import("openapi-types").OpenAPIV3_1.ServerObject[];
77
- } & Pick<{
78
- paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
79
- webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
80
- components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
81
- }, "paths"> & Omit<Partial<{
82
- paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
83
- webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
84
- components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
85
- }>, "paths">) | (Omit<Omit<import("openapi-types").OpenAPIV3.Document<{}>, "paths" | "components">, "paths" | "components" | "info" | "servers" | "webhooks" | "jsonSchemaDialect"> & {
86
- info: import("openapi-types").OpenAPIV3_1.InfoObject;
87
- jsonSchemaDialect?: string;
88
- servers?: import("openapi-types").OpenAPIV3_1.ServerObject[];
89
- } & Pick<{
90
- paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
91
- webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
92
- components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
93
- }, "webhooks"> & Omit<Partial<{
94
- paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
95
- webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
96
- components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
97
- }>, "webhooks">) | (Omit<Omit<import("openapi-types").OpenAPIV3.Document<{}>, "paths" | "components">, "paths" | "components" | "info" | "servers" | "webhooks" | "jsonSchemaDialect"> & {
98
- info: import("openapi-types").OpenAPIV3_1.InfoObject;
99
- jsonSchemaDialect?: string;
100
- servers?: import("openapi-types").OpenAPIV3_1.ServerObject[];
101
- } & Pick<{
102
- paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
103
- webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
104
- components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
105
- }, "components"> & Omit<Partial<{
106
- paths: import("openapi-types").OpenAPIV3_1.PathsObject<{}, {}>;
107
- webhooks: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>>;
108
- components: import("openapi-types").OpenAPIV3_1.ComponentsObject;
109
- }>, "components">)>;
37
+ deref(): Promise<OpenAPI.Document<{}>>;
110
38
  /**
111
39
  * Validate, and potentially convert to OpenAPI, a given API definition.
112
40
  *
package/dist/index.js CHANGED
@@ -48,7 +48,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
48
48
  function verb(n) { return function (v) { return step([n, v]); }; }
49
49
  function step(op) {
50
50
  if (f) throw new TypeError("Generator is already executing.");
51
- while (_) try {
51
+ while (g && (g = 0, op[0] && (_ = 0)), _) try {
52
52
  if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
53
53
  if (y = 0, t) op = [op[0] & 2, t.value];
54
54
  switch (op[0]) {
package/dist/lib/utils.d.ts CHANGED
@@ -7,7 +7,7 @@ export declare function isBuffer(obj: any): any;
7
7
  * Determine the type of a given variable. Returns `false` if unrecognized.
8
8
  *
9
9
  */
10
- export declare function getType(obj: any): false | "path" | "json" | "buffer" | "string-json" | "string-yaml" | "url";
10
+ export declare function getType(obj: any): false | "buffer" | "json" | "string-json" | "string-yaml" | "url" | "path";
11
11
  /**
12
12
  * Determine if a given schema if an OpenAPI definition.
13
13
  *
@@ -44,4 +44,4 @@ export declare function isAPIDefinition(schema: Record<string, unknown>): boolea
44
44
  * Retrieve the type of API definition that a given schema is.
45
45
  *
46
46
  */
47
- export declare function getAPIDefinitionType(schema: Record<string, unknown>): "unknown" | "openapi" | "postman" | "swagger";
47
+ export declare function getAPIDefinitionType(schema: Record<string, unknown>): "openapi" | "postman" | "swagger" | "unknown";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "oas-normalize",
3
- "version": "8.1.3",
3
+ "version": "8.1.4",
4
4
  "description": "Tooling for converting, valiating, and parsing OpenAPI, Swagger, and Postman API definitions",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/tsconfig.json CHANGED
@@ -9,6 +9,7 @@
9
9
  "paths": {
10
10
  "swagger2openapi": [".sink.d.ts"]
11
11
  },
12
+ "skipLibCheck": true
12
13
  },
13
14
  "include": ["./src/**/*"]
14
15
  }