@scaleway/sdk 2.26.0 → 2.28.0

package/dist/scw/auth.js

@@ -1,67 +1,28 @@
-import { addAsyncHeaderInterceptor, addHeaderInterceptor } from '../internal/interceptors/helpers.js';
-import { assertValidAuthenticationSecrets } from './client-ini-profile.js';
-
-const SESSION_HEADER_KEY = 'x-session-token';
-const AUTH_HEADER_KEY = 'x-auth-token';
-/**
- * Authenticates with a session token.
- *
- * @param getToken - The token accessor
- * @returns The request interceptor
- *
- * @deprecated Please use addAsyncHeaderInterceptor instead.
- *
- * @internal
- */
-const authenticateWithSessionToken = getToken => addAsyncHeaderInterceptor(SESSION_HEADER_KEY, getToken);
-
-/**
- * Authenticates with a secrets.
- *
- * @param getToken - The secrets
- * @returns The request interceptor
- *
- * @throws Error
- * Thrown if the secrets are invalid.
- *
- * @internal
- */
-const authenticateWithSecrets = secrets => {
+import { addAsyncHeaderInterceptor, addHeaderInterceptor } from "../internal/interceptors/helpers.js";
+import { assertValidAuthenticationSecrets } from "./client-ini-profile.js";
+const SESSION_HEADER_KEY = "x-session-token";
+const AUTH_HEADER_KEY = "x-auth-token";
+const authenticateWithSessionToken = (getToken) => addAsyncHeaderInterceptor(SESSION_HEADER_KEY, getToken);
+const authenticateWithSecrets = (secrets) => {
   assertValidAuthenticationSecrets(secrets);
   return addHeaderInterceptor(AUTH_HEADER_KEY, secrets.secretKey);
 };
-
-/**
- * Obfuscates a token.
- *
- * @param key - The token
- * @returns The obfuscated token
- *
- * @internal
- */
-const obfuscateToken = key => `${key.substring(0, 5)}xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`;
-
-/**
- * Obfuscates an UUID.
- *
- * @param key - The UUID
- * @returns The obfuscated UUID
- *
- * @internal
- */
-const obfuscateUUID = key => `${key.substring(0, 8)}-xxxx-xxxx-xxxx-xxxxxxxxxxxx`;
-/**
- * Obfuscates headers entry.
- *
- * @param array - The header entry
- * @returns The obfuscated entry
- *
- * @internal
- */
-const obfuscateAuthHeadersEntry = ([name, value]) => {
-  if (name === SESSION_HEADER_KEY) return [name, obfuscateToken(value)];
-  if (name === AUTH_HEADER_KEY) return [name, obfuscateUUID(value)];
+const obfuscateToken = (key) => `${key.substring(0, 5)}xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`;
+const obfuscateUUID = (key) => `${key.substring(0, 8)}-xxxx-xxxx-xxxx-xxxxxxxxxxxx`;
+const obfuscateAuthHeadersEntry = ([
+  name,
+  value
+]) => {
+  if (name === SESSION_HEADER_KEY)
+    return [name, obfuscateToken(value)];
+  if (name === AUTH_HEADER_KEY)
+    return [name, obfuscateUUID(value)];
   return [name, value];
 };
-
-export { authenticateWithSecrets, authenticateWithSessionToken, obfuscateAuthHeadersEntry, obfuscateToken, obfuscateUUID };
+export {
+  authenticateWithSecrets,
+  authenticateWithSessionToken,
+  obfuscateAuthHeadersEntry,
+  obfuscateToken,
+  obfuscateUUID
+};

package/dist/scw/client-ini-factory.cjs

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const auth = require("./auth.cjs");
+const clientIniProfile = require("./client-ini-profile.cjs");
+const withProfile = (profile) => (settings) => {
+  const newSettings = { ...settings };
+  if (profile.apiURL) {
+    newSettings.apiURL = profile.apiURL;
+  }
+  if (profile.defaultOrganizationId) {
+    newSettings.defaultOrganizationId = profile.defaultOrganizationId;
+  }
+  if (profile.defaultProjectId) {
+    newSettings.defaultProjectId = profile.defaultProjectId;
+  }
+  if (profile.defaultRegion) {
+    newSettings.defaultRegion = profile.defaultRegion;
+  }
+  if (profile.defaultZone) {
+    newSettings.defaultZone = profile.defaultZone;
+  }
+  if (clientIniProfile.hasAuthenticationSecrets(profile)) {
+    newSettings.interceptors = [
+      {
+        request: auth.authenticateWithSecrets(profile)
+      },
+      ...newSettings.interceptors
+    ];
+  }
+  return newSettings;
+};
+const withHTTPClient = (httpClient) => (settings) => ({ ...settings, httpClient });
+const withDefaultPageSize = (defaultPageSize) => (settings) => ({ ...settings, defaultPageSize });
+const withUserAgent = (userAgent) => (settings) => ({ ...settings, userAgent });
+const withUserAgentSuffix = (userAgent) => (settings) => ({
+  ...settings,
+  userAgent: settings.userAgent ? `${settings.userAgent} ${userAgent}` : userAgent
+});
+const withAdditionalInterceptors = (interceptors) => (settings) => ({
+  ...settings,
+  interceptors: settings.interceptors.concat(interceptors)
+});
+const withLegacyInterceptors = () => (settings) => {
+  if (!settings.requestInterceptors && !settings.responseInterceptors) {
+    return settings;
+  }
+  const allInterceptors = settings.interceptors.concat(
+    (settings.requestInterceptors ?? []).map((obj) => ({
+      request: obj
+    })),
+    (settings.responseInterceptors ?? []).map((obj) => ({
+      response: obj
+    }))
+  );
+  return {
+    ...settings,
+    interceptors: allInterceptors
+  };
+};
+exports.withAdditionalInterceptors = withAdditionalInterceptors;
+exports.withDefaultPageSize = withDefaultPageSize;
+exports.withHTTPClient = withHTTPClient;
+exports.withLegacyInterceptors = withLegacyInterceptors;
+exports.withProfile = withProfile;
+exports.withUserAgent = withUserAgent;
+exports.withUserAgentSuffix = withUserAgentSuffix;

package/dist/scw/client-ini-factory.d.ts

@@ -0,0 +1,111 @@
+import type { NetworkInterceptors } from '../index';
+import type { Profile } from './client-ini-profile';
+import type { Settings } from './client-settings';
+/**
+ * A factory to build {@link Settings}.
+ *
+ * @public
+ */
+export type ClientConfig = (obj: Settings) => Settings;
+/**
+ * Instantiates the SDK from a configuration {@link Profile}.
+ *
+ * @param profile - The profile
+ * @returns A factory {@link ClientConfig}
+ *
+ * @remarks This method should be used in conjunction with the initializer `createAdvancedClient`.
+ *
+ * @public
+ */
+export declare const withProfile: (profile: Readonly<Profile>) => (settings: Readonly<Settings>) => Settings;
+/**
+ * Instantiates the SDK with a different HTTP client.
+ *
+ * @param httpClient - A fetch compatible HTTP client
+ * @returns A factory {@link ClientConfig}
+ *
+ * @remarks This method should be used in conjunction with the initializer `createAdvancedClient`.
+ *
+ * @public
+ */
+export declare const withHTTPClient: (httpClient: typeof fetch) => (settings: Readonly<Settings>) => Settings;
+/**
+ * Instantiates the SDK with a default page size.
+ *
+ * @param defaultPageSize - The default page size
+ * @returns A factory {@link ClientConfig}
+ *
+ * @remarks This method should be used in conjunction with the initializer `createAdvancedClient`.
+ *
+ * @public
+ */
+export declare const withDefaultPageSize: (defaultPageSize: number) => ClientConfig;
+/**
+ * Instantiates the SDK with a different default user agent.
+ *
+ * @param userAgent - The default user agent
+ * @returns A factory {@link ClientConfig}
+ *
+ * @remarks This method should be used in conjunction with the initializer `createAdvancedClient`.
+ *
+ * @public
+ */
+export declare const withUserAgent: (userAgent: string) => (settings: Readonly<Settings>) => Settings;
+/**
+ * Instantiates the SDK with an additional user agent.
+ *
+ * @param userAgent - The suffix to append to default user agent
+ * @returns A factory {@link ClientConfig}
+ *
+ * @remarks This method should be used in conjunction with the initializer `createAdvancedClient`.
+ *
+ * @public
+ */
+export declare const withUserAgentSuffix: (userAgent: string) => (settings: Readonly<Settings>) => Settings;
+/**
+ * Instantiates the SDK with additional interceptors.
+ *
+ * @param interceptors - The additional {@link NetworkInterceptors} interceptors
+ * @returns A factory {@link ClientConfig}
+ *
+ * @remarks
+ * It doesn't override the existing interceptors, but instead push more to the list.
+ * This method should be used in conjunction with the initializer `createAdvancedClient`.
+ *
+ * @example
+ * ```
+ * withAdditionalInterceptors([
+ *   {
+ *     request: ({ request }) => {
+ *       console.log(`Do something with ${JSON.stringify(request)}`)
+ *       return request
+ *     },
+ *     response: ({ response }) => {
+ *       console.log(`Do something with ${JSON.stringify(response)}`)
+ *       return response
+ *     },
+ *     responseError: async ({
+ *       request,
+ *       error,
+ *     }: {
+ *       request: Request
+ *       error: unknown
+ *     }) => {
+ *       console.log(
+ *         `Do something with ${JSON.stringify(request)} and ${JSON.stringify(
+ *           error,
+ *         )}`,
+ *       )
+ *       throw error // or return Promise.resolve(someData)
+ *     },
+ *   },
+ * ])
+ * ```
+ *
+ * @public
+ */
+export declare const withAdditionalInterceptors: (interceptors: NetworkInterceptors[]) => (settings: Readonly<Settings>) => Settings;
+/**
+ * Instantiates the SDK with legacy interceptors.
+ */
+export declare const withLegacyInterceptors: () => (settings: Readonly<Settings>) => Settings;

package/dist/scw/client-ini-factory.js

@@ -1,26 +1,7 @@
-import { authenticateWithSecrets } from './auth.js';
-import { hasAuthenticationSecrets } from './client-ini-profile.js';
-
-/**
- * A factory to build {@link Settings}.
- *
- * @public
- */
-
-/**
- * Instantiates the SDK from a configuration {@link Profile}.
- *
- * @param profile - The profile
- * @returns A factory {@link ClientConfig}
- *
- * @remarks This method should be used in conjunction with the initializer `createAdvancedClient`.
- *
- * @public
- */
-const withProfile = profile => settings => {
-  const newSettings = {
-    ...settings
-  };
+import { authenticateWithSecrets } from "./auth.js";
+import { hasAuthenticationSecrets } from "./client-ini-profile.js";
+const withProfile = (profile) => (settings) => {
+  const newSettings = { ...settings };
   if (profile.apiURL) {
     newSettings.apiURL = profile.apiURL;
   }
@@ -37,138 +18,49 @@ const withProfile = profile => settings => {
     newSettings.defaultZone = profile.defaultZone;
   }
   if (hasAuthenticationSecrets(profile)) {
-    newSettings.interceptors = [{
-      request: authenticateWithSecrets(profile)
-    }, ...newSettings.interceptors];
+    newSettings.interceptors = [
+      {
+        request: authenticateWithSecrets(profile)
+      },
+      ...newSettings.interceptors
+    ];
   }
   return newSettings;
 };
-
-/**
- * Instantiates the SDK with a different HTTP client.
- *
- * @param httpClient - A fetch compatible HTTP client
- * @returns A factory {@link ClientConfig}
- *
- * @remarks This method should be used in conjunction with the initializer `createAdvancedClient`.
- *
- * @public
- */
-const withHTTPClient = httpClient => settings => ({
-  ...settings,
-  httpClient
-});
-
-/**
- * Instantiates the SDK with a default page size.
- *
- * @param defaultPageSize - The default page size
- * @returns A factory {@link ClientConfig}
- *
- * @remarks This method should be used in conjunction with the initializer `createAdvancedClient`.
- *
- * @public
- */
-const withDefaultPageSize = defaultPageSize => settings => ({
-  ...settings,
-  defaultPageSize
-});
-
-/**
- * Instantiates the SDK with a different default user agent.
- *
- * @param userAgent - The default user agent
- * @returns A factory {@link ClientConfig}
- *
- * @remarks This method should be used in conjunction with the initializer `createAdvancedClient`.
- *
- * @public
- */
-const withUserAgent = userAgent => settings => ({
-  ...settings,
-  userAgent
-});
-
-/**
- * Instantiates the SDK with an additional user agent.
- *
- * @param userAgent - The suffix to append to default user agent
- * @returns A factory {@link ClientConfig}
- *
- * @remarks This method should be used in conjunction with the initializer `createAdvancedClient`.
- *
- * @public
- */
-const withUserAgentSuffix = userAgent => settings => ({
+const withHTTPClient = (httpClient) => (settings) => ({ ...settings, httpClient });
+const withDefaultPageSize = (defaultPageSize) => (settings) => ({ ...settings, defaultPageSize });
+const withUserAgent = (userAgent) => (settings) => ({ ...settings, userAgent });
+const withUserAgentSuffix = (userAgent) => (settings) => ({
   ...settings,
   userAgent: settings.userAgent ? `${settings.userAgent} ${userAgent}` : userAgent
 });
-
-/**
- * Instantiates the SDK with additional interceptors.
- *
- * @param interceptors - The additional {@link NetworkInterceptors} interceptors
- * @returns A factory {@link ClientConfig}
- *
- * @remarks
- * It doesn't override the existing interceptors, but instead push more to the list.
- * This method should be used in conjunction with the initializer `createAdvancedClient`.
- *
- * @example
- * ```
- * withAdditionalInterceptors([
- *   {
- *     request: ({ request }) => {
- *       console.log(`Do something with ${JSON.stringify(request)}`)
- *       return request
- *     },
- *     response: ({ response }) => {
- *       console.log(`Do something with ${JSON.stringify(response)}`)
- *       return response
- *     },
- *     responseError: async ({
- *       request,
- *       error,
- *     }: {
- *       request: Request
- *       error: unknown
- *     }) => {
- *       console.log(
- *         `Do something with ${JSON.stringify(request)} and ${JSON.stringify(
- *           error,
- *         )}`,
- *       )
- *       throw error // or return Promise.resolve(someData)
- *     },
- *   },
- * ])
- * ```
- *
- * @public
- */
-const withAdditionalInterceptors = interceptors => settings => ({
+const withAdditionalInterceptors = (interceptors) => (settings) => ({
   ...settings,
   interceptors: settings.interceptors.concat(interceptors)
 });
-
-/**
- * Instantiates the SDK with legacy interceptors.
- */
-/* eslint-disable deprecation/deprecation */
-const withLegacyInterceptors = () => settings => {
+const withLegacyInterceptors = () => (settings) => {
   if (!settings.requestInterceptors && !settings.responseInterceptors) {
     return settings;
   }
-  const allInterceptors = settings.interceptors.concat((settings.requestInterceptors ?? []).map(obj => ({
-    request: obj
-  })), (settings.responseInterceptors ?? []).map(obj => ({
-    response: obj
-  })));
+  const allInterceptors = settings.interceptors.concat(
+    (settings.requestInterceptors ?? []).map((obj) => ({
+      request: obj
+    })),
+    (settings.responseInterceptors ?? []).map((obj) => ({
+      response: obj
+    }))
+  );
   return {
     ...settings,
     interceptors: allInterceptors
   };
 };
-/* eslint-enable deprecation/deprecation */
-
-export { withAdditionalInterceptors, withDefaultPageSize, withHTTPClient, withLegacyInterceptors, withProfile, withUserAgent, withUserAgentSuffix };
+export {
+  withAdditionalInterceptors,
+  withDefaultPageSize,
+  withHTTPClient,
+  withLegacyInterceptors,
+  withProfile,
+  withUserAgent,
+  withUserAgentSuffix
+};

package/dist/scw/client-ini-profile.cjs

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const stringValidation = require("../internal/validations/string-validation.cjs");
+const hasAuthenticationSecrets = (obj) => typeof obj.accessKey === "string" && obj.accessKey !== "" && typeof obj.secretKey === "string" && obj.secretKey !== "";
+function assertValidAuthenticationSecrets(obj) {
+  if (!(obj.accessKey && obj.secretKey)) {
+    throw new Error(
+      `Invalid secrets, accessKey & secretKey must be defined. See https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/`
+    );
+  }
+  if (!stringValidation.isAccessKey(obj.accessKey)) {
+    throw new Error(
+      `Invalid access key format '${obj.accessKey}', expected SCWXXXXXXXXXXXXXXXXX format. See https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/`
+    );
+  }
+  if (!stringValidation.isSecretKey(obj.secretKey)) {
+    throw new Error(
+      `Invalid secret key format '${obj.secretKey}', expected a UUID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. See https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/`
+    );
+  }
+}
+exports.assertValidAuthenticationSecrets = assertValidAuthenticationSecrets;
+exports.hasAuthenticationSecrets = hasAuthenticationSecrets;

package/dist/scw/client-ini-profile.d.ts

@@ -0,0 +1,82 @@
+import type { Region, Zone } from './locality';
+/**
+ * Holds access key and secret key.
+ *
+ * @public
+ */
+export interface AuthenticationSecrets {
+    /**
+     * You need an access key and a secret key to connect to Scaleway API.
+     * Generate your access key at the following address: {@link https://console.scaleway.com/project/credentials}.
+     */
+    accessKey: 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.
+     * Generate your secret key at the following address: {@link https://console.scaleway.com/project/credentials}.
+     */
+    secretKey: string;
+}
+/**
+ * Holds default values of a Scaleway profile.
+ *
+ * @public
+ */
+export interface ProfileDefaultValues {
+    /**
+     * 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?: Region;
+    /**
+     * 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?: Zone;
+}
+/**
+ * Holds values of a Scaleway profile.
+ *
+ * @public
+ */
+export type Profile = Partial<ProfileDefaultValues & AuthenticationSecrets>;
+/**
+ * Verifies that the payload contains both the accessKey and the secretKey.
+ *
+ * @param obj - The secrets
+ * @returns Whether the secrets are not empty.
+ *
+ * @internal
+ */
+export declare const hasAuthenticationSecrets: (obj: Partial<AuthenticationSecrets>) => obj is AuthenticationSecrets;
+/**
+ * Asserts the format of secrets.
+ *
+ * @param obj - The secrets
+ * @returns Whether the secrets use a valid format
+ *
+ * @throws Error
+ * Thrown if either the accessKey or the secretKey has en invalid format.
+ *
+ * @internal
+ */
+export declare function assertValidAuthenticationSecrets(obj: Partial<AuthenticationSecrets>): asserts obj is AuthenticationSecrets;

package/dist/scw/client-ini-profile.js

@@ -1,54 +1,23 @@
-import { isAccessKey, isSecretKey } from '../internal/validations/string-validation.js';
-
-/**
- * Holds access key and secret key.
- *
- * @public
- */
-
-/**
- * Holds default values of a Scaleway profile.
- *
- * @public
- */
-
-/**
- * Holds values of a Scaleway profile.
- *
- * @public
- */
-
-/**
- * Verifies that the payload contains both the accessKey and the secretKey.
- *
- * @param obj - The secrets
- * @returns Whether the secrets are not empty.
- *
- * @internal
- */
-const hasAuthenticationSecrets = obj => typeof obj.accessKey === 'string' && obj.accessKey !== '' && typeof obj.secretKey === 'string' && obj.secretKey !== '';
-
-/**
- * Asserts the format of secrets.
- *
- * @param obj - The secrets
- * @returns Whether the secrets use a valid format
- *
- * @throws Error
- * Thrown if either the accessKey or the secretKey has en invalid format.
- *
- * @internal
- */
+import { isAccessKey, isSecretKey } from "../internal/validations/string-validation.js";
+const hasAuthenticationSecrets = (obj) => typeof obj.accessKey === "string" && obj.accessKey !== "" && typeof obj.secretKey === "string" && obj.secretKey !== "";
 function assertValidAuthenticationSecrets(obj) {
   if (!(obj.accessKey && obj.secretKey)) {
-    throw new Error(`Invalid secrets, accessKey & secretKey must be defined. See https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/`);
+    throw new Error(
+      `Invalid secrets, accessKey & secretKey must be defined. See https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/`
+    );
   }
   if (!isAccessKey(obj.accessKey)) {
-    throw new Error(`Invalid access key format '${obj.accessKey}', expected SCWXXXXXXXXXXXXXXXXX format. See https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/`);
+    throw new Error(
+      `Invalid access key format '${obj.accessKey}', expected SCWXXXXXXXXXXXXXXXXX format. See https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/`
+    );
   }
   if (!isSecretKey(obj.secretKey)) {
-    throw new Error(`Invalid secret key format '${obj.secretKey}', expected a UUID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. See https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/`);
+    throw new Error(
+      `Invalid secret key format '${obj.secretKey}', expected a UUID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. See https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/`
+    );
   }
 }
-
-export { assertValidAuthenticationSecrets, hasAuthenticationSecrets };
+export {
+  assertValidAuthenticationSecrets,
+  hasAuthenticationSecrets
+};