@scalar/oas-utils 0.2.87 → 0.2.90

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @scalar/oas-utils
 
+## 0.2.90
+
+### Patch Changes
+
+- 573d113: feat: add isDefined type safe filter helper
+- c263aaf: feat: better deal with empty OpenAPI documents
+- Updated dependencies [c263aaf]
+  - @scalar/types@0.0.25
+  - @scalar/themes@0.9.57
+
+## 0.2.89
+
+### Patch Changes
+
+- Updated dependencies [23daedd]
+  - @scalar/themes@0.9.56
+
+## 0.2.88
+
+### Patch Changes
+
+- Updated dependencies [fbef0c3]
+  - @scalar/types@0.0.24
+  - @scalar/themes@0.9.55
+
 ## 0.2.87
 
 ### Patch Changes

package/dist/helpers/index.d.ts

@@ -6,6 +6,7 @@ export * from './findVariables.js';
 export * from './httpMethods.js';
 export * from './httpStatusCodes.js';
 export * from './isLocalUrl.js';
+export { isDefined } from './is-defined.js';
 export * from './isValidUrl.js';
 export * from './iterateTitle.js';
 export * from './local-storage.js';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,cAAc,CAAA;AAC5B,cAAc,oBAAoB,CAAA;AAClC,cAAc,0BAA0B,CAAA;AACxC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,mBAAmB,CAAA;AACjC,cAAc,cAAc,CAAA;AAC5B,cAAc,cAAc,CAAA;AAC5B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,qBAAqB,CAAA;AACnC,cAAc,2BAA2B,CAAA;AACzC,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,cAAc,CAAA;AAC5B,cAAc,oBAAoB,CAAA;AAClC,cAAc,0BAA0B,CAAA;AACxC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,mBAAmB,CAAA;AACjC,cAAc,cAAc,CAAA;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AACxC,cAAc,cAAc,CAAA;AAC5B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,qBAAqB,CAAA;AACnC,cAAc,2BAA2B,CAAA;AACzC,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA"}

package/dist/helpers/index.js

@@ -6,6 +6,7 @@ export { findVariables } from './findVariables.js';
 export { REQUEST_METHODS, canMethodHaveBody, getHttpMethodInfo, isHttpMethod } from './httpMethods.js';
 export { httpStatusCodes } from './httpStatusCodes.js';
 export { isLocalUrl } from './isLocalUrl.js';
+export { isDefined } from './is-defined.js';
 export { isValidUrl } from './isValidUrl.js';
 export { iterateTitle } from './iterateTitle.js';
 export { LS_KEYS } from './local-storage.js';

package/dist/helpers/is-defined.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Type safe alternative to array.filter(Boolean)
+ *
+ * @example
+ *
+ * ```ts
+ * const dataArray = [1, null, 2, undefined, 3].filter(isDefined)
+ * ```
+ *
+ * @see https://jaketrent.com/post/typescript-type-safe-filter-boolean/
+ */
+export declare const isDefined: <T>(value: T | null | undefined) => value is NonNullable<T>;
+//# sourceMappingURL=is-defined.d.ts.map

package/dist/helpers/is-defined.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-defined.d.ts","sourceRoot":"","sources":["../../src/helpers/is-defined.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAClB,CAAC,GAAG,IAAI,GAAG,SAAS,KAC1B,KAAK,IAAI,WAAW,CAAC,CAAC,CAA0C,CAAA"}

package/dist/helpers/is-defined.js

@@ -0,0 +1,14 @@
+/**
+ * Type safe alternative to array.filter(Boolean)
+ *
+ * @example
+ *
+ * ```ts
+ * const dataArray = [1, null, 2, undefined, 3].filter(isDefined)
+ * ```
+ *
+ * @see https://jaketrent.com/post/typescript-type-safe-filter-boolean/
+ */
+const isDefined = (value) => value !== null && value !== undefined;
+
+export { isDefined };

package/dist/transforms/import-spec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,OAAO,EACZ,KAAK,cAAc,EAGnB,KAAK,MAAM,EACX,KAAK,GAAG,EAMT,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAEL,KAAK,cAAc,EAGpB,MAAM,0BAA0B,CAAA;AAUjC,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGxD,mFAAmF;AACnF,eAAO,MAAM,WAAW,SAChB,MAAM,GAAG,aAAa;;;IA+B1B;;;OAGG;YAEC,SAAS,CAAC,QAAQ,GAClB,WAAW,CAAC,QAAQ;;EAG3B,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC1C,iBAAiB,EACjB,aAAa,GAAG,WAAW,CAC5B,GACC,IAAI,CACF,sBAAsB,EACtB,gBAAgB,GAAG,eAAe,GAAG,SAAS,CAC/C,GAAG;IACF,mFAAmF;IACnF,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAEH;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,EAC5B,EACE,cAAc,EACd,aAAa,EACb,WAAW,EACX,OAAO,EAAE,eAAe,EACxB,qBAA6B,EAC7B,UAAU,EACV,SAAiB,GAClB,GAAE,yBAA8B,GAChC,OAAO,CACN;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,MAAM,EAAE,SAAS,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAA;IACjD,QAAQ,EAAE,cAAc,EAAE,CAAA;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,EAAE,GAAG,EAAE,CAAA;IACX,eAAe,EAAE,cAAc,EAAE,CAAA;CAClC,GACD;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,cAAc,EAAE,MAAM,EAAE,CAAA;CAAE,CAC5C,CAsVA"}
+{"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,OAAO,EACZ,KAAK,cAAc,EAGnB,KAAK,MAAM,EACX,KAAK,GAAG,EAMT,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAEL,KAAK,cAAc,EAGpB,MAAM,0BAA0B,CAAA;AAUjC,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGxD,mFAAmF;AACnF,eAAO,MAAM,WAAW,SAChB,MAAM,GAAG,aAAa;;;IAuC1B;;;OAGG;YAEC,SAAS,CAAC,QAAQ,GAClB,WAAW,CAAC,QAAQ;;EAG3B,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC1C,iBAAiB,EACjB,aAAa,GAAG,WAAW,CAC5B,GACC,IAAI,CACF,sBAAsB,EACtB,gBAAgB,GAAG,eAAe,GAAG,SAAS,CAC/C,GAAG;IACF,mFAAmF;IACnF,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAEH;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,EAC5B,EACE,cAAc,EACd,aAAa,EACb,WAAW,EACX,OAAO,EAAE,eAAe,EACxB,qBAA6B,EAC7B,UAAU,EACV,SAAiB,GAClB,GAAE,yBAA8B,GAChC,OAAO,CACN;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,MAAM,EAAE,SAAS,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAA;IACjD,QAAQ,EAAE,cAAc,EAAE,CAAA;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,EAAE,GAAG,EAAE,CAAA;IACX,eAAe,EAAE,cAAc,EAAE,CAAA;CAClC,GACD;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,cAAc,EAAE,MAAM,EAAE,CAAA;CAAE,CAC5C,CAsVA"}

package/dist/transforms/import-spec.js

@@ -11,11 +11,18 @@ import { collectionSchema } from '../entities/spec/collection.js';
 
 /** Takes a string or object and parses it into an openapi spec compliant schema */
 const parseSchema = async (spec, { shouldLoad = true } = {}) => {
-    // TODO: Plugins for URLs and files with the proxy is missing here.
-    // @see packages/api-reference/src/helpers/parse.ts
+    if (spec === null || (typeof spec === 'string' && spec.trim() === '')) {
+        console.warn('[@scalar/oas-utils] Empty OpenAPI document provided.');
+        return {
+            schema: {},
+            errors: [],
+        };
+    }
     let filesystem = spec;
     let loadErrors = [];
     if (shouldLoad) {
+        // TODO: Plugins for URLs and files with the proxy is missing here.
+        // @see packages/api-reference/src/helpers/parse.ts
         const resp = await load(spec).catch((e) => ({
             errors: [
                 {

package/package.json

@@ -7,7 +7,7 @@
   "bugs": "https://github.com/scalar/scalar/issues/new/choose",
   "repository": {
     "type": "git",
-    "url": "https://github.com/scalar/scalar.git",
+    "url": "git+https://github.com/scalar/scalar.git",
     "directory": "packages/oas-utils"
   },
   "keywords": [
@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.87",
+  "version": "0.2.90",
   "engines": {
     "node": ">=18"
   },
@@ -117,17 +117,17 @@
     "yaml": "^2.4.5",
     "zod": "^3.23.8",
     "@scalar/object-utils": "1.1.12",
-    "@scalar/types": "0.0.23",
     "@scalar/openapi-types": "0.1.5",
-    "@scalar/themes": "0.9.54"
+    "@scalar/types": "0.0.25",
+    "@scalar/themes": "0.9.57"
   },
   "devDependencies": {
     "type-fest": "^4.20.0",
     "vite": "^5.4.10",
     "vitest": "^1.6.0",
     "zod-to-ts": "github:amritk/zod-to-ts#build",
+    "@scalar/openapi-parser": "0.10.1",
     "@scalar/build-tooling": "0.1.12",
-    "@scalar/openapi-parser": "0.9.0",
     "@scalar/openapi-types": "0.1.5"
   },
   "scripts": {