@scalar/oas-utils 0.2.111 → 0.2.113

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @scalar/oas-utils
 
+## 0.2.113
+
+### Patch Changes
+
+- a31973c: feat: add ScalarStabilitySchema
+- Updated dependencies [bab7990]
+- Updated dependencies [2c621d4]
+  - @scalar/types@0.0.39
+  - @scalar/themes@0.9.74
+
+## 0.2.112
+
+### Patch Changes
+
+- Updated dependencies [7f1a40e]
+  - @scalar/types@0.0.38
+  - @scalar/themes@0.9.73
+
 ## 0.2.111
 
 ### Patch Changes

package/dist/entities/spec/operation.d.ts

@@ -5,7 +5,7 @@
 import { type RequestPayload, type Request as RequestType } from './requests.js';
 export type Operation = RequestType;
 export type OperationPayload = RequestPayload;
-export declare const operationSchema: import("zod").ZodObject<import("zod").objectUtil.extendShape<Omit<{
+export declare const operationSchema: import("zod").ZodObject<import("zod").objectUtil.extendShape<import("zod").objectUtil.extendShape<Omit<{
     tags: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
     summary: import("zod").ZodOptional<import("zod").ZodString>;
     description: import("zod").ZodOptional<import("zod").ZodString>;
@@ -161,6 +161,8 @@ export declare const operationSchema: import("zod").ZodObject<import("zod").obje
     'x-internal': import("zod").ZodOptional<import("zod").ZodBoolean>;
     'x-scalar-ignore': import("zod").ZodOptional<import("zod").ZodBoolean>;
 }, "x-scalar-examples">, {
+    'x-scalar-stability': import("zod").ZodCatch<import("zod").ZodOptional<import("zod").ZodEnum<[import("@scalar/types").XScalarStability.Deprecated, import("@scalar/types").XScalarStability.Experimental, import("@scalar/types").XScalarStability.Stable]>>>;
+}>, {
     type: import("zod").ZodDefault<import("zod").ZodOptional<import("zod").ZodLiteral<"request">>>;
     uid: import("zod").ZodBranded<import("zod").ZodDefault<import("zod").ZodOptional<import("zod").ZodString>>, "operation">;
     path: import("zod").ZodDefault<import("zod").ZodOptional<import("zod").ZodString>>;
@@ -207,6 +209,7 @@ export declare const operationSchema: import("zod").ZodObject<import("zod").obje
     }[] | undefined;
     requestBody?: any;
     responses?: Record<string, any> | undefined;
+    'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
 }, {
     path?: string | undefined;
     type?: "request" | undefined;
@@ -244,6 +247,7 @@ export declare const operationSchema: import("zod").ZodObject<import("zod").obje
     }[] | undefined;
     requestBody?: any;
     responses?: Record<string, any> | undefined;
+    'x-scalar-stability'?: unknown;
     method?: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace" | undefined;
 }>;
 //# sourceMappingURL=operation.d.ts.map

package/dist/entities/spec/operation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/operation.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,OAAO,IAAI,WAAW,EAAiB,MAAM,YAAY,CAAA;AAE5F,MAAM,MAAM,SAAS,GAAG,WAAW,CAAA;AACnC,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAAA;AAC7C,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAgB,CAAA"}
+{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/operation.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,OAAO,IAAI,WAAW,EAAiB,MAAM,YAAY,CAAA;AAE5F,MAAM,MAAM,SAAS,GAAG,WAAW,CAAA;AACnC,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAAA;AAC7C,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAgB,CAAA"}

package/dist/entities/spec/requests.d.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { XScalarStability } from '@scalar/types';
 import { type RequestExample } from './request-examples.js';
 export declare const requestMethods: readonly ["connect", "delete", "get", "head", "options", "patch", "post", "put", "trace"];
 export type RequestMethod = (typeof requestMethods)[number];
@@ -314,7 +315,7 @@ export declare const oasRequestSchema: z.ZodObject<{
     }> | undefined;
 }>;
 /** Unified request schema for client usage */
-export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
+export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<Omit<{
     /**
      * A list of tags for API documentation control. Tags can be used for logical
      * grouping of operations by resources or any other qualifier.
@@ -505,6 +506,8 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
     'x-internal': z.ZodOptional<z.ZodBoolean>;
     'x-scalar-ignore': z.ZodOptional<z.ZodBoolean>;
 }, "x-scalar-examples">, {
+    'x-scalar-stability': z.ZodCatch<z.ZodOptional<z.ZodEnum<[XScalarStability.Deprecated, XScalarStability.Experimental, XScalarStability.Stable]>>>;
+}>, {
     type: z.ZodDefault<z.ZodOptional<z.ZodLiteral<"request">>>;
     uid: z.ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "operation">;
     /** Path Key */
@@ -557,6 +560,7 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
     }[] | undefined;
     requestBody?: any;
     responses?: Record<string, any> | undefined;
+    'x-scalar-stability'?: XScalarStability | undefined;
 }, {
     path?: string | undefined;
     type?: "request" | undefined;
@@ -594,6 +598,7 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
     }[] | undefined;
     requestBody?: any;
     responses?: Record<string, any> | undefined;
+    'x-scalar-stability'?: unknown;
     method?: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace" | undefined;
 }>;
 export type Request = z.infer<typeof requestSchema>;

package/dist/entities/spec/requests.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/requests.ts"],"names":[],"mappings":"AAEA,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvC,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,oBAAoB,CAAA;AAI9E,eAAO,MAAM,cAAc,2FAA4F,CAAA;AAEvH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAA;AAE3D,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG;IACzD,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,wCAAwC;IACxC,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,wBAAwB;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,0BAA0B;IAC1B,MAAM,EAAE,aAAa,CAAA;IACrB,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,iEAAiE;AACjE,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAMD,2CAA2C;AAC3C,eAAO,MAAM,gBAAgB;IAC3B;;;;;OAKG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;IAEH;;;;;;OAMG;;IAEH;;;;;OAKG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEvB,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAG2B,CAAA;AA0BnD,8CAA8C;AAC9C,eAAO,MAAM,aAAa;IA3ExB;;;;;OAKG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;IAEH;;;;;;OAMG;;IAEH;;;;;OAKG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEvB,sBAAsB;;;;;;IAetB,eAAe;;IAEf,qBAAqB;;IAErB,kDAAkD;;IAElD,oCAAoC;;IAEpC,uDAAuD;;IAEvD,+DAA+D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAK6C,CAAA;AAE9G,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AACnD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA"}
+{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/requests.ts"],"names":[],"mappings":"AAEA,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAEhD,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,oBAAoB,CAAA;AAI9E,eAAO,MAAM,cAAc,2FAA4F,CAAA;AAEvH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAA;AAE3D,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG;IACzD,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,wCAAwC;IACxC,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,wBAAwB;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,0BAA0B;IAC1B,MAAM,EAAE,aAAa,CAAA;IACrB,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,iEAAiE;AACjE,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAMD,2CAA2C;AAC3C,eAAO,MAAM,gBAAgB;IAC3B;;;;;OAKG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;IAEH;;;;;;OAMG;;IAEH;;;;;OAKG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEvB,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAG2B,CAAA;AAyCnD,8CAA8C;AAC9C,eAAO,MAAM,aAAa;IA1FxB;;;;;OAKG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;IAEH;;;;;;OAMG;;IAEH;;;;;OAKG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEvB,sBAAsB;;;;;;;;IA8BtB,eAAe;;IAEf,qBAAqB;;IAErB,kDAAkD;;IAElD,oCAAoC;;IAEpC,uDAAuD;;IAEvD,+DAA+D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQlC,CAAA;AAE/B,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AACnD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA"}

package/dist/entities/spec/requests.js

@@ -1,5 +1,6 @@
 import { nanoidSchema, selectedSecuritySchemeUidSchema } from '../shared/utility.js';
 import { z } from 'zod';
+import { XScalarStability } from '@scalar/types';
 import { oasParameterSchema } from './parameters.js';
 import { xScalarExampleSchema } from './request-examples.js';
 import { oasSecurityRequirementSchema } from './security.js';
@@ -58,6 +59,20 @@ const oasRequestSchema = z.object({
     'x-internal': z.boolean().optional(),
     'x-scalar-ignore': z.boolean().optional(),
 });
+/**
+ * An OpenAPI extension to indicate the stability of the operation
+ *
+ * @example
+ * ```yaml
+ * x-scalar-stability: deprecated
+ * ```
+ */
+const ScalarStabilitySchema = z.object({
+    'x-scalar-stability': z
+        .enum([XScalarStability.Deprecated, XScalarStability.Experimental, XScalarStability.Stable])
+        .optional()
+        .catch(undefined),
+});
 /**
  * Extended properties added to the spec definition for client usage
  *
@@ -82,6 +97,9 @@ const extendedRequestSchema = z.object({
     selectedSecuritySchemeUids: selectedSecuritySchemeUidSchema,
 });
 /** Unified request schema for client usage */
-const requestSchema = oasRequestSchema.omit({ 'x-scalar-examples': true }).merge(extendedRequestSchema);
+const requestSchema = oasRequestSchema
+    .omit({ 'x-scalar-examples': true })
+    .merge(ScalarStabilitySchema)
+    .merge(extendedRequestSchema);
 
 export { oasRequestSchema, requestMethods, requestSchema };

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.111",
+  "version": "0.2.113",
   "engines": {
     "node": ">=18"
   },
@@ -127,9 +127,9 @@
     "yaml": "^2.4.5",
     "zod": "^3.23.8",
     "@scalar/object-utils": "1.1.13",
-    "@scalar/types": "0.0.37",
+    "@scalar/themes": "0.9.74",
     "@scalar/openapi-types": "0.1.9",
-    "@scalar/themes": "0.9.72"
+    "@scalar/types": "0.0.39"
   },
   "devDependencies": {
     "type-fest": "^4.20.0",
@@ -137,8 +137,8 @@
     "vitest": "^1.6.0",
     "zod-to-ts": "github:amritk/zod-to-ts#build",
     "@scalar/build-tooling": "0.1.16",
-    "@scalar/openapi-types": "0.1.9",
-    "@scalar/openapi-parser": "0.10.9"
+    "@scalar/openapi-parser": "0.10.9",
+    "@scalar/openapi-types": "0.1.9"
   },
   "scripts": {
     "build": "scalar-build-rollup",