@scaleway/configuration-loader 1.0.3 → 1.0.5

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.
 
+## [1.0.5](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/configuration-loader@1.0.4...@scaleway/configuration-loader@1.0.5) (2024-05-15)
+
+### Bug Fixes
+
+- **build:** export all types ([#1261](https://github.com/scaleway/scaleway-sdk-js/issues/1261)) ([2c13c19](https://github.com/scaleway/scaleway-sdk-js/commit/2c13c19d1699d2138d0ae9c4cf2a8a29b50d93ff))
+
+## 1.0.4 (2024-05-06)
+
+**Note:** Version bump only for package @scaleway/configuration-loader
+
 ## [1.0.3](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/configuration-loader@1.0.2...@scaleway/configuration-loader@1.0.3) (2024-02-19)
 
 **Note:** Version bump only for package @scaleway/configuration-loader

package/dist/config-loader.cjs

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const process = require("process");
+const env = require("./env.cjs");
+const pathResolver = require("./path-resolver.cjs");
+const ymlLoader = require("./yml-loader.cjs");
+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
+});
+const loadProfileFromEnvironmentValues = () => ({
+  accessKey: process.env[env.EnvironmentKey.ScwAccessKey],
+  apiURL: process.env[env.EnvironmentKey.ScwAPIURL],
+  defaultOrganizationId: process.env[env.EnvironmentKey.ScwDefaultOrganizationId],
+  defaultProjectId: process.env[env.EnvironmentKey.ScwDefaultProjectId],
+  defaultRegion: process.env[env.EnvironmentKey.ScwDefaultRegion],
+  defaultZone: process.env[env.EnvironmentKey.ScwDefaultZone],
+  secretKey: process.env[env.EnvironmentKey.ScwSecretKey]
+});
+const loadAllProfilesFromConfigurationFile = (params) => {
+  const filePath = params?.filepath ?? pathResolver.resolveConfigurationFilePath();
+  if (typeof filePath !== "string" || filePath.length === 0) {
+    throw new Error("Could not find the path to the configuration file.");
+  }
+  const configs = ymlLoader.loadConfigurationFromFile(filePath);
+  return Object.keys(configs).reduce(
+    (prev, pKey) => ({
+      ...prev,
+      [pKey]: convertFileConfigToSDK(configs[pKey])
+    }),
+    {}
+  );
+};
+const loadProfileFromConfigurationFile = (params) => {
+  const configs = loadAllProfilesFromConfigurationFile(params);
+  const profileName = 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 profileMap;
+};
+exports.loadAllProfilesFromConfigurationFile = loadAllProfilesFromConfigurationFile;
+exports.loadProfileFromConfigurationFile = loadProfileFromConfigurationFile;
+exports.loadProfileFromEnvironmentValues = loadProfileFromEnvironmentValues;

package/dist/config-loader.d.ts

@@ -0,0 +1,34 @@
+import type { AllProfilesFromFileParams, Profile, ProfileFromFileParams } from './types';
+/**
+ * Loads profile from environment values.
+ *
+ * @returns The profile filled with values found in the environment
+ *
+ * @public
+ */
+export 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
+ */
+export declare const loadAllProfilesFromConfigurationFile: (params?: Readonly<AllProfilesFromFileParams>) => Record<string, Profile>;
+/**
+ * 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
+ */
+export declare const loadProfileFromConfigurationFile: (params?: Readonly<ProfileFromFileParams>) => Profile;

package/dist/config-loader.js

@@ -1,9 +1,8 @@
-import { env } from 'process';
-import { EnvironmentKey } from './env.js';
-import { resolveConfigurationFilePath } from './path-resolver.js';
-import { loadConfigurationFromFile } from './yml-loader.js';
-
-const convertFileConfigToSDK = obj => ({
+import { env } from "process";
+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,
@@ -12,14 +11,6 @@ const convertFileConfigToSDK = obj => ({
   defaultZone: obj.default_zone,
   secretKey: obj.secret_key
 });
-
-/**
- * Loads profile from environment values.
- *
- * @returns The profile filled with values found in the environment
- *
- * @public
- */
 const loadProfileFromEnvironmentValues = () => ({
   accessKey: env[EnvironmentKey.ScwAccessKey],
   apiURL: env[EnvironmentKey.ScwAPIURL],
@@ -29,50 +20,33 @@ const loadProfileFromEnvironmentValues = () => ({
   defaultZone: env[EnvironmentKey.ScwDefaultZone],
   secretKey: env[EnvironmentKey.ScwSecretKey]
 });
-
-/**
- * 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
- */
-const loadAllProfilesFromConfigurationFile = params => {
+const loadAllProfilesFromConfigurationFile = (params) => {
   const filePath = params?.filepath ?? resolveConfigurationFilePath();
-  if (typeof filePath !== 'string' || filePath.length === 0) {
-    throw new Error('Could not find the path to the configuration file.');
+  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])
-  }), {});
+  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 loadProfileFromConfigurationFile = (params) => {
   const configs = loadAllProfilesFromConfigurationFile(params);
-  const profileName = params?.profileName ?? 'default';
+  const profileName = 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.`);
+  if (typeof profileMap !== "object") {
+    throw new Error(
+      `Could not find the desired profile '${profileName}' in the configuration file.`
+    );
   }
   return profileMap;
 };
-
-export { loadAllProfilesFromConfigurationFile, loadProfileFromConfigurationFile, loadProfileFromEnvironmentValues };
+export {
+  loadAllProfilesFromConfigurationFile,
+  loadProfileFromConfigurationFile,
+  loadProfileFromEnvironmentValues
+};

package/dist/env.cjs

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+var EnvironmentKey = /* @__PURE__ */ ((EnvironmentKey2) => {
+  EnvironmentKey2["ScwConfigPath"] = "SCW_CONFIG_PATH";
+  EnvironmentKey2["ScwAccessKey"] = "SCW_ACCESS_KEY";
+  EnvironmentKey2["ScwSecretKey"] = "SCW_SECRET_KEY";
+  EnvironmentKey2["ScwAPIURL"] = "SCW_API_URL";
+  EnvironmentKey2["ScwDefaultOrganizationId"] = "SCW_DEFAULT_ORGANIZATION_ID";
+  EnvironmentKey2["ScwDefaultProjectId"] = "SCW_DEFAULT_PROJECT_ID";
+  EnvironmentKey2["ScwDefaultRegion"] = "SCW_DEFAULT_REGION";
+  EnvironmentKey2["ScwDefaultZone"] = "SCW_DEFAULT_ZONE";
+  return EnvironmentKey2;
+})(EnvironmentKey || {});
+exports.EnvironmentKey = EnvironmentKey;

package/dist/env.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Environment Key.
+ */
+export declare enum EnvironmentKey {
+    /** Path to the Scaleway configuration file */
+    ScwConfigPath = "SCW_CONFIG_PATH",
+    /** Scaleway access key */
+    ScwAccessKey = "SCW_ACCESS_KEY",
+    /**
+     * Scaleway secret key
+     * @remarks #nosec G101
+     */
+    ScwSecretKey = "SCW_SECRET_KEY",
+    /** Scaleway API URL */
+    ScwAPIURL = "SCW_API_URL",
+    /** Scaleway default organization ID */
+    ScwDefaultOrganizationId = "SCW_DEFAULT_ORGANIZATION_ID",
+    /** Scaleway default project ID */
+    ScwDefaultProjectId = "SCW_DEFAULT_PROJECT_ID",
+    /** Scaleway default region */
+    ScwDefaultRegion = "SCW_DEFAULT_REGION",
+    /** Scaleway default zone */
+    ScwDefaultZone = "SCW_DEFAULT_ZONE"
+}

package/dist/env.js

@@ -1,16 +1,14 @@
-/**
- * Environment Key.
- */
-let EnvironmentKey = /*#__PURE__*/function (EnvironmentKey) {
-  EnvironmentKey["ScwConfigPath"] = "SCW_CONFIG_PATH";
-  EnvironmentKey["ScwAccessKey"] = "SCW_ACCESS_KEY";
-  EnvironmentKey["ScwSecretKey"] = "SCW_SECRET_KEY";
-  EnvironmentKey["ScwAPIURL"] = "SCW_API_URL";
-  EnvironmentKey["ScwDefaultOrganizationId"] = "SCW_DEFAULT_ORGANIZATION_ID";
-  EnvironmentKey["ScwDefaultProjectId"] = "SCW_DEFAULT_PROJECT_ID";
-  EnvironmentKey["ScwDefaultRegion"] = "SCW_DEFAULT_REGION";
-  EnvironmentKey["ScwDefaultZone"] = "SCW_DEFAULT_ZONE";
-  return EnvironmentKey;
-}({});
-
-export { EnvironmentKey };
+var EnvironmentKey = /* @__PURE__ */ ((EnvironmentKey2) => {
+  EnvironmentKey2["ScwConfigPath"] = "SCW_CONFIG_PATH";
+  EnvironmentKey2["ScwAccessKey"] = "SCW_ACCESS_KEY";
+  EnvironmentKey2["ScwSecretKey"] = "SCW_SECRET_KEY";
+  EnvironmentKey2["ScwAPIURL"] = "SCW_API_URL";
+  EnvironmentKey2["ScwDefaultOrganizationId"] = "SCW_DEFAULT_ORGANIZATION_ID";
+  EnvironmentKey2["ScwDefaultProjectId"] = "SCW_DEFAULT_PROJECT_ID";
+  EnvironmentKey2["ScwDefaultRegion"] = "SCW_DEFAULT_REGION";
+  EnvironmentKey2["ScwDefaultZone"] = "SCW_DEFAULT_ZONE";
+  return EnvironmentKey2;
+})(EnvironmentKey || {});
+export {
+  EnvironmentKey
+};

package/dist/index.cjs

@@ -1,214 +1,6 @@
-'use strict';
-
-var process = require('process');
-var node_os = require('node:os');
-var path = require('node:path');
-var node_process = require('node:process');
-var fs = require('fs');
-
-function _interopNamespaceDefault(e) {
-  var n = Object.create(null);
-  if (e) {
-    Object.keys(e).forEach(function (k) {
-      if (k !== 'default') {
-        var d = Object.getOwnPropertyDescriptor(e, k);
-        Object.defineProperty(n, k, d.get ? d : {
-          enumerable: true,
-          get: function () { return e[k]; }
-        });
-      }
-    });
-  }
-  n.default = e;
-  return Object.freeze(n);
-}
-
-var path__namespace = /*#__PURE__*/_interopNamespaceDefault(path);
-
-/**
- * Environment Key.
- */
-let EnvironmentKey = /*#__PURE__*/function (EnvironmentKey) {
-  EnvironmentKey["ScwConfigPath"] = "SCW_CONFIG_PATH";
-  EnvironmentKey["ScwAccessKey"] = "SCW_ACCESS_KEY";
-  EnvironmentKey["ScwSecretKey"] = "SCW_SECRET_KEY";
-  EnvironmentKey["ScwAPIURL"] = "SCW_API_URL";
-  EnvironmentKey["ScwDefaultOrganizationId"] = "SCW_DEFAULT_ORGANIZATION_ID";
-  EnvironmentKey["ScwDefaultProjectId"] = "SCW_DEFAULT_PROJECT_ID";
-  EnvironmentKey["ScwDefaultRegion"] = "SCW_DEFAULT_REGION";
-  EnvironmentKey["ScwDefaultZone"] = "SCW_DEFAULT_ZONE";
-  return EnvironmentKey;
-}({});
-
-/**
- * Gets the Scaleway directory.
- *
- * @returns The path to the Scaleway diretory
- *
- * @internal
- */
-const getScwConfigurationDirectory = () => {
-  const xdgConfigPath = node_process.env.XDG_CONFIG_HOME;
-  if (typeof xdgConfigPath === 'string' && xdgConfigPath.length > 0) {
-    return path__namespace.join(xdgConfigPath, 'scw');
-  }
-  return path__namespace.join(node_os.homedir(), '.config', 'scw');
-};
-
-/**
- * Gets the configuration file path.
- *
- * @returns The path to the configuration file
- *
- * @internal
- */
-const resolveConfigurationFilePath = () => {
-  // Try path defined by user in env variables
-  const envFilePath = node_process.env[EnvironmentKey.ScwConfigPath];
-  if (typeof envFilePath === 'string' && envFilePath.length > 0) {
-    return envFilePath;
-  }
-
-  // or fallback on the default path
-  return path__namespace.join(getScwConfigurationDirectory(), 'config.yaml');
-};
-
-const STRIP_COMMENT_REGEX = /(^|\s)[;#]/;
-const DETECT_SECTION_REGEX = /^\s*([^]+):\s*$/;
-const DETECT_ITEM_REGEX = /^\s*(.+?)\s*:\s*(.+?)\s*$/;
-
-/**
- * Converts YAML to configuration map.
- *
- * @param input - YAML string
- * @returns The configuration map
- *
- * @internal
- */
-const convertYamlToConfiguration = input => {
-  let foundProfilesKey = false;
-  let currentSection = 'default';
-  const map = {};
-  if (typeof input !== 'string') {
-    return map;
-  }
-  input.split(/\r?\n/).forEach(rawLine => {
-    // remove comments
-    const line = rawLine.split(STRIP_COMMENT_REGEX)[0];
-    // parse sections
-    const newSection = DETECT_SECTION_REGEX.exec(line);
-    if (newSection) {
-      currentSection = undefined;
-      if (newSection[1] === 'profiles') {
-        foundProfilesKey = true;
-      } else if (foundProfilesKey) {
-        [, currentSection] = newSection;
-      }
-    }
-    // parse items
-    else if (currentSection) {
-      const item = DETECT_ITEM_REGEX.exec(line);
-      if (item) {
-        if (typeof map[currentSection] !== 'object') {
-          map[currentSection] = {};
-        }
-        [,, map[currentSection][item[1]]] = item;
-      }
-    }
-  });
-  return map;
-};
-
-/**
- * Loads configuration from a file.
- *
- * @param filePath - Path to the configuration file
- * @returns The configuration
- *
- * @throws Error
- * Thrown if the file doesn't exist.
- *
- * @internal
- */
-const loadConfigurationFromFile = filePath => {
-  // `readFileSync` returns a string when encoding option is specified.
-  // {@link https://nodejs.org/api/fs.html#fs_fs_readfilesync_path_options}
-  const fileContent = fs.readFileSync(filePath, 'utf-8');
-  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.
- *
- * @returns The profile filled with values found in the environment
- *
- * @public
- */
-const loadProfileFromEnvironmentValues = () => ({
-  accessKey: process.env[EnvironmentKey.ScwAccessKey],
-  apiURL: process.env[EnvironmentKey.ScwAPIURL],
-  defaultOrganizationId: process.env[EnvironmentKey.ScwDefaultOrganizationId],
-  defaultProjectId: process.env[EnvironmentKey.ScwDefaultProjectId],
-  defaultRegion: process.env[EnvironmentKey.ScwDefaultRegion],
-  defaultZone: process.env[EnvironmentKey.ScwDefaultZone],
-  secretKey: process.env[EnvironmentKey.ScwSecretKey]
-});
-
-/**
- * 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
- */
-const loadAllProfilesFromConfigurationFile = params => {
-  const filePath = 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?.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 profileMap;
-};
-
-exports.loadAllProfilesFromConfigurationFile = loadAllProfilesFromConfigurationFile;
-exports.loadProfileFromConfigurationFile = loadProfileFromConfigurationFile;
-exports.loadProfileFromEnvironmentValues = loadProfileFromEnvironmentValues;
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const configLoader = require("./config-loader.cjs");
+exports.loadAllProfilesFromConfigurationFile = configLoader.loadAllProfilesFromConfigurationFile;
+exports.loadProfileFromConfigurationFile = configLoader.loadProfileFromConfigurationFile;
+exports.loadProfileFromEnvironmentValues = configLoader.loadProfileFromEnvironmentValues;

package/dist/index.d.ts

@@ -1,102 +1,2 @@
-/**
- * Profile contains information to help instanciating the Scaleway client.
- *
- * @public
- */
-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}
-   */
-  accessKey?: string
-  /**
-   * APIURL overrides the API URL of the Scaleway API to the given URL.
-   * Change that if you want to direct requests to a different endpoint.
-   *
-   * @defaultValue `https://api.scaleway.com`
-   */
-  apiURL?: string
-  /**
-   * Your organization ID is the identifier of your account inside Scaleway infrastructure.
-   */
-  defaultOrganizationId?: string
-  /**
-   * Your project ID is the identifier of the project your resources are attached to.
-   */
-  defaultProjectId?: string
-  /**
-   * A region is represented as a geographical area such as France (Paris) or the Netherlands (Amsterdam).
-   * It can contain multiple availability zones.
-   *
-   * Examples: fr-par, nl-ams.
-   */
-  defaultRegion?: string
-  /**
-   * A region can be split into many availability zones (AZ).
-   * Latency between multiple AZ of the same region are low as they have a common network layer.
-   *
-   * Examples: fr-par-1, nl-ams-1
-   */
-  defaultZone?: string
-  /**
-   * The secret key is the value that can be used to authenticate against the API (the value used in X-Auth-Token HTTP-header).
-   * The secret key MUST remain secret and not given to anyone or published online.
-   */
-  secretKey?: string
-}
-/** Parameters to load the all the profiles from the configuration file */
-type AllProfilesFromFileParams = {
-  /**
-   * The path at which to locate the configuration file.
-   *
-   * Defaults to the value of the `SCW_CONFIG_PATH` environment variable
-   * or `~/.scw/config` otherwise.
-   */
-  filepath?: string
-}
-
-/** Parameters to load the profile from the configuration file */
-type ProfileFromFileParams = AllProfilesFromFileParams & {
-  /**
-   * Name of the profile to load.
-   *
-   * @defaultValue `default`
-   * */
-  profileName?: string
-}
-
-/**
- * Loads profile from environment values.
- *
- * @returns The profile filled with values found in the environment
- *
- * @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.
- *
- * @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
- */
-declare const loadProfileFromConfigurationFile: (params?: Readonly<ProfileFromFileParams>) => Profile;
-
-export { type AllProfilesFromFileParams, type Profile, type ProfileFromFileParams, loadAllProfilesFromConfigurationFile, loadProfileFromConfigurationFile, loadProfileFromEnvironmentValues };
+export { loadAllProfilesFromConfigurationFile, loadProfileFromConfigurationFile, loadProfileFromEnvironmentValues, } from './config-loader';
+export type { AllProfilesFromFileParams, Profile, ProfileFromFileParams, } from './types';

package/dist/index.js

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

package/dist/path-resolver.cjs

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const node_os = require("node:os");
+const path = require("node:path");
+const node_process = require("node:process");
+const env = require("./env.cjs");
+function _interopNamespaceDefault(e) {
+  const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
+  if (e) {
+    for (const k in e) {
+      if (k !== "default") {
+        const d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: () => e[k]
+        });
+      }
+    }
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+const path__namespace = /* @__PURE__ */ _interopNamespaceDefault(path);
+const getScwConfigurationDirectory = () => {
+  const xdgConfigPath = node_process.env.XDG_CONFIG_HOME;
+  if (typeof xdgConfigPath === "string" && xdgConfigPath.length > 0) {
+    return path__namespace.join(xdgConfigPath, "scw");
+  }
+  return path__namespace.join(node_os.homedir(), ".config", "scw");
+};
+const resolveConfigurationFilePath = () => {
+  const envFilePath = node_process.env[env.EnvironmentKey.ScwConfigPath];
+  if (typeof envFilePath === "string" && envFilePath.length > 0) {
+    return envFilePath;
+  }
+  return path__namespace.join(getScwConfigurationDirectory(), "config.yaml");
+};
+exports.getScwConfigurationDirectory = getScwConfigurationDirectory;
+exports.resolveConfigurationFilePath = resolveConfigurationFilePath;

package/dist/path-resolver.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Gets the Scaleway directory.
+ *
+ * @returns The path to the Scaleway diretory
+ *
+ * @internal
+ */
+export declare const getScwConfigurationDirectory: () => string;
+/**
+ * Gets the configuration file path.
+ *
+ * @returns The path to the configuration file
+ *
+ * @internal
+ */
+export declare const resolveConfigurationFilePath: () => string;

package/dist/path-resolver.js

@@ -1,39 +1,22 @@
-import { homedir } from 'node:os';
-import * as path from 'node:path';
-import { env } from 'node:process';
-import { EnvironmentKey } from './env.js';
-
-/**
- * Gets the Scaleway directory.
- *
- * @returns The path to the Scaleway diretory
- *
- * @internal
- */
+import { homedir } from "node:os";
+import * as path from "node:path";
+import { env } from "node:process";
+import { EnvironmentKey } from "./env.js";
 const getScwConfigurationDirectory = () => {
   const xdgConfigPath = env.XDG_CONFIG_HOME;
-  if (typeof xdgConfigPath === 'string' && xdgConfigPath.length > 0) {
-    return path.join(xdgConfigPath, 'scw');
+  if (typeof xdgConfigPath === "string" && xdgConfigPath.length > 0) {
+    return path.join(xdgConfigPath, "scw");
   }
-  return path.join(homedir(), '.config', 'scw');
+  return path.join(homedir(), ".config", "scw");
 };
-
-/**
- * Gets the configuration file path.
- *
- * @returns The path to the configuration file
- *
- * @internal
- */
 const resolveConfigurationFilePath = () => {
-  // Try path defined by user in env variables
   const envFilePath = env[EnvironmentKey.ScwConfigPath];
-  if (typeof envFilePath === 'string' && envFilePath.length > 0) {
+  if (typeof envFilePath === "string" && envFilePath.length > 0) {
     return envFilePath;
   }
-
-  // or fallback on the default path
-  return path.join(getScwConfigurationDirectory(), 'config.yaml');
+  return path.join(getScwConfigurationDirectory(), "config.yaml");
+};
+export {
+  getScwConfigurationDirectory,
+  resolveConfigurationFilePath
 };
-
-export { getScwConfigurationDirectory, resolveConfigurationFilePath };

package/dist/types.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Profile contains information to help instanciating the Scaleway client.
+ *
+ * @public
+ */
+export 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}
+     */
+    accessKey?: string;
+    /**
+     * APIURL overrides the API URL of the Scaleway API to the given URL.
+     * Change that if you want to direct requests to a different endpoint.
+     *
+     * @defaultValue `https://api.scaleway.com`
+     */
+    apiURL?: string;
+    /**
+     * Your organization ID is the identifier of your account inside Scaleway infrastructure.
+     */
+    defaultOrganizationId?: string;
+    /**
+     * Your project ID is the identifier of the project your resources are attached to.
+     */
+    defaultProjectId?: string;
+    /**
+     * A region is represented as a geographical area such as France (Paris) or the Netherlands (Amsterdam).
+     * It can contain multiple availability zones.
+     *
+     * Examples: fr-par, nl-ams.
+     */
+    defaultRegion?: string;
+    /**
+     * A region can be split into many availability zones (AZ).
+     * Latency between multiple AZ of the same region are low as they have a common network layer.
+     *
+     * Examples: fr-par-1, nl-ams-1
+     */
+    defaultZone?: string;
+    /**
+     * The secret key is the value that can be used to authenticate against the API (the value used in X-Auth-Token HTTP-header).
+     * The secret key MUST remain secret and not given to anyone or published online.
+     */
+    secretKey?: string;
+};
+/** Configuration type. */
+export type ConfigurationType = Record<string, Record<string, string>>;
+/** Parameters to load the all the profiles from the configuration file */
+export type AllProfilesFromFileParams = {
+    /**
+     * The path at which to locate the configuration file.
+     *
+     * Defaults to the value of the `SCW_CONFIG_PATH` environment variable
+     * or `~/.scw/config` otherwise.
+     */
+    filepath?: string;
+};
+/** Parameters to load the profile from the configuration file */
+export type ProfileFromFileParams = AllProfilesFromFileParams & {
+    /**
+     * Name of the profile to load.
+     *
+     * @defaultValue `default`
+     * */
+    profileName?: string;
+};

package/dist/yml-loader.cjs

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const fs = require("fs");
+const STRIP_COMMENT_REGEX = /(^|\s)[;#]/;
+const DETECT_SECTION_REGEX = /^\s*([^]+):\s*$/;
+const DETECT_ITEM_REGEX = /^\s*(.+?)\s*:\s*(.+?)\s*$/;
+const convertYamlToConfiguration = (input) => {
+  let foundProfilesKey = false;
+  let currentSection = "default";
+  const map = {};
+  if (typeof input !== "string") {
+    return map;
+  }
+  input.split(/\r?\n/).forEach((rawLine) => {
+    const line = rawLine.split(STRIP_COMMENT_REGEX)[0];
+    const newSection = DETECT_SECTION_REGEX.exec(line);
+    if (newSection) {
+      currentSection = void 0;
+      if (newSection[1] === "profiles") {
+        foundProfilesKey = true;
+      } else if (foundProfilesKey) {
+        [, currentSection] = newSection;
+      }
+    } else if (currentSection) {
+      const item = DETECT_ITEM_REGEX.exec(line);
+      if (item) {
+        if (typeof map[currentSection] !== "object") {
+          map[currentSection] = {};
+        }
+        [, , map[currentSection][item[1]]] = item;
+      }
+    }
+  });
+  return map;
+};
+const loadConfigurationFromFile = (filePath) => {
+  const fileContent = fs.readFileSync(filePath, "utf-8");
+  return convertYamlToConfiguration(fileContent);
+};
+exports.convertYamlToConfiguration = convertYamlToConfiguration;
+exports.loadConfigurationFromFile = loadConfigurationFromFile;

package/dist/yml-loader.d.ts

@@ -0,0 +1,22 @@
+import type { ConfigurationType } from './types';
+/**
+ * Converts YAML to configuration map.
+ *
+ * @param input - YAML string
+ * @returns The configuration map
+ *
+ * @internal
+ */
+export declare const convertYamlToConfiguration: (input: string | null) => ConfigurationType;
+/**
+ * Loads configuration from a file.
+ *
+ * @param filePath - Path to the configuration file
+ * @returns The configuration
+ *
+ * @throws Error
+ * Thrown if the file doesn't exist.
+ *
+ * @internal
+ */
+export declare const loadConfigurationFromFile: (filePath: string) => ConfigurationType;

package/dist/yml-loader.js

@@ -1,67 +1,41 @@
-import { readFileSync } from 'fs';
-
+import { readFileSync } from "fs";
 const STRIP_COMMENT_REGEX = /(^|\s)[;#]/;
 const DETECT_SECTION_REGEX = /^\s*([^]+):\s*$/;
 const DETECT_ITEM_REGEX = /^\s*(.+?)\s*:\s*(.+?)\s*$/;
-
-/**
- * Converts YAML to configuration map.
- *
- * @param input - YAML string
- * @returns The configuration map
- *
- * @internal
- */
-const convertYamlToConfiguration = input => {
+const convertYamlToConfiguration = (input) => {
   let foundProfilesKey = false;
-  let currentSection = 'default';
+  let currentSection = "default";
   const map = {};
-  if (typeof input !== 'string') {
+  if (typeof input !== "string") {
     return map;
   }
-  input.split(/\r?\n/).forEach(rawLine => {
-    // remove comments
+  input.split(/\r?\n/).forEach((rawLine) => {
     const line = rawLine.split(STRIP_COMMENT_REGEX)[0];
-    // parse sections
     const newSection = DETECT_SECTION_REGEX.exec(line);
     if (newSection) {
-      currentSection = undefined;
-      if (newSection[1] === 'profiles') {
+      currentSection = void 0;
+      if (newSection[1] === "profiles") {
         foundProfilesKey = true;
       } else if (foundProfilesKey) {
         [, currentSection] = newSection;
       }
-    }
-    // parse items
-    else if (currentSection) {
+    } else if (currentSection) {
       const item = DETECT_ITEM_REGEX.exec(line);
       if (item) {
-        if (typeof map[currentSection] !== 'object') {
+        if (typeof map[currentSection] !== "object") {
           map[currentSection] = {};
         }
-        [,, map[currentSection][item[1]]] = item;
+        [, , map[currentSection][item[1]]] = item;
       }
     }
   });
   return map;
 };
-
-/**
- * Loads configuration from a file.
- *
- * @param filePath - Path to the configuration file
- * @returns The configuration
- *
- * @throws Error
- * Thrown if the file doesn't exist.
- *
- * @internal
- */
-const loadConfigurationFromFile = filePath => {
-  // `readFileSync` returns a string when encoding option is specified.
-  // {@link https://nodejs.org/api/fs.html#fs_fs_readfilesync_path_options}
-  const fileContent = readFileSync(filePath, 'utf-8');
+const loadConfigurationFromFile = (filePath) => {
+  const fileContent = readFileSync(filePath, "utf-8");
   return convertYamlToConfiguration(fileContent);
 };
-
-export { convertYamlToConfiguration, loadConfigurationFromFile };
+export {
+  convertYamlToConfiguration,
+  loadConfigurationFromFile
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/configuration-loader",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "license": "Apache-2.0",
   "description": "Load configuration via file or environment for NodeJS.",
   "main": "dist/index.cjs",
@@ -18,8 +18,14 @@
     "node": ">=14.13"
   },
   "type": "module",
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "type:generate": "tsc --declaration -p tsconfig.build.json",
+    "build": "vite build --config ../../vite.config.ts && pnpm run type:generate",
+    "build:profile": "npx vite-bundle-visualizer -c ../../vite.config.ts"
+  },
   "devDependencies": {
     "@types/node": "18.11.18"
   },
-  "gitHead": "9c45a5e1754dd35cc4d5a502f99bbbaff6ed7ba4"
+  "gitHead": "a7d80e98eaa7977ce6ac697f3003823972f5c52f"
 }

package/tsconfig.build.json

@@ -0,0 +1,18 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noEmit": false,
+    "emitDeclarationOnly": true,
+    "rootDir": "src",
+    "outDir": "dist",
+    "skipLibCheck": true
+  },
+  "exclude": [
+    "dist/*",
+    "*.config.ts",
+    "*.setup.ts",
+    "**/__tests__",
+    "**/__mocks__",
+    "src/**/*.test.tsx"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["src/**/*.ts", "src/**/*.tsx", "*.config.ts"]
+}