@remix-relay/react
Version:
Provides Relay integration with React Router (Framework)
219 lines (211 loc) • 8.67 kB
JavaScript
;
var __create = Object.create;
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
var __getOwnPropNames = Object.getOwnPropertyNames;
var __getProtoOf = Object.getPrototypeOf;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __export = (target, all) => {
for (var name in all)
__defProp(target, name, { get: all[name], enumerable: true });
};
var __copyProps = (to, from, except, desc) => {
if (from && typeof from === "object" || typeof from === "function") {
for (let key of __getOwnPropNames(from))
if (!__hasOwnProp.call(to, key) && key !== except)
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
}
return to;
};
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
// If the importer is in node compatibility mode or this is not an ESM
// file that has been converted to a CommonJS file using a Babel-
// compatible transform (i.e. "__esModule" has not been set), then set
// "default" to the CommonJS "module.exports" for node compatibility.
isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
mod
));
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
// src/index.ts
var src_exports = {};
__export(src_exports, {
Deferred: () => Deferred,
RemixRelayProvider: () => RemixRelayProvider,
clientLoaderQuery: () => clientLoaderQuery,
getCachedResponse: () => getCachedResponse,
getClientLoaderQuery: () => getClientLoaderQuery,
metaQuery: () => metaQuery,
useLoaderQuery: () => useLoaderQuery,
useRouteLoaderQuery: () => useRouteLoaderQuery
});
module.exports = __toCommonJS(src_exports);
// src/Deferred.tsx
var import_react2 = require("react");
var import_react_router = require("react-router");
// src/deferred-query-context.tsx
var import_react = require("react");
var import_jsx_runtime = require("react/jsx-runtime");
var DeferredQueryContext = (0, import_react.createContext)(null);
var SetDeferredQueryContext = (0, import_react.createContext)(() => {
});
function RemixRelayProvider({ children }) {
const [deferredQueries, setDeferredQueries] = (0, import_react.useState)(
null
);
return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(SetDeferredQueryContext, { value: setDeferredQueries, children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(DeferredQueryContext, { value: deferredQueries, children }) });
}
// src/Deferred.tsx
var import_jsx_runtime2 = require("react/jsx-runtime");
function Deferred({ children, ...rest }) {
const [mounted, setMounted] = (0, import_react2.useState)(false);
(0, import_react2.useEffect)(() => {
if (!mounted && typeof window !== "undefined") {
setMounted(true);
}
}, [mounted]);
const deferredQuery = (0, import_react2.use)(DeferredQueryContext);
return mounted ? /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(import_react2.Suspense, { ...rest, children: deferredQuery ? /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(import_react_router.Await, { resolve: deferredQuery, children }) : children }) : /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(import_jsx_runtime2.Fragment, { children: rest.fallback });
}
// src/client-loader-query.ts
var import_react_relay = __toESM(require("react-relay"));
var { fetchQuery, loadQuery } = import_react_relay.default;
function getClientLoaderQuery(environment) {
return async (query, variables) => clientLoaderQuery(environment, query, variables);
}
async function clientLoaderQuery(environment, query, variables) {
const data = await fetchQuery(environment, query, variables, {
fetchPolicy: "store-or-network"
}).toPromise();
const queryRef = loadQuery(environment, query, variables, {
fetchPolicy: "store-only"
});
return { queryRef, data };
}
// src/get-cached-response.ts
var import_relay_runtime = require("relay-runtime");
var responseCache = new import_relay_runtime.QueryResponseCache({
size: 100,
ttl: 5e3
});
function getCachedResponse(params, variables, cacheConfig) {
const isQuery = params.operationKind === "query";
const cacheKey = params.id ?? params.cacheID;
const forceFetch = cacheConfig && cacheConfig.force;
if (responseCache === null || !isQuery || forceFetch) {
return null;
}
const fromCache = responseCache.get(cacheKey, variables);
const deferredFromCache = [];
for (let i = 0; ; i++) {
const deferred = responseCache.get(`${cacheKey}-${i}`, variables);
if (!deferred) break;
deferredFromCache.push(deferred);
}
if (fromCache === null) {
return null;
}
return import_relay_runtime.Observable.create((sink) => {
sink.next(fromCache);
for (const deferred of deferredFromCache) {
sink.next(deferred);
}
sink.complete();
});
}
// src/meta-query.ts
function metaQuery(metaFunction) {
return ({ data, ...rest }) => {
const metaData = data && "data" in data ? data.data : data && "preloadedQuery" in data ? data.preloadedQuery.response.data : null;
return metaFunction({
data: metaData,
...rest
});
};
}
// src/useLoaderQuery.ts
var import_react3 = require("react");
var import_react_dom = require("react-dom");
var import_react_relay2 = __toESM(require("react-relay"));
var import_react_router2 = require("react-router");
var import_tiny_invariant = __toESM(require("tiny-invariant"));
var { usePreloadedQuery, useQueryLoader, useRelayEnvironment } = import_react_relay2.default;
function useCommonLoaderQuery(query, fetchPolicy, loaderData) {
const preloadedQuery = "preloadedQuery" in loaderData ? loaderData.preloadedQuery : null;
const deferredQueries = "deferredQueries" in loaderData ? loaderData.deferredQueries : null;
const [deferredResult, setDeferredResult] = (0, import_react3.useState)(preloadedQuery);
const setDeferredQueries = (0, import_react3.use)(SetDeferredQueryContext);
(0, import_react3.useEffect)(() => {
if (deferredQueries) {
setDeferredQueries(
deferredQueries.then(async (deferredResults) => {
deferredResults.forEach((result) => {
(0, import_react_dom.flushSync)(() => {
setDeferredResult(
result
);
});
});
return deferredResults;
})
);
}
}, [deferredQueries, preloadedQuery, setDeferredQueries, setDeferredResult]);
const environment = useRelayEnvironment();
(0, import_react3.useMemo)(() => {
if (deferredResult) {
writePreloadedQueryToCache(deferredResult);
}
}, [deferredResult]);
let ref = "queryRef" in loaderData ? loaderData.queryRef : deferredResult ? {
environment,
fetchKey: `${deferredResult.params.id ?? deferredResult.params.cacheID}${simpleHash(deferredResult.response)}`,
fetchPolicy,
isDisposed: false,
name: deferredResult.params.name,
kind: "PreloadedQuery",
variables: deferredResult.variables,
dispose: () => {
}
} : null;
(0, import_tiny_invariant.default)(ref, "Missing queryRef");
const [queryRef, loadQuery2, disposeQuery] = useQueryLoader(query);
if (queryRef) ref = queryRef;
const reloadQuery = (variables, options = { fetchPolicy: "store-and-network" }) => loadQuery2(variables, options);
const data = usePreloadedQuery(query, ref);
return [data, reloadQuery, disposeQuery];
}
function useLoaderQuery(query, fetchPolicy = "network-only") {
const loaderData = (0, import_react_router2.useLoaderData)();
return useCommonLoaderQuery(query, fetchPolicy, loaderData);
}
function useRouteLoaderQuery(routeId, query, fetchPolicy = "network-only") {
const loaderData = (0, import_react_router2.useRouteLoaderData)(routeId);
(0, import_tiny_invariant.default)(loaderData, `Missing loader data for routeId ${routeId}`);
return useCommonLoaderQuery(query, fetchPolicy, loaderData);
}
function writePreloadedQueryToCache(preloadedQueryObject) {
let cacheKey = preloadedQueryObject.params.id ?? preloadedQueryObject.params.cacheID;
responseCache?.set(
cacheKey,
preloadedQueryObject.variables,
preloadedQueryObject.response
);
}
function simpleHash(input) {
return JSON.stringify(input).split("").reduce((a, b) => {
a = (a << 5) - a + b.charCodeAt(0);
return a & a;
}, 0);
}
// Annotate the CommonJS export names for ESM import in node:
0 && (module.exports = {
Deferred,
RemixRelayProvider,
clientLoaderQuery,
getCachedResponse,
getClientLoaderQuery,
metaQuery,
useLoaderQuery,
useRouteLoaderQuery
});
//# sourceMappingURL=index.js.map