@scaleway/sdk-client 2.1.0 → 2.2.0

package/dist/internal/logger/index.js

@@ -1,12 +1,28 @@
 import { ConsoleLogger } from "./console-logger.js";
-let sdkLogger = new ConsoleLogger("silent");
+var sdkLogger = new ConsoleLogger("silent");
+/**
+* Sets a logger to be used within the SDK.
+*
+* @param logger - The Logger instance
+*
+* @public
+*/
 const setLogger = (logger) => {
-  sdkLogger = logger;
+	sdkLogger = logger;
 };
+/**
+* Sets the logger to console logger with given logLevel (log is disabled by default).
+*
+* @param logLevel - The Log level (default to 'warn')
+* @param prefix - A Log message prefix (default to 'scaleway-sdk-js:')
+*
+* @public
+*/
 const enableConsoleLogger = (logLevel = "warn", prefix = "scaleway-sdk-js:") => setLogger(new ConsoleLogger(logLevel, prefix));
+/**
+* Returns the active SDK logger.
+*
+* @internal
+*/
 const getLogger = () => sdkLogger;
-export {
-  enableConsoleLogger,
-  getLogger,
-  setLogger
-};
+export { enableConsoleLogger, getLogger, setLogger };

package/dist/internal/logger/level-resolver.js

@@ -1,13 +1,10 @@
-var LevelResolver = /* @__PURE__ */ ((LevelResolver2) => {
-  LevelResolver2[LevelResolver2["silent"] = 0] = "silent";
-  LevelResolver2[LevelResolver2["error"] = 1] = "error";
-  LevelResolver2[LevelResolver2["warn"] = 2] = "warn";
-  LevelResolver2[LevelResolver2["info"] = 3] = "info";
-  LevelResolver2[LevelResolver2["debug"] = 4] = "debug";
-  return LevelResolver2;
-})(LevelResolver || {});
+let LevelResolver = /* @__PURE__ */ function(LevelResolver) {
+	LevelResolver[LevelResolver["silent"] = 0] = "silent";
+	LevelResolver[LevelResolver["error"] = 1] = "error";
+	LevelResolver[LevelResolver["warn"] = 2] = "warn";
+	LevelResolver[LevelResolver["info"] = 3] = "info";
+	LevelResolver[LevelResolver["debug"] = 4] = "debug";
+	return LevelResolver;
+}({});
 const shouldLog = (currentLevel, level) => LevelResolver[level] <= currentLevel;
-export {
-  LevelResolver,
-  shouldLog
-};
+export { LevelResolver, shouldLog };

package/dist/internal/validations/string-validation.js

@@ -1,30 +1,29 @@
-const isAccessKeyRegex = /^SCW[A-Z0-9]{17}$/i;
-const isRegionRegex = /^[a-z]{2}-[a-z]{3}$/i;
-const isUUIDRegex = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/i;
-const isZoneRegex = /^[a-z]{2}-[a-z]{3}-[1-9]$/i;
+var isAccessKeyRegex = /^SCW[A-Z0-9]{17}$/i;
+var isRegionRegex = /^[a-z]{2}-[a-z]{3}$/i;
+var isUUIDRegex = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/i;
+var isZoneRegex = /^[a-z]{2}-[a-z]{3}-[1-9]$/i;
+/** Returns true if the given string has a valid UUID format. */
 const isUUID = (str) => isUUIDRegex.test(str);
+/** Returns true if the given string has a valid Scaleway access key format. */
 const isAccessKey = (str) => isAccessKeyRegex.test(str);
+/** Returns true if the given string has a valid Scaleway secret key format. */
 const isSecretKey = (str) => isUUID(str);
+/** Returns true if the given string has a valid Scaleway organization ID format. */
 const isOrganizationId = (str) => isUUID(str);
+/** Returns true if the given string has a valid Scaleway project ID format. */
 const isProjectId = (str) => isUUID(str);
+/** Returns true if the given string has a valid region format. */
 const isRegion = (str) => isRegionRegex.test(str);
+/** Returns true if the given string has a valid zone format. */
 const isZone = (str) => isZoneRegex.test(str);
+/** Returns true if the given string has a valid URL format and starts by `http(s):`. */
 const isURL = (str) => {
-  let url;
-  try {
-    url = new URL(str);
-  } catch {
-    return false;
-  }
-  return url.protocol === "http:" || url.protocol === "https:";
-};
-export {
-  isAccessKey,
-  isOrganizationId,
-  isProjectId,
-  isRegion,
-  isSecretKey,
-  isURL,
-  isUUID,
-  isZone
+	let url;
+	try {
+		url = new URL(str);
+	} catch {
+		return false;
+	}
+	return url.protocol === "http:" || url.protocol === "https:";
 };
+export { isAccessKey, isOrganizationId, isProjectId, isRegion, isSecretKey, isURL, isUUID, isZone };

package/dist/internals.js

@@ -0,0 +1,8 @@
+import "./helpers/json.js";
+import "./helpers/marshalling.js";
+import "./internal/async/interval-retrier.js";
+import "./internal/interceptors/helpers.js";
+import "./scw/api.js";
+import "./scw/auth.js";
+import "./scw/custom-marshalling.js";
+import "./scw/fetch/resource-paginator.js";

package/dist/package.js

@@ -0,0 +1,32 @@
+var package_default = {
+	name: "@scaleway/sdk-client",
+	version: "2.1.0",
+	license: "Apache-2.0",
+	description: "Scaleway SDK Client",
+	keywords: [
+		"scaleway",
+		"cloud",
+		"sdk",
+		"client"
+	],
+	scripts: {
+		"typecheck": "tsc --noEmit",
+		"type:generate": "tsc --declaration -p tsconfig.build.json",
+		"build": "vite build --config ../../vite.config.ts && pnpm run type:generate && tsc-alias -p tsconfig.build.json",
+		"build:profile": "npx vite-bundle-visualizer -c ../../vite.config.ts"
+	},
+	files: ["dist"],
+	publishConfig: { "access": "public" },
+	repository: {
+		"type": "git",
+		"url": "git+https://github.com/scaleway/scaleway-sdk-js",
+		"directory": "packages/client"
+	},
+	engines: { "node": ">=20.19.6" },
+	type: "module",
+	exports: { ".": {
+		"types": "./dist/index.d.ts",
+		"default": "./dist/index.js"
+	} }
+};
+export { package_default as default };

package/dist/scw/api.js

@@ -1,8 +1,11 @@
-class API {
-  constructor(client) {
-    this.client = client;
-  }
-}
-export {
-  API
+/**
+* Abstract class to instantiate API from a {@link Client}.
+*
+* @internal
+*/
+var API = class {
+	constructor(client) {
+		this.client = client;
+	}
 };
+export { API };

package/dist/scw/auth.js

@@ -1,25 +1,68 @@
 import { addAsyncHeaderInterceptor, addHeaderInterceptor } from "../internal/interceptors/helpers.js";
 import { assertValidAuthenticationSecrets } from "./client-ini-profile.js";
-import { SESSION_HEADER_KEY, AUTH_HEADER_KEY } from "./constants.js";
+import { AUTH_HEADER_KEY, SESSION_HEADER_KEY } from "./constants.js";
+/**
+* Authentication utilities for Scaleway SDK.
+*
+* Note: This file uses interface call signatures instead of shorthand function types
+* to maintain clear, documented public API signatures that are more readable in IDE
+* tooltips and generated documentation.
+*/
+/**
+* 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) => {
-  assertValidAuthenticationSecrets(secrets);
-  return addHeaderInterceptor(AUTH_HEADER_KEY, secrets.secretKey);
+	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`;
-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
+/**
+* Obfuscates headers entry.
+*
+* @param array - The header entry
+* @returns The obfuscated entry
+*
+* @internal
+*/
+const obfuscateAuthHeadersEntry = ([name, value]) => {
+	if (name === "x-session-token") return [name, obfuscateToken(value)];
+	if (name === "x-auth-token") return [name, obfuscateUUID(value)];
+	return [name, value];
 };
+export { authenticateWithSecrets, authenticateWithSessionToken, obfuscateAuthHeadersEntry };

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

@@ -1,66 +1,136 @@
-import { authenticateWithSecrets } from "./auth.js";
 import { hasAuthenticationSecrets } from "./client-ini-profile.js";
+import { authenticateWithSecrets } from "./auth.js";
+/**
+* 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 };
-  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 (hasAuthenticationSecrets(profile)) {
-    newSettings.interceptors = [
-      {
-        request: authenticateWithSecrets(profile)
-      },
-      ...newSettings.interceptors
-    ];
-  }
-  return newSettings;
+	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 (hasAuthenticationSecrets(profile)) newSettings.interceptors = [{ request: authenticateWithSecrets(profile) }, ...newSettings.interceptors];
+	return newSettings;
 };
-const withHTTPClient = (httpClient) => (settings) => ({ ...settings, httpClient });
-const withDefaultPageSize = (defaultPageSize) => (settings) => ({ ...settings, defaultPageSize });
-const withUserAgent = (userAgent) => (settings) => ({ ...settings, userAgent });
+/**
+* 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) => ({
-  ...settings,
-  userAgent: settings.userAgent ? `${settings.userAgent} ${userAgent}` : userAgent
+	...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) => ({
-  ...settings,
-  interceptors: settings.interceptors.concat(interceptors)
+	...settings,
+	interceptors: settings.interceptors.concat(interceptors)
 });
+/**
+* Instantiates the SDK with legacy 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
-  };
-};
-export {
-  withAdditionalInterceptors,
-  withDefaultPageSize,
-  withHTTPClient,
-  withLegacyInterceptors,
-  withProfile,
-  withUserAgent,
-  withUserAgentSuffix
+	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
+	};
 };
+export { withAdditionalInterceptors, withDefaultPageSize, withHTTPClient, withLegacyInterceptors, withProfile, withUserAgent, withUserAgentSuffix };

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

@@ -1,23 +1,27 @@
 import { isAccessKey, isSecretKey } from "../internal/validations/string-validation.js";
+/**
+* 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
+*/
 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 (!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 (!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/`
-    );
-  }
+	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 (!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 (!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/`);
 }
-export {
-  assertValidAuthenticationSecrets,
-  hasAuthenticationSecrets
-};
+export { assertValidAuthenticationSecrets, hasAuthenticationSecrets };

package/dist/scw/client-settings.js

@@ -1,51 +1,27 @@
-import { isOrganizationId, isProjectId, isRegion, isZone, isURL } from "../internal/validations/string-validation.js";
+import { isOrganizationId, isProjectId, isRegion, isURL, isZone } from "../internal/validations/string-validation.js";
+/**
+* Validates the content of a {@link Settings} object.
+*
+* @throws Error
+* Thrown if {@link Settings} aren't valid.
+*
+* @internal
+*/
 const assertValidSettings = (obj) => {
-  if (obj.defaultOrganizationId !== void 0) {
-    if (typeof obj.defaultOrganizationId !== "string" || obj.defaultOrganizationId.length === 0) {
-      throw new Error("Default organization ID cannot be empty");
-    }
-    if (!isOrganizationId(obj.defaultOrganizationId)) {
-      throw new Error(
-        `Invalid organization ID format '${obj.defaultOrganizationId}', expected a UUID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`
-      );
-    }
-  }
-  if (obj.defaultProjectId !== void 0) {
-    if (typeof obj.defaultProjectId !== "string" || obj.defaultProjectId.length === 0) {
-      throw new Error("Default project ID cannot be empty");
-    }
-    if (!isProjectId(obj.defaultProjectId)) {
-      throw new Error(
-        `Invalid project ID format '${obj.defaultProjectId}', expected a UUID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`
-      );
-    }
-  }
-  if (obj.defaultRegion && !isRegion(obj.defaultRegion)) {
-    throw new Error(`Invalid default region format '${obj.defaultRegion}'`);
-  }
-  if (obj.defaultZone && !isZone(obj.defaultZone)) {
-    throw new Error(`Invalid default zone format '${obj.defaultZone}'`);
-  }
-  if (obj.apiURL && !isURL(obj.apiURL)) {
-    throw new Error(`Invalid URL ${obj.apiURL}`);
-  }
-  if (obj.apiURL?.endsWith("/")) {
-    throw new Error(
-      `Invalid URL ${obj.apiURL}: it should not have a trailing slash`
-    );
-  }
-  if (typeof obj.httpClient !== typeof fetch) {
-    throw new Error(`Invalid HTTP Client`);
-  }
-  if (obj.defaultPageSize !== void 0 && (typeof obj.defaultPageSize !== "number" || Number.isNaN(obj.defaultPageSize) || obj.defaultPageSize <= 0)) {
-    throw new Error(
-      `Invalid defaultPageSize ${obj.defaultPageSize}: it should be a number above 0`
-    );
-  }
-  if (typeof obj.userAgent !== "string") {
-    throw new Error(`Invalid User-Agent`);
-  }
-};
-export {
-  assertValidSettings
+	if (obj.defaultOrganizationId !== void 0) {
+		if (typeof obj.defaultOrganizationId !== "string" || obj.defaultOrganizationId.length === 0) throw new Error("Default organization ID cannot be empty");
+		if (!isOrganizationId(obj.defaultOrganizationId)) throw new Error(`Invalid organization ID format '${obj.defaultOrganizationId}', expected a UUID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`);
+	}
+	if (obj.defaultProjectId !== void 0) {
+		if (typeof obj.defaultProjectId !== "string" || obj.defaultProjectId.length === 0) throw new Error("Default project ID cannot be empty");
+		if (!isProjectId(obj.defaultProjectId)) throw new Error(`Invalid project ID format '${obj.defaultProjectId}', expected a UUID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`);
+	}
+	if (obj.defaultRegion && !isRegion(obj.defaultRegion)) throw new Error(`Invalid default region format '${obj.defaultRegion}'`);
+	if (obj.defaultZone && !isZone(obj.defaultZone)) throw new Error(`Invalid default zone format '${obj.defaultZone}'`);
+	if (obj.apiURL && !isURL(obj.apiURL)) throw new Error(`Invalid URL ${obj.apiURL}`);
+	if (obj.apiURL?.endsWith("/")) throw new Error(`Invalid URL ${obj.apiURL}: it should not have a trailing slash`);
+	if (typeof obj.httpClient !== typeof fetch) throw new Error(`Invalid HTTP Client`);
+	if (obj.defaultPageSize !== void 0 && (typeof obj.defaultPageSize !== "number" || Number.isNaN(obj.defaultPageSize) || obj.defaultPageSize <= 0)) throw new Error(`Invalid defaultPageSize ${obj.defaultPageSize}: it should be a number above 0`);
+	if (typeof obj.userAgent !== "string") throw new Error(`Invalid User-Agent`);
 };
+export { assertValidSettings };