@open-xchange/vite-plugin-replace-pkg 0.0.2 → 0.0.4

package/CHANGELOG.md

@@ -1,9 +1,19 @@
 # Changelog
 
-## [0.0.2] - 2024-08-07
+## `0.0.4` – 2024-Oct-21
+
+- chore: fixed repository URL in package.json
+
+## `0.0.3` – 2024-Aug-09
+
+- added: options `prepend`, `append`, `exportGlobal`
+- changed: made option `replace.token` optional (defaults to `GITLAB_TOKEN` env var)
+- fixed: inactive log level "info"
+
+## `0.0.2` – 2024-Aug-07
 
 - changed: GitLab API token as plugin parameter instead of env var
 
-## [0.0.1] - 2024-08-07
+## `0.0.1` – 2024-Aug-07
 
 - initial release

package/README.md

@@ -54,14 +54,14 @@ export default defineConfig(() => {
 
 ### Options
 
-#### `package`
+#### Option `package`
 
 - Type: `string`
 - _required_
 
 The name of the external package to be replaced, as appearing in `import` statements in source code.
 
-#### `replace`
+#### Option `replace`
 
 - Type: _various (see below)_
 - _required_
@@ -105,10 +105,10 @@ The location of the source file to resolve the module imports with. There are di
    | Name | Type | Default | Description |
    | - | - | - | - |
    | `server` | `string` | _required_ | The URL of the GitLab server to be used for downloading the source file. |
-   | `token` | `string\|undefined` | _required_ | A valid GitLab API access token. If the token does not exist or is empty, downloading the source wile will be skipped silently. |
    | `project` | `string\|number` | _required_ | Name or numeric identifier of the GitLab project. The project name may contain slashes (e.g. `"my-group/my-project"`) which will be encoded internally. |
    | `path` | `string` | _required_ | Path to the source file to be downloaded. Slashes in the path will be encoded internally. |
    | `ref` | `string` | `HEAD` | The name of a branch or tag, or a commit ID. Slashes in branch names will be encoded internally. |
+   | `token` | `string` | environment variable `GITLAB_TOKEN` | A valid GitLab API access token. If omitted, uses the contents of the environment variable `GITLAB_TOKEN`. If the resulting token is empty, downloading the source file will be skipped silently. |
 
    Example:
 
@@ -153,7 +153,7 @@ The location of the source file to resolve the module imports with. There are di
    })
    ```
 
-#### `transform`
+#### Option `transform`
 
 - Type: `(source: string) => string | string[] | Promise<string | string[]>`
 - _optional_
@@ -173,12 +173,113 @@ export default defineConfig(() => {
     replacePlugin({
       package: "external-package"
       replace: "https://example.org/path/to/index.js",
-      transform: source => ["/* replaced file header */", source],
+      transform: source => source.replaceAll(/* ... */)
     }),
   ],
 })
 ```
 
+#### Option `prepend`
+
+- Type: `string | string[]`
+- _optional_
+
+Inserts arbitrary source code to the beginning of the replacement module. An array of strings will be concatenated with newline characters.
+
+This option will be applied after source code transformation (option `transform`).
+
+Example:
+
+```ts
+// vite.config.ts
+
+import { defineConfig } from "vite" // or "vitest/config"
+import replacePlugin from "@open-xchange/vite-plugin-replace-pkg"
+
+export default defineConfig(() => {
+  plugins: [
+    replacePlugin({
+      package: "external-package"
+      replace: "https://example.org/path/to/index.js",
+      prepend: [/* ... */],
+    }),
+  ],
+})
+```
+
+#### Option `append`
+
+- Type: `string | string[]`
+- _optional_
+
+Inserts arbitrary source code to the end of the replacement module. An array of strings will be concatenated with newline characters.
+
+This option will be applied after source code transformation (option `transform`).
+
+Example:
+
+```ts
+// vite.config.ts
+
+import { defineConfig } from "vite" // or "vitest/config"
+import replacePlugin from "@open-xchange/vite-plugin-replace-pkg"
+
+export default defineConfig(() => {
+  plugins: [
+    replacePlugin({
+      package: "external-package"
+      replace: "https://example.org/path/to/index.js",
+      append: [/* ... */],
+    }),
+  ],
+})
+```
+
+#### Option `exportGlobal`
+
+- Type: `string`
+- _optional_
+
+Specifies the name of a global variable that will be defined by the replacement module. This plugin will append source code to the replacement module that will delete the variable from global scope, and will export it as the default export instead.
+
+This option will be applied after source code transformation (option `transform`).
+
+Example:
+
+```ts
+// vite.config.ts
+
+import { defineConfig } from "vite" // or "vitest/config"
+import replacePlugin from "@open-xchange/vite-plugin-replace-pkg"
+
+export default defineConfig(() => {
+  plugins: [
+    replacePlugin({
+      package: "external-package"
+      replace: "https://example.org/path/to/index.js",
+      exportGlobal: "TheModule",
+    }),
+  ],
+})
+```
+
+is equivalent to
+
+```ts
+// vite.config.ts
+
+// ...
+    replacePlugin({
+      package: "external-package"
+      replace: "https://example.org/path/to/index.js",
+      append: [
+        "const __contents = globalThis.TheModule",
+        "delete globalThis.TheModule",
+        "export default __contents",
+      ],
+    }),
+```
+
 ### Logging
 
 By default, warning messages and error messages will be logged to the shell. The environment variable `PLUGIN_REPLACE_PKG_LOGLEVEL` can be used to change the log level of this plugin. Possible values are `info`, `warn`, `error`, and `silent`.

package/dist/index.d.ts

@@ -22,11 +22,6 @@ export interface VitePluginReplacePkg_GitLabFile {
      * The URL of the GitLab server to be used for downloading the source file.
      */
     server: string;
-    /**
-     * A valid GitLab API access token. If the token does not exist or is an
-     * empty string, downloading the source wile will be skipped silently.
-     */
-    token: string | undefined;
     /**
      * Name or identifier of the GitLab project (repository). The project name
      * may contain slashes (e.g. "my-group/my-project") which will be encoded
@@ -43,6 +38,12 @@ export interface VitePluginReplacePkg_GitLabFile {
      * will be encoded internally. Default value is "HEAD".
      */
     ref?: string;
+    /**
+     * A valid GitLab API access token. If omitted, uses the contents of the
+     * environment variable `GITLAB_TOKEN`. If the resulting token is empty,
+     * downloading the source file will be skipped silently.
+     */
+    token?: string;
 }
 /**
  * A custom callback function to fetch the replacement source code for an
@@ -75,6 +76,28 @@ export interface VitePluginReplacePkgOptions {
      *  multiple source lines.
      */
     transform?: (source: string) => string | string[] | Promise<string | string[]>;
+    /**
+     * Inserts arbitrary source code to the beginning of the replacement
+     * module. An array of strings will be concatenated with newline
+     * characters. This option will be applied after source code transformation
+     * (option `transform`).
+     */
+    prepend?: string | string[];
+    /**
+     * Inserts arbitrary source code to the end of the replacement module. An
+     * array of strings will be concatenated with newline characters. This
+     * option will be applied after source code transformation (option
+     * `transform`).
+     */
+    append?: string | string[];
+    /**
+     * Specifies the name of a global variable that will be defined by the
+     * replacement module. This plugin will append source code to the
+     * replacement module that will delete the variable from global scope, and
+     * will export it as the default export instead. This option will be
+     * applied after source code transformation (option `transform`).
+     */
+    exportGlobal?: string;
 }
 export declare const PROJECT_NAME = "@open-xchange/vite-plugin-replace-pkg";
 /**

package/dist/index.js

@@ -2,48 +2,20 @@ import { onceFn } from "@open-xchange/vite-helper/utils";
 import { Logger } from "@open-xchange/vite-helper/logger";
 // constants ==================================================================
 export const PROJECT_NAME = "@open-xchange/vite-plugin-replace-pkg";
-const logger = new Logger({
-    loggerPrefix: "pkg",
-    logLevelEnvVar: "PLUGIN_REPLACE_PKG_LOGLEVEL",
-});
 // functions ==================================================================
-const resolveFetchOptions = (options) => {
-    const { replace } = options;
-    // callback function
-    if (typeof replace === "function") {
-        return;
-    }
-    // plain string
-    if (typeof replace === "string") {
-        return replace ? { url: replace } : undefined;
-    }
-    // `RequestInit` object
-    if ("url" in replace) {
-        return replace.url ? replace : undefined;
-    }
-    // `GitLabFile` object
-    if ("project" in replace) {
-        // GitLab API token
-        if (!replace.token) {
-            logger.warn("missing GitLab API token");
-            return;
-        }
-        // build the file URL for the GitLab API
-        // https://docs.gitlab.com/ee/api/repository_files.html#get-raw-file-from-repository
-        const project = encodeURIComponent(replace.project);
-        const path = encodeURIComponent(replace.path);
-        const url = `${replace.server}/api/v4/projects/${project}/repository/files/${path}/raw`;
-        // additional settings (query, headers, etc.)
-        const query = { lfs: true };
-        if (replace.ref) {
-            query.ref = replace.ref;
-        }
-        const headers = { "PRIVATE-TOKEN": replace.token };
-        return { url, headers, query };
-    }
-    logger.error("invalid configuration for package %f", options.package);
-    return undefined;
-};
+/**
+ * Joins a string array with newline characters, ensures trailing newline.
+ *
+ * @param contents
+ *  The string contents to be flattened.
+ *
+ * @returns
+ *  The flattened contents.
+ */
+function flatten(contents) {
+    const result = Array.isArray(contents) ? contents.join("\n") : contents;
+    return result.endsWith("\n") ? result : (result + "\n");
+}
 // plugin =====================================================================
 /**
  * A plugin for Vite to replace a specific external package with an arbitrary
@@ -60,12 +32,58 @@ const resolveFetchOptions = (options) => {
 export default function vitePluginReplacePkg(options) {
     const pkgName = options.package;
     const moduleId = "\0" + PROJECT_NAME + "/" + pkgName;
+    // must not be instantiated globally (needs initialized environment variables)
+    const logger = new Logger({
+        loggerPrefix: "pkg",
+        logLevelEnvVar: "PLUGIN_REPLACE_PKG_LOGLEVEL",
+    });
+    // resolves the URL of the replacement module to be fetched
+    const resolveFetchOptions = () => {
+        logger.info("resolving replacement module for %f", pkgName);
+        const { replace } = options;
+        // callback function
+        if (typeof replace === "function") {
+            return;
+        }
+        // plain string
+        if (typeof replace === "string") {
+            return replace ? { url: replace } : undefined;
+        }
+        // `RequestInit` object
+        if ("url" in replace) {
+            return replace.url ? replace : undefined;
+        }
+        // `GitLabFile` object
+        if ("project" in replace) {
+            // GitLab API token
+            const token = replace.token ?? process.env.GITLAB_TOKEN;
+            if (!token) {
+                logger.warn("missing GitLab API token");
+                return;
+            }
+            // build the file URL for the GitLab API
+            // https://docs.gitlab.com/ee/api/repository_files.html#get-raw-file-from-repository
+            const project = encodeURIComponent(replace.project);
+            const path = encodeURIComponent(replace.path);
+            const url = `${replace.server}/api/v4/projects/${project}/repository/files/${path}/raw`;
+            // additional settings (query, headers, etc.)
+            const query = { lfs: true };
+            if (replace.ref) {
+                query.ref = replace.ref;
+            }
+            const headers = { "PRIVATE-TOKEN": token };
+            return { url, headers, query };
+        }
+        logger.error("invalid configuration for package %f", pkgName);
+        return undefined;
+    };
+    // fetches the replacement module ("onceFn" wrapped to be called from "resolveId" and "load")
     const fetchSourceFile = onceFn(async () => {
         try {
             if (typeof options.replace === "function") {
                 return await options.replace(pkgName);
             }
-            const fetchOptions = resolveFetchOptions(options);
+            const fetchOptions = resolveFetchOptions();
             if (fetchOptions) {
                 const query = Object.entries(fetchOptions.query ?? {}).map(entry => entry.map(encodeURIComponent).join("=")).join("&");
                 const url = fetchOptions.url + (query ? `?${query}` : "");
@@ -94,6 +112,7 @@ export default function vitePluginReplacePkg(options) {
                 if (source !== pkgName) {
                     return;
                 }
+                // try to fetch source file, skip "load" hook if not available
                 const contents = await fetchSourceFile();
                 return contents ? moduleId : undefined;
             },
@@ -102,9 +121,25 @@ export default function vitePluginReplacePkg(options) {
             if (id !== moduleId) {
                 return;
             }
-            const contents = await fetchSourceFile();
-            const transformed = options.transform ? await options.transform(contents) : contents;
-            return Array.isArray(transformed) ? transformed.join("\n") : transformed;
+            const { transform, prepend, append, exportGlobal } = options;
+            let contents = flatten(await fetchSourceFile());
+            if (transform) {
+                contents = flatten(await transform(contents));
+            }
+            if (prepend) {
+                contents = flatten(prepend) + contents;
+            }
+            if (append) {
+                contents += flatten(append);
+            }
+            if (exportGlobal) {
+                contents += flatten([
+                    `const __contents = globalThis["${exportGlobal}"];`,
+                    `delete globalThis["${exportGlobal}"];`,
+                    "export default __contents;",
+                ]);
+            }
+            return contents;
         },
     };
 }

package/package.json

@@ -1,41 +1,39 @@
 {
-    "name": "@open-xchange/vite-plugin-replace-pkg",
-    "version": "0.0.2",
-    "description": "Vite plugin replacing a specific external package with an arbitrary source code module",
-    "repository": {
-        "url": "https://gitlab.open-xchange.com/fspd/npm-packages/vite-plugin-replace-pkg"
-    },
-    "license": "MIT",
-    "engines": {
-        "node": "18.18.0 || ^20.9.0 || >=21.1.0"
-    },
-    "packageManager": "yarn@4.4.0",
-    "type": "module",
-    "exports": "./dist/index.js",
-    "scripts": {
-        "prepare": "husky",
-        "prepack": "yarn build && yarn lint",
-        "build": "npx --yes rimraf dist && tsc",
-        "lint": "eslint ."
-    },
-    "lint-staged": {
-        "*.{js,ts,json}": "yarn lint"
-    },
-    "dependencies": {
-        "@open-xchange/vite-helper": "0.0.3"
-    },
-    "devDependencies": {
-        "@open-xchange/linter-presets": "0.4.2",
-        "@types/node": "22.1.0",
-        "eslint": "9.8.0",
-        "husky": "9.1.4",
-        "typescript": "5.5.4",
-        "vite": "5.3.5"
-    },
-    "peerDependencies": {
-        "vite": "^5.3"
-    },
-    "resolutions": {
-        "semver": "^7.6.2"
-    }
-}
+  "name": "@open-xchange/vite-plugin-replace-pkg",
+  "version": "0.0.4",
+  "description": "Vite plugin replacing a specific external package with an arbitrary source code module",
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.open-xchange.com/fspd/commons/plugins/-/tree/main/packages/vite-plugin-replace-pkg"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": "18.18.0 || ^20.9.0 || >=21.1.0"
+  },
+  "packageManager": "yarn@4.5.0",
+  "type": "module",
+  "exports": "./dist/index.js",
+  "scripts": {
+    "prepare": "yarn build",
+    "prepack": "yarn build && yarn lint",
+    "build": "rimraf dist && tsc",
+    "lint": "eslint ."
+  },
+  "dependencies": {
+    "@open-xchange/vite-helper": "0.1.2"
+  },
+  "devDependencies": {
+    "@open-xchange/linter-presets": "0.8.8",
+    "@types/node": "22.7.6",
+    "eslint": "9.12.0",
+    "rimraf": "6.0.1",
+    "typescript": "5.6.3",
+    "vite": "5.4.9"
+  },
+  "peerDependencies": {
+    "vite": "^5.3"
+  },
+  "resolutions": {
+    "semver": "^7.6.2"
+  }
+}

package/.vscode/settings.json

@@ -1,3 +0,0 @@
-{
-    "typescript.tsdk": "node_modules/typescript/lib"
-}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 OX Software GmbH, Germany <info@open-xchange.com>
-
-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.