@graphql-box/cache-manager 5.3.3 → 5.4.0

package/src/constants.ts

@@ -1,6 +1,6 @@
-export const METADATA = 'metadata' as const;
-export const CACHE_CONTROL = 'cacheControl' as const;
-export const NO_CACHE = 'noCache' as const;
+export const METADATA = 'metadata';
+export const CACHE_CONTROL = 'cacheControl';
+export const NO_CACHE = 'noCache';
 
-export const HEADER_CACHE_CONTROL = 'cache-control' as const;
-export const HEADER_NO_CACHE = 'no-cache' as const;
+export const HEADER_CACHE_CONTROL = 'cache-control';
+export const HEADER_NO_CACHE = 'no-cache';

package/src/debug/logCacheEntry.ts

@@ -7,7 +7,7 @@ type Descriptor = (
   value: unknown,
   cachemapOptions: CachemapOptions,
   options: RequestOptions,
-  context: CacheManagerContext & { requestFieldCacheKey?: string }
+  context: CacheManagerContext & { requestFieldCacheKey?: string },
 ) => Promise<void>;
 
 export const logCacheEntry = () => {
@@ -20,7 +20,7 @@ export const logCacheEntry = () => {
 
     descriptor.value = async function descriptorValue(...args: Parameters<Descriptor>): ReturnType<Descriptor> {
       return new Promise<void>(resolve => {
-        void (async () => {
+        const resolver = async () => {
           const { debugManager, requestFieldCacheKey, ...otherContext } = args[5];
 
           if (!debugManager) {
@@ -47,7 +47,9 @@ export const logCacheEntry = () => {
           };
 
           debugManager.log(CACHE_ENTRY_ADDED, payload);
-        })();
+        };
+
+        void resolver();
       });
     };
   };

package/src/debug/logCacheQuery.ts

@@ -5,7 +5,9 @@ type Descriptor = (
   cacheType: CacheTypes,
   hash: string,
   options: RequestOptions,
-  context: CacheManagerContext & { requestFieldCacheKey?: string }
+  context: CacheManagerContext & { requestFieldCacheKey?: string },
+  // Proving more difficult to fix, that worth the effort
+  // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
 ) => Promise<never | undefined>;
 
 export const logCacheQuery = () => {
@@ -17,16 +19,22 @@ export const logCacheQuery = () => {
     }
 
     descriptor.value = async function descriptorValue(...args: Parameters<Descriptor>): ReturnType<Descriptor> {
-      return new Promise(resolve => {
-        void (async () => {
+      // Proving more difficult to fix, that worth the effort
+      // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
+      return new Promise<never | undefined>(resolve => {
+        const resolver = async () => {
           const { debugManager, requestFieldCacheKey, ...otherContext } = args[3];
 
           if (!debugManager) {
+            // Proving more difficult to fix, that worth the effort
+            // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
             resolve(await method.apply(this, args));
             return;
           }
 
           const startTime = debugManager.now();
+          // Proving more difficult to fix, that worth the effort
+          // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
           const result = await method.apply(this, args);
           const endTime = debugManager.now();
           const duration = endTime - startTime;
@@ -43,7 +51,9 @@ export const logCacheQuery = () => {
           };
 
           debugManager.log(CACHE_ENTRY_QUERIED, payload);
-        })();
+        };
+
+        void resolver();
       });
     };
   };

package/src/debug/logPartialCompiled.ts

@@ -5,7 +5,7 @@ type Descriptor = (
   hash: string,
   partialQueryResponse: PartialQueryResponse,
   options: RequestOptions,
-  context: CacheManagerContext
+  context: CacheManagerContext,
 ) => void;
 
 export const logPartialCompiled = () => {

package/src/helpers/checkFieldPathChecklist.ts

@@ -2,7 +2,7 @@ import { type CheckFieldPathChecklistResult, type FieldPathChecklistValue } from
 
 export const checkFieldPathChecklist = (
   fieldPathChecklistValues: FieldPathChecklistValue[] | undefined,
-  fieldTypeName: string | undefined
+  fieldTypeName: string | undefined,
 ): CheckFieldPathChecklistResult => {
   if (!fieldPathChecklistValues || fieldPathChecklistValues.length === 0) {
     return { hasData: false, typeUnused: !!fieldTypeName };

package/src/helpers/createEntityDataKey.ts

@@ -4,8 +4,10 @@ import { type CacheManagerContext } from '../types.ts';
 export const createEntityDataKey = (
   fieldData: EntityData,
   fieldTypeInfo: FieldTypeInfo,
-  context: CacheManagerContext
+  context: CacheManagerContext,
 ) => {
   const fieldTypeName = fieldTypeInfo.isEntity ? fieldTypeInfo.typeName : fieldData.__typename;
+  // In context, context.typeIDKey is never gonna be undefined
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
   return `${fieldTypeName}::${String(fieldData[context.typeIDKey!])}`;
 };

package/src/helpers/filterField.ts

@@ -19,7 +19,7 @@ export const filterField = (
   fieldPathChecklist: FieldPathChecklist,
   fragmentSpreadChecklist: FragmentSpreadCheckist,
   ancestorRequestFieldPath: string,
-  context: CacheManagerContext
+  context: CacheManagerContext,
 ): boolean => {
   const { fragmentDefinitions, typeIDKey } = context;
   const fieldsAndTypeNames = getChildFields(field, { fragmentDefinitions });
@@ -43,7 +43,7 @@ export const filterField = (
       fragmentSpreadFieldCounter[fragmentName] = {
         hasData: 0,
         total: fragmentDefinitions?.[fragmentName]
-          ? getChildFields(fragmentDefinitions[fragmentName]!, { fragmentDefinitions })?.length ?? 0
+          ? (getChildFields(fragmentDefinitions[fragmentName], { fragmentDefinitions })?.length ?? 0)
           : 0,
       };
     }
@@ -59,7 +59,7 @@ export const filterField = (
       {
         requestFieldPath: ancestorRequestFieldPath,
       },
-      context
+      context,
     );
 
     const { hasData, typeUnused } = checkFieldPathChecklist(fieldPathChecklist.get(requestFieldPath), childTypeName);

package/src/helpers/filterFragmentDefinitions.ts

@@ -9,7 +9,7 @@ export const filterFragmentDefinitions = (
   ast: DocumentNode,
   fieldPathChecklist: FieldPathChecklist,
   fragmentSpreadChecklist: FragmentSpreadCheckist,
-  context: CacheManagerContext
+  context: CacheManagerContext,
 ) => {
   const definitionsToFilter = keys(fragmentSpreadChecklist).reduce<{ name: string; path: string }[]>(
     (namesAndPaths, key) => {
@@ -20,9 +20,11 @@ export const filterFragmentDefinitions = (
       }
 
       const { deleted, paths, total } = checklist;
+      // Will come back and sort this out later
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       return deleted === 0 && total === 1 ? [...namesAndPaths, { name: key, path: paths[0]! }] : namesAndPaths;
     },
-    []
+    [],
   );
 
   const { fragmentDefinitions = {} } = context;

package/src/helpers/filterFragmentSpreads.ts

@@ -8,13 +8,13 @@ export const filterFragmentSpreads = (
   field: FieldNode | FragmentDefinitionNode | OperationDefinitionNode,
   fragmentSpreadFieldCounter: FragmentSpreadFieldCounter,
   fragmentSpreadChecklist: FragmentSpreadCheckist,
-  ancestorRequestFieldPath: string
+  ancestorRequestFieldPath: string,
 ) => {
   if (isEmpty(fragmentSpreadFieldCounter)) {
     return;
   }
 
-  for (const key of Object.keys(fragmentSpreadFieldCounter)) {
+  for (const [key, value] of Object.entries(fragmentSpreadFieldCounter)) {
     const checklist = fragmentSpreadChecklist[key];
 
     if (!checklist) {
@@ -22,7 +22,7 @@ export const filterFragmentSpreads = (
     }
 
     checklist.paths.push(ancestorRequestFieldPath);
-    const { hasData, total } = fragmentSpreadFieldCounter[key]!;
+    const { hasData, total } = value;
 
     if (hasData === total) {
       deleteFragmentSpreads(field, key);

package/src/helpers/filterIDsAndTypeNames.ts

@@ -1,11 +1,11 @@
 import { TYPE_NAME_KEY } from '@graphql-box/core';
-import { deleteChildFields, getChildFields, getName } from '@graphql-box/helpers';
+import { deleteChildFields, getChildFields } from '@graphql-box/helpers';
 import { type FieldNode, type FragmentDefinitionNode, type OperationDefinitionNode } from 'graphql';
 import { type CacheManagerContext } from '../types.ts';
 
 export const filterIDsAndTypeNames = (
   field: FieldNode | FragmentDefinitionNode | OperationDefinitionNode,
-  { fragmentDefinitions, typeIDKey }: CacheManagerContext
+  { fragmentDefinitions, typeIDKey }: CacheManagerContext,
 ) => {
   const fieldsAndTypeNames = getChildFields(field, { fragmentDefinitions });
 
@@ -13,12 +13,12 @@ export const filterIDsAndTypeNames = (
     return false;
   }
 
-  const fieldNames = fieldsAndTypeNames.map(({ fieldNode }) => getName(fieldNode)!);
+  const fieldNames = fieldsAndTypeNames.map(({ fieldNode }) => fieldNode.name.value);
 
   if (fieldNames.length === 2 && fieldNames.every(name => name === typeIDKey || name === TYPE_NAME_KEY)) {
     deleteChildFields(
       field,
-      fieldsAndTypeNames.map(({ fieldNode }) => fieldNode)
+      fieldsAndTypeNames.map(({ fieldNode }) => fieldNode),
     );
 
     return true;

package/src/helpers/filterInlineFragments.ts

@@ -4,7 +4,7 @@ import { type CacheManagerContext } from '../types.ts';
 
 export const filterInlineFragments = (
   field: FieldNode | FragmentDefinitionNode | OperationDefinitionNode,
-  { fragmentDefinitions, typeIDKey }: CacheManagerContext
+  { fragmentDefinitions, typeIDKey }: CacheManagerContext,
 ) => {
   const inlineFragments = getInlineFragments(field);
   let filtered = false;

package/src/helpers/filterOperationAndFragmentDefinitions.ts

@@ -5,6 +5,6 @@ export const filterOperationAndFragmentDefinitions = (ast: DocumentNode) => {
   return ast.definitions.filter(
     definition =>
       isKind<OperationDefinitionNode>(definition, Kind.OPERATION_DEFINITION) ||
-      isKind<FragmentDefinitionNode>(definition, Kind.FRAGMENT_DEFINITION)
-  ) as (OperationDefinitionNode | FragmentDefinitionNode)[];
+      isKind<FragmentDefinitionNode>(definition, Kind.FRAGMENT_DEFINITION),
+  );
 };

package/src/helpers/filterOutPropsWithEntityArgsOrDirectives.ts

@@ -15,7 +15,7 @@ export const filterOutPropsWithEntityArgsOrDirectives = (
   fieldData: unknown,
   field: FieldNode,
   ancestorKeysAndPaths: KeysAndPaths,
-  context: CacheManagerContext
+  context: CacheManagerContext,
 ) => {
   if (!isPlainObject(fieldData)) {
     return fieldData;
@@ -31,10 +31,13 @@ export const filterOutPropsWithEntityArgsOrDirectives = (
       const fieldTypeInfo = context.fieldTypeMap.get(keysAndPaths.requestFieldPath);
 
       if (
+        // In this context, typeIDKey cannot be undefined
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         isFieldEntity(fieldData[key], fieldTypeInfo, context.typeIDKey!) ||
         fieldTypeInfo?.hasArguments ||
         fieldTypeInfo?.hasDirectives
       ) {
+        // In this context, this is safe
         // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
         delete fieldData[key];
       }

package/src/helpers/filterOutPropsWithEntityOrArgs.ts

@@ -1,7 +1,6 @@
 import { type EntityData } from '@graphql-box/core';
 import { type KeysAndPaths, buildFieldKeysAndPaths, getName, resolveFragments } from '@graphql-box/helpers';
 import { type FieldNode } from 'graphql';
-import { keys } from 'lodash-es';
 import { type CacheManagerContext } from '../types.ts';
 import { isFieldEntity } from './isFieldEntity.ts';
 
@@ -9,18 +8,23 @@ export const filterOutPropsWithEntityOrArgs = (
   fieldData: EntityData,
   field: FieldNode,
   ancestorKeysAndPaths: KeysAndPaths,
-  context: CacheManagerContext
+  context: CacheManagerContext,
 ) => {
   const fieldAndTypeName = resolveFragments(field.selectionSet?.selections, context.fragmentDefinitions);
 
-  return keys(fieldData).reduce<Partial<EntityData>>((acc, key) => {
+  // The data returned will be EntityData
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+  return Object.keys(fieldData).reduce<Partial<EntityData>>((acc, key) => {
     const match = fieldAndTypeName.find(({ fieldNode }) => getName(fieldNode) === key);
 
     if (match) {
       const { requestFieldPath } = buildFieldKeysAndPaths(match.fieldNode, ancestorKeysAndPaths, context);
       const fieldTypeInfo = context.fieldTypeMap.get(requestFieldPath);
 
+      // In this context, typeIDKey will not be undefined
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       if (isFieldEntity(fieldData[key], fieldTypeInfo, context.typeIDKey!) || fieldTypeInfo?.hasArguments) {
+        // In this context, this is safe
         // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
         delete fieldData[key];
       }

package/src/helpers/filterQuery.ts

@@ -13,7 +13,7 @@ import { filterFragmentDefinitions } from './filterFragmentDefinitions.ts';
 export const filterQuery = (
   requestData: RequestData,
   { fieldPathChecklist }: CachedResponseData,
-  context: CacheManagerContext
+  context: CacheManagerContext,
 ) => {
   const { ast } = requestData;
   const queryNode = getOperationDefinitions(ast, context.operation)[0];
@@ -32,6 +32,8 @@ export const filterQuery = (
   const fragmentSpreadChecklist = createFragmentSpreadChecklist(requestData, context);
 
   for (let index = fieldsAndTypeNames.length - 1; index >= 0; index -= 1) {
+    // In this context fieldsAndTypeNames[index] will not be undefined
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     const { fieldNode } = fieldsAndTypeNames[index]!;
 
     const { requestFieldPath } = buildFieldKeysAndPaths(
@@ -39,7 +41,7 @@ export const filterQuery = (
       {
         requestFieldPath: operation,
       },
-      context
+      context,
     );
 
     if (filterField(fieldNode, fieldPathChecklist, fragmentSpreadChecklist, requestFieldPath, context)) {

package/src/helpers/getDataValue.ts

@@ -3,10 +3,14 @@ import { isNumber, isString } from 'lodash-es';
 
 export const getDataValue = <T>(value: unknown, key: string | number): T | undefined => {
   if (isArray(value) && isNumber(key)) {
+    // Casting for ease of typing for consumers
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     return value[key] as T;
   }
 
   if (isPlainObject(value) && isString(key)) {
+    // Casting for ease of typing for consumers
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     return value[key] as T;
   }
 

package/src/helpers/isFieldEntity.ts

@@ -4,7 +4,7 @@ import { isPlainObject } from '@graphql-box/helpers';
 export const isFieldEntity = (
   fieldData: unknown,
   fieldTypeInfo: FieldTypeInfo | undefined,
-  typeIDKey: string
+  typeIDKey: string,
 ): fieldData is EntityData => {
   if (!isPlainObject(fieldData) || !(typeIDKey in fieldData)) {
     return false;

package/src/helpers/isFirstResponseChunk.ts

@@ -3,5 +3,5 @@ import { type CacheManagerContext } from '../types.ts';
 
 export const isFirstResponseChunk = (
   rawResponseData: RawResponseDataWithMaybeCacheMetadata,
-  context: CacheManagerContext
+  context: CacheManagerContext,
 ) => context.hasDeferOrStream && rawResponseData.hasNext && !rawResponseData.paths;

package/src/helpers/isLastResponseChunk.ts

@@ -3,5 +3,5 @@ import { type CacheManagerContext } from '../types.ts';
 
 export const isLastResponseChunk = (
   rawResponseData: RawResponseDataWithMaybeCacheMetadata,
-  context: CacheManagerContext
+  context: CacheManagerContext,
 ) => context.hasDeferOrStream && !rawResponseData.hasNext && rawResponseData.paths;

package/src/helpers/isNotLastResponseChunk.ts

@@ -3,5 +3,5 @@ import { type CacheManagerContext } from '../types.ts';
 
 export const isNotLastResponseChunk = (
   rawResponseData: RawResponseDataWithMaybeCacheMetadata,
-  context: CacheManagerContext
+  context: CacheManagerContext,
 ) => context.hasDeferOrStream && rawResponseData.hasNext;

package/src/helpers/isNotResponseChunk.ts

@@ -3,5 +3,5 @@ import { type CacheManagerContext } from '../types.ts';
 
 export const isNotResponseChunk = (
   rawResponseData: RawResponseDataWithMaybeCacheMetadata,
-  context: CacheManagerContext
+  context: CacheManagerContext,
 ) => !context.hasDeferOrStream && !rawResponseData.hasNext && !rawResponseData.paths;

package/src/helpers/mergeObjects.ts

@@ -2,6 +2,8 @@ import { isPlainObject, mergeObjects } from '@graphql-box/helpers';
 
 export const mergeDataSets = <T extends object>(obj: T, source: T, typeIDKey: string): T => {
   return mergeObjects<T>(obj, source, (_key: string, value: unknown): string | number | undefined => {
+    // Casting of ease of typing
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     return isPlainObject(value) && value[typeIDKey] ? (value[typeIDKey] as string | number) : undefined;
   });
 };

package/src/helpers/mergeResponseDataSets.ts

@@ -30,6 +30,6 @@ export const mergeResponseDataSets = (responseDataSets: RawResponseDataWithMaybe
 
       return acc;
     },
-    { data: {} }
+    { data: {} },
   );
 };

package/src/helpers/normalizePatchResponseData.ts

@@ -4,7 +4,7 @@ import { type CacheManagerContext } from '../types.ts';
 
 export const normalizePatchResponseData = (
   rawResponseData: RawResponseDataWithMaybeCacheMetadata,
-  context: CacheManagerContext
+  context: CacheManagerContext,
 ) => {
   if (!context.normalizePatchResponseData) {
     return rawResponseData;

package/src/helpers/validTypeIdValue.ts

@@ -4,13 +4,15 @@ import { isPlainObject } from '@graphql-box/helpers';
 export const getValidTypeIdValue = (
   requestFieldPathData: unknown,
   { typeIDValue }: FieldTypeInfo,
-  typeIDKey: string
+  typeIDKey: string,
 ): string | number | undefined => {
   if (typeIDValue) {
     return typeIDValue;
   }
 
   if (isPlainObject(requestFieldPathData)) {
+    // Identifier value can only be one of these types
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     return requestFieldPathData[typeIDKey] as string | number | undefined;
   }