@scaleway/sdk 2.25.0 → 2.27.0

package/dist/helpers/marshalling.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Returns the parameter if it's valid as path parameter
+ * (string and not empty, or number), else throws an exception.
+ *
+ * @param name - The parameter name
+ * @param param - The parameter value
+ * @returns The parameter value
+ *
+ * @throws TypeError
+ * Thrown if the parameter is invalid.
+ *
+ * @internal
+ */
+export declare function validatePathParam(name: string, param: string | number | undefined): string;
+/**
+ * Resolves the ideal parameter and value amongst an optional list.
+ *
+ * @param list - The list to be looking into
+ * @param isRequired - If at least one "one-of" should be found, false by default
+ * @returns The parameter and value
+ *
+ * @throws TypeError
+ * Thrown if isRequired is true, and no value or default value is specified.
+ *
+ * @internal
+ */
+export declare const resolveOneOf: <T>(list: {
+    param: string;
+    value: T | undefined;
+    default?: T | undefined;
+}[], isRequired?: boolean) => Record<string, T>;
+type URLParameterValue = string | number | boolean | Date | null;
+/**
+ * Filters defined parameters tuples and converts them to URLSearchParams.
+ *
+ * @param paramTuples - The key/value pairs
+ * @returns URLSearchParams
+ *
+ * @internal
+ */
+export declare const urlParams: (...paramTuples: Readonly<[
+    string,
+    URLParameterValue | URLParameterValue[] | undefined
+]>[]) => URLSearchParams;
+/**
+ * Unmarshals data to Date object.
+ *
+ * @internal
+ */
+export declare const unmarshalDate: (data: unknown) => Date | undefined;
+/**
+ * Unmarshals array of object.
+ *
+ * @internal
+ */
+export declare const unmarshalArrayOfObject: <T, B extends boolean>(data: unknown, unmarshaller: (input: unknown) => T, emptyFallback?: B) => B extends true ? T[] | undefined : T[];
+/**
+ * Unmarshals map of object.
+ *
+ * @internal
+ */
+export declare const unmarshalMapOfObject: <T, B extends boolean>(data: unknown, unmarshaller: (input: unknown) => T, emptyFallback?: B) => B extends true ? Record<string, T> | undefined : Record<string, T>;
+export {};

package/dist/helpers/marshalling.js

@@ -1,115 +1,78 @@
-/**
- * Returns the parameter if it's valid as path parameter
- * (string and not empty, or number), else throws an exception.
- *
- * @param name - The parameter name
- * @param param - The parameter value
- * @returns The parameter value
- *
- * @throws TypeError
- * Thrown if the parameter is invalid.
- *
- * @internal
- */
 function validatePathParam(name, param) {
-  if (typeof param === 'string' && param.length > 0) return param;
-  if (typeof param === 'number') return param.toString();
+  if (typeof param === "string" && param.length > 0)
+    return param;
+  if (typeof param === "number")
+    return param.toString();
   throw new TypeError(`param ${name} cannot be empty in request`);
 }
-
-/**
- * Resolves the ideal parameter and value amongst an optional list.
- *
- * @param list - The list to be looking into
- * @param isRequired - If at least one "one-of" should be found, false by default
- * @returns The parameter and value
- *
- * @throws TypeError
- * Thrown if isRequired is true, and no value or default value is specified.
- *
- * @internal
- */
 const resolveOneOf = (list, isRequired = false) => {
-  const elt = list.find(obj => obj.value !== undefined) ?? list.find(obj => obj.default !== undefined);
+  const elt = list.find((obj) => obj.value !== void 0) ?? list.find((obj) => obj.default !== void 0);
   const value = elt?.value ?? elt?.default;
-  if (elt && value !== undefined) {
-    return {
-      [elt.param]: value
-    };
+  if (elt && value !== void 0) {
+    return { [elt.param]: value };
   }
   if (isRequired) {
-    const keyList = list.map(obj => obj.param).join(' or ');
+    const keyList = list.map((obj) => obj.param).join(" or ");
     throw new TypeError(`one of ${keyList} must be indicated in the request`);
   }
   return {};
 };
-/**
- * Filters defined parameters tuples and converts them to URLSearchParams.
- *
- * @param paramTuples - The key/value pairs
- * @returns URLSearchParams
- *
- * @internal
- */
 const urlParams = (...paramTuples) => {
   const params = new URLSearchParams();
   for (const [key, value] of paramTuples) {
-    if (typeof key === 'string' && value != null) {
+    if (typeof key === "string" && value != null) {
       if (Array.isArray(value)) {
         for (const innerValue of value) {
           if (innerValue !== null) {
-            params.append(key, innerValue instanceof Date ? innerValue.toISOString() : innerValue.toString());
+            params.append(
+              key,
+              innerValue instanceof Date ? innerValue.toISOString() : innerValue.toString()
+            );
           }
         }
       } else {
-        params.append(key, value instanceof Date ? value.toISOString() : value.toString());
+        params.append(
+          key,
+          value instanceof Date ? value.toISOString() : value.toString()
+        );
       }
     }
   }
   return params;
 };
-
-/**
- * Unmarshals data to Date object.
- *
- * @internal
- */
-const unmarshalDate = data => {
-  if (typeof data !== 'string') {
-    return undefined;
+const unmarshalDate = (data) => {
+  if (typeof data !== "string") {
+    return void 0;
   }
   const date = new Date(data);
   if (Number.isNaN(date.getTime())) {
-    return undefined;
+    return void 0;
   }
   return date;
 };
-
-/**
- * Unmarshals array of object.
- *
- * @internal
- */
 const unmarshalArrayOfObject = (data, unmarshaller, emptyFallback = true) => {
   if (!Array.isArray(data)) {
-    return emptyFallback ? [] : undefined;
+    return emptyFallback ? [] : void 0;
   }
-  return data.map(elt => unmarshaller(elt));
+  return data.map((elt) => unmarshaller(elt));
 };
-
-/**
- * Unmarshals map of object.
- *
- * @internal
- */
 const unmarshalMapOfObject = (data, unmarshaller, emptyFallback = true) => {
-  if (!data || typeof data !== 'object' || !(data instanceof Object) || Array.isArray(data)) {
-    return emptyFallback ? {} : undefined;
+  if (!data || typeof data !== "object" || !(data instanceof Object) || Array.isArray(data)) {
+    return emptyFallback ? {} : void 0;
   }
-  return Object.entries(data).reduce((acc, [key, value]) => ({
-    ...acc,
-    [key]: unmarshaller(value)
-  }), {});
+  return Object.entries(data).reduce(
+    (acc, [key, value]) => ({
+      ...acc,
+      [key]: unmarshaller(value)
+    }),
+    {}
+  );
+};
+export {
+  resolveOneOf,
+  unmarshalArrayOfObject,
+  unmarshalDate,
+  unmarshalMapOfObject,
+  urlParams,
+  validatePathParam
 };
-
-export { resolveOneOf, unmarshalArrayOfObject, unmarshalDate, unmarshalMapOfObject, urlParams, validatePathParam };