@scalar/workspace-store 0.4.0 → 0.5.0

package/dist/navigation/types.d.ts

@@ -1,7 +1,8 @@
-import type { OpenAPIV3_1 } from '@scalar/openapi-types';
+import type { OperationObject } from '../schemas/v3.1/strict/path-operations.js';
+import type { TagObject } from '../schemas/v3.1/strict/tag.js';
 /** Map of tagNames and their entries */
 export type TagsMap = Map<string, {
-    tag: OpenAPIV3_1.TagObject;
+    tag: TagObject;
     entries: TraversedEntry[];
 }>;
 type TraverseEntryBase = {
@@ -18,7 +19,7 @@ export type TraversedDescription = TraverseEntryBase & {
 export type TraversedOperation = TraverseEntryBase & {
     type: 'operation';
     ref: string;
-    method: OpenAPIV3_1.HttpMethods;
+    method: string;
     path: string;
 };
 /** Model entry returned form traversing the document */
@@ -38,7 +39,7 @@ export type TraversedTag = TraverseEntryBase & {
 export type TraversedWebhook = TraverseEntryBase & {
     type: 'webhook';
     ref: string;
-    method: OpenAPIV3_1.HttpMethods;
+    method: string;
     name: string;
 };
 /** Entries returned form traversing the document */
@@ -57,7 +58,7 @@ type OperationSortValue = {
  */
 export type TraverseSpecOptions = {
     /** Controls how tags are sorted - either alphabetically or using a custom sort function */
-    tagsSorter: 'alpha' | ((a: OpenAPIV3_1.TagObject, b: OpenAPIV3_1.TagObject) => number);
+    tagsSorter: 'alpha' | ((a: TagObject, b: TagObject) => number);
     /** Controls how operations are sorted - alphabetically, by method, or using a custom sort function */
     operationsSorter: 'alpha' | 'method' | ((a: OperationSortValue, b: OperationSortValue) => number);
     /** Whether to hide model schemas from the navigation */
@@ -71,19 +72,19 @@ export type TraverseSpecOptions = {
     /** Function to generate unique IDs for operations */
     getOperationId: (operation: {
         path: string;
-        method: OpenAPIV3_1.HttpMethods;
-    } & OpenAPIV3_1.OperationObject, parentTag: OpenAPIV3_1.TagObject) => string;
+        method: string;
+    } & OperationObject, parentTag: TagObject) => string;
     /** Function to generate unique IDs for webhooks */
     getWebhookId: (webhook?: {
         name: string;
         method?: string;
-    }, parentTag?: OpenAPIV3_1.TagObject) => string;
+    }, parentTag?: TagObject) => string;
     /** Function to generate unique IDs for models/schemas */
     getModelId: (model?: {
         name: string;
-    }, parentTag?: OpenAPIV3_1.TagObject) => string;
+    }, parentTag?: TagObject) => string;
     /** Function to generate unique IDs for tags */
-    getTagId: (tag: OpenAPIV3_1.TagObject) => string;
+    getTagId: (tag: TagObject) => string;
 };
 export type Heading = {
     depth: number;

package/dist/navigation/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/navigation/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,wCAAwC;AACxC,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,EAAE;IAAE,GAAG,EAAE,WAAW,CAAC,SAAS,CAAC;IAAC,OAAO,EAAE,cAAc,EAAE,CAAA;CAAE,CAAC,CAAA;AAE5F,KAAK,iBAAiB,GAAG;IACvB,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,OAAO,GAAG,KAAK,GAAG,SAAS,CAAA;IACxD,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,8DAA8D;AAC9D,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,GAAG;IACrD,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAA;CAC/B,CAAA;AAED,4DAA4D;AAC5D,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,GAAG;IACnD,IAAI,EAAE,WAAW,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,WAAW,CAAC,WAAW,CAAA;IAC/B,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,wDAAwD;AACxD,MAAM,MAAM,eAAe,GAAG,iBAAiB,GAAG;IAChD,IAAI,EAAE,OAAO,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,0EAA0E;AAC1E,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG;IAC7C,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAA;IAC3B,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,4HAA4H;AAC5H,MAAM,MAAM,gBAAgB,GAAG,iBAAiB,GAAG;IACjD,IAAI,EAAE,SAAS,CAAA;IACf,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,WAAW,CAAC,WAAW,CAAA;IAC/B,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,oDAAoD;AACpD,MAAM,MAAM,cAAc,GACtB,oBAAoB,GACpB,kBAAkB,GAClB,eAAe,GACf,YAAY,GACZ,gBAAgB,CAAA;AAEpB,KAAK,kBAAkB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAA;AAEvE;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,2FAA2F;IAC3F,UAAU,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,SAAS,EAAE,CAAC,EAAE,WAAW,CAAC,SAAS,KAAK,MAAM,CAAC,CAAA;IAEtF,sGAAsG;IACtG,gBAAgB,EAAE,OAAO,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,CAAC,EAAE,kBAAkB,KAAK,MAAM,CAAC,CAAA;IAEjG,wDAAwD;IACxD,UAAU,EAAE,OAAO,CAAA;IAEnB,4DAA4D;IAC5D,YAAY,EAAE,CAAC,OAAO,EAAE;QACtB,KAAK,EAAE,MAAM,CAAA;QACb,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,KAAK,MAAM,CAAA;IAEZ,qDAAqD;IACrD,cAAc,EAAE,CACd,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,WAAW,CAAC,WAAW,CAAA;KAChC,GAAG,WAAW,CAAC,eAAe,EAC/B,SAAS,EAAE,WAAW,CAAC,SAAS,KAC7B,MAAM,CAAA;IAEX,mDAAmD;IACnD,YAAY,EAAE,CACZ,OAAO,CAAC,EAAE;QACR,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,EACD,SAAS,CAAC,EAAE,WAAW,CAAC,SAAS,KAC9B,MAAM,CAAA;IAEX,yDAAyD;IACzD,UAAU,EAAE,CACV,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAA;KACb,EACD,SAAS,CAAC,EAAE,WAAW,CAAC,SAAS,KAC9B,MAAM,CAAA;IAEX,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,GAAG,EAAE,WAAW,CAAC,SAAS,KAAK,MAAM,CAAA;CACjD,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/navigation/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAA;AAC5E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAE1D,wCAAwC;AACxC,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,EAAE;IAAE,GAAG,EAAE,SAAS,CAAC;IAAC,OAAO,EAAE,cAAc,EAAE,CAAA;CAAE,CAAC,CAAA;AAEhF,KAAK,iBAAiB,GAAG;IACvB,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,OAAO,GAAG,KAAK,GAAG,SAAS,CAAA;IACxD,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,8DAA8D;AAC9D,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,GAAG;IACrD,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAA;CAC/B,CAAA;AAED,4DAA4D;AAC5D,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,GAAG;IACnD,IAAI,EAAE,WAAW,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,wDAAwD;AACxD,MAAM,MAAM,eAAe,GAAG,iBAAiB,GAAG;IAChD,IAAI,EAAE,OAAO,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,0EAA0E;AAC1E,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG;IAC7C,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAA;IAC3B,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,4HAA4H;AAC5H,MAAM,MAAM,gBAAgB,GAAG,iBAAiB,GAAG;IACjD,IAAI,EAAE,SAAS,CAAA;IACf,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,oDAAoD;AACpD,MAAM,MAAM,cAAc,GACtB,oBAAoB,GACpB,kBAAkB,GAClB,eAAe,GACf,YAAY,GACZ,gBAAgB,CAAA;AAEpB,KAAK,kBAAkB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAA;AAEvE;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,2FAA2F;IAC3F,UAAU,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,KAAK,MAAM,CAAC,CAAA;IAE9D,sGAAsG;IACtG,gBAAgB,EAAE,OAAO,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,CAAC,EAAE,kBAAkB,KAAK,MAAM,CAAC,CAAA;IAEjG,wDAAwD;IACxD,UAAU,EAAE,OAAO,CAAA;IAEnB,4DAA4D;IAC5D,YAAY,EAAE,CAAC,OAAO,EAAE;QACtB,KAAK,EAAE,MAAM,CAAA;QACb,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,KAAK,MAAM,CAAA;IAEZ,qDAAqD;IACrD,cAAc,EAAE,CACd,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,MAAM,CAAA;KACf,GAAG,eAAe,EACnB,SAAS,EAAE,SAAS,KACjB,MAAM,CAAA;IAEX,mDAAmD;IACnD,YAAY,EAAE,CACZ,OAAO,CAAC,EAAE;QACR,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,EACD,SAAS,CAAC,EAAE,SAAS,KAClB,MAAM,CAAA;IAEX,yDAAyD;IACzD,UAAU,EAAE,CACV,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAA;KACb,EACD,SAAS,CAAC,EAAE,SAAS,KAClB,MAAM,CAAA;IAEX,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,GAAG,EAAE,SAAS,KAAK,MAAM,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA"}

package/dist/schemas/typebox-coerce.d.ts

@@ -0,0 +1,26 @@
+import type { TSchema } from '@sinclair/typebox';
+/**
+ * Coerces a value to match the provided TypeBox schema by first converting and then casting the value.
+ * This is useful for ensuring values match their expected types, especially when dealing with
+ * form inputs or API responses that may need type conversion.
+ *
+ * @param schema - The TypeBox schema to coerce the value against
+ * @param value - The value to coerce
+ * @returns The coerced value that matches the schema
+ *
+ * @example
+ * // Convert string "123" to number
+ * const schema = Type.Number()
+ * const value = "123"
+ * const coerced = coerceValue(schema, value) // Returns 123
+ *
+ * @example
+ * // Convert string "true" to boolean
+ * const schema = Type.Boolean()
+ * const value = "true"
+ * const coerced = coerceValue(schema, value) // Returns true
+ */
+export declare const coerceValue: <T extends TSchema>(schema: T, value: unknown) => (T & {
+    params: [];
+})["static"];
+//# sourceMappingURL=typebox-coerce.d.ts.map

package/dist/schemas/typebox-coerce.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typebox-coerce.d.ts","sourceRoot":"","sources":["../../src/schemas/typebox-coerce.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAGhD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,OAAO,UAAU,CAAC,SAAS,OAAO;;YAEvE,CAAA"}

package/dist/schemas/typebox-coerce.js

@@ -0,0 +1,8 @@
+import { Value } from "@sinclair/typebox/value";
+const coerceValue = (schema, value) => {
+  return Value.Cast(schema, Value.Convert(schema, value));
+};
+export {
+  coerceValue
+};
+//# sourceMappingURL=typebox-coerce.js.map

package/dist/schemas/typebox-coerce.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/schemas/typebox-coerce.ts"],
+  "sourcesContent": ["import type { TSchema } from '@sinclair/typebox'\nimport { Value } from '@sinclair/typebox/value'\n\n/**\n * Coerces a value to match the provided TypeBox schema by first converting and then casting the value.\n * This is useful for ensuring values match their expected types, especially when dealing with\n * form inputs or API responses that may need type conversion.\n *\n * @param schema - The TypeBox schema to coerce the value against\n * @param value - The value to coerce\n * @returns The coerced value that matches the schema\n *\n * @example\n * // Convert string \"123\" to number\n * const schema = Type.Number()\n * const value = \"123\"\n * const coerced = coerceValue(schema, value) // Returns 123\n *\n * @example\n * // Convert string \"true\" to boolean\n * const schema = Type.Boolean()\n * const value = \"true\"\n * const coerced = coerceValue(schema, value) // Returns true\n */\nexport const coerceValue = <T extends TSchema>(schema: T, value: unknown) => {\n  return Value.Cast(schema, Value.Convert(schema, value))\n}\n"],
+  "mappings": "AACA,SAAS,aAAa;AAuBf,MAAM,cAAc,CAAoB,QAAW,UAAmB;AAC3E,SAAO,MAAM,KAAK,QAAQ,MAAM,QAAQ,QAAQ,KAAK,CAAC;AACxD;",
+  "names": []
+}

package/dist/schemas/v3.1/compose.d.ts

@@ -0,0 +1,6 @@
+import { Type, type TSchema } from '@sinclair/typebox';
+/**
+ * Work around for: https://github.com/sinclairzx81/typebox/issues/1264
+ */
+export declare const compose: <A extends TSchema[]>(...args: A) => ReturnType<typeof Type.Intersect<A>>;
+//# sourceMappingURL=compose.d.ts.map

package/dist/schemas/v3.1/compose.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compose.d.ts","sourceRoot":"","sources":["../../../src/schemas/v3.1/compose.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAEtD;;GAEG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,SAAS,OAAO,EAAE,WAAW,CAAC,KACX,UAAU,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAC9E,CAAA"}

package/dist/schemas/v3.1/compose.js

@@ -0,0 +1,8 @@
+import { Type } from "@sinclair/typebox";
+const compose = (...args) => {
+  return Type.Composite(args);
+};
+export {
+  compose
+};
+//# sourceMappingURL=compose.js.map

package/dist/schemas/v3.1/compose.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/schemas/v3.1/compose.ts"],
+  "sourcesContent": ["import { Type, type TSchema } from '@sinclair/typebox'\n\n/**\n * Work around for: https://github.com/sinclairzx81/typebox/issues/1264\n */\nexport const compose = <A extends TSchema[]>(...args: A) => {\n  return Type.Composite(args) as unknown as ReturnType<typeof Type.Intersect<A>>\n}\n"],
+  "mappings": "AAAA,SAAS,YAA0B;AAK5B,MAAM,UAAU,IAAyB,SAAY;AAC1D,SAAO,KAAK,UAAU,IAAI;AAC5B;",
+  "names": []
+}

package/dist/schemas/v3.1/strict/callback.d.ts

@@ -0,0 +1,3 @@
+import { type TSchema } from '@sinclair/typebox';
+export declare const callbackObjectSchemaBuilder: <P extends TSchema>(pathItem: P) => import("@sinclair/typebox").TIntersect<[import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, P>, import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TTemplateLiteralSyntax<"x-${string}">, import("@sinclair/typebox").TUnknown>]>;
+//# sourceMappingURL=callback.d.ts.map

package/dist/schemas/v3.1/strict/callback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"callback.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/callback.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAItD,eAAO,MAAM,2BAA2B,GAAI,CAAC,SAAS,OAAO,YAAY,CAAC,wQAQvE,CAAA"}

package/dist/schemas/v3.1/strict/callback.js

@@ -0,0 +1,15 @@
+import { Type } from "@sinclair/typebox";
+import { ExtensionsSchema } from "../../../schemas/v3.1/strict/extensions.js";
+import { compose } from "../../../schemas/v3.1/compose.js";
+const callbackObjectSchemaBuilder = (pathItem) => compose(
+  Type.Record(
+    Type.String(),
+    /** A Path Item Object used to define a callback request and expected responses. A complete example is available. */
+    pathItem
+  ),
+  ExtensionsSchema
+);
+export {
+  callbackObjectSchemaBuilder
+};
+//# sourceMappingURL=callback.js.map

package/dist/schemas/v3.1/strict/callback.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/schemas/v3.1/strict/callback.ts"],
+  "sourcesContent": ["import { Type, type TSchema } from '@sinclair/typebox'\nimport { ExtensionsSchema } from '@/schemas/v3.1/strict/extensions'\nimport { compose } from '@/schemas/v3.1/compose'\n\nexport const callbackObjectSchemaBuilder = <P extends TSchema>(pathItem: P) =>\n  compose(\n    Type.Record(\n      Type.String(),\n      /** A Path Item Object used to define a callback request and expected responses. A complete example is available. */\n      pathItem,\n    ),\n    ExtensionsSchema,\n  )\n"],
+  "mappings": "AAAA,SAAS,YAA0B;AACnC,SAAS,wBAAwB;AACjC,SAAS,eAAe;AAEjB,MAAM,8BAA8B,CAAoB,aAC7D;AAAA,EACE,KAAK;AAAA,IACH,KAAK,OAAO;AAAA;AAAA,IAEZ;AAAA,EACF;AAAA,EACA;AACF;",
+  "names": []
+}