enlace 0.0.1-beta.1 → 0.0.1-beta.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +836 -0
- package/dist/hook/index.d.mts +178 -0
- package/dist/hook/index.d.ts +178 -0
- package/dist/{next/hook → hook}/index.js +278 -167
- package/dist/{next/hook → hook}/index.mjs +279 -185
- package/dist/index.d.mts +59 -68
- package/dist/index.d.ts +59 -68
- package/dist/index.js +53 -327
- package/dist/index.mjs +55 -327
- package/package.json +6 -11
- package/dist/next/hook/index.d.mts +0 -124
- package/dist/next/hook/index.d.ts +0 -124
- package/dist/next/index.d.mts +0 -74
- package/dist/next/index.d.ts +0 -74
- package/dist/next/index.js +0 -111
- package/dist/next/index.mjs +0 -95
package/dist/index.js
CHANGED
|
@@ -21,349 +21,75 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
|
|
|
21
21
|
// src/index.ts
|
|
22
22
|
var src_exports = {};
|
|
23
23
|
__export(src_exports, {
|
|
24
|
-
|
|
25
|
-
clearCache: () => clearCache,
|
|
26
|
-
createEnlaceHook: () => createEnlaceHook,
|
|
27
|
-
invalidateTags: () => invalidateTags,
|
|
28
|
-
onRevalidate: () => onRevalidate
|
|
24
|
+
createEnlaceNext: () => createEnlaceNext
|
|
29
25
|
});
|
|
30
26
|
module.exports = __toCommonJS(src_exports);
|
|
31
27
|
__reExport(src_exports, require("enlace-core"), module.exports);
|
|
32
28
|
|
|
33
|
-
// src/
|
|
34
|
-
var
|
|
35
|
-
|
|
36
|
-
// src/react/useQueryMode.ts
|
|
37
|
-
var import_react = require("react");
|
|
29
|
+
// src/next/index.ts
|
|
30
|
+
var import_enlace_core2 = require("enlace-core");
|
|
38
31
|
|
|
39
|
-
// src/
|
|
40
|
-
var
|
|
41
|
-
loading: false,
|
|
42
|
-
fetching: false,
|
|
43
|
-
ok: void 0,
|
|
44
|
-
data: void 0,
|
|
45
|
-
error: void 0
|
|
46
|
-
};
|
|
47
|
-
function hookReducer(state, action) {
|
|
48
|
-
switch (action.type) {
|
|
49
|
-
case "RESET":
|
|
50
|
-
return action.state;
|
|
51
|
-
case "FETCH_START":
|
|
52
|
-
return {
|
|
53
|
-
...state,
|
|
54
|
-
loading: state.data === void 0,
|
|
55
|
-
fetching: true
|
|
56
|
-
};
|
|
57
|
-
case "FETCH_SUCCESS":
|
|
58
|
-
return {
|
|
59
|
-
loading: false,
|
|
60
|
-
fetching: false,
|
|
61
|
-
ok: true,
|
|
62
|
-
data: action.data,
|
|
63
|
-
error: void 0
|
|
64
|
-
};
|
|
65
|
-
case "FETCH_ERROR":
|
|
66
|
-
return {
|
|
67
|
-
loading: false,
|
|
68
|
-
fetching: false,
|
|
69
|
-
ok: false,
|
|
70
|
-
data: void 0,
|
|
71
|
-
error: action.error
|
|
72
|
-
};
|
|
73
|
-
case "SYNC_CACHE":
|
|
74
|
-
return action.state;
|
|
75
|
-
default:
|
|
76
|
-
return state;
|
|
77
|
-
}
|
|
78
|
-
}
|
|
32
|
+
// src/next/fetch.ts
|
|
33
|
+
var import_enlace_core = require("enlace-core");
|
|
79
34
|
|
|
80
35
|
// src/utils/generateTags.ts
|
|
81
36
|
function generateTags(path) {
|
|
82
37
|
return path.map((_, i) => path.slice(0, i + 1).join("/"));
|
|
83
38
|
}
|
|
84
39
|
|
|
85
|
-
// src/
|
|
86
|
-
function
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
);
|
|
108
|
-
}
|
|
109
|
-
function getCache(key) {
|
|
110
|
-
return cache.get(key);
|
|
111
|
-
}
|
|
112
|
-
function setCache(key, entry) {
|
|
113
|
-
const existing = cache.get(key);
|
|
114
|
-
if (existing) {
|
|
115
|
-
if ("ok" in entry) {
|
|
116
|
-
delete existing.promise;
|
|
40
|
+
// src/next/fetch.ts
|
|
41
|
+
async function executeNextFetch(baseUrl, path, method, combinedOptions, requestOptions) {
|
|
42
|
+
const {
|
|
43
|
+
autoGenerateTags = true,
|
|
44
|
+
autoRevalidateTags = true,
|
|
45
|
+
skipServerRevalidation = false,
|
|
46
|
+
serverRevalidator,
|
|
47
|
+
onSuccess,
|
|
48
|
+
...coreOptions
|
|
49
|
+
} = combinedOptions;
|
|
50
|
+
const isGet = method === "GET";
|
|
51
|
+
const autoTags = generateTags(path);
|
|
52
|
+
const nextOnSuccess = (payload) => {
|
|
53
|
+
if (!isGet) {
|
|
54
|
+
const shouldRevalidateServer = requestOptions?.serverRevalidate ?? !skipServerRevalidation;
|
|
55
|
+
if (shouldRevalidateServer) {
|
|
56
|
+
const revalidateTags = requestOptions?.revalidateTags ?? (autoRevalidateTags ? autoTags : []);
|
|
57
|
+
const revalidatePaths = requestOptions?.revalidatePaths ?? [];
|
|
58
|
+
if (revalidateTags.length || revalidatePaths.length) {
|
|
59
|
+
serverRevalidator?.(revalidateTags, revalidatePaths);
|
|
60
|
+
}
|
|
61
|
+
}
|
|
117
62
|
}
|
|
118
|
-
|
|
119
|
-
existing.subscribers.forEach((cb) => cb());
|
|
120
|
-
} else {
|
|
121
|
-
cache.set(key, {
|
|
122
|
-
data: void 0,
|
|
123
|
-
error: void 0,
|
|
124
|
-
ok: void 0,
|
|
125
|
-
timestamp: 0,
|
|
126
|
-
tags: [],
|
|
127
|
-
subscribers: /* @__PURE__ */ new Set(),
|
|
128
|
-
...entry
|
|
129
|
-
});
|
|
130
|
-
}
|
|
131
|
-
}
|
|
132
|
-
function subscribeCache(key, callback) {
|
|
133
|
-
let entry = cache.get(key);
|
|
134
|
-
if (!entry) {
|
|
135
|
-
cache.set(key, {
|
|
136
|
-
data: void 0,
|
|
137
|
-
error: void 0,
|
|
138
|
-
ok: void 0,
|
|
139
|
-
timestamp: 0,
|
|
140
|
-
tags: [],
|
|
141
|
-
subscribers: /* @__PURE__ */ new Set()
|
|
142
|
-
});
|
|
143
|
-
entry = cache.get(key);
|
|
144
|
-
}
|
|
145
|
-
entry.subscribers.add(callback);
|
|
146
|
-
return () => {
|
|
147
|
-
entry.subscribers.delete(callback);
|
|
63
|
+
onSuccess?.(payload);
|
|
148
64
|
};
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
function clearCache(key) {
|
|
156
|
-
if (key) {
|
|
157
|
-
cache.delete(key);
|
|
158
|
-
} else {
|
|
159
|
-
cache.clear();
|
|
160
|
-
}
|
|
161
|
-
}
|
|
162
|
-
function clearCacheByTags(tags) {
|
|
163
|
-
cache.forEach((entry) => {
|
|
164
|
-
const hasMatch = entry.tags.some((tag) => tags.includes(tag));
|
|
165
|
-
if (hasMatch) {
|
|
166
|
-
entry.data = void 0;
|
|
167
|
-
entry.error = void 0;
|
|
168
|
-
entry.ok = void 0;
|
|
169
|
-
entry.timestamp = 0;
|
|
170
|
-
delete entry.promise;
|
|
65
|
+
const nextRequestOptions = { ...requestOptions };
|
|
66
|
+
if (isGet) {
|
|
67
|
+
const tags = requestOptions?.tags ?? (autoGenerateTags ? autoTags : void 0);
|
|
68
|
+
const nextFetchOptions = {};
|
|
69
|
+
if (tags) {
|
|
70
|
+
nextFetchOptions.tags = tags;
|
|
171
71
|
}
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
// src/react/revalidator.ts
|
|
176
|
-
var listeners = /* @__PURE__ */ new Set();
|
|
177
|
-
function invalidateTags(tags) {
|
|
178
|
-
clearCacheByTags(tags);
|
|
179
|
-
listeners.forEach((listener) => listener(tags));
|
|
180
|
-
}
|
|
181
|
-
function onRevalidate(callback) {
|
|
182
|
-
listeners.add(callback);
|
|
183
|
-
return () => listeners.delete(callback);
|
|
184
|
-
}
|
|
185
|
-
|
|
186
|
-
// src/react/useQueryMode.ts
|
|
187
|
-
function useQueryMode(api, trackedCall, options) {
|
|
188
|
-
const { autoGenerateTags, staleTime } = options;
|
|
189
|
-
const queryKey = createQueryKey(trackedCall);
|
|
190
|
-
const requestOptions = trackedCall.options;
|
|
191
|
-
const queryTags = requestOptions?.tags ?? (autoGenerateTags ? generateTags(trackedCall.path) : []);
|
|
192
|
-
const getCacheState = (includeNeedsFetch = false) => {
|
|
193
|
-
const cached = getCache(queryKey);
|
|
194
|
-
const hasCachedData = cached?.data !== void 0;
|
|
195
|
-
const isFetching = !!cached?.promise;
|
|
196
|
-
const needsFetch = includeNeedsFetch && (!hasCachedData || isStale(queryKey, staleTime));
|
|
197
|
-
return {
|
|
198
|
-
loading: !hasCachedData && (isFetching || needsFetch),
|
|
199
|
-
fetching: isFetching || needsFetch,
|
|
200
|
-
ok: cached?.ok,
|
|
201
|
-
data: cached?.data,
|
|
202
|
-
error: cached?.error
|
|
203
|
-
};
|
|
204
|
-
};
|
|
205
|
-
const [state, dispatch] = (0, import_react.useReducer)(hookReducer, null, () => getCacheState(true));
|
|
206
|
-
const mountedRef = (0, import_react.useRef)(true);
|
|
207
|
-
const fetchRef = (0, import_react.useRef)(null);
|
|
208
|
-
(0, import_react.useEffect)(() => {
|
|
209
|
-
mountedRef.current = true;
|
|
210
|
-
dispatch({ type: "RESET", state: getCacheState(true) });
|
|
211
|
-
const unsubscribe = subscribeCache(queryKey, () => {
|
|
212
|
-
if (mountedRef.current) {
|
|
213
|
-
dispatch({ type: "SYNC_CACHE", state: getCacheState() });
|
|
214
|
-
}
|
|
215
|
-
});
|
|
216
|
-
const doFetch = () => {
|
|
217
|
-
const cached2 = getCache(queryKey);
|
|
218
|
-
if (cached2?.promise) {
|
|
219
|
-
return;
|
|
220
|
-
}
|
|
221
|
-
dispatch({ type: "FETCH_START" });
|
|
222
|
-
let current = api;
|
|
223
|
-
for (const segment of trackedCall.path) {
|
|
224
|
-
current = current[segment];
|
|
225
|
-
}
|
|
226
|
-
const method = current[trackedCall.method];
|
|
227
|
-
const fetchPromise = method(trackedCall.options).then((res) => {
|
|
228
|
-
if (mountedRef.current) {
|
|
229
|
-
setCache(queryKey, {
|
|
230
|
-
data: res.ok ? res.data : void 0,
|
|
231
|
-
error: res.ok ? void 0 : res.error,
|
|
232
|
-
ok: res.ok,
|
|
233
|
-
timestamp: Date.now(),
|
|
234
|
-
tags: queryTags
|
|
235
|
-
});
|
|
236
|
-
}
|
|
237
|
-
});
|
|
238
|
-
setCache(queryKey, {
|
|
239
|
-
promise: fetchPromise,
|
|
240
|
-
tags: queryTags
|
|
241
|
-
});
|
|
242
|
-
};
|
|
243
|
-
fetchRef.current = doFetch;
|
|
244
|
-
const cached = getCache(queryKey);
|
|
245
|
-
if (cached?.data !== void 0 && !isStale(queryKey, staleTime)) {
|
|
246
|
-
dispatch({ type: "SYNC_CACHE", state: getCacheState() });
|
|
247
|
-
} else {
|
|
248
|
-
doFetch();
|
|
72
|
+
if (requestOptions?.revalidate !== void 0) {
|
|
73
|
+
nextFetchOptions.revalidate = requestOptions.revalidate;
|
|
249
74
|
}
|
|
250
|
-
|
|
251
|
-
mountedRef.current = false;
|
|
252
|
-
fetchRef.current = null;
|
|
253
|
-
unsubscribe();
|
|
254
|
-
};
|
|
255
|
-
}, [queryKey]);
|
|
256
|
-
(0, import_react.useEffect)(() => {
|
|
257
|
-
if (queryTags.length === 0) return;
|
|
258
|
-
return onRevalidate((invalidatedTags) => {
|
|
259
|
-
const hasMatch = invalidatedTags.some((tag) => queryTags.includes(tag));
|
|
260
|
-
if (hasMatch && mountedRef.current && fetchRef.current) {
|
|
261
|
-
fetchRef.current();
|
|
262
|
-
}
|
|
263
|
-
});
|
|
264
|
-
}, [JSON.stringify(queryTags)]);
|
|
265
|
-
return state;
|
|
266
|
-
}
|
|
267
|
-
|
|
268
|
-
// src/react/types.ts
|
|
269
|
-
var HTTP_METHODS = ["get", "post", "put", "patch", "delete"];
|
|
270
|
-
|
|
271
|
-
// src/react/trackingProxy.ts
|
|
272
|
-
function createTrackingProxy(onTrack) {
|
|
273
|
-
const createProxy = (path = []) => {
|
|
274
|
-
return new Proxy(() => {
|
|
275
|
-
}, {
|
|
276
|
-
get(_, prop) {
|
|
277
|
-
if (HTTP_METHODS.includes(prop)) {
|
|
278
|
-
const methodFn = (options) => {
|
|
279
|
-
onTrack({
|
|
280
|
-
trackedCall: { path, method: prop, options },
|
|
281
|
-
selectorPath: null,
|
|
282
|
-
selectorMethod: null
|
|
283
|
-
});
|
|
284
|
-
return Promise.resolve({ ok: true, data: void 0 });
|
|
285
|
-
};
|
|
286
|
-
onTrack({
|
|
287
|
-
trackedCall: null,
|
|
288
|
-
selectorPath: path,
|
|
289
|
-
selectorMethod: prop
|
|
290
|
-
});
|
|
291
|
-
return methodFn;
|
|
292
|
-
}
|
|
293
|
-
return createProxy([...path, prop]);
|
|
294
|
-
}
|
|
295
|
-
});
|
|
296
|
-
};
|
|
297
|
-
return createProxy();
|
|
298
|
-
}
|
|
299
|
-
|
|
300
|
-
// src/react/useSelectorMode.ts
|
|
301
|
-
var import_react2 = require("react");
|
|
302
|
-
function useSelectorMode(method, path, autoRevalidateTags) {
|
|
303
|
-
const [state, dispatch] = (0, import_react2.useReducer)(hookReducer, initialState);
|
|
304
|
-
const methodRef = (0, import_react2.useRef)(method);
|
|
305
|
-
const triggerRef = (0, import_react2.useRef)(null);
|
|
306
|
-
const pathRef = (0, import_react2.useRef)(path);
|
|
307
|
-
const autoRevalidateRef = (0, import_react2.useRef)(autoRevalidateTags);
|
|
308
|
-
methodRef.current = method;
|
|
309
|
-
pathRef.current = path;
|
|
310
|
-
autoRevalidateRef.current = autoRevalidateTags;
|
|
311
|
-
if (!triggerRef.current) {
|
|
312
|
-
triggerRef.current = (async (...args) => {
|
|
313
|
-
dispatch({ type: "FETCH_START" });
|
|
314
|
-
const res = await methodRef.current(...args);
|
|
315
|
-
if (res.ok) {
|
|
316
|
-
dispatch({ type: "FETCH_SUCCESS", data: res.data });
|
|
317
|
-
const options = args[0];
|
|
318
|
-
const tagsToInvalidate = options?.revalidateTags ?? (autoRevalidateRef.current ? generateTags(pathRef.current) : []);
|
|
319
|
-
if (tagsToInvalidate.length > 0) {
|
|
320
|
-
invalidateTags(tagsToInvalidate);
|
|
321
|
-
}
|
|
322
|
-
} else {
|
|
323
|
-
dispatch({ type: "FETCH_ERROR", error: res.error });
|
|
324
|
-
}
|
|
325
|
-
return res;
|
|
326
|
-
});
|
|
75
|
+
nextRequestOptions.next = nextFetchOptions;
|
|
327
76
|
}
|
|
328
|
-
return
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
77
|
+
return (0, import_enlace_core.executeFetch)(
|
|
78
|
+
baseUrl,
|
|
79
|
+
path,
|
|
80
|
+
method,
|
|
81
|
+
{ ...coreOptions, onSuccess: nextOnSuccess },
|
|
82
|
+
nextRequestOptions
|
|
83
|
+
);
|
|
332
84
|
}
|
|
333
85
|
|
|
334
|
-
// src/
|
|
335
|
-
function
|
|
336
|
-
const
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
let trackingResult = {
|
|
344
|
-
trackedCall: null,
|
|
345
|
-
selectorPath: null,
|
|
346
|
-
selectorMethod: null
|
|
347
|
-
};
|
|
348
|
-
const trackingProxy = createTrackingProxy((result2) => {
|
|
349
|
-
trackingResult = result2;
|
|
350
|
-
});
|
|
351
|
-
const result = selectorOrQuery(
|
|
352
|
-
trackingProxy
|
|
353
|
-
);
|
|
354
|
-
if (typeof result === "function") {
|
|
355
|
-
const actualResult = selectorOrQuery(api);
|
|
356
|
-
return useSelectorMode(
|
|
357
|
-
actualResult,
|
|
358
|
-
trackingResult.selectorPath ?? [],
|
|
359
|
-
autoRevalidateTags
|
|
360
|
-
);
|
|
361
|
-
}
|
|
362
|
-
return useQueryMode(
|
|
363
|
-
api,
|
|
364
|
-
trackingResult.trackedCall,
|
|
365
|
-
{ autoGenerateTags, staleTime }
|
|
366
|
-
);
|
|
367
|
-
}
|
|
368
|
-
return useEnlaceHook;
|
|
86
|
+
// src/next/index.ts
|
|
87
|
+
function createEnlaceNext(baseUrl, defaultOptions = {}, nextOptions = {}) {
|
|
88
|
+
const combinedOptions = { ...defaultOptions, ...nextOptions };
|
|
89
|
+
return (0, import_enlace_core2.createProxyHandler)(
|
|
90
|
+
baseUrl,
|
|
91
|
+
combinedOptions,
|
|
92
|
+
[],
|
|
93
|
+
executeNextFetch
|
|
94
|
+
);
|
|
369
95
|
}
|