@ubiquity-os/plugin-sdk 3.5.3 → 3.5.4

package/dist/configuration.d.mts

@@ -50,14 +50,16 @@ interface LoggerInterface {
 }
 /**
  * Handles fetching and managing plugin configurations from GitHub repositories.
- * Prioritizes production configuration (`.ubiquity-os.config.yml`) over development configuration (`.ubiquity-os.config.dev.yml`).
+ * Prioritizes production configuration (`.ubiquity-os.config.yml`) over development configuration (`.ubiquity-os.config.dev.yml`),
+ * except if the `_environment` value is provided to the constructor.
  **/
 declare class ConfigurationHandler {
     private readonly _logger;
     private readonly _octokit;
+    private readonly _environment;
     private _manifestCache;
     private _manifestPromiseCache;
-    constructor(_logger: LoggerInterface, _octokit: Context["octokit"]);
+    constructor(_logger: LoggerInterface, _octokit: Context["octokit"], _environment?: "development" | "production" | null);
     /**
      *  Retrieves the configuration for the current plugin based on its manifest.
      *  @param manifest - The plugin manifest containing the `short_name` identifier
@@ -82,7 +84,7 @@ declare class ConfigurationHandler {
         };
     }>;
     /**
-     * Retrieves the configuration from the given owner/repository. Also returns the raw data and errors if any.
+     * Retrieves the configuration from the given owner/repository. Also returns the raw data and errors, if any.
      *
      * @param owner The repository owner
      * @param repository The repository name

package/dist/configuration.d.ts

@@ -50,14 +50,16 @@ interface LoggerInterface {
 }
 /**
  * Handles fetching and managing plugin configurations from GitHub repositories.
- * Prioritizes production configuration (`.ubiquity-os.config.yml`) over development configuration (`.ubiquity-os.config.dev.yml`).
+ * Prioritizes production configuration (`.ubiquity-os.config.yml`) over development configuration (`.ubiquity-os.config.dev.yml`),
+ * except if the `_environment` value is provided to the constructor.
  **/
 declare class ConfigurationHandler {
     private readonly _logger;
     private readonly _octokit;
+    private readonly _environment;
     private _manifestCache;
     private _manifestPromiseCache;
-    constructor(_logger: LoggerInterface, _octokit: Context["octokit"]);
+    constructor(_logger: LoggerInterface, _octokit: Context["octokit"], _environment?: "development" | "production" | null);
     /**
      *  Retrieves the configuration for the current plugin based on its manifest.
      *  @param manifest - The plugin manifest containing the `short_name` identifier
@@ -82,7 +84,7 @@ declare class ConfigurationHandler {
         };
     }>;
     /**
-     * Retrieves the configuration from the given owner/repository. Also returns the raw data and errors if any.
+     * Retrieves the configuration from the given owner/repository. Also returns the raw data and errors, if any.
      *
      * @param owner The repository owner
      * @param repository The repository name

package/dist/configuration.js

@@ -118,9 +118,10 @@ var CONFIG_PROD_FULL_PATH = ".github/.ubiquity-os.config.yml";
 var CONFIG_DEV_FULL_PATH = ".github/.ubiquity-os.config.dev.yml";
 var CONFIG_ORG_REPO = ".ubiquity-os";
 var ConfigurationHandler = class {
-  constructor(_logger, _octokit) {
+  constructor(_logger, _octokit, _environment = null) {
     this._logger = _logger;
     this._octokit = _octokit;
+    this._environment = _environment;
   }
   _manifestCache = {};
   _manifestPromiseCache = {};
@@ -197,7 +198,7 @@ var ConfigurationHandler = class {
     };
   }
   /**
-   * Retrieves the configuration from the given owner/repository. Also returns the raw data and errors if any.
+   * Retrieves the configuration from the given owner/repository. Also returns the raw data and errors, if any.
    *
    * @param owner The repository owner
    * @param repository The repository name
@@ -239,7 +240,17 @@ var ConfigurationHandler = class {
       this._logger.error("Repo or owner is not defined, cannot download the requested file");
       return null;
     }
-    const pathList = [CONFIG_PROD_FULL_PATH, CONFIG_DEV_FULL_PATH];
+    let pathList;
+    switch (this._environment) {
+      case "development":
+        pathList = [CONFIG_DEV_FULL_PATH];
+        break;
+      case "production":
+        pathList = [CONFIG_PROD_FULL_PATH];
+        break;
+      default:
+        pathList = [CONFIG_PROD_FULL_PATH, CONFIG_DEV_FULL_PATH];
+    }
     for (const filePath of pathList) {
       try {
         this._logger.debug("Attempting to fetch configuration", { owner, repository, filePath });

package/dist/configuration.mjs

@@ -81,9 +81,10 @@ var CONFIG_PROD_FULL_PATH = ".github/.ubiquity-os.config.yml";
 var CONFIG_DEV_FULL_PATH = ".github/.ubiquity-os.config.dev.yml";
 var CONFIG_ORG_REPO = ".ubiquity-os";
 var ConfigurationHandler = class {
-  constructor(_logger, _octokit) {
+  constructor(_logger, _octokit, _environment = null) {
     this._logger = _logger;
     this._octokit = _octokit;
+    this._environment = _environment;
   }
   _manifestCache = {};
   _manifestPromiseCache = {};
@@ -160,7 +161,7 @@ var ConfigurationHandler = class {
     };
   }
   /**
-   * Retrieves the configuration from the given owner/repository. Also returns the raw data and errors if any.
+   * Retrieves the configuration from the given owner/repository. Also returns the raw data and errors, if any.
    *
    * @param owner The repository owner
    * @param repository The repository name
@@ -202,7 +203,17 @@ var ConfigurationHandler = class {
       this._logger.error("Repo or owner is not defined, cannot download the requested file");
       return null;
     }
-    const pathList = [CONFIG_PROD_FULL_PATH, CONFIG_DEV_FULL_PATH];
+    let pathList;
+    switch (this._environment) {
+      case "development":
+        pathList = [CONFIG_DEV_FULL_PATH];
+        break;
+      case "production":
+        pathList = [CONFIG_PROD_FULL_PATH];
+        break;
+      default:
+        pathList = [CONFIG_PROD_FULL_PATH, CONFIG_DEV_FULL_PATH];
+    }
     for (const filePath of pathList) {
       try {
         this._logger.debug("Attempting to fetch configuration", { owner, repository, filePath });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ubiquity-os/plugin-sdk",
-  "version": "3.5.3",
+  "version": "3.5.4",
   "description": "SDK for plugin support.",
   "author": "Ubiquity DAO",
   "license": "MIT",