@graphql-box/connection-resolver 5.3.1 → 5.4.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@graphql-box/connection-resolver",
   "description": "The GraphQL Box connection resolver module.",
-  "version": "5.3.1",
+  "version": "5.4.0",
   "author": "Dylan Aubrey",
   "license": "MIT",
   "homepage": "https://github.com/badbatch/graphql-box",
@@ -15,6 +15,9 @@
   "main": "./dist/cjs/index.cjs",
   "module": "./dist/esm/index.mjs",
   "types": "./dist/types/cjs/index.d.cts",
+  "imports": {
+    "#*": "./src/*"
+  },
   "exports": {
     ".": {
       "types": {
@@ -29,27 +32,23 @@
     "access": "public"
   },
   "dependencies": {
-    "@cachemap/core": "^5.0.9",
-    "js-base64": "^3.7.5",
-    "type-fest": "^4.5.0",
-    "@graphql-box/core": "5.3.1"
+    "@cachemap/core": "^5.2.2",
+    "@types/lodash-es": "^4.17.12",
+    "core-js": "^3.39.0",
+    "js-base64": "^3.7.7",
+    "lodash-es": "^4.17.21",
+    "type-fest": "^4.30.0",
+    "@graphql-box/core": "5.4.0"
   },
   "peerDependencies": {
-    "@babel/runtime": "<8",
-    "core-js": "<4",
-    "graphql": "<17",
-    "lodash-es": "<5"
+    "graphql": "<17"
   },
   "devDependencies": {
-    "@babel/runtime": "^7.20.13",
-    "@cachemap/map": "^5.0.6",
+    "@cachemap/map": "^5.0.8",
     "@jest/globals": "^29.3.1",
-    "@types/lodash-es": "^4.14.191",
-    "core-js": "^3.27.2",
-    "cts-types": "^0.0.6",
-    "del-cli": "^5.1.0",
-    "graphql": "^16.8.1",
-    "lodash-es": "^4.17.21"
+    "cts-types": "^0.0.8",
+    "del-cli": "^6.0.0",
+    "graphql": "^16.9.0"
   },
   "keywords": [
     "client",

package/src/__testUtils__/generateCursorCache.ts

@@ -32,7 +32,7 @@ export const generateCursorCache = async ({
 
     await Promise.all(
       pages.map(async page => {
-        const isLastPage = page === pages[pages.length - 1];
+        const isLastPage = page === pages.at(-1);
         let resultsOnCurrentPage: number;
 
         if (isLastPage) {
@@ -43,18 +43,18 @@ export const generateCursorCache = async ({
         }
 
         const edges = Array.from({ length: resultsOnCurrentPage }, (_v, index) => index).map(index => {
-          const id = encode(`${index}::${page}`);
+          const id = encode(`${String(index)}::${String(page)}`);
           return { cursor: `${id}::${group}`, node: { id } };
         });
 
         await cacheCursors(cursorCache, { edges, group, headers, page, totalPages, totalResults });
-      })
+      }),
     );
   } else {
     await cursorCache.set(
       `${group}-metadata`,
       { totalPages, totalResults },
-      { cacheHeaders: { cacheControl: headers.get('cache-control') ?? undefined } }
+      { cacheHeaders: { cacheControl: headers.get('cache-control') ?? undefined } },
     );
   }
 

package/src/__testUtils__/generatePageResponse.ts

@@ -15,7 +15,7 @@ export const generatePageResponse =
       data: {
         page,
         results: Array.from({ length: resultsPerPage }, (_v, index) => index).map(index => {
-          return { id: encode(`${index}::${page}`) };
+          return { id: encode(`${String(index)}::${String(page)}`) };
         }),
         totalPages,
         totalResults,

package/src/helpers/cacheCursors.ts

@@ -12,13 +12,13 @@ export type Params = {
 
 export const cacheCursors = async (
   cursorCache: Core,
-  { edges, group, headers, page, totalPages, totalResults }: Params
+  { edges, group, headers, page, totalPages, totalResults }: Params,
 ) => {
   const cacheControl = headers.get('cache-control');
   const options = cacheControl ? { cacheHeaders: { cacheControl } } : undefined;
 
   await Promise.all(
-    edges.map(async ({ cursor, node }, index) => cursorCache.set(cursor, { group, index, node, page }, options))
+    edges.map(async ({ cursor, node }, index) => cursorCache.set(cursor, { group, index, node, page }, options)),
   );
 
   await cursorCache.set(`${group}-metadata`, { totalPages, totalResults }, options);

package/src/helpers/getCount.ts

@@ -1,3 +1,6 @@
 import { type ConnectionInputOptions } from '../types.ts';
 
+// Based on how ConnectionInputOptions are generated, either first
+// or last would be set.
+// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 export const getCount = ({ first, last }: ConnectionInputOptions) => first ?? last!;

package/src/helpers/getInRangeCachedEdges.ts

@@ -9,7 +9,7 @@ export type Context = {
 
 export const getInRangeCachedEdges = (
   cachedEdgesByPage: CachedEdges[],
-  { endIndex, resultsPerPage, startIndex }: Context
+  { endIndex, resultsPerPage, startIndex }: Context,
 ) => {
   return cachedEdgesByPage.reduce<CachedEdges[]>((inRange, cachedEdgesPage, index) => {
     const currentPageStartIndex = getCurrentPageStartIndex({ pageIndex: index, startIndex });

package/src/helpers/getIndexesOnCurrentPage.test.ts

@@ -4,7 +4,7 @@ describe('getIndexesOnCurrentPage', () => {
   describe('when current page is last page', () => {
     it('should return the correct value', () => {
       expect(
-        getIndexesOnCurrentPage({ metadata: { totalPages: 6, totalResults: 53 }, page: 6, resultsPerPage: 10 })
+        getIndexesOnCurrentPage({ metadata: { totalPages: 6, totalResults: 53 }, page: 6, resultsPerPage: 10 }),
       ).toBe(2);
     });
   });
@@ -12,7 +12,7 @@ describe('getIndexesOnCurrentPage', () => {
   describe('when current page is NOT last page', () => {
     it('should return the correct value', () => {
       expect(
-        getIndexesOnCurrentPage({ metadata: { totalPages: 6, totalResults: 53 }, page: 5, resultsPerPage: 10 })
+        getIndexesOnCurrentPage({ metadata: { totalPages: 6, totalResults: 53 }, page: 5, resultsPerPage: 10 }),
       ).toBe(9);
     });
   });

package/src/helpers/getPageNumbersToRequest.ts

@@ -20,7 +20,7 @@ export type Context = {
 
 export const getPageNumbersToRequest = (
   args: ConnectionInputOptions,
-  { endIndex, entry: { page }, metadata, resultsPerPage, startIndex }: GetPageNumbersToRequestContext & Context
+  { endIndex, entry: { page }, metadata, resultsPerPage, startIndex }: GetPageNumbersToRequestContext & Context,
 ) => {
   const startPageNumber = getStartPageNumber(args, { page, resultsPerPage, startIndex });
   const endPageNumber = getEndPageNumber(args, { endIndex, metadata, page, resultsPerPage });

package/src/helpers/getStartAndEndCursors.ts

@@ -3,6 +3,6 @@ import { type Edge } from '../types.ts';
 export const getStartCursor = (edges: Edge[]) => edges[0]?.cursor;
 
 export const getEndCursor = (edges: Edge[]) => {
-  const lastEdge = edges[edges.length - 1];
+  const lastEdge = edges.at(-1);
   return lastEdge?.cursor;
 };

package/src/helpers/getStartAndEndIndexes.ts

@@ -13,32 +13,32 @@ export type Context = {
 
 export const getStartIndex = (
   args: ConnectionInputOptions,
-  { entry: { index, page }, resultsPerPage }: Pick<Context, 'entry' | 'resultsPerPage'>
+  { entry: { index, page }, resultsPerPage }: Pick<Context, 'entry' | 'resultsPerPage'>,
 ) => {
   const count = getCount(args);
 
   return getDirection(args.last) === 'forward'
     ? { absolute: index + 1, relative: index + 1 }
     : isFirstPage(page) && index - count < 0
-    ? { absolute: 0, relative: 0 }
-    : (() => {
-        const absoluteStartIndex = index - count;
+      ? { absolute: 0, relative: 0 }
+      : (() => {
+          const absoluteStartIndex = index - count;
 
-        if (absoluteStartIndex >= 0) {
-          return { absolute: absoluteStartIndex, relative: absoluteStartIndex };
-        }
+          if (absoluteStartIndex >= 0) {
+            return { absolute: absoluteStartIndex, relative: absoluteStartIndex };
+          }
 
-        const indexesRemainingAfterLastPage = Math.abs(absoluteStartIndex);
-        const pagesRemaining = indexesRemainingAfterLastPage / resultsPerPage + 1;
-        const remainder = indexesRemainingAfterLastPage % resultsPerPage;
-        const relativeStartIndex = remainder === 0 ? 0 : page - pagesRemaining < 0 ? 0 : resultsPerPage - remainder;
-        return { absolute: absoluteStartIndex, relative: relativeStartIndex };
-      })();
+          const indexesRemainingAfterLastPage = Math.abs(absoluteStartIndex);
+          const pagesRemaining = indexesRemainingAfterLastPage / resultsPerPage + 1;
+          const remainder = indexesRemainingAfterLastPage % resultsPerPage;
+          const relativeStartIndex = remainder === 0 ? 0 : page - pagesRemaining < 0 ? 0 : resultsPerPage - remainder;
+          return { absolute: absoluteStartIndex, relative: relativeStartIndex };
+        })();
 };
 
 export const getEndIndex = (
   args: ConnectionInputOptions,
-  { entry: { index, page }, metadata: { totalPages, totalResults }, resultsPerPage }: Context
+  { entry: { index, page }, metadata: { totalPages, totalResults }, resultsPerPage }: Context,
 ) => {
   const count = getCount(args);
   const indexesOnLastPage = getIndexesOnLastPage({ resultsPerPage, totalResults });
@@ -46,22 +46,22 @@ export const getEndIndex = (
   return getDirection(args.last) === 'backward'
     ? { absolute: index - 1, relative: index - 1 }
     : isLastPage({ page, totalPages }) && index + count > indexesOnLastPage
-    ? { absolute: indexesOnLastPage, relative: indexesOnLastPage }
-    : (() => {
-        const absoluteEndIndex = index + count;
-        const indexesPerPage = resultsPerPage - 1;
+      ? { absolute: indexesOnLastPage, relative: indexesOnLastPage }
+      : (() => {
+          const absoluteEndIndex = index + count;
+          const indexesPerPage = resultsPerPage - 1;
 
-        if (absoluteEndIndex <= indexesPerPage) {
-          return { absolute: absoluteEndIndex, relative: absoluteEndIndex };
-        }
+          if (absoluteEndIndex <= indexesPerPage) {
+            return { absolute: absoluteEndIndex, relative: absoluteEndIndex };
+          }
 
-        const indexesRemainingAfterFirstPage = absoluteEndIndex - indexesPerPage;
-        const pagesRemaining = indexesRemainingAfterFirstPage / resultsPerPage;
-        const remainder = indexesRemainingAfterFirstPage % resultsPerPage;
+          const indexesRemainingAfterFirstPage = absoluteEndIndex - indexesPerPage;
+          const pagesRemaining = indexesRemainingAfterFirstPage / resultsPerPage;
+          const remainder = indexesRemainingAfterFirstPage % resultsPerPage;
 
-        const relativeEndIndex =
-          remainder === 0 ? indexesPerPage : page + pagesRemaining > totalPages ? indexesOnLastPage : remainder - 1;
+          const relativeEndIndex =
+            remainder === 0 ? indexesPerPage : page + pagesRemaining > totalPages ? indexesOnLastPage : remainder - 1;
 
-        return { absolute: absoluteEndIndex, relative: relativeEndIndex };
-      })();
+          return { absolute: absoluteEndIndex, relative: relativeEndIndex };
+        })();
 };

package/src/helpers/getStartAndEndPageNumbers.ts

@@ -15,19 +15,19 @@ export type Context = {
 
 export const getStartPageNumber = (
   args: ConnectionInputOptions,
-  { page, resultsPerPage, startIndex }: Omit<PageNumberContext, 'endIndex'> & Omit<Context, 'metadata'>
+  { page, resultsPerPage, startIndex }: Omit<PageNumberContext, 'endIndex'> & Omit<Context, 'metadata'>,
 ) => {
   if (getDirection(args.last) === 'forward' || startIndex.absolute >= 0) {
     return page;
   }
 
   const startPageNumber = page - Math.ceil(Math.abs(startIndex.absolute) / resultsPerPage);
-  return startPageNumber <= 1 ? 1 : startPageNumber;
+  return Math.max(startPageNumber, 1);
 };
 
 export const getEndPageNumber = (
   args: ConnectionInputOptions,
-  { endIndex, metadata: { totalPages }, page, resultsPerPage }: Omit<PageNumberContext, 'startIndex'> & Context
+  { endIndex, metadata: { totalPages }, page, resultsPerPage }: Omit<PageNumberContext, 'startIndex'> & Context,
 ) => {
   const indexesPerPage = resultsPerPage - 1;
 
@@ -40,5 +40,5 @@ export const getEndPageNumber = (
   }
 
   const endPageNumber = page + Math.ceil((endIndex.absolute - indexesPerPage) / resultsPerPage);
-  return endPageNumber >= totalPages ? totalPages : endPageNumber;
+  return Math.min(endPageNumber, totalPages);
 };

package/src/helpers/hasPreviousNextPage.ts

@@ -23,6 +23,5 @@ export const hasNextPage = ({
   metadata: { totalPages, totalResults },
   resultsPerPage,
 }: HasNextPageParams) =>
-  (isNumber(cachedEdgesByPage[cachedEdgesByPage.length - 1]?.pageNumber) &&
-    cachedEdgesByPage[cachedEdgesByPage.length - 1]?.pageNumber !== totalPages) ||
+  (isNumber(cachedEdgesByPage.at(-1)?.pageNumber) && cachedEdgesByPage.at(-1)?.pageNumber !== totalPages) ||
   endIndex.relative < getIndexesOnLastPage({ resultsPerPage, totalResults });

package/src/helpers/isCursorLast.test.ts

@@ -13,7 +13,7 @@ describe('isCursorLast', () => {
           resultsPerPage: 10,
           totalPages: 6,
           totalResults: 53,
-        })
+        }),
       ).toBe(true);
     });
   });
@@ -29,7 +29,7 @@ describe('isCursorLast', () => {
           resultsPerPage: 10,
           totalPages: 6,
           totalResults: 53,
-        })
+        }),
       ).toBe(false);
     });
   });

package/src/helpers/makeEntry.ts

@@ -9,7 +9,7 @@ export type Context = {
 
 export const makeEntry = (
   args: ConnectionInputOptions,
-  { metadata: { totalPages, totalResults }, resultsPerPage }: Context
+  { metadata: { totalPages, totalResults }, resultsPerPage }: Context,
 ) => {
   if (getDirection(args.last) === 'backward') {
     return { index: getIndexesOnLastPage({ resultsPerPage, totalResults }) + 1, page: totalPages };

package/src/helpers/requestAndCachePages.ts

@@ -14,7 +14,7 @@ export type Context<Resource extends PlainObject, ResourceNode extends Node> = {
 
 export const requestAndCachePages = async <Resource extends PlainObject, ResourceNode extends Node>(
   pages: number[],
-  { cursorCache, getters, groupCursor, makeIDCursor, resourceResolver }: Context<Resource, ResourceNode>
+  { cursorCache, getters, groupCursor, makeIDCursor, resourceResolver }: Context<Resource, ResourceNode>,
 ) => {
   const errors: Error[] = [];
 
@@ -48,7 +48,7 @@ export const requestAndCachePages = async <Resource extends PlainObject, Resourc
       }
 
       return { edges: [], pageNumber: page };
-    })
+    }),
   );
 
   return { cachedEdges, errors };

package/src/helpers/requestOutstandingPages.ts

@@ -14,7 +14,7 @@ export type RequestMissingPagesCallback = (params: { nextPage: number }) => Prom
 
 export const requestOutstandingPages = async (
   { count, direction, page, results, resultsPerPage, totalPages, totalResults }: RequestMissingPagesParams,
-  requestCallback: RequestMissingPagesCallback
+  requestCallback: RequestMissingPagesCallback,
 ) => {
   const resultsOnLastPage = totalResults % totalPages;
   const outstanding = count - results;

package/src/helpers/resolveConnection.ts

@@ -20,7 +20,14 @@ export type Context<Resource extends PlainObject, ResourceNode extends Node> = {
 
 export const resolveConnection = async <Resource extends PlainObject, ResourceNode extends Node>(
   args: PlainObject & ConnectionInputOptions,
-  { cursorCache, getters, groupCursor, makeIDCursor, resourceResolver, resultsPerPage }: Context<Resource, ResourceNode>
+  {
+    cursorCache,
+    getters,
+    groupCursor,
+    makeIDCursor,
+    resourceResolver,
+    resultsPerPage,
+  }: Context<Resource, ResourceNode>,
 ) => {
   const { cachedEdges, hasNextPage, hasPreviousPage, indexes, missingPages, totalResults } =
     await retrieveCachedConnection(args, {