@scalar/oas-utils 0.2.76 → 0.2.78

package/dist/migrations/v-2.1.0/migration.d.ts

@@ -1,344 +1,15 @@
 import type { v_0_0_0 } from '../../migrations/v-0.0.0/types.generated';
+import type { v_2_1_0 } from './types.generated';
 /** V-0.0.0 to V-2.1.0 migration */
-export declare const migrate_v_2_1_0: (data: Omit<v_0_0_0.Data, "folders">) => {
-    collections: {
-        type: "collection";
-        openapi: string;
-        info: {
-            title: string;
-            summary?: string | undefined;
-            description?: string | undefined;
-            termsOfService?: string | undefined;
-            contact?: {
-                name?: string | undefined;
-                url?: string | undefined;
-                email?: string | undefined;
-            } | undefined;
-            license?: {
-                name: string;
-                identifier?: string | undefined;
-                url?: string | undefined;
-            } | undefined;
-            version: string;
-        };
-        security: {
-            [x: string]: string[];
-        }[];
-        externalDocs: {
-            description: string;
-            url: string;
-        } | undefined;
-        uid: string;
-        securitySchemes: string[];
-        selectedSecuritySchemeUids: never[];
-        selectedServerUid: string;
-        servers: string[];
-        requests: string[];
-        tags: string[];
-        auth: Record<string, {
-            type: "apiKey";
-            value: string;
-            name: string;
-        } | {
-            type: "http";
-            username: string;
-            password: string;
-            token: string;
-        } | {
-            type: "oauth-implicit";
-            token: string;
-        } | {
-            type: "oauth-password";
-            username: string;
-            password: string;
-            token: string;
-            clientSecret: string;
-        } | {
-            type: "oauth-clientCredentials";
-            token: string;
-            clientSecret: string;
-        } | {
-            type: "oauth-authorizationCode";
-            token: string;
-            clientSecret: string;
-        }>;
-        children: string[];
-        'x-scalar-icon': string;
-        watchMode: false;
-        watchModeStatus: "IDLE";
-    }[];
-    cookies: v_0_0_0.Cookie[];
-    environments: {
-        value: string;
-        uid: string;
-        name: string;
-        color: string;
-        raw?: string;
-        parsed?: {
-            key: string;
-            value: string;
-        }[];
-        isDefault?: boolean | undefined;
-    }[];
-    requestExamples: {
-        type: "requestExample";
-        uid: string;
-        url?: string;
-        requestUid: string;
-        name: string;
-        body: {
-            raw?: {
-                encoding: "json" | "text" | "html" | "text" | "javascript" | "xml" | "yaml" | "edn";
-                value: string;
-            };
-            formData?: {
-                encoding: "form-data" | "urlencoded";
-                value: {
-                    key: string;
-                    value: string;
-                    enabled: boolean;
-                    file?: {
-                        name: string;
-                        lastModified: number;
-                        webkitRelativePath: string;
-                        size: number;
-                        type: string;
-                        arrayBuffer: (...args_0: unknown[]) => Promise<any>;
-                        slice: (args_0: number | undefined, args_1: number | undefined, args_2: string | undefined, ...args_3: unknown[]) => any;
-                        stream: (...args_0: unknown[]) => any;
-                        text: (...args_0: unknown[]) => Promise<string>;
-                    } | undefined;
-                    description?: string | undefined;
-                    refUid?: string | undefined;
-                    required?: boolean | undefined;
-                    enum?: string[] | undefined;
-                    type?: string | undefined;
-                    format?: string | undefined;
-                    minimum?: number | undefined;
-                    maximum?: number | undefined;
-                    default?: any | undefined;
-                    nullable?: boolean | undefined;
-                }[];
-            };
-            binary?: any | undefined;
-            activeBody: "raw" | "formData" | "binary";
-        };
-        parameters: {
-            path: {
-                key: string;
-                value: string;
-                enabled: boolean;
-                file?: any | undefined;
-                description?: string | undefined;
-                refUid?: string | undefined;
-                required?: boolean | undefined;
-                enum?: string[] | undefined;
-                type?: string | undefined;
-                format?: string | undefined;
-                minimum?: number | undefined;
-                maximum?: number | undefined;
-                default?: any | undefined;
-                nullable?: boolean | undefined;
-            }[];
-            query: {
-                key: string;
-                value: string;
-                enabled: boolean;
-                file?: any | undefined;
-                description?: string | undefined;
-                refUid?: string | undefined;
-                required?: boolean | undefined;
-                enum?: string[] | undefined;
-                type?: string | undefined;
-                format?: string | undefined;
-                minimum?: number | undefined;
-                maximum?: number | undefined;
-                default?: any | undefined;
-                nullable?: boolean | undefined;
-            }[];
-            headers: {
-                key: string;
-                value: string;
-                enabled: boolean;
-                file?: any | undefined;
-                description?: string | undefined;
-                refUid?: string | undefined;
-                required?: boolean | undefined;
-                enum?: string[] | undefined;
-                type?: string | undefined;
-                format?: string | undefined;
-                minimum?: number | undefined;
-                maximum?: number | undefined;
-                default?: any | undefined;
-                nullable?: boolean | undefined;
-            }[];
-            cookies: {
-                key: string;
-                value: string;
-                enabled: boolean;
-                file?: any | undefined;
-                description?: string | undefined;
-                refUid?: string | undefined;
-                required?: boolean | undefined;
-                enum?: string[] | undefined;
-                type?: string | undefined;
-                format?: string | undefined;
-                minimum?: number | undefined;
-                maximum?: number | undefined;
-                default?: any | undefined;
-                nullable?: boolean | undefined;
-            }[];
-        };
-        auth?: {
-            [x: string]: any;
-        };
-    }[];
-    requests: {
-        parameters: {
-            required: boolean;
-            name: string;
-            in: "path" | "query" | "header" | "cookie";
-            deprecated: boolean;
-            description?: string | undefined;
-            example?: unknown;
-            schema?: unknown;
-            content?: unknown;
-            style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
-            examples?: Record<string, {
-                value?: unknown;
-                summary?: string | undefined;
-            }> | undefined;
-        }[];
-        type: "request";
-        method: "options" | "delete" | "get" | "connect" | "head" | "patch" | "post" | "put" | "trace";
-        examples: string[];
-        selectedSecuritySchemeUids: string[];
-        selectedServerUid: string;
-        servers: never[];
-        path: string;
-        uid: string;
-        ref?: {
-            path: string;
-            collectionRef?: string | undefined;
-            isExternal: boolean;
-        } | null;
-        tags?: string[] | undefined;
-        summary?: string | undefined;
-        description?: string | undefined;
-        operationId?: string | undefined;
-        security?: {
-            [x: string]: string[];
-        }[] | undefined;
-        securitySchemeUids?: string[];
-        requestBody?: any | undefined;
-        childUids?: string[];
-        history?: any[];
-    }[];
-    securitySchemes: ({
-        nameKey: string;
-        'x-scalar-client-id': string;
-        flow: {
-            type: "implicit";
-            refreshUrl: string;
-            scopes: Map<string, string | undefined> | Record<string, string | undefined> | {};
-            selectedScopes: string[];
-            authorizationUrl: string;
-            'x-scalar-redirect-uri': string;
-        } | {
-            type: "password";
-            refreshUrl: string;
-            scopes: Map<string, string | undefined> | Record<string, string | undefined> | {};
-            selectedScopes: string[];
-            tokenUrl: string;
-        } | {
-            type: "clientCredentials";
-            refreshUrl: string;
-            scopes: Map<string, string | undefined> | Record<string, string | undefined> | {};
-            selectedScopes: string[];
-            tokenUrl: string;
-        } | {
-            type: "authorizationCode";
-            refreshUrl: string;
-            scopes: Map<string, string | undefined> | Record<string, string | undefined> | {};
-            selectedScopes: string[];
-            authorizationUrl: string;
-            'x-scalar-redirect-uri': string;
-            tokenUrl: string;
-            'x-usePkce': "SHA-256" | "plain" | "no";
-        };
-        uid: string;
-        description?: string | undefined;
-        type: "oauth2";
-        clientId?: string;
-    } | {
-        nameKey: string;
-        uid: string;
-        description?: string | undefined;
-        type: "apiKey";
-        name: string;
-        in: "query" | "header" | "cookie";
-        value?: string;
-    } | {
-        nameKey: string;
-        uid: string;
-        description?: string | undefined;
-        type: "http";
-        scheme: "basic" | "bearer";
-        bearerFormat: "JWT" | string;
-        value?: string;
-        secondValue?: string;
-    } | {
-        nameKey: string;
-        uid: string;
-        description?: string | undefined;
-        type: "openIdConnect";
-        openIdConnectUrl: string;
-    })[];
-    servers: {
-        variables: {
-            [x: string]: {
-                uid?: string;
-                enum?: [string, ...string[]] | undefined;
-                default?: string;
-                description?: string | undefined;
-                value?: string | undefined;
-            };
-        };
-        uid: string;
-        url: string;
-        description?: string | undefined;
-    }[];
-    tags: {
-        type: "tag";
-        uid: string;
-        name: string;
-        description: string | undefined;
-        children: string[];
-        'x-scalar-children': never[];
-    }[];
-    workspaces: {
-        description: string;
-        cookies: string[];
-        collections: string[];
-        environments: string[];
-        uid: string;
-        name: string;
-        isReadOnly: boolean;
-        collectionUids?: string[];
-        environmentUids?: string[];
-        hotKeyConfig: {
-            modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
-            hotKeys?: {
-                [x: string]: {
-                    modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
-                    event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
-                };
-            } | undefined;
-        } | undefined;
-        activeEnvironmentId: string;
-        cookieUids?: string[];
-        proxyUrl?: string | undefined;
-        themeId: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
-    }[];
+export declare const migrate_v_2_1_0: (data: Omit<v_0_0_0.DataRecord, "folders">) => {
+    collections: Record<string, v_2_1_0.Collection>;
+    cookies: Record<string, v_0_0_0.Cookie>;
+    environments: Record<string, v_2_1_0.Environment>;
+    requestExamples: Record<string, v_2_1_0.RequestExample>;
+    requests: Record<string, v_2_1_0.Request>;
+    securitySchemes: Record<string, v_2_1_0.SecurityScheme>;
+    servers: Record<string, v_2_1_0.Server>;
+    tags: Record<string, v_2_1_0.Tag>;
+    workspaces: Record<string, v_2_1_0.Workspace>;
 };
 //# sourceMappingURL=migration.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.1.0/migration.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAA;AAInE,mCAAmC;AACnC,eAAO,MAAM,eAAe,SAAU,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC;;;;;;;;;;oBAG/C,CAAC;mBAIjB,CADJ;qBAA4C,CAAC;;;;0BAKlC,CAAC;mBACR,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAiDsD,CAAC;;;;oBASlD,CAAC;;;;;;wBAIF,CAAR;;;;;;sCAM2B,GAAG;oHAMoB,GAAsB;iCAGhE,GAAC;+BACS,GAAG;;+BAKb,CAAC;0BAED,CAAC;4BAIY,CAAA;wBAAoC,CAAC;wBAAqC,CAAC;0BACpF,CAAC;2BAAsC,CAAC;2BAGvC,CAAC;2BAAsC,CAAC;4BACxC,CAAC;;;kBACR,CAAD;;;;;;;;oBAQD,CAAC;2BAAqC,CAAC;sBAElB,CAAC;wBACA,CAAC;oBAAkC,CAAC;oBAG1D,CAAF;sBAAmC,CAAC;uBAE5B,CAAC;uBAAoC,CAAC;uBAChB,CAAC;wBACvB,CAAC;;;;;;oBAOS,CAAC;2BACP,CAAA;sBAAmC,CAAC;wBACtC,CAAC;oBACP,CAAA;oBAAmC,CAAC;sBAE7B,CAAC;uBACa,CAAC;uBACJ,CAAC;uBAAoC,CAAC;wBAC/C,CAAC;;;;;;oBAIS,CAAC;2BACA,CAAC;sBAChB,CAAC;wBACW,CAAC;oBACC,CAAC;oBAIlB,CAAA;sBACE,CAAC;uBACS,CAAC;uBAGb,CAAA;uBAAoC,CAAC;wBACpC,CAAC;;;;;;oBAQO,CAAC;2BAAqC,CAAC;sBACnC,CAAC;wBACW,CAAC;oBACtB,CAAC;oBAAmC,CAAC;sBACf,CAAC;uBACf,CAAC;uBACf,CAAD;uBAAoC,CAAC;wBAItC,CADJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBAUS,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA4I+b,CAAC;;6BAA4E,CAAC;;;;;;;;;;CADthB,CAAA"}
+{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.1.0/migration.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAA;AAEnE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAEhD,mCAAmC;AACnC,eAAO,MAAM,eAAe,SAAU,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC;;;;;;;;;;CAuVxE,CAAA"}

package/dist/migrations/v-2.1.0/migration.js

@@ -85,7 +85,7 @@ const migrate_v_2_1_0 = (data) => {
     /** This is needed due to our previous data being poluted, we will only allow auth on a requst which is in the spec */
     const requestSecurityDict = {};
     // Collections
-    const collections = Object.values(oldData.collections ?? {}).map((c) => {
+    const collections = Object.values(oldData.collections ?? {}).reduce((prev, c) => {
         const { requestUids, tagUids, authUids } = flattenChildren(c.childUids ?? []);
         // Ensure we got unique uids
         const securitySchemesSet = new Set([
@@ -96,13 +96,13 @@ const migrate_v_2_1_0 = (data) => {
         // Add this auth to each request
         requestUids.forEach((r) => (requestSecurityDict[r] = securitySchemes));
         // Migrate auth
-        const auth = securitySchemes.reduce((prev, uid) => {
+        const auth = securitySchemes.reduce((_prev, uid) => {
             const scheme = oldData.securitySchemes[uid];
-            if (scheme?.uid)
-                prev[uid] = migrateAuth(scheme);
-            return prev;
+            if (scheme?.uid && _prev)
+                _prev[uid] = migrateAuth(scheme);
+            return _prev;
         }, {});
-        return {
+        prev[c.uid] = {
             'type': 'collection',
             'openapi': c.spec?.openapi || '3.1.0',
             'info': c.spec?.info || { title: 'OpenAPI Spec', version: '0.0.1' },
@@ -121,16 +121,20 @@ const migrate_v_2_1_0 = (data) => {
             'watchMode': false,
             'watchModeStatus': 'IDLE',
         };
-    });
+        return prev;
+    }, {});
     // Cookies
-    const cookies = Object.values(oldData.cookies ?? {});
+    const cookies = oldData.cookies ?? {};
     // Environments
-    const environments = Object.values(oldData.environments ?? {}).map((e) => ({
-        ...e,
-        value: e.raw ?? '',
-    }));
+    const environments = Object.values(oldData.environments ?? {}).reduce((prev, e) => {
+        prev[e.uid] = {
+            ...e,
+            value: e.raw ?? '',
+        };
+        return prev;
+    }, {});
     // Requests
-    const requests = Object.values(oldData.requests ?? {}).map((r) => {
+    const requests = Object.values(oldData.requests ?? {}).reduce((prev, r) => {
         // Convert parameters
         const parameters = [
             ...Object.values(r.parameters?.path ?? {}),
@@ -140,7 +144,7 @@ const migrate_v_2_1_0 = (data) => {
         ].filter((p) => p);
         // Ensure this request can access these schemes
         const selectedSecuritySchemeUids = (r.selectedSecuritySchemeUids || []).filter((s) => requestSecurityDict[r.uid]?.includes(s));
-        return {
+        prev[r.uid] = {
             ...r,
             parameters,
             type: 'request',
@@ -150,12 +154,16 @@ const migrate_v_2_1_0 = (data) => {
             selectedServerUid: '',
             servers: [],
         };
-    });
+        return prev;
+    }, {});
     // Request Examples
-    const requestExamples = Object.values(oldData.requestExamples ?? {}).map((e) => ({
-        ...e,
-        type: 'requestExample',
-    }));
+    const requestExamples = Object.values(oldData.requestExamples ?? {}).reduce((prev, e) => {
+        prev[e.uid] = {
+            ...e,
+            type: 'requestExample',
+        };
+        return prev;
+    }, {});
     /** Specifically handle each oauth2 flow */
     const migrateFlow = (flow) => {
         const base = {
@@ -208,36 +216,49 @@ const migrate_v_2_1_0 = (data) => {
         }
     };
     // Security Schemes
-    const securitySchemes = Object.values(oldData.securitySchemes ?? {}).map((s) => s.type === 'oauth2'
-        ? {
-            ...s,
-            'nameKey': getNameKey(s),
-            'x-scalar-client-id': s.clientId || '',
-            'flow': migrateFlow(s.flow),
-        }
-        : { ...s, nameKey: getNameKey(s) });
+    const securitySchemes = Object.values(oldData.securitySchemes ?? {}).reduce((prev, s) => {
+        prev[s.uid] =
+            s.type === 'oauth2'
+                ? {
+                    ...s,
+                    'nameKey': getNameKey(s),
+                    'x-scalar-client-id': s.clientId || '',
+                    'flow': migrateFlow(s.flow),
+                }
+                : { ...s, nameKey: getNameKey(s) };
+        return prev;
+    }, {});
     // Servers
-    const servers = Object.values(oldData.servers ?? {}).map((s) => ({
-        ...s,
-        variables: s.variables ?? {},
-    }));
+    const servers = Object.values(oldData.servers ?? {}).reduce((prev, s) => {
+        prev[s.uid] = {
+            ...s,
+            variables: s.variables ?? {},
+        };
+        return prev;
+    }, {});
     // Tags
-    const tags = Object.values(oldData.folders ?? {}).map((f) => ({
-        'type': 'tag',
-        'uid': f.uid,
-        'name': f.name || 'unknownTag',
-        'description': f.description,
-        'children': f.childUids || [],
-        'x-scalar-children': [],
-    }));
+    const tags = Object.values(oldData.folders ?? {}).reduce((prev, f) => {
+        prev[f.uid] = {
+            'type': 'tag',
+            'uid': f.uid,
+            'name': f.name || 'unknownTag',
+            'description': f.description,
+            'children': f.childUids || [],
+            'x-scalar-children': [],
+        };
+        return prev;
+    }, {});
     // Workspaces
-    const workspaces = Object.values(oldData.workspaces ?? {}).map((w) => ({
-        ...w,
-        description: w.description ?? 'Basic Scalar Workspace',
-        cookies: w.cookieUids || [],
-        collections: w.collectionUids || [],
-        environments: w.environmentUids || [],
-    }));
+    const workspaces = Object.values(oldData.workspaces ?? {}).reduce((prev, w) => {
+        prev[w.uid] = {
+            ...w,
+            description: w.description ?? 'Basic Scalar Workspace',
+            cookies: w.cookieUids || [],
+            collections: w.collectionUids || [],
+            environments: w.environmentUids || [],
+        };
+        return prev;
+    }, {});
     return {
         collections,
         cookies,