@scaleway/sdk 2.26.0 → 2.27.0

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 (!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 { ProfileDefaultValues } from './client-ini-profile';
+/**
+ * Holds default values of settings.
+ *
+ * @public
+ */
+export type DefaultValues = ProfileDefaultValues & {
+    /**
+     * 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

@@ -1,78 +1,51 @@
-import { isOrganizationId, isProjectId, isRegion, isZone, isURL } from '../internal/validations/string-validation.js';
-
-/**
- * Holds default values of settings.
- *
- * @public
- */
-
-/**
- * Settings hold the values of all client options.
- *
- * @public
- */
-
-/**
- * Validates the content of a {@link Settings} object.
- *
- * @throws Error
- * Thrown if {@link Settings} aren't valid.
- *
- * @internal
- */
-const assertValidSettings = obj => {
-  // Default Organization ID.
-  if (obj.defaultOrganizationId !== undefined) {
-    if (typeof obj.defaultOrganizationId !== 'string' || obj.defaultOrganizationId.length === 0) {
-      throw new Error('Default organization ID cannot be empty');
+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`);
+      throw new Error(
+        `Invalid organization ID format '${obj.defaultOrganizationId}', expected a UUID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`
+      );
     }
   }
-
-  // Default Project ID.
-  if (obj.defaultProjectId !== undefined) {
-    if (typeof obj.defaultProjectId !== 'string' || obj.defaultProjectId.length === 0) {
-      throw new Error('Default project ID cannot be empty');
+  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`);
+      throw new Error(
+        `Invalid project ID format '${obj.defaultProjectId}', expected a UUID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`
+      );
     }
   }
-
-  // Default Region.
   if (obj.defaultRegion && !isRegion(obj.defaultRegion)) {
     throw new Error(`Invalid default region format '${obj.defaultRegion}'`);
   }
-
-  // Default Zone.
   if (obj.defaultZone && !isZone(obj.defaultZone)) {
     throw new Error(`Invalid default zone format '${obj.defaultZone}'`);
   }
-
-  // API URL.
   if (!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 (obj.apiURL.endsWith("/")) {
+    throw new Error(
+      `Invalid URL ${obj.apiURL}: it should not have a trailing slash`
+    );
   }
-
-  // HTTP Client.
   if (typeof obj.httpClient !== typeof fetch) {
     throw new Error(`Invalid HTTP Client`);
   }
-
-  // Default Page Size.
-  if (obj.defaultPageSize !== undefined && (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 (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`
+    );
   }
-
-  // User Agent.
-  if (typeof obj.userAgent !== 'string') {
+  if (typeof obj.userAgent !== "string") {
     throw new Error(`Invalid User-Agent`);
   }
 };
-
-export { assertValidSettings };
+export {
+  assertValidSettings
+};

package/dist/scw/client.cjs

@@ -0,0 +1,28 @@
+"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 = (profile = {}) => createAdvancedClient(clientIniFactory.withProfile(profile));
+exports.createAdvancedClient = createAdvancedClient;
+exports.createClient = createClient;

package/dist/scw/client.d.ts

@@ -0,0 +1,72 @@
+import type { ClientConfig } from './client-ini-factory';
+import type { Profile } from './client-ini-profile';
+import type { Settings } from './client-settings';
+import type { Fetcher } from './fetch/build-fetcher';
+/**
+ * Scaleway client.
+ */
+export type 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: (profile?: Profile) => Client;

package/dist/scw/client.js

@@ -1,47 +1,19 @@
-import { getLogger } from '../internal/logger/index.js';
-import { withLegacyInterceptors, 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';
-
-/** Default {@link Settings} values. */
+import { getLogger } from "../internal/logger/index.js";
+import { withLegacyInterceptors, 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',
+  apiURL: "https://api.scaleway.com",
   httpClient: fetch,
   interceptors: [],
   userAgent
 };
-
-/**
- * Scaleway client.
- */
-
-/**
- * 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
- */
 const createAdvancedClient = (...configs) => {
-  const settings = configs.concat([withLegacyInterceptors()]).reduce((currentSettings, config) => config(currentSettings), DEFAULT_SETTINGS);
+  const settings = configs.concat([withLegacyInterceptors()]).reduce(
+    (currentSettings, config) => config(currentSettings),
+    DEFAULT_SETTINGS
+  );
   assertValidSettings(settings);
   getLogger().info(`init Scaleway SDK version ${version}`);
   return {
@@ -49,42 +21,8 @@ const createAdvancedClient = (...configs) => {
     settings
   };
 };
-
-/**
- * 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
- */
 const createClient = (profile = {}) => createAdvancedClient(withProfile(profile));
-
-export { createAdvancedClient, createClient };
+export {
+  createAdvancedClient,
+  createClient
+};

package/dist/scw/constants.cjs

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const version = "v2.26.0";
+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 = "v2.26.0";
+export declare const userAgent = "scaleway-sdk-js/v2.26.0";

package/dist/scw/constants.js

@@ -1,4 +1,6 @@
-const version = 'v2.25.0';
+const version = "v2.26.0";
 const userAgent = `scaleway-sdk-js/${version}`;
-
-export { userAgent, version };
+export {
+  userAgent,
+  version
+};

package/dist/scw/custom-marshalling.cjs

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const json = require("../helpers/json.cjs");
+const marshalling = require("../helpers/marshalling.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 marshalScwFile = (obj) => ({
+  content: obj.content,
+  content_type: obj.contentType,
+  name: obj.name
+});
+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))
+});
+exports.marshalMoney = marshalMoney;
+exports.marshalScwFile = marshalScwFile;
+exports.marshalTimeSeries = marshalTimeSeries;
+exports.marshalTimeSeriesPoint = marshalTimeSeriesPoint;
+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,59 @@
+import type { Money, ScwFile, ServiceInfo, TimeSeries, TimeSeriesPoint } from './custom-types';
+/**
+ * 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;
+/**
+ * Marshals {@link ScwFile}.
+ *
+ * @internal
+ */
+export declare const marshalScwFile: (obj: ScwFile) => 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>;