@scalar/oas-utils 0.2.88 → 0.2.91

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/dist/helpers/index.d.ts +1 -0
  3. package/dist/helpers/index.d.ts.map +1 -1
  4. package/dist/helpers/index.js +1 -0
  5. package/dist/helpers/is-defined.d.ts +13 -0
  6. package/dist/helpers/is-defined.d.ts.map +1 -0
  7. package/dist/helpers/is-defined.js +14 -0
  8. package/dist/transforms/import-spec.d.ts.map +1 -1
  9. package/dist/transforms/import-spec.js +9 -2
  10. package/package.json +5 -5
package/CHANGELOG.md CHANGED
@@ -1,5 +1,29 @@
1
1
  # @scalar/oas-utils
2
2
 
3
+ ## 0.2.91
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies [6407b2b]
8
+ - @scalar/themes@0.9.58
9
+
10
+ ## 0.2.90
11
+
12
+ ### Patch Changes
13
+
14
+ - 573d113: feat: add isDefined type safe filter helper
15
+ - c263aaf: feat: better deal with empty OpenAPI documents
16
+ - Updated dependencies [c263aaf]
17
+ - @scalar/types@0.0.25
18
+ - @scalar/themes@0.9.57
19
+
20
+ ## 0.2.89
21
+
22
+ ### Patch Changes
23
+
24
+ - Updated dependencies [23daedd]
25
+ - @scalar/themes@0.9.56
26
+
3
27
  ## 0.2.88
4
28
 
5
29
  ### Patch Changes
package/dist/helpers/index.d.ts CHANGED
@@ -6,6 +6,7 @@ export * from './findVariables.js';
6
6
  export * from './httpMethods.js';
7
7
  export * from './httpStatusCodes.js';
8
8
  export * from './isLocalUrl.js';
9
+ export { isDefined } from './is-defined.js';
9
10
  export * from './isValidUrl.js';
10
11
  export * from './iterateTitle.js';
11
12
  export * from './local-storage.js';
package/dist/helpers/index.d.ts.map CHANGED
@@ -1 +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"}
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,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 CHANGED
@@ -6,6 +6,7 @@ export { findVariables } from './findVariables.js';
6
6
  export { REQUEST_METHODS, canMethodHaveBody, getHttpMethodInfo, isHttpMethod } from './httpMethods.js';
7
7
  export { httpStatusCodes } from './httpStatusCodes.js';
8
8
  export { isLocalUrl } from './isLocalUrl.js';
9
+ export { isDefined } from './is-defined.js';
9
10
  export { isValidUrl } from './isValidUrl.js';
10
11
  export { iterateTitle } from './iterateTitle.js';
11
12
  export { LS_KEYS } from './local-storage.js';
package/dist/helpers/is-defined.d.ts ADDED
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Type safe alternative to array.filter(Boolean)
3
+ *
4
+ * @example
5
+ *
6
+ * ```ts
7
+ * const dataArray = [1, null, 2, undefined, 3].filter(isDefined)
8
+ * ```
9
+ *
10
+ * @see https://jaketrent.com/post/typescript-type-safe-filter-boolean/
11
+ */
12
+ export declare const isDefined: <T>(value: T | null | undefined) => value is NonNullable<T>;
13
+ //# sourceMappingURL=is-defined.d.ts.map
package/dist/helpers/is-defined.d.ts.map ADDED
@@ -0,0 +1 @@
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 ADDED
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Type safe alternative to array.filter(Boolean)
3
+ *
4
+ * @example
5
+ *
6
+ * ```ts
7
+ * const dataArray = [1, null, 2, undefined, 3].filter(isDefined)
8
+ * ```
9
+ *
10
+ * @see https://jaketrent.com/post/typescript-type-safe-filter-boolean/
11
+ */
12
+ const isDefined = (value) => value !== null && value !== undefined;
13
+
14
+ export { isDefined };
package/dist/transforms/import-spec.d.ts.map CHANGED
@@ -1 +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"}
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;;;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 CHANGED
@@ -11,11 +11,18 @@ import { collectionSchema } from '../entities/spec/collection.js';
11
11
 
12
12
  /** Takes a string or object and parses it into an openapi spec compliant schema */
13
13
  const parseSchema = async (spec, { shouldLoad = true } = {}) => {
14
- // TODO: Plugins for URLs and files with the proxy is missing here.
15
- // @see packages/api-reference/src/helpers/parse.ts
14
+ if (spec === null || (typeof spec === 'string' && spec.trim() === '')) {
15
+ console.warn('[@scalar/oas-utils] Empty OpenAPI document provided.');
16
+ return {
17
+ schema: {},
18
+ errors: [],
19
+ };
20
+ }
16
21
  let filesystem = spec;
17
22
  let loadErrors = [];
18
23
  if (shouldLoad) {
24
+ // TODO: Plugins for URLs and files with the proxy is missing here.
25
+ // @see packages/api-reference/src/helpers/parse.ts
19
26
  const resp = await load(spec).catch((e) => ({
20
27
  errors: [
21
28
  {
package/package.json CHANGED
@@ -7,7 +7,7 @@
7
7
  "bugs": "https://github.com/scalar/scalar/issues/new/choose",
8
8
  "repository": {
9
9
  "type": "git",
10
- "url": "https://github.com/scalar/scalar.git",
10
+ "url": "git+https://github.com/scalar/scalar.git",
11
11
  "directory": "packages/oas-utils"
12
12
  },
13
13
  "keywords": [
@@ -16,7 +16,7 @@
16
16
  "specification",
17
17
  "yaml"
18
18
  ],
19
- "version": "0.2.88",
19
+ "version": "0.2.91",
20
20
  "engines": {
21
21
  "node": ">=18"
22
22
  },
@@ -117,9 +117,9 @@
117
117
  "yaml": "^2.4.5",
118
118
  "zod": "^3.23.8",
119
119
  "@scalar/object-utils": "1.1.12",
120
+ "@scalar/themes": "0.9.58",
120
121
  "@scalar/openapi-types": "0.1.5",
121
- "@scalar/themes": "0.9.55",
122
- "@scalar/types": "0.0.24"
122
+ "@scalar/types": "0.0.25"
123
123
  },
124
124
  "devDependencies": {
125
125
  "type-fest": "^4.20.0",
@@ -127,7 +127,7 @@
127
127
  "vitest": "^1.6.0",
128
128
  "zod-to-ts": "github:amritk/zod-to-ts#build",
129
129
  "@scalar/build-tooling": "0.1.12",
130
- "@scalar/openapi-parser": "0.10.0",
130
+ "@scalar/openapi-parser": "0.10.1",
131
131
  "@scalar/openapi-types": "0.1.5"
132
132
  },
133
133
  "scripts": {