@data-client/react/legacy/hooks/useDLE.js

Async State Management without the Management. REST, GraphQL, SSE, Websockets, Fetch

import _extends from "@babel/runtime/helpers/esm/extends";
import { ExpiryStatus } from '@data-client/core';
import { useEffect, useMemo } from 'react';
import useCacheState from './useCacheState.js';
import useController from './useController.js';

/**
 * Use async data with { data, loading, error } (DLE)
 * @see https://dataclient.io/docs/api/useDLE
 */

export default function useDLE(endpoint, ...args) {
  const state = useCacheState();
  const controller = useController();
  const key = args[0] !== null ? endpoint.key(...args) : '';
  const cacheResults = key && state.endpoints[key];
  const meta = state.meta[key];

  // Compute denormalized value
  // eslint-disable-next-line prefer-const
  let {
    data,
    expiryStatus,
    expiresAt,
    countRef
  } = useMemo(() => {
    return controller.getResponseMeta(endpoint, ...args, state);
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [cacheResults, state.indexes, state.entities, state.entityMeta, meta, key]);

  // If we are hard invalid we must fetch regardless of triggering or staleness
  const forceFetch = expiryStatus === ExpiryStatus.Invalid;
  const maybePromise = useMemo(() => {
    // null params mean don't do anything
    if (Date.now() <= expiresAt && !forceFetch || !key) return;
    return controller.fetch(endpoint, ...args).catch(() => {});
    // we need to check against serialized params, since params can change frequently
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [expiresAt, key, forceFetch, state.lastReset]);

  // fully "valid" data will not suspend/loading even if it is not fresh
  const loading = expiryStatus !== ExpiryStatus.Valid && !!maybePromise;
  data = useMemo(() => {
    // if useSuspense() would suspend, don't include entities from cache
    if (loading) {
      if (!endpoint.schema) return undefined;
      // TODO: use getResponse() once it just returns data
      return controller.getResponseMeta(endpoint, ...args, _extends({}, state, {
        entities: {}
      })).data;
    }
    return data;
    // key substitutes args + endpoint
    // we only need cacheResults, as entities are not used in this case
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [key, data, loading, cacheResults]);
  const error = controller.getError(endpoint, ...args, state);

  // eslint-disable-next-line react-hooks/exhaustive-deps
  useEffect(countRef, [data]);
  return {
    data,
    loading,
    error
  };
}
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"names":["ExpiryStatus","useEffect","useMemo","useCacheState","useController","useDLE","endpoint","args","state","controller","key","cacheResults","endpoints","meta","data","expiryStatus","expiresAt","countRef","getResponseMeta","indexes","entities","entityMeta","forceFetch","Invalid","maybePromise","Date","now","fetch","catch","lastReset","loading","Valid","schema","undefined","_extends","error","getError"],"sources":["../../src/hooks/useDLE.ts"],"sourcesContent":["import type {\n  Denormalize,\n  DenormalizeNullable,\n  ErrorTypes,\n  EndpointInterface,\n  FetchFunction,\n  Schema,\n  ResolveType,\n} from '@data-client/core';\nimport { ExpiryStatus } from '@data-client/core';\nimport { useEffect, useMemo } from 'react';\n\nimport useCacheState from './useCacheState.js';\nimport useController from './useController.js';\n\ntype SchemaReturn<S extends Schema | undefined> =\n  | {\n      data: Denormalize<S>;\n      loading: false;\n      error: undefined;\n    }\n  | { data: DenormalizeNullable<S>; loading: true; error: undefined }\n  | { data: DenormalizeNullable<S>; loading: false; error: ErrorTypes };\n\ntype AsyncReturn<E> =\n  | {\n      data: E extends (...args: any) => any ? ResolveType<E> : any;\n      loading: false;\n      error: undefined;\n    }\n  | { data: undefined; loading: true; error: undefined }\n  | { data: undefined; loading: false; error: ErrorTypes };\n\n/**\n * Use async data with { data, loading, error } (DLE)\n * @see https://dataclient.io/docs/api/useDLE\n */\nexport default function useDLE<\n  E extends EndpointInterface<\n    FetchFunction,\n    Schema | undefined,\n    undefined | false\n  >,\n>(\n  endpoint: E,\n  ...args: readonly [...Parameters<E>]\n): E['schema'] extends undefined | null ? AsyncReturn<E>\n: SchemaReturn<E['schema']>;\n\nexport default function useDLE<\n  E extends EndpointInterface<\n    FetchFunction,\n    Schema | undefined,\n    undefined | false\n  >,\n>(\n  endpoint: E,\n  ...args: readonly [...Parameters<E>] | readonly [null]\n): {\n  data: E['schema'] extends undefined | null ? undefined\n  : DenormalizeNullable<E['schema']>;\n  loading: boolean;\n  error: ErrorTypes | undefined;\n};\n\nexport default function useDLE<\n  E extends EndpointInterface<\n    FetchFunction,\n    Schema | undefined,\n    undefined | false\n  >,\n>(endpoint: E, ...args: readonly [...Parameters<E>] | readonly [null]): any {\n  const state = useCacheState();\n  const controller = useController();\n\n  const key = args[0] !== null ? endpoint.key(...args) : '';\n  const cacheResults = key && state.endpoints[key];\n  const meta = state.meta[key];\n\n  // Compute denormalized value\n  // eslint-disable-next-line prefer-const\n  let { data, expiryStatus, expiresAt, countRef } = useMemo(() => {\n    return controller.getResponseMeta(endpoint, ...args, state);\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [\n    cacheResults,\n    state.indexes,\n    state.entities,\n    state.entityMeta,\n    meta,\n    key,\n  ]);\n\n  // If we are hard invalid we must fetch regardless of triggering or staleness\n  const forceFetch = expiryStatus === ExpiryStatus.Invalid;\n\n  const maybePromise = useMemo(() => {\n    // null params mean don't do anything\n    if ((Date.now() <= expiresAt && !forceFetch) || !key) return;\n\n    return controller.fetch(endpoint, ...(args as any)).catch(() => {});\n    // we need to check against serialized params, since params can change frequently\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [expiresAt, key, forceFetch, state.lastReset]);\n\n  // fully \"valid\" data will not suspend/loading even if it is not fresh\n  const loading = expiryStatus !== ExpiryStatus.Valid && !!maybePromise;\n\n  data = useMemo(() => {\n    // if useSuspense() would suspend, don't include entities from cache\n    if (loading) {\n      if (!endpoint.schema) return undefined;\n      // TODO: use getResponse() once it just returns data\n      return controller.getResponseMeta(endpoint, ...args, {\n        ...state,\n        entities: {},\n      }).data as any;\n    }\n    return data;\n    // key substitutes args + endpoint\n    // we only need cacheResults, as entities are not used in this case\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [key, data, loading, cacheResults]);\n\n  const error = controller.getError(endpoint, ...args, state);\n\n  // eslint-disable-next-line react-hooks/exhaustive-deps\n  useEffect(countRef, [data]);\n\n  return {\n    data,\n    loading,\n    error,\n  };\n}\n"],"mappings":";AASA,SAASA,YAAY,QAAQ,mBAAmB;AAChD,SAASC,SAAS,EAAEC,OAAO,QAAQ,OAAO;AAE1C,OAAOC,aAAa,MAAM,oBAAoB;AAC9C,OAAOC,aAAa,MAAM,oBAAoB;;AAoB9C;AACA;AACA;AACA;;AA6BA,eAAe,SAASC,MAAMA,CAM5BC,QAAW,EAAE,GAAGC,IAAmD,EAAO;EAC1E,MAAMC,KAAK,GAAGL,aAAa,CAAC,CAAC;EAC7B,MAAMM,UAAU,GAAGL,aAAa,CAAC,CAAC;EAElC,MAAMM,GAAG,GAAGH,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,GAAGD,QAAQ,CAACI,GAAG,CAAC,GAAGH,IAAI,CAAC,GAAG,EAAE;EACzD,MAAMI,YAAY,GAAGD,GAAG,IAAIF,KAAK,CAACI,SAAS,CAACF,GAAG,CAAC;EAChD,MAAMG,IAAI,GAAGL,KAAK,CAACK,IAAI,CAACH,GAAG,CAAC;;EAE5B;EACA;EACA,IAAI;IAAEI,IAAI;IAAEC,YAAY;IAAEC,SAAS;IAAEC;EAAS,CAAC,GAAGf,OAAO,CAAC,MAAM;IAC9D,OAAOO,UAAU,CAACS,eAAe,CAACZ,QAAQ,EAAE,GAAGC,IAAI,EAAEC,KAAK,CAAC;IAC3D;EACF,CAAC,EAAE,CACDG,YAAY,EACZH,KAAK,CAACW,OAAO,EACbX,KAAK,CAACY,QAAQ,EACdZ,KAAK,CAACa,UAAU,EAChBR,IAAI,EACJH,GAAG,CACJ,CAAC;;EAEF;EACA,MAAMY,UAAU,GAAGP,YAAY,KAAKf,YAAY,CAACuB,OAAO;EAExD,MAAMC,YAAY,GAAGtB,OAAO,CAAC,MAAM;IACjC;IACA,IAAKuB,IAAI,CAACC,GAAG,CAAC,CAAC,IAAIV,SAAS,IAAI,CAACM,UAAU,IAAK,CAACZ,GAAG,EAAE;IAEtD,OAAOD,UAAU,CAACkB,KAAK,CAACrB,QAAQ,EAAE,GAAIC,IAAY,CAAC,CAACqB,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACnE;IACA;EACF,CAAC,EAAE,CAACZ,SAAS,EAAEN,GAAG,EAAEY,UAAU,EAAEd,KAAK,CAACqB,SAAS,CAAC,CAAC;;EAEjD;EACA,MAAMC,OAAO,GAAGf,YAAY,KAAKf,YAAY,CAAC+B,KAAK,IAAI,CAAC,CAACP,YAAY;EAErEV,IAAI,GAAGZ,OAAO,CAAC,MAAM;IACnB;IACA,IAAI4B,OAAO,EAAE;MACX,IAAI,CAACxB,QAAQ,CAAC0B,MAAM,EAAE,OAAOC,SAAS;MACtC;MACA,OAAOxB,UAAU,CAACS,eAAe,CAACZ,QAAQ,EAAE,GAAGC,IAAI,EAAA2B,QAAA,KAC9C1B,KAAK;QACRY,QAAQ,EAAE,CAAC;MAAC,EACb,CAAC,CAACN,IAAI;IACT;IACA,OAAOA,IAAI;IACX;IACA;IACA;EACF,CAAC,EAAE,CAACJ,GAAG,EAAEI,IAAI,EAAEgB,OAAO,EAAEnB,YAAY,CAAC,CAAC;EAEtC,MAAMwB,KAAK,GAAG1B,UAAU,CAAC2B,QAAQ,CAAC9B,QAAQ,EAAE,GAAGC,IAAI,EAAEC,KAAK,CAAC;;EAE3D;EACAP,SAAS,CAACgB,QAAQ,EAAE,CAACH,IAAI,CAAC,CAAC;EAE3B,OAAO;IACLA,IAAI;IACJgB,OAAO;IACPK;EACF,CAAC;AACH","ignoreList":[]}