@scalar/oas-utils 0.3.2 → 0.4.1

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 (80) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/dist/entities/spec/collection.d.ts +6 -12
  3. package/dist/entities/spec/collection.d.ts.map +1 -1
  4. package/dist/entities/spec/collection.js +1 -1
  5. package/dist/entities/spec/collection.js.map +2 -2
  6. package/dist/helpers/http-methods.js +9 -9
  7. package/dist/helpers/http-methods.js.map +1 -1
  8. package/dist/helpers/pretty-print-json.d.ts.map +1 -1
  9. package/dist/helpers/pretty-print-json.js.map +2 -2
  10. package/dist/transforms/import-spec.d.ts +8 -3
  11. package/dist/transforms/import-spec.d.ts.map +1 -1
  12. package/dist/transforms/import-spec.js +30 -9
  13. package/dist/transforms/import-spec.js.map +2 -2
  14. package/package.json +5 -5
  15. package/dist/entities/spec/operation.test.js +0 -43
  16. package/dist/entities/spec/operation.test.js.map +0 -7
  17. package/dist/entities/spec/parameters.test.js +0 -80
  18. package/dist/entities/spec/parameters.test.js.map +0 -7
  19. package/dist/entities/spec/request-example.test.js +0 -633
  20. package/dist/entities/spec/request-example.test.js.map +0 -7
  21. package/dist/entities/spec/server.test.js +0 -120
  22. package/dist/entities/spec/server.test.js.map +0 -7
  23. package/dist/entities/spec/spec-objects.test.js +0 -205
  24. package/dist/entities/spec/spec-objects.test.js.map +0 -7
  25. package/dist/entities/spec/x-scalar-environments.test.js +0 -11
  26. package/dist/entities/spec/x-scalar-environments.test.js.map +0 -7
  27. package/dist/entities/spec/x-scalar-secrets.test.js +0 -11
  28. package/dist/entities/spec/x-scalar-secrets.test.js.map +0 -7
  29. package/dist/helpers/ensure-protocol.test.js +0 -70
  30. package/dist/helpers/ensure-protocol.test.js.map +0 -7
  31. package/dist/helpers/fetch-document.test.js +0 -63
  32. package/dist/helpers/fetch-document.test.js.map +0 -7
  33. package/dist/helpers/find-variables.test.js +0 -20
  34. package/dist/helpers/find-variables.test.js.map +0 -7
  35. package/dist/helpers/is-defined.test.js +0 -37
  36. package/dist/helpers/is-defined.test.js.map +0 -7
  37. package/dist/helpers/is-local-url.test.js +0 -40
  38. package/dist/helpers/is-local-url.test.js.map +0 -7
  39. package/dist/helpers/is-valid-url.test.js +0 -17
  40. package/dist/helpers/is-valid-url.test.js.map +0 -7
  41. package/dist/helpers/json2xml.test.js +0 -19
  42. package/dist/helpers/json2xml.test.js.map +0 -7
  43. package/dist/helpers/make-url-absolute.test.js +0 -61
  44. package/dist/helpers/make-url-absolute.test.js.map +0 -7
  45. package/dist/helpers/merge-urls.test.js +0 -339
  46. package/dist/helpers/merge-urls.test.js.map +0 -7
  47. package/dist/helpers/normalize-mime-type-object.test.js +0 -53
  48. package/dist/helpers/normalize-mime-type-object.test.js.map +0 -7
  49. package/dist/helpers/normalize-mime-type.test.js +0 -33
  50. package/dist/helpers/normalize-mime-type.test.js.map +0 -7
  51. package/dist/helpers/omit-undefined-values.test.js +0 -89
  52. package/dist/helpers/omit-undefined-values.test.js.map +0 -7
  53. package/dist/helpers/parse.test.js +0 -45
  54. package/dist/helpers/parse.test.js.map +0 -7
  55. package/dist/helpers/pretty-print-json.test.js +0 -28
  56. package/dist/helpers/pretty-print-json.test.js.map +0 -7
  57. package/dist/helpers/redirect-to-proxy.test.js +0 -54
  58. package/dist/helpers/redirect-to-proxy.test.js.map +0 -7
  59. package/dist/helpers/regex-helpers.test.js +0 -154
  60. package/dist/helpers/regex-helpers.test.js.map +0 -7
  61. package/dist/helpers/replace-variables.test.js +0 -30
  62. package/dist/helpers/replace-variables.test.js.map +0 -7
  63. package/dist/helpers/security/get-schemes.test.js +0 -71
  64. package/dist/helpers/security/get-schemes.test.js.map +0 -7
  65. package/dist/helpers/security/has-token.test.js +0 -157
  66. package/dist/helpers/security/has-token.test.js.map +0 -7
  67. package/dist/migrations/semver.test.js +0 -21
  68. package/dist/migrations/semver.test.js.map +0 -7
  69. package/dist/migrations/v-2.4.0/migration.test.js +0 -90
  70. package/dist/migrations/v-2.4.0/migration.test.js.map +0 -7
  71. package/dist/migrations/v-2.5.0/migration.test.js +0 -108
  72. package/dist/migrations/v-2.5.0/migration.test.js.map +0 -7
  73. package/dist/spec-getters/get-example-from-schema.test.js +0 -1092
  74. package/dist/spec-getters/get-example-from-schema.test.js.map +0 -7
  75. package/dist/spec-getters/get-parameters-from-operation.test.js +0 -178
  76. package/dist/spec-getters/get-parameters-from-operation.test.js.map +0 -7
  77. package/dist/spec-getters/get-request-body-from-operation.test.js +0 -289
  78. package/dist/spec-getters/get-request-body-from-operation.test.js.map +0 -7
  79. package/dist/transforms/import-spec.test.js +0 -1124
  80. package/dist/transforms/import-spec.test.js.map +0 -7
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/entities/spec/operation.test.ts"],
4
- "sourcesContent": ["import { describe, expect, it } from 'vitest'\n\nimport { operationSchema } from './operation'\n\ndescribe('operationSchema', () => {\n describe('x-scalar-stability', () => {\n it('parses deprecated', () => {\n expect(\n operationSchema.parse({\n 'x-scalar-stability': 'deprecated',\n }),\n ).toMatchObject({\n 'x-scalar-stability': 'deprecated',\n })\n })\n\n it('parses experimental', () => {\n expect(\n operationSchema.parse({\n 'x-scalar-stability': 'experimental',\n }),\n ).toMatchObject({\n 'x-scalar-stability': 'experimental',\n })\n })\n\n it('parses stable', () => {\n expect(\n operationSchema.parse({\n 'x-scalar-stability': 'stable',\n }),\n ).toMatchObject({\n 'x-scalar-stability': 'stable',\n })\n })\n\n it('parses unknown', () => {\n expect(\n operationSchema.parse({\n 'x-scalar-stability': 'unknown',\n }),\n ).toMatchObject({\n 'x-scalar-stability': undefined,\n })\n })\n })\n})\n"],
5
- "mappings": "AAAA,SAAS,UAAU,QAAQ,UAAU;AAErC,SAAS,uBAAuB;AAEhC,SAAS,mBAAmB,MAAM;AAChC,WAAS,sBAAsB,MAAM;AACnC,OAAG,qBAAqB,MAAM;AAC5B;AAAA,QACE,gBAAgB,MAAM;AAAA,UACpB,sBAAsB;AAAA,QACxB,CAAC;AAAA,MACH,EAAE,cAAc;AAAA,QACd,sBAAsB;AAAA,MACxB,CAAC;AAAA,IACH,CAAC;AAED,OAAG,uBAAuB,MAAM;AAC9B;AAAA,QACE,gBAAgB,MAAM;AAAA,UACpB,sBAAsB;AAAA,QACxB,CAAC;AAAA,MACH,EAAE,cAAc;AAAA,QACd,sBAAsB;AAAA,MACxB,CAAC;AAAA,IACH,CAAC;AAED,OAAG,iBAAiB,MAAM;AACxB;AAAA,QACE,gBAAgB,MAAM;AAAA,UACpB,sBAAsB;AAAA,QACxB,CAAC;AAAA,MACH,EAAE,cAAc;AAAA,QACd,sBAAsB;AAAA,MACxB,CAAC;AAAA,IACH,CAAC;AAED,OAAG,kBAAkB,MAAM;AACzB;AAAA,QACE,gBAAgB,MAAM;AAAA,UACpB,sBAAsB;AAAA,QACxB,CAAC;AAAA,MACH,EAAE,cAAc;AAAA,QACd,sBAAsB;AAAA,MACxB,CAAC;AAAA,IACH,CAAC;AAAA,EACH,CAAC;AACH,CAAC;",
6
- "names": []
7
- }
@@ -1,80 +0,0 @@
1
- import { oasParameterSchema } from "../../entities/spec/parameters.js";
2
- import { describe, expect, it } from "vitest";
3
- import { z } from "zod";
4
- describe("oasParameterSchema", () => {
5
- it("should validate a parameter with a correct example", () => {
6
- const validParameterWithExample = {
7
- in: "query",
8
- name: "limit",
9
- example: 10
10
- };
11
- expect(() => oasParameterSchema.parse(validParameterWithExample)).not.toThrow();
12
- });
13
- it("should validate examples as a record with correct structure", () => {
14
- const validExamples = {
15
- milkyWay: {
16
- value: "Milky Way",
17
- summary: "Our galaxy"
18
- },
19
- andromeda: {
20
- value: "Andromeda",
21
- summary: "Nearest major galaxy"
22
- }
23
- };
24
- const validParameter = {
25
- in: "query",
26
- name: "galaxy",
27
- examples: validExamples
28
- };
29
- expect(() => oasParameterSchema.parse(validParameter)).not.toThrow();
30
- });
31
- it("should fail validation if examples have incorrect structure", () => {
32
- const invalidExamples = {
33
- milkyWay: {
34
- value: "Milky Way"
35
- // Summary is optional, so this should not cause a failure
36
- },
37
- andromeda: "This should be an object, not a string"
38
- };
39
- const invalidParameter = {
40
- in: "query",
41
- name: "galaxy",
42
- examples: invalidExamples
43
- };
44
- expect(() => oasParameterSchema.parse(invalidParameter)).toThrow(z.ZodError);
45
- });
46
- it("should validate examples as an array", () => {
47
- const validParameter = {
48
- in: "query",
49
- name: "galaxy",
50
- examples: ["Milky Way", "Andromeda"]
51
- };
52
- expect(() => oasParameterSchema.parse(validParameter)).not.toThrow();
53
- });
54
- it("should validate examples with a single array item", () => {
55
- const validParameter = {
56
- in: "query",
57
- name: "galaxy",
58
- examples: ["Milky Way"]
59
- };
60
- expect(() => oasParameterSchema.parse(validParameter)).not.toThrow();
61
- });
62
- it("should validate with an empty array of examples", () => {
63
- const validParameter = {
64
- in: "query",
65
- name: "galaxy",
66
- examples: []
67
- };
68
- expect(() => oasParameterSchema.parse(validParameter)).not.toThrow();
69
- });
70
- it("should validate examples with the explode property", () => {
71
- const validParameter = {
72
- in: "query",
73
- name: "galaxy",
74
- examples: ["Milky Way", "Andromeda"],
75
- explode: true
76
- };
77
- expect(() => oasParameterSchema.parse(validParameter)).not.toThrow();
78
- });
79
- });
80
- //# sourceMappingURL=parameters.test.js.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/entities/spec/parameters.test.ts"],
4
- "sourcesContent": ["import { oasParameterSchema } from '@/entities/spec/parameters'\nimport { describe, expect, it } from 'vitest'\nimport { z } from 'zod'\n\ndescribe('oasParameterSchema', () => {\n it('should validate a parameter with a correct example', () => {\n const validParameterWithExample = {\n in: 'query',\n name: 'limit',\n example: 10,\n }\n\n expect(() => oasParameterSchema.parse(validParameterWithExample)).not.toThrow()\n })\n\n it('should validate examples as a record with correct structure', () => {\n const validExamples = {\n milkyWay: {\n value: 'Milky Way',\n summary: 'Our galaxy',\n },\n andromeda: {\n value: 'Andromeda',\n summary: 'Nearest major galaxy',\n },\n }\n\n const validParameter = {\n in: 'query',\n name: 'galaxy',\n examples: validExamples,\n }\n\n expect(() => oasParameterSchema.parse(validParameter)).not.toThrow()\n })\n\n it('should fail validation if examples have incorrect structure', () => {\n const invalidExamples = {\n milkyWay: {\n value: 'Milky Way',\n // Summary is optional, so this should not cause a failure\n },\n andromeda: 'This should be an object, not a string',\n }\n\n const invalidParameter = {\n in: 'query',\n name: 'galaxy',\n examples: invalidExamples,\n }\n\n expect(() => oasParameterSchema.parse(invalidParameter)).toThrow(z.ZodError)\n })\n\n it('should validate examples as an array', () => {\n const validParameter = {\n in: 'query',\n name: 'galaxy',\n examples: ['Milky Way', 'Andromeda'],\n }\n\n expect(() => oasParameterSchema.parse(validParameter)).not.toThrow()\n })\n\n it('should validate examples with a single array item', () => {\n const validParameter = {\n in: 'query',\n name: 'galaxy',\n examples: ['Milky Way'],\n }\n\n expect(() => oasParameterSchema.parse(validParameter)).not.toThrow()\n })\n\n it('should validate with an empty array of examples', () => {\n const validParameter = {\n in: 'query',\n name: 'galaxy',\n examples: [],\n }\n\n expect(() => oasParameterSchema.parse(validParameter)).not.toThrow()\n })\n\n it('should validate examples with the explode property', () => {\n const validParameter = {\n in: 'query',\n name: 'galaxy',\n examples: ['Milky Way', 'Andromeda'],\n explode: true,\n }\n\n expect(() => oasParameterSchema.parse(validParameter)).not.toThrow()\n })\n})\n"],
5
- "mappings": "AAAA,SAAS,0BAA0B;AACnC,SAAS,UAAU,QAAQ,UAAU;AACrC,SAAS,SAAS;AAElB,SAAS,sBAAsB,MAAM;AACnC,KAAG,sDAAsD,MAAM;AAC7D,UAAM,4BAA4B;AAAA,MAChC,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,SAAS;AAAA,IACX;AAEA,WAAO,MAAM,mBAAmB,MAAM,yBAAyB,CAAC,EAAE,IAAI,QAAQ;AAAA,EAChF,CAAC;AAED,KAAG,+DAA+D,MAAM;AACtE,UAAM,gBAAgB;AAAA,MACpB,UAAU;AAAA,QACR,OAAO;AAAA,QACP,SAAS;AAAA,MACX;AAAA,MACA,WAAW;AAAA,QACT,OAAO;AAAA,QACP,SAAS;AAAA,MACX;AAAA,IACF;AAEA,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,UAAU;AAAA,IACZ;AAEA,WAAO,MAAM,mBAAmB,MAAM,cAAc,CAAC,EAAE,IAAI,QAAQ;AAAA,EACrE,CAAC;AAED,KAAG,+DAA+D,MAAM;AACtE,UAAM,kBAAkB;AAAA,MACtB,UAAU;AAAA,QACR,OAAO;AAAA;AAAA,MAET;AAAA,MACA,WAAW;AAAA,IACb;AAEA,UAAM,mBAAmB;AAAA,MACvB,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,UAAU;AAAA,IACZ;AAEA,WAAO,MAAM,mBAAmB,MAAM,gBAAgB,CAAC,EAAE,QAAQ,EAAE,QAAQ;AAAA,EAC7E,CAAC;AAED,KAAG,wCAAwC,MAAM;AAC/C,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,UAAU,CAAC,aAAa,WAAW;AAAA,IACrC;AAEA,WAAO,MAAM,mBAAmB,MAAM,cAAc,CAAC,EAAE,IAAI,QAAQ;AAAA,EACrE,CAAC;AAED,KAAG,qDAAqD,MAAM;AAC5D,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,UAAU,CAAC,WAAW;AAAA,IACxB;AAEA,WAAO,MAAM,mBAAmB,MAAM,cAAc,CAAC,EAAE,IAAI,QAAQ;AAAA,EACrE,CAAC;AAED,KAAG,mDAAmD,MAAM;AAC1D,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,UAAU,CAAC;AAAA,IACb;AAEA,WAAO,MAAM,mBAAmB,MAAM,cAAc,CAAC,EAAE,IAAI,QAAQ;AAAA,EACrE,CAAC;AAED,KAAG,sDAAsD,MAAM;AAC7D,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,UAAU,CAAC,aAAa,WAAW;AAAA,MACnC,SAAS;AAAA,IACX;AAEA,WAAO,MAAM,mBAAmB,MAAM,cAAc,CAAC,EAAE,IAAI,QAAQ;AAAA,EACrE,CAAC;AACH,CAAC;",
6
- "names": []
7
- }