@scaleway/sdk 2.0.0-alpha.13 → 2.0.0-alpha.15

package/dist/scw/fetch/resource-paginator.js

@@ -0,0 +1,84 @@
+const extract = key => result => result[key];
+function* pages(key, fetcher, request, firstPage) {
+  if (!Array.isArray(firstPage[key])) {
+    throw new Error(`Property ${key} is not a list in paginated result`);
+  }
+  const getList = extract(key);
+  let page = request.page || 1;
+  if (page === 1) {
+    yield Promise.resolve(getList(firstPage));
+    page += 1;
+  }
+  const {
+    length
+  } = firstPage[key];
+  if (!length) return;
+  const {
+    totalCount
+  } = firstPage;
+  while (page <= Math.floor((totalCount + length - 1) / length)) {
+    yield fetcher({
+      ...request,
+      page
+    }).then(getList);
+    page += 1;
+  }
+}
+
+/**
+ * Fetches a paginated resource.
+ *
+ * @param key - The resource key of values list
+ * @param fetcher - The method to retrieve paginated resources
+ * @param request - A request with pagination options
+ * @param initial - The first page
+ * @returns An async generator of resources arrays
+ */
+function fetchPaginated(key, fetcher, request, initial) {
+  try {
+    if (initial === void 0) {
+      initial = fetcher(request);
+    }
+    return async function* () {
+      yield* pages(key, fetcher, request, await initial);
+    }();
+  } catch (e) {
+    return Promise.reject(e);
+  }
+}
+
+/**
+ * Fetches all paginated resource.
+ *
+ * @param key - The resource key of values list
+ * @param fetcher - The method to retrieve paginated resources
+ * @param request - A request with pagination options
+ * @param initial - The first page
+ * @returns A resources array Promise
+ */
+const fetchAll = async function (key, fetcher, request, initial) {
+  if (initial === void 0) {
+    initial = fetcher(request);
+  }
+  return (await Promise.all(Array.from(pages(key, fetcher, request, await initial)))).flat();
+};
+
+/**
+ * Enriches a listing method with helpers.
+ *
+ * @param key - The resource key of values list
+ * @param fetcher - The method to retrieve paginated resources
+ * @param request - A request with pagination options
+ * @returns A resource Promise with the pagination helpers
+ *
+ * @internal
+ */
+const enrichForPagination = (key, fetcher, request) => {
+  const firstPage = fetcher(request);
+  return Object.assign(firstPage, {
+    all: () => fetchAll(key, fetcher, request, firstPage),
+    [Symbol.asyncIterator]: () => fetchPaginated(key, fetcher, request, firstPage)
+  });
+};
+
+export { enrichForPagination, extract, fetchAll, fetchPaginated };

package/dist/scw/fetch/response-parser.js

@@ -0,0 +1,72 @@
+import { isResponse } from '../../helpers/is-response.js';
+import { isJSONObject } from '../../helpers/json.js';
+import { parseScalewayError } from '../errors/error-parser.js';
+import { ScalewayError } from '../errors/scw-error.js';
+
+const X_TOTAL_COUNT_HEADER_KEY = 'x-total-count';
+const TOTAL_COUNT_RES_KEY = 'total_count';
+
+/**
+ * Fixes the totalCount property for old APIs.
+ *
+ * @internal
+ */
+const fixLegacyTotalCount = (obj, headers) => {
+  const headerVal = headers.get(X_TOTAL_COUNT_HEADER_KEY);
+  if (!headerVal) {
+    return obj;
+  }
+  const totalCount = parseInt(headerVal, 10);
+  if (Number.isNaN(totalCount)) {
+    return obj;
+  }
+  if (isJSONObject(obj) && !(TOTAL_COUNT_RES_KEY in obj)) {
+    return Object.assign(obj, {
+      [TOTAL_COUNT_RES_KEY]: totalCount
+    });
+  }
+  return obj;
+};
+
+/**
+ * Makes response parser.
+ *
+ * @param unmarshaller - The response payload unmarshaller
+ * @returns An async converter of HTTP Response to desired result
+ *
+ * @throws {@link ScalewayError}
+ * Thrown by the API if the request couldn't be completed.
+ *
+ * @throws TypeError
+ * Thrown if the response parameter isn't of the expected type.
+ *
+ * @throws Error
+ * JSON parsing could trigger an error.
+ *
+ * @internal
+ */
+const responseParser = (unmarshaller, responseType) => async response => {
+  if (!isResponse(response)) {
+    throw new TypeError('Invalid response object');
+  }
+  if (response.ok) {
+    if (response.status === 204) return unmarshaller(undefined);
+    const contentType = response.headers.get('Content-Type');
+    try {
+      if (responseType === 'json' && contentType === 'application/json') {
+        return unmarshaller(fixLegacyTotalCount(await response.json(), response.headers));
+      }
+      if (responseType === 'blob') {
+        return unmarshaller(await response.blob());
+      }
+      return unmarshaller(await response.text());
+    } catch (err) {
+      throw new ScalewayError(response.status, `could not parse '${contentType ?? ''}' response${err instanceof Error ? `: ${err.message}` : ''}`);
+    }
+  }
+  const error = await response.clone().json().catch(() => response.text());
+  if (isJSONObject(error)) throw parseScalewayError(response.status, error);
+  throw new ScalewayError(response.status, typeof error === 'string' ? error : 'cannot read error response body');
+};
+
+export { fixLegacyTotalCount, responseParser };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk",
-  "version": "2.0.0-alpha.13",
+  "version": "2.0.0-alpha.15",
   "license": "Apache-2.0",
   "description": "Scaleway SDK.",
   "keywords": [
@@ -35,5 +35,5 @@
   "bundledDependencies": [
     "@scaleway/random-name"
   ],
-  "gitHead": "c44b344492909e4b368507a685f9d186505746f8"
+  "gitHead": "f1ccf454891957e771ceff60eedb1574c215e057"
 }