@scaleway/configuration-loader 0.1.0-beta.4 → 0.1.0-beta.6

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 0.1.0-beta.6 (2023-01-03)
+
+### Features
+
+- **configuration-loader:** list all configurations at once ([#336](https://github.com/scaleway/scaleway-sdk-js/issues/336)) ([f58b62c](https://github.com/scaleway/scaleway-sdk-js/commit/f58b62c050dedf9aa8fae71600c2e718f099173a))
+
+## 0.1.0-beta.5 (2022-12-05)
+
+**Note:** Version bump only for package @scaleway/configuration-loader
+
 ## 0.1.0-beta.4 (2022-11-23)
 
 **Note:** Version bump only for package @scaleway/configuration-loader

package/dist/config-loader.js

@@ -3,6 +3,16 @@ import { EnvironmentKey } from './env.js';
 import { resolveConfigurationFilePath } from './path-resolver.js';
 import { loadConfigurationFromFile } from './yml-loader.js';
 
+const convertFileConfigToSDK = obj => ({
+  accessKey: obj.access_key,
+  apiURL: obj.api_url,
+  defaultOrganizationId: obj.default_organization_id,
+  defaultProjectId: obj.default_project_id,
+  defaultRegion: obj.default_region,
+  defaultZone: obj.default_zone,
+  secretKey: obj.secret_key
+});
+
 /**
  * Loads profile from environment values.
  *
@@ -21,37 +31,48 @@ const loadProfileFromEnvironmentValues = () => ({
 });
 
 /**
- * Loads profile from configuration file.
+ * Loads all the profiles from configuration file.
  *
  * @param params - The parameters to load the profile
- * @returns The profile filled with values found in the configuration profile
+ * @returns The profiles filled with values found in the configuration profile
  *
  * @throws Error
- * Thrown if the configuration file couldn't be found,
- * or if the specified profile can't be found.
+ * Thrown if the configuration file couldn't be found.
  *
  * @public
  */
-const loadProfileFromConfigurationFile = params => {
+const loadAllProfilesFromConfigurationFile = params => {
   const filePath = (params == null ? void 0 : params.filepath) ?? resolveConfigurationFilePath();
   if (typeof filePath !== 'string' || filePath.length === 0) {
     throw new Error('Could not find the path to the configuration file.');
   }
   const configs = loadConfigurationFromFile(filePath);
+  return Object.keys(configs).reduce((prev, pKey) => ({
+    ...prev,
+    [pKey]: convertFileConfigToSDK(configs[pKey])
+  }), {});
+};
+
+/**
+ * Loads profile from configuration file.
+ *
+ * @param params - The parameters to load the profile
+ * @returns The profile filled with values found in the configuration profile
+ *
+ * @throws Error
+ * Thrown if the configuration file couldn't be found,
+ * or if the specified profile can't be found.
+ *
+ * @public
+ */
+const loadProfileFromConfigurationFile = params => {
+  const configs = loadAllProfilesFromConfigurationFile(params);
   const profileName = (params == null ? void 0 : params.profileName) ?? 'default';
   const profileMap = configs[profileName];
   if (typeof profileMap !== 'object') {
     throw new Error(`Could not find the desired profile '${profileName}' in the configuration file.`);
   }
-  return {
-    accessKey: profileMap.access_key,
-    apiURL: profileMap.api_url,
-    defaultOrganizationId: profileMap.default_organization_id,
-    defaultProjectId: profileMap.default_project_id,
-    defaultRegion: profileMap.default_region,
-    defaultZone: profileMap.default_zone,
-    secretKey: profileMap.secret_key
-  };
+  return profileMap;
 };
 
-export { loadProfileFromConfigurationFile, loadProfileFromEnvironmentValues };
+export { loadAllProfilesFromConfigurationFile, loadProfileFromConfigurationFile, loadProfileFromEnvironmentValues };

package/dist/index.cjs

@@ -136,6 +136,16 @@ const loadConfigurationFromFile = filePath => {
   return convertYamlToConfiguration(fileContent);
 };
 
+const convertFileConfigToSDK = obj => ({
+  accessKey: obj.access_key,
+  apiURL: obj.api_url,
+  defaultOrganizationId: obj.default_organization_id,
+  defaultProjectId: obj.default_project_id,
+  defaultRegion: obj.default_region,
+  defaultZone: obj.default_zone,
+  secretKey: obj.secret_key
+});
+
 /**
  * Loads profile from environment values.
  *
@@ -154,38 +164,50 @@ const loadProfileFromEnvironmentValues = () => ({
 });
 
 /**
- * Loads profile from configuration file.
+ * Loads all the profiles from configuration file.
  *
  * @param params - The parameters to load the profile
- * @returns The profile filled with values found in the configuration profile
+ * @returns The profiles filled with values found in the configuration profile
  *
  * @throws Error
- * Thrown if the configuration file couldn't be found,
- * or if the specified profile can't be found.
+ * Thrown if the configuration file couldn't be found.
  *
  * @public
  */
-const loadProfileFromConfigurationFile = params => {
+const loadAllProfilesFromConfigurationFile = params => {
   const filePath = (params == null ? void 0 : params.filepath) ?? resolveConfigurationFilePath();
   if (typeof filePath !== 'string' || filePath.length === 0) {
     throw new Error('Could not find the path to the configuration file.');
   }
   const configs = loadConfigurationFromFile(filePath);
+  return Object.keys(configs).reduce((prev, pKey) => ({
+    ...prev,
+    [pKey]: convertFileConfigToSDK(configs[pKey])
+  }), {});
+};
+
+/**
+ * Loads profile from configuration file.
+ *
+ * @param params - The parameters to load the profile
+ * @returns The profile filled with values found in the configuration profile
+ *
+ * @throws Error
+ * Thrown if the configuration file couldn't be found,
+ * or if the specified profile can't be found.
+ *
+ * @public
+ */
+const loadProfileFromConfigurationFile = params => {
+  const configs = loadAllProfilesFromConfigurationFile(params);
   const profileName = (params == null ? void 0 : params.profileName) ?? 'default';
   const profileMap = configs[profileName];
   if (typeof profileMap !== 'object') {
     throw new Error(`Could not find the desired profile '${profileName}' in the configuration file.`);
   }
-  return {
-    accessKey: profileMap.access_key,
-    apiURL: profileMap.api_url,
-    defaultOrganizationId: profileMap.default_organization_id,
-    defaultProjectId: profileMap.default_project_id,
-    defaultRegion: profileMap.default_region,
-    defaultZone: profileMap.default_zone,
-    secretKey: profileMap.secret_key
-  };
+  return profileMap;
 };
 
+exports.loadAllProfilesFromConfigurationFile = loadAllProfilesFromConfigurationFile;
 exports.loadProfileFromConfigurationFile = loadProfileFromConfigurationFile;
 exports.loadProfileFromEnvironmentValues = loadProfileFromEnvironmentValues;

package/dist/index.d.ts

@@ -3,7 +3,7 @@
  *
  * @public
  */
-declare type Profile = {
+type Profile = {
     /**
      * You need an access key and a secret key to connect to Scaleway API.
      * Generate your token at the following address: {@link https://console.scaleway.com/project/credentials}
@@ -44,8 +44,8 @@ declare type Profile = {
      */
     secretKey?: string;
 };
-/** Parameters to load the profile from the configuration file */
-declare type ProfileFromFileParams = {
+/** Parameters to load the all the profiles from the configuration file */
+type AllProfilesFromFileParams = {
     /**
      * The path at which to locate the configuration file.
      *
@@ -53,6 +53,9 @@ declare type ProfileFromFileParams = {
      * or `~/.scw/config` otherwise.
      */
     filepath?: string;
+};
+/** Parameters to load the profile from the configuration file */
+type ProfileFromFileParams = AllProfilesFromFileParams & {
     /**
      * Name of the profile to load.
      *
@@ -69,6 +72,18 @@ declare type ProfileFromFileParams = {
  * @public
  */
 declare const loadProfileFromEnvironmentValues: () => Profile;
+/**
+ * Loads all the profiles from configuration file.
+ *
+ * @param params - The parameters to load the profile
+ * @returns The profiles filled with values found in the configuration profile
+ *
+ * @throws Error
+ * Thrown if the configuration file couldn't be found.
+ *
+ * @public
+ */
+declare const loadAllProfilesFromConfigurationFile: (params?: Readonly<AllProfilesFromFileParams>) => Record<string, Profile>;
 /**
  * Loads profile from configuration file.
  *
@@ -83,4 +98,4 @@ declare const loadProfileFromEnvironmentValues: () => Profile;
  */
 declare const loadProfileFromConfigurationFile: (params?: Readonly<ProfileFromFileParams>) => Profile;
 
-export { Profile, ProfileFromFileParams, loadProfileFromConfigurationFile, loadProfileFromEnvironmentValues };
+export { AllProfilesFromFileParams, Profile, ProfileFromFileParams, loadAllProfilesFromConfigurationFile, loadProfileFromConfigurationFile, loadProfileFromEnvironmentValues };

package/dist/index.js

@@ -1 +1 @@
-export { loadProfileFromConfigurationFile, loadProfileFromEnvironmentValues } from './config-loader.js';
+export { loadAllProfilesFromConfigurationFile, loadProfileFromConfigurationFile, loadProfileFromEnvironmentValues } from './config-loader.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/configuration-loader",
-  "version": "0.1.0-beta.4",
+  "version": "0.1.0-beta.6",
   "license": "Apache-2.0",
   "description": "Load configuration via file or environment for NodeJS.",
   "main": "dist/index.cjs",
@@ -19,7 +19,7 @@
   },
   "type": "module",
   "devDependencies": {
-    "@types/node": "^17.0.45"
+    "@types/node": "^18.11.10"
   },
-  "gitHead": "5484de96723e18038b6a8781ebb941a1f270f49a"
+  "gitHead": "0aca532d8c1f7954def5216262ca6c6adb5aa590"
 }