@scaleway/sdk-client 1.1.1 → 1.2.1

package/dist/helpers/json.cjs

@@ -4,4 +4,44 @@ const isJSONObject = (obj) => {
   const objT = typeof obj;
   return obj !== void 0 && obj !== null && objT !== "string" && objT !== "number" && objT !== "boolean" && !Array.isArray(obj) && objT === "object";
 };
+const camelize = (str) => {
+  const strLength = str.length;
+  if (strLength <= 0) {
+    return str;
+  }
+  let out = "";
+  for (let capNext = false, index = 0; index < strLength; index += 1) {
+    const char = str.charAt(index);
+    if (char >= "a" && char <= "z") {
+      if (capNext) {
+        out += char.toUpperCase();
+      } else {
+        out += char;
+      }
+    } else if (char >= "A" && char <= "Z") {
+      out += char;
+    } else if (char >= "0" && char <= "9") {
+      out += char;
+    }
+    capNext = char === "_" || char === " " || char === "-" || char === ".";
+  }
+  return out.charAt(0).toLowerCase() + out.substring(1);
+};
+const camelizeKeys = (obj, ignoreKeys = []) => {
+  if (Array.isArray(obj)) {
+    return obj.map((v) => camelizeKeys(v, ignoreKeys));
+  }
+  if (obj && typeof obj === "object" && !(obj instanceof Date)) {
+    return Object.entries(obj).reduce(
+      (acc, [key, value]) => ({
+        ...acc,
+        [camelize(key)]: ignoreKeys.includes(key) ? value : camelizeKeys(value, ignoreKeys)
+      }),
+      {}
+    );
+  }
+  return obj;
+};
+exports.camelize = camelize;
+exports.camelizeKeys = camelizeKeys;
 exports.isJSONObject = isJSONObject;

package/dist/helpers/json.d.ts

@@ -11,3 +11,22 @@ export declare const isJSON: (obj: unknown) => obj is JSON;
  * @internal
  */
 export declare const isJSONObject: (obj: unknown) => obj is JSONObject;
+/**
+ * Camelizes a string.
+ *
+ * @param str - The string to camelize
+ * @returns The camelized string
+ *
+ * @internal
+ */
+export declare const camelize: (str: string) => string;
+/**
+ * Camelizes keys of an object (deeply).
+ *
+ * @param obj - The object
+ * @param ignoreKeys - The keys to ignore
+ * @returns The object with camelized keys
+ *
+ * @internal
+ */
+export declare const camelizeKeys: <T>(obj: object | unknown[] | unknown, ignoreKeys?: string[]) => T;

package/dist/helpers/json.js

@@ -2,6 +2,46 @@ const isJSONObject = (obj) => {
   const objT = typeof obj;
   return obj !== void 0 && obj !== null && objT !== "string" && objT !== "number" && objT !== "boolean" && !Array.isArray(obj) && objT === "object";
 };
+const camelize = (str) => {
+  const strLength = str.length;
+  if (strLength <= 0) {
+    return str;
+  }
+  let out = "";
+  for (let capNext = false, index = 0; index < strLength; index += 1) {
+    const char = str.charAt(index);
+    if (char >= "a" && char <= "z") {
+      if (capNext) {
+        out += char.toUpperCase();
+      } else {
+        out += char;
+      }
+    } else if (char >= "A" && char <= "Z") {
+      out += char;
+    } else if (char >= "0" && char <= "9") {
+      out += char;
+    }
+    capNext = char === "_" || char === " " || char === "-" || char === ".";
+  }
+  return out.charAt(0).toLowerCase() + out.substring(1);
+};
+const camelizeKeys = (obj, ignoreKeys = []) => {
+  if (Array.isArray(obj)) {
+    return obj.map((v) => camelizeKeys(v, ignoreKeys));
+  }
+  if (obj && typeof obj === "object" && !(obj instanceof Date)) {
+    return Object.entries(obj).reduce(
+      (acc, [key, value]) => ({
+        ...acc,
+        [camelize(key)]: ignoreKeys.includes(key) ? value : camelizeKeys(value, ignoreKeys)
+      }),
+      {}
+    );
+  }
+  return obj;
+};
 export {
+  camelize,
+  camelizeKeys,
   isJSONObject
 };

package/dist/index.cjs

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const index = require("./internal/logger/index.cjs");
 const client = require("./scw/client.cjs");
+const constants = require("./scw/constants.cjs");
 const clientIniFactory = require("./scw/client-ini-factory.cjs");
 const customTypes = require("./scw/custom-types.cjs");
 const index$1 = require("./scw/errors/standard/index.cjs");
@@ -17,6 +18,8 @@ exports.enableConsoleLogger = index.enableConsoleLogger;
 exports.setLogger = index.setLogger;
 exports.createAdvancedClient = client.createAdvancedClient;
 exports.createClient = client.createClient;
+exports.AUTH_HEADER_KEY = constants.AUTH_HEADER_KEY;
+exports.SESSION_HEADER_KEY = constants.SESSION_HEADER_KEY;
 exports.withAdditionalInterceptors = clientIniFactory.withAdditionalInterceptors;
 exports.withDefaultPageSize = clientIniFactory.withDefaultPageSize;
 exports.withHTTPClient = clientIniFactory.withHTTPClient;
@@ -37,6 +40,7 @@ exports.marshalDecimal = customMarshalling.marshalDecimal;
 exports.marshalMoney = customMarshalling.marshalMoney;
 exports.marshalScwFile = customMarshalling.marshalScwFile;
 exports.marshalTimeSeries = customMarshalling.marshalTimeSeries;
+exports.unmarshalAnyRes = customMarshalling.unmarshalAnyRes;
 exports.unmarshalDecimal = customMarshalling.unmarshalDecimal;
 exports.unmarshalMoney = customMarshalling.unmarshalMoney;
 exports.unmarshalScwFile = customMarshalling.unmarshalScwFile;

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export type { NetworkInterceptors, RequestInterceptor, ResponseInterceptor, Resp
 export { enableConsoleLogger, setLogger } from './internal/logger/index.js';
 export type { Logger } from './internal/logger/logger';
 export { createClient, createAdvancedClient } from './scw/client.js';
+export { AUTH_HEADER_KEY, SESSION_HEADER_KEY } from './scw/constants.js';
 export type { Client } from './scw/client.js';
 export type { Profile } from './scw/client-ini-profile.js';
 export type { Settings } from './scw/client-settings.js';

package/dist/index.js

@@ -1,5 +1,6 @@
 import { enableConsoleLogger, setLogger } from "./internal/logger/index.js";
 import { createAdvancedClient, createClient } from "./scw/client.js";
+import { AUTH_HEADER_KEY, SESSION_HEADER_KEY } from "./scw/constants.js";
 import { withAdditionalInterceptors, withDefaultPageSize, withHTTPClient, withProfile, withUserAgent, withUserAgentSuffix } from "./scw/client-ini-factory.js";
 import { Decimal } from "./scw/custom-types.js";
 import * as index from "./scw/errors/standard/index.js";
@@ -8,13 +9,15 @@ import { createExponentialBackoffStrategy, tryAtIntervals, waitForResource } fro
 import { addAsyncHeaderInterceptor } from "./internal/interceptors/helpers.js";
 import { API } from "./scw/api.js";
 import { authenticateWithSessionToken } from "./scw/auth.js";
-import { marshalBlobToScwFile, marshalDecimal, marshalMoney, marshalScwFile, marshalTimeSeries, unmarshalDecimal, unmarshalMoney, unmarshalScwFile, unmarshalServiceInfo, unmarshalTimeSeries, unmarshalTimeSeriesPoint } from "./scw/custom-marshalling.js";
+import { marshalBlobToScwFile, marshalDecimal, marshalMoney, marshalScwFile, marshalTimeSeries, unmarshalAnyRes, unmarshalDecimal, unmarshalMoney, unmarshalScwFile, unmarshalServiceInfo, unmarshalTimeSeries, unmarshalTimeSeriesPoint } from "./scw/custom-marshalling.js";
 import { resolveOneOf, unmarshalArrayOfObject, unmarshalDate, unmarshalMapOfObject, urlParams, validatePathParam } from "./helpers/marshalling.js";
 import { enrichForPagination } from "./scw/fetch/resource-paginator.js";
 export {
   API,
+  AUTH_HEADER_KEY,
   Decimal,
   index as Errors,
+  SESSION_HEADER_KEY,
   addAsyncHeaderInterceptor,
   authenticateWithSessionToken,
   createAdvancedClient,
@@ -31,6 +34,7 @@ export {
   resolveOneOf,
   setLogger,
   tryAtIntervals,
+  unmarshalAnyRes,
   unmarshalArrayOfObject,
   unmarshalDate,
   unmarshalDecimal,

package/dist/internals.d.ts

@@ -4,7 +4,7 @@ export { addAsyncHeaderInterceptor } from './internal/interceptors/helpers.js';
 export { API } from './scw/api.js';
 export { authenticateWithSessionToken } from './scw/auth.js';
 export type { DefaultValues } from './scw/client-settings.js';
-export { marshalDecimal, marshalScwFile, marshalMoney, marshalTimeSeries, marshalBlobToScwFile, unmarshalDecimal, unmarshalMoney, unmarshalScwFile, unmarshalServiceInfo, unmarshalTimeSeries, unmarshalTimeSeriesPoint, } from './scw/custom-marshalling.js';
+export { marshalBlobToScwFile, marshalDecimal, marshalMoney, marshalScwFile, marshalTimeSeries, unmarshalAnyRes, unmarshalDecimal, unmarshalMoney, unmarshalScwFile, unmarshalServiceInfo, unmarshalTimeSeries, unmarshalTimeSeriesPoint, } from './scw/custom-marshalling.js';
 export type { ServiceInfo } from './scw/custom-types.js';
 export { resolveOneOf, unmarshalDate, unmarshalArrayOfObject, unmarshalMapOfObject, urlParams, validatePathParam, } from './helpers/marshalling.js';
 export { enrichForPagination } from './scw/fetch/resource-paginator.js';

package/dist/package.json.cjs

@@ -1,67 +1,8 @@
 "use strict";
 Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } });
-const name = "@scaleway/sdk-client";
-const version = "1.1.0";
-const license = "Apache-2.0";
-const description = "Scaleway SDK Client";
-const keywords = [
-  "scaleway",
-  "cloud",
-  "sdk",
-  "client"
-];
-const main = "dist/index.cjs";
-const module$1 = "dist/index.js";
-const types = "dist/index.d.ts";
-const 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"
-};
-const files = [
-  "dist"
-];
-const publishConfig = {
-  access: "public"
-};
-const repository = {
-  type: "git",
-  url: "https://github.com/scaleway/scaleway-sdk-js",
-  directory: "packages/client"
-};
-const engines = {
-  node: ">=18.0"
-};
-const type = "module";
+const version = "1.2.0";
 const pkg = {
-  name,
-  version,
-  license,
-  description,
-  keywords,
-  main,
-  module: module$1,
-  types,
-  scripts,
-  files,
-  publishConfig,
-  repository,
-  engines,
-  type
+  version
 };
 exports.default = pkg;
-exports.description = description;
-exports.engines = engines;
-exports.files = files;
-exports.keywords = keywords;
-exports.license = license;
-exports.main = main;
-exports.module = module$1;
-exports.name = name;
-exports.publishConfig = publishConfig;
-exports.repository = repository;
-exports.scripts = scripts;
-exports.type = type;
-exports.types = types;
 exports.version = version;

package/dist/package.json.js

@@ -1,67 +1,8 @@
-const name = "@scaleway/sdk-client";
-const version = "1.1.0";
-const license = "Apache-2.0";
-const description = "Scaleway SDK Client";
-const keywords = [
-  "scaleway",
-  "cloud",
-  "sdk",
-  "client"
-];
-const main = "dist/index.cjs";
-const module = "dist/index.js";
-const types = "dist/index.d.ts";
-const 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"
-};
-const files = [
-  "dist"
-];
-const publishConfig = {
-  access: "public"
-};
-const repository = {
-  type: "git",
-  url: "https://github.com/scaleway/scaleway-sdk-js",
-  directory: "packages/client"
-};
-const engines = {
-  node: ">=18.0"
-};
-const type = "module";
+const version = "1.2.0";
 const pkg = {
-  name,
-  version,
-  license,
-  description,
-  keywords,
-  main,
-  module,
-  types,
-  scripts,
-  files,
-  publishConfig,
-  repository,
-  engines,
-  type
+  version
 };
 export {
   pkg as default,
-  description,
-  engines,
-  files,
-  keywords,
-  license,
-  main,
-  module,
-  name,
-  publishConfig,
-  repository,
-  scripts,
-  type,
-  types,
   version
 };

package/dist/scw/auth.cjs

@@ -2,12 +2,11 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const helpers = require("../internal/interceptors/helpers.cjs");
 const clientIniProfile = require("./client-ini-profile.cjs");
-const SESSION_HEADER_KEY = "x-session-token";
-const AUTH_HEADER_KEY = "x-auth-token";
-const authenticateWithSessionToken = (getToken) => helpers.addAsyncHeaderInterceptor(SESSION_HEADER_KEY, getToken);
+const constants = require("./constants.cjs");
+const authenticateWithSessionToken = (getToken) => helpers.addAsyncHeaderInterceptor(constants.SESSION_HEADER_KEY, getToken);
 const authenticateWithSecrets = (secrets) => {
   clientIniProfile.assertValidAuthenticationSecrets(secrets);
-  return helpers.addHeaderInterceptor(AUTH_HEADER_KEY, secrets.secretKey);
+  return helpers.addHeaderInterceptor(constants.AUTH_HEADER_KEY, secrets.secretKey);
 };
 const obfuscateToken = (key) => `${key.substring(0, 5)}xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`;
 const obfuscateUUID = (key) => `${key.substring(0, 8)}-xxxx-xxxx-xxxx-xxxxxxxxxxxx`;
@@ -15,8 +14,8 @@ const obfuscateAuthHeadersEntry = ([
   name,
   value
 ]) => {
-  if (name === SESSION_HEADER_KEY) return [name, obfuscateToken(value)];
-  if (name === AUTH_HEADER_KEY) return [name, obfuscateUUID(value)];
+  if (name === constants.SESSION_HEADER_KEY) return [name, obfuscateToken(value)];
+  if (name === constants.AUTH_HEADER_KEY) return [name, obfuscateUUID(value)];
   return [name, value];
 };
 exports.authenticateWithSecrets = authenticateWithSecrets;

package/dist/scw/auth.d.ts

@@ -3,6 +3,19 @@ import type { AuthenticationSecrets } from './client-ini-profile.js';
 interface TokenAccessor {
     (): Promise<string | undefined>;
 }
+interface AddSessionHeader {
+    request: Request;
+    getAsyncToken: () => Promise<string | undefined>;
+}
+/**
+ * Add an JWT Session Header to a request through an interceptor.
+ *
+ * @param request - The request to modify
+ * @param getJwt - The session value
+ * @returns The Request interceptor
+ *
+ */
+export declare const addSessionHeader: ({ request, getAsyncToken, }: AddSessionHeader) => Promise<Request>;
 /**
  * Authenticates with a session token.
  *

package/dist/scw/auth.js

@@ -1,7 +1,6 @@
 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";
+import { SESSION_HEADER_KEY, AUTH_HEADER_KEY } from "./constants.js";
 const authenticateWithSessionToken = (getToken) => addAsyncHeaderInterceptor(SESSION_HEADER_KEY, getToken);
 const authenticateWithSecrets = (secrets) => {
   assertValidAuthenticationSecrets(secrets);

package/dist/scw/client.js

@@ -1,7 +1,7 @@
 import { getLogger } from "../internal/logger/index.js";
-import { withLegacyInterceptors, withAdditionalInterceptors, withProfile } from "./client-ini-factory.js";
+import { withAdditionalInterceptors, withProfile, withLegacyInterceptors } from "./client-ini-factory.js";
 import { assertValidSettings } from "./client-settings.js";
-import { version, userAgent } from "./constants.js";
+import { userAgent, version } from "./constants.js";
 import { buildFetcher } from "./fetch/build-fetcher.js";
 const DEFAULT_SETTINGS = {
   apiURL: "https://api.scaleway.com",

package/dist/scw/constants.cjs

@@ -3,5 +3,9 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const _package = require("../package.json.cjs");
 const { version } = _package.default;
 const userAgent = `scaleway-sdk-js/${version}`;
+const SESSION_HEADER_KEY = "x-session-token";
+const AUTH_HEADER_KEY = "x-auth-token";
+exports.AUTH_HEADER_KEY = AUTH_HEADER_KEY;
+exports.SESSION_HEADER_KEY = SESSION_HEADER_KEY;
 exports.userAgent = userAgent;
 exports.version = version;

package/dist/scw/constants.d.ts

@@ -1,2 +1,4 @@
 export declare const version: string;
 export declare const userAgent: string;
+export declare const SESSION_HEADER_KEY = "x-session-token";
+export declare const AUTH_HEADER_KEY = "x-auth-token";

package/dist/scw/constants.js

@@ -1,7 +1,11 @@
 import pkg from "../package.json.js";
 const { version } = pkg;
 const userAgent = `scaleway-sdk-js/${version}`;
+const SESSION_HEADER_KEY = "x-session-token";
+const AUTH_HEADER_KEY = "x-auth-token";
 export {
+  AUTH_HEADER_KEY,
+  SESSION_HEADER_KEY,
   userAgent,
   version
 };

package/dist/scw/custom-marshalling.cjs

@@ -112,12 +112,38 @@ const marshalTimeSeries = (obj) => ({
 const marshalDecimal = (obj) => ({
   value: obj.toString()
 });
+const unmarshalDates = (obj, keys) => {
+  if (Array.isArray(obj)) {
+    return obj.map((v) => unmarshalDates(v, keys));
+  }
+  if (obj && typeof obj === "object") {
+    return Object.entries(obj).reduce(
+      (acc, [key, value]) => ({
+        ...acc,
+        [key]: typeof value === "string" && keys.includes(key) ? new Date(value) : unmarshalDates(value, keys)
+      }),
+      {}
+    );
+  }
+  return obj;
+};
+const unmarshalAnyRes = (obj, ignoreKeys = [], dateKeys) => {
+  if (!json.isJSONObject(obj)) {
+    throw new TypeError(`Data isn't a dictionary.`);
+  }
+  return json.camelizeKeys(
+    dateKeys && dateKeys.length > 0 ? unmarshalDates(obj, dateKeys) : obj,
+    ignoreKeys
+  );
+};
 exports.marshalBlobToScwFile = marshalBlobToScwFile;
 exports.marshalDecimal = marshalDecimal;
 exports.marshalMoney = marshalMoney;
 exports.marshalScwFile = marshalScwFile;
 exports.marshalTimeSeries = marshalTimeSeries;
 exports.marshalTimeSeriesPoint = marshalTimeSeriesPoint;
+exports.unmarshalAnyRes = unmarshalAnyRes;
+exports.unmarshalDates = unmarshalDates;
 exports.unmarshalDecimal = unmarshalDecimal;
 exports.unmarshalMoney = unmarshalMoney;
 exports.unmarshalScwFile = unmarshalScwFile;

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

@@ -78,3 +78,27 @@ export declare const marshalTimeSeries: (obj: TimeSeries) => Record<string, unkn
 export declare const marshalDecimal: (obj: Decimal) => {
     value: string;
 };
+/**
+ * Unmarshals record to convert iso dates from string to Dates.
+ *
+ * @param obj - The input
+ * @param keys - The keys requiring a conversion
+ * @returns The updated input
+ *
+ * @internal
+ */
+export declare const unmarshalDates: <T>(obj: unknown, keys: string[]) => T;
+/**
+ * Unmarshals input to a record with camilized keys and instanciated Date.
+ *
+ * @param obj - The input
+ * @param ignoreKeys - The keys which should be not be transformed
+ * @param dateKeys - The keys which should be transformed to Date
+ * @returns The record
+ *
+ * @throws TypeError
+ * Thrown if the input isn't {@link JSONObject}.
+ *
+ * @internal
+ */
+export declare const unmarshalAnyRes: <T>(obj: unknown, ignoreKeys?: string[], dateKeys?: string[]) => T;

package/dist/scw/custom-marshalling.js

@@ -1,5 +1,5 @@
-import { isJSONObject } from "../helpers/json.js";
-import { unmarshalDate, unmarshalArrayOfObject } from "../helpers/marshalling.js";
+import { isJSONObject, camelizeKeys } from "../helpers/json.js";
+import { unmarshalArrayOfObject, unmarshalDate } from "../helpers/marshalling.js";
 import { fromByteArray } from "../vendor/base64/index.js";
 import { Decimal } from "./custom-types.js";
 const unmarshalMoney = (data) => {
@@ -110,6 +110,30 @@ const marshalTimeSeries = (obj) => ({
 const marshalDecimal = (obj) => ({
   value: obj.toString()
 });
+const unmarshalDates = (obj, keys) => {
+  if (Array.isArray(obj)) {
+    return obj.map((v) => unmarshalDates(v, keys));
+  }
+  if (obj && typeof obj === "object") {
+    return Object.entries(obj).reduce(
+      (acc, [key, value]) => ({
+        ...acc,
+        [key]: typeof value === "string" && keys.includes(key) ? new Date(value) : unmarshalDates(value, keys)
+      }),
+      {}
+    );
+  }
+  return obj;
+};
+const unmarshalAnyRes = (obj, ignoreKeys = [], dateKeys) => {
+  if (!isJSONObject(obj)) {
+    throw new TypeError(`Data isn't a dictionary.`);
+  }
+  return camelizeKeys(
+    dateKeys && dateKeys.length > 0 ? unmarshalDates(obj, dateKeys) : obj,
+    ignoreKeys
+  );
+};
 export {
   marshalBlobToScwFile,
   marshalDecimal,
@@ -117,6 +141,8 @@ export {
   marshalScwFile,
   marshalTimeSeries,
   marshalTimeSeriesPoint,
+  unmarshalAnyRes,
+  unmarshalDates,
   unmarshalDecimal,
   unmarshalMoney,
   unmarshalScwFile,

package/dist/scw/locality.d.ts

@@ -1,2 +1,2 @@
 export type Region = 'fr-par' | 'nl-ams' | 'pl-waw' | (string & {});
-export type Zone = 'fr-par-1' | 'fr-par-2' | 'fr-par-3' | 'nl-ams-1' | 'nl-ams-2' | 'nl-ams-3' | 'pl-waw-1' | 'pl-waw-2' | (string & {});
+export type Zone = 'fr-par-1' | 'fr-par-2' | 'fr-par-3' | 'nl-ams-1' | 'nl-ams-2' | 'nl-ams-3' | 'pl-waw-1' | 'pl-waw-2' | 'pl-waw-3' | (string & {});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk-client",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "license": "Apache-2.0",
   "description": "Scaleway SDK Client",
   "keywords": [
@@ -33,5 +33,5 @@
     "node": ">=18.0"
   },
   "type": "module",
-  "gitHead": "50cbd0a83df3ed423f7aedae4018e63299e7c945"
+  "gitHead": "a3b0b412eb0b067b8f2ea61360a023f38d17f5a0"
 }