@scalar/oas-utils 0.0.3 → 0.0.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scalar/oas-utils
 
+## 0.0.4
+
+### Patch Changes
+
+- cecf074: Migrate to oas utils for basic spec operations
+
 ## 0.0.3
 
 ### Patch Changes

package/dist/fetch-spec.d.ts

@@ -1,3 +1,3 @@
 /** Fetches an OAS spec file from a given URL. */
-export declare const fetchSpecFromUrl: (url: string, proxy?: string, parseObject?: boolean) => Promise<string | import("./types").AnyObject>;
+export declare function fetchSpecFromUrl(url: string, proxy?: string): Promise<string>;
 //# sourceMappingURL=fetch-spec.d.ts.map

package/dist/fetch-spec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetch-spec.d.ts","sourceRoot":"","sources":["../src/fetch-spec.ts"],"names":[],"mappings":"AAEA,iDAAiD;AACjD,eAAO,MAAM,gBAAgB,QACtB,MAAM,UACH,MAAM,yEAgCf,CAAA"}
+{"version":3,"file":"fetch-spec.d.ts","sourceRoot":"","sources":["../src/fetch-spec.ts"],"names":[],"mappings":"AAEA,iDAAiD;AACjD,wBAAsB,gBAAgB,CACpC,GAAG,EAAE,MAAM,EACX,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,MAAM,CAAC,CA8BjB"}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export * from './fetch-spec';
+export { fetchSpecFromUrl } from './fetch-spec';
 export * from './parse';
 export * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAC/C,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA"}

package/dist/index.js

@@ -1,23 +1,50 @@
 import { parse, stringify } from 'yaml';
 
 const yaml = {
-  parse,
+  /** Parse and throw if the return value is not an object */
+  parse: (val) => {
+    const yamlObject = parse(val);
+    if (typeof yamlObject !== "object")
+      throw Error("Invalid YAML object");
+    return yamlObject;
+  },
+  /** Parse and return a fallback on failure */
+  parseSafe(val, fallback) {
+    try {
+      return yaml.parse(val);
+    } catch (err) {
+      return typeof fallback === "function" ? fallback(err) : fallback;
+    }
+  },
   stringify
 };
-const loadJsonOrYaml = (value) => {
-  if (typeof value === "string") {
+const json = {
+  /** Parse and throw if the return value is not an object */
+  parse: (val) => {
+    const jsonObject = JSON.parse(val);
+    if (typeof jsonObject !== "object")
+      throw Error("Invalid JSON object");
+    return jsonObject;
+  },
+  /** Parse and return a fallback on failure */
+  parseSafe(val, fallback) {
     try {
-      return JSON.parse(value);
-    } catch (error) {
-      if (value.length > 0 && ["{", "["].includes(value[0])) {
-        throw error;
-      }
-      return yaml.parse(value);
+      return json.parse(val);
+    } catch (err) {
+      return typeof fallback === "function" ? fallback(err) : fallback;
     }
-  }
-  return value;
+  },
+  stringify: (val) => JSON.stringify(val)
+};
+const isJsonString = (value) => {
+  if (typeof value !== "string")
+    return false;
+  return !!json.parseSafe(value, false);
+};
+const transformToJson = (value) => {
+  return JSON.stringify(json.parseSafe(value, yaml.parseSafe(value, value)));
 };
-function loadJsonOrYamlString(value) {
+function formatJsonOrYamlString(value) {
   const trimmed = value.trim();
   if (trimmed[0] !== "{")
     return value;
@@ -27,8 +54,21 @@ function loadJsonOrYamlString(value) {
     return value;
   }
 }
+const parseJsonOrYaml = (value) => {
+  if (typeof value !== "string")
+    return value;
+  const jsonObject = json.parseSafe(value, null);
+  if (jsonObject)
+    return jsonObject;
+  if (value.length > 0 && ["{", "["].includes(value[0])) {
+    throw Error("Invalid JSON or YAML");
+  }
+  return yaml.parseSafe(value, (err) => {
+    throw Error(err);
+  });
+};
 
-const fetchSpecFromUrl = async (url, proxy, parseObject = false) => {
+async function fetchSpecFromUrl(url, proxy) {
   const response = proxy ? await fetch(proxy, {
     method: "POST",
     headers: {
@@ -46,7 +86,7 @@ const fetchSpecFromUrl = async (url, proxy, parseObject = false) => {
     );
   }
   const payload = proxy ? String((await response.json()).data) : await response.text();
-  return parseObject ? loadJsonOrYaml(payload) : loadJsonOrYamlString(payload);
-};
+  return formatJsonOrYamlString(payload);
+}
 
-export { fetchSpecFromUrl, loadJsonOrYaml, loadJsonOrYamlString, yaml };
+export { fetchSpecFromUrl, formatJsonOrYamlString, isJsonString, json, parseJsonOrYaml, transformToJson, yaml };

package/dist/parse.d.ts

@@ -1,11 +1,33 @@
-import { parse, stringify } from 'yaml';
+import { stringify } from 'yaml';
 import { type AnyObject } from './types';
+type PrimitiveOrObject = object | string | null | number | boolean | undefined;
+/** Yaml handling with optional safeparse */
 export declare const yaml: {
-    parse: typeof parse;
+    /** Parse and throw if the return value is not an object */
+    parse: (val: string) => AnyObject;
+    /** Parse and return a fallback on failure */
+    parseSafe<T extends PrimitiveOrObject>(val: string, fallback: T | ((err: any) => T)): AnyObject | T;
     stringify: typeof stringify;
 };
-/** Parses a JSON or Yaml object or string into an object */
-export declare const loadJsonOrYaml: (value: string | AnyObject) => AnyObject;
+/** JSON handling with optional safeparse */
+export declare const json: {
+    /** Parse and throw if the return value is not an object */
+    parse: (val: string) => AnyObject;
+    /** Parse and return a fallback on failure */
+    parseSafe<T extends PrimitiveOrObject>(val: string, fallback: T | ((err: any) => T)): AnyObject | T;
+    stringify: (val: object) => string;
+};
+/**
+ * Check if value is a valid JSON string
+ */
+export declare const isJsonString: (value?: any) => boolean;
+/**
+ * This helper is used to transform the content of the swagger file to JSON, even it was YAML.
+ */
+export declare const transformToJson: (value: string) => string;
 /** Validates a JSON string if provided. Otherwise returns the raw Yaml */
-export declare function loadJsonOrYamlString(value: string): string;
+export declare function formatJsonOrYamlString(value: string): string;
+/** Parse JSON or YAML into an object */
+export declare const parseJsonOrYaml: (value: string | AnyObject) => AnyObject;
+export {};
 //# sourceMappingURL=parse.d.ts.map

package/dist/parse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../src/parse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAEvC,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,SAAS,CAAA;AAExC,eAAO,MAAM,IAAI;;;CAGhB,CAAA;AAED,4DAA4D;AAC5D,eAAO,MAAM,cAAc,UAAW,MAAM,GAAG,SAAS,KAAG,SAgB1D,CAAA;AAED,0EAA0E;AAC1E,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,UAYjD"}
+{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../src/parse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,SAAS,EAAE,MAAM,MAAM,CAAA;AAEvC,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,SAAS,CAAA;AAExC,KAAK,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAA;AAE9E,4CAA4C;AAC5C,eAAO,MAAM,IAAI;IACf,2DAA2D;iBAC9C,MAAM;IAKnB,6CAA6C;gDAEtC,MAAM,uBACU,GAAG,KAAK,CAAC,IAC7B,SAAS,GAAG,CAAC;;CAQjB,CAAA;AAED,4CAA4C;AAC5C,eAAO,MAAM,IAAI;IACf,2DAA2D;iBAC9C,MAAM,KAAG,SAAS;IAK/B,6CAA6C;gDAEtC,MAAM,uBACU,GAAG,KAAK,CAAC,IAC7B,SAAS,GAAG,CAAC;qBAOC,MAAM;CACxB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,YAAY,WAAY,GAAG,YAIvC,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,eAAe,UAAW,MAAM,WAG5C,CAAA;AAED,0EAA0E;AAC1E,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,MAAM,UAYnD;AAED,wCAAwC;AACxC,eAAO,MAAM,eAAe,UAAW,MAAM,GAAG,SAAS,KAAG,SAc3D,CAAA"}

package/package.json

@@ -11,7 +11,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.0.3",
+  "version": "0.0.4",
   "engines": {
     "node": ">=18"
   },
@@ -48,7 +48,7 @@
     "tsc-alias": "^1.8.8",
     "vite": "^5.1.1",
     "vitest": "^1.2.2",
-    "@scalar/build-tooling": "0.0.3"
+    "@scalar/build-tooling": "0.0.4"
   },
   "scripts": {
     "build": "vite build && pnpm types:build && tsc-alias -p tsconfig.build.json",