@scalar/oas-utils 0.2.121 → 0.2.123

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 (202) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/dist/entities/cookie/cookie.d.ts +4 -4
  3. package/dist/entities/cookie/cookie.js +1 -1
  4. package/dist/entities/cookie/index.d.ts +1 -1
  5. package/dist/entities/cookie/index.d.ts.map +1 -1
  6. package/dist/entities/environment/environment.d.ts +2 -2
  7. package/dist/entities/environment/environment.js +1 -1
  8. package/dist/entities/environment/index.d.ts +1 -1
  9. package/dist/entities/environment/index.d.ts.map +1 -1
  10. package/dist/entities/hotkeys/index.d.ts +1 -1
  11. package/dist/entities/hotkeys/index.d.ts.map +1 -1
  12. package/dist/entities/shared/index.d.ts +1 -1
  13. package/dist/entities/shared/index.d.ts.map +1 -1
  14. package/dist/entities/shared/index.js +1 -1
  15. package/dist/entities/shared/utility.d.ts +0 -16
  16. package/dist/entities/shared/utility.d.ts.map +1 -1
  17. package/dist/entities/shared/utility.js +1 -8
  18. package/dist/entities/spec/collection.d.ts +24 -24
  19. package/dist/entities/spec/collection.d.ts.map +1 -1
  20. package/dist/entities/spec/collection.js +3 -2
  21. package/dist/entities/spec/index.d.ts +10 -11
  22. package/dist/entities/spec/index.d.ts.map +1 -1
  23. package/dist/entities/spec/index.js +8 -8
  24. package/dist/entities/spec/operation.d.ts +23 -23
  25. package/dist/entities/spec/operation.d.ts.map +1 -1
  26. package/dist/entities/spec/parameters.d.ts +6 -6
  27. package/dist/entities/spec/request-examples.d.ts +244 -244
  28. package/dist/entities/spec/request-examples.d.ts.map +1 -1
  29. package/dist/entities/spec/request-examples.js +6 -71
  30. package/dist/entities/spec/requests.d.ts +47 -47
  31. package/dist/entities/spec/requests.d.ts.map +1 -1
  32. package/dist/entities/spec/requests.js +3 -2
  33. package/dist/entities/spec/security.d.ts +39 -39
  34. package/dist/entities/spec/security.d.ts.map +1 -1
  35. package/dist/entities/spec/security.js +4 -4
  36. package/dist/entities/spec/server.d.ts +99 -28
  37. package/dist/entities/spec/server.d.ts.map +1 -1
  38. package/dist/entities/spec/server.js +1 -1
  39. package/dist/entities/spec/spec-objects.d.ts +3 -3
  40. package/dist/entities/spec/spec-objects.js +1 -1
  41. package/dist/entities/spec/x-scalar-environments.d.ts +9 -9
  42. package/dist/entities/spec/x-scalar-secrets.d.ts +4 -4
  43. package/dist/entities/workspace/index.d.ts +1 -1
  44. package/dist/entities/workspace/index.d.ts.map +1 -1
  45. package/dist/entities/workspace/workspace.d.ts +18 -18
  46. package/dist/entities/workspace/workspace.js +1 -1
  47. package/dist/helpers/{createHash.d.ts → create-hash.d.ts} +1 -1
  48. package/dist/helpers/create-hash.d.ts.map +1 -0
  49. package/dist/helpers/ensure-protocol.js +1 -1
  50. package/dist/helpers/{fetchSpecFromUrl.d.ts → fetch-spec-from-url.d.ts} +1 -1
  51. package/dist/helpers/fetch-spec-from-url.d.ts.map +1 -0
  52. package/dist/helpers/{fetchSpecFromUrl.js → fetch-spec-from-url.js} +1 -1
  53. package/dist/helpers/{fetchWithProxyFallback.d.ts → fetch-with-proxy-fallback.d.ts} +1 -1
  54. package/dist/helpers/fetch-with-proxy-fallback.d.ts.map +1 -0
  55. package/dist/helpers/{fetchWithProxyFallback.js → fetch-with-proxy-fallback.js} +1 -1
  56. package/dist/helpers/find-variables.d.ts +5 -0
  57. package/dist/helpers/find-variables.d.ts.map +1 -0
  58. package/dist/helpers/{findVariables.js → find-variables.js} +1 -1
  59. package/dist/helpers/{httpMethods.d.ts → http-methods.d.ts} +2 -2
  60. package/dist/helpers/http-methods.d.ts.map +1 -0
  61. package/dist/helpers/{httpStatusCodes.d.ts → http-status-codes.d.ts} +1 -1
  62. package/dist/helpers/http-status-codes.d.ts.map +1 -0
  63. package/dist/helpers/index.d.ts +27 -26
  64. package/dist/helpers/index.d.ts.map +1 -1
  65. package/dist/helpers/index.js +21 -20
  66. package/dist/helpers/{isLocalUrl.d.ts → is-local-url.d.ts} +1 -1
  67. package/dist/helpers/is-local-url.d.ts.map +1 -0
  68. package/dist/helpers/{isValidUrl.d.ts → is-valid-url.d.ts} +1 -1
  69. package/dist/helpers/is-valid-url.d.ts.map +1 -0
  70. package/dist/helpers/{iterateTitle.d.ts → iterate-title.d.ts} +1 -1
  71. package/dist/helpers/iterate-title.d.ts.map +1 -0
  72. package/dist/helpers/{makeUrlAbsolute.d.ts → make-url-absolute.d.ts} +1 -1
  73. package/dist/helpers/make-url-absolute.d.ts.map +1 -0
  74. package/dist/helpers/merge-urls.d.ts.map +1 -1
  75. package/dist/helpers/merge-urls.js +2 -2
  76. package/dist/helpers/{normalizeMimeTypeObject.d.ts → normalize-mime-type-object.d.ts} +1 -1
  77. package/dist/helpers/normalize-mime-type-object.d.ts.map +1 -0
  78. package/dist/helpers/{normalizeMimeTypeObject.js → normalize-mime-type-object.js} +1 -1
  79. package/dist/helpers/{normalizeMimeType.d.ts → normalize-mime-type.d.ts} +1 -1
  80. package/dist/helpers/normalize-mime-type.d.ts.map +1 -0
  81. package/dist/helpers/parse.js +1 -1
  82. package/dist/helpers/{prettyPrintJson.d.ts → pretty-print-json.d.ts} +1 -1
  83. package/dist/helpers/pretty-print-json.d.ts.map +1 -0
  84. package/dist/helpers/{redirectToProxy.d.ts → redirect-to-proxy.d.ts} +1 -1
  85. package/dist/helpers/redirect-to-proxy.d.ts.map +1 -0
  86. package/dist/helpers/{redirectToProxy.js → redirect-to-proxy.js} +2 -2
  87. package/dist/helpers/{regexHelpers.d.ts → regex-helpers.d.ts} +1 -1
  88. package/dist/helpers/regex-helpers.d.ts.map +1 -0
  89. package/dist/helpers/{replaceVariables.d.ts → replace-variables.d.ts} +1 -1
  90. package/dist/helpers/replace-variables.d.ts.map +1 -0
  91. package/dist/helpers/{shouldIgnoreEntity.d.ts → should-ignore-entity.d.ts} +3 -2
  92. package/dist/helpers/should-ignore-entity.d.ts.map +1 -0
  93. package/dist/helpers/{ssrState.d.ts → ssr-state.d.ts} +1 -1
  94. package/dist/helpers/ssr-state.d.ts.map +1 -0
  95. package/dist/helpers/string.d.ts.map +1 -1
  96. package/dist/helpers/string.js +1 -1
  97. package/dist/migrations/index.d.ts +3 -3
  98. package/dist/migrations/index.d.ts.map +1 -1
  99. package/dist/migrations/local-storage.d.ts +1 -1
  100. package/dist/migrations/local-storage.d.ts.map +1 -1
  101. package/dist/migrations/migrator.d.ts +1 -1
  102. package/dist/migrations/migrator.d.ts.map +1 -1
  103. package/dist/migrations/semver.js +1 -1
  104. package/dist/migrations/v-2.1.0/migration.d.ts +2 -2
  105. package/dist/migrations/v-2.1.0/migration.d.ts.map +1 -1
  106. package/dist/migrations/v-2.1.0/migration.js +1 -1
  107. package/dist/migrations/v-2.2.0/migration.d.ts +2 -2
  108. package/dist/migrations/v-2.2.0/migration.d.ts.map +1 -1
  109. package/dist/migrations/v-2.3.0/migration.d.ts +2 -2
  110. package/dist/migrations/v-2.3.0/migration.d.ts.map +1 -1
  111. package/dist/migrations/v-2.4.0/migration.d.ts +2 -2
  112. package/dist/migrations/v-2.4.0/migration.d.ts.map +1 -1
  113. package/dist/migrations/v-2.5.0/migration.d.ts +2 -2
  114. package/dist/migrations/v-2.5.0/migration.d.ts.map +1 -1
  115. package/dist/migrations/v-2.5.0/migration.js +2 -3
  116. package/dist/migrations/v-2.5.0/types.generated.d.ts +9 -4
  117. package/dist/migrations/v-2.5.0/types.generated.d.ts.map +1 -1
  118. package/dist/spec-getters/{getExampleFromSchema.d.ts → get-example-from-schema.d.ts} +1 -1
  119. package/dist/spec-getters/get-example-from-schema.d.ts.map +1 -0
  120. package/dist/spec-getters/{getParametersFromOperation.d.ts → get-parameters-from-operation.d.ts} +1 -1
  121. package/dist/spec-getters/get-parameters-from-operation.d.ts.map +1 -0
  122. package/dist/spec-getters/{getParametersFromOperation.js → get-parameters-from-operation.js} +1 -1
  123. package/dist/spec-getters/{getRequestBodyFromOperation.d.ts → get-request-body-from-operation.d.ts} +2 -2
  124. package/dist/spec-getters/get-request-body-from-operation.d.ts.map +1 -0
  125. package/dist/spec-getters/{getRequestBodyFromOperation.js → get-request-body-from-operation.js} +7 -7
  126. package/dist/spec-getters/{getServerVariableExamples.d.ts → get-server-variable-examples.d.ts} +2 -2
  127. package/dist/spec-getters/get-server-variable-examples.d.ts.map +1 -0
  128. package/dist/spec-getters/index.d.ts +4 -4
  129. package/dist/spec-getters/index.d.ts.map +1 -1
  130. package/dist/spec-getters/index.js +4 -4
  131. package/dist/transforms/import-spec.d.ts +7 -3
  132. package/dist/transforms/import-spec.d.ts.map +1 -1
  133. package/dist/transforms/import-spec.js +35 -26
  134. package/dist/transforms/index.d.ts +1 -1
  135. package/dist/transforms/index.d.ts.map +1 -1
  136. package/dist/transforms/index.js +1 -1
  137. package/package.json +7 -45
  138. package/dist/diff/diff.d.ts +0 -13
  139. package/dist/diff/diff.d.ts.map +0 -1
  140. package/dist/diff/diff.js +0 -41
  141. package/dist/diff/index.d.ts +0 -2
  142. package/dist/diff/index.d.ts.map +0 -1
  143. package/dist/diff/index.js +0 -1
  144. package/dist/entities/index.d.ts +0 -2
  145. package/dist/entities/index.d.ts.map +0 -1
  146. package/dist/entities/index.js +0 -1
  147. package/dist/helpers/createHash.d.ts.map +0 -1
  148. package/dist/helpers/fetchSpecFromUrl.d.ts.map +0 -1
  149. package/dist/helpers/fetchWithProxyFallback.d.ts.map +0 -1
  150. package/dist/helpers/findVariables.d.ts +0 -5
  151. package/dist/helpers/findVariables.d.ts.map +0 -1
  152. package/dist/helpers/httpMethods.d.ts.map +0 -1
  153. package/dist/helpers/httpStatusCodes.d.ts.map +0 -1
  154. package/dist/helpers/isLocalUrl.d.ts.map +0 -1
  155. package/dist/helpers/isValidUrl.d.ts.map +0 -1
  156. package/dist/helpers/iterateTitle.d.ts.map +0 -1
  157. package/dist/helpers/makeUrlAbsolute.d.ts.map +0 -1
  158. package/dist/helpers/normalizeMimeType.d.ts.map +0 -1
  159. package/dist/helpers/normalizeMimeTypeObject.d.ts.map +0 -1
  160. package/dist/helpers/prettyPrintJson.d.ts.map +0 -1
  161. package/dist/helpers/redirectToProxy.d.ts.map +0 -1
  162. package/dist/helpers/regexHelpers.d.ts.map +0 -1
  163. package/dist/helpers/replaceVariables.d.ts.map +0 -1
  164. package/dist/helpers/shouldIgnoreEntity.d.ts.map +0 -1
  165. package/dist/helpers/ssrState.d.ts.map +0 -1
  166. package/dist/migrations/v-0.0.0/index.d.ts +0 -2
  167. package/dist/migrations/v-0.0.0/index.d.ts.map +0 -1
  168. package/dist/migrations/v-0.0.0/index.js +0 -1
  169. package/dist/migrations/v-2.1.0/index.d.ts +0 -3
  170. package/dist/migrations/v-2.1.0/index.d.ts.map +0 -1
  171. package/dist/migrations/v-2.1.0/index.js +0 -1
  172. package/dist/migrations/v-2.2.0/index.d.ts +0 -3
  173. package/dist/migrations/v-2.2.0/index.d.ts.map +0 -1
  174. package/dist/migrations/v-2.2.0/index.js +0 -1
  175. package/dist/migrations/v-2.3.0/index.d.ts +0 -3
  176. package/dist/migrations/v-2.3.0/index.d.ts.map +0 -1
  177. package/dist/migrations/v-2.3.0/index.js +0 -1
  178. package/dist/migrations/v-2.4.0/index.d.ts +0 -3
  179. package/dist/migrations/v-2.4.0/index.d.ts.map +0 -1
  180. package/dist/migrations/v-2.4.0/index.js +0 -1
  181. package/dist/migrations/v-2.5.0/index.d.ts +0 -3
  182. package/dist/migrations/v-2.5.0/index.d.ts.map +0 -1
  183. package/dist/migrations/v-2.5.0/index.js +0 -1
  184. package/dist/spec-getters/getExampleFromSchema.d.ts.map +0 -1
  185. package/dist/spec-getters/getParametersFromOperation.d.ts.map +0 -1
  186. package/dist/spec-getters/getRequestBodyFromOperation.d.ts.map +0 -1
  187. package/dist/spec-getters/getServerVariableExamples.d.ts.map +0 -1
  188. /package/dist/helpers/{createHash.js → create-hash.js} +0 -0
  189. /package/dist/helpers/{httpMethods.js → http-methods.js} +0 -0
  190. /package/dist/helpers/{httpStatusCodes.js → http-status-codes.js} +0 -0
  191. /package/dist/helpers/{isLocalUrl.js → is-local-url.js} +0 -0
  192. /package/dist/helpers/{isValidUrl.js → is-valid-url.js} +0 -0
  193. /package/dist/helpers/{iterateTitle.js → iterate-title.js} +0 -0
  194. /package/dist/helpers/{makeUrlAbsolute.js → make-url-absolute.js} +0 -0
  195. /package/dist/helpers/{normalizeMimeType.js → normalize-mime-type.js} +0 -0
  196. /package/dist/helpers/{prettyPrintJson.js → pretty-print-json.js} +0 -0
  197. /package/dist/helpers/{regexHelpers.js → regex-helpers.js} +0 -0
  198. /package/dist/helpers/{replaceVariables.js → replace-variables.js} +0 -0
  199. /package/dist/helpers/{shouldIgnoreEntity.js → should-ignore-entity.js} +0 -0
  200. /package/dist/helpers/{ssrState.js → ssr-state.js} +0 -0
  201. /package/dist/spec-getters/{getExampleFromSchema.js → get-example-from-schema.js} +0 -0
  202. /package/dist/spec-getters/{getServerVariableExamples.js → get-server-variable-examples.js} +0 -0
@@ -1,4 +1,4 @@
1
- export * from './data-version.js';
2
- export * from './migrator.js';
3
- export * from './semver.js';
1
+ export { DATA_VERSION, DATA_VERSION_LS_LEY } from './data-version.ts';
2
+ export { migrator } from './migrator.ts';
3
+ export { semverLessThan } from './semver.ts';
4
4
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/migrations/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/migrations/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AACrE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA"}
@@ -1,4 +1,4 @@
1
- import type { LS_KEYS } from '../helpers/index.js';
1
+ import type { LS_KEYS } from '../helpers/local-storage.ts';
2
2
  /**
3
3
  * Supports pre-flatted local storage
4
4
  */
@@ -1 +1 @@
1
- {"version":3,"file":"local-storage.d.ts","sourceRoot":"","sources":["../../src/migrations/local-storage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAKxC;;GAEG;AACH,eAAO,MAAM,iBAAiB,UAAW,CAAC,OAAO,OAAO,EAAE,MAAM,OAAO,OAAO,CAAC,KAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAKvG,CAAA;AAED,oDAAoD;AACpD,eAAO,MAAM,sBAAsB,QAAO,MAyBzC,CAAA"}
1
+ {"version":3,"file":"local-storage.d.ts","sourceRoot":"","sources":["../../src/migrations/local-storage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAKzD;;GAEG;AACH,eAAO,MAAM,iBAAiB,UAAW,CAAC,OAAO,OAAO,EAAE,MAAM,OAAO,OAAO,CAAC,KAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAKvG,CAAA;AAED,oDAAoD;AACpD,eAAO,MAAM,sBAAsB,QAAO,MAyBzC,CAAA"}
@@ -1,4 +1,4 @@
1
- import { type v_2_5_0 } from '../migrations/v-2.5.0/index.js';
1
+ import type { v_2_5_0 } from '../migrations/v-2.5.0/types.generated.ts';
2
2
  /** Handles all data migrations per entity */
3
3
  export declare const migrator: () => v_2_5_0["DataArray"];
4
4
  //# sourceMappingURL=migrator.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"migrator.d.ts","sourceRoot":"","sources":["../../src/migrations/migrator.ts"],"names":[],"mappings":"AAMA,OAAO,EAAmB,KAAK,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAEpE,6CAA6C;AAC7C,eAAO,MAAM,QAAQ,QAAO,OAAO,CAAC,WAAW,CAoD9C,CAAA"}
1
+ {"version":3,"file":"migrator.d.ts","sourceRoot":"","sources":["../../src/migrations/migrator.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAA;AAEtE,6CAA6C;AAC7C,eAAO,MAAM,QAAQ,QAAO,OAAO,CAAC,WAAW,CAoD9C,CAAA"}
@@ -4,7 +4,7 @@
4
4
  const semverLessThan = (left, right) => {
5
5
  // Parse the strings into numbers
6
6
  const parseSemver = (version) => {
7
- const [major, minor = 0, patch = 0] = version.split('.').map((part) => Number.parseInt(part, 10));
7
+ const [major = 0, minor = 0, patch = 0] = version.split('.').map((part) => Number.parseInt(part, 10));
8
8
  return { major, minor, patch };
9
9
  };
10
10
  const { major: major1, minor: minor1, patch: patch1 } = parseSemver(left);
@@ -1,5 +1,5 @@
1
- import type { v_0_0_0 } from '../../migrations/v-0.0.0/types.generated';
2
- import type { v_2_1_0 } from './types.generated';
1
+ import type { v_0_0_0 } from '../../migrations/v-0.0.0/types.generated.ts';
2
+ import type { v_2_1_0 } from './types.generated.ts';
3
3
  /** V-0.0.0 to V-2.1.0 migration */
4
4
  export declare const migrate_v_2_1_0: (data: Omit<v_0_0_0.DataRecord, "folders">) => {
5
5
  collections: Record<string, v_2_1_0.Collection>;
@@ -1 +1 @@
1
- {"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.1.0/migration.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAA;AAEnE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAEhD,mCAAmC;AACnC,eAAO,MAAM,eAAe,SAAU,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC;;;;;;;;;;CA0UxE,CAAA"}
1
+ {"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.1.0/migration.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAA;AAEtE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAEnD,mCAAmC;AACnC,eAAO,MAAM,eAAe,SAAU,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC;;;;;;;;;;CA0UxE,CAAA"}
@@ -1,5 +1,5 @@
1
- import { parseLocalStorage } from '../local-storage.js';
2
1
  import { camelToTitleWords, capitalize } from '../../helpers/string.js';
2
+ import { parseLocalStorage } from '../local-storage.js';
3
3
 
4
4
  /** V-0.0.0 to V-2.1.0 migration */
5
5
  const migrate_v_2_1_0 = (data) => {
@@ -1,5 +1,5 @@
1
- import type { v_2_1_0 } from '../../migrations/v-2.1.0/types.generated';
2
- import type { v_2_2_0 } from './types.generated';
1
+ import type { v_2_1_0 } from '../../migrations/v-2.1.0/types.generated.ts';
2
+ import type { v_2_2_0 } from './types.generated.ts';
3
3
  /** V-2.1.0 to V-2.2.0 migration */
4
4
  export declare const migrate_v_2_2_0: (data: v_2_1_0.DataRecord) => v_2_2_0.DataRecord;
5
5
  //# sourceMappingURL=migration.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.2.0/migration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAA;AAEnE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAkGhD,mCAAmC;AACnC,eAAO,MAAM,eAAe,SAAU,OAAO,CAAC,UAAU,KAAG,OAAO,CAAC,UA6BlE,CAAA"}
1
+ {"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.2.0/migration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAA;AAEtE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAkGnD,mCAAmC;AACnC,eAAO,MAAM,eAAe,SAAU,OAAO,CAAC,UAAU,KAAG,OAAO,CAAC,UA6BlE,CAAA"}
@@ -1,5 +1,5 @@
1
- import type { v_2_2_0 } from '../../migrations/v-2.2.0/types.generated';
2
- import type { v_2_3_0 } from './types.generated';
1
+ import type { v_2_2_0 } from '../../migrations/v-2.2.0/types.generated.ts';
2
+ import type { v_2_3_0 } from './types.generated.ts';
3
3
  /** V-2.2.0 to V-2.3.0 migration */
4
4
  export declare const migrate_v_2_3_0: (data: v_2_2_0.DataRecord) => v_2_3_0.DataRecord;
5
5
  //# sourceMappingURL=migration.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.3.0/migration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAA;AAEnE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAEhD,mCAAmC;AACnC,eAAO,MAAM,eAAe,SAAU,OAAO,CAAC,UAAU,KAAG,OAAO,CAAC,UAqDlE,CAAA"}
1
+ {"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.3.0/migration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAA;AAEtE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAEnD,mCAAmC;AACnC,eAAO,MAAM,eAAe,SAAU,OAAO,CAAC,UAAU,KAAG,OAAO,CAAC,UAqDlE,CAAA"}
@@ -1,5 +1,5 @@
1
- import type { v_2_3_0 } from '../../migrations/v-2.3.0/types.generated';
2
- import type { v_2_4_0 } from './types.generated';
1
+ import type { v_2_3_0 } from '../../migrations/v-2.3.0/types.generated.ts';
2
+ import type { v_2_4_0 } from './types.generated.ts';
3
3
  /** V-2.3.0 to V-2.4.0 migration */
4
4
  export declare const migrate_v_2_4_0: (data: v_2_3_0.DataRecord) => v_2_4_0.DataRecord;
5
5
  //# sourceMappingURL=migration.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.4.0/migration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAA;AAEnE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAEhD,mCAAmC;AACnC,eAAO,MAAM,eAAe,SAAU,OAAO,CAAC,UAAU,KAAG,OAAO,CAAC,UA6BlE,CAAA"}
1
+ {"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.4.0/migration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAA;AAEtE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAEnD,mCAAmC;AACnC,eAAO,MAAM,eAAe,SAAU,OAAO,CAAC,UAAU,KAAG,OAAO,CAAC,UA6BlE,CAAA"}
@@ -1,5 +1,5 @@
1
- import type { v_2_4_0 } from '../../migrations/v-2.4.0/types.generated';
2
- import type { v_2_5_0 } from './types.generated';
1
+ import type { v_2_4_0 } from '../../migrations/v-2.4.0/types.generated.ts';
2
+ import type { v_2_5_0 } from './types.generated.ts';
3
3
  /** V-2.4.0 to V-2.5.0 migration */
4
4
  export declare const migrate_v_2_5_0: (data: v_2_4_0.DataRecord) => v_2_5_0["DataRecord"];
5
5
  //# sourceMappingURL=migration.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.5.0/migration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAA;AAMnE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAEhD,mCAAmC;AACnC,eAAO,MAAM,eAAe,SAAU,OAAO,CAAC,UAAU,KAAG,OAAO,CAAC,YAAY,CAgK9E,CAAA"}
1
+ {"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.5.0/migration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAA;AACtE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAEnD,mCAAmC;AACnC,eAAO,MAAM,eAAe,SAAU,OAAO,CAAC,UAAU,KAAG,OAAO,CAAC,YAAY,CAiK9E,CAAA"}
@@ -76,10 +76,9 @@ const migrate_v_2_5_0 = (data) => {
76
76
  uid: server.uid,
77
77
  variables: Object.entries(server.variables || {}).reduce((variablesAcc, [variableKey, variable]) => {
78
78
  variablesAcc[variableKey] = {
79
- ...variable,
80
- enum: variable.enum && variable.enum.length > 0 ? variable.enum : undefined,
81
79
  default: variable.default ?? '',
82
- description: variable.description,
80
+ description: variable.description ?? '',
81
+ ...(variable.enum?.length && { enum: variable.enum }),
83
82
  };
84
83
  return variablesAcc;
85
84
  }, {}),
@@ -1,7 +1,12 @@
1
- import type { Cookie } from '../../entities/cookie/index.js';
2
- import type { Environment } from '../../entities/environment/index.js';
3
- import type { Collection, Request, RequestExample, Server, SecurityScheme, Tag } from '../../entities/spec/index.js';
4
- import type { Workspace } from '../../entities/workspace/index.js';
1
+ import type { Cookie } from '../../entities/cookie/cookie.ts';
2
+ import type { Environment } from '../../entities/environment/environment.ts';
3
+ import type { Collection } from '../../entities/spec/collection.ts';
4
+ import type { RequestExample } from '../../entities/spec/request-examples.ts';
5
+ import type { Request } from '../../entities/spec/requests.ts';
6
+ import type { Server } from '../../entities/spec/server.ts';
7
+ import type { Tag } from '../../entities/spec/spec-objects.ts';
8
+ import type { Workspace } from '../../entities/workspace/workspace.ts';
9
+ import type { SecurityScheme } from '@scalar/types/entities';
5
10
  export type v_2_5_0 = {
6
11
  Cookie: Cookie;
7
12
  Environment: Environment;
@@ -1 +1 @@
1
- {"version":3,"file":"types.generated.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.5.0/types.generated.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AACvG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAErD,MAAM,MAAM,OAAO,GAAG;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,WAAW,CAAA;IACxB,UAAU,EAAE,UAAU,CAAA;IACtB,OAAO,EAAE,OAAO,CAAA;IAChB,cAAc,EAAE,cAAc,CAAA;IAC9B,cAAc,EAAE,cAAc,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,SAAS,EAAE,SAAS,CAAA;IAEpB,UAAU,EAAE;QACV,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;QACvC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC/B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;QACzC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;QAC/C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACjC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;QAC/C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC/B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QACzB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;KACtC,CAAA;IAED,SAAS,EAAE;QACT,WAAW,EAAE,UAAU,EAAE,CAAA;QACzB,OAAO,EAAE,MAAM,EAAE,CAAA;QACjB,YAAY,EAAE,WAAW,EAAE,CAAA;QAC3B,eAAe,EAAE,cAAc,EAAE,CAAA;QACjC,QAAQ,EAAE,OAAO,EAAE,CAAA;QACnB,eAAe,EAAE,cAAc,EAAE,CAAA;QACjC,OAAO,EAAE,MAAM,EAAE,CAAA;QACjB,IAAI,EAAE,GAAG,EAAE,CAAA;QACX,UAAU,EAAE,SAAS,EAAE,CAAA;KACxB,CAAA;CACF,CAAA"}
1
+ {"version":3,"file":"types.generated.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.5.0/types.generated.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAA;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAA;AACxE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAA;AACzE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AACvD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iCAAiC,CAAA;AAC1D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAA;AAClE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAE5D,MAAM,MAAM,OAAO,GAAG;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,WAAW,CAAA;IACxB,UAAU,EAAE,UAAU,CAAA;IACtB,OAAO,EAAE,OAAO,CAAA;IAChB,cAAc,EAAE,cAAc,CAAA;IAC9B,cAAc,EAAE,cAAc,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,SAAS,EAAE,SAAS,CAAA;IAEpB,UAAU,EAAE;QACV,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;QACvC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC/B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;QACzC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;QAC/C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACjC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;QAC/C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC/B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QACzB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;KACtC,CAAA;IAED,SAAS,EAAE;QACT,WAAW,EAAE,UAAU,EAAE,CAAA;QACzB,OAAO,EAAE,MAAM,EAAE,CAAA;QACjB,YAAY,EAAE,WAAW,EAAE,CAAA;QAC3B,eAAe,EAAE,cAAc,EAAE,CAAA;QACjC,QAAQ,EAAE,OAAO,EAAE,CAAA;QACnB,eAAe,EAAE,cAAc,EAAE,CAAA;QACjC,OAAO,EAAE,MAAM,EAAE,CAAA;QACjB,IAAI,EAAE,GAAG,EAAE,CAAA;QACX,UAAU,EAAE,SAAS,EAAE,CAAA;KACxB,CAAA;CACF,CAAA"}
@@ -27,4 +27,4 @@ export declare const getExampleFromSchema: (schema: Record<string, any>, options
27
27
  */
28
28
  omitEmptyAndOptionalProperties?: boolean;
29
29
  }, level?: number, parentSchema?: Record<string, any>, name?: string) => any;
30
- //# sourceMappingURL=getExampleFromSchema.d.ts.map
30
+ //# sourceMappingURL=get-example-from-schema.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-example-from-schema.d.ts","sourceRoot":"","sources":["../../src/spec-getters/get-example-from-schema.ts"],"names":[],"mappings":"AAyDA;;GAEG;AACH,eAAO,MAAM,oBAAoB,WACvB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,YACjB;IACR;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC/B;;;OAGG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAA;CACzC,UACM,MAAM,iBACE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,SAC3B,MAAM,KACZ,GA8QF,CAAA"}
@@ -8,4 +8,4 @@ import type { BaseParameter, TransformedOperation } from '@scalar/types/legacy';
8
8
  * - Swagger 2.0: Possible values are "query", "header", "path", "formData" or "body".
9
9
  */
10
10
  export declare function getParametersFromOperation(operation: Omit<TransformedOperation, 'httpVerb'>, where: 'query' | 'header' | 'path' | 'cookie' | 'formData' | 'body', requiredOnly?: boolean): BaseParameter[];
11
- //# sourceMappingURL=getParametersFromOperation.d.ts.map
11
+ //# sourceMappingURL=get-parameters-from-operation.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-parameters-from-operation.d.ts","sourceRoot":"","sources":["../../src/spec-getters/get-parameters-from-operation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAI/E;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,IAAI,CAAC,oBAAoB,EAAE,UAAU,CAAC,EACjD,KAAK,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,EACnE,YAAY,GAAE,OAAc,GAC3B,aAAa,EAAE,CAiCjB"}
@@ -1,4 +1,4 @@
1
- import { getExampleFromSchema } from './getExampleFromSchema.js';
1
+ import { getExampleFromSchema } from './get-example-from-schema.js';
2
2
 
3
3
  /**
4
4
  * Get the query parameters from an operation.
@@ -4,10 +4,10 @@ import type { ContentType, TransformedOperation } from '@scalar/types/legacy';
4
4
  */
5
5
  export declare function getRequestBodyFromOperation(operation: Omit<TransformedOperation, 'httpVerb'>, selectedExampleKey?: string | number, omitEmptyAndOptionalProperties?: boolean): {
6
6
  mimeType: ContentType;
7
- text?: string;
7
+ text?: string | undefined;
8
8
  params?: {
9
9
  name: string;
10
10
  value?: string;
11
11
  }[];
12
12
  } | null;
13
- //# sourceMappingURL=getRequestBodyFromOperation.d.ts.map
13
+ //# sourceMappingURL=get-request-body-from-operation.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-request-body-from-operation.d.ts","sourceRoot":"","sources":["../../src/spec-getters/get-request-body-from-operation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAyC7E;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,IAAI,CAAC,oBAAoB,EAAE,UAAU,CAAC,EACjD,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,EACpC,8BAA8B,CAAC,EAAE,OAAO,GACvC;IACD,QAAQ,EAAE,WAAW,CAAA;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,EAAE,CAAA;CACJ,GAAG,IAAI,CA+JP"}
@@ -1,8 +1,8 @@
1
1
  import { json2xml } from '../helpers/json2xml.js';
2
- import { normalizeMimeTypeObject } from '../helpers/normalizeMimeTypeObject.js';
3
- import { prettyPrintJson } from '../helpers/prettyPrintJson.js';
4
- import { getExampleFromSchema } from './getExampleFromSchema.js';
5
- import { getParametersFromOperation } from './getParametersFromOperation.js';
2
+ import { normalizeMimeTypeObject } from '../helpers/normalize-mime-type-object.js';
3
+ import { prettyPrintJson } from '../helpers/pretty-print-json.js';
4
+ import { getExampleFromSchema } from './get-example-from-schema.js';
5
+ import { getParametersFromOperation } from './get-parameters-from-operation.js';
6
6
 
7
7
  /**
8
8
  * Transform the object into a nested array of objects
@@ -40,7 +40,7 @@ function getRequestBodyFromOperation(operation, selectedExampleKey, omitEmptyAnd
40
40
  /** Examples */
41
41
  const examples = content?.[mimeType]?.examples ?? content?.['application/json']?.examples;
42
42
  // Let’s use the first example
43
- const selectedExample = examples?.[selectedExampleKey ?? Object.keys(examples ?? {})[0]];
43
+ const selectedExample = examples?.[selectedExampleKey ?? Object.keys(examples ?? {})[0] ?? ''];
44
44
  if (selectedExample) {
45
45
  return {
46
46
  mimeType,
@@ -59,7 +59,7 @@ function getRequestBodyFromOperation(operation, selectedExampleKey, omitEmptyAnd
59
59
  if (bodyParameters.length > 0) {
60
60
  return {
61
61
  mimeType: 'application/json',
62
- text: prettyPrintJson(bodyParameters[0].value),
62
+ text: prettyPrintJson(bodyParameters[0]?.value ?? ''),
63
63
  };
64
64
  }
65
65
  /**
@@ -107,7 +107,7 @@ function getRequestBodyFromOperation(operation, selectedExampleKey, omitEmptyAnd
107
107
  const exampleFromSchema = requestBodyObject?.schema
108
108
  ? getExampleFromSchema(requestBodyObject?.schema, {
109
109
  mode: 'write',
110
- omitEmptyAndOptionalProperties: omitEmptyAndOptionalProperties,
110
+ omitEmptyAndOptionalProperties: omitEmptyAndOptionalProperties ?? false,
111
111
  })
112
112
  : null;
113
113
  const body = example ?? exampleFromSchema;
@@ -1,4 +1,4 @@
1
- import type { Server } from '../entities/spec/server.js';
1
+ import type { Server } from '../entities/spec/server.ts';
2
2
  /** Retrieve example values for server variables */
3
3
  export declare const getServerVariableExamples: (server: Server) => Record<string, string[]>;
4
- //# sourceMappingURL=getServerVariableExamples.d.ts.map
4
+ //# sourceMappingURL=get-server-variable-examples.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-server-variable-examples.d.ts","sourceRoot":"","sources":["../../src/spec-getters/get-server-variable-examples.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAEvD,mDAAmD;AACnD,eAAO,MAAM,yBAAyB,WAAY,MAAM,6BAUvD,CAAA"}
@@ -1,5 +1,5 @@
1
- export * from './getExampleFromSchema.js';
2
- export * from './getParametersFromOperation.js';
3
- export * from './getRequestBodyFromOperation.js';
4
- export * from './getServerVariableExamples.js';
1
+ export { getExampleFromSchema } from './get-example-from-schema.ts';
2
+ export { getParametersFromOperation } from './get-parameters-from-operation.ts';
3
+ export { getRequestBodyFromOperation } from './get-request-body-from-operation.ts';
4
+ export { getServerVariableExamples } from './get-server-variable-examples.ts';
5
5
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/spec-getters/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,6BAA6B,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/spec-getters/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AACnE,OAAO,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAA;AAC/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,sCAAsC,CAAA;AAClF,OAAO,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAA"}
@@ -1,4 +1,4 @@
1
- export { getExampleFromSchema } from './getExampleFromSchema.js';
2
- export { getParametersFromOperation } from './getParametersFromOperation.js';
3
- export { getRequestBodyFromOperation } from './getRequestBodyFromOperation.js';
4
- export { getServerVariableExamples } from './getServerVariableExamples.js';
1
+ export { getExampleFromSchema } from './get-example-from-schema.js';
2
+ export { getParametersFromOperation } from './get-parameters-from-operation.js';
3
+ export { getRequestBodyFromOperation } from './get-request-body-from-operation.js';
4
+ export { getServerVariableExamples } from './get-server-variable-examples.js';
@@ -1,9 +1,13 @@
1
- import type { SelectedSecuritySchemeUids } from '../entities/shared/utility.js';
2
- import { type Collection, type CollectionPayload, type Request, type RequestExample, type Server, type Tag } from '../entities/spec/index.js';
3
- import { type SecurityScheme } from '../entities/spec/security.js';
4
1
  import type { OpenAPIV3_1 } from '@scalar/openapi-types';
5
2
  import type { ApiReferenceConfiguration } from '@scalar/types/api-reference';
6
3
  import type { UnknownObject } from '@scalar/types/utils';
4
+ import type { SelectedSecuritySchemeUids } from '../entities/shared/utility.ts';
5
+ import { type Collection, type CollectionPayload } from '../entities/spec/collection.ts';
6
+ import { type RequestExample } from '../entities/spec/request-examples.ts';
7
+ import { type Request } from '../entities/spec/requests.ts';
8
+ import { type SecurityScheme } from '../entities/spec/security.ts';
9
+ import { type Server } from '../entities/spec/server.ts';
10
+ import { type Tag } from '../entities/spec/spec-objects.ts';
7
11
  /** Takes a string or object and parses it into an openapi spec compliant schema */
8
12
  export declare const parseSchema: (spec: string | UnknownObject, { shouldLoad }?: {
9
13
  shouldLoad?: boolean | undefined;
@@ -1 +1 @@
1
- {"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAA;AAC3E,OAAO,EACL,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,OAAO,EACZ,KAAK,cAAc,EAGnB,KAAK,MAAM,EACX,KAAK,GAAG,EAMT,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAEL,KAAK,cAAc,EAGpB,MAAM,0BAA0B,CAAA;AAMjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAC5E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGxD,mFAAmF;AACnF,eAAO,MAAM,WAAW,SAAgB,MAAM,GAAG,aAAa;;;IAoC1D;;;OAGG;YAC8C,WAAW,CAAC,QAAQ;;EAGxE,CAAA;AAED,sDAAsD;AACtD,eAAO,MAAM,6BAA6B,yBAClB,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,0BACnB,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,iCAC1B,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,KACvD,0BAWF,CAAA;AAED,iCAAiC;AACjC,eAAO,MAAM,UAAU,SAAU,MAAM,KAA2B,UAAU,CAAC,KAAK,CAAC,CAAA;AAEnF,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,iBAAiB,EAAE,aAAa,GAAG,WAAW,CAAC,GAC1F,IAAI,CAAC,yBAAyB,EAAE,gBAAgB,GAAG,eAAe,GAAG,SAAS,GAAG,MAAM,CAAC,GAAG;IACzF,mFAAmF;IACnF,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAEH;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,EAC5B,EACE,cAAc,EACd,aAAa,EACb,WAAW,EACX,OAAO,EAAE,iBAAiB,EAC1B,qBAA6B,EAC7B,IAAI,EACJ,UAAU,EACV,SAAiB,GAClB,GAAE,yBAA8B,GAChC,OAAO,CACN;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAA;IAC5B,QAAQ,EAAE,cAAc,EAAE,CAAA;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,EAAE,GAAG,EAAE,CAAA;IACX,eAAe,EAAE,cAAc,EAAE,CAAA;CAClC,GACD;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,cAAc,EAAE,MAAM,EAAE,CAAC;IAAC,UAAU,EAAE,SAAS,CAAA;CAAE,CACnE,CA0VA;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,OAAO,EAAE,WAAW,CAAC,YAAY,EAAE,GAAG,SAAS,EAC/C,EAAE,aAAa,EAAE,GAAE,IAAI,CAAC,yBAAyB,EAAE,eAAe,CAAM,GACvE,MAAM,EAAE,CA0CV"}
1
+ {"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAE5E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGxD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAA;AAC9E,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,iBAAiB,EAAoB,MAAM,+BAA+B,CAAA;AAEzG,OAAO,EAAE,KAAK,cAAc,EAA4B,MAAM,qCAAqC,CAAA;AACnG,OAAO,EAAE,KAAK,OAAO,EAAsC,MAAM,6BAA6B,CAAA;AAC9F,OAAO,EAEL,KAAK,cAAc,EAGpB,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,2BAA2B,CAAA;AACrE,OAAO,EAAE,KAAK,GAAG,EAAa,MAAM,iCAAiC,CAAA;AAMrE,mFAAmF;AACnF,eAAO,MAAM,WAAW,SAAgB,MAAM,GAAG,aAAa;;;IAoC1D;;;OAGG;YAC8C,WAAW,CAAC,QAAQ;;EAGxE,CAAA;AAED,sDAAsD;AACtD,eAAO,MAAM,6BAA6B,yBAClB,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,0BACnB,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,iCAC1B,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,KACvD,0BAaF,CAAA;AAED,iCAAiC;AACjC,eAAO,MAAM,UAAU,SAAU,MAAM,KAA2B,UAAU,CAAC,KAAK,CAAC,CAAA;AAEnF,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,iBAAiB,EAAE,aAAa,GAAG,WAAW,CAAC,GAC1F,IAAI,CAAC,yBAAyB,EAAE,gBAAgB,GAAG,eAAe,GAAG,SAAS,GAAG,MAAM,CAAC,GAAG;IACzF,mFAAmF;IACnF,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAEH;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,EAC5B,EACE,cAAc,EACd,aAAa,EACb,WAAW,EACX,OAAO,EAAE,iBAAiB,EAC1B,qBAA6B,EAC7B,IAAI,EACJ,UAAU,EACV,SAAiB,GAClB,GAAE,yBAA8B,GAChC,OAAO,CACN;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAA;IAC5B,QAAQ,EAAE,cAAc,EAAE,CAAA;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,EAAE,GAAG,EAAE,CAAA;IACX,eAAe,EAAE,cAAc,EAAE,CAAA;CAClC,GACD;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,cAAc,EAAE,MAAM,EAAE,CAAC;IAAC,UAAU,EAAE,SAAS,CAAA;CAAE,CACnE,CAwWA;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,OAAO,EAAE,WAAW,CAAC,YAAY,EAAE,GAAG,SAAS,EAC/C,EAAE,aAAa,EAAE,GAAE,IAAI,CAAC,yBAAyB,EAAE,eAAe,CAAM,GACvE,MAAM,EAAE,CA0CV"}
@@ -1,15 +1,15 @@
1
- import { securitySchemeSchema } from '../entities/spec/security.js';
2
- import { isHttpMethod } from '../helpers/httpMethods.js';
3
- import { schemaModel } from '../helpers/schema-model.js';
4
1
  import { keysOf } from '@scalar/object-utils/arrays';
5
2
  import { load, upgrade, dereference } from '@scalar/openapi-parser';
6
- import { isDefined } from '../helpers/is-defined.js';
7
- import { serverSchema } from '../entities/spec/server.js';
3
+ import { collectionSchema } from '../entities/spec/collection.js';
4
+ import { createExampleFromRequest } from '../entities/spec/request-examples.js';
8
5
  import { requestSchema } from '../entities/spec/requests.js';
6
+ import { securitySchemeSchema } from '../entities/spec/security.js';
7
+ import { serverSchema } from '../entities/spec/server.js';
9
8
  import { tagSchema } from '../entities/spec/spec-objects.js';
10
- import { createExampleFromRequest } from '../entities/spec/request-examples.js';
11
- import { collectionSchema } from '../entities/spec/collection.js';
9
+ import { isHttpMethod } from '../helpers/http-methods.js';
10
+ import { isDefined } from '../helpers/is-defined.js';
12
11
  import { combineUrlAndPath } from '../helpers/merge-urls.js';
12
+ import { schemaModel } from '../helpers/schema-model.js';
13
13
 
14
14
  /** Takes a string or object and parses it into an openapi spec compliant schema */
15
15
  const parseSchema = async (spec, { shouldLoad = true } = {}) => {
@@ -57,7 +57,7 @@ const getSelectedSecuritySchemeUids = (securityRequirements, preferredSecurityNa
57
57
  const names = securityRequirements[0] && !preferredSecurityNames.length ? [securityRequirements[0]] : preferredSecurityNames;
58
58
  // Map names to uids
59
59
  const uids = names
60
- .map((name) => (Array.isArray(name) ? name.map((k) => securitySchemeMap[k]) : securitySchemeMap[name]))
60
+ .map((name) => Array.isArray(name) ? name.map((k) => securitySchemeMap[k]).filter(isDefined) : securitySchemeMap[name])
61
61
  .filter(isDefined);
62
62
  return uids;
63
63
  };
@@ -105,11 +105,17 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
105
105
  // ---------------------------------------------------------------------------
106
106
  // SECURITY HANDLING
107
107
  const security = schema.components?.securitySchemes ?? schema?.securityDefinitions ?? {};
108
+ // Toss out a deprecated warning for the old authentication state
109
+ if (authentication?.oAuth2 || authentication?.apiKey || authentication?.http) {
110
+ console.warn(`DEPRECATION WARNING: It looks like you're using legacy authentication config. Please migrate to use the updated config. See https://github.com/scalar/scalar/blob/main/documentation/configuration.md#authentication-partial This will be removed in a future version.`);
111
+ }
108
112
  const securitySchemes = Object.entries(security)
109
113
  .map?.(([nameKey, _scheme]) => {
110
114
  // Apply any transforms we need before parsing
111
115
  const payload = {
112
116
  ..._scheme,
117
+ // Add the new auth config overrides, we keep the old code below for backwards compatibility
118
+ ...(authentication?.securitySchemes?.[nameKey] ?? {}),
113
119
  nameKey,
114
120
  };
115
121
  // For oauth2 we need to add the type to the flows + prefill from authentication
@@ -119,10 +125,15 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
119
125
  if (!payload.flows?.[key]) {
120
126
  return;
121
127
  }
128
+ // This part handles setting of flows via the new auth config, the rest can be removed in a future version
129
+ payload.flows[key] = {
130
+ ...(_scheme.flows?.[key] ?? {}),
131
+ ...(authentication?.securitySchemes?.[nameKey]?.flows?.[key] ?? {}),
132
+ };
122
133
  const flow = payload.flows[key];
123
134
  // Set the type
124
135
  flow.type = key;
125
- // Prefill values from authorization config
136
+ // Prefill values from authorization config - old deprecated config
126
137
  if (authentication?.oAuth2) {
127
138
  if (authentication.oAuth2.accessToken) {
128
139
  flow.token = authentication.oAuth2.accessToken;
@@ -148,7 +159,7 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
148
159
  }
149
160
  });
150
161
  }
151
- // Otherwise we just prefill
162
+ // Otherwise we just prefill - old deprecated config
152
163
  else if (authentication) {
153
164
  // ApiKey
154
165
  if (payload.type === 'apiKey' && authentication.apiKey?.token) {
@@ -161,14 +172,8 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
161
172
  payload.password = authentication.http.basic.password ?? '';
162
173
  }
163
174
  // Bearer
164
- else if (payload.scheme === 'bearer') {
165
- if (authentication.http?.bearer?.token) {
166
- payload.token = authentication.http.bearer.token ?? '';
167
- }
168
- // Temp multiple bearer
169
- if (authentication.http?.bearer?.multiple?.[nameKey]) {
170
- payload.token = authentication.http.bearer.multiple[nameKey];
171
- }
175
+ else if (payload.scheme === 'bearer' && authentication.http?.bearer?.token) {
176
+ payload.token = authentication.http.bearer.token ?? '';
172
177
  }
173
178
  }
174
179
  }
@@ -247,9 +252,11 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
247
252
  // Handle the case of {} for optional
248
253
  if (keys.length) {
249
254
  const [key] = Object.keys(s);
250
- return {
251
- [key]: s[key],
252
- };
255
+ if (key) {
256
+ return {
257
+ [key]: s[key],
258
+ };
259
+ }
253
260
  }
254
261
  return s;
255
262
  });
@@ -283,17 +290,19 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
283
290
  tags.forEach((t) => {
284
291
  t['x-scalar-children']?.forEach((c) => {
285
292
  // Add the uid to the appropriate parent.children
286
- const nestedUid = tagMap[c.tagName].uid;
287
- t.children.push(nestedUid);
288
- // Remove the nested uid from the root folder
289
- collectionChildren.delete(nestedUid);
293
+ const nestedUid = tagMap[c.tagName]?.uid;
294
+ if (nestedUid) {
295
+ t.children.push(nestedUid);
296
+ // Remove the nested uid from the root folder
297
+ collectionChildren.delete(nestedUid);
298
+ }
290
299
  });
291
300
  });
292
301
  // Add the request UIDs to the tag children (or collection root)
293
302
  requests.forEach((r) => {
294
303
  if (r.tags?.length) {
295
304
  r.tags.forEach((t) => {
296
- tagMap[t].children.push(r.uid);
305
+ tagMap[t]?.children.push(r.uid);
297
306
  });
298
307
  }
299
308
  else {
@@ -1,2 +1,2 @@
1
- export * from './import-spec.js';
1
+ export { getSlugUid, importSpecToWorkspace, parseSchema, type ImportSpecToWorkspaceArgs } from './import-spec.ts';
2
2
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/transforms/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/transforms/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,qBAAqB,EAAE,WAAW,EAAE,KAAK,yBAAyB,EAAE,MAAM,kBAAkB,CAAA"}
@@ -1 +1 @@
1
- export { getSelectedSecuritySchemeUids, getServersFromOpenApiDocument, getSlugUid, importSpecToWorkspace, parseSchema } from './import-spec.js';
1
+ export { getSlugUid, importSpecToWorkspace, parseSchema } from './import-spec.js';
package/package.json CHANGED
@@ -16,7 +16,7 @@
16
16
  "specification",
17
17
  "yaml"
18
18
  ],
19
- "version": "0.2.121",
19
+ "version": "0.2.123",
20
20
  "engines": {
21
21
  "node": ">=18"
22
22
  },
@@ -38,46 +38,11 @@
38
38
  "types": "./dist/migrations/index.d.ts",
39
39
  "default": "./dist/migrations/index.js"
40
40
  },
41
- "./migrations/v-2.5.0": {
42
- "import": "./dist/migrations/v-2.5.0/index.js",
43
- "types": "./dist/migrations/v-2.5.0/index.d.ts",
44
- "default": "./dist/migrations/v-2.5.0/index.js"
45
- },
46
- "./migrations/v-2.4.0": {
47
- "import": "./dist/migrations/v-2.4.0/index.js",
48
- "types": "./dist/migrations/v-2.4.0/index.d.ts",
49
- "default": "./dist/migrations/v-2.4.0/index.js"
50
- },
51
- "./migrations/v-2.3.0": {
52
- "import": "./dist/migrations/v-2.3.0/index.js",
53
- "types": "./dist/migrations/v-2.3.0/index.d.ts",
54
- "default": "./dist/migrations/v-2.3.0/index.js"
55
- },
56
- "./migrations/v-2.2.0": {
57
- "import": "./dist/migrations/v-2.2.0/index.js",
58
- "types": "./dist/migrations/v-2.2.0/index.d.ts",
59
- "default": "./dist/migrations/v-2.2.0/index.js"
60
- },
61
- "./migrations/v-2.1.0": {
62
- "import": "./dist/migrations/v-2.1.0/index.js",
63
- "types": "./dist/migrations/v-2.1.0/index.d.ts",
64
- "default": "./dist/migrations/v-2.1.0/index.js"
65
- },
66
- "./migrations/v-0.0.0": {
67
- "import": "./dist/migrations/v-0.0.0/index.js",
68
- "types": "./dist/migrations/v-0.0.0/index.d.ts",
69
- "default": "./dist/migrations/v-0.0.0/index.js"
70
- },
71
41
  "./helpers": {
72
42
  "import": "./dist/helpers/index.js",
73
43
  "types": "./dist/helpers/index.d.ts",
74
44
  "default": "./dist/helpers/index.js"
75
45
  },
76
- "./entities": {
77
- "import": "./dist/entities/index.js",
78
- "types": "./dist/entities/index.d.ts",
79
- "default": "./dist/entities/index.js"
80
- },
81
46
  "./entities/workspace": {
82
47
  "import": "./dist/entities/workspace/index.js",
83
48
  "types": "./dist/entities/workspace/index.d.ts",
@@ -107,11 +72,6 @@
107
72
  "import": "./dist/entities/cookie/index.js",
108
73
  "types": "./dist/entities/cookie/index.d.ts",
109
74
  "default": "./dist/entities/cookie/index.js"
110
- },
111
- "./diff": {
112
- "import": "./dist/diff/index.js",
113
- "types": "./dist/diff/index.d.ts",
114
- "default": "./dist/diff/index.js"
115
75
  }
116
76
  },
117
77
  "files": [
@@ -123,21 +83,23 @@
123
83
  "@hyperjump/json-schema": "^1.9.6",
124
84
  "flatted": "^3.3.1",
125
85
  "microdiff": "^1.4.0",
126
- "nanoid": "^5.0.9",
86
+ "nanoid": "^5.1.5",
87
+ "type-fest": "^4.20.0",
127
88
  "yaml": "^2.4.5",
128
89
  "zod": "^3.23.8",
129
90
  "@scalar/object-utils": "1.1.13",
130
91
  "@scalar/openapi-types": "0.1.9",
131
- "@scalar/themes": "0.9.80",
132
- "@scalar/types": "0.1.2"
92
+ "@scalar/themes": "0.9.82",
93
+ "@scalar/types": "0.1.4"
133
94
  },
134
95
  "devDependencies": {
96
+ "@types/node": "^20.17.10",
135
97
  "type-fest": "^4.20.0",
136
98
  "vite": "^5.4.10",
137
99
  "vitest": "^1.6.0",
138
100
  "zod-to-ts": "github:amritk/zod-to-ts#build",
139
101
  "@scalar/build-tooling": "0.1.17",
140
- "@scalar/openapi-parser": "0.10.11",
102
+ "@scalar/openapi-parser": "0.10.12",
141
103
  "@scalar/openapi-types": "0.1.9"
142
104
  },
143
105
  "scripts": {
@@ -1,13 +0,0 @@
1
- declare const types: {
2
- readonly CREATE: "add";
3
- readonly REMOVE: "remove";
4
- readonly CHANGE: "modify";
5
- };
6
- export type DiffChangeType = (typeof types)[keyof typeof types];
7
- /**
8
- * Compare two specs and return the changes for each request entry
9
- *
10
- */
11
- export declare function diffSpec(a: object, b: object): string;
12
- export {};
13
- //# sourceMappingURL=diff.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"diff.d.ts","sourceRoot":"","sources":["../../src/diff/diff.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,KAAK;;;;CAID,CAAA;AAEV,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,KAAK,CAAC,CAAC,MAAM,OAAO,KAAK,CAAC,CAAA;AAE/D;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,UAsC5C"}