@scaleway/configuration-loader 0.0.2-alpha.0

package/.npmignore

@@ -0,0 +1,6 @@
+**/__tests__/**
+examples/
+src
+.eslintrc.cjs
+!.npmignore
+CHANGELOG.md

package/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2019 Scaleway.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/config-loader.js

@@ -0,0 +1,62 @@
+import { env } from 'process';
+import { EnvironmentKey } from './env.js';
+import { resolveConfigurationFilePath } from './path-resolver.js';
+import { loadConfigurationFromFile } from './yml-loader.js';
+
+/**
+ * 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],
+  defaultOrganizationId: env[EnvironmentKey.ScwDefaultOrganizationId],
+  defaultProjectId: env[EnvironmentKey.ScwDefaultProjectId],
+  defaultRegion: env[EnvironmentKey.ScwDefaultRegion],
+  defaultZone: env[EnvironmentKey.ScwDefaultZone],
+  secretKey: env[EnvironmentKey.ScwSecretKey]
+});
+/**
+ * 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 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);
+  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
+  };
+};
+
+export { loadProfileFromConfigurationFile, loadProfileFromEnvironmentValues };

package/dist/env.js

@@ -0,0 +1,17 @@
+/**
+ * Environment Key.
+ */
+let EnvironmentKey;
+
+(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";
+})(EnvironmentKey || (EnvironmentKey = {}));
+
+export { EnvironmentKey };

package/dist/index.cjs

@@ -0,0 +1,200 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var process = require('process');
+var os = require('os');
+var path = require('path');
+var fs = require('fs');
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return 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__*/_interopNamespace(path);
+
+/**
+ * Environment Key.
+ */
+let EnvironmentKey;
+
+(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";
+})(EnvironmentKey || (EnvironmentKey = {}));
+
+/**
+ * Gets the Scaleway directory.
+ *
+ * @returns The path to the Scaleway diretory
+ *
+ * @internal
+ */
+
+const getScwConfigurationDirectory = () => {
+  const xdgConfigPath = process.env.XDG_CONFIG_HOME;
+  if (typeof xdgConfigPath === 'string' && xdgConfigPath.length > 0) return path__namespace.join(xdgConfigPath, 'scw');
+  return path__namespace.join(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 = 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 === true) {
+        [, 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);
+};
+
+/**
+ * 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 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 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);
+  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
+  };
+};
+
+exports.loadProfileFromConfigurationFile = loadProfileFromConfigurationFile;
+exports.loadProfileFromEnvironmentValues = loadProfileFromEnvironmentValues;

package/dist/index.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Profile contains information to help instanciating the Scaleway client.
+ *
+ * @public
+ */
+declare 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 profile from the configuration file */
+declare type ProfileFromFileParams = {
+    /**
+     * 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;
+    /**
+     * Name of the profile to load.
+     *
+     * @defaultValue `default`
+     * */
+    profileName?: 'default' | string;
+};
+
+/**
+ * Loads profile from environment values.
+ *
+ * @returns The profile filled with values found in the environment
+ *
+ * @public
+ */
+declare const loadProfileFromEnvironmentValues: () => 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> | undefined) => Profile;
+
+export { ProfileFromFileParams, loadProfileFromConfigurationFile, loadProfileFromEnvironmentValues };

package/dist/index.js

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

package/dist/path-resolver.js

@@ -0,0 +1,35 @@
+import { homedir } from 'os';
+import * as path from 'path';
+import { env } from 'process';
+import { EnvironmentKey } from './env.js';
+
+/**
+ * Gets the Scaleway directory.
+ *
+ * @returns The path to the Scaleway diretory
+ *
+ * @internal
+ */
+
+const getScwConfigurationDirectory = () => {
+  const xdgConfigPath = env.XDG_CONFIG_HOME;
+  if (typeof xdgConfigPath === 'string' && xdgConfigPath.length > 0) return path.join(xdgConfigPath, '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) return envFilePath; // or fallback on the default path
+
+  return path.join(getScwConfigurationDirectory(), 'config.yaml');
+};
+
+export { getScwConfigurationDirectory, resolveConfigurationFilePath };

package/dist/yml-loader.js

@@ -0,0 +1,71 @@
+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 => {
+  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 === true) {
+        [, 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 = readFileSync(filePath, 'utf-8');
+  return convertYamlToConfiguration(fileContent);
+};
+
+export { convertYamlToConfiguration, loadConfigurationFromFile };

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@scaleway/configuration-loader",
+  "version": "0.0.2-alpha.0",
+  "license": "Apache-2.0",
+  "description": "Load configuration via file or environment for NodeJS.",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "directory": "packages/configuration-loader"
+  },
+  "engines": {
+    "node": ">=14.x"
+  },
+  "type": "module",
+  "gitHead": "348ef780f8af12baa19e8c5b3c02f3087bcf0964"
+}