@scalar/openapi-types 0.2.2 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @scalar/openapi-types
 
+## 0.3.1
+
+### Patch Changes
+
+- 4440949: chore: bumping packages
+
+## 0.3.0
+
+### Minor Changes
+
+- 483ca93: chore: require Node 20 (or above)
+
+## 0.2.3
+
+### Patch Changes
+
+- cb9428c: Support additional query parameters for the OAuth authorization request (prompt, audience, anything), and handle OAuth authorization denials
+
 ## 0.2.2
 
 ### Patch Changes

package/dist/schemas/extensions/index.d.ts

@@ -6,7 +6,9 @@ export { XScalarIconSchema } from './x-scalar-icon.js';
 export { XScalarIgnoreSchema } from './x-scalar-ignore.js';
 export { XScalarRedirectUriSchema } from './x-scalar-redirect-uri.js';
 export { XScalarSdkInstallationSchema } from './x-scalar-sdk-installation.js';
+export { XScalarSecurityQuery } from './x-scalar-security-query.js';
 export { XScalarStabilitySchema, XScalarStabilityValues } from './x-scalar-stability.js';
 export { XTagGroupsSchema, XTagGroupSchema } from './x-tag-groups.js';
 export { XusePkceSchema, XUsePkceValues } from './x-use-pkce.js';
+export { XPostResponseSchema, PostResponseSchema } from './x-post-response.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/schemas/extensions/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/schemas/extensions/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,gCAAgC,CAAA;AAChF,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACxE,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAA;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAA;AAClE,OAAO,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAA;AAC1E,OAAO,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AACrF,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAClE,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/schemas/extensions/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,gCAAgC,CAAA;AAChF,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACxE,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAA;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAA;AAClE,OAAO,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAA;AAC1E,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AACrF,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAClE,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7D,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA"}

package/dist/schemas/extensions/index.js

@@ -6,19 +6,24 @@ import { XScalarIconSchema } from "./x-scalar-icon.js";
 import { XScalarIgnoreSchema } from "./x-scalar-ignore.js";
 import { XScalarRedirectUriSchema } from "./x-scalar-redirect-uri.js";
 import { XScalarSdkInstallationSchema } from "./x-scalar-sdk-installation.js";
+import { XScalarSecurityQuery } from "./x-scalar-security-query.js";
 import { XScalarStabilitySchema, XScalarStabilityValues } from "./x-scalar-stability.js";
 import { XTagGroupsSchema, XTagGroupSchema } from "./x-tag-groups.js";
 import { XusePkceSchema, XUsePkceValues } from "./x-use-pkce.js";
+import { XPostResponseSchema, PostResponseSchema } from "./x-post-response.js";
 export {
+  PostResponseSchema,
   XAdditionalPropertiesNameSchema,
   XCodeSampleSchema,
   XCodeSamplesSchema,
   XEnumDescriptionsSchema,
   XInternalSchema,
+  XPostResponseSchema,
   XScalarIconSchema,
   XScalarIgnoreSchema,
   XScalarRedirectUriSchema,
   XScalarSdkInstallationSchema,
+  XScalarSecurityQuery,
   XScalarStabilitySchema,
   XScalarStabilityValues,
   XTagGroupSchema,

package/dist/schemas/extensions/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/schemas/extensions/index.ts"],
-  "sourcesContent": ["export { XAdditionalPropertiesNameSchema } from './x-additional-properties-name'\nexport { XCodeSamplesSchema, XCodeSampleSchema } from './x-code-samples'\nexport { XEnumDescriptionsSchema } from './x-enum-descriptions'\nexport { XInternalSchema } from './x-internal'\nexport { XScalarIconSchema } from './x-scalar-icon'\nexport { XScalarIgnoreSchema } from './x-scalar-ignore'\nexport { XScalarRedirectUriSchema } from './x-scalar-redirect-uri'\nexport { XScalarSdkInstallationSchema } from './x-scalar-sdk-installation'\nexport { XScalarStabilitySchema, XScalarStabilityValues } from './x-scalar-stability'\nexport { XTagGroupsSchema, XTagGroupSchema } from './x-tag-groups'\nexport { XusePkceSchema, XUsePkceValues } from './x-use-pkce'\n"],
-  "mappings": "AAAA,SAAS,uCAAuC;AAChD,SAAS,oBAAoB,yBAAyB;AACtD,SAAS,+BAA+B;AACxC,SAAS,uBAAuB;AAChC,SAAS,yBAAyB;AAClC,SAAS,2BAA2B;AACpC,SAAS,gCAAgC;AACzC,SAAS,oCAAoC;AAC7C,SAAS,wBAAwB,8BAA8B;AAC/D,SAAS,kBAAkB,uBAAuB;AAClD,SAAS,gBAAgB,sBAAsB;",
+  "sourcesContent": ["export { XAdditionalPropertiesNameSchema } from './x-additional-properties-name'\nexport { XCodeSamplesSchema, XCodeSampleSchema } from './x-code-samples'\nexport { XEnumDescriptionsSchema } from './x-enum-descriptions'\nexport { XInternalSchema } from './x-internal'\nexport { XScalarIconSchema } from './x-scalar-icon'\nexport { XScalarIgnoreSchema } from './x-scalar-ignore'\nexport { XScalarRedirectUriSchema } from './x-scalar-redirect-uri'\nexport { XScalarSdkInstallationSchema } from './x-scalar-sdk-installation'\nexport { XScalarSecurityQuery } from './x-scalar-security-query'\nexport { XScalarStabilitySchema, XScalarStabilityValues } from './x-scalar-stability'\nexport { XTagGroupsSchema, XTagGroupSchema } from './x-tag-groups'\nexport { XusePkceSchema, XUsePkceValues } from './x-use-pkce'\nexport { XPostResponseSchema, PostResponseSchema } from './x-post-response'\n"],
+  "mappings": "AAAA,SAAS,uCAAuC;AAChD,SAAS,oBAAoB,yBAAyB;AACtD,SAAS,+BAA+B;AACxC,SAAS,uBAAuB;AAChC,SAAS,yBAAyB;AAClC,SAAS,2BAA2B;AACpC,SAAS,gCAAgC;AACzC,SAAS,oCAAoC;AAC7C,SAAS,4BAA4B;AACrC,SAAS,wBAAwB,8BAA8B;AAC/D,SAAS,kBAAkB,uBAAuB;AAClD,SAAS,gBAAgB,sBAAsB;AAC/C,SAAS,qBAAqB,0BAA0B;",
   "names": []
 }

package/dist/schemas/extensions/x-post-response.d.ts

@@ -0,0 +1,26 @@
+import { z } from 'zod';
+/** The code to execute */
+export declare const PostResponseSchema: z.ZodString;
+/**
+ * Post response scripts allow to execute arbitrary code after a response is received
+ *
+ * This is useful for:
+ * - Extracting data from the response, or
+ * - Testing the response
+ *
+ * @example
+ * ```yaml
+ * x-post-response: |
+ *   pm.test("Status code is 200", () => {
+ *     pm.response.to.have.status(200)
+ *   })
+ * ```
+ */
+export declare const XPostResponseSchema: z.ZodObject<{
+    'x-post-response': z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    'x-post-response'?: string | undefined;
+}, {
+    'x-post-response'?: string | undefined;
+}>;
+//# sourceMappingURL=x-post-response.d.ts.map

package/dist/schemas/extensions/x-post-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"x-post-response.d.ts","sourceRoot":"","sources":["../../../src/schemas/extensions/x-post-response.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,0BAA0B;AAC1B,eAAO,MAAM,kBAAkB,aAAa,CAAA;AAE5C;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,mBAAmB;;;;;;EAE9B,CAAA"}

package/dist/schemas/extensions/x-post-response.js

@@ -0,0 +1,10 @@
+import { z } from "zod";
+const PostResponseSchema = z.string();
+const XPostResponseSchema = z.object({
+  "x-post-response": PostResponseSchema.optional()
+});
+export {
+  PostResponseSchema,
+  XPostResponseSchema
+};
+//# sourceMappingURL=x-post-response.js.map

package/dist/schemas/extensions/x-post-response.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/schemas/extensions/x-post-response.ts"],
+  "sourcesContent": ["import { z } from 'zod'\n\n/** The code to execute */\nexport const PostResponseSchema = z.string()\n\n/**\n * Post response scripts allow to execute arbitrary code after a response is received\n *\n * This is useful for:\n * - Extracting data from the response, or\n * - Testing the response\n *\n * @example\n * ```yaml\n * x-post-response: |\n *   pm.test(\"Status code is 200\", () => {\n *     pm.response.to.have.status(200)\n *   })\n * ```\n */\nexport const XPostResponseSchema = z.object({\n  'x-post-response': PostResponseSchema.optional(),\n})\n"],
+  "mappings": "AAAA,SAAS,SAAS;AAGX,MAAM,qBAAqB,EAAE,OAAO;AAiBpC,MAAM,sBAAsB,EAAE,OAAO;AAAA,EAC1C,mBAAmB,mBAAmB,SAAS;AACjD,CAAC;",
+  "names": []
+}

package/dist/schemas/extensions/x-post-response.test.js

@@ -0,0 +1,24 @@
+import { describe, expect, it } from "vitest";
+import { XPostResponseSchema } from "./x-post-response.js";
+describe("x-post-response", () => {
+  it("validates a valid post response script", () => {
+    const result = XPostResponseSchema.parse({
+      "x-post-response": 'pm.test("Status code is 200", () => { pm.response.to.have.status(200) })'
+    });
+    expect(result).toEqual({
+      "x-post-response": 'pm.test("Status code is 200", () => { pm.response.to.have.status(200) })'
+    });
+  });
+  it("allows empty object", () => {
+    const result = XPostResponseSchema.parse({});
+    expect(result).toEqual({ "x-post-response": void 0 });
+  });
+  it("rejects non-string values", () => {
+    expect(
+      () => XPostResponseSchema.parse({
+        "x-post-response": 123
+      })
+    ).toThrow();
+  });
+});
+//# sourceMappingURL=x-post-response.test.js.map

package/dist/schemas/extensions/x-post-response.test.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/schemas/extensions/x-post-response.test.ts"],
+  "sourcesContent": ["import { describe, expect, it } from 'vitest'\nimport { XPostResponseSchema } from './x-post-response'\n\ndescribe('x-post-response', () => {\n  it('validates a valid post response script', () => {\n    const result = XPostResponseSchema.parse({\n      'x-post-response': 'pm.test(\"Status code is 200\", () => { pm.response.to.have.status(200) })',\n    })\n\n    expect(result).toEqual({\n      'x-post-response': 'pm.test(\"Status code is 200\", () => { pm.response.to.have.status(200) })',\n    })\n  })\n\n  it('allows empty object', () => {\n    const result = XPostResponseSchema.parse({})\n    expect(result).toEqual({ 'x-post-response': undefined })\n  })\n\n  it('rejects non-string values', () => {\n    expect(() =>\n      XPostResponseSchema.parse({\n        'x-post-response': 123,\n      }),\n    ).toThrow()\n  })\n})\n"],
+  "mappings": "AAAA,SAAS,UAAU,QAAQ,UAAU;AACrC,SAAS,2BAA2B;AAEpC,SAAS,mBAAmB,MAAM;AAChC,KAAG,0CAA0C,MAAM;AACjD,UAAM,SAAS,oBAAoB,MAAM;AAAA,MACvC,mBAAmB;AAAA,IACrB,CAAC;AAED,WAAO,MAAM,EAAE,QAAQ;AAAA,MACrB,mBAAmB;AAAA,IACrB,CAAC;AAAA,EACH,CAAC;AAED,KAAG,uBAAuB,MAAM;AAC9B,UAAM,SAAS,oBAAoB,MAAM,CAAC,CAAC;AAC3C,WAAO,MAAM,EAAE,QAAQ,EAAE,mBAAmB,OAAU,CAAC;AAAA,EACzD,CAAC;AAED,KAAG,6BAA6B,MAAM;AACpC;AAAA,MAAO,MACL,oBAAoB,MAAM;AAAA,QACxB,mBAAmB;AAAA,MACrB,CAAC;AAAA,IACH,EAAE,QAAQ;AAAA,EACZ,CAAC;AACH,CAAC;",
+  "names": []
+}

package/dist/schemas/extensions/x-scalar-security-query.d.ts

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+/**
+ * An OpenAPI extension set any query parameters for the OAuth authorize request
+ *
+ * @example
+ * ```yaml
+ * x-scalar-security-query: {
+ *   prompt: 'consent',
+ *   audience: 'scalar'
+ * }
+ * ```
+ */
+export declare const XScalarSecurityQuery: z.ZodObject<{
+    'x-scalar-security-query': z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    'x-scalar-security-query'?: Record<string, string> | undefined;
+}, {
+    'x-scalar-security-query'?: Record<string, string> | undefined;
+}>;
+//# sourceMappingURL=x-scalar-security-query.d.ts.map

package/dist/schemas/extensions/x-scalar-security-query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"x-scalar-security-query.d.ts","sourceRoot":"","sources":["../../../src/schemas/extensions/x-scalar-security-query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB;;;;;;EAE/B,CAAA"}

package/dist/schemas/extensions/x-scalar-security-query.js

@@ -0,0 +1,8 @@
+import { z } from "zod";
+const XScalarSecurityQuery = z.object({
+  "x-scalar-security-query": z.record(z.string(), z.string()).optional()
+});
+export {
+  XScalarSecurityQuery
+};
+//# sourceMappingURL=x-scalar-security-query.js.map

package/dist/schemas/extensions/x-scalar-security-query.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/schemas/extensions/x-scalar-security-query.ts"],
+  "sourcesContent": ["import { z } from 'zod'\n\n/**\n * An OpenAPI extension set any query parameters for the OAuth authorize request\n *\n * @example\n * ```yaml\n * x-scalar-security-query: {\n *   prompt: 'consent',\n *   audience: 'scalar'\n * }\n * ```\n */\nexport const XScalarSecurityQuery = z.object({\n  'x-scalar-security-query': z.record(z.string(), z.string()).optional(),\n})\n"],
+  "mappings": "AAAA,SAAS,SAAS;AAaX,MAAM,uBAAuB,EAAE,OAAO;AAAA,EAC3C,2BAA2B,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,OAAO,CAAC,EAAE,SAAS;AACvE,CAAC;",
+  "names": []
+}

package/dist/schemas/extensions/x-scalar-security-query.test.js

@@ -0,0 +1,35 @@
+import { describe, expect, it } from "vitest";
+import { XScalarSecurityQuery } from "./x-scalar-security-query.js";
+describe("XScalarSecurityQuery", () => {
+  it("allows any property", () => {
+    const result = XScalarSecurityQuery.parse({
+      "x-scalar-security-query": {
+        prompt: "consent"
+      }
+    });
+    expect(result).toEqual({
+      "x-scalar-security-query": {
+        prompt: "consent"
+      }
+    });
+  });
+  it("allows more than one property", () => {
+    const result = XScalarSecurityQuery.parse({
+      "x-scalar-security-query": {
+        prompt: "consent",
+        audience: "scalar"
+      }
+    });
+    expect(result).toEqual({
+      "x-scalar-security-query": {
+        prompt: "consent",
+        audience: "scalar"
+      }
+    });
+  });
+  it("can be empty, not required", () => {
+    const result = XScalarSecurityQuery.parse({});
+    expect(result).toEqual({});
+  });
+});
+//# sourceMappingURL=x-scalar-security-query.test.js.map

package/dist/schemas/extensions/x-scalar-security-query.test.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/schemas/extensions/x-scalar-security-query.test.ts"],
+  "sourcesContent": ["import { describe, expect, it } from 'vitest'\nimport { XScalarSecurityQuery } from './x-scalar-security-query'\n\ndescribe('XScalarSecurityQuery', () => {\n  it('allows any property', () => {\n    const result = XScalarSecurityQuery.parse({\n      'x-scalar-security-query': {\n        prompt: 'consent',\n      },\n    })\n\n    expect(result).toEqual({\n      'x-scalar-security-query': {\n        prompt: 'consent',\n      },\n    })\n  })\n\n  it('allows more than one property', () => {\n    const result = XScalarSecurityQuery.parse({\n      'x-scalar-security-query': {\n        prompt: 'consent',\n        audience: 'scalar',\n      },\n    })\n\n    expect(result).toEqual({\n      'x-scalar-security-query': {\n        prompt: 'consent',\n        audience: 'scalar',\n      },\n    })\n  })\n\n  it('can be empty, not required', () => {\n    const result = XScalarSecurityQuery.parse({})\n\n    expect(result).toEqual({})\n  })\n})\n"],
+  "mappings": "AAAA,SAAS,UAAU,QAAQ,UAAU;AACrC,SAAS,4BAA4B;AAErC,SAAS,wBAAwB,MAAM;AACrC,KAAG,uBAAuB,MAAM;AAC9B,UAAM,SAAS,qBAAqB,MAAM;AAAA,MACxC,2BAA2B;AAAA,QACzB,QAAQ;AAAA,MACV;AAAA,IACF,CAAC;AAED,WAAO,MAAM,EAAE,QAAQ;AAAA,MACrB,2BAA2B;AAAA,QACzB,QAAQ;AAAA,MACV;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,KAAG,iCAAiC,MAAM;AACxC,UAAM,SAAS,qBAAqB,MAAM;AAAA,MACxC,2BAA2B;AAAA,QACzB,QAAQ;AAAA,QACR,UAAU;AAAA,MACZ;AAAA,IACF,CAAC;AAED,WAAO,MAAM,EAAE,QAAQ;AAAA,MACrB,2BAA2B;AAAA,QACzB,QAAQ;AAAA,QACR,UAAU;AAAA,MACZ;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,KAAG,8BAA8B,MAAM;AACrC,UAAM,SAAS,qBAAqB,MAAM,CAAC,CAAC;AAE5C,WAAO,MAAM,EAAE,QAAQ,CAAC,CAAC;AAAA,EAC3B,CAAC;AACH,CAAC;",
+  "names": []
+}

package/package.json

@@ -16,9 +16,9 @@
     "swagger",
     "typescript"
   ],
-  "version": "0.2.2",
+  "version": "0.3.1",
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "type": "module",
   "exports": {
@@ -53,7 +53,7 @@
     "zod": "3.24.1"
   },
   "devDependencies": {
-    "@scalar/build-tooling": "0.1.19"
+    "@scalar/build-tooling": "0.2.0"
   },
   "scripts": {
     "build": "scalar-build-esbuild",