npm - vite-plugin-cogs-sdk - Versions diffs - 2.10.0 - Mend

vite-plugin-cogs-sdk 2.10.0

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 (6) hide show

package/README.md ADDED Viewed

@@ -0,0 +1,30 @@
+# `vite-plugin-cogs-sdk`
+A Vite plugin to easily setup your project to be a COGS plugin or custom content. It:
+- In development mode creates an index.html which redirects to the Vite dev server with hot reloading to make development easier.
+- In development and production mode ensures that the `src/cogs-plugin-manifest.js` file is copied into the correct location.
+- Automatically set the dev server to be accessible over the network so Media Masters can access it (can be disabled with the `noServerExpose` option).
+To use the plugin you need to have a file at `src/cogs-plugin-manifest.js` in CommonJS format.
+## Installation
+Install `vite-plugin-cogs-sdk` as a development dependency using your package manager of choice:
+```bash
+npm install --save-dev vite-plugin-cogs-sdk
+pnpm add --save-dev vite-plugin-cogs-sdk
+yarn add --dev vite-plugin-cogs-sdk
+```
+You can then add the plugin to your `vite.config.js` file, adding it to the `plugins` array if you already have others:
+```javascript
+import { defineConfig } from 'vite';
+import cogsSdkPlugin from 'vite-plugin-cogs-sdk';
+export default defineConfig({
+  plugins: [cogsSdkPlugin()],
+});
+```

package/dist/index.cjs ADDED Viewed

@@ -0,0 +1,167 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  cogsSdkPlugin: () => cogsSdkPlugin,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var import_node_fs = require("fs");
+var import_promises = require("fs/promises");
+var import_node_path = require("path");
+var PLUGIN_NAME = "cogs-sdk";
+var devModeIndexHtmlContent = (serverUrl) => {
+  const serverUrlNoTrailingSlash = serverUrl.endsWith("/") ? serverUrl.slice(0, -1) : serverUrl;
+  return `<html>
+  <head>
+    <title>Redirecting...</title>
+    <script>
+      document.addEventListener('DOMContentLoaded', () => {
+        const parsedUrl = new URL(document.location.href);
+        const pathParams = new URLSearchParams(parsedUrl.searchParams);
+        document.location.href = \`${serverUrlNoTrailingSlash}\${parsedUrl.pathname}?\${pathParams.toString()}\`;
+      });
+    </script>
+  </head>
+  <body></body>
+</html>`;
+};
+var INDEX_HTML_POLYFILL = `  <!-- COGS SDK Polyfill for global -->
+<script>
+if (global === undefined) {
+var global = window;
+}
+if (module === undefined) {
+var module = {};
+}
+</script>
+</head>`;
+var cogsSdkPlugin = (options = {}) => {
+  let config;
+  let serverUrl;
+  let manifestFilename, manifestFilePath;
+  const basePath = process.cwd();
+  if (options.manifestFilePath) {
+    manifestFilename = (0, import_node_path.basename)(options.manifestFilePath);
+    manifestFilePath = (0, import_node_path.resolve)(basePath, options.manifestFilePath);
+  } else {
+    manifestFilename = "cogs-plugin-manifest.js";
+    manifestFilePath = (0, import_node_path.join)(basePath, "src", manifestFilename);
+  }
+  if (!(0, import_node_fs.existsSync)(manifestFilePath)) {
+    throw new Error(`COGS Manifest file not found at ${manifestFilePath}`);
+  }
+  const generateDevModeOutput = async () => {
+    const outDirPath = (0, import_node_path.join)(basePath, config.build.outDir);
+    await (0, import_promises.rm)(outDirPath, { force: true, recursive: true });
+    await (0, import_promises.mkdir)(outDirPath);
+    await (0, import_promises.cp)(manifestFilePath, (0, import_node_path.join)(outDirPath, manifestFilename));
+    const publicPath = (0, import_node_path.join)(basePath, "public");
+    if ((0, import_node_fs.existsSync)(publicPath)) {
+      await (0, import_promises.cp)(publicPath, outDirPath, { recursive: true });
+    }
+    const indexHtmlContent = devModeIndexHtmlContent(serverUrl);
+    await (0, import_promises.writeFile)((0, import_node_path.join)(outDirPath, "index.html"), indexHtmlContent);
+  };
+  return {
+    name: PLUGIN_NAME,
+    /**
+     * Make sure the server is exposed to all the network so it "just works" in dev mode
+     */
+    config() {
+      if (options.noServerExpose) {
+        return {};
+      } else {
+        return { server: { host: "0.0.0.0" } };
+      }
+    },
+    /**
+     * Store the resolved config so we can access it elsewhere in the plugin code
+     */
+    configResolved(resolvedConfig) {
+      config = resolvedConfig;
+    },
+    /**
+     * When the server is configured we add a listener to get the real port value. This is because it might not match the one in the config if
+     * that one was not available
+     */
+    configureServer(server) {
+      server.httpServer?.on("listening", () => {
+        setImmediate(() => {
+          if (server.resolvedUrls?.network && server.resolvedUrls.network.length > 0) {
+            serverUrl = server.resolvedUrls.network[0];
+          } else if (server.resolvedUrls?.local && server.resolvedUrls.local.length > 0) {
+            serverUrl = server.resolvedUrls.local[0];
+          } else {
+            const address = server.httpServer?.address();
+            if (address && typeof address === "object") {
+              serverUrl = `http://localhost:${address.port}/`;
+            }
+          }
+          generateDevModeOutput();
+        });
+      });
+    },
+    /**
+     * When the build starts we detect if we're in "serve" mode (dev mode) and start a dev build output
+     */
+    async buildStart() {
+      if (config.command === "serve") {
+        serverUrl = `http://localhost:${config.server.port}/`;
+        this.addWatchFile(manifestFilePath);
+        await generateDevModeOutput();
+      }
+    },
+    /**
+     * When the manifest file changes in dev mode, we need to rebuild the output.
+     * This is only used in build mode.
+     */
+    async watchChange(path) {
+      if (path === manifestFilePath) {
+        await generateDevModeOutput();
+      }
+    },
+    /**
+     * We tell Vite to include the manifest file in the build output as an asset.
+     * This is only called in "build" mode when we're bundling for production
+     */
+    async generateBundle() {
+      const source = await (0, import_promises.readFile)(manifestFilePath);
+      this.emitFile({
+        fileName: manifestFilename,
+        source,
+        type: "asset"
+      });
+    },
+    /**
+     * We need to add a polyfill for `global` and `module` in the HTML file for the COGS SDK to correctly load
+     * It is used in both build and serve mode
+     */
+    transformIndexHtml(html) {
+      return html.replace(/<\/head>/, INDEX_HTML_POLYFILL);
+    }
+  };
+};
+var index_default = cogsSdkPlugin;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  cogsSdkPlugin
+});

package/dist/index.d.cts ADDED Viewed

@@ -0,0 +1,15 @@
+import { Plugin } from 'vite';
+interface CogsPluginOptions {
+    /**
+     * Set a custom path to the COGS plugin manifest file
+     */
+    manifestFilePath?: string;
+    /**
+     * Set the `true` to not expose the dev server on all networks and only allow connections over `localhost`
+     */
+    noServerExpose?: boolean;
+}
+declare const cogsSdkPlugin: (options?: CogsPluginOptions) => Plugin;
+export { type CogsPluginOptions, cogsSdkPlugin, cogsSdkPlugin as default };

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,15 @@
+import { Plugin } from 'vite';
+interface CogsPluginOptions {
+    /**
+     * Set a custom path to the COGS plugin manifest file
+     */
+    manifestFilePath?: string;
+    /**
+     * Set the `true` to not expose the dev server on all networks and only allow connections over `localhost`
+     */
+    noServerExpose?: boolean;
+}
+declare const cogsSdkPlugin: (options?: CogsPluginOptions) => Plugin;
+export { type CogsPluginOptions, cogsSdkPlugin, cogsSdkPlugin as default };

package/dist/index.js ADDED Viewed

@@ -0,0 +1,142 @@
+// src/index.ts
+import { existsSync } from "fs";
+import { cp, mkdir, readFile, rm, writeFile } from "fs/promises";
+import { basename, join, resolve } from "path";
+var PLUGIN_NAME = "cogs-sdk";
+var devModeIndexHtmlContent = (serverUrl) => {
+  const serverUrlNoTrailingSlash = serverUrl.endsWith("/") ? serverUrl.slice(0, -1) : serverUrl;
+  return `<html>
+  <head>
+    <title>Redirecting...</title>
+    <script>
+      document.addEventListener('DOMContentLoaded', () => {
+        const parsedUrl = new URL(document.location.href);
+        const pathParams = new URLSearchParams(parsedUrl.searchParams);
+        document.location.href = \`${serverUrlNoTrailingSlash}\${parsedUrl.pathname}?\${pathParams.toString()}\`;
+      });
+    </script>
+  </head>
+  <body></body>
+</html>`;
+};
+var INDEX_HTML_POLYFILL = `  <!-- COGS SDK Polyfill for global -->
+<script>
+if (global === undefined) {
+var global = window;
+}
+if (module === undefined) {
+var module = {};
+}
+</script>
+</head>`;
+var cogsSdkPlugin = (options = {}) => {
+  let config;
+  let serverUrl;
+  let manifestFilename, manifestFilePath;
+  const basePath = process.cwd();
+  if (options.manifestFilePath) {
+    manifestFilename = basename(options.manifestFilePath);
+    manifestFilePath = resolve(basePath, options.manifestFilePath);
+  } else {
+    manifestFilename = "cogs-plugin-manifest.js";
+    manifestFilePath = join(basePath, "src", manifestFilename);
+  }
+  if (!existsSync(manifestFilePath)) {
+    throw new Error(`COGS Manifest file not found at ${manifestFilePath}`);
+  }
+  const generateDevModeOutput = async () => {
+    const outDirPath = join(basePath, config.build.outDir);
+    await rm(outDirPath, { force: true, recursive: true });
+    await mkdir(outDirPath);
+    await cp(manifestFilePath, join(outDirPath, manifestFilename));
+    const publicPath = join(basePath, "public");
+    if (existsSync(publicPath)) {
+      await cp(publicPath, outDirPath, { recursive: true });
+    }
+    const indexHtmlContent = devModeIndexHtmlContent(serverUrl);
+    await writeFile(join(outDirPath, "index.html"), indexHtmlContent);
+  };
+  return {
+    name: PLUGIN_NAME,
+    /**
+     * Make sure the server is exposed to all the network so it "just works" in dev mode
+     */
+    config() {
+      if (options.noServerExpose) {
+        return {};
+      } else {
+        return { server: { host: "0.0.0.0" } };
+      }
+    },
+    /**
+     * Store the resolved config so we can access it elsewhere in the plugin code
+     */
+    configResolved(resolvedConfig) {
+      config = resolvedConfig;
+    },
+    /**
+     * When the server is configured we add a listener to get the real port value. This is because it might not match the one in the config if
+     * that one was not available
+     */
+    configureServer(server) {
+      server.httpServer?.on("listening", () => {
+        setImmediate(() => {
+          if (server.resolvedUrls?.network && server.resolvedUrls.network.length > 0) {
+            serverUrl = server.resolvedUrls.network[0];
+          } else if (server.resolvedUrls?.local && server.resolvedUrls.local.length > 0) {
+            serverUrl = server.resolvedUrls.local[0];
+          } else {
+            const address = server.httpServer?.address();
+            if (address && typeof address === "object") {
+              serverUrl = `http://localhost:${address.port}/`;
+            }
+          }
+          generateDevModeOutput();
+        });
+      });
+    },
+    /**
+     * When the build starts we detect if we're in "serve" mode (dev mode) and start a dev build output
+     */
+    async buildStart() {
+      if (config.command === "serve") {
+        serverUrl = `http://localhost:${config.server.port}/`;
+        this.addWatchFile(manifestFilePath);
+        await generateDevModeOutput();
+      }
+    },
+    /**
+     * When the manifest file changes in dev mode, we need to rebuild the output.
+     * This is only used in build mode.
+     */
+    async watchChange(path) {
+      if (path === manifestFilePath) {
+        await generateDevModeOutput();
+      }
+    },
+    /**
+     * We tell Vite to include the manifest file in the build output as an asset.
+     * This is only called in "build" mode when we're bundling for production
+     */
+    async generateBundle() {
+      const source = await readFile(manifestFilePath);
+      this.emitFile({
+        fileName: manifestFilename,
+        source,
+        type: "asset"
+      });
+    },
+    /**
+     * We need to add a polyfill for `global` and `module` in the HTML file for the COGS SDK to correctly load
+     * It is used in both build and serve mode
+     */
+    transformIndexHtml(html) {
+      return html.replace(/<\/head>/, INDEX_HTML_POLYFILL);
+    }
+  };
+};
+var index_default = cogsSdkPlugin;
+export {
+  cogsSdkPlugin,
+  index_default as default
+};

package/package.json ADDED Viewed

@@ -0,0 +1,56 @@
+{
+  "name": "vite-plugin-cogs-sdk",
+  "description": "A Vite plugin to easily setup your project to be a COGS plugin or custom content",
+  "author": "Clockwork Dog <info@clockwork.dog>",
+  "homepage": "https://github.com/clockwork-dog/cogs-sdk/tree/main/packages/vite-plugin",
+  "version": "2.10.0",
+  "keywords": [
+    "cogs",
+    "vite-plugin"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/clockwork-dog/cogs-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/clockwork-dog/cogs-sdk/issues"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "scripts": {
+    "types": "tsc --noEmit",
+    "lint": "eslint",
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "release": "yarn npm publish --access public"
+  },
+  "peerDependencies": {
+    "vite": ">=6.0.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.30.1",
+    "eslint": "^9.30.1",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-plugin-prettier": "^5.5.1",
+    "globals": "^16.3.0",
+    "prettier": "^3.6.2",
+    "tsup": "^8.5.0",
+    "typescript": "~5.8.3",
+    "typescript-eslint": "^8.35.1",
+    "vite": "^6.0.0"
+  }
+}