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

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
-## [0.0.1] - 2024-08-06
+## [0.0.2] - 2024-08-07
+
+- changed: GitLab API token as plugin parameter instead of env var
+
+## [0.0.1] - 2024-08-07
 
 - initial release

package/README.md

@@ -105,6 +105,7 @@ 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. |
@@ -177,3 +178,7 @@ export default defineConfig(() => {
   ],
 })
 ```
+
+### 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

@@ -16,16 +16,17 @@ export interface VitePluginReplacePkg_RequestInit extends RequestInit {
 }
 /**
  * The specification of a source file in a GitLab repository.
- *
- * Downloading the source file needs a valid GitLab API token stored in the
- * environment variable "GITLAB_TOKEN". If the variable does not exist,
- * downloading the source wile will be skipped.
  */
 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

package/dist/index.js

@@ -4,7 +4,7 @@ import { Logger } from "@open-xchange/vite-helper/logger";
 export const PROJECT_NAME = "@open-xchange/vite-plugin-replace-pkg";
 const logger = new Logger({
     loggerPrefix: "pkg",
-    logLevelEnvVar: "PLUGIN_REPLACE_PACKAGES_LOGLEVEL",
+    logLevelEnvVar: "PLUGIN_REPLACE_PKG_LOGLEVEL",
 });
 // functions ==================================================================
 const resolveFetchOptions = (options) => {
@@ -23,10 +23,9 @@ const resolveFetchOptions = (options) => {
     }
     // `GitLabFile` object
     if ("project" in replace) {
-        // resolve GitLab API tokens
-        const token = process.env.GITLAB_TOKEN;
-        if (!token) {
-            logger.warn("missing environment variable %f with GitLab API token", "GITLAB_TOKEN");
+        // GitLab API token
+        if (!replace.token) {
+            logger.warn("missing GitLab API token");
             return;
         }
         // build the file URL for the GitLab API
@@ -39,7 +38,7 @@ const resolveFetchOptions = (options) => {
         if (replace.ref) {
             query.ref = replace.ref;
         }
-        const headers = { "PRIVATE-TOKEN": token };
+        const headers = { "PRIVATE-TOKEN": replace.token };
         return { url, headers, query };
     }
     logger.error("invalid configuration for package %f", options.package);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@open-xchange/vite-plugin-replace-pkg",
-    "version": "0.0.1",
+    "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"