@scaleway/sdk-client 1.1.0

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

@@ -0,0 +1,23 @@
+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/`
+    );
+  }
+  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
+};

package/dist/scw/client-settings.cjs

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const stringValidation = require("../internal/validations/string-validation.cjs");
+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 (!stringValidation.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 (!stringValidation.isProjectId(obj.defaultProjectId)) {
+      throw new Error(
+        `Invalid project ID format '${obj.defaultProjectId}', expected a UUID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`
+      );
+    }
+  }
+  if (obj.defaultRegion && !stringValidation.isRegion(obj.defaultRegion)) {
+    throw new Error(`Invalid default region format '${obj.defaultRegion}'`);
+  }
+  if (obj.defaultZone && !stringValidation.isZone(obj.defaultZone)) {
+    throw new Error(`Invalid default zone format '${obj.defaultZone}'`);
+  }
+  if (obj.apiURL && !stringValidation.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`);
+  }
+};
+exports.assertValidSettings = assertValidSettings;

package/dist/scw/client-settings.d.ts

@@ -0,0 +1,59 @@
+import type { NetworkInterceptors, RequestInterceptor, ResponseInterceptor } from '../internal/interceptors/types';
+import type { Profile } from './client-ini-profile.js';
+/**
+ * Holds default values of settings.
+ *
+ * @public
+ */
+export type DefaultValues = Profile & {
+    /**
+     * The default number of results when requesting a paginated resource.
+     */
+    defaultPageSize?: number;
+};
+/**
+ * Settings hold the values of all client options.
+ *
+ * @public
+ */
+export interface Settings extends DefaultValues {
+    /**
+     * The default number of results when requesting a paginated resource.
+     */
+    defaultPageSize?: number;
+    /**
+     * HTTP Client doing the requests.
+     */
+    httpClient: typeof fetch;
+    /**
+     * The Request interceptors.
+     *
+     * @deprecated Please use `interceptors` instead.
+     */
+    requestInterceptors?: RequestInterceptor[];
+    /**
+     * The Response interceptors.
+     *
+     * @deprecated Please use `interceptors` instead.
+     */
+    responseInterceptors?: ResponseInterceptor[];
+    /**
+     * The Network interceptors.
+     */
+    interceptors: NetworkInterceptors[];
+    /**
+     * The User-Agent sent with each request.
+     *
+     * @defaultValue scaleway-sdk-js/version
+     */
+    userAgent: string;
+}
+/**
+ * Validates the content of a {@link Settings} object.
+ *
+ * @throws Error
+ * Thrown if {@link Settings} aren't valid.
+ *
+ * @internal
+ */
+export declare const assertValidSettings: (obj: Readonly<Settings>) => void;

package/dist/scw/client-settings.js

@@ -0,0 +1,51 @@
+import { isOrganizationId, isProjectId, isRegion, isZone, isURL } from "../internal/validations/string-validation.js";
+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
+};

package/dist/scw/client.cjs

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const index = require("../internal/logger/index.cjs");
+const clientIniFactory = require("./client-ini-factory.cjs");
+const clientSettings = require("./client-settings.cjs");
+const constants = require("./constants.cjs");
+const buildFetcher = require("./fetch/build-fetcher.cjs");
+const DEFAULT_SETTINGS = {
+  apiURL: "https://api.scaleway.com",
+  httpClient: fetch,
+  interceptors: [],
+  userAgent: constants.userAgent
+};
+const createAdvancedClient = (...configs) => {
+  const settings = configs.concat([clientIniFactory.withLegacyInterceptors()]).reduce(
+    (currentSettings, config) => config(currentSettings),
+    DEFAULT_SETTINGS
+  );
+  clientSettings.assertValidSettings(settings);
+  index.getLogger().info(`init Scaleway SDK version ${constants.version}`);
+  return {
+    fetch: buildFetcher.buildFetcher(settings, settings.httpClient),
+    settings
+  };
+};
+const createClient = (settings = {}) => createAdvancedClient(
+  clientIniFactory.withProfile(settings),
+  clientIniFactory.withAdditionalInterceptors(settings.interceptors ?? [])
+);
+exports.createAdvancedClient = createAdvancedClient;
+exports.createClient = createClient;

package/dist/scw/client.d.ts

@@ -0,0 +1,71 @@
+import type { ClientConfig } from './client-ini-factory.js';
+import type { Settings } from './client-settings.js';
+import type { Fetcher } from './fetch/build-fetcher.js';
+/**
+ * Scaleway client.
+ */
+export interface Client {
+    fetch: Fetcher;
+    settings: Settings;
+}
+/**
+ * Creates a Scaleway client with advanced options.
+ * You can either use existing factories
+ * (like `withProfile`, `withUserAgentSuffix`, etc)
+ * or write your own using the interface `ClientConfig`.
+ *
+ * @example
+ * Creates a client with factories:
+ * ```
+ * createAdvancedClient(
+ *   (obj: Settings) => ({
+ *     ...obj,
+ *     defaultPageSize: 100 ,
+ *     httpClient: myFetchWrapper,
+ *   }),
+ *   withUserAgentSuffix('bot-name/1.0'),
+ * )
+ * ```
+ *
+ * @throws Error
+ * Thrown if the setup fails.
+ *
+ * @public
+ */
+export declare const createAdvancedClient: (...configs: ClientConfig[]) => Client;
+/**
+ * Creates a Scaleway client with a profile.
+ *
+ * @example
+ * Creates a client with credentials & default values (see https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/):
+ * ```
+ * import { createClient } from '@scaleway/sdk'
+ *
+ * createClient({
+ *   accessKey: 'SCWXXXXXXXXXXXXXXXXX',
+ *   secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+ *   defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+ *   defaultRegion: 'fr-par',
+ *   defaultZone: 'fr-par-1',
+ * })
+ * ```
+ *
+ * @example
+ * Creates a client by loading values from the environment (see https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/)
+ * or the config file created by CLI `scw init` (see https://www.scaleway.com/en/cli/):
+ * ```
+ * import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
+ * import { createClient } from '@scaleway/sdk'
+ *
+ * createClient({
+ *   ...await loadProfileFromConfigurationFile(),
+ *   defaultZone: 'fr-par-3',
+ * })
+ * ```
+ *
+ * @throws Error
+ * Thrown if the setup fails.
+ *
+ * @public
+ */
+export declare const createClient: (settings?: Partial<Settings>) => Client;

package/dist/scw/client.js

@@ -0,0 +1,31 @@
+import { getLogger } from "../internal/logger/index.js";
+import { withLegacyInterceptors, withAdditionalInterceptors, withProfile } from "./client-ini-factory.js";
+import { assertValidSettings } from "./client-settings.js";
+import { version, userAgent } from "./constants.js";
+import { buildFetcher } from "./fetch/build-fetcher.js";
+const DEFAULT_SETTINGS = {
+  apiURL: "https://api.scaleway.com",
+  httpClient: fetch,
+  interceptors: [],
+  userAgent
+};
+const createAdvancedClient = (...configs) => {
+  const settings = configs.concat([withLegacyInterceptors()]).reduce(
+    (currentSettings, config) => config(currentSettings),
+    DEFAULT_SETTINGS
+  );
+  assertValidSettings(settings);
+  getLogger().info(`init Scaleway SDK version ${version}`);
+  return {
+    fetch: buildFetcher(settings, settings.httpClient),
+    settings
+  };
+};
+const createClient = (settings = {}) => createAdvancedClient(
+  withProfile(settings),
+  withAdditionalInterceptors(settings.interceptors ?? [])
+);
+export {
+  createAdvancedClient,
+  createClient
+};

package/dist/scw/constants.cjs

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const _package = require("../package.json.cjs");
+const { version } = _package.default;
+const userAgent = `scaleway-sdk-js/${version}`;
+exports.userAgent = userAgent;
+exports.version = version;

package/dist/scw/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const version: string;
+export declare const userAgent: string;

package/dist/scw/constants.js

@@ -0,0 +1,7 @@
+import pkg from "../package.json.js";
+const { version } = pkg;
+const userAgent = `scaleway-sdk-js/${version}`;
+export {
+  userAgent,
+  version
+};

package/dist/scw/custom-marshalling.cjs

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const json = require("../helpers/json.cjs");
+const marshalling = require("../helpers/marshalling.cjs");
+const index = require("../vendor/base64/index.cjs");
+const customTypes = require("./custom-types.cjs");
+const unmarshalMoney = (data) => {
+  if (!json.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Money' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    currencyCode: data.currency_code,
+    nanos: data.nanos,
+    units: data.units
+  };
+};
+const unmarshalServiceInfo = (data) => {
+  if (!json.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ServiceInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    description: data.description,
+    documentationUrl: data.documentation_url,
+    name: data.name,
+    version: data.version
+  };
+};
+const unmarshalScwFile = (data) => {
+  if (!json.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ScwFile' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    content: data.content,
+    contentType: data.content_type,
+    name: data.name
+  };
+};
+const unmarshalTimeSeriesPoint = (data) => {
+  if (!Array.isArray(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'TimeSeriesPoint' failed as data isn't an array.`
+    );
+  }
+  return {
+    timestamp: marshalling.unmarshalDate(data[0]),
+    value: data[1]
+  };
+};
+const unmarshalTimeSeries = (data) => {
+  if (!json.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'TimeSeries' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    metadata: data.metadata,
+    name: data.name,
+    points: marshalling.unmarshalArrayOfObject(data.points, unmarshalTimeSeriesPoint)
+  };
+};
+const unmarshalDecimal = (data) => {
+  if (!(typeof data === "object")) {
+    throw new TypeError(
+      `Unmarshalling the type 'Decimal' failed as data isn't an object.`
+    );
+  }
+  if (data === null) {
+    return null;
+  }
+  if (!("value" in data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Decimal' failed as data object does not have a 'value' key.`
+    );
+  }
+  if (!(typeof data.value === "string")) {
+    throw new TypeError(
+      `Unmarshalling the type 'Decimal' failed as 'value' is not a string.`
+    );
+  }
+  return new customTypes.Decimal(data.value);
+};
+const marshalScwFile = (obj) => ({
+  content: obj.content,
+  content_type: obj.contentType,
+  name: obj.name
+});
+const marshalBlobToScwFile = async (blob) => ({
+  content: index.fromByteArray(new Uint8Array(await blob.arrayBuffer())),
+  content_type: blob.type,
+  name: "file"
+});
+const marshalMoney = (obj) => ({
+  currency_code: obj.currencyCode,
+  nanos: obj.nanos,
+  units: obj.units
+});
+const marshalTimeSeriesPoint = (obj) => ({
+  timestamp: obj.timestamp?.toISOString(),
+  value: obj.value
+});
+const marshalTimeSeries = (obj) => ({
+  metadata: obj.metadata,
+  name: obj.name,
+  points: obj.points.map((elt) => marshalTimeSeriesPoint(elt))
+});
+const marshalDecimal = (obj) => ({
+  value: obj.toString()
+});
+exports.marshalBlobToScwFile = marshalBlobToScwFile;
+exports.marshalDecimal = marshalDecimal;
+exports.marshalMoney = marshalMoney;
+exports.marshalScwFile = marshalScwFile;
+exports.marshalTimeSeries = marshalTimeSeries;
+exports.marshalTimeSeriesPoint = marshalTimeSeriesPoint;
+exports.unmarshalDecimal = unmarshalDecimal;
+exports.unmarshalMoney = unmarshalMoney;
+exports.unmarshalScwFile = unmarshalScwFile;
+exports.unmarshalServiceInfo = unmarshalServiceInfo;
+exports.unmarshalTimeSeries = unmarshalTimeSeries;
+exports.unmarshalTimeSeriesPoint = unmarshalTimeSeriesPoint;

package/dist/scw/custom-marshalling.d.ts

@@ -0,0 +1,80 @@
+import type { Money, ScwFile, ServiceInfo, TimeSeries, TimeSeriesPoint } from './custom-types.js';
+import { Decimal } from './custom-types.js';
+/**
+ * Unmarshals {@link Money}
+ *
+ * @internal
+ */
+export declare const unmarshalMoney: (data: unknown) => Money;
+/**
+ * Unmarshals {@link ServiceInfo}.
+ *
+ * @internal
+ */
+export declare const unmarshalServiceInfo: (data: unknown) => ServiceInfo;
+/**
+ * Unmarshals {@link ScwFile}.
+ *
+ * @internal
+ */
+export declare const unmarshalScwFile: (data: unknown) => ScwFile;
+/**
+ * Unmarshals {@link TimeSeriesPoint}
+ *
+ * @remarks To optimize the size of this message,
+ * the JSON is compressed in an array instead of a dictionary.
+ * Example: `["2019-08-08T15:00:00Z", 0.2]`.
+ *
+ * @internal
+ */
+export declare const unmarshalTimeSeriesPoint: (data: unknown) => TimeSeriesPoint;
+/**
+ * Unmarshals {@link TimeSeries}
+ *
+ * @internal
+ */
+export declare const unmarshalTimeSeries: (data: unknown) => TimeSeries;
+/**
+ * Unmarshals {@link Decimal}
+ *
+ * @internal
+ */
+export declare const unmarshalDecimal: (data: unknown) => Decimal | null;
+/**
+ * Marshals {@link ScwFile}.
+ *
+ * @internal
+ */
+export declare const marshalScwFile: (obj: ScwFile) => Record<string, unknown>;
+/**
+ * Marshals {@link Blob}.
+ *
+ * @internal
+ */
+export declare const marshalBlobToScwFile: (blob: Blob) => Promise<Record<string, unknown>>;
+/**
+ * Marshals {@link Money}
+ *
+ * @internal
+ */
+export declare const marshalMoney: (obj: Money) => Record<string, unknown>;
+/**
+ * Marshals {@link TimeSeriesPoint}
+ *
+ * @internal
+ */
+export declare const marshalTimeSeriesPoint: (obj: TimeSeriesPoint) => Record<string, unknown>;
+/**
+ * Marshals {@link TimeSeries}
+ *
+ * @internal
+ */
+export declare const marshalTimeSeries: (obj: TimeSeries) => Record<string, unknown>;
+/**
+ * Marshals {@link Decimal}
+ *
+ * @internal
+ */
+export declare const marshalDecimal: (obj: Decimal) => {
+    value: string;
+};