@scalar/oas-utils 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# @scalar/oas-utils
+
+## 0.0.2
+
+### Patch Changes
+
+- c254604: Add OAS utils package
+- 5cf4afa: style: replace resize observer with css container queries

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Scalar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/fetch-spec.d.ts

@@ -0,0 +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>;
+//# sourceMappingURL=fetch-spec.d.ts.map

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

@@ -0,0 +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"}

package/dist/index.d.ts

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

package/dist/index.d.ts.map

@@ -0,0 +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"}

package/dist/index.js

@@ -0,0 +1,52 @@
+import { parse, stringify } from 'yaml';
+
+const yaml = {
+  parse,
+  stringify
+};
+const loadJsonOrYaml = (value) => {
+  if (typeof value === "string") {
+    try {
+      return JSON.parse(value);
+    } catch (error) {
+      if (value.length > 0 && ["{", "["].includes(value[0])) {
+        throw error;
+      }
+      return yaml.parse(value);
+    }
+  }
+  return value;
+};
+function loadJsonOrYamlString(value) {
+  const trimmed = value.trim();
+  if (trimmed[0] !== "{")
+    return value;
+  try {
+    return JSON.stringify(JSON.parse(value), null, 2);
+  } catch {
+    return value;
+  }
+}
+
+const fetchSpecFromUrl = async (url, proxy, parseObject = false) => {
+  const response = proxy ? await fetch(proxy, {
+    method: "POST",
+    headers: {
+      "Content-Type": "application/json"
+    },
+    body: JSON.stringify({
+      method: "GET",
+      url
+    })
+  }) : await fetch(url);
+  if (response.status !== 200) {
+    const proxyWarning = proxy ? "" : "Trying to fetch the spec file without a proxy. The CORS headers must be set properly or the request will fail.";
+    console.error(
+      `[fetchSpecFromUrl] Failed to fetch the spec at ${url}. ${proxyWarning}`
+    );
+  }
+  const payload = proxy ? String((await response.json()).data) : await response.text();
+  return parseObject ? loadJsonOrYaml(payload) : loadJsonOrYamlString(payload);
+};
+
+export { fetchSpecFromUrl, loadJsonOrYaml, loadJsonOrYamlString, yaml };

package/dist/parse.d.ts

@@ -0,0 +1,11 @@
+import { parse, stringify } from 'yaml';
+import { type AnyObject } from './types';
+export declare const yaml: {
+    parse: typeof parse;
+    stringify: typeof stringify;
+};
+/** Parses a JSON or Yaml object or string into an object */
+export declare const loadJsonOrYaml: (value: string | AnyObject) => AnyObject;
+/** Validates a JSON string if provided. Otherwise returns the raw Yaml */
+export declare function loadJsonOrYamlString(value: string): string;
+//# sourceMappingURL=parse.d.ts.map

package/dist/parse.d.ts.map

@@ -0,0 +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"}

package/dist/types.d.ts

@@ -0,0 +1,3 @@
+export type AnyObject = Record<string, any>;
+export type AnyStringOrObject = string | Record<string, any>;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAE3C,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@scalar/oas-utils",
+  "description": "Open API spec and Yaml handling utilities",
+  "license": "MIT",
+  "author": "Scalar (https://github.com/scalar)",
+  "homepage": "https://github.com/scalar/scalar",
+  "bugs": "https://github.com/scalar/scalar/issues/new/choose",
+  "keywords": [
+    "oas",
+    "fetching",
+    "specification",
+    "yaml"
+  ],
+  "version": "0.0.2",
+  "engines": {
+    "node": ">=20"
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./css/*.css": {
+      "import": "./dist/css/*.css",
+      "require": "./dist/css/*.css"
+    },
+    "./*.css": {
+      "import": "./dist/*.css",
+      "require": "./dist/*.css"
+    }
+  },
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
+  "module": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/scalar/scalar.git",
+    "directory": "packages/oas-utils"
+  },
+  "dependencies": {
+    "yaml": "^2.4.1"
+  },
+  "devDependencies": {
+    "tsc-alias": "^1.8.8",
+    "vite": "^5.1.1",
+    "vitest": "^1.2.2",
+    "@scalar/build-tooling": "0.0.2"
+  },
+  "scripts": {
+    "build": "vite build && pnpm types:build && tsc-alias -p tsconfig.build.json",
+    "dev": "vite",
+    "lint:check": "eslint .",
+    "lint:fix": "eslint .  --fix",
+    "preview": "vite preview",
+    "test": "vitest",
+    "test:unit": "vitest .",
+    "types:build": "tsc -p tsconfig.build.json",
+    "types:check": "tsc --noEmit --skipLibCheck --composite false"
+  }
+}