@scalar/oas-utils 0.4.33 → 0.5.0

package/dist/helpers/security/get-schemes.d.ts

@@ -3,69 +3,67 @@ import type { Operation } from '../../entities/spec/operation.js';
 /** Parses a list of selected security scheme uids which may be an array or single uid and returns a flattened array of security schemes */
 export declare const getSchemes: (selectedSecuritySchemes: Operation["selectedSecuritySchemeUids"], securitySchemes: Record<SecurityScheme["uid"], SecurityScheme>) => NonNullable<{
     type: "apiKey";
-    value: string;
     name: string;
-    uid: string & import("zod").BRAND<"securityScheme">;
-    nameKey: string;
     in: "cookie" | "query" | "header";
+    uid: string & import("zod").$brand<"securityScheme">;
+    nameKey: string;
+    value: string;
     description?: string | undefined;
 } | {
     type: "http";
-    uid: string & import("zod").BRAND<"securityScheme">;
-    nameKey: string;
     scheme: "basic" | "bearer";
     bearerFormat: string;
+    uid: string & import("zod").$brand<"securityScheme">;
+    nameKey: string;
     username: string;
     password: string;
     token: string;
     description?: string | undefined;
 } | {
     type: "openIdConnect";
-    uid: string & import("zod").BRAND<"securityScheme">;
-    nameKey: string;
     openIdConnectUrl: string;
+    uid: string & import("zod").$brand<"securityScheme">;
+    nameKey: string;
     description?: string | undefined;
 } | {
     type: "oauth2";
-    uid: string & import("zod").BRAND<"securityScheme">;
-    nameKey: string;
     flows: {
-        password?: {
-            type: "password";
-            username: string;
-            password: string;
-            token: string;
+        implicit?: {
             refreshUrl: string;
             scopes: Record<string, string>;
             selectedScopes: string[];
             "x-scalar-client-id": string;
-            tokenUrl: string;
-            clientSecret: string;
+            token: string;
+            type: "implicit";
+            authorizationUrl: string;
+            "x-scalar-redirect-uri": string;
             "x-scalar-security-query"?: Record<string, string> | undefined;
             "x-scalar-security-body"?: Record<string, string> | undefined;
             "x-tokenName"?: string | undefined;
-            "x-scalar-credentials-location"?: "header" | "body" | undefined;
         } | undefined;
-        implicit?: {
-            type: "implicit";
-            token: string;
+        password?: {
             refreshUrl: string;
             scopes: Record<string, string>;
             selectedScopes: string[];
             "x-scalar-client-id": string;
-            authorizationUrl: string;
-            "x-scalar-redirect-uri": string;
+            token: string;
+            type: "password";
+            tokenUrl: string;
+            clientSecret: string;
+            username: string;
+            password: string;
             "x-scalar-security-query"?: Record<string, string> | undefined;
             "x-scalar-security-body"?: Record<string, string> | undefined;
             "x-tokenName"?: string | undefined;
+            "x-scalar-credentials-location"?: "header" | "body" | undefined;
         } | undefined;
         clientCredentials?: {
-            type: "clientCredentials";
-            token: string;
             refreshUrl: string;
             scopes: Record<string, string>;
             selectedScopes: string[];
             "x-scalar-client-id": string;
+            token: string;
+            type: "clientCredentials";
             tokenUrl: string;
             clientSecret: string;
             "x-scalar-security-query"?: Record<string, string> | undefined;
@@ -74,23 +72,25 @@ export declare const getSchemes: (selectedSecuritySchemes: Operation["selectedSe
             "x-scalar-credentials-location"?: "header" | "body" | undefined;
         } | undefined;
         authorizationCode?: {
-            type: "authorizationCode";
-            token: string;
             refreshUrl: string;
             scopes: Record<string, string>;
             selectedScopes: string[];
             "x-scalar-client-id": string;
+            token: string;
+            type: "authorizationCode";
             authorizationUrl: string;
+            "x-usePkce": "SHA-256" | "plain" | "no";
             "x-scalar-redirect-uri": string;
             tokenUrl: string;
             clientSecret: string;
-            "x-usePkce": "SHA-256" | "plain" | "no";
             "x-scalar-security-query"?: Record<string, string> | undefined;
             "x-scalar-security-body"?: Record<string, string> | undefined;
             "x-tokenName"?: string | undefined;
             "x-scalar-credentials-location"?: "header" | "body" | undefined;
         } | undefined;
     };
+    uid: string & import("zod").$brand<"securityScheme">;
+    nameKey: string;
     description?: string | undefined;
     'x-default-scopes'?: string[] | undefined;
 }>[];

package/dist/helpers/security/get-schemes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-schemes.d.ts","sourceRoot":"","sources":["../../../src/helpers/security/get-schemes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAG5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAE1D,2IAA2I;AAC3I,eAAO,MAAM,UAAU,GACrB,yBAAyB,SAAS,CAAC,4BAA4B,CAAC,EAChE,iBAAiB,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAOqvqF,CAAC;;;;;;;;;;;qCAA0X,CAAC;oCAA0E,CAAC;yBAA+D,CAAC;2CAAiE,CAAC;;gBAAwE,CAAC;;;;;;;;;qCAAiV,CAAC;oCAA0E,CAAC;yBAA+D,CAAC;;yBAAsE,CAAC;;;;;;;;;qCAAuU,CAAC;oCAA0E,CAAC;yBAA+D,CAAC;2CAAiE,CAAC;;yBAAiF,CAAC;;;;;;;;;;;;qCAA+c,CAAC;oCAA0E,CAAC;yBAA+D,CAAC;2CAAiE,CAAC;;;;;IAD9uvF,CAAA"}
+{"version":3,"file":"get-schemes.d.ts","sourceRoot":"","sources":["../../../src/helpers/security/get-schemes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAG5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAE1D,2IAA2I;AAC3I,eAAO,MAAM,UAAU,GACrB,yBAAyB,SAAS,CAAC,4BAA4B,CAAC,EAChE,iBAAiB,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAOq+mB,CAAC;;;;;;;;;qCAAiV,CAAC;oCAA0E,CAAC;yBAA+D,CAAC;;gBAA6D,CAAC;;;;;;;;;;;qCAA0X,CAAC;oCAA0E,CAAC;yBAA+D,CAAC;2CAAiE,CAAC;;yBAAiF,CAAC;;;;;;;;;qCAAuU,CAAC;oCAA0E,CAAC;yBAA+D,CAAC;2CAAiE,CAAC;;yBAAiF,CAAC;;;;;;;;;;;;qCAA+c,CAAC;oCAA0E,CAAC;yBAA+D,CAAC;2CAAiE,CAAC;;;;;;;IAD99rB,CAAA"}

package/dist/migrations/v-2.5.0/migration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.5.0/migration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAA;AACnE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAEhD,mCAAmC;AACnC,eAAO,MAAM,eAAe,GAAI,MAAM,OAAO,CAAC,UAAU,KAAG,OAAO,CAAC,YAAY,CAkK9E,CAAA"}
+{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.5.0/migration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAA;AAEnE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAEhD,mCAAmC;AACnC,eAAO,MAAM,eAAe,GAAI,MAAM,OAAO,CAAC,UAAU,KAAG,OAAO,CAAC,YAAY,CAkK9E,CAAA"}

package/dist/migrations/v-2.5.0/migration.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/migrations/v-2.5.0/migration.ts"],
-  "sourcesContent": ["import type { v_2_4_0 } from '@/migrations/v-2.4.0/types.generated'\nimport type { v_2_5_0 } from './types.generated'\n\n/** V-2.4.0 to V-2.5.0 migration */\nexport const migrate_v_2_5_0 = (data: v_2_4_0.DataRecord): v_2_5_0['DataRecord'] => {\n  console.info('Performing data migration v-2.4.0 to v-2.5.0')\n\n  const cookies = Object.entries(data.cookies || {}).reduce<Record<string, v_2_5_0['Cookie']>>((acc, [key, cookie]) => {\n    acc[key] = {\n      ...cookie,\n      uid: cookie.uid as v_2_5_0['Cookie']['uid'],\n    } satisfies v_2_5_0['Cookie']\n    return acc\n  }, {})\n\n  const collections = Object.entries(data.collections || {}).reduce<Record<string, v_2_5_0['Collection']>>(\n    (acc, [key, collection]) => {\n      acc[key] = {\n        ...collection,\n        info: collection.info ?? {\n          title: 'API',\n          version: '1.0',\n        },\n        uid: collection.uid as v_2_5_0['Collection']['uid'],\n        selectedSecuritySchemeUids:\n          collection.selectedSecuritySchemeUids as v_2_5_0['Collection']['selectedSecuritySchemeUids'],\n        servers: collection.servers.map((uid) => uid as v_2_5_0['Server']['uid']),\n        tags: collection.tags.map((uid) => uid as v_2_5_0['Tag']['uid']),\n        requests: collection.requests.map((uid) => uid as v_2_5_0['Request']['uid']),\n        children: collection.children.map((uid) => uid as v_2_5_0['Request']['uid'] | v_2_5_0['Tag']['uid']),\n        selectedServerUid: collection.selectedServerUid as v_2_5_0['Server']['uid'],\n        useCollectionSecurity: false,\n      } satisfies v_2_5_0['Collection']\n      return acc\n    },\n    {},\n  )\n\n  const environments = Object.entries(data.environments || {}).reduce<Record<string, v_2_5_0['Environment']>>(\n    (acc, [key, environment]) => {\n      acc[key] = {\n        ...environment,\n        uid: environment.uid as v_2_5_0['Environment']['uid'],\n      } satisfies v_2_5_0['Environment']\n      return acc\n    },\n    {},\n  )\n\n  const requests = Object.entries(data.requests || {}).reduce<Record<string, v_2_5_0['Request']>>(\n    (acc, [key, request]) => {\n      acc[key] = {\n        ...request,\n        uid: request.uid as v_2_5_0['Request']['uid'],\n        servers: request.servers as v_2_5_0['Request']['servers'],\n        selectedServerUid: request.selectedServerUid as v_2_5_0['Request']['selectedServerUid'],\n        examples: request.examples as v_2_5_0['Request']['examples'],\n        selectedSecuritySchemeUids:\n          request.selectedSecuritySchemeUids as v_2_5_0['Request']['selectedSecuritySchemeUids'],\n      } satisfies v_2_5_0['Request']\n      return acc\n    },\n    {},\n  )\n\n  const requestExamples = Object.entries(data.requestExamples || {}).reduce<Record<string, v_2_5_0['RequestExample']>>(\n    (acc, [key, example]) => {\n      const headers = example.parameters.headers\n\n      // Check if \"Accept\" header exists\n      const hasAcceptHeader = headers.some((header) => header.key.toLowerCase() === 'accept')\n\n      if (!hasAcceptHeader) {\n        // Add \"Accept\" header as the first entry\n        headers.unshift({ key: 'Accept', value: '*/*', enabled: true })\n      }\n\n      // Update the example with potentially modified headers\n      acc[key] = {\n        ...example,\n        uid: example.uid as v_2_5_0['RequestExample']['uid'],\n        requestUid: example.requestUid as v_2_5_0['RequestExample']['requestUid'],\n        parameters: {\n          ...example.parameters,\n          headers,\n        },\n      }\n      return acc\n    },\n    {},\n  )\n\n  const securitySchemes = Object.entries(data.securitySchemes || {}).reduce<Record<string, v_2_5_0['SecurityScheme']>>(\n    (acc, [key, securityScheme]) => {\n      acc[key] = {\n        ...securityScheme,\n        uid: securityScheme.uid as v_2_5_0['SecurityScheme']['uid'],\n      } satisfies v_2_5_0['SecurityScheme']\n      return acc\n    },\n    {},\n  )\n\n  const servers = Object.entries(data.servers || {}).reduce<Record<string, v_2_5_0['Server']>>((acc, [key, server]) => {\n    acc[key] = {\n      ...server,\n      uid: server.uid as v_2_5_0['Server']['uid'],\n      variables: Object.entries(server.variables || {}).reduce<\n        Record<\n          string,\n          {\n            enum?: [string, ...string[]]\n            default: string\n            description?: string\n          }\n        >\n      >((variablesAcc, [variableKey, variable]) => {\n        variablesAcc[variableKey] = {\n          default: variable.default ?? '',\n          description: variable.description ?? '',\n          ...(variable.enum?.length && { enum: variable.enum as [string, ...string[]] }),\n        }\n        return variablesAcc\n      }, {}),\n    }\n    return acc\n  }, {})\n\n  const tags = Object.entries(data.tags || {}).reduce<Record<string, v_2_5_0['Tag']>>((acc, [key, tag]) => {\n    acc[key] = {\n      ...tag,\n      uid: tag.uid as v_2_5_0['Tag']['uid'],\n      children: tag.children as v_2_5_0['Tag']['children'],\n    } satisfies v_2_5_0['Tag']\n    return acc\n  }, {})\n\n  const workspaces = Object.entries(data.workspaces || {}).reduce<Record<string, v_2_5_0['Workspace']>>(\n    (acc, [key, workspace]) => {\n      acc[key] = {\n        ...workspace,\n        uid: workspace.uid as v_2_5_0['Workspace']['uid'],\n        collections: workspace.collections.map((uid) => uid as v_2_5_0['Collection']['uid']),\n        cookies: workspace.cookies.map((uid) => uid as v_2_5_0['Cookie']['uid']),\n        selectedHttpClient: {\n          targetKey: 'shell',\n          clientKey: 'curl',\n        },\n      }\n      return acc\n    },\n    {},\n  )\n\n  return {\n    ...data,\n    collections,\n    cookies,\n    environments,\n    requests,\n    requestExamples,\n    securitySchemes,\n    servers,\n    tags,\n    workspaces,\n  } satisfies v_2_5_0['DataRecord']\n}\n"],
-  "mappings": "AAIO,MAAM,kBAAkB,CAAC,SAAoD;AAClF,UAAQ,KAAK,8CAA8C;AAE3D,QAAM,UAAU,OAAO,QAAQ,KAAK,WAAW,CAAC,CAAC,EAAE,OAA0C,CAAC,KAAK,CAAC,KAAK,MAAM,MAAM;AACnH,QAAI,GAAG,IAAI;AAAA,MACT,GAAG;AAAA,MACH,KAAK,OAAO;AAAA,IACd;AACA,WAAO;AAAA,EACT,GAAG,CAAC,CAAC;AAEL,QAAM,cAAc,OAAO,QAAQ,KAAK,eAAe,CAAC,CAAC,EAAE;AAAA,IACzD,CAAC,KAAK,CAAC,KAAK,UAAU,MAAM;AAC1B,UAAI,GAAG,IAAI;AAAA,QACT,GAAG;AAAA,QACH,MAAM,WAAW,QAAQ;AAAA,UACvB,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA,KAAK,WAAW;AAAA,QAChB,4BACE,WAAW;AAAA,QACb,SAAS,WAAW,QAAQ,IAAI,CAAC,QAAQ,GAA+B;AAAA,QACxE,MAAM,WAAW,KAAK,IAAI,CAAC,QAAQ,GAA4B;AAAA,QAC/D,UAAU,WAAW,SAAS,IAAI,CAAC,QAAQ,GAAgC;AAAA,QAC3E,UAAU,WAAW,SAAS,IAAI,CAAC,QAAQ,GAAwD;AAAA,QACnG,mBAAmB,WAAW;AAAA,QAC9B,uBAAuB;AAAA,MACzB;AACA,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAEA,QAAM,eAAe,OAAO,QAAQ,KAAK,gBAAgB,CAAC,CAAC,EAAE;AAAA,IAC3D,CAAC,KAAK,CAAC,KAAK,WAAW,MAAM;AAC3B,UAAI,GAAG,IAAI;AAAA,QACT,GAAG;AAAA,QACH,KAAK,YAAY;AAAA,MACnB;AACA,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAEA,QAAM,WAAW,OAAO,QAAQ,KAAK,YAAY,CAAC,CAAC,EAAE;AAAA,IACnD,CAAC,KAAK,CAAC,KAAK,OAAO,MAAM;AACvB,UAAI,GAAG,IAAI;AAAA,QACT,GAAG;AAAA,QACH,KAAK,QAAQ;AAAA,QACb,SAAS,QAAQ;AAAA,QACjB,mBAAmB,QAAQ;AAAA,QAC3B,UAAU,QAAQ;AAAA,QAClB,4BACE,QAAQ;AAAA,MACZ;AACA,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAEA,QAAM,kBAAkB,OAAO,QAAQ,KAAK,mBAAmB,CAAC,CAAC,EAAE;AAAA,IACjE,CAAC,KAAK,CAAC,KAAK,OAAO,MAAM;AACvB,YAAM,UAAU,QAAQ,WAAW;AAGnC,YAAM,kBAAkB,QAAQ,KAAK,CAAC,WAAW,OAAO,IAAI,YAAY,MAAM,QAAQ;AAEtF,UAAI,CAAC,iBAAiB;AAEpB,gBAAQ,QAAQ,EAAE,KAAK,UAAU,OAAO,OAAO,SAAS,KAAK,CAAC;AAAA,MAChE;AAGA,UAAI,GAAG,IAAI;AAAA,QACT,GAAG;AAAA,QACH,KAAK,QAAQ;AAAA,QACb,YAAY,QAAQ;AAAA,QACpB,YAAY;AAAA,UACV,GAAG,QAAQ;AAAA,UACX;AAAA,QACF;AAAA,MACF;AACA,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAEA,QAAM,kBAAkB,OAAO,QAAQ,KAAK,mBAAmB,CAAC,CAAC,EAAE;AAAA,IACjE,CAAC,KAAK,CAAC,KAAK,cAAc,MAAM;AAC9B,UAAI,GAAG,IAAI;AAAA,QACT,GAAG;AAAA,QACH,KAAK,eAAe;AAAA,MACtB;AACA,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAEA,QAAM,UAAU,OAAO,QAAQ,KAAK,WAAW,CAAC,CAAC,EAAE,OAA0C,CAAC,KAAK,CAAC,KAAK,MAAM,MAAM;AACnH,QAAI,GAAG,IAAI;AAAA,MACT,GAAG;AAAA,MACH,KAAK,OAAO;AAAA,MACZ,WAAW,OAAO,QAAQ,OAAO,aAAa,CAAC,CAAC,EAAE,OAShD,CAAC,cAAc,CAAC,aAAa,QAAQ,MAAM;AAC3C,qBAAa,WAAW,IAAI;AAAA,UAC1B,SAAS,SAAS,WAAW;AAAA,UAC7B,aAAa,SAAS,eAAe;AAAA,UACrC,GAAI,SAAS,MAAM,UAAU,EAAE,MAAM,SAAS,KAA8B;AAAA,QAC9E;AACA,eAAO;AAAA,MACT,GAAG,CAAC,CAAC;AAAA,IACP;AACA,WAAO;AAAA,EACT,GAAG,CAAC,CAAC;AAEL,QAAM,OAAO,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,EAAE,OAAuC,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM;AACvG,QAAI,GAAG,IAAI;AAAA,MACT,GAAG;AAAA,MACH,KAAK,IAAI;AAAA,MACT,UAAU,IAAI;AAAA,IAChB;AACA,WAAO;AAAA,EACT,GAAG,CAAC,CAAC;AAEL,QAAM,aAAa,OAAO,QAAQ,KAAK,cAAc,CAAC,CAAC,EAAE;AAAA,IACvD,CAAC,KAAK,CAAC,KAAK,SAAS,MAAM;AACzB,UAAI,GAAG,IAAI;AAAA,QACT,GAAG;AAAA,QACH,KAAK,UAAU;AAAA,QACf,aAAa,UAAU,YAAY,IAAI,CAAC,QAAQ,GAAmC;AAAA,QACnF,SAAS,UAAU,QAAQ,IAAI,CAAC,QAAQ,GAA+B;AAAA,QACvE,oBAAoB;AAAA,UAClB,WAAW;AAAA,UACX,WAAW;AAAA,QACb;AAAA,MACF;AACA,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAEA,SAAO;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;",
+  "sourcesContent": ["import type { v_2_4_0 } from '@/migrations/v-2.4.0/types.generated'\n\nimport type { v_2_5_0 } from './types.generated'\n\n/** V-2.4.0 to V-2.5.0 migration */\nexport const migrate_v_2_5_0 = (data: v_2_4_0.DataRecord): v_2_5_0['DataRecord'] => {\n  console.info('Performing data migration v-2.4.0 to v-2.5.0')\n\n  const cookies = Object.entries(data.cookies || {}).reduce<Record<string, v_2_5_0['Cookie']>>((acc, [key, cookie]) => {\n    acc[key] = {\n      ...cookie,\n      uid: cookie.uid as v_2_5_0['Cookie']['uid'],\n    } satisfies v_2_5_0['Cookie']\n    return acc\n  }, {})\n\n  const collections = Object.entries(data.collections || {}).reduce<Record<string, v_2_5_0['Collection']>>(\n    (acc, [key, collection]) => {\n      acc[key] = {\n        ...collection,\n        info: collection.info ?? {\n          title: 'API',\n          version: '1.0',\n        },\n        uid: collection.uid as v_2_5_0['Collection']['uid'],\n        selectedSecuritySchemeUids:\n          collection.selectedSecuritySchemeUids as v_2_5_0['Collection']['selectedSecuritySchemeUids'],\n        servers: collection.servers.map((uid) => uid as v_2_5_0['Server']['uid']),\n        tags: collection.tags.map((uid) => uid as v_2_5_0['Tag']['uid']),\n        requests: collection.requests.map((uid) => uid as v_2_5_0['Request']['uid']),\n        children: collection.children.map((uid) => uid as v_2_5_0['Request']['uid'] | v_2_5_0['Tag']['uid']),\n        selectedServerUid: collection.selectedServerUid as v_2_5_0['Server']['uid'],\n        useCollectionSecurity: false,\n      } satisfies v_2_5_0['Collection']\n      return acc\n    },\n    {},\n  )\n\n  const environments = Object.entries(data.environments || {}).reduce<Record<string, v_2_5_0['Environment']>>(\n    (acc, [key, environment]) => {\n      acc[key] = {\n        ...environment,\n        uid: environment.uid as v_2_5_0['Environment']['uid'],\n      } satisfies v_2_5_0['Environment']\n      return acc\n    },\n    {},\n  )\n\n  const requests = Object.entries(data.requests || {}).reduce<Record<string, v_2_5_0['Request']>>(\n    (acc, [key, request]) => {\n      acc[key] = {\n        ...request,\n        uid: request.uid as v_2_5_0['Request']['uid'],\n        servers: request.servers as v_2_5_0['Request']['servers'],\n        selectedServerUid: request.selectedServerUid as v_2_5_0['Request']['selectedServerUid'],\n        examples: request.examples as v_2_5_0['Request']['examples'],\n        selectedSecuritySchemeUids:\n          request.selectedSecuritySchemeUids as v_2_5_0['Request']['selectedSecuritySchemeUids'],\n      } satisfies v_2_5_0['Request']\n      return acc\n    },\n    {},\n  )\n\n  const requestExamples = Object.entries(data.requestExamples || {}).reduce<Record<string, v_2_5_0['RequestExample']>>(\n    (acc, [key, example]) => {\n      const headers = example.parameters.headers\n\n      // Check if \"Accept\" header exists\n      const hasAcceptHeader = headers.some((header) => header.key.toLowerCase() === 'accept')\n\n      if (!hasAcceptHeader) {\n        // Add \"Accept\" header as the first entry\n        headers.unshift({ key: 'Accept', value: '*/*', enabled: true })\n      }\n\n      // Update the example with potentially modified headers\n      acc[key] = {\n        ...example,\n        uid: example.uid as v_2_5_0['RequestExample']['uid'],\n        requestUid: example.requestUid as v_2_5_0['RequestExample']['requestUid'],\n        parameters: {\n          ...example.parameters,\n          headers,\n        },\n      }\n      return acc\n    },\n    {},\n  )\n\n  const securitySchemes = Object.entries(data.securitySchemes || {}).reduce<Record<string, v_2_5_0['SecurityScheme']>>(\n    (acc, [key, securityScheme]) => {\n      acc[key] = {\n        ...securityScheme,\n        uid: securityScheme.uid as v_2_5_0['SecurityScheme']['uid'],\n      } satisfies v_2_5_0['SecurityScheme']\n      return acc\n    },\n    {},\n  )\n\n  const servers = Object.entries(data.servers || {}).reduce<Record<string, v_2_5_0['Server']>>((acc, [key, server]) => {\n    acc[key] = {\n      ...server,\n      uid: server.uid as v_2_5_0['Server']['uid'],\n      variables: Object.entries(server.variables || {}).reduce<\n        Record<\n          string,\n          {\n            enum?: [string, ...string[]]\n            default: string\n            description?: string\n          }\n        >\n      >((variablesAcc, [variableKey, variable]) => {\n        variablesAcc[variableKey] = {\n          default: variable.default ?? '',\n          description: variable.description ?? '',\n          ...(variable.enum?.length && { enum: variable.enum as [string, ...string[]] }),\n        }\n        return variablesAcc\n      }, {}),\n    }\n    return acc\n  }, {})\n\n  const tags = Object.entries(data.tags || {}).reduce<Record<string, v_2_5_0['Tag']>>((acc, [key, tag]) => {\n    acc[key] = {\n      ...tag,\n      uid: tag.uid as v_2_5_0['Tag']['uid'],\n      children: tag.children as v_2_5_0['Tag']['children'],\n    } satisfies v_2_5_0['Tag']\n    return acc\n  }, {})\n\n  const workspaces = Object.entries(data.workspaces || {}).reduce<Record<string, v_2_5_0['Workspace']>>(\n    (acc, [key, workspace]) => {\n      acc[key] = {\n        ...workspace,\n        uid: workspace.uid as v_2_5_0['Workspace']['uid'],\n        collections: workspace.collections.map((uid) => uid as v_2_5_0['Collection']['uid']),\n        cookies: workspace.cookies.map((uid) => uid as v_2_5_0['Cookie']['uid']),\n        selectedHttpClient: {\n          targetKey: 'shell',\n          clientKey: 'curl',\n        },\n      }\n      return acc\n    },\n    {},\n  )\n\n  return {\n    ...data,\n    collections,\n    cookies,\n    environments,\n    requests,\n    requestExamples,\n    securitySchemes,\n    servers,\n    tags,\n    workspaces,\n  } satisfies v_2_5_0['DataRecord']\n}\n"],
+  "mappings": "AAKO,MAAM,kBAAkB,CAAC,SAAoD;AAClF,UAAQ,KAAK,8CAA8C;AAE3D,QAAM,UAAU,OAAO,QAAQ,KAAK,WAAW,CAAC,CAAC,EAAE,OAA0C,CAAC,KAAK,CAAC,KAAK,MAAM,MAAM;AACnH,QAAI,GAAG,IAAI;AAAA,MACT,GAAG;AAAA,MACH,KAAK,OAAO;AAAA,IACd;AACA,WAAO;AAAA,EACT,GAAG,CAAC,CAAC;AAEL,QAAM,cAAc,OAAO,QAAQ,KAAK,eAAe,CAAC,CAAC,EAAE;AAAA,IACzD,CAAC,KAAK,CAAC,KAAK,UAAU,MAAM;AAC1B,UAAI,GAAG,IAAI;AAAA,QACT,GAAG;AAAA,QACH,MAAM,WAAW,QAAQ;AAAA,UACvB,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA,KAAK,WAAW;AAAA,QAChB,4BACE,WAAW;AAAA,QACb,SAAS,WAAW,QAAQ,IAAI,CAAC,QAAQ,GAA+B;AAAA,QACxE,MAAM,WAAW,KAAK,IAAI,CAAC,QAAQ,GAA4B;AAAA,QAC/D,UAAU,WAAW,SAAS,IAAI,CAAC,QAAQ,GAAgC;AAAA,QAC3E,UAAU,WAAW,SAAS,IAAI,CAAC,QAAQ,GAAwD;AAAA,QACnG,mBAAmB,WAAW;AAAA,QAC9B,uBAAuB;AAAA,MACzB;AACA,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAEA,QAAM,eAAe,OAAO,QAAQ,KAAK,gBAAgB,CAAC,CAAC,EAAE;AAAA,IAC3D,CAAC,KAAK,CAAC,KAAK,WAAW,MAAM;AAC3B,UAAI,GAAG,IAAI;AAAA,QACT,GAAG;AAAA,QACH,KAAK,YAAY;AAAA,MACnB;AACA,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAEA,QAAM,WAAW,OAAO,QAAQ,KAAK,YAAY,CAAC,CAAC,EAAE;AAAA,IACnD,CAAC,KAAK,CAAC,KAAK,OAAO,MAAM;AACvB,UAAI,GAAG,IAAI;AAAA,QACT,GAAG;AAAA,QACH,KAAK,QAAQ;AAAA,QACb,SAAS,QAAQ;AAAA,QACjB,mBAAmB,QAAQ;AAAA,QAC3B,UAAU,QAAQ;AAAA,QAClB,4BACE,QAAQ;AAAA,MACZ;AACA,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAEA,QAAM,kBAAkB,OAAO,QAAQ,KAAK,mBAAmB,CAAC,CAAC,EAAE;AAAA,IACjE,CAAC,KAAK,CAAC,KAAK,OAAO,MAAM;AACvB,YAAM,UAAU,QAAQ,WAAW;AAGnC,YAAM,kBAAkB,QAAQ,KAAK,CAAC,WAAW,OAAO,IAAI,YAAY,MAAM,QAAQ;AAEtF,UAAI,CAAC,iBAAiB;AAEpB,gBAAQ,QAAQ,EAAE,KAAK,UAAU,OAAO,OAAO,SAAS,KAAK,CAAC;AAAA,MAChE;AAGA,UAAI,GAAG,IAAI;AAAA,QACT,GAAG;AAAA,QACH,KAAK,QAAQ;AAAA,QACb,YAAY,QAAQ;AAAA,QACpB,YAAY;AAAA,UACV,GAAG,QAAQ;AAAA,UACX;AAAA,QACF;AAAA,MACF;AACA,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAEA,QAAM,kBAAkB,OAAO,QAAQ,KAAK,mBAAmB,CAAC,CAAC,EAAE;AAAA,IACjE,CAAC,KAAK,CAAC,KAAK,cAAc,MAAM;AAC9B,UAAI,GAAG,IAAI;AAAA,QACT,GAAG;AAAA,QACH,KAAK,eAAe;AAAA,MACtB;AACA,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAEA,QAAM,UAAU,OAAO,QAAQ,KAAK,WAAW,CAAC,CAAC,EAAE,OAA0C,CAAC,KAAK,CAAC,KAAK,MAAM,MAAM;AACnH,QAAI,GAAG,IAAI;AAAA,MACT,GAAG;AAAA,MACH,KAAK,OAAO;AAAA,MACZ,WAAW,OAAO,QAAQ,OAAO,aAAa,CAAC,CAAC,EAAE,OAShD,CAAC,cAAc,CAAC,aAAa,QAAQ,MAAM;AAC3C,qBAAa,WAAW,IAAI;AAAA,UAC1B,SAAS,SAAS,WAAW;AAAA,UAC7B,aAAa,SAAS,eAAe;AAAA,UACrC,GAAI,SAAS,MAAM,UAAU,EAAE,MAAM,SAAS,KAA8B;AAAA,QAC9E;AACA,eAAO;AAAA,MACT,GAAG,CAAC,CAAC;AAAA,IACP;AACA,WAAO;AAAA,EACT,GAAG,CAAC,CAAC;AAEL,QAAM,OAAO,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,EAAE,OAAuC,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM;AACvG,QAAI,GAAG,IAAI;AAAA,MACT,GAAG;AAAA,MACH,KAAK,IAAI;AAAA,MACT,UAAU,IAAI;AAAA,IAChB;AACA,WAAO;AAAA,EACT,GAAG,CAAC,CAAC;AAEL,QAAM,aAAa,OAAO,QAAQ,KAAK,cAAc,CAAC,CAAC,EAAE;AAAA,IACvD,CAAC,KAAK,CAAC,KAAK,SAAS,MAAM;AACzB,UAAI,GAAG,IAAI;AAAA,QACT,GAAG;AAAA,QACH,KAAK,UAAU;AAAA,QACf,aAAa,UAAU,YAAY,IAAI,CAAC,QAAQ,GAAmC;AAAA,QACnF,SAAS,UAAU,QAAQ,IAAI,CAAC,QAAQ,GAA+B;AAAA,QACvE,oBAAoB;AAAA,UAClB,WAAW;AAAA,UACX,WAAW;AAAA,QACb;AAAA,MACF;AACA,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AAEA,SAAO;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;",
   "names": []
 }

package/dist/spec-getters/get-example-from-schema.d.ts

@@ -1,31 +1,34 @@
 import type { OpenAPIV3_1 } from '@scalar/openapi-types';
 /**
- * This function takes an OpenAPI schema and generates an example from it
+ * Generate an example value from a given OpenAPI SchemaObject.
+ *
+ * This function recursively processes OpenAPI schemas to create realistic example data.
+ * It handles all OpenAPI schema types including primitives, objects, arrays, and
+ * composition schemas (allOf, oneOf, anyOf).
+ * Uses a tonne of caching for maximum performance.
+ *
+ * @param schema - The OpenAPI SchemaObject to generate an example from.
+ * @param options - Options to customize example generation.
+ * @param level - The current recursion depth.
+ * @param parentSchema - The parent schema, if any.
+ * @param name - The name of the property being processed.
+ * @returns An example value for the given schema.
  */
-export declare const getExampleFromSchema: (_schema: OpenAPIV3_1.SchemaObject, options?: {
-    /**
-     * The fallback string for empty string values.
-     * @default ''
-     */
+export declare const getExampleFromSchema: (schema: OpenAPIV3_1.SchemaObject, options?: {
+    /** Fallback string for empty string values. */
     emptyString?: string;
-    /**
-     * Whether to use the XML tag names as keys
-     * @default false
-     */
+    /** Whether to use XML tag names as keys. */
     xml?: boolean;
-    /**
-     * Whether to show read-only/write-only properties. Otherwise all properties are shown.
-     * @default undefined
-     */
+    /** Whether to show read-only/write-only properties. */
     mode?: "read" | "write";
-    /**
-     * Dynamic values to add to the example.
-     */
-    variables?: Record<string, any>;
-    /**
-     * Whether to omit empty and optional properties.
-     * @default false
-     */
+    /** Dynamic variables which can replace values via x-variable. */
+    variables?: Record<string, unknown>;
+    /** Whether to omit empty and optional properties. */
     omitEmptyAndOptionalProperties?: boolean;
-}, level?: number, parentSchema?: OpenAPIV3_1.SchemaObject, name?: string) => any;
+}, args?: Partial<{
+    level: number;
+    parentSchema: OpenAPIV3_1.SchemaObject;
+    name: string;
+    seen: WeakSet<object>;
+}>) => any;
 //# sourceMappingURL=get-example-from-schema.d.ts.map

package/dist/spec-getters/get-example-from-schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-example-from-schema.d.ts","sourceRoot":"","sources":["../../src/spec-getters/get-example-from-schema.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAwExD;;GAEG;AACH,eAAO,MAAM,oBAAoB,GAC/B,SAAS,WAAW,CAAC,YAAY,EACjC,UAAU;IACR;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC/B;;;OAGG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAA;CACzC,EACD,QAAO,MAAU,EACjB,eAAe,WAAW,CAAC,YAAY,EACvC,OAAO,MAAM,KACZ,GAyTF,CAAA"}
+{"version":3,"file":"get-example-from-schema.d.ts","sourceRoot":"","sources":["../../src/spec-getters/get-example-from-schema.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAwbxD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,oBAAoB,GAC/B,QAAQ,WAAW,CAAC,YAAY,EAChC,UAAU;IACR,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,4CAA4C;IAC5C,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB,iEAAiE;IACjE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnC,qDAAqD;IACrD,8BAA8B,CAAC,EAAE,OAAO,CAAA;CACzC,EACD,OAAO,OAAO,CAAC;IACb,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,EAAE,WAAW,CAAC,YAAY,CAAA;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;CACtB,CAAC,KACD,GAyJF,CAAA"}