@scaleway/configuration-loader 2.2.0 → 2.3.0

package/.turbo/turbo-build.log

@@ -1,19 +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 v8.0.0-beta.16 building ssr environment for production...
-
+vite v8.0.1 building ssr environment for production...
+
 rendering chunks...
 computing gzip size...
-dist/index.js          0.26 kB │ gzip: 0.12 kB
-dist/path-resolver.js  0.89 kB │ gzip: 0.38 kB
-dist/env.js            0.90 kB │ gzip: 0.38 kB
-dist/yml-loader.js     1.40 kB │ gzip: 0.64 kB
-dist/config-loader.js  2.56 kB │ gzip: 0.81 kB
+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
 
-✓ built in 28ms
+✓ built in 32ms
 
-> @scaleway/configuration-loader@2.1.0 type:generate /home/runner/work/scaleway-sdk-js/scaleway-sdk-js/packages/configuration-loader
+> @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,12 @@
 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

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,7 +1,8 @@
 import { EnvironmentKey } from "./env.js";
 import { resolveConfigurationFilePath } from "./path-resolver.js";
-import { loadConfigurationFromFile } from "./yml-loader.js";
+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,
@@ -18,7 +19,7 @@ var convertFileConfigToSDK = (obj) => ({
 *
 * @public
 */
-const loadProfileFromEnvironmentValues = () => ({
+var loadProfileFromEnvironmentValues = () => ({
 	accessKey: env[EnvironmentKey.ScwAccessKey],
 	apiURL: env[EnvironmentKey.ScwAPIURL],
 	defaultOrganizationId: env[EnvironmentKey.ScwDefaultOrganizationId],
@@ -38,7 +39,7 @@ const loadProfileFromEnvironmentValues = () => ({
 *
 * @public
 */
-const loadAllProfilesFromConfigurationFile = (params) => {
+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);
@@ -58,11 +59,54 @@ const loadAllProfilesFromConfigurationFile = (params) => {
 *
 * @public
 */
-const loadProfileFromConfigurationFile = (params) => {
+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;
 };
-export { loadAllProfilesFromConfigurationFile, loadProfileFromConfigurationFile, loadProfileFromEnvironmentValues };
+/**
+* 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;
+};
+/**
+* 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,7 +1,8 @@
+//#region src/env.ts
 /**
 * Environment Key.
 */
-let EnvironmentKey = /* @__PURE__ */ function(EnvironmentKey) {
+var EnvironmentKey = /* @__PURE__ */ function(EnvironmentKey) {
 	/** Path to the Scaleway configuration file */
 	EnvironmentKey["ScwConfigPath"] = "SCW_CONFIG_PATH";
 	/** Scaleway access key */
@@ -23,4 +24,5 @@ let EnvironmentKey = /* @__PURE__ */ function(EnvironmentKey) {
 	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,2 +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,7 +1,8 @@
 import { EnvironmentKey } from "./env.js";
-import { env } from "node:process";
 import { homedir } from "node:os";
 import * as path from "node:path";
+import { env } from "node:process";
+//#region src/path-resolver.ts
 /**
 * Gets the Scaleway directory.
 *
@@ -9,7 +10,7 @@ import * as path from "node:path";
 *
 * @internal
 */
-const getScwConfigurationDirectory = () => {
+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");
@@ -21,9 +22,10 @@ const getScwConfigurationDirectory = () => {
 *
 * @internal
 */
-const resolveConfigurationFilePath = () => {
+var resolveConfigurationFilePath = () => {
 	const envFilePath = env[EnvironmentKey.ScwConfigPath];
 	if (typeof envFilePath === "string" && envFilePath.length > 0) return envFilePath;
 	return path.join(getScwConfigurationDirectory(), "config.yaml");
 };
-export { resolveConfigurationFilePath };
+//#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,4 +1,8 @@
-import { readFileSync } from "node:fs";
+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*$/;
@@ -10,7 +14,7 @@ var DETECT_ITEM_REGEX = /^\s*(.+?)\s*:\s*(.+?)\s*$/;
 *
 * @internal
 */
-const convertYamlToConfiguration = (input) => {
+var convertYamlToConfiguration = (input) => {
 	let foundProfilesKey = false;
 	let currentSection = "default";
 	const map = {};
@@ -33,7 +37,7 @@ const convertYamlToConfiguration = (input) => {
 	return map;
 };
 /**
-* Loads configuration from a file.
+* Loads configuration from a file (synchronous).
 *
 * @param filePath - Path to the configuration file
 * @returns The configuration
@@ -43,7 +47,42 @@ const convertYamlToConfiguration = (input) => {
 *
 * @internal
 */
-const loadConfigurationFromFile = (filePath) => {
+var loadConfigurationFromFile = (filePath) => {
 	return convertYamlToConfiguration(readFileSync(filePath, "utf-8"));
 };
-export { 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.2.0",
+  "version": "2.3.0",
   "license": "Apache-2.0",
   "description": "Load configuration via file or environment for NodeJS.",
   "publishConfig": {