enlace 0.0.1-beta.2 → 0.0.1-beta.20
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/README.md +648 -85
- package/dist/hook/index.d.mts +220 -0
- package/dist/hook/index.d.ts +220 -0
- package/dist/{next/hook → hook}/index.js +334 -169
- package/dist/hook/index.mjs +590 -0
- package/dist/index.d.mts +74 -69
- package/dist/index.d.ts +74 -69
- package/dist/index.js +65 -314
- package/dist/index.mjs +67 -314
- package/package.json +17 -12
- package/dist/next/hook/index.d.mts +0 -124
- package/dist/next/hook/index.d.ts +0 -124
- package/dist/next/hook/index.mjs +0 -444
- 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,153 +21,93 @@ 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
|
-
|
|
26
|
-
createEnlaceHook: () => createEnlaceHook,
|
|
27
|
-
invalidateTags: () => invalidateTags,
|
|
28
|
-
onRevalidate: () => onRevalidate
|
|
24
|
+
enlaceNext: () => enlaceNext,
|
|
25
|
+
invalidateTags: () => invalidateTags
|
|
29
26
|
});
|
|
30
27
|
module.exports = __toCommonJS(src_exports);
|
|
31
28
|
__reExport(src_exports, require("enlace-core"), module.exports);
|
|
32
29
|
|
|
33
|
-
// src/
|
|
34
|
-
var
|
|
35
|
-
|
|
36
|
-
// src/react/useQueryMode.ts
|
|
37
|
-
var import_react = require("react");
|
|
30
|
+
// src/next/index.ts
|
|
31
|
+
var import_enlace_core2 = require("enlace-core");
|
|
38
32
|
|
|
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
|
-
}
|
|
33
|
+
// src/next/fetch.ts
|
|
34
|
+
var import_enlace_core = require("enlace-core");
|
|
79
35
|
|
|
80
36
|
// src/utils/generateTags.ts
|
|
81
37
|
function generateTags(path) {
|
|
82
38
|
return path.map((_, i) => path.slice(0, i + 1).join("/"));
|
|
83
39
|
}
|
|
84
40
|
|
|
85
|
-
// src/
|
|
86
|
-
function
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
41
|
+
// src/next/fetch.ts
|
|
42
|
+
async function executeNextFetch(baseUrl, path, method, combinedOptions, requestOptions) {
|
|
43
|
+
const {
|
|
44
|
+
autoGenerateTags = true,
|
|
45
|
+
autoRevalidateTags = true,
|
|
46
|
+
skipServerRevalidation = false,
|
|
47
|
+
serverRevalidator,
|
|
48
|
+
onSuccess,
|
|
49
|
+
...coreOptions
|
|
50
|
+
} = combinedOptions;
|
|
51
|
+
const isGet = method === "GET";
|
|
52
|
+
const autoTags = generateTags(path);
|
|
53
|
+
const nextOnSuccess = (payload) => {
|
|
54
|
+
if (!isGet) {
|
|
55
|
+
const shouldRevalidateServer = requestOptions?.serverRevalidate ?? !skipServerRevalidation;
|
|
56
|
+
if (shouldRevalidateServer) {
|
|
57
|
+
const baseRevalidateTags = requestOptions?.revalidateTags ?? (autoRevalidateTags ? autoTags : []);
|
|
58
|
+
const revalidateTags = [
|
|
59
|
+
...baseRevalidateTags,
|
|
60
|
+
...requestOptions?.additionalRevalidateTags ?? []
|
|
61
|
+
];
|
|
62
|
+
const revalidatePaths = requestOptions?.revalidatePaths ?? [];
|
|
63
|
+
if (revalidateTags.length || revalidatePaths.length) {
|
|
64
|
+
serverRevalidator?.(revalidateTags, revalidatePaths);
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
onSuccess?.(payload);
|
|
69
|
+
};
|
|
70
|
+
const nextRequestOptions = { ...requestOptions };
|
|
71
|
+
if (isGet) {
|
|
72
|
+
const tags = requestOptions?.tags ?? (autoGenerateTags ? autoTags : void 0);
|
|
73
|
+
const nextFetchOptions = {};
|
|
74
|
+
if (tags) {
|
|
75
|
+
nextFetchOptions.tags = tags;
|
|
76
|
+
}
|
|
77
|
+
if (requestOptions?.revalidate !== void 0) {
|
|
78
|
+
nextFetchOptions.revalidate = requestOptions.revalidate;
|
|
79
|
+
}
|
|
80
|
+
nextRequestOptions.next = nextFetchOptions;
|
|
81
|
+
}
|
|
82
|
+
return (0, import_enlace_core.executeFetch)(
|
|
83
|
+
baseUrl,
|
|
84
|
+
path,
|
|
85
|
+
method,
|
|
86
|
+
{ ...coreOptions, onSuccess: nextOnSuccess },
|
|
87
|
+
nextRequestOptions
|
|
95
88
|
);
|
|
96
89
|
}
|
|
97
90
|
|
|
98
|
-
// src/
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
return
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
})
|
|
91
|
+
// src/next/index.ts
|
|
92
|
+
function enlaceNext(baseUrl, defaultOptions = {}, nextOptions = {}) {
|
|
93
|
+
const combinedOptions = { ...defaultOptions, ...nextOptions };
|
|
94
|
+
return (0, import_enlace_core2.createProxyHandler)(
|
|
95
|
+
baseUrl,
|
|
96
|
+
combinedOptions,
|
|
97
|
+
[],
|
|
98
|
+
executeNextFetch
|
|
107
99
|
);
|
|
108
100
|
}
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
function setCache(key, entry) {
|
|
113
|
-
const existing = cache.get(key);
|
|
114
|
-
if (existing) {
|
|
115
|
-
if ("ok" in entry) {
|
|
116
|
-
delete existing.promise;
|
|
117
|
-
}
|
|
118
|
-
Object.assign(existing, entry);
|
|
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);
|
|
148
|
-
};
|
|
149
|
-
}
|
|
150
|
-
function isStale(key, staleTime) {
|
|
151
|
-
const entry = cache.get(key);
|
|
152
|
-
if (!entry) return true;
|
|
153
|
-
return Date.now() - entry.timestamp > staleTime;
|
|
154
|
-
}
|
|
155
|
-
function clearCache(key) {
|
|
156
|
-
if (key) {
|
|
157
|
-
cache.delete(key);
|
|
158
|
-
} else {
|
|
159
|
-
cache.clear();
|
|
160
|
-
}
|
|
161
|
-
}
|
|
101
|
+
|
|
102
|
+
// src/react/cache.ts
|
|
103
|
+
var cache = /* @__PURE__ */ new Map();
|
|
162
104
|
function clearCacheByTags(tags) {
|
|
163
105
|
cache.forEach((entry) => {
|
|
164
106
|
const hasMatch = entry.tags.some((tag) => tags.includes(tag));
|
|
165
107
|
if (hasMatch) {
|
|
166
|
-
entry.data = void 0;
|
|
167
|
-
entry.error = void 0;
|
|
168
|
-
entry.ok = void 0;
|
|
169
108
|
entry.timestamp = 0;
|
|
170
109
|
delete entry.promise;
|
|
110
|
+
entry.subscribers.forEach((cb) => cb());
|
|
171
111
|
}
|
|
172
112
|
});
|
|
173
113
|
}
|
|
@@ -178,192 +118,3 @@ function invalidateTags(tags) {
|
|
|
178
118
|
clearCacheByTags(tags);
|
|
179
119
|
listeners.forEach((listener) => listener(tags));
|
|
180
120
|
}
|
|
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();
|
|
249
|
-
}
|
|
250
|
-
return () => {
|
|
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
|
-
});
|
|
327
|
-
}
|
|
328
|
-
return {
|
|
329
|
-
trigger: triggerRef.current,
|
|
330
|
-
...state
|
|
331
|
-
};
|
|
332
|
-
}
|
|
333
|
-
|
|
334
|
-
// src/react/createEnlaceHook.ts
|
|
335
|
-
function createEnlaceHook(baseUrl, defaultOptions = {}, hookOptions = {}) {
|
|
336
|
-
const api = (0, import_enlace_core.createEnlace)(baseUrl, defaultOptions);
|
|
337
|
-
const {
|
|
338
|
-
autoGenerateTags = true,
|
|
339
|
-
autoRevalidateTags = true,
|
|
340
|
-
staleTime = 0
|
|
341
|
-
} = hookOptions;
|
|
342
|
-
function useEnlaceHook(selectorOrQuery) {
|
|
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;
|
|
369
|
-
}
|