@scalar/openapi-types 0.1.8 → 0.2.0

package/dist/schemas/extensions/x-scalar-icon.d.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+export declare const XScalarIconSchema: z.ZodObject<{
+    'x-scalar-icon': z.ZodCatch<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    'x-scalar-icon'?: string | undefined;
+}, {
+    'x-scalar-icon'?: unknown;
+}>;
+//# sourceMappingURL=x-scalar-icon.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"x-scalar-icon.d.ts","sourceRoot":"","sources":["../../../src/schemas/extensions/x-scalar-icon.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,iBAAiB;;;;;;EAE5B,CAAA"}

package/dist/schemas/extensions/x-scalar-icon.js

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+
+const XScalarIconSchema = z.object({
+    'x-scalar-icon': z.string().optional().catch(undefined),
+});
+
+export { XScalarIconSchema };

package/dist/schemas/extensions/x-scalar-ignore.d.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+export declare const XScalarIgnoreSchema: z.ZodObject<{
+    'x-scalar-ignore': z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    'x-scalar-ignore'?: boolean | undefined;
+}, {
+    'x-scalar-ignore'?: unknown;
+}>;
+//# sourceMappingURL=x-scalar-ignore.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"x-scalar-ignore.d.ts","sourceRoot":"","sources":["../../../src/schemas/extensions/x-scalar-ignore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,mBAAmB;;;;;;EAE9B,CAAA"}

package/dist/schemas/extensions/x-scalar-ignore.js

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+
+const XScalarIgnoreSchema = z.object({
+    'x-scalar-ignore': z.boolean().optional().catch(undefined),
+});
+
+export { XScalarIgnoreSchema };

package/dist/schemas/extensions/x-scalar-redirect-uri.d.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+export declare const XScalarRedirectUriSchema: z.ZodObject<{
+    'x-scalar-redirect-uri': z.ZodCatch<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    'x-scalar-redirect-uri'?: string | undefined;
+}, {
+    'x-scalar-redirect-uri'?: unknown;
+}>;
+//# sourceMappingURL=x-scalar-redirect-uri.d.ts.map

package/dist/schemas/extensions/x-scalar-redirect-uri.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"x-scalar-redirect-uri.d.ts","sourceRoot":"","sources":["../../../src/schemas/extensions/x-scalar-redirect-uri.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,wBAAwB;;;;;;EAEnC,CAAA"}

package/dist/schemas/extensions/x-scalar-redirect-uri.js

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+
+const XScalarRedirectUriSchema = z.object({
+    'x-scalar-redirect-uri': z.string().optional().catch(undefined),
+});
+
+export { XScalarRedirectUriSchema };

package/dist/schemas/extensions/x-scalar-stability.d.ts

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+export declare const XScalarStabilityValues: {
+    readonly Deprecated: "deprecated";
+    readonly Experimental: "experimental";
+    readonly Stable: "stable";
+};
+export type XScalarStabilityValues = (typeof XScalarStabilityValues)[keyof typeof XScalarStabilityValues];
+/**
+ * An OpenAPI extension to indicate the stability of the operation
+ *
+ * @example
+ * ```yaml
+ * x-scalar-stability: deprecated
+ * ```
+ */
+export declare const XScalarStabilitySchema: z.ZodObject<{
+    'x-scalar-stability': z.ZodCatch<z.ZodOptional<z.ZodEnum<[string, ...string[]]>>>;
+}, "strip", z.ZodTypeAny, {
+    'x-scalar-stability'?: string | undefined;
+}, {
+    'x-scalar-stability'?: unknown;
+}>;
+//# sourceMappingURL=x-scalar-stability.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"x-scalar-stability.d.ts","sourceRoot":"","sources":["../../../src/schemas/extensions/x-scalar-stability.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,sBAAsB;;;;CAIzB,CAAA;AAEV,MAAM,MAAM,sBAAsB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,OAAO,sBAAsB,CAAC,CAAA;AAEzG;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB;;;;;;EAKjC,CAAA"}

package/dist/schemas/extensions/x-scalar-stability.js

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+
+const XScalarStabilityValues = {
+    Deprecated: 'deprecated',
+    Experimental: 'experimental',
+    Stable: 'stable',
+};
+/**
+ * An OpenAPI extension to indicate the stability of the operation
+ *
+ * @example
+ * ```yaml
+ * x-scalar-stability: deprecated
+ * ```
+ */
+const XScalarStabilitySchema = z.object({
+    'x-scalar-stability': z
+        .enum(Object.values(XScalarStabilityValues))
+        .optional()
+        .catch(undefined),
+});
+
+export { XScalarStabilitySchema, XScalarStabilityValues };

package/dist/schemas/extensions/x-tag-groups.d.ts

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+export declare const XTagGroupSchema: z.ZodObject<{
+    /**
+     * The group name.
+     */
+    name: z.ZodString;
+    /**
+     * List of tags to include in this group.
+     */
+    tags: z.ZodCatch<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    tags: string[];
+    name: string;
+}, {
+    name: string;
+    tags?: unknown;
+}>;
+/**
+ * x-tagGroups
+ *
+ * List of tags to include in this group.
+ */
+export declare const XTagGroupsSchema: z.ZodCatch<z.ZodArray<z.ZodObject<{
+    /**
+     * The group name.
+     */
+    name: z.ZodString;
+    /**
+     * List of tags to include in this group.
+     */
+    tags: z.ZodCatch<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    tags: string[];
+    name: string;
+}, {
+    name: string;
+    tags?: unknown;
+}>, "many">>;
+//# sourceMappingURL=x-tag-groups.d.ts.map

package/dist/schemas/extensions/x-tag-groups.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"x-tag-groups.d.ts","sourceRoot":"","sources":["../../../src/schemas/extensions/x-tag-groups.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,eAAe;IAC1B;;OAEG;;IAEH;;OAEG;;;;;;;;EAEH,CAAA;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB;IAf3B;;OAEG;;IAEH;;OAEG;;;;;;;;YAS4D,CAAA"}

package/dist/schemas/extensions/x-tag-groups.js

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+
+const XTagGroupSchema = z.object({
+    /**
+     * The group name.
+     */
+    name: z.string(),
+    /**
+     * List of tags to include in this group.
+     */
+    tags: z.coerce.string().array().catch([]),
+});
+/**
+ * x-tagGroups
+ *
+ * List of tags to include in this group.
+ */
+const XTagGroupsSchema = XTagGroupSchema.array().catch([]);
+
+export { XTagGroupSchema, XTagGroupsSchema };

package/dist/schemas/extensions/x-use-pkce.d.ts

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+/** Options for the x-usePkce extension */
+export declare const XUsePkceValues: readonly ["SHA-256", "plain", "no"];
+export declare const XusePkceSchema: z.ZodObject<{
+    /**
+     * Use x-usePkce to enable Proof Key for Code Exchange (PKCE) for the Oauth2 authorization code flow.
+     */
+    'x-usePkce': z.ZodDefault<z.ZodOptional<z.ZodEnum<["SHA-256", "plain", "no"]>>>;
+}, "strip", z.ZodTypeAny, {
+    'x-usePkce': "SHA-256" | "plain" | "no";
+}, {
+    'x-usePkce'?: "SHA-256" | "plain" | "no" | undefined;
+}>;
+//# sourceMappingURL=x-use-pkce.d.ts.map

package/dist/schemas/extensions/x-use-pkce.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"x-use-pkce.d.ts","sourceRoot":"","sources":["../../../src/schemas/extensions/x-use-pkce.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,0CAA0C;AAC1C,eAAO,MAAM,cAAc,qCAAsC,CAAA;AAEjE,eAAO,MAAM,cAAc;IACzB;;OAEG;;;;;;EAEH,CAAA"}

package/dist/schemas/extensions/x-use-pkce.js

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+
+/** Options for the x-usePkce extension */
+const XUsePkceValues = ['SHA-256', 'plain', 'no'];
+const XusePkceSchema = z.object({
+    /**
+     * Use x-usePkce to enable Proof Key for Code Exchange (PKCE) for the Oauth2 authorization code flow.
+     */
+    'x-usePkce': z.enum(XUsePkceValues).optional().default('no'),
+});
+
+export { XUsePkceValues, XusePkceSchema };

package/package.json

@@ -16,7 +16,7 @@
     "swagger",
     "typescript"
   ],
-  "version": "0.1.8",
+  "version": "0.2.0",
   "engines": {
     "node": ">=18"
   },
@@ -26,6 +26,21 @@
       "import": "./dist/index.js",
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
+    },
+    "./schemas/extensions": {
+      "import": "./dist/schemas/extensions/index.js",
+      "types": "./dist/schemas/extensions/index.d.ts",
+      "default": "./dist/schemas/extensions/index.js"
+    },
+    "./schemas/3.1/unprocessed": {
+      "import": "./dist/schemas/3.1/unprocessed/index.js",
+      "types": "./dist/schemas/3.1/unprocessed/index.d.ts",
+      "default": "./dist/schemas/3.1/unprocessed/index.js"
+    },
+    "./schemas/3.1/processed": {
+      "import": "./dist/schemas/3.1/processed/index.js",
+      "types": "./dist/schemas/3.1/processed/index.d.ts",
+      "default": "./dist/schemas/3.1/processed/index.js"
     }
   },
   "files": [
@@ -34,8 +49,11 @@
     "CHANGELOG.md"
   ],
   "sideEffects": false,
+  "dependencies": {
+    "zod": "^3.23.8"
+  },
   "devDependencies": {
-    "@scalar/build-tooling": "0.1.14"
+    "@scalar/build-tooling": "0.1.17"
   },
   "scripts": {
     "build": "pnpm types:check && rollup -c --configPlugin typescript && pnpm types:build",

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023-present Scalar
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.