@scaleway/configuration-loader 1.0.4 → 1.0.5

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.
 
+## [1.0.5](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/configuration-loader@1.0.4...@scaleway/configuration-loader@1.0.5) (2024-05-15)
+
+### Bug Fixes
+
+- **build:** export all types ([#1261](https://github.com/scaleway/scaleway-sdk-js/issues/1261)) ([2c13c19](https://github.com/scaleway/scaleway-sdk-js/commit/2c13c19d1699d2138d0ae9c4cf2a8a29b50d93ff))
+
 ## 1.0.4 (2024-05-06)
 
 **Note:** Version bump only for package @scaleway/configuration-loader

package/dist/types.d.ts

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

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/configuration-loader",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "license": "Apache-2.0",
   "description": "Load configuration via file or environment for NodeJS.",
   "main": "dist/index.cjs",
@@ -27,5 +27,5 @@
   "devDependencies": {
     "@types/node": "18.11.18"
   },
-  "gitHead": "454991493a602594b9a252adc2329bd3a25f5023"
+  "gitHead": "a7d80e98eaa7977ce6ac697f3003823972f5c52f"
 }