oas 24.7.0 → 24.9.0

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 (58) hide show
  1. package/README.md +1 -0
  2. package/dist/analyzer/index.cjs +6 -6
  3. package/dist/analyzer/index.js +5 -5
  4. package/dist/{chunk-D6YGEKAS.js → chunk-2PJJRTP6.js} +13 -4
  5. package/dist/chunk-2PJJRTP6.js.map +1 -0
  6. package/dist/{chunk-3CBAAWG2.cjs → chunk-3FVUMJJI.cjs} +36 -29
  7. package/dist/chunk-3FVUMJJI.cjs.map +1 -0
  8. package/dist/{chunk-BALOBQT5.js → chunk-F65XXTLV.js} +3 -3
  9. package/dist/{chunk-6QHUSSDH.cjs → chunk-G6ASGSM5.cjs} +1 -1
  10. package/dist/chunk-G6ASGSM5.cjs.map +1 -0
  11. package/dist/{chunk-7KGYHFQ2.js → chunk-J2PK2DSN.js} +11 -4
  12. package/dist/chunk-J2PK2DSN.js.map +1 -0
  13. package/dist/{chunk-OCUXVRES.cjs → chunk-OD3GKGB2.cjs} +13 -13
  14. package/dist/{chunk-JCLIAFTG.js → chunk-P2SB77YR.js} +4 -1
  15. package/dist/chunk-P2SB77YR.js.map +1 -0
  16. package/dist/{chunk-XPA5KLS5.js → chunk-U7Q7XPMY.js} +1 -1
  17. package/dist/chunk-U7Q7XPMY.js.map +1 -0
  18. package/dist/{chunk-XWUEF5DO.cjs → chunk-YHO3AOX6.cjs} +5 -2
  19. package/dist/chunk-YHO3AOX6.cjs.map +1 -0
  20. package/dist/{chunk-TKJRRBN7.cjs → chunk-YX5TCZYW.cjs} +26 -17
  21. package/dist/chunk-YX5TCZYW.cjs.map +1 -0
  22. package/dist/{extensions-qzNCq0DK.d.cts → extensions-BgSADIb5.d.cts} +49 -13
  23. package/dist/{extensions-CxJyLZaY.d.ts → extensions-pEeRZhXP.d.ts} +49 -13
  24. package/dist/extensions.cjs +4 -2
  25. package/dist/extensions.d.cts +1 -1
  26. package/dist/extensions.d.ts +1 -1
  27. package/dist/extensions.js +3 -1
  28. package/dist/index.cjs +6 -6
  29. package/dist/index.d.cts +27 -18
  30. package/dist/index.d.ts +27 -18
  31. package/dist/index.js +5 -5
  32. package/dist/operation/index.cjs +5 -5
  33. package/dist/operation/index.d.cts +1 -1
  34. package/dist/operation/index.d.ts +1 -1
  35. package/dist/operation/index.js +4 -4
  36. package/dist/operation/lib/get-parameters-as-json-schema.cjs +4 -4
  37. package/dist/operation/lib/get-parameters-as-json-schema.d.cts +1 -1
  38. package/dist/operation/lib/get-parameters-as-json-schema.d.ts +1 -1
  39. package/dist/operation/lib/get-parameters-as-json-schema.js +3 -3
  40. package/dist/types.cjs +2 -2
  41. package/dist/types.d.cts +1 -1
  42. package/dist/types.d.ts +1 -1
  43. package/dist/types.js +1 -1
  44. package/dist/utils.cjs +4 -4
  45. package/dist/utils.d.cts +1 -1
  46. package/dist/utils.d.ts +1 -1
  47. package/dist/utils.js +3 -3
  48. package/package.json +2 -2
  49. package/dist/chunk-3CBAAWG2.cjs.map +0 -1
  50. package/dist/chunk-6QHUSSDH.cjs.map +0 -1
  51. package/dist/chunk-7KGYHFQ2.js.map +0 -1
  52. package/dist/chunk-D6YGEKAS.js.map +0 -1
  53. package/dist/chunk-JCLIAFTG.js.map +0 -1
  54. package/dist/chunk-TKJRRBN7.cjs.map +0 -1
  55. package/dist/chunk-XPA5KLS5.js.map +0 -1
  56. package/dist/chunk-XWUEF5DO.cjs.map +0 -1
  57. /package/dist/{chunk-BALOBQT5.js.map → chunk-F65XXTLV.js.map} +0 -0
  58. /package/dist/{chunk-OCUXVRES.cjs.map → chunk-OD3GKGB2.cjs.map} +0 -0
@@ -84,7 +84,7 @@ type ExampleGroups = Record<string, {
84
84
  * Mutually exclusive of `request`. Note that if this object is present,
85
85
  * there may or may not be corresponding responses in the `response` object.
86
86
  */
87
- customCodeSamples?: (Extensions['code-samples'] & {
87
+ customCodeSamples?: (Extensions['code-samples'][number] & {
88
88
  /**
89
89
  * The index in the originally defined `code-samples` array
90
90
  */
@@ -190,6 +190,11 @@ declare class Operation {
190
190
  isMultipart(): boolean;
191
191
  isJson(): boolean;
192
192
  isXml(): boolean;
193
+ /**
194
+ * Checks if the current operation is a webhook or not.
195
+ *
196
+ */
197
+ isWebhook(): boolean;
193
198
  /**
194
199
  * Returns an array of all security requirements associated wtih this operation. If none are
195
200
  * defined at the operation level, the securities for the entire API definition are returned
@@ -304,16 +309,7 @@ declare class Operation {
304
309
  }): {
305
310
  description?: string;
306
311
  label: string;
307
- schema: SchemaObject; /**
308
- * Retrieve a collection of grouped security schemes. The inner array determines AND-grouped
309
- * security schemes, the outer array determines OR-groups.
310
- *
311
- * @see {@link https://swagger.io/docs/specification/authentication/#multiple}
312
- * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object}
313
- * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#securityRequirementObject}
314
- * @param filterInvalid Optional flag that, when set to `true`, filters out invalid/nonexistent
315
- * security schemes, rather than returning `false`.
316
- */
312
+ schema: SchemaObject;
317
313
  type: string | string[];
318
314
  }[];
319
315
  /**
@@ -542,6 +538,22 @@ declare const HEADERS = "headers";
542
538
  * }
543
539
  */
544
540
  declare const METRICS_ENABLED = "metrics-enabled";
541
+ /**
542
+ * Configuration options for OAuth flows in the API Explorer.
543
+ *
544
+ * @defaultValue {}
545
+ * @see {@link https://docs.readme.com/main/docs/openapi-extensions#oauth-options}
546
+ * @example
547
+ * {
548
+ * "x-readme": {
549
+ * "oauth-options": {
550
+ * "scopeSeparator": ",",
551
+ * "useInsecureClientAuthentication": true
552
+ * }
553
+ * }
554
+ * }
555
+ */
556
+ declare const OAUTH_OPTIONS = "oauth-options";
545
557
  /**
546
558
  * Controls the order of parameters on your API Reference pages.
547
559
  *
@@ -654,11 +666,35 @@ interface Extensions {
654
666
  * @example "Custom cURL snippet"
655
667
  */
656
668
  name?: string;
657
- };
669
+ }[];
658
670
  [DISABLE_TAG_SORTING]: boolean;
659
671
  [EXPLORER_ENABLED]: boolean;
660
672
  [HEADERS]: Record<string, number | string>[];
661
673
  [METRICS_ENABLED]: boolean;
674
+ [OAUTH_OPTIONS]: {
675
+ /**
676
+ * Scope separator for passing scopes. This value will be URL-encoded.
677
+ *
678
+ * @example ","
679
+ * @example "+"
680
+ * @default " "
681
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc6749#section-3.3} Scope separators information from OAuth 2.0 specification
682
+ */
683
+ scopeSeparator?: string;
684
+ /**
685
+ * When enabled, the client credentials (i.e., `client_id` and `client_secret`) are sent in the request body (NOT recommended).
686
+ * When disabled (the default), client credentials are sent using the HTTP Basic Authentication scheme.
687
+ *
688
+ * This is applicable for all requests to the token endpoint.
689
+ *
690
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc6749#section-2.3.1}
691
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc6749#section-3.2}
692
+ *
693
+ * @example true
694
+ * @default false
695
+ */
696
+ useInsecureClientAuthentication?: boolean;
697
+ };
662
698
  [PARAMETER_ORDERING]: ('body' | 'cookie' | 'form' | 'header' | 'path' | 'query')[];
663
699
  [PROXY_ENABLED]: boolean;
664
700
  [SAMPLES_LANGUAGES]: string[];
@@ -683,4 +719,4 @@ declare function getExtension(extension: string | keyof Extensions, api: OASDocu
683
719
  */
684
720
  declare function validateParameterOrdering(ordering: (typeof extensionDefaults)[typeof PARAMETER_ORDERING] | undefined, extension: string): void;
685
721
 
686
- export { Callback as C, DISABLE_TAG_SORTING as D, type Extensions as E, HEADERS as H, METRICS_ENABLED as M, Operation as O, PARAMETER_ORDERING as P, type SchemaWrapper as S, Webhook as W, getParametersAsJSONSchema as a, CODE_SAMPLES as b, EXPLORER_ENABLED as c, PROXY_ENABLED as d, SAMPLES_LANGUAGES as e, SIMPLE_MODE as f, type getParametersAsJSONSchemaOptions as g, extensionDefaults as h, hasRootExtension as i, getExtension as j, types as t, validateParameterOrdering as v };
722
+ export { Callback as C, DISABLE_TAG_SORTING as D, type Extensions as E, HEADERS as H, METRICS_ENABLED as M, Operation as O, PARAMETER_ORDERING as P, type SchemaWrapper as S, Webhook as W, getParametersAsJSONSchema as a, CODE_SAMPLES as b, EXPLORER_ENABLED as c, OAUTH_OPTIONS as d, PROXY_ENABLED as e, SAMPLES_LANGUAGES as f, type getParametersAsJSONSchemaOptions as g, SIMPLE_MODE as h, extensionDefaults as i, hasRootExtension as j, getExtension as k, types as t, validateParameterOrdering as v };
@@ -84,7 +84,7 @@ type ExampleGroups = Record<string, {
84
84
  * Mutually exclusive of `request`. Note that if this object is present,
85
85
  * there may or may not be corresponding responses in the `response` object.
86
86
  */
87
- customCodeSamples?: (Extensions['code-samples'] & {
87
+ customCodeSamples?: (Extensions['code-samples'][number] & {
88
88
  /**
89
89
  * The index in the originally defined `code-samples` array
90
90
  */
@@ -190,6 +190,11 @@ declare class Operation {
190
190
  isMultipart(): boolean;
191
191
  isJson(): boolean;
192
192
  isXml(): boolean;
193
+ /**
194
+ * Checks if the current operation is a webhook or not.
195
+ *
196
+ */
197
+ isWebhook(): boolean;
193
198
  /**
194
199
  * Returns an array of all security requirements associated wtih this operation. If none are
195
200
  * defined at the operation level, the securities for the entire API definition are returned
@@ -304,16 +309,7 @@ declare class Operation {
304
309
  }): {
305
310
  description?: string;
306
311
  label: string;
307
- schema: SchemaObject; /**
308
- * Retrieve a collection of grouped security schemes. The inner array determines AND-grouped
309
- * security schemes, the outer array determines OR-groups.
310
- *
311
- * @see {@link https://swagger.io/docs/specification/authentication/#multiple}
312
- * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object}
313
- * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#securityRequirementObject}
314
- * @param filterInvalid Optional flag that, when set to `true`, filters out invalid/nonexistent
315
- * security schemes, rather than returning `false`.
316
- */
312
+ schema: SchemaObject;
317
313
  type: string | string[];
318
314
  }[];
319
315
  /**
@@ -542,6 +538,22 @@ declare const HEADERS = "headers";
542
538
  * }
543
539
  */
544
540
  declare const METRICS_ENABLED = "metrics-enabled";
541
+ /**
542
+ * Configuration options for OAuth flows in the API Explorer.
543
+ *
544
+ * @defaultValue {}
545
+ * @see {@link https://docs.readme.com/main/docs/openapi-extensions#oauth-options}
546
+ * @example
547
+ * {
548
+ * "x-readme": {
549
+ * "oauth-options": {
550
+ * "scopeSeparator": ",",
551
+ * "useInsecureClientAuthentication": true
552
+ * }
553
+ * }
554
+ * }
555
+ */
556
+ declare const OAUTH_OPTIONS = "oauth-options";
545
557
  /**
546
558
  * Controls the order of parameters on your API Reference pages.
547
559
  *
@@ -654,11 +666,35 @@ interface Extensions {
654
666
  * @example "Custom cURL snippet"
655
667
  */
656
668
  name?: string;
657
- };
669
+ }[];
658
670
  [DISABLE_TAG_SORTING]: boolean;
659
671
  [EXPLORER_ENABLED]: boolean;
660
672
  [HEADERS]: Record<string, number | string>[];
661
673
  [METRICS_ENABLED]: boolean;
674
+ [OAUTH_OPTIONS]: {
675
+ /**
676
+ * Scope separator for passing scopes. This value will be URL-encoded.
677
+ *
678
+ * @example ","
679
+ * @example "+"
680
+ * @default " "
681
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc6749#section-3.3} Scope separators information from OAuth 2.0 specification
682
+ */
683
+ scopeSeparator?: string;
684
+ /**
685
+ * When enabled, the client credentials (i.e., `client_id` and `client_secret`) are sent in the request body (NOT recommended).
686
+ * When disabled (the default), client credentials are sent using the HTTP Basic Authentication scheme.
687
+ *
688
+ * This is applicable for all requests to the token endpoint.
689
+ *
690
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc6749#section-2.3.1}
691
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc6749#section-3.2}
692
+ *
693
+ * @example true
694
+ * @default false
695
+ */
696
+ useInsecureClientAuthentication?: boolean;
697
+ };
662
698
  [PARAMETER_ORDERING]: ('body' | 'cookie' | 'form' | 'header' | 'path' | 'query')[];
663
699
  [PROXY_ENABLED]: boolean;
664
700
  [SAMPLES_LANGUAGES]: string[];
@@ -683,4 +719,4 @@ declare function getExtension(extension: string | keyof Extensions, api: OASDocu
683
719
  */
684
720
  declare function validateParameterOrdering(ordering: (typeof extensionDefaults)[typeof PARAMETER_ORDERING] | undefined, extension: string): void;
685
721
 
686
- export { Callback as C, DISABLE_TAG_SORTING as D, type Extensions as E, HEADERS as H, METRICS_ENABLED as M, Operation as O, PARAMETER_ORDERING as P, type SchemaWrapper as S, Webhook as W, getParametersAsJSONSchema as a, CODE_SAMPLES as b, EXPLORER_ENABLED as c, PROXY_ENABLED as d, SAMPLES_LANGUAGES as e, SIMPLE_MODE as f, type getParametersAsJSONSchemaOptions as g, extensionDefaults as h, hasRootExtension as i, getExtension as j, types as t, validateParameterOrdering as v };
722
+ export { Callback as C, DISABLE_TAG_SORTING as D, type Extensions as E, HEADERS as H, METRICS_ENABLED as M, Operation as O, PARAMETER_ORDERING as P, type SchemaWrapper as S, Webhook as W, getParametersAsJSONSchema as a, CODE_SAMPLES as b, EXPLORER_ENABLED as c, OAUTH_OPTIONS as d, PROXY_ENABLED as e, SAMPLES_LANGUAGES as f, type getParametersAsJSONSchemaOptions as g, SIMPLE_MODE as h, extensionDefaults as i, hasRootExtension as j, getExtension as k, types as t, validateParameterOrdering as v };
@@ -12,8 +12,8 @@
12
12
 
13
13
 
14
14
 
15
- var _chunkXWUEF5DOcjs = require('./chunk-XWUEF5DO.cjs');
16
15
 
16
+ var _chunkYHO3AOX6cjs = require('./chunk-YHO3AOX6.cjs');
17
17
 
18
18
 
19
19
 
@@ -27,5 +27,7 @@ var _chunkXWUEF5DOcjs = require('./chunk-XWUEF5DO.cjs');
27
27
 
28
28
 
29
29
 
30
- exports.CODE_SAMPLES = _chunkXWUEF5DOcjs.CODE_SAMPLES; exports.DISABLE_TAG_SORTING = _chunkXWUEF5DOcjs.DISABLE_TAG_SORTING; exports.EXPLORER_ENABLED = _chunkXWUEF5DOcjs.EXPLORER_ENABLED; exports.HEADERS = _chunkXWUEF5DOcjs.HEADERS; exports.METRICS_ENABLED = _chunkXWUEF5DOcjs.METRICS_ENABLED; exports.PARAMETER_ORDERING = _chunkXWUEF5DOcjs.PARAMETER_ORDERING; exports.PROXY_ENABLED = _chunkXWUEF5DOcjs.PROXY_ENABLED; exports.SAMPLES_LANGUAGES = _chunkXWUEF5DOcjs.SAMPLES_LANGUAGES; exports.SIMPLE_MODE = _chunkXWUEF5DOcjs.SIMPLE_MODE; exports.extensionDefaults = _chunkXWUEF5DOcjs.extensionDefaults; exports.getExtension = _chunkXWUEF5DOcjs.getExtension; exports.hasRootExtension = _chunkXWUEF5DOcjs.hasRootExtension; exports.validateParameterOrdering = _chunkXWUEF5DOcjs.validateParameterOrdering;
30
+
31
+
32
+ exports.CODE_SAMPLES = _chunkYHO3AOX6cjs.CODE_SAMPLES; exports.DISABLE_TAG_SORTING = _chunkYHO3AOX6cjs.DISABLE_TAG_SORTING; exports.EXPLORER_ENABLED = _chunkYHO3AOX6cjs.EXPLORER_ENABLED; exports.HEADERS = _chunkYHO3AOX6cjs.HEADERS; exports.METRICS_ENABLED = _chunkYHO3AOX6cjs.METRICS_ENABLED; exports.OAUTH_OPTIONS = _chunkYHO3AOX6cjs.OAUTH_OPTIONS; exports.PARAMETER_ORDERING = _chunkYHO3AOX6cjs.PARAMETER_ORDERING; exports.PROXY_ENABLED = _chunkYHO3AOX6cjs.PROXY_ENABLED; exports.SAMPLES_LANGUAGES = _chunkYHO3AOX6cjs.SAMPLES_LANGUAGES; exports.SIMPLE_MODE = _chunkYHO3AOX6cjs.SIMPLE_MODE; exports.extensionDefaults = _chunkYHO3AOX6cjs.extensionDefaults; exports.getExtension = _chunkYHO3AOX6cjs.getExtension; exports.hasRootExtension = _chunkYHO3AOX6cjs.hasRootExtension; exports.validateParameterOrdering = _chunkYHO3AOX6cjs.validateParameterOrdering;
31
33
  //# sourceMappingURL=extensions.cjs.map
@@ -1,4 +1,4 @@
1
- export { b as CODE_SAMPLES, D as DISABLE_TAG_SORTING, c as EXPLORER_ENABLED, E as Extensions, H as HEADERS, M as METRICS_ENABLED, P as PARAMETER_ORDERING, d as PROXY_ENABLED, e as SAMPLES_LANGUAGES, f as SIMPLE_MODE, h as extensionDefaults, j as getExtension, i as hasRootExtension, v as validateParameterOrdering } from './extensions-qzNCq0DK.cjs';
1
+ export { b as CODE_SAMPLES, D as DISABLE_TAG_SORTING, c as EXPLORER_ENABLED, E as Extensions, H as HEADERS, M as METRICS_ENABLED, d as OAUTH_OPTIONS, P as PARAMETER_ORDERING, e as PROXY_ENABLED, f as SAMPLES_LANGUAGES, h as SIMPLE_MODE, i as extensionDefaults, k as getExtension, j as hasRootExtension, v as validateParameterOrdering } from './extensions-BgSADIb5.cjs';
2
2
  import './types.cjs';
3
3
  import 'json-schema';
4
4
  import 'openapi-types';
@@ -1,4 +1,4 @@
1
- export { b as CODE_SAMPLES, D as DISABLE_TAG_SORTING, c as EXPLORER_ENABLED, E as Extensions, H as HEADERS, M as METRICS_ENABLED, P as PARAMETER_ORDERING, d as PROXY_ENABLED, e as SAMPLES_LANGUAGES, f as SIMPLE_MODE, h as extensionDefaults, j as getExtension, i as hasRootExtension, v as validateParameterOrdering } from './extensions-CxJyLZaY.js';
1
+ export { b as CODE_SAMPLES, D as DISABLE_TAG_SORTING, c as EXPLORER_ENABLED, E as Extensions, H as HEADERS, M as METRICS_ENABLED, d as OAUTH_OPTIONS, P as PARAMETER_ORDERING, e as PROXY_ENABLED, f as SAMPLES_LANGUAGES, h as SIMPLE_MODE, i as extensionDefaults, k as getExtension, j as hasRootExtension, v as validateParameterOrdering } from './extensions-pEeRZhXP.js';
2
2
  import './types.js';
3
3
  import 'json-schema';
4
4
  import 'openapi-types';
@@ -4,6 +4,7 @@ import {
4
4
  EXPLORER_ENABLED,
5
5
  HEADERS,
6
6
  METRICS_ENABLED,
7
+ OAUTH_OPTIONS,
7
8
  PARAMETER_ORDERING,
8
9
  PROXY_ENABLED,
9
10
  SAMPLES_LANGUAGES,
@@ -12,13 +13,14 @@ import {
12
13
  getExtension,
13
14
  hasRootExtension,
14
15
  validateParameterOrdering
15
- } from "./chunk-JCLIAFTG.js";
16
+ } from "./chunk-P2SB77YR.js";
16
17
  export {
17
18
  CODE_SAMPLES,
18
19
  DISABLE_TAG_SORTING,
19
20
  EXPLORER_ENABLED,
20
21
  HEADERS,
21
22
  METRICS_ENABLED,
23
+ OAUTH_OPTIONS,
22
24
  PARAMETER_ORDERING,
23
25
  PROXY_ENABLED,
24
26
  SAMPLES_LANGUAGES,
package/dist/index.cjs CHANGED
@@ -1,14 +1,14 @@
1
1
  "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
2
 
3
- var _chunkTKJRRBN7cjs = require('./chunk-TKJRRBN7.cjs');
4
- require('./chunk-3CBAAWG2.cjs');
3
+ var _chunkYX5TCZYWcjs = require('./chunk-YX5TCZYW.cjs');
4
+ require('./chunk-3FVUMJJI.cjs');
5
5
  require('./chunk-VIIXOUMH.cjs');
6
- require('./chunk-OCUXVRES.cjs');
7
- require('./chunk-XWUEF5DO.cjs');
8
- require('./chunk-6QHUSSDH.cjs');
6
+ require('./chunk-OD3GKGB2.cjs');
7
+ require('./chunk-YHO3AOX6.cjs');
8
+ require('./chunk-G6ASGSM5.cjs');
9
9
 
10
10
 
11
- exports.default = _chunkTKJRRBN7cjs.Oas;
11
+ exports.default = _chunkYX5TCZYWcjs.Oas;
12
12
 
13
13
  module.exports = exports.default;
14
14
  //# sourceMappingURL=index.cjs.map
package/dist/index.d.cts CHANGED
@@ -1,6 +1,6 @@
1
1
  import * as openapi_types from 'openapi-types';
2
- import { O as Operation, W as Webhook, E as Extensions } from './extensions-qzNCq0DK.cjs';
3
- import { OASDocument, User, HttpMethods, PathsObject } from './types.cjs';
2
+ import { O as Operation, W as Webhook, E as Extensions } from './extensions-BgSADIb5.cjs';
3
+ import { OASDocument, User, ServerVariable, HttpMethods, PathsObject } from './types.cjs';
4
4
  import { Match, ParamData } from 'path-to-regexp';
5
5
  import 'json-schema';
6
6
 
@@ -16,11 +16,6 @@ interface PathMatch {
16
16
  };
17
17
  }
18
18
  type PathMatches = PathMatch[];
19
- type Variables = Record<string, {
20
- default?: number | string;
21
- }[] | number | string | {
22
- default?: number | string;
23
- }>;
24
19
  declare class Oas {
25
20
  /**
26
21
  * An OpenAPI API Definition.
@@ -73,23 +68,37 @@ declare class Oas {
73
68
  *
74
69
  */
75
70
  getDefinition(): OASDocument;
76
- url(selected?: number, variables?: Variables): string;
71
+ url(selected?: number, variables?: ServerVariable): string;
77
72
  variables(selected?: number): {
78
73
  [variable: string]: openapi_types.OpenAPIV3.ServerVariableObject;
79
74
  };
80
- defaultVariables(selected?: number): Record<string, unknown>;
75
+ defaultVariables(selected?: number): ServerVariable;
81
76
  splitUrl(selected?: number): ({
82
- type: string;
83
- value: string;
77
+ /**
78
+ * A unique key, where the `value` is concatenated to its index
79
+ */
84
80
  key: string;
85
- description?: undefined;
86
- enum?: undefined;
87
- } | {
88
- type: string;
81
+ type: 'text';
89
82
  value: string;
83
+ } | {
84
+ /**
85
+ * An optional description for the server variable.
86
+ *
87
+ * @see {@link https://spec.openapis.org/oas/v3.1.0#fixed-fields-4}
88
+ */
89
+ description?: string;
90
+ /**
91
+ * An enumeration of string values to be used if the substitution options are from a limited set.
92
+ *
93
+ * @see {@link https://spec.openapis.org/oas/v3.1.0#fixed-fields-4}
94
+ */
95
+ enum?: string[];
96
+ /**
97
+ * A unique key, where the `value` is concatenated to its index
98
+ */
90
99
  key: string;
91
- description: string;
92
- enum: string[];
100
+ type: 'variable';
101
+ value: string;
93
102
  })[];
94
103
  /**
95
104
  * With a fully composed server URL, run through our list of known OAS servers and return back
@@ -128,7 +137,7 @@ declare class Oas {
128
137
  * @param url A URL to swap variables into.
129
138
  * @param variables An object containing variables to swap into the URL.
130
139
  */
131
- replaceUrl(url: string, variables?: Variables): string;
140
+ replaceUrl(url: string, variables?: ServerVariable): string;
132
141
  /**
133
142
  * Retrieve an Operation of Webhook class instance for a given path and method.
134
143
  *
package/dist/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import * as openapi_types from 'openapi-types';
2
- import { O as Operation, W as Webhook, E as Extensions } from './extensions-CxJyLZaY.js';
3
- import { OASDocument, User, HttpMethods, PathsObject } from './types.js';
2
+ import { O as Operation, W as Webhook, E as Extensions } from './extensions-pEeRZhXP.js';
3
+ import { OASDocument, User, ServerVariable, HttpMethods, PathsObject } from './types.js';
4
4
  import { Match, ParamData } from 'path-to-regexp';
5
5
  import 'json-schema';
6
6
 
@@ -16,11 +16,6 @@ interface PathMatch {
16
16
  };
17
17
  }
18
18
  type PathMatches = PathMatch[];
19
- type Variables = Record<string, {
20
- default?: number | string;
21
- }[] | number | string | {
22
- default?: number | string;
23
- }>;
24
19
  declare class Oas {
25
20
  /**
26
21
  * An OpenAPI API Definition.
@@ -73,23 +68,37 @@ declare class Oas {
73
68
  *
74
69
  */
75
70
  getDefinition(): OASDocument;
76
- url(selected?: number, variables?: Variables): string;
71
+ url(selected?: number, variables?: ServerVariable): string;
77
72
  variables(selected?: number): {
78
73
  [variable: string]: openapi_types.OpenAPIV3.ServerVariableObject;
79
74
  };
80
- defaultVariables(selected?: number): Record<string, unknown>;
75
+ defaultVariables(selected?: number): ServerVariable;
81
76
  splitUrl(selected?: number): ({
82
- type: string;
83
- value: string;
77
+ /**
78
+ * A unique key, where the `value` is concatenated to its index
79
+ */
84
80
  key: string;
85
- description?: undefined;
86
- enum?: undefined;
87
- } | {
88
- type: string;
81
+ type: 'text';
89
82
  value: string;
83
+ } | {
84
+ /**
85
+ * An optional description for the server variable.
86
+ *
87
+ * @see {@link https://spec.openapis.org/oas/v3.1.0#fixed-fields-4}
88
+ */
89
+ description?: string;
90
+ /**
91
+ * An enumeration of string values to be used if the substitution options are from a limited set.
92
+ *
93
+ * @see {@link https://spec.openapis.org/oas/v3.1.0#fixed-fields-4}
94
+ */
95
+ enum?: string[];
96
+ /**
97
+ * A unique key, where the `value` is concatenated to its index
98
+ */
90
99
  key: string;
91
- description: string;
92
- enum: string[];
100
+ type: 'variable';
101
+ value: string;
93
102
  })[];
94
103
  /**
95
104
  * With a fully composed server URL, run through our list of known OAS servers and return back
@@ -128,7 +137,7 @@ declare class Oas {
128
137
  * @param url A URL to swap variables into.
129
138
  * @param variables An object containing variables to swap into the URL.
130
139
  */
131
- replaceUrl(url: string, variables?: Variables): string;
140
+ replaceUrl(url: string, variables?: ServerVariable): string;
132
141
  /**
133
142
  * Retrieve an Operation of Webhook class instance for a given path and method.
134
143
  *
package/dist/index.js CHANGED
@@ -1,11 +1,11 @@
1
1
  import {
2
2
  Oas
3
- } from "./chunk-D6YGEKAS.js";
4
- import "./chunk-7KGYHFQ2.js";
3
+ } from "./chunk-2PJJRTP6.js";
4
+ import "./chunk-J2PK2DSN.js";
5
5
  import "./chunk-SITXIAYE.js";
6
- import "./chunk-BALOBQT5.js";
7
- import "./chunk-JCLIAFTG.js";
8
- import "./chunk-XPA5KLS5.js";
6
+ import "./chunk-F65XXTLV.js";
7
+ import "./chunk-P2SB77YR.js";
8
+ import "./chunk-U7Q7XPMY.js";
9
9
  export {
10
10
  Oas as default
11
11
  };
@@ -2,14 +2,14 @@
2
2
 
3
3
 
4
4
 
5
- var _chunk3CBAAWG2cjs = require('../chunk-3CBAAWG2.cjs');
5
+ var _chunk3FVUMJJIcjs = require('../chunk-3FVUMJJI.cjs');
6
6
  require('../chunk-VIIXOUMH.cjs');
7
- require('../chunk-OCUXVRES.cjs');
8
- require('../chunk-XWUEF5DO.cjs');
9
- require('../chunk-6QHUSSDH.cjs');
7
+ require('../chunk-OD3GKGB2.cjs');
8
+ require('../chunk-YHO3AOX6.cjs');
9
+ require('../chunk-G6ASGSM5.cjs');
10
10
 
11
11
 
12
12
 
13
13
 
14
- exports.Callback = _chunk3CBAAWG2cjs.Callback; exports.Operation = _chunk3CBAAWG2cjs.Operation; exports.Webhook = _chunk3CBAAWG2cjs.Webhook;
14
+ exports.Callback = _chunk3FVUMJJIcjs.Callback; exports.Operation = _chunk3FVUMJJIcjs.Operation; exports.Webhook = _chunk3FVUMJJIcjs.Webhook;
15
15
  //# sourceMappingURL=index.cjs.map
@@ -1,4 +1,4 @@
1
- export { C as Callback, O as Operation, W as Webhook } from '../extensions-qzNCq0DK.cjs';
1
+ export { C as Callback, O as Operation, W as Webhook } from '../extensions-BgSADIb5.cjs';
2
2
  import '../types.cjs';
3
3
  import 'json-schema';
4
4
  import 'openapi-types';
@@ -1,4 +1,4 @@
1
- export { C as Callback, O as Operation, W as Webhook } from '../extensions-CxJyLZaY.js';
1
+ export { C as Callback, O as Operation, W as Webhook } from '../extensions-pEeRZhXP.js';
2
2
  import '../types.js';
3
3
  import 'json-schema';
4
4
  import 'openapi-types';
@@ -2,11 +2,11 @@ import {
2
2
  Callback,
3
3
  Operation,
4
4
  Webhook
5
- } from "../chunk-7KGYHFQ2.js";
5
+ } from "../chunk-J2PK2DSN.js";
6
6
  import "../chunk-SITXIAYE.js";
7
- import "../chunk-BALOBQT5.js";
8
- import "../chunk-JCLIAFTG.js";
9
- import "../chunk-XPA5KLS5.js";
7
+ import "../chunk-F65XXTLV.js";
8
+ import "../chunk-P2SB77YR.js";
9
+ import "../chunk-U7Q7XPMY.js";
10
10
  export {
11
11
  Callback,
12
12
  Operation,
@@ -1,11 +1,11 @@
1
1
  "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
2
 
3
3
 
4
- var _chunkOCUXVREScjs = require('../../chunk-OCUXVRES.cjs');
5
- require('../../chunk-XWUEF5DO.cjs');
6
- require('../../chunk-6QHUSSDH.cjs');
4
+ var _chunkOD3GKGB2cjs = require('../../chunk-OD3GKGB2.cjs');
5
+ require('../../chunk-YHO3AOX6.cjs');
6
+ require('../../chunk-G6ASGSM5.cjs');
7
7
 
8
8
 
9
9
 
10
- exports.getParametersAsJSONSchema = _chunkOCUXVREScjs.getParametersAsJSONSchema; exports.types = _chunkOCUXVREScjs.types;
10
+ exports.getParametersAsJSONSchema = _chunkOD3GKGB2cjs.getParametersAsJSONSchema; exports.types = _chunkOD3GKGB2cjs.types;
11
11
  //# sourceMappingURL=get-parameters-as-json-schema.cjs.map
@@ -1,4 +1,4 @@
1
1
  import '../../types.cjs';
2
- export { S as SchemaWrapper, a as getParametersAsJSONSchema, g as getParametersAsJSONSchemaOptions, t as types } from '../../extensions-qzNCq0DK.cjs';
2
+ export { S as SchemaWrapper, a as getParametersAsJSONSchema, g as getParametersAsJSONSchemaOptions, t as types } from '../../extensions-BgSADIb5.cjs';
3
3
  import 'json-schema';
4
4
  import 'openapi-types';
@@ -1,4 +1,4 @@
1
1
  import '../../types.js';
2
- export { S as SchemaWrapper, a as getParametersAsJSONSchema, g as getParametersAsJSONSchemaOptions, t as types } from '../../extensions-CxJyLZaY.js';
2
+ export { S as SchemaWrapper, a as getParametersAsJSONSchema, g as getParametersAsJSONSchemaOptions, t as types } from '../../extensions-pEeRZhXP.js';
3
3
  import 'json-schema';
4
4
  import 'openapi-types';
@@ -1,9 +1,9 @@
1
1
  import {
2
2
  getParametersAsJSONSchema,
3
3
  types
4
- } from "../../chunk-BALOBQT5.js";
5
- import "../../chunk-JCLIAFTG.js";
6
- import "../../chunk-XPA5KLS5.js";
4
+ } from "../../chunk-F65XXTLV.js";
5
+ import "../../chunk-P2SB77YR.js";
6
+ import "../../chunk-U7Q7XPMY.js";
7
7
  export {
8
8
  getParametersAsJSONSchema,
9
9
  types
package/dist/types.cjs CHANGED
@@ -2,10 +2,10 @@
2
2
 
3
3
 
4
4
 
5
- var _chunk6QHUSSDHcjs = require('./chunk-6QHUSSDH.cjs');
5
+ var _chunkG6ASGSM5cjs = require('./chunk-G6ASGSM5.cjs');
6
6
 
7
7
 
8
8
 
9
9
 
10
- exports.isOAS31 = _chunk6QHUSSDHcjs.isOAS31; exports.isRef = _chunk6QHUSSDHcjs.isRef; exports.isSchema = _chunk6QHUSSDHcjs.isSchema;
10
+ exports.isOAS31 = _chunkG6ASGSM5cjs.isOAS31; exports.isRef = _chunkG6ASGSM5cjs.isRef; exports.isSchema = _chunkG6ASGSM5cjs.isSchema;
11
11
  //# sourceMappingURL=types.cjs.map
package/dist/types.d.cts CHANGED
@@ -26,7 +26,7 @@ interface DataForHAR {
26
26
  query?: Record<string, any>;
27
27
  server?: {
28
28
  selected: number;
29
- variables?: Record<string, unknown>;
29
+ variables?: ServerVariable;
30
30
  };
31
31
  }
32
32
  interface User {
package/dist/types.d.ts CHANGED
@@ -26,7 +26,7 @@ interface DataForHAR {
26
26
  query?: Record<string, any>;
27
27
  server?: {
28
28
  selected: number;
29
- variables?: Record<string, unknown>;
29
+ variables?: ServerVariable;
30
30
  };
31
31
  }
32
32
  interface User {
package/dist/types.js CHANGED
@@ -2,7 +2,7 @@ import {
2
2
  isOAS31,
3
3
  isRef,
4
4
  isSchema
5
- } from "./chunk-XPA5KLS5.js";
5
+ } from "./chunk-U7Q7XPMY.js";
6
6
  export {
7
7
  isOAS31,
8
8
  isRef,
package/dist/utils.cjs CHANGED
@@ -5,13 +5,13 @@ var _chunkVIIXOUMHcjs = require('./chunk-VIIXOUMH.cjs');
5
5
 
6
6
 
7
7
 
8
- var _chunkOCUXVREScjs = require('./chunk-OCUXVRES.cjs');
9
- require('./chunk-XWUEF5DO.cjs');
10
- require('./chunk-6QHUSSDH.cjs');
8
+ var _chunkOD3GKGB2cjs = require('./chunk-OD3GKGB2.cjs');
9
+ require('./chunk-YHO3AOX6.cjs');
10
+ require('./chunk-G6ASGSM5.cjs');
11
11
 
12
12
 
13
13
 
14
14
 
15
15
 
16
- exports.findSchemaDefinition = _chunkVIIXOUMHcjs.findSchemaDefinition; exports.jsonSchemaTypes = _chunkOCUXVREScjs.types; exports.matchesMimeType = _chunkOCUXVREScjs.matches_mimetype_default; exports.supportedMethods = _chunkVIIXOUMHcjs.supportedMethods;
16
+ exports.findSchemaDefinition = _chunkVIIXOUMHcjs.findSchemaDefinition; exports.jsonSchemaTypes = _chunkOD3GKGB2cjs.types; exports.matchesMimeType = _chunkOD3GKGB2cjs.matches_mimetype_default; exports.supportedMethods = _chunkVIIXOUMHcjs.supportedMethods;
17
17
  //# sourceMappingURL=utils.cjs.map
package/dist/utils.d.cts CHANGED
@@ -1,4 +1,4 @@
1
- export { t as jsonSchemaTypes } from './extensions-qzNCq0DK.cjs';
1
+ export { t as jsonSchemaTypes } from './extensions-BgSADIb5.cjs';
2
2
  import './types.cjs';
3
3
  import 'json-schema';
4
4
  import 'openapi-types';
package/dist/utils.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export { t as jsonSchemaTypes } from './extensions-CxJyLZaY.js';
1
+ export { t as jsonSchemaTypes } from './extensions-pEeRZhXP.js';
2
2
  import './types.js';
3
3
  import 'json-schema';
4
4
  import 'openapi-types';
package/dist/utils.js CHANGED
@@ -5,9 +5,9 @@ import {
5
5
  import {
6
6
  matches_mimetype_default,
7
7
  types
8
- } from "./chunk-BALOBQT5.js";
9
- import "./chunk-JCLIAFTG.js";
10
- import "./chunk-XPA5KLS5.js";
8
+ } from "./chunk-F65XXTLV.js";
9
+ import "./chunk-P2SB77YR.js";
10
+ import "./chunk-U7Q7XPMY.js";
11
11
  export {
12
12
  findSchemaDefinition,
13
13
  types as jsonSchemaTypes,