@scalar/core 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @scalar/core
+
+## 0.1.0
+
+### Minor Changes
+
+- bab7990: init :)
+
+### Patch Changes
+
+- Updated dependencies [bab7990]
+- Updated dependencies [2c621d4]
+  - @scalar/types@0.0.39

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present 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/README.md

@@ -0,0 +1,35 @@
+# Scalar Core
+
+[![Version](https://img.shields.io/npm/v/%40scalar/core)](https://www.npmjs.com/package/@scalar/core)
+[![Downloads](https://img.shields.io/npm/dm/%40scalar/core)](https://www.npmjs.com/package/@scalar/core)
+[![License](https://img.shields.io/npm/l/%40scalar%2Fcore)](https://www.npmjs.com/package/@scalar/core)
+[![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.gg/scalar)
+
+Shared libraries for our packages, specifically [@scalar/api-reference](https://npmjs.com/@scalar/api-reference) and [@scalar/api-client](https://www.npmjs.com/package/@scalar/api-client).
+
+
+## Installation
+
+```bash
+npm install @scalar/core
+```
+
+## Usage
+
+```ts
+import { getHtmlDocument } from '@scalar/core/lib/html-rendering'
+
+const html = getHtmlDocument({
+  spec: {
+    url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.json',
+  },
+})
+```
+
+## Community
+
+We are API nerds. You too? Let’s chat on Discord: <https://discord.gg/scalar>
+
+## License
+
+The source code in this repository is licensed under [MIT](https://github.com/scalar/scalar/blob/main/LICENSE).

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# 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":""}

package/dist/index.js

@@ -0,0 +1 @@
+

package/dist/libs/html-rendering/index.d.ts

@@ -0,0 +1,22 @@
+import { type ApiReferenceConfiguration, type HtmlRenderingConfiguration } from '@scalar/types/api-reference';
+export type { HtmlRenderingConfiguration };
+/**
+ * The HTML document to render the Scalar API reference.
+ *
+ * We must check the passed in configuration and not the parsedConfig for the theme as the parsedConfig will have it
+ * defaulted to 'default'
+ */
+export declare const getHtmlDocument: (configuration: Partial<HtmlRenderingConfiguration>, customTheme?: string) => string;
+/**
+ * The script tags to load the @scalar/api-reference package from the CDN.
+ */
+export declare function getScriptTags(configuration: ApiReferenceConfiguration, cdn: string): string;
+/**
+ * The configuration to pass to the @scalar/api-reference package.
+ */
+export declare const getConfiguration: (givenConfiguration: ApiReferenceConfiguration) => string;
+/**
+ * The content to pass to the @scalar/api-reference package as the <script> tag content.
+ */
+export declare const getScriptTagContent: (configuration: ApiReferenceConfiguration) => string;
+//# sourceMappingURL=index.d.ts.map

package/dist/libs/html-rendering/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/libs/html-rendering/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAGhC,MAAM,6BAA6B,CAAA;AAGpC,YAAY,EAAE,0BAA0B,EAAE,CAAA;AAE1C;;;;;GAKG;AACH,eAAO,MAAM,eAAe,kBAAmB,OAAO,CAAC,0BAA0B,CAAC,iCAwBjF,CAAA;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,aAAa,EAAE,yBAAyB,EAAE,GAAG,EAAE,MAAM,UAQlF;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,uBAAwB,yBAAyB,WAa7E,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,kBAAmB,yBAAyB,WAKpE,CAAA"}

package/dist/libs/html-rendering/index.js

@@ -0,0 +1,69 @@
+import { htmlRenderingConfigurationSchema, apiReferenceConfigurationSchema } from '@scalar/types/api-reference';
+
+/**
+ * The HTML document to render the Scalar API reference.
+ *
+ * We must check the passed in configuration and not the parsedConfig for the theme as the parsedConfig will have it
+ * defaulted to 'default'
+ */
+const getHtmlDocument = (configuration, customTheme = '') => {
+    const { cdn, pageTitle, ...rest } = configuration;
+    const parsedHtmlOptions = htmlRenderingConfigurationSchema.parse({ cdn, pageTitle, customTheme });
+    const parsedConfig = apiReferenceConfigurationSchema.parse(rest);
+    return `
+    <!DOCTYPE html>
+    <html>
+      <head>
+        <title>${parsedHtmlOptions.pageTitle}</title>
+        <meta charset="utf-8" />
+        <meta
+          name="viewport"
+          content="width=device-width, initial-scale=1" />
+        <style>
+          ${configuration.theme ? '' : customTheme}
+        </style>
+      </head>
+      <body>
+        ${getScriptTags(parsedConfig, parsedHtmlOptions.cdn)}
+      </body>
+    </html>
+  `;
+};
+/**
+ * The script tags to load the @scalar/api-reference package from the CDN.
+ */
+function getScriptTags(configuration, cdn) {
+    return `
+      <script
+        id="api-reference"
+        type="application/json"
+        data-configuration="${getConfiguration(configuration)}">${getScriptTagContent(configuration)}</script>
+        <script src="${cdn}"></script>
+    `;
+}
+/**
+ * The configuration to pass to the @scalar/api-reference package.
+ */
+const getConfiguration = (givenConfiguration) => {
+    // Clone before mutating
+    const configuration = {
+        ...givenConfiguration,
+    };
+    if (!configuration.spec?.url) {
+        delete configuration.spec;
+    }
+    else if (configuration.spec?.content) {
+        delete configuration.spec?.content;
+    }
+    return JSON.stringify(configuration).split('"').join('&quot;');
+};
+/**
+ * The content to pass to the @scalar/api-reference package as the <script> tag content.
+ */
+const getScriptTagContent = (configuration) => configuration.spec?.content
+    ? typeof configuration.spec?.content === 'function'
+        ? JSON.stringify(configuration.spec?.content())
+        : JSON.stringify(configuration.spec?.content)
+    : '';
+
+export { getConfiguration, getHtmlDocument, getScriptTagContent, getScriptTags };

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@scalar/core",
+  "description": "Shared libraries for our packages",
+  "license": "MIT",
+  "author": "Scalar (https://github.com/scalar)",
+  "homepage": "https://github.com/scalar/scalar",
+  "bugs": "https://github.com/scalar/scalar/issues/new/choose",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/scalar/scalar.git",
+    "directory": "packages/core"
+  },
+  "keywords": [],
+  "version": "0.1.0",
+  "engines": {
+    "node": ">=18"
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./libs/html-rendering": {
+      "import": "./dist/libs/html-rendering/index.js",
+      "types": "./dist/libs/html-rendering/index.d.ts",
+      "default": "./dist/libs/html-rendering/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
+  "module": "dist/index.js",
+  "dependencies": {
+    "@scalar/types": "0.0.39"
+  },
+  "devDependencies": {
+    "vite": "^5.4.10",
+    "@scalar/build-tooling": "0.1.16"
+  },
+  "scripts": {
+    "build": "scalar-build-rollup",
+    "lint:check": "scalar-lint-check",
+    "lint:fix": "scalar-lint-fix",
+    "test": "vitest",
+    "types:build": "scalar-types-build",
+    "types:check": "scalar-types-check"
+  }
+}