@scaleway/configuration-loader 0.1.0-beta.7 → 1.0.1

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.1 (2024-02-05)
+
+**Note:** Version bump only for package @scaleway/configuration-loader
+
+## 1.0.0 (2023-02-21)
+
+### Features
+
+- prepare v1 release ([#454](https://github.com/scaleway/scaleway-sdk-js/issues/454)) ([57bc014](https://github.com/scaleway/scaleway-sdk-js/commit/57bc014556338ba9fa7eca2a2d4179f5ff8383be))
+
 ## 0.1.0-beta.7 (2023-01-27)
 
 ### Features

package/dist/config-loader.js

@@ -42,7 +42,7 @@ const loadProfileFromEnvironmentValues = () => ({
  * @public
  */
 const loadAllProfilesFromConfigurationFile = params => {
-  const filePath = (params == null ? void 0 : params.filepath) ?? resolveConfigurationFilePath();
+  const filePath = params?.filepath ?? resolveConfigurationFilePath();
   if (typeof filePath !== 'string' || filePath.length === 0) {
     throw new Error('Could not find the path to the configuration file.');
   }
@@ -67,7 +67,7 @@ const loadAllProfilesFromConfigurationFile = params => {
  */
 const loadProfileFromConfigurationFile = params => {
   const configs = loadAllProfilesFromConfigurationFile(params);
-  const profileName = (params == null ? void 0 : 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.`);

package/dist/env.js

@@ -1,8 +1,7 @@
 /**
  * Environment Key.
  */
-let EnvironmentKey;
-(function (EnvironmentKey) {
+let EnvironmentKey = /*#__PURE__*/function (EnvironmentKey) {
   EnvironmentKey["ScwConfigPath"] = "SCW_CONFIG_PATH";
   EnvironmentKey["ScwAccessKey"] = "SCW_ACCESS_KEY";
   EnvironmentKey["ScwSecretKey"] = "SCW_SECRET_KEY";
@@ -11,6 +10,7 @@ let EnvironmentKey;
   EnvironmentKey["ScwDefaultProjectId"] = "SCW_DEFAULT_PROJECT_ID";
   EnvironmentKey["ScwDefaultRegion"] = "SCW_DEFAULT_REGION";
   EnvironmentKey["ScwDefaultZone"] = "SCW_DEFAULT_ZONE";
-})(EnvironmentKey || (EnvironmentKey = {}));
+  return EnvironmentKey;
+}({});
 
 export { EnvironmentKey };

package/dist/index.cjs

@@ -1,8 +1,9 @@
 'use strict';
 
 var process = require('process');
-var os = require('os');
-var path = require('path');
+var node_os = require('node:os');
+var path = require('node:path');
+var node_process = require('node:process');
 var fs = require('fs');
 
 function _interopNamespaceDefault(e) {
@@ -27,8 +28,7 @@ var path__namespace = /*#__PURE__*/_interopNamespaceDefault(path);
 /**
  * Environment Key.
  */
-let EnvironmentKey;
-(function (EnvironmentKey) {
+let EnvironmentKey = /*#__PURE__*/function (EnvironmentKey) {
   EnvironmentKey["ScwConfigPath"] = "SCW_CONFIG_PATH";
   EnvironmentKey["ScwAccessKey"] = "SCW_ACCESS_KEY";
   EnvironmentKey["ScwSecretKey"] = "SCW_SECRET_KEY";
@@ -37,7 +37,8 @@ let EnvironmentKey;
   EnvironmentKey["ScwDefaultProjectId"] = "SCW_DEFAULT_PROJECT_ID";
   EnvironmentKey["ScwDefaultRegion"] = "SCW_DEFAULT_REGION";
   EnvironmentKey["ScwDefaultZone"] = "SCW_DEFAULT_ZONE";
-})(EnvironmentKey || (EnvironmentKey = {}));
+  return EnvironmentKey;
+}({});
 
 /**
  * Gets the Scaleway directory.
@@ -47,11 +48,11 @@ let EnvironmentKey;
  * @internal
  */
 const getScwConfigurationDirectory = () => {
-  const xdgConfigPath = process.env.XDG_CONFIG_HOME;
+  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(os.homedir(), '.config', 'scw');
+  return path__namespace.join(node_os.homedir(), '.config', 'scw');
 };
 
 /**
@@ -63,7 +64,7 @@ const getScwConfigurationDirectory = () => {
  */
 const resolveConfigurationFilePath = () => {
   // Try path defined by user in env variables
-  const envFilePath = process.env[EnvironmentKey.ScwConfigPath];
+  const envFilePath = node_process.env[EnvironmentKey.ScwConfigPath];
   if (typeof envFilePath === 'string' && envFilePath.length > 0) {
     return envFilePath;
   }
@@ -77,9 +78,9 @@ const DETECT_SECTION_REGEX = /^\s*([^]+):\s*$/;
 const DETECT_ITEM_REGEX = /^\s*(.+?)\s*:\s*(.+?)\s*$/;
 
 /**
- * Converts Yaml to configuration map.
+ * Converts YAML to configuration map.
  *
- * @param input - Yaml string
+ * @param input - YAML string
  * @returns The configuration map
  *
  * @internal

package/dist/index.d.ts

@@ -4,65 +4,66 @@
  * @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;
-};
+  /**
+   * 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;
-};
+  /**
+   * 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?: 'default' | string;
-};
+  /**
+   * Name of the profile to load.
+   *
+   * @defaultValue `default`
+   * */
+  profileName?: 'default' | string
+}
 
 /**
  * Loads profile from environment values.
@@ -98,4 +99,4 @@ declare const loadAllProfilesFromConfigurationFile: (params?: Readonly<AllProfil
  */
 declare const loadProfileFromConfigurationFile: (params?: Readonly<ProfileFromFileParams>) => Profile;
 
-export { AllProfilesFromFileParams, Profile, ProfileFromFileParams, loadAllProfilesFromConfigurationFile, loadProfileFromConfigurationFile, loadProfileFromEnvironmentValues };
+export { type AllProfilesFromFileParams, type Profile, type ProfileFromFileParams, loadAllProfilesFromConfigurationFile, loadProfileFromConfigurationFile, loadProfileFromEnvironmentValues };

package/dist/path-resolver.js

@@ -1,6 +1,6 @@
-import { homedir } from 'os';
-import * as path from 'path';
-import { env } from 'process';
+import { homedir } from 'node:os';
+import * as path from 'node:path';
+import { env } from 'node:process';
 import { EnvironmentKey } from './env.js';
 
 /**

package/dist/yml-loader.js

@@ -5,9 +5,9 @@ const DETECT_SECTION_REGEX = /^\s*([^]+):\s*$/;
 const DETECT_ITEM_REGEX = /^\s*(.+?)\s*:\s*(.+?)\s*$/;
 
 /**
- * Converts Yaml to configuration map.
+ * Converts YAML to configuration map.
  *
- * @param input - Yaml string
+ * @param input - YAML string
  * @returns The configuration map
  *
  * @internal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/configuration-loader",
-  "version": "0.1.0-beta.7",
+  "version": "1.0.1",
   "license": "Apache-2.0",
   "description": "Load configuration via file or environment for NodeJS.",
   "main": "dist/index.cjs",
@@ -21,5 +21,5 @@
   "devDependencies": {
     "@types/node": "^18.11.18"
   },
-  "gitHead": "d58e6175a5b8b8a3727097710b2ebcee012f924b"
+  "gitHead": "be0ae25435fdaf070491fd28121cfe844d907b10"
 }