@scalar/oas-utils 0.10.7 → 0.10.9

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

@@ -1,105 +1,108 @@
+/** Migrate security scheme from v-2.1.0 to v-2.2.0 */
 const migrateSecurityScheme = (scheme, auth) => {
-  if (scheme.type === "apiKey" && auth.type === "apiKey") {
-    return {
-      ...scheme,
-      value: auth.value
-    };
-  }
-  if (scheme.type === "http" && auth.type === "http") {
-    return {
-      ...scheme,
-      username: auth.username,
-      password: auth.password,
-      token: auth.token
-    };
-  }
-  if (scheme.type === "oauth2") {
-    const { flow, ..._scheme } = scheme;
-    if (flow.type === "implicit" && auth.type === "oauth-implicit") {
-      return {
-        ..._scheme,
-        flows: {
-          implicit: {
-            ...flow,
-            "scopes": flow.scopes,
-            "token": auth.token,
-            "x-scalar-client-id": _scheme["x-scalar-client-id"]
-          }
-        }
-      };
+    // API Key
+    if (scheme.type === 'apiKey' && auth.type === 'apiKey') {
+        return {
+            ...scheme,
+            value: auth.value,
+        };
     }
-    if (flow.type === "password" && auth.type === "oauth-password") {
-      return {
-        ..._scheme,
-        flows: {
-          password: {
-            ...flow,
-            "username": auth.username,
-            "password": auth.password,
-            "token": auth.token,
-            "clientSecret": auth.clientSecret,
-            "scopes": flow.scopes,
-            "x-scalar-client-id": _scheme["x-scalar-client-id"]
-          }
-        }
-      };
+    // HTTP
+    if (scheme.type === 'http' && auth.type === 'http') {
+        return {
+            ...scheme,
+            username: auth.username,
+            password: auth.password,
+            token: auth.token,
+        };
     }
-    if (flow.type === "clientCredentials" && auth.type === "oauth-clientCredentials") {
-      return {
-        ..._scheme,
-        flows: {
-          clientCredentials: {
-            ...flow,
-            "token": auth.token,
-            "clientSecret": auth.clientSecret,
-            "scopes": flow.scopes,
-            "x-scalar-client-id": _scheme["x-scalar-client-id"]
-          }
+    // OAuth2
+    if (scheme.type === 'oauth2') {
+        const { flow, ..._scheme } = scheme;
+        // Implicit
+        if (flow.type === 'implicit' && auth.type === 'oauth-implicit') {
+            return {
+                ..._scheme,
+                flows: {
+                    implicit: {
+                        ...flow,
+                        'scopes': flow.scopes,
+                        'token': auth.token,
+                        'x-scalar-client-id': _scheme['x-scalar-client-id'],
+                    },
+                },
+            };
         }
-      };
-    }
-    if (flow.type === "authorizationCode" && auth.type === "oauth-authorizationCode") {
-      return {
-        ..._scheme,
-        flows: {
-          authorizationCode: {
-            ...flow,
-            "token": auth.token,
-            "clientSecret": auth.clientSecret,
-            "scopes": flow.scopes,
-            "x-scalar-client-id": _scheme["x-scalar-client-id"]
-          }
+        // Password
+        if (flow.type === 'password' && auth.type === 'oauth-password') {
+            return {
+                ..._scheme,
+                flows: {
+                    password: {
+                        ...flow,
+                        'username': auth.username,
+                        'password': auth.password,
+                        'token': auth.token,
+                        'clientSecret': auth.clientSecret,
+                        'scopes': flow.scopes,
+                        'x-scalar-client-id': _scheme['x-scalar-client-id'],
+                    },
+                },
+            };
+        }
+        // Client Credentials
+        if (flow.type === 'clientCredentials' && auth.type === 'oauth-clientCredentials') {
+            return {
+                ..._scheme,
+                flows: {
+                    clientCredentials: {
+                        ...flow,
+                        'token': auth.token,
+                        'clientSecret': auth.clientSecret,
+                        'scopes': flow.scopes,
+                        'x-scalar-client-id': _scheme['x-scalar-client-id'],
+                    },
+                },
+            };
+        }
+        // Authorization Code
+        if (flow.type === 'authorizationCode' && auth.type === 'oauth-authorizationCode') {
+            return {
+                ..._scheme,
+                flows: {
+                    authorizationCode: {
+                        ...flow,
+                        'token': auth.token,
+                        'clientSecret': auth.clientSecret,
+                        'scopes': flow.scopes,
+                        'x-scalar-client-id': _scheme['x-scalar-client-id'],
+                    },
+                },
+            };
         }
-      };
     }
-  }
-  return null;
+    return null;
 };
-const migrate_v_2_2_0 = (data) => {
-  console.info("Performing data migration v-2.1.0 to v-2.2.0");
-  const securitySchemes = Object.values(data.securitySchemes).reduce(
-    (prev, s) => {
-      const collection = Object.values(data.collections).find((c) => c.securitySchemes.includes(s.uid));
-      const auth = collection?.auth?.[s.uid];
-      if (!auth) {
+/** V-2.1.0 to V-2.2.0 migration */
+export const migrate_v_2_2_0 = (data) => {
+    console.info('Performing data migration v-2.1.0 to v-2.2.0');
+    const securitySchemes = Object.values(data.securitySchemes).reduce((prev, s) => {
+        const collection = Object.values(data.collections).find((c) => c.securitySchemes.includes(s.uid));
+        const auth = collection?.auth?.[s.uid];
+        if (!auth) {
+            return prev;
+        }
+        const newScheme = migrateSecurityScheme(s, auth);
+        if (newScheme) {
+            prev[s.uid] = newScheme;
+        }
         return prev;
-      }
-      const newScheme = migrateSecurityScheme(s, auth);
-      if (newScheme) {
-        prev[s.uid] = newScheme;
-      }
-      return prev;
-    },
-    {}
-  );
-  const servers = data.servers;
-  return {
-    ...data,
-    securitySchemes,
-    servers
-  };
-};
-export {
-  migrate_v_2_2_0
+    }, {});
+    // No changes to servers
+    const servers = data.servers;
+    return {
+        ...data,
+        securitySchemes,
+        servers,
+    };
 };
-//# sourceMappingURL=migration.js.map

package/dist/migrations/v-2.2.0/types.generated.js

@@ -1 +1 @@
-//# sourceMappingURL=types.generated.js.map
+export {};

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

@@ -1,51 +1,48 @@
-const migrate_v_2_3_0 = (data) => {
-  console.info("Performing data migration v-2.2.0 to v-2.3.0");
-  const environments = data.environments;
-  const workspaces = Object.values(data.workspaces).reduce((prev, w) => {
-    const workspaceEnvironments = {};
-    Object.entries(environments).forEach(([envId, envData]) => {
-      const parsedData = typeof envData.value === "string" ? JSON.parse(envData.value) : envData.value;
-      if (envId === "default") {
-        Object.assign(workspaceEnvironments, parsedData);
-      }
-    });
-    prev[w.uid] = {
-      ...w,
-      environments: workspaceEnvironments
-    };
-    return prev;
-  }, {});
-  const collections = Object.values(data.collections).reduce((prev, c) => {
-    prev[c.uid] = {
-      ...c,
-      "x-scalar-environments": c["x-scalar-environments"] || {}
-    };
-    return prev;
-  }, {});
-  Object.values(workspaces).forEach((workspace) => {
-    Object.entries(environments).forEach(([envKey, envData]) => {
-      if (envKey !== "default") {
-        const parsedData = typeof envData.value === "string" ? JSON.parse(envData.value) : envData.value;
-        const envName = envData.name;
-        Object.values(collections).forEach((collection) => {
-          collection["x-scalar-environments"] = collection["x-scalar-environments"] || {};
-          collection["x-scalar-environments"][envName] = {
-            variables: parsedData
-          };
-          if (workspace.activeEnvironmentId === envKey) {
-            collection["x-scalar-active-environment"] = envName ?? "";
-          }
+/** V-2.2.0 to V-2.3.0 migration */
+export const migrate_v_2_3_0 = (data) => {
+    console.info('Performing data migration v-2.2.0 to v-2.3.0');
+    const environments = data.environments;
+    const workspaces = Object.values(data.workspaces).reduce((prev, w) => {
+        const workspaceEnvironments = {};
+        Object.entries(environments).forEach(([envId, envData]) => {
+            const parsedData = typeof envData.value === 'string' ? JSON.parse(envData.value) : envData.value;
+            if (envId === 'default') {
+                Object.assign(workspaceEnvironments, parsedData);
+            }
+        });
+        prev[w.uid] = {
+            ...w,
+            environments: workspaceEnvironments,
+        };
+        return prev;
+    }, {});
+    const collections = Object.values(data.collections).reduce((prev, c) => {
+        prev[c.uid] = {
+            ...c,
+            'x-scalar-environments': c['x-scalar-environments'] || {},
+        };
+        return prev;
+    }, {});
+    Object.values(workspaces).forEach((workspace) => {
+        Object.entries(environments).forEach(([envKey, envData]) => {
+            if (envKey !== 'default') {
+                const parsedData = typeof envData.value === 'string' ? JSON.parse(envData.value) : envData.value;
+                const envName = envData.name;
+                Object.values(collections).forEach((collection) => {
+                    collection['x-scalar-environments'] = collection['x-scalar-environments'] || {};
+                    collection['x-scalar-environments'][envName] = {
+                        variables: parsedData,
+                    };
+                    if (workspace.activeEnvironmentId === envKey) {
+                        collection['x-scalar-active-environment'] = envName ?? '';
+                    }
+                });
+            }
         });
-      }
     });
-  });
-  return {
-    ...data,
-    collections,
-    workspaces
-  };
-};
-export {
-  migrate_v_2_3_0
+    return {
+        ...data,
+        collections,
+        workspaces,
+    };
 };
-//# sourceMappingURL=migration.js.map

package/dist/migrations/v-2.3.0/types.generated.js

@@ -1 +1 @@
-//# sourceMappingURL=types.generated.js.map
+export {};

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

@@ -1,27 +1,27 @@
-const migrate_v_2_4_0 = (data) => {
-  console.info("Performing data migration v-2.3.0 to v-2.4.0");
-  const collections = Object.values(data.collections).reduce((prev, c) => {
-    if (c.info?.title === "Drafts") {
-      c.servers = [];
-      Object.values(data.requests).forEach((request) => {
-        if (request.selectedServerUid && c.requests.includes(request.uid)) {
-          const server = data.servers[request.selectedServerUid];
-          if (server) {
-            request.path = `${server.url}${request.path}`;
-          }
-          request.selectedServerUid = "";
+/** V-2.3.0 to V-2.4.0 migration */
+export const migrate_v_2_4_0 = (data) => {
+    console.info('Performing data migration v-2.3.0 to v-2.4.0');
+    const collections = Object.values(data.collections).reduce((prev, c) => {
+        if (c.info?.title === 'Drafts') {
+            // Remove the servers from the draft collection
+            c.servers = [];
+            Object.values(data.requests).forEach((request) => {
+                if (request.selectedServerUid && c.requests.includes(request.uid)) {
+                    const server = data.servers[request.selectedServerUid];
+                    if (server) {
+                        // Update the request paths to include the server URL
+                        request.path = `${server.url}${request.path}`;
+                    }
+                    // Remove the selected server UID from the draft request
+                    request.selectedServerUid = '';
+                }
+            });
         }
-      });
-    }
-    prev[c.uid] = c;
-    return prev;
-  }, {});
-  return {
-    ...data,
-    collections
-  };
+        prev[c.uid] = c;
+        return prev;
+    }, {});
+    return {
+        ...data,
+        collections,
+    };
 };
-export {
-  migrate_v_2_4_0
-};
-//# sourceMappingURL=migration.js.map

package/dist/migrations/v-2.4.0/types.generated.js

@@ -1 +1 @@
-//# sourceMappingURL=types.generated.js.map
+export {};

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

@@ -1,144 +1,127 @@
-const migrate_v_2_5_0 = (data) => {
-  console.info("Performing data migration v-2.4.0 to v-2.5.0");
-  const cookies = Object.entries(data.cookies || {}).reduce((acc, [key, cookie]) => {
-    acc[key] = {
-      ...cookie,
-      uid: cookie.uid
-    };
-    return acc;
-  }, {});
-  const collections = Object.entries(data.collections || {}).reduce(
-    (acc, [key, collection]) => {
-      acc[key] = {
-        ...collection,
-        info: collection.info ?? {
-          title: "API",
-          version: "1.0"
-        },
-        uid: collection.uid,
-        selectedSecuritySchemeUids: collection.selectedSecuritySchemeUids,
-        servers: collection.servers.map((uid) => uid),
-        tags: collection.tags.map((uid) => uid),
-        requests: collection.requests.map((uid) => uid),
-        children: collection.children.map((uid) => uid),
-        selectedServerUid: collection.selectedServerUid,
-        useCollectionSecurity: false
-      };
-      return acc;
-    },
-    {}
-  );
-  const environments = Object.entries(data.environments || {}).reduce(
-    (acc, [key, environment]) => {
-      acc[key] = {
-        ...environment,
-        uid: environment.uid
-      };
-      return acc;
-    },
-    {}
-  );
-  const requests = Object.entries(data.requests || {}).reduce(
-    (acc, [key, request]) => {
-      if (request.method === "connect") {
+/** V-2.4.0 to V-2.5.0 migration */
+export const migrate_v_2_5_0 = (data) => {
+    console.info('Performing data migration v-2.4.0 to v-2.5.0');
+    const cookies = Object.entries(data.cookies || {}).reduce((acc, [key, cookie]) => {
+        acc[key] = {
+            ...cookie,
+            uid: cookie.uid,
+        };
+        return acc;
+    }, {});
+    const collections = Object.entries(data.collections || {}).reduce((acc, [key, collection]) => {
+        acc[key] = {
+            ...collection,
+            info: collection.info ?? {
+                title: 'API',
+                version: '1.0',
+            },
+            uid: collection.uid,
+            selectedSecuritySchemeUids: collection.selectedSecuritySchemeUids,
+            servers: collection.servers.map((uid) => uid),
+            tags: collection.tags.map((uid) => uid),
+            requests: collection.requests.map((uid) => uid),
+            children: collection.children.map((uid) => uid),
+            selectedServerUid: collection.selectedServerUid,
+            useCollectionSecurity: false,
+        };
+        return acc;
+    }, {});
+    const environments = Object.entries(data.environments || {}).reduce((acc, [key, environment]) => {
+        acc[key] = {
+            ...environment,
+            uid: environment.uid,
+        };
         return acc;
-      }
-      acc[key] = {
-        ...request,
-        uid: request.uid,
-        servers: request.servers,
-        selectedServerUid: request.selectedServerUid,
-        examples: request.examples,
-        selectedSecuritySchemeUids: request.selectedSecuritySchemeUids,
-        method: request.method
-      };
-      return acc;
-    },
-    {}
-  );
-  const requestExamples = Object.entries(data.requestExamples || {}).reduce(
-    (acc, [key, example]) => {
-      const headers = example.parameters.headers;
-      const hasAcceptHeader = headers.some((header) => header.key.toLowerCase() === "accept");
-      if (!hasAcceptHeader) {
-        headers.unshift({ key: "Accept", value: "*/*", enabled: true });
-      }
-      acc[key] = {
-        ...example,
-        uid: example.uid,
-        requestUid: example.requestUid,
-        parameters: {
-          ...example.parameters,
-          headers
+    }, {});
+    const requests = Object.entries(data.requests || {}).reduce((acc, [key, request]) => {
+        // Skip 'connect' operations as they are not supported in v-2.5.0
+        if (request.method === 'connect') {
+            return acc;
         }
-      };
-      return acc;
-    },
-    {}
-  );
-  const securitySchemes = Object.entries(data.securitySchemes || {}).reduce(
-    (acc, [key, securityScheme]) => {
-      acc[key] = {
-        ...securityScheme,
-        uid: securityScheme.uid
-      };
-      return acc;
-    },
-    {}
-  );
-  const servers = Object.entries(data.servers || {}).reduce((acc, [key, server]) => {
-    acc[key] = {
-      ...server,
-      uid: server.uid,
-      variables: Object.entries(server.variables || {}).reduce((variablesAcc, [variableKey, variable]) => {
-        variablesAcc[variableKey] = {
-          default: variable.default ?? "",
-          description: variable.description ?? "",
-          ...variable.enum?.length && { enum: variable.enum }
+        acc[key] = {
+            ...request,
+            uid: request.uid,
+            servers: request.servers,
+            selectedServerUid: request.selectedServerUid,
+            examples: request.examples,
+            selectedSecuritySchemeUids: request.selectedSecuritySchemeUids,
+            method: request.method,
         };
-        return variablesAcc;
-      }, {})
-    };
-    return acc;
-  }, {});
-  const tags = Object.entries(data.tags || {}).reduce((acc, [key, tag]) => {
-    acc[key] = {
-      ...tag,
-      uid: tag.uid,
-      children: tag.children
-    };
-    return acc;
-  }, {});
-  const workspaces = Object.entries(data.workspaces || {}).reduce(
-    (acc, [key, workspace]) => {
-      acc[key] = {
-        ...workspace,
-        uid: workspace.uid,
-        collections: workspace.collections.map((uid) => uid),
-        cookies: workspace.cookies.map((uid) => uid),
-        selectedHttpClient: {
-          targetKey: "shell",
-          clientKey: "curl"
+        return acc;
+    }, {});
+    const requestExamples = Object.entries(data.requestExamples || {}).reduce((acc, [key, example]) => {
+        const headers = example.parameters.headers;
+        // Check if "Accept" header exists
+        const hasAcceptHeader = headers.some((header) => header.key.toLowerCase() === 'accept');
+        if (!hasAcceptHeader) {
+            // Add "Accept" header as the first entry
+            headers.unshift({ key: 'Accept', value: '*/*', enabled: true });
         }
-      };
-      return acc;
-    },
-    {}
-  );
-  return {
-    ...data,
-    collections,
-    cookies,
-    environments,
-    requests,
-    requestExamples,
-    securitySchemes,
-    servers,
-    tags,
-    workspaces
-  };
-};
-export {
-  migrate_v_2_5_0
+        // Update the example with potentially modified headers
+        acc[key] = {
+            ...example,
+            uid: example.uid,
+            requestUid: example.requestUid,
+            parameters: {
+                ...example.parameters,
+                headers,
+            },
+        };
+        return acc;
+    }, {});
+    const securitySchemes = Object.entries(data.securitySchemes || {}).reduce((acc, [key, securityScheme]) => {
+        acc[key] = {
+            ...securityScheme,
+            uid: securityScheme.uid,
+        };
+        return acc;
+    }, {});
+    const servers = Object.entries(data.servers || {}).reduce((acc, [key, server]) => {
+        acc[key] = {
+            ...server,
+            uid: server.uid,
+            variables: Object.entries(server.variables || {}).reduce((variablesAcc, [variableKey, variable]) => {
+                variablesAcc[variableKey] = {
+                    default: variable.default ?? '',
+                    description: variable.description ?? '',
+                    ...(variable.enum?.length && { enum: variable.enum }),
+                };
+                return variablesAcc;
+            }, {}),
+        };
+        return acc;
+    }, {});
+    const tags = Object.entries(data.tags || {}).reduce((acc, [key, tag]) => {
+        acc[key] = {
+            ...tag,
+            uid: tag.uid,
+            children: tag.children,
+        };
+        return acc;
+    }, {});
+    const workspaces = Object.entries(data.workspaces || {}).reduce((acc, [key, workspace]) => {
+        acc[key] = {
+            ...workspace,
+            uid: workspace.uid,
+            collections: workspace.collections.map((uid) => uid),
+            cookies: workspace.cookies.map((uid) => uid),
+            selectedHttpClient: {
+                targetKey: 'shell',
+                clientKey: 'curl',
+            },
+        };
+        return acc;
+    }, {});
+    return {
+        ...data,
+        collections,
+        cookies,
+        environments,
+        requests,
+        requestExamples,
+        securitySchemes,
+        servers,
+        tags,
+        workspaces,
+    };
 };
-//# sourceMappingURL=migration.js.map

package/dist/migrations/v-2.5.0/types.generated.js

@@ -1 +1 @@
-//# sourceMappingURL=types.generated.js.map
+export {};