@scalar/oas-utils 0.2.91 → 0.2.93

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scalar/oas-utils
 
+## 0.2.93
+
+### Patch Changes
+
+- ca2d98b: chore: adds drafts server migration
+
+## 0.2.92
+
+### Patch Changes
+
+- 02b4201: fix(api-client): strict TS config (enable noUncheckedIndexedAccess)
+
 ## 0.2.91
 
 ### Patch Changes

package/dist/helpers/httpMethods.d.ts

@@ -24,6 +24,6 @@ export declare const getHttpMethodInfo: (methodName: string) => {
     backgroundColor: string;
 };
 /** Type guard which takes in a string and returns true if it is in fact an HTTPMethod */
-export declare const isHttpMethod: (method: string) => method is RequestMethod;
+export declare const isHttpMethod: (method?: string | undefined) => method is RequestMethod;
 export {};
 //# sourceMappingURL=httpMethods.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"httpMethods.d.ts","sourceRoot":"","sources":["../../src/helpers/httpMethods.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAkB,MAAM,0BAA0B,CAAA;AAE7E;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE;KAC3B,CAAC,IAAI,aAAa,GAAG;QACpB,KAAK,EAAE,MAAM,CAAA;QACb,KAAK,EAAE,MAAM,CAAA;QACb,eAAe,EAAE,MAAM,CAAA;KACxB;CA+CO,CAAA;AAEV,yCAAyC;AACzC,QAAA,MAAM,YAAY,6CAA8C,CAAA;AAChE,KAAK,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAA;AAE/C,0DAA0D;AAC1D,eAAO,MAAM,iBAAiB,WACpB,aAAa,KACpB,MAAM,IAAI,UAAyD,CAAA;AAEtE;;GAEG;AACH,eAAO,MAAM,iBAAiB,eAAgB,MAAM;WAhEzC,MAAM;WACN,MAAM;qBACI,MAAM;CAuE1B,CAAA;AAED,yFAAyF;AACzF,eAAO,MAAM,YAAY,WAAY,MAAM,KAAG,MAAM,IAAI,aACN,CAAA"}
+{"version":3,"file":"httpMethods.d.ts","sourceRoot":"","sources":["../../src/helpers/httpMethods.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAkB,MAAM,0BAA0B,CAAA;AAE7E;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE;KAC3B,CAAC,IAAI,aAAa,GAAG;QACpB,KAAK,EAAE,MAAM,CAAA;QACb,KAAK,EAAE,MAAM,CAAA;QACb,eAAe,EAAE,MAAM,CAAA;KACxB;CA+CO,CAAA;AAEV,yCAAyC;AACzC,QAAA,MAAM,YAAY,6CAA8C,CAAA;AAChE,KAAK,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAA;AAE/C,0DAA0D;AAC1D,eAAO,MAAM,iBAAiB,WACpB,aAAa,KACpB,MAAM,IAAI,UAAyD,CAAA;AAEtE;;GAEG;AACH,eAAO,MAAM,iBAAiB,eAAgB,MAAM;WAhEzC,MAAM;WACN,MAAM;qBACI,MAAM;CAuE1B,CAAA;AAED,yFAAyF;AACzF,eAAO,MAAM,YAAY,YACd,MAAM,GAAG,SAAS,KAC1B,MAAM,IAAI,aACsD,CAAA"}

package/dist/helpers/httpMethods.js

@@ -67,6 +67,6 @@ const getHttpMethodInfo = (methodName) => {
     });
 };
 /** Type guard which takes in a string and returns true if it is in fact an HTTPMethod */
-const isHttpMethod = (method) => requestMethods.includes(method);
+const isHttpMethod = (method) => method ? requestMethods.includes(method) : false;
 
 export { REQUEST_METHODS, canMethodHaveBody, getHttpMethodInfo, isHttpMethod };

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

@@ -6,8 +6,10 @@
  * - 0.0.0
  * - 2.1.0 - refactor
  * - 2.2.0 - auth compliancy
+ * - 2.3.0 - environments
+ * - 2.4.0 - draft collection servers
  */
-export declare const DATA_VERSION = "2.3.0";
+export declare const DATA_VERSION = "2.4.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

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

package/dist/migrations/data-version.js

@@ -6,8 +6,10 @@
  * - 0.0.0
  * - 2.1.0 - refactor
  * - 2.2.0 - auth compliancy
+ * - 2.3.0 - environments
+ * - 2.4.0 - draft collection servers
  */
-const DATA_VERSION = '2.3.0';
+const DATA_VERSION = '2.4.0';
 /** The localStorage key under which the data version is stored */
 const DATA_VERSION_LS_LEY = 'scalar_api_client_data_version';
 

package/dist/migrations/migrator.d.ts

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

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

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

package/dist/migrations/migrator.js

@@ -3,6 +3,7 @@ import { semverLessThan } from './semver.js';
 import { migrate_v_2_1_0 } from './v-2.1.0/migration.js';
 import { migrate_v_2_2_0 } from './v-2.2.0/migration.js';
 import { migrate_v_2_3_0 } from './v-2.3.0/migration.js';
+import { migrate_v_2_4_0 } from './v-2.4.0/migration.js';
 
 /** Handles all data migrations per entity */
 const migrator = () => {
@@ -29,6 +30,9 @@ const migrator = () => {
     // 2.2.0 -> 2.3.0 migration
     if (semverLessThan(dataVersion, '2.3.0'))
         data = migrate_v_2_3_0(data);
+    // 2.3.0 -> 2.4.0 migration
+    if (semverLessThan(dataVersion, '2.4.0'))
+        data = migrate_v_2_4_0(data);
     // Convert to data array
     data = {
         collections: Object.values(data.collections),

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

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

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

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

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

@@ -0,0 +1 @@
+export { migrate_v_2_4_0 } from './migration.js';

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

@@ -0,0 +1,5 @@
+import type { v_2_3_0 } from '../../migrations/v-2.3.0/types.generated';
+import type { v_2_4_0 } from './types.generated';
+/** V-2.3.0 to V-2.4.0 migration */
+export declare const migrate_v_2_4_0: (data: v_2_3_0.DataRecord) => v_2_4_0.DataRecord;
+//# sourceMappingURL=migration.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.4.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,SACpB,OAAO,CAAC,UAAU,KACvB,OAAO,CAAC,UA8BV,CAAA"}

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

@@ -0,0 +1,29 @@
+/** V-2.3.0 to V-2.4.0 migration */
+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,
+    };
+};
+
+export { migrate_v_2_4_0 };

package/dist/migrations/v-2.4.0/types.generated.d.ts

@@ -0,0 +1,38 @@
+import type { Cookie as Ck } from '../../entities/cookie/index.js';
+import type { Environment as E } from '../../entities/environment/index.js';
+import type { Collection as Co, Request as R, RequestExample as RE, Server as S, SecurityScheme as SS, Tag as T } from '../../entities/spec/index.js';
+import type { Workspace as W } from '../../entities/workspace/index.js';
+export declare namespace v_2_4_0 {
+    type Cookie = Ck;
+    type Environment = E;
+    type Collection = Co;
+    type Request = R;
+    type RequestExample = RE;
+    type SecurityScheme = SS;
+    type Server = S;
+    type Tag = T;
+    type Workspace = W;
+    type DataRecord = {
+        collections: Record<string, Collection>;
+        cookies: Record<string, Cookie>;
+        environments: Record<string, Environment>;
+        requestExamples: Record<string, RequestExample>;
+        requests: Record<string, Request>;
+        securitySchemes: Record<string, SecurityScheme>;
+        servers: Record<string, Server>;
+        tags: Record<string, Tag>;
+        workspaces: Record<string, Workspace>;
+    };
+    type DataArray = {
+        collections: Collection[];
+        cookies: Cookie[];
+        environments: Environment[];
+        requestExamples: RequestExample[];
+        requests: Request[];
+        securitySchemes: SecurityScheme[];
+        servers: Server[];
+        tags: Tag[];
+        workspaces: Workspace[];
+    };
+}
+//# sourceMappingURL=types.generated.d.ts.map

package/dist/migrations/v-2.4.0/types.generated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.generated.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.4.0/types.generated.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,EAAE,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,WAAW,IAAI,CAAC,EAAE,MAAM,wBAAwB,CAAA;AAC9D,OAAO,KAAK,EACV,UAAU,IAAI,EAAE,EAChB,OAAO,IAAI,CAAC,EACZ,cAAc,IAAI,EAAE,EACpB,MAAM,IAAI,CAAC,EACX,cAAc,IAAI,EAAE,EACpB,GAAG,IAAI,CAAC,EACT,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAAE,SAAS,IAAI,CAAC,EAAE,MAAM,sBAAsB,CAAA;AAE1D,yBAAiB,OAAO,CAAC;IACvB,KAAY,MAAM,GAAG,EAAE,CAAA;IACvB,KAAY,WAAW,GAAG,CAAC,CAAA;IAC3B,KAAY,UAAU,GAAG,EAAE,CAAA;IAC3B,KAAY,OAAO,GAAG,CAAC,CAAA;IACvB,KAAY,cAAc,GAAG,EAAE,CAAA;IAC/B,KAAY,cAAc,GAAG,EAAE,CAAA;IAC/B,KAAY,MAAM,GAAG,CAAC,CAAA;IACtB,KAAY,GAAG,GAAG,CAAC,CAAA;IACnB,KAAY,SAAS,GAAG,CAAC,CAAA;IAEzB,KAAY,UAAU,GAAG;QACvB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;QACvC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC/B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;QACzC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;QAC/C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACjC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;QAC/C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC/B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QACzB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;KACtC,CAAA;IAED,KAAY,SAAS,GAAG;QACtB,WAAW,EAAE,UAAU,EAAE,CAAA;QACzB,OAAO,EAAE,MAAM,EAAE,CAAA;QACjB,YAAY,EAAE,WAAW,EAAE,CAAA;QAC3B,eAAe,EAAE,cAAc,EAAE,CAAA;QACjC,QAAQ,EAAE,OAAO,EAAE,CAAA;QACnB,eAAe,EAAE,cAAc,EAAE,CAAA;QACjC,OAAO,EAAE,MAAM,EAAE,CAAA;QACjB,IAAI,EAAE,GAAG,EAAE,CAAA;QACX,UAAU,EAAE,SAAS,EAAE,CAAA;KACxB,CAAA;CACF"}

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.91",
+  "version": "0.2.93",
   "engines": {
     "node": ">=18"
   },
@@ -38,6 +38,11 @@
       "types": "./dist/migrations/index.d.ts",
       "default": "./dist/migrations/index.js"
     },
+    "./migrations/v-2.4.0": {
+      "import": "./dist/migrations/v-2.4.0/index.js",
+      "types": "./dist/migrations/v-2.4.0/index.d.ts",
+      "default": "./dist/migrations/v-2.4.0/index.js"
+    },
     "./migrations/v-2.3.0": {
       "import": "./dist/migrations/v-2.3.0/index.js",
       "types": "./dist/migrations/v-2.3.0/index.d.ts",
@@ -116,10 +121,10 @@
     "nanoid": "^5.0.7",
     "yaml": "^2.4.5",
     "zod": "^3.23.8",
-    "@scalar/object-utils": "1.1.12",
-    "@scalar/themes": "0.9.58",
     "@scalar/openapi-types": "0.1.5",
-    "@scalar/types": "0.0.25"
+    "@scalar/object-utils": "1.1.12",
+    "@scalar/types": "0.0.25",
+    "@scalar/themes": "0.9.58"
   },
   "devDependencies": {
     "type-fest": "^4.20.0",
@@ -127,7 +132,7 @@
     "vitest": "^1.6.0",
     "zod-to-ts": "github:amritk/zod-to-ts#build",
     "@scalar/build-tooling": "0.1.12",
-    "@scalar/openapi-parser": "0.10.1",
+    "@scalar/openapi-parser": "0.10.2",
     "@scalar/openapi-types": "0.1.5"
   },
   "scripts": {