@scaleway/configuration-loader 2.4.4 → 2.5.0

package/CHANGELOG.md

@@ -1,8 +1,22 @@
 # Change Log
 
+## 2.5.0
+
+### Minor Changes
+
+- update generated APIs
+
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 2.4.5 (2026-07-27)
+
+**Note:** Version bump only for package @scaleway/configuration-loader
+
+
+
+
+
 ## 2.4.4 (2026-06-29)
 
 **Note:** Version bump only for package @scaleway/configuration-loader

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/configuration-loader",
-  "version": "2.4.4",
+  "version": "2.5.0",
   "description": "Load configuration via file or environment for NodeJS.",
   "license": "Apache-2.0",
   "repository": {
@@ -19,15 +19,15 @@
     "access": "public"
   },
   "devDependencies": {
-    "@types/node": "20.19.43",
+    "@types/node": "26.1.1",
     "@repo/configs": "^0.1.1"
   },
   "engines": {
     "node": ">=20.20.2"
   },
   "scripts": {
-    "typecheck": "tsgo --noEmit",
-    "type:generate": "tsgo --declaration -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "type:generate": "tsc --declaration -p tsconfig.build.json",
     "build": "vite build --config ../../vite.config.ts && pnpm run type:generate && pnpm run copy-test-fixtures",
     "copy-test-fixtures": "mkdir -p dist/__tests__/data && cp src/__tests__/data/*.yaml dist/__tests__/data/",
     "build:profile": "npx vite-bundle-visualizer -c ../../vite.config.ts"

package/.turbo/turbo-build.log

@@ -1,27 +0,0 @@
-
-> @scaleway/configuration-loader@2.4.3 build /home/runner/work/scaleway-sdk-js/scaleway-sdk-js/packages/configuration-loader
-> vite build --config ../../vite.config.ts && pnpm run type:generate && pnpm run copy-test-fixtures
-
-vite v8.0.16 building ssr environment for production...
-
-rendering chunks...
-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.05 kB │ gzip: 1.03 kB
-dist/config-loader.js                 4.34 kB │ gzip: 0.95 kB
-
-✓ built in 30ms
-
-> @scaleway/configuration-loader@2.4.3 type:generate /home/runner/work/scaleway-sdk-js/scaleway-sdk-js/packages/configuration-loader
-> tsgo --declaration -p tsconfig.build.json
-
-
-> @scaleway/configuration-loader@2.4.3 copy-test-fixtures /home/runner/work/scaleway-sdk-js/scaleway-sdk-js/packages/configuration-loader
-> mkdir -p dist/__tests__/data && cp src/__tests__/data/*.yaml dist/__tests__/data/
-

package/dist/config-loader.d.ts

@@ -1,63 +0,0 @@
-import type { AllProfilesFromFileParams, Profile, ProfileFromFileParams } from './types.js';
-/**
- * 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;
-/**
- * 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,112 +0,0 @@
-import { EnvironmentKey } from "./env.js";
-import { resolveConfigurationFilePath } from "./path-resolver.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,
-	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
-*/
-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]
-});
-/**
-* 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;
-};
-/**
-* 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.d.ts

@@ -1,24 +0,0 @@
-/**
- * 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,28 +0,0 @@
-//#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,3 +0,0 @@
-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,3 +0,0 @@
-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.d.ts

@@ -1,16 +0,0 @@
-/**
- * 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,31 +0,0 @@
-import { EnvironmentKey } from "./env.js";
-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.
-*
-* @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");
-};
-/**
-* 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/types.d.ts

@@ -1,67 +0,0 @@
-/**
- * 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.d.ts

@@ -1,51 +0,0 @@
-import type { ConfigurationType } from './types.js';
-/**
- * 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 (synchronous).
- *
- * @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;
-/**
- * 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,88 +0,0 @@
-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;
-};
-/**
-* 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"));
-};
-/**
-* 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 };