@pinia/colada-plugin-retry 0.0.2 → 0.0.3
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/dist/index.cjs +3 -3
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +5 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
package/dist/index.cjs
CHANGED
|
@@ -17,11 +17,11 @@ var __copyProps = (to, from, except, desc) => {
|
|
|
17
17
|
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
18
18
|
|
|
19
19
|
// src/index.ts
|
|
20
|
-
var
|
|
21
|
-
__export(
|
|
20
|
+
var index_exports = {};
|
|
21
|
+
__export(index_exports, {
|
|
22
22
|
PiniaColadaRetry: () => PiniaColadaRetry
|
|
23
23
|
});
|
|
24
|
-
module.exports = __toCommonJS(
|
|
24
|
+
module.exports = __toCommonJS(index_exports);
|
|
25
25
|
var RETRY_OPTIONS_DEFAULTS = {
|
|
26
26
|
delay: (attempt) => {
|
|
27
27
|
const time = Math.min(
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * Pinia Colada Retry plugin.\n *\n * Adds the ability to retry failed queries.\n *\n * @module @pinia/colada-plugin-retry\n */\nimport type { PiniaColadaPluginContext } from '@pinia/colada'\n\n/**\n * Options for the Pinia Colada Retry plugin.\n */\nexport interface RetryOptions {\n /**\n * The delay between retries. Can be a duration in ms or a function that receives the attempt number (starts at 0) and returns a duration in ms. By default, it will wait 2^attempt * 1000 ms, but never more than 30 seconds.\n * @param attempt -\n * @returns\n */\n delay?: number | ((attempt: number) => number)\n\n /**\n * The maximum number of times to retry the operation. Set to 0 to disable or to Infinity to retry forever. It can also be a function that receives the failure count and the error and returns if it should retry. Defaults to 3. **Must be a positive number**.\n */\n retry?: number | ((failureCount: number, error: unknown) => boolean)\n}\n\nexport interface RetryEntry {\n retryCount: number\n timeoutId?: ReturnType<typeof setTimeout>\n}\n\nconst RETRY_OPTIONS_DEFAULTS = {\n delay: (attempt: number) => {\n const time = Math.min(\n 2 ** attempt * 1000,\n // never more than 30 seconds\n 30_000,\n )\n console.log(`⏲️ delaying attempt #${attempt + 1} by ${time}ms`)\n return time\n },\n retry: (count) => {\n console.log(\n `🔄 Retrying ${'🟨'.repeat(count + 1)}${'⬜️'.repeat(2 - count)}`,\n )\n return count < 2\n },\n} satisfies Required<RetryOptions>\n\n/**\n * Plugin that adds the ability to retry failed queries.\n *\n * @param globalOptions - global options for the retries\n */\nexport function PiniaColadaRetry(\n globalOptions?: RetryOptions,\n): (context: PiniaColadaPluginContext) => void {\n const defaults = { ...RETRY_OPTIONS_DEFAULTS, ...globalOptions }\n\n return ({ queryCache }) => {\n const retryMap = new Map<string, RetryEntry>()\n\n let isInternalCall = false\n queryCache.$onAction(({ name, args, after, onError }) => {\n // cleanup all pending retries when data is deleted (means the data is not needed anymore)\n if (name === 'remove') {\n const [cacheEntry] = args\n const key = cacheEntry.key.join('/')\n const entry = retryMap.get(key)\n if (entry) {\n clearTimeout(entry.timeoutId)\n retryMap.delete(key)\n }\n }\n\n if (name !== 'fetch') return\n const [queryEntry] = args\n const localOptions = queryEntry.options?.retry\n\n const options = {\n ...(typeof localOptions === 'object'\n ? localOptions\n : {\n retry: localOptions,\n }),\n } satisfies RetryOptions\n\n const retry = options.retry ?? defaults.retry\n const delay = options.delay ?? defaults.delay\n // avoid setting up anything at all\n if (retry === 0) return\n\n const key = queryEntry.key.join('/')\n\n // clear any pending retry\n clearTimeout(retryMap.get(key)?.timeoutId)\n // if the user manually calls the action, reset the retry count\n if (!isInternalCall) {\n retryMap.delete(key)\n }\n\n const retryFetch = () => {\n if (queryEntry.state.value.status === 'error') {\n const error = queryEntry.state.value.error\n // ensure the entry exists\n let entry = retryMap.get(key)\n if (!entry) {\n entry = { retryCount: 0 }\n retryMap.set(key, entry)\n }\n\n const shouldRetry\n = typeof retry === 'number'\n ? retry > entry.retryCount\n : retry(entry.retryCount, error)\n\n if (shouldRetry) {\n const delayTime\n = typeof delay === 'function' ? delay(entry.retryCount) : delay\n entry.timeoutId = setTimeout(() => {\n // NOTE: we could add some default error handler\n isInternalCall = true\n Promise.resolve(queryCache.fetch(queryEntry)).catch(\n process.env.NODE_ENV !== 'test' ? console.error : () => {},\n )\n isInternalCall = false\n if (entry) {\n entry.retryCount++\n }\n }, delayTime)\n } else {\n // remove the entry if we are not going to retry\n retryMap.delete(key)\n }\n } else {\n // remove the entry if it worked out to reset it\n retryMap.delete(key)\n }\n }\n onError(retryFetch)\n after(retryFetch)\n })\n }\n}\n\ndeclare module '@pinia/colada' {\n // eslint-disable-next-line unused-imports/no-unused-vars\n export interface UseQueryOptions<TResult, TError> {\n /**\n * Options for the retries of this query added by `@pinia/colada-plugin-retry`.\n */\n retry?: RetryOptions | Exclude<RetryOptions['retry'], undefined>\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AA+BA,IAAM,yBAAyB;AAAA,EAC7B,OAAO,CAAC,YAAoB;AAC1B,UAAM,OAAO,KAAK;AAAA,MAChB,KAAK,UAAU;AAAA;AAAA,MAEf;AAAA,IACF;AACA,YAAQ,IAAI,kCAAwB,UAAU,CAAC,OAAO,IAAI,IAAI;AAC9D,WAAO;AAAA,EACT;AAAA,EACA,OAAO,CAAC,UAAU;AAChB,YAAQ;AAAA,MACN,sBAAe,YAAK,OAAO,QAAQ,CAAC,CAAC,GAAG,eAAK,OAAO,IAAI,KAAK,CAAC;AAAA,IAChE;AACA,WAAO,QAAQ;AAAA,EACjB;AACF;AAOO,SAAS,iBACd,eAC6C;AAC7C,QAAM,WAAW,EAAE,GAAG,wBAAwB,GAAG,cAAc;AAE/D,SAAO,CAAC,EAAE,WAAW,MAAM;AACzB,UAAM,WAAW,oBAAI,IAAwB;AAE7C,QAAI,iBAAiB;AACrB,eAAW,UAAU,CAAC,EAAE,MAAM,MAAM,OAAO,QAAQ,MAAM;AAEvD,UAAI,SAAS,UAAU;AACrB,cAAM,CAAC,UAAU,IAAI;AACrB,cAAMA,OAAM,WAAW,IAAI,KAAK,GAAG;AACnC,cAAM,QAAQ,SAAS,IAAIA,IAAG;AAC9B,YAAI,OAAO;AACT,uBAAa,MAAM,SAAS;AAC5B,mBAAS,OAAOA,IAAG;AAAA,QACrB;AAAA,MACF;AAEA,UAAI,SAAS,QAAS;AACtB,YAAM,CAAC,UAAU,IAAI;AACrB,YAAM,eAAe,WAAW,SAAS;AAEzC,YAAM,UAAU;AAAA,QACd,GAAI,OAAO,iBAAiB,WACxB,eACA;AAAA,UACE,OAAO;AAAA,QACT;AAAA,MACN;AAEA,YAAM,QAAQ,QAAQ,SAAS,SAAS;AACxC,YAAM,QAAQ,QAAQ,SAAS,SAAS;AAExC,UAAI,UAAU,EAAG;AAEjB,YAAM,MAAM,WAAW,IAAI,KAAK,GAAG;AAGnC,mBAAa,SAAS,IAAI,GAAG,GAAG,SAAS;AAEzC,UAAI,CAAC,gBAAgB;AACnB,iBAAS,OAAO,GAAG;AAAA,MACrB;AAEA,YAAM,aAAa,MAAM;AACvB,YAAI,WAAW,MAAM,MAAM,WAAW,SAAS;AAC7C,gBAAM,QAAQ,WAAW,MAAM,MAAM;AAErC,cAAI,QAAQ,SAAS,IAAI,GAAG;AAC5B,cAAI,CAAC,OAAO;AACV,oBAAQ,EAAE,YAAY,EAAE;AACxB,qBAAS,IAAI,KAAK,KAAK;AAAA,UACzB;AAEA,gBAAM,cACF,OAAO,UAAU,WACf,QAAQ,MAAM,aACd,MAAM,MAAM,YAAY,KAAK;AAEnC,cAAI,aAAa;AACf,kBAAM,YACF,OAAO,UAAU,aAAa,MAAM,MAAM,UAAU,IAAI;AAC5D,kBAAM,YAAY,WAAW,MAAM;AAEjC,+BAAiB;AACjB,sBAAQ,QAAQ,WAAW,MAAM,UAAU,CAAC,EAAE;AAAA,gBAC5C,QAAQ,IAAI,aAAa,SAAS,QAAQ,QAAQ,MAAM;AAAA,gBAAC;AAAA,cAC3D;AACA,+BAAiB;AACjB,kBAAI,OAAO;AACT,sBAAM;AAAA,cACR;AAAA,YACF,GAAG,SAAS;AAAA,UACd,OAAO;AAEL,qBAAS,OAAO,GAAG;AAAA,UACrB;AAAA,QACF,OAAO;AAEL,mBAAS,OAAO,GAAG;AAAA,QACrB;AAAA,MACF;AACA,cAAQ,UAAU;AAClB,YAAM,UAAU;AAAA,IAClB,CAAC;AAAA,EACH;AACF;","names":["key"]}
|
package/dist/index.d.cts
CHANGED
|
@@ -1,8 +1,13 @@
|
|
|
1
1
|
import { PiniaColadaPluginContext } from '@pinia/colada';
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
+
* Pinia Colada Retry plugin.
|
|
5
|
+
*
|
|
6
|
+
* Adds the ability to retry failed queries.
|
|
7
|
+
*
|
|
4
8
|
* @module @pinia/colada-plugin-retry
|
|
5
9
|
*/
|
|
10
|
+
|
|
6
11
|
/**
|
|
7
12
|
* Options for the Pinia Colada Retry plugin.
|
|
8
13
|
*/
|
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,13 @@
|
|
|
1
1
|
import { PiniaColadaPluginContext } from '@pinia/colada';
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
+
* Pinia Colada Retry plugin.
|
|
5
|
+
*
|
|
6
|
+
* Adds the ability to retry failed queries.
|
|
7
|
+
*
|
|
4
8
|
* @module @pinia/colada-plugin-retry
|
|
5
9
|
*/
|
|
10
|
+
|
|
6
11
|
/**
|
|
7
12
|
* Options for the Pinia Colada Retry plugin.
|
|
8
13
|
*/
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * Pinia Colada Retry plugin.\n *\n * Adds the ability to retry failed queries.\n *\n * @module @pinia/colada-plugin-retry\n */\nimport type { PiniaColadaPluginContext } from '@pinia/colada'\n\n/**\n * Options for the Pinia Colada Retry plugin.\n */\nexport interface RetryOptions {\n /**\n * The delay between retries. Can be a duration in ms or a function that receives the attempt number (starts at 0) and returns a duration in ms. By default, it will wait 2^attempt * 1000 ms, but never more than 30 seconds.\n * @param attempt -\n * @returns\n */\n delay?: number | ((attempt: number) => number)\n\n /**\n * The maximum number of times to retry the operation. Set to 0 to disable or to Infinity to retry forever. It can also be a function that receives the failure count and the error and returns if it should retry. Defaults to 3. **Must be a positive number**.\n */\n retry?: number | ((failureCount: number, error: unknown) => boolean)\n}\n\nexport interface RetryEntry {\n retryCount: number\n timeoutId?: ReturnType<typeof setTimeout>\n}\n\nconst RETRY_OPTIONS_DEFAULTS = {\n delay: (attempt: number) => {\n const time = Math.min(\n 2 ** attempt * 1000,\n // never more than 30 seconds\n 30_000,\n )\n console.log(`⏲️ delaying attempt #${attempt + 1} by ${time}ms`)\n return time\n },\n retry: (count) => {\n console.log(\n `🔄 Retrying ${'🟨'.repeat(count + 1)}${'⬜️'.repeat(2 - count)}`,\n )\n return count < 2\n },\n} satisfies Required<RetryOptions>\n\n/**\n * Plugin that adds the ability to retry failed queries.\n *\n * @param globalOptions - global options for the retries\n */\nexport function PiniaColadaRetry(\n globalOptions?: RetryOptions,\n): (context: PiniaColadaPluginContext) => void {\n const defaults = { ...RETRY_OPTIONS_DEFAULTS, ...globalOptions }\n\n return ({ queryCache }) => {\n const retryMap = new Map<string, RetryEntry>()\n\n let isInternalCall = false\n queryCache.$onAction(({ name, args, after, onError }) => {\n // cleanup all pending retries when data is deleted (means the data is not needed anymore)\n if (name === 'remove') {\n const [cacheEntry] = args\n const key = cacheEntry.key.join('/')\n const entry = retryMap.get(key)\n if (entry) {\n clearTimeout(entry.timeoutId)\n retryMap.delete(key)\n }\n }\n\n if (name !== 'fetch') return\n const [queryEntry] = args\n const localOptions = queryEntry.options?.retry\n\n const options = {\n ...(typeof localOptions === 'object'\n ? localOptions\n : {\n retry: localOptions,\n }),\n } satisfies RetryOptions\n\n const retry = options.retry ?? defaults.retry\n const delay = options.delay ?? defaults.delay\n // avoid setting up anything at all\n if (retry === 0) return\n\n const key = queryEntry.key.join('/')\n\n // clear any pending retry\n clearTimeout(retryMap.get(key)?.timeoutId)\n // if the user manually calls the action, reset the retry count\n if (!isInternalCall) {\n retryMap.delete(key)\n }\n\n const retryFetch = () => {\n if (queryEntry.state.value.status === 'error') {\n const error = queryEntry.state.value.error\n // ensure the entry exists\n let entry = retryMap.get(key)\n if (!entry) {\n entry = { retryCount: 0 }\n retryMap.set(key, entry)\n }\n\n const shouldRetry\n = typeof retry === 'number'\n ? retry > entry.retryCount\n : retry(entry.retryCount, error)\n\n if (shouldRetry) {\n const delayTime\n = typeof delay === 'function' ? delay(entry.retryCount) : delay\n entry.timeoutId = setTimeout(() => {\n // NOTE: we could add some default error handler\n isInternalCall = true\n Promise.resolve(queryCache.fetch(queryEntry)).catch(\n process.env.NODE_ENV !== 'test' ? console.error : () => {},\n )\n isInternalCall = false\n if (entry) {\n entry.retryCount++\n }\n }, delayTime)\n } else {\n // remove the entry if we are not going to retry\n retryMap.delete(key)\n }\n } else {\n // remove the entry if it worked out to reset it\n retryMap.delete(key)\n }\n }\n onError(retryFetch)\n after(retryFetch)\n })\n }\n}\n\ndeclare module '@pinia/colada' {\n // eslint-disable-next-line unused-imports/no-unused-vars\n export interface UseQueryOptions<TResult, TError> {\n /**\n * Options for the retries of this query added by `@pinia/colada-plugin-retry`.\n */\n retry?: RetryOptions | Exclude<RetryOptions['retry'], undefined>\n }\n}\n"],"mappings":";AA+BA,IAAM,yBAAyB;AAAA,EAC7B,OAAO,CAAC,YAAoB;AAC1B,UAAM,OAAO,KAAK;AAAA,MAChB,KAAK,UAAU;AAAA;AAAA,MAEf;AAAA,IACF;AACA,YAAQ,IAAI,kCAAwB,UAAU,CAAC,OAAO,IAAI,IAAI;AAC9D,WAAO;AAAA,EACT;AAAA,EACA,OAAO,CAAC,UAAU;AAChB,YAAQ;AAAA,MACN,sBAAe,YAAK,OAAO,QAAQ,CAAC,CAAC,GAAG,eAAK,OAAO,IAAI,KAAK,CAAC;AAAA,IAChE;AACA,WAAO,QAAQ;AAAA,EACjB;AACF;AAOO,SAAS,iBACd,eAC6C;AAC7C,QAAM,WAAW,EAAE,GAAG,wBAAwB,GAAG,cAAc;AAE/D,SAAO,CAAC,EAAE,WAAW,MAAM;AACzB,UAAM,WAAW,oBAAI,IAAwB;AAE7C,QAAI,iBAAiB;AACrB,eAAW,UAAU,CAAC,EAAE,MAAM,MAAM,OAAO,QAAQ,MAAM;AAEvD,UAAI,SAAS,UAAU;AACrB,cAAM,CAAC,UAAU,IAAI;AACrB,cAAMA,OAAM,WAAW,IAAI,KAAK,GAAG;AACnC,cAAM,QAAQ,SAAS,IAAIA,IAAG;AAC9B,YAAI,OAAO;AACT,uBAAa,MAAM,SAAS;AAC5B,mBAAS,OAAOA,IAAG;AAAA,QACrB;AAAA,MACF;AAEA,UAAI,SAAS,QAAS;AACtB,YAAM,CAAC,UAAU,IAAI;AACrB,YAAM,eAAe,WAAW,SAAS;AAEzC,YAAM,UAAU;AAAA,QACd,GAAI,OAAO,iBAAiB,WACxB,eACA;AAAA,UACE,OAAO;AAAA,QACT;AAAA,MACN;AAEA,YAAM,QAAQ,QAAQ,SAAS,SAAS;AACxC,YAAM,QAAQ,QAAQ,SAAS,SAAS;AAExC,UAAI,UAAU,EAAG;AAEjB,YAAM,MAAM,WAAW,IAAI,KAAK,GAAG;AAGnC,mBAAa,SAAS,IAAI,GAAG,GAAG,SAAS;AAEzC,UAAI,CAAC,gBAAgB;AACnB,iBAAS,OAAO,GAAG;AAAA,MACrB;AAEA,YAAM,aAAa,MAAM;AACvB,YAAI,WAAW,MAAM,MAAM,WAAW,SAAS;AAC7C,gBAAM,QAAQ,WAAW,MAAM,MAAM;AAErC,cAAI,QAAQ,SAAS,IAAI,GAAG;AAC5B,cAAI,CAAC,OAAO;AACV,oBAAQ,EAAE,YAAY,EAAE;AACxB,qBAAS,IAAI,KAAK,KAAK;AAAA,UACzB;AAEA,gBAAM,cACF,OAAO,UAAU,WACf,QAAQ,MAAM,aACd,MAAM,MAAM,YAAY,KAAK;AAEnC,cAAI,aAAa;AACf,kBAAM,YACF,OAAO,UAAU,aAAa,MAAM,MAAM,UAAU,IAAI;AAC5D,kBAAM,YAAY,WAAW,MAAM;AAEjC,+BAAiB;AACjB,sBAAQ,QAAQ,WAAW,MAAM,UAAU,CAAC,EAAE;AAAA,gBAC5C,QAAQ,IAAI,aAAa,SAAS,QAAQ,QAAQ,MAAM;AAAA,gBAAC;AAAA,cAC3D;AACA,+BAAiB;AACjB,kBAAI,OAAO;AACT,sBAAM;AAAA,cACR;AAAA,YACF,GAAG,SAAS;AAAA,UACd,OAAO;AAEL,qBAAS,OAAO,GAAG;AAAA,UACrB;AAAA,QACF,OAAO;AAEL,mBAAS,OAAO,GAAG;AAAA,QACrB;AAAA,MACF;AACA,cAAQ,UAAU;AAClB,YAAM,UAAU;AAAA,IAClB,CAAC;AAAA,EACH;AACF;","names":["key"]}
|
package/package.json
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
7
|
-
"version": "0.0.
|
|
7
|
+
"version": "0.0.3",
|
|
8
8
|
"description": "Retry failed requests with Pinia Colada",
|
|
9
9
|
"author": {
|
|
10
10
|
"name": "Eduardo San Martin Morote",
|
|
@@ -58,10 +58,10 @@
|
|
|
58
58
|
"dist"
|
|
59
59
|
],
|
|
60
60
|
"peerDependencies": {
|
|
61
|
-
"@pinia/colada": "^0.
|
|
61
|
+
"@pinia/colada": "^0.13.4"
|
|
62
62
|
},
|
|
63
63
|
"devDependencies": {
|
|
64
|
-
"@pinia/colada": "^0.
|
|
64
|
+
"@pinia/colada": "^0.13.4"
|
|
65
65
|
},
|
|
66
66
|
"scripts": {
|
|
67
67
|
"build": "tsup",
|