@shgysk8zer0/importmap 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [v1.0.0] - 2023-05-30
+
+Initial Release

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Chris Zuber
+
+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,72 @@
+# @shgysk8zer0/importmap
+Front-End dependencies based on [`<script type="importmap">`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script/type/importmap)
+
+Intended for use with [`rollup`](https://rollupjs.org/) and [`@shgysk8zer0/rollup-import`](https://www.npmjs.com/package/@shgysk8zer0/rollup-import).
+
+- - -
+[![CodeQL](https://github.com/shgysk8zer0/importmap/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/shgysk8zer0/importmap/actions/workflows/codeql-analysis.yml)
+![Node CI](https://github.com/shgysk8zer0/importmap/workflows/Node%20CI/badge.svg)
+![Lint Code Base](https://github.com/shgysk8zer0/importmap/workflows/Lint%20Code%20Base/badge.svg)
+
+[![GitHub license](https://img.shields.io/github/license/shgysk8zer0/importmap.svg)](https://github.com/shgysk8zer0/importmap/blob/master/LICENSE)
+[![GitHub last commit](https://img.shields.io/github/last-commit/shgysk8zer0/importmap.svg)](https://github.com/shgysk8zer0/importmap/commits/master)
+[![GitHub release](https://img.shields.io/github/release/shgysk8zer0/importmap?logo=github)](https://github.com/shgysk8zer0/importmap/releases)
+[![GitHub Sponsors](https://img.shields.io/github/sponsors/shgysk8zer0?logo=github)](https://github.com/sponsors/shgysk8zer0)
+
+[![npm](https://img.shields.io/npm/v/@shgysk8zer0/importmap)](https://www.npmjs.com/package/@shgysk8zer0/importmap)
+![node-current](https://img.shields.io/node/v/@shgysk8zer0/importmap)
+![npm bundle size gzipped](https://img.shields.io/bundlephobia/minzip/@shgysk8zer0/importmap)
+[![npm](https://img.shields.io/npm/dw/@shgysk8zer0/importmap?logo=npm)](https://www.npmjs.com/package/@shgysk8zer0/importmap)
+
+[![GitHub followers](https://img.shields.io/github/followers/shgysk8zer0.svg?style=social)](https://github.com/shgysk8zer0)
+![GitHub forks](https://img.shields.io/github/forks/shgysk8zer0/importmap.svg?style=social)
+![GitHub stars](https://img.shields.io/github/stars/shgysk8zer0/importmap.svg?style=social)
+[![Twitter Follow](https://img.shields.io/twitter/follow/shgysk8zer0.svg?style=social)](https://twitter.com/shgysk8zer0)
+
+[![Donate using Liberapay](https://img.shields.io/liberapay/receives/shgysk8zer0.svg?logo=liberapay)](https://liberapay.com/shgysk8zer0/donate "Donate using Liberapay")
+- - -
+
+- [Code of Conduct](./.github/CODE_OF_CONDUCT.md)
+- [Contributing](./.github/CONTRIBUTING.md)
+<!-- - [Security Policy](./.github/SECURITY.md) -->
+
+## Installation
+
+```bash
+npm i @shgysk8zer0/importmap
+```
+
+## Example
+
+```js
+// rollup.config.js
+import { rollupImport } from '@shgysk8zer0/rollup-import';
+import { imports } from '@shgysk8zer0/importmap';
+
+export default {
+	input: 'index.js',
+	output: {
+		file: 'index.min.js',
+		format: 'iife',
+		sourcemap: true,
+	},
+	plugins: [rollupImport({ imports })],
+};
+```
+
+## For `<script type="importmap">`
+
+The module exports `getImportMapScript()`, which can be used to generate the
+required importmap `<script>`:
+
+```js
+import { getImportMapScript } from '@shgysk8zer0/importmap';
+
+getImportMapScript();
+```
+
+Which results in:
+
+```html
+<script type="importmap" integrity="sha384-...">{"imports": {}, "scope": {}}</script>
+```

package/index.cjs

@@ -0,0 +1,62 @@
+'use strict';
+
+var promises = require('node:fs/promises');
+var node_crypto = require('node:crypto');
+
+const versions = {
+	'@shgysk8zer0/kazoo': '0.0.16',
+	'@shgysk8zer0/konami': '1.0.9',
+	'@shgysk8zer0/polyfills': '0.0.7',
+	'@shgysk8zer0/components': '0.0.9',
+	'@shgysk8zer0/http-status': '1.0.1',
+	'leaflet': '1.9.3',
+	'firebase': '9.16.0',
+	'url-pattern': '8.0.2',
+	'@webcomponents/custom-elements': '1.6.0',
+	'highlight.js': '11.8.0',
+};
+
+const ENCODING = 'utf8';
+const ALGO = 'sha384';
+
+const imports = {
+	'@shgysk8zer0/kazoo/': `https://unpkg.com/@shgysk8zer0/kazoo@${versions['@shgysk8zer0/kazoo']}/`,
+	'@shgysk8zer0/konami': `https://unpkg.com/@shgysk8zer0/konami@${versions['@shgysk8zer0/konami']}/konami.js`,
+	'@shgysk8zer0/polyfills': `https://unpkg.com/@shgysk8zer0/polyfills@${versions['@shgysk8zer0/polyfills']}/all.min.js`,
+	'@shgysk8zer0/polyfills/': `https://unpkg.com/@shgysk8zer0/polyfills@${versions['@shgysk8zer0/polyfills']}/`,
+	'@shgysk8zer0/components/': `https://unpkg.com/@shgysk8zer0/components${versions['@shgysk8zer0/components']}/`,
+	'@kernvalley/components/': `https://unpkg.com/@shgysk8zer0/components${versions['@shgysk8zer0/components']}/krv/`,
+	'@shgysk8zer0/http-status': `https://unpkg.com/@shgysk8zer0/http-status@${versions['@shgysk8zer0/http-status']}/http-status.js`,
+	'leaflet': `https://unpkg.com/leaflet@[${versions.leaflet}]/dist/leaflet-src.esm.js`,
+	'firebase/': `https://www.gstatic.com/firebasejs${versions.firebase}/`,
+	'url-pattern': `https://unpkg.com/urlpattern-polyfill@${versions['url-pattern']}/index.js`,
+	'custom-elements': `https://unpkg.com/@webcomponents/custom-elements@${versions['@webcomponents/custom-elements']}/custom-elements.min.js`,
+	'highlight.js': `https://unpkg.com/@highlightjs/cdn-assets@${versions['highlight.js']}/es/highlight.min.js`,
+	'highlight.js/': `https://unpkg.com/@highlightjs/cdn-assets@${versions['lighlight.js']}/`,
+};
+
+const scope = {};
+
+async function createImportmapJSON(path = 'importmap.json', { signal, spaces = 2 } = {}) {
+	await promises.writeFile(path, JSON.stringify({ imports, scope }, null, spaces), { encoding: ENCODING, signal });
+}
+
+function getImportmapIntegrity({ algo = ALGO, spaces = 0 } = {}) {
+	const hash = node_crypto.createHash(algo);
+	hash.update(JSON.stringify({ imports, scope }, null, spaces), 'utf8');
+	return `${algo}-${hash.digest('base64')}`;
+}
+
+function getImportMapScript({ algo = ALGO, spaces = 0 } = {}) {
+	const integrity = getImportmapIntegrity({ algo, spaces });
+	const json = JSON.stringify({ imports, scope }, null, spaces);
+	return `<script type="importmap" integrity="${integrity}">${json}</script>`;
+}
+
+exports.ALGO = ALGO;
+exports.ENCODING = ENCODING;
+exports.createImportmapJSON = createImportmapJSON;
+exports.getImportMapScript = getImportMapScript;
+exports.getImportmapIntegrity = getImportmapIntegrity;
+exports.imports = imports;
+exports.scope = scope;

package/index.js

@@ -0,0 +1,40 @@
+import { writeFile } from 'node:fs/promises';
+import { versions } from './versions.js';
+import { createHash } from 'node:crypto';
+
+export const ENCODING = 'utf8';
+export const ALGO = 'sha384';
+
+export const imports = {
+	'@shgysk8zer0/kazoo/': `https://unpkg.com/@shgysk8zer0/kazoo@${versions['@shgysk8zer0/kazoo']}/`,
+	'@shgysk8zer0/konami': `https://unpkg.com/@shgysk8zer0/konami@${versions['@shgysk8zer0/konami']}/konami.js`,
+	'@shgysk8zer0/polyfills': `https://unpkg.com/@shgysk8zer0/polyfills@${versions['@shgysk8zer0/polyfills']}/all.min.js`,
+	'@shgysk8zer0/polyfills/': `https://unpkg.com/@shgysk8zer0/polyfills@${versions['@shgysk8zer0/polyfills']}/`,
+	'@shgysk8zer0/components/': `https://unpkg.com/@shgysk8zer0/components${versions['@shgysk8zer0/components']}/`,
+	'@kernvalley/components/': `https://unpkg.com/@shgysk8zer0/components${versions['@shgysk8zer0/components']}/krv/`,
+	'@shgysk8zer0/http-status': `https://unpkg.com/@shgysk8zer0/http-status@${versions['@shgysk8zer0/http-status']}/http-status.js`,
+	'leaflet': `https://unpkg.com/leaflet@[${versions.leaflet}]/dist/leaflet-src.esm.js`,
+	'firebase/': `https://www.gstatic.com/firebasejs${versions.firebase}/`,
+	'url-pattern': `https://unpkg.com/urlpattern-polyfill@${versions['url-pattern']}/index.js`,
+	'custom-elements': `https://unpkg.com/@webcomponents/custom-elements@${versions['@webcomponents/custom-elements']}/custom-elements.min.js`,
+	'highlight.js': `https://unpkg.com/@highlightjs/cdn-assets@${versions['highlight.js']}/es/highlight.min.js`,
+	'highlight.js/': `https://unpkg.com/@highlightjs/cdn-assets@${versions['lighlight.js']}/`,
+};
+
+export const scope = {};
+
+export async function createImportmapJSON(path = 'importmap.json', { signal, spaces = 2 } = {}) {
+	await writeFile(path, JSON.stringify({ imports, scope }, null, spaces), { encoding: ENCODING, signal });
+}
+
+export function getImportmapIntegrity({ algo = ALGO, spaces = 0 } = {}) {
+	const hash = createHash(algo);
+	hash.update(JSON.stringify({ imports, scope }, null, spaces), 'utf8');
+	return `${algo}-${hash.digest('base64')}`;
+}
+
+export function getImportMapScript({ algo = ALGO, spaces = 0 } = {}) {
+	const integrity = getImportmapIntegrity({ algo, spaces });
+	const json = JSON.stringify({ imports, scope }, null, spaces);
+	return `<script type="importmap" integrity="${integrity}">${json}</script>`;
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@shgysk8zer0/importmap",
+  "version": "1.0.0",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "description": "Front-End dependencies based on `<script type=\"importmap\">`",
+  "type": "module",
+  "module": "index.js",
+  "main": "index.cjs",
+  "scripts": {
+    "test": "npm run lint:js && npm run build",
+    "preversion": "npm test",
+    "prepare": "npm run build",
+    "lint:js": "eslint .",
+    "fix:js": "eslint. --fix",
+    "build": "npm run build:js",
+    "build:js": "rollup -c",
+    "create:lock": "npm i --package-lock-only",
+    "version:bump": "npm run version:bump:patch",
+    "version:bump:patch": "npm version --no-git-tag-version patch",
+    "version:bump:minor": "npm version --no-git-tag-version minor",
+    "version:bump:major": "npm version --no-git-tag-version major"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shgysk8zer0/importmap.git"
+  },
+  "author": "Chris Zuber <admin@kernvalley.us>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/shgysk8zer0/importmap/issues"
+  },
+  "homepage": "https://github.com/shgysk8zer0/importmap#readme",
+  "devDependencies": {
+    "eslint": "^8.41.0",
+    "rollup": "^3.23.0"
+  }
+}

package/versions.js

@@ -0,0 +1,12 @@
+export const versions = {
+	'@shgysk8zer0/kazoo': '0.0.16',
+	'@shgysk8zer0/konami': '1.0.9',
+	'@shgysk8zer0/polyfills': '0.0.7',
+	'@shgysk8zer0/components': '0.0.9',
+	'@shgysk8zer0/http-status': '1.0.1',
+	'leaflet': '1.9.3',
+	'firebase': '9.16.0',
+	'url-pattern': '8.0.2',
+	'@webcomponents/custom-elements': '1.6.0',
+	'highlight.js': '11.8.0',
+};