@scaleway/configuration-loader 2.1.0 → 2.3.0

package/.turbo/turbo-build.log

@@ -1,18 +1,23 @@
 
-> @scaleway/configuration-loader@2.1.0 build /home/runner/work/scaleway-sdk-js/scaleway-sdk-js/packages/configuration-loader
+> @scaleway/configuration-loader@2.2.0 build /home/runner/work/scaleway-sdk-js/scaleway-sdk-js/packages/configuration-loader
 > vite build --config ../../vite.config.ts && pnpm run type:generate
 
-vite v7.2.4 building ssr environment for production...
-transforming...
-✓ 5 modules transformed.
+vite v8.0.1 building ssr environment for production...
+
 rendering chunks...
-dist/index.js          0.27 kB
-dist/env.js            0.62 kB
-dist/path-resolver.js  0.75 kB
-dist/yml-loader.js     1.27 kB
-dist/config-loader.js  1.93 kB
-✓ built in 136ms
+computing gzip size...
+dist/types.js                         0.00 kB │ gzip: 0.02 kB
+dist/index.js                         0.51 kB │ gzip: 0.16 kB
+dist/env.js                           0.94 kB │ gzip: 0.41 kB
+dist/path-resolver.js                 0.96 kB │ gzip: 0.41 kB
+dist/__tests__/path-resolver.test.js  1.50 kB │ gzip: 0.57 kB
+dist/__tests__/yml-loader.test.js     2.63 kB │ gzip: 0.81 kB
+dist/yml-loader.js                    2.78 kB │ gzip: 1.09 kB
+dist/__tests__/config-loader.test.js  3.08 kB │ gzip: 1.04 kB
+dist/config-loader.js                 4.34 kB │ gzip: 0.95 kB
 
-> @scaleway/configuration-loader@2.1.0 type:generate /home/runner/work/scaleway-sdk-js/scaleway-sdk-js/packages/configuration-loader
+✓ built in 32ms
+
+> @scaleway/configuration-loader@2.2.0 type:generate /home/runner/work/scaleway-sdk-js/scaleway-sdk-js/packages/configuration-loader
 > tsc --declaration -p tsconfig.build.json
 

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# 2.3.0 (2026-04-02)
+
+### Features
+
+- **configuration-loader:** add async config loading and file permission check ([#2860](https://github.com/scaleway/scaleway-sdk-js/issues/2860)) ([1377d94](https://github.com/scaleway/scaleway-sdk-js/commit/1377d94a2a01c6a717781513affd634c7fc61b98))
+
+# 2.2.0 (2026-03-05)
+
+### Features
+
+- **sdk-react:** add react sdk ([#2794](https://github.com/scaleway/scaleway-sdk-js/issues/2794)) ([7dfbf6b](https://github.com/scaleway/scaleway-sdk-js/commit/7dfbf6b4d4eae5f95cd05ff7433e30c522619475))
+
 # 2.1.0 (2025-12-19)
 
 ### Bug Fixes

package/biome.jsonc

@@ -0,0 +1,13 @@
+{
+  "$schema": "../../node_modules/@biomejs/biome/configuration_schema.json",
+  "assist": {
+    "actions": {
+      "source": {
+        "organizeImports": "on"
+      }
+    },
+   "enabled": true
+  },
+  "extends": "//",
+  "root": false
+}

package/dist/config-loader.d.ts

@@ -32,3 +32,32 @@ export declare const loadAllProfilesFromConfigurationFile: (params?: Readonly<Al
  * @public
  */
 export declare const loadProfileFromConfigurationFile: (params?: Readonly<ProfileFromFileParams>) => Profile;
+/**
+ * Loads all profiles from configuration file (asynchronous).
+ *
+ * Non-blocking alternative to {@link loadAllProfilesFromConfigurationFile}.
+ *
+ * @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 loadAllProfilesFromConfigurationFileAsync: (params?: Readonly<AllProfilesFromFileParams>) => Promise<Record<string, Profile>>;
+/**
+ * Loads profile from configuration file (asynchronous).
+ *
+ * Non-blocking alternative to {@link loadProfileFromConfigurationFile}.
+ *
+ * @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 loadProfileFromConfigurationFileAsync: (params?: Readonly<ProfileFromFileParams>) => Promise<Profile>;

package/dist/config-loader.js

@@ -1,50 +1,112 @@
-import { env } from "node: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,
-  defaultProjectId: obj.default_project_id,
-  defaultRegion: obj.default_region,
-  defaultZone: obj.default_zone,
-  secretKey: obj.secret_key
+import { loadConfigurationFromFile, loadConfigurationFromFileAsync } from "./yml-loader.js";
+import { env } from "node:process";
+//#region src/config-loader.ts
+var 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: 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 environment values.
+*
+* @returns The profile filled with values found in the environment
+*
+* @public
+*/
+var 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]
 });
-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);
-  const result = {};
-  for (const pKey of Object.keys(configs)) {
-    result[pKey] = convertFileConfigToSDK(configs[pKey]);
-  }
-  return result;
+/**
+* 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
+*/
+var 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);
+	const result = {};
+	for (const pKey of Object.keys(configs)) result[pKey] = convertFileConfigToSDK(configs[pKey]);
+	return result;
+};
+/**
+* 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
+*/
+var 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;
 };
-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;
+/**
+* Loads all profiles from configuration file (asynchronous).
+*
+* Non-blocking alternative to {@link loadAllProfilesFromConfigurationFile}.
+*
+* @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
+*/
+var loadAllProfilesFromConfigurationFileAsync = async (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 = await loadConfigurationFromFileAsync(filePath);
+	const result = {};
+	for (const pKey of Object.keys(configs)) result[pKey] = convertFileConfigToSDK(configs[pKey]);
+	return result;
 };
-export {
-  loadAllProfilesFromConfigurationFile,
-  loadProfileFromConfigurationFile,
-  loadProfileFromEnvironmentValues
+/**
+* Loads profile from configuration file (asynchronous).
+*
+* Non-blocking alternative to {@link loadProfileFromConfigurationFile}.
+*
+* @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
+*/
+var loadProfileFromConfigurationFileAsync = async (params) => {
+	const configs = await loadAllProfilesFromConfigurationFileAsync(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;
 };
+//#endregion
+export { loadAllProfilesFromConfigurationFile, loadAllProfilesFromConfigurationFileAsync, loadProfileFromConfigurationFile, loadProfileFromConfigurationFileAsync, loadProfileFromEnvironmentValues };

package/dist/env.js

@@ -1,14 +1,28 @@
-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
-};
+//#region src/env.ts
+/**
+* Environment Key.
+*/
+var EnvironmentKey = /* @__PURE__ */ function(EnvironmentKey) {
+	/** Path to the Scaleway configuration file */
+	EnvironmentKey["ScwConfigPath"] = "SCW_CONFIG_PATH";
+	/** Scaleway access key */
+	EnvironmentKey["ScwAccessKey"] = "SCW_ACCESS_KEY";
+	/**
+	* Scaleway secret key
+	* @remarks #nosec G101
+	*/
+	EnvironmentKey["ScwSecretKey"] = "SCW_SECRET_KEY";
+	/** Scaleway API URL */
+	EnvironmentKey["ScwAPIURL"] = "SCW_API_URL";
+	/** Scaleway default organization ID */
+	EnvironmentKey["ScwDefaultOrganizationId"] = "SCW_DEFAULT_ORGANIZATION_ID";
+	/** Scaleway default project ID */
+	EnvironmentKey["ScwDefaultProjectId"] = "SCW_DEFAULT_PROJECT_ID";
+	/** Scaleway default region */
+	EnvironmentKey["ScwDefaultRegion"] = "SCW_DEFAULT_REGION";
+	/** Scaleway default zone */
+	EnvironmentKey["ScwDefaultZone"] = "SCW_DEFAULT_ZONE";
+	return EnvironmentKey;
+}({});
+//#endregion
+export { EnvironmentKey };

package/dist/index.d.ts

@@ -1,2 +1,3 @@
-export { loadAllProfilesFromConfigurationFile, loadProfileFromConfigurationFile, loadProfileFromEnvironmentValues, } from './config-loader.js';
+export { loadAllProfilesFromConfigurationFile, loadAllProfilesFromConfigurationFileAsync, loadProfileFromConfigurationFile, loadProfileFromConfigurationFileAsync, loadProfileFromEnvironmentValues, } from './config-loader.js';
 export type { AllProfilesFromFileParams, Profile, ProfileFromFileParams, } from './types.js';
+export { hasSecureFilePermissions } from './yml-loader.js';

package/dist/index.js

@@ -1,6 +1,3 @@
-import { loadAllProfilesFromConfigurationFile, loadProfileFromConfigurationFile, loadProfileFromEnvironmentValues } from "./config-loader.js";
-export {
-  loadAllProfilesFromConfigurationFile,
-  loadProfileFromConfigurationFile,
-  loadProfileFromEnvironmentValues
-};
+import { hasSecureFilePermissions } from "./yml-loader.js";
+import { loadAllProfilesFromConfigurationFile, loadAllProfilesFromConfigurationFileAsync, loadProfileFromConfigurationFile, loadProfileFromConfigurationFileAsync, loadProfileFromEnvironmentValues } from "./config-loader.js";
+export { hasSecureFilePermissions, loadAllProfilesFromConfigurationFile, loadAllProfilesFromConfigurationFileAsync, loadProfileFromConfigurationFile, loadProfileFromConfigurationFileAsync, loadProfileFromEnvironmentValues };

package/dist/path-resolver.js

@@ -1,22 +1,31 @@
+import { EnvironmentKey } from "./env.js";
 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");
-  }
-  return path.join(homedir(), ".config", "scw");
-};
-const resolveConfigurationFilePath = () => {
-  const envFilePath = env[EnvironmentKey.ScwConfigPath];
-  if (typeof envFilePath === "string" && envFilePath.length > 0) {
-    return envFilePath;
-  }
-  return path.join(getScwConfigurationDirectory(), "config.yaml");
+//#region src/path-resolver.ts
+/**
+* Gets the Scaleway directory.
+*
+* @returns The path to the Scaleway diretory
+*
+* @internal
+*/
+var 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");
 };
-export {
-  getScwConfigurationDirectory,
-  resolveConfigurationFilePath
+/**
+* Gets the configuration file path.
+*
+* @returns The path to the configuration file
+*
+* @internal
+*/
+var resolveConfigurationFilePath = () => {
+	const envFilePath = env[EnvironmentKey.ScwConfigPath];
+	if (typeof envFilePath === "string" && envFilePath.length > 0) return envFilePath;
+	return path.join(getScwConfigurationDirectory(), "config.yaml");
 };
+//#endregion
+export { getScwConfigurationDirectory, resolveConfigurationFilePath };

package/dist/yml-loader.d.ts

@@ -9,7 +9,7 @@ import type { ConfigurationType } from './types.js';
  */
 export declare const convertYamlToConfiguration: (input: string | null) => ConfigurationType;
 /**
- * Loads configuration from a file.
+ * Loads configuration from a file (synchronous).
  *
  * @param filePath - Path to the configuration file
  * @returns The configuration
@@ -20,3 +20,32 @@ export declare const convertYamlToConfiguration: (input: string | null) => Confi
  * @internal
  */
 export declare const loadConfigurationFromFile: (filePath: string) => ConfigurationType;
+/**
+ * Loads configuration from a file (asynchronous).
+ *
+ * Non-blocking alternative to {@link loadConfigurationFromFile} that avoids
+ * stalling the event loop on slow filesystems or large config files.
+ *
+ * @param filePath - Path to the configuration file
+ * @returns The configuration
+ *
+ * @throws Error
+ * Thrown if the file doesn't exist.
+ *
+ * @public
+ */
+export declare const loadConfigurationFromFileAsync: (filePath: string) => Promise<ConfigurationType>;
+/**
+ * Checks whether a configuration file has secure permissions.
+ *
+ * The Scaleway config file contains secret keys that grant full API access.
+ * On POSIX systems this function verifies the file is not readable by group
+ * or others (mode 0o600 or stricter). Returns `true` on Windows where POSIX
+ * permission bits are not meaningful.
+ *
+ * @param filePath - Path to the configuration file
+ * @returns `true` if the file has secure permissions (or on Windows)
+ *
+ * @public
+ */
+export declare const hasSecureFilePermissions: (filePath: string) => Promise<boolean>;

package/dist/yml-loader.js

@@ -1,41 +1,88 @@
-import { readFileSync } from "node:fs";
-const STRIP_COMMENT_REGEX = /(^|\s)[;#]/;
-const DETECT_SECTION_REGEX = /^\s*([\s\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;
+import { readFile, readFileSync, stat } from "node:fs";
+import { promisify } from "node:util";
+//#region src/yml-loader.ts
+var readFileAsync = promisify(readFile);
+var statAsync = promisify(stat);
+var STRIP_COMMENT_REGEX = /(^|\s)[;#]/;
+var DETECT_SECTION_REGEX = /^\s*([\s\S]+?):\s*$/;
+var DETECT_ITEM_REGEX = /^\s*(.+?)\s*:\s*(.+?)\s*$/;
+/**
+* Converts YAML to configuration map.
+*
+* @param input - YAML string
+* @returns The configuration map
+*
+* @internal
+*/
+var 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 = readFileSync(filePath, "utf-8");
-  return convertYamlToConfiguration(fileContent);
+/**
+* Loads configuration from a file (synchronous).
+*
+* @param filePath - Path to the configuration file
+* @returns The configuration
+*
+* @throws Error
+* Thrown if the file doesn't exist.
+*
+* @internal
+*/
+var loadConfigurationFromFile = (filePath) => {
+	return convertYamlToConfiguration(readFileSync(filePath, "utf-8"));
 };
-export {
-  convertYamlToConfiguration,
-  loadConfigurationFromFile
+/**
+* Loads configuration from a file (asynchronous).
+*
+* Non-blocking alternative to {@link loadConfigurationFromFile} that avoids
+* stalling the event loop on slow filesystems or large config files.
+*
+* @param filePath - Path to the configuration file
+* @returns The configuration
+*
+* @throws Error
+* Thrown if the file doesn't exist.
+*
+* @public
+*/
+var loadConfigurationFromFileAsync = async (filePath) => {
+	return convertYamlToConfiguration(await readFileAsync(filePath, "utf-8"));
 };
+/**
+* Checks whether a configuration file has secure permissions.
+*
+* The Scaleway config file contains secret keys that grant full API access.
+* On POSIX systems this function verifies the file is not readable by group
+* or others (mode 0o600 or stricter). Returns `true` on Windows where POSIX
+* permission bits are not meaningful.
+*
+* @param filePath - Path to the configuration file
+* @returns `true` if the file has secure permissions (or on Windows)
+*
+* @public
+*/
+var hasSecureFilePermissions = async (filePath) => {
+	if (process.platform === "win32") return true;
+	return ((await statAsync(filePath)).mode & 63) === 0;
+};
+//#endregion
+export { convertYamlToConfiguration, hasSecureFilePermissions, loadConfigurationFromFile, loadConfigurationFromFileAsync };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/configuration-loader",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "license": "Apache-2.0",
   "description": "Load configuration via file or environment for NodeJS.",
   "publishConfig": {
@@ -22,7 +22,7 @@
     }
   },
   "devDependencies": {
-    "@types/node": "18.19.130"
+    "@types/node": "20.19.35"
   },
   "scripts": {
     "typecheck": "tsc --noEmit",