@scalar/oas-utils 0.2.43 → 0.2.44

package/dist/helpers/local-storage.js

@@ -0,0 +1,17 @@
+/**
+ * localStorage keys for resources
+ * DO NOT CHANGE THESE AS IT WILL BREAK THE MIGRATION
+ */
+const LS_KEYS = {
+    COLLECTION: 'collection',
+    COOKIE: 'cookie',
+    ENVIRONMENT: 'environment',
+    REQUEST: 'request',
+    REQUEST_EXAMPLE: 'requestExample',
+    SECURITY_SCHEME: 'securityScheme',
+    SERVER: 'server',
+    TAG: 'tag',
+    WORKSPACE: 'workspace',
+};
+
+export { LS_KEYS };

package/dist/helpers/redirectToProxy.d.ts

@@ -1,5 +1,7 @@
 /** Redirects the request to a proxy server with a given URL. */
 export declare function redirectToProxy(proxy?: string, url?: string): string;
+/** Check if the URL is relative, aka doesn't start with http[s] */
+export declare const isRelativePath: (url: string) => boolean;
 /** Returns false for requests to localhost, relative URLs, if no proxy is defined … */
 export declare function shouldUseProxy(proxy?: string, url?: string): boolean;
 /** Detect requests to localhost */

package/dist/helpers/redirectToProxy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"redirectToProxy.d.ts","sourceRoot":"","sources":["../../src/helpers/redirectToProxy.ts"],"names":[],"mappings":"AAAA,gEAAgE;AAChE,wBAAgB,eAAe,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAepE;AAED,uFAAuF;AACvF,wBAAgB,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAiBpE;AAED,mCAAmC;AACnC,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,WAI/C"}
+{"version":3,"file":"redirectToProxy.d.ts","sourceRoot":"","sources":["../../src/helpers/redirectToProxy.ts"],"names":[],"mappings":"AAAA,gEAAgE;AAChE,wBAAgB,eAAe,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAepE;AAED,mEAAmE;AACnE,eAAO,MAAM,cAAc,QAAS,MAAM,YAA8B,CAAA;AAExE,uFAAuF;AACvF,wBAAgB,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAWpE;AAED,mCAAmC;AACnC,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,WAI/C"}

package/dist/helpers/redirectToProxy.js

@@ -11,20 +11,19 @@ function redirectToProxy(proxy, url) {
     newUrl.searchParams.append('scalar_url', url);
     return newUrl.toString();
 }
+/** Check if the URL is relative, aka doesn't start with http[s] */
+const isRelativePath = (url) => !/^https?:\/\//.test(url);
 /** Returns false for requests to localhost, relative URLs, if no proxy is defined … */
 function shouldUseProxy(proxy, url) {
     // No proxy or url
-    if (!proxy || !url) {
+    if (!proxy || !url)
         return false;
-    }
     // Relative URLs
-    if (!url.startsWith('http://') && !url.startsWith('https://')) {
+    if (isRelativePath(url))
         return false;
-    }
     // Requests to localhost
-    if (isRequestToLocalhost(url)) {
+    if (isRequestToLocalhost(url))
         return false;
-    }
     return true;
 }
 /** Detect requests to localhost */
@@ -34,4 +33,4 @@ function isRequestToLocalhost(url) {
     return listOfLocalUrls.includes(hostname);
 }
 
-export { isRequestToLocalhost, redirectToProxy, shouldUseProxy };
+export { isRelativePath, isRequestToLocalhost, redirectToProxy, shouldUseProxy };

package/dist/helpers/regexHelpers.d.ts

@@ -0,0 +1,2 @@
+export declare const variableRegex: RegExp;
+//# sourceMappingURL=regexHelpers.d.ts.map

package/dist/helpers/regexHelpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"regexHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/regexHelpers.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,QAA+B,CAAA"}

package/dist/helpers/regexHelpers.js

@@ -0,0 +1,3 @@
+const variableRegex = /{{((?:[^{}]|{[^{}]*})*)}}/g;
+
+export { variableRegex };

package/dist/helpers/schema-model.d.ts

@@ -1,5 +1,5 @@
 import type { ZodSchema, ZodTypeDef } from 'zod';
 /** Parse an value from a given schema with optional error or null return */
-export declare function schemaModel<T, I = any>(data: I, schema: ZodSchema<T, ZodTypeDef, any>, throwError?: true): T;
-export declare function schemaModel<T, I = any>(data: I, schema: ZodSchema<T, ZodTypeDef, any>, throwError?: false): T | null;
+export declare function schemaModel<T, I = any>(data: I, schema: ZodSchema<T, ZodTypeDef, any>, throwError?: true, errorLocation?: string): T;
+export declare function schemaModel<T, I = any>(data: I, schema: ZodSchema<T, ZodTypeDef, any>, throwError?: false, errorLocation?: string): T | null;
 //# sourceMappingURL=schema-model.d.ts.map

package/dist/helpers/schema-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema-model.d.ts","sourceRoot":"","sources":["../../src/helpers/schema-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,KAAK,CAAA;AAEhD,4EAA4E;AAC5E,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,EACpC,IAAI,EAAE,CAAC,EACP,MAAM,EAAE,SAAS,CAAC,CAAC,EAAE,UAAU,EAAE,GAAG,CAAC,EACrC,UAAU,CAAC,EAAE,IAAI,GAChB,CAAC,CAAA;AACJ,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,EACpC,IAAI,EAAE,CAAC,EACP,MAAM,EAAE,SAAS,CAAC,CAAC,EAAE,UAAU,EAAE,GAAG,CAAC,EACrC,UAAU,CAAC,EAAE,KAAK,GACjB,CAAC,GAAG,IAAI,CAAA"}
+{"version":3,"file":"schema-model.d.ts","sourceRoot":"","sources":["../../src/helpers/schema-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,KAAK,CAAA;AAEhD,4EAA4E;AAC5E,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,EACpC,IAAI,EAAE,CAAC,EACP,MAAM,EAAE,SAAS,CAAC,CAAC,EAAE,UAAU,EAAE,GAAG,CAAC,EACrC,UAAU,CAAC,EAAE,IAAI,EACjB,aAAa,CAAC,EAAE,MAAM,GACrB,CAAC,CAAA;AACJ,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,EACpC,IAAI,EAAE,CAAC,EACP,MAAM,EAAE,SAAS,CAAC,CAAC,EAAE,UAAU,EAAE,GAAG,CAAC,EACrC,UAAU,CAAC,EAAE,KAAK,EAClB,aAAa,CAAC,EAAE,MAAM,GACrB,CAAC,GAAG,IAAI,CAAA"}

package/dist/helpers/schema-model.js

@@ -1,21 +1,15 @@
-function schemaModel(data, schema, throwError = true) {
-    if (throwError) {
-        const result = schema.safeParse(data);
-        if (!result.success) {
-            console.error('Zod Schema Error');
-            console.group();
-            result.error.issues.forEach((issue) => {
-                console.log(`Path: ${issue.path.join(', ')} \nError: ${issue.message}`);
-            });
-            console.groupEnd();
-            throw new Error('Zod validation failure');
-        }
-        return result.data;
-    }
-    else {
-        const res = schema.safeParse(data);
-        return res.success ? res.data : null;
+/** Parse a Zod */
+function schemaModel(data, schema, throwError = true, errorLocation) {
+    const result = schema.safeParse(data);
+    if (!result.success) {
+        console.group('Schema Error' + (errorLocation ? ` - ${errorLocation}` : ''));
+        console.warn(JSON.stringify(result.error.format(), null, 2));
+        console.log('Recieved: ', data);
+        console.groupEnd();
     }
+    if (throwError && !result.success)
+        throw new Error('Zod validation failure');
+    return result.data;
 }
 
 export { schemaModel };

package/dist/migrations/data-version.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Ensure we update this every migration
+ *
+ * previous data versions:
+ * - undefined
+ * - 0.0.0
+ * - 2.1.0
+ */
+export declare const DATA_VERSION = "2.1.0";
+/** The localStorage key under which the data version is stored */
+export declare const DATA_VERSION_LS_LEY = "scalar_api_client_data_version";
+//# sourceMappingURL=data-version.d.ts.map

package/dist/migrations/data-version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-version.d.ts","sourceRoot":"","sources":["../../src/migrations/data-version.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,UAAU,CAAA;AAEnC,kEAAkE;AAClE,eAAO,MAAM,mBAAmB,mCAAmC,CAAA"}

package/dist/migrations/data-version.js

@@ -0,0 +1,13 @@
+/**
+ * Ensure we update this every migration
+ *
+ * previous data versions:
+ * - undefined
+ * - 0.0.0
+ * - 2.1.0
+ */
+const DATA_VERSION = '2.1.0';
+/** The localStorage key under which the data version is stored */
+const DATA_VERSION_LS_LEY = 'scalar_api_client_data_version';
+
+export { DATA_VERSION, DATA_VERSION_LS_LEY };

package/dist/migrations/generate-types.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=generate-types.d.ts.map

package/dist/migrations/generate-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-types.d.ts","sourceRoot":"","sources":["../../src/migrations/generate-types.ts"],"names":[],"mappings":""}

package/dist/migrations/index.d.ts

@@ -0,0 +1,4 @@
+export * from './data-version.js';
+export * from './migrator.js';
+export * from './semver.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/migrations/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/migrations/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA"}

package/dist/migrations/index.js

@@ -0,0 +1,3 @@
+export { DATA_VERSION, DATA_VERSION_LS_LEY } from './data-version.js';
+export { migrator } from './migrator.js';
+export { semverLessThan } from './semver.js';

package/dist/migrations/local-storage.d.ts

@@ -0,0 +1,8 @@
+import type { LS_KEYS } from '../helpers/index.js';
+/**
+ * Supports pre-flatted local storage
+ */
+export declare const parseLocalStorage: (lsKey: (typeof LS_KEYS)[keyof typeof LS_KEYS]) => Record<string, unknown>;
+/** Take a best guess of the localStorage version */
+export declare const getLocalStorageVersion: () => string;
+//# sourceMappingURL=local-storage.d.ts.map

package/dist/migrations/local-storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-storage.d.ts","sourceRoot":"","sources":["../../src/migrations/local-storage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAKxC;;GAEG;AACH,eAAO,MAAM,iBAAiB,UACrB,CAAC,OAAO,OAAO,EAAE,MAAM,OAAO,OAAO,CAAC,KAC5C,MAAM,CAAC,MAAM,EAAE,OAAO,CAKxB,CAAA;AAED,oDAAoD;AACpD,eAAO,MAAM,sBAAsB,QAAO,MAsBzC,CAAA"}

package/dist/migrations/local-storage.js

@@ -0,0 +1,36 @@
+import { DATA_VERSION_LS_LEY } from './data-version.js';
+import { parse } from 'flatted';
+
+/**
+ * Supports pre-flatted local storage
+ */
+const parseLocalStorage = (lsKey) => {
+    const item = localStorage.getItem(lsKey) || '[{}]';
+    const data = item[0] === '[' ? parse(item) : JSON.parse(item);
+    return data;
+};
+/** Take a best guess of the localStorage version */
+const getLocalStorageVersion = () => {
+    const collectionStr = localStorage.getItem('collection');
+    const dataVersion = localStorage.getItem(DATA_VERSION_LS_LEY);
+    // No flatted means first version
+    if (!collectionStr?.length || collectionStr?.[0] === '{')
+        return '0.0.0';
+    // Flatted + types means 2.1.0
+    try {
+        const [collection] = Object.values(parse(collectionStr) ?? {});
+        if (collection.type === 'collection')
+            return '2.1.0';
+        if (dataVersion)
+            return dataVersion;
+        return '0.0.0';
+    }
+    catch (e) {
+        console.error(e);
+        if (dataVersion)
+            return dataVersion;
+        return '0.0.0';
+    }
+};
+
+export { getLocalStorageVersion, parseLocalStorage };

package/dist/migrations/migrator.d.ts

@@ -0,0 +1,4 @@
+import { type v_2_1_0 } from '../migrations/v-2.1.0/index.js';
+/** Handles all data migrations per entity */
+export declare const migrator: () => v_2_1_0.DataArray;
+//# sourceMappingURL=migrator.d.ts.map

package/dist/migrations/migrator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrator.d.ts","sourceRoot":"","sources":["../../src/migrations/migrator.ts"],"names":[],"mappings":"AAKA,OAAO,EAAmB,KAAK,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAEpE,6CAA6C;AAC7C,eAAO,MAAM,QAAQ,QAAO,OAAO,CAAC,SAkCnC,CAAA"}

package/dist/migrations/migrator.js

@@ -0,0 +1,40 @@
+import { getLocalStorageVersion, parseLocalStorage } from './local-storage.js';
+import { semverLessThan } from './semver.js';
+import { migrate_v_2_1_0 } from './v-2.1.0/migration.js';
+
+/** Handles all data migrations per entity */
+const migrator = () => {
+    const dataVersion = getLocalStorageVersion();
+    console.info('Data version: ' + dataVersion);
+    // First we gather all of the old data
+    let data = {
+        collections: parseLocalStorage('collection'),
+        cookies: parseLocalStorage('cookie'),
+        environments: parseLocalStorage('environment'),
+        requestExamples: parseLocalStorage('requestExample'),
+        requests: parseLocalStorage('request'),
+        securitySchemes: parseLocalStorage('securityScheme'),
+        servers: parseLocalStorage('server'),
+        tags: parseLocalStorage('tag'),
+        workspaces: parseLocalStorage('workspace'),
+    };
+    // 0.0.0 -> 2.1.0 migration
+    if (semverLessThan(dataVersion, '2.1.0'))
+        data = migrate_v_2_1_0(data);
+    // If no migration, just grab values
+    else
+        data = {
+            collections: Object.values(data.collections),
+            cookies: Object.values(data.cookies),
+            environments: Object.values(data.environments),
+            requestExamples: Object.values(data.requestExamples),
+            requests: Object.values(data.requests),
+            securitySchemes: Object.values(data.securitySchemes),
+            servers: Object.values(data.servers),
+            tags: Object.values(data.tags),
+            workspaces: Object.values(data.workspaces),
+        };
+    return data;
+};
+
+export { migrator };

package/dist/migrations/semver.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Compares semver versions and checks if the left one is less than the right
+ */
+export declare const semverLessThan: (left: string, right: string) => boolean;
+//# sourceMappingURL=semver.d.ts.map

package/dist/migrations/semver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"semver.d.ts","sourceRoot":"","sources":["../../src/migrations/semver.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,cAAc,SAAU,MAAM,SAAS,MAAM,KAAG,OAqB5D,CAAA"}

package/dist/migrations/semver.js

@@ -0,0 +1,25 @@
+/**
+ * Compares semver versions and checks if the left one is less than the right
+ */
+const semverLessThan = (left, right) => {
+    // Parse the strings into numbers
+    const parseSemver = (version) => {
+        const [major, minor = 0, patch = 0] = version
+            .split('.')
+            .map((part) => parseInt(part, 10));
+        return { major, minor, patch };
+    };
+    const { major: major1, minor: minor1, patch: patch1 } = parseSemver(left);
+    const { major: major2, minor: minor2, patch: patch2 } = parseSemver(right);
+    if (major1 < major2)
+        return true;
+    if (major1 > major2)
+        return false;
+    if (minor1 < minor2)
+        return true;
+    if (minor1 > minor2)
+        return false;
+    return patch1 < patch2;
+};
+
+export { semverLessThan };

package/dist/migrations/v-0.0.0/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types.generated';
+//# sourceMappingURL=index.d.ts.map

package/dist/migrations/v-0.0.0/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-0.0.0/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA"}

package/dist/migrations/v-0.0.0/index.js

@@ -0,0 +1 @@
+