@varlet/axle 1.0.1 → 1.0.2

package/dist/use.mjs

@@ -0,0 +1,229 @@
+import { isFunction } from "rattail";
+import { getCurrentInstance, onActivated, onDeactivated, onMounted, onUnmounted, ref, watch } from "vue";
+//#region src/use.ts
+function normalizeValueGetter(valueGetter) {
+	return isFunction(valueGetter) ? valueGetter() : valueGetter;
+}
+const cacheBuffer = /* @__PURE__ */ new Map();
+function cleanupCacheBuffer() {
+	cacheBuffer.forEach((value, key) => {
+		if (value.expiredTime && Date.now() >= value.expiredTime) cacheBuffer.delete(key);
+	});
+}
+function createUseAxle(options) {
+	const { axle, onTransform: defaultOnTransform, immediate: defaultImmediate = true, abortOnUnmount: defaultAbortOnUnmount = true, cacheTime: defaultCacheTime = Infinity } = options;
+	const useAxle = (options) => {
+		const { url: initialUrlOrGetter, method, immediate = defaultImmediate, abortOnUnmount = defaultAbortOnUnmount, cacheTime = defaultCacheTime, cacheKey, pollingInterval, pollingOnHidden = true, pollingOnDeactivated = false, refreshOnWindowFocus = false, value: initialValue, resetValue: initialResetValue, cloneResetValue: initialCloneResetValue, params: initialParamsOrGetter, config: initialConfigOrGetter, watch: watchOptions, runnable = () => true, onBefore = () => {}, onAfter = () => {}, onTransform = defaultOnTransform ?? ((response) => response), onSuccess = () => {}, onError = () => {} } = options;
+		const value = ref(initialValue);
+		const loading = ref(false);
+		const error = ref();
+		const downloadProgress = ref(0);
+		const uploadProgress = ref(0);
+		const pollingCanceled = ref(false);
+		const refs = {
+			value,
+			loading,
+			error,
+			downloadProgress,
+			uploadProgress,
+			pollingCanceled
+		};
+		const extra = {
+			uploadProgress,
+			downloadProgress,
+			loading,
+			error,
+			pollingCanceled,
+			abort,
+			resetValue,
+			invalidateCache,
+			cancelPolling
+		};
+		let controller = new AbortController();
+		let pollingTimer = null;
+		let deactivated = false;
+		let hidden = false;
+		let unmounted = false;
+		const run = Object.assign(async (options = {}) => {
+			if (!runnable() || abortOnUnmount && unmounted) return;
+			pollingCanceled.value = false;
+			if (controller.signal.aborted) controller = new AbortController();
+			if ((options.resetValue ?? initialResetValue ?? false) === true) resetValue(options);
+			uploadProgress.value = 0;
+			downloadProgress.value = 0;
+			const url = options.url ?? normalizeValueGetter(initialUrlOrGetter);
+			const params = options.params ?? normalizeValueGetter(initialParamsOrGetter);
+			const config = options.config ?? normalizeValueGetter(initialConfigOrGetter);
+			const normalizedCacheKey = cacheKey ? normalizeValueGetter(cacheKey) : void 0;
+			onBefore(refs);
+			loading.value = true;
+			try {
+				cleanupCacheBuffer();
+				const response = await getResponse();
+				if (shouldSetCacheResponse(normalizedCacheKey)) {
+					const cache = cacheBuffer.get(normalizedCacheKey);
+					cache.response = response;
+					cache.expiredTime = Date.now() + cacheTime;
+				}
+				value.value = await onTransform(response, refs);
+				error.value = void 0;
+				onSuccess(response, refs);
+				loading.value = false;
+				onAfter(refs);
+				return response;
+			} catch (responseError) {
+				error.value = responseError;
+				onError(responseError, refs);
+				loading.value = false;
+				onAfter(refs);
+				throw responseError;
+			} finally {
+				clearPolling();
+				startPolling();
+			}
+			function getResponse() {
+				if (shouldUseCache(normalizedCacheKey)) return JSON.parse(JSON.stringify(cacheBuffer.get(normalizedCacheKey).response));
+				if (shouldAwaitCachePromise(normalizedCacheKey)) return cacheBuffer.get(normalizedCacheKey).promise;
+				const promise = fetchResponse();
+				if (shouldSetCachePromise(normalizedCacheKey)) cacheBuffer.set(normalizedCacheKey, { promise });
+				return promise;
+			}
+			function fetchResponse() {
+				return axle[method](url, params, {
+					signal: controller.signal,
+					onUploadProgress(event) {
+						uploadProgress.value = event.progress ?? 0;
+					},
+					onDownloadProgress(event) {
+						downloadProgress.value = event.progress ?? 0;
+					},
+					...config
+				});
+			}
+			function shouldUseCache(key) {
+				if (!key || !cacheBuffer.has(key)) return false;
+				return cacheBuffer.get(key).response != null;
+			}
+			function shouldAwaitCachePromise(key) {
+				if (!key || !cacheBuffer.has(key)) return false;
+				return cacheBuffer.get(key).promise;
+			}
+			function shouldSetCachePromise(key) {
+				if (!key || cacheBuffer.has(key)) return false;
+				return true;
+			}
+			function shouldSetCacheResponse(key) {
+				if (!key || !cacheBuffer.has(key)) return false;
+				return cacheBuffer.get(key).response == null;
+			}
+		}, extra);
+		if (immediate) runWithInitialConfig();
+		if (getCurrentInstance()) {
+			onActivated(() => {
+				deactivated = false;
+				addVisibilityChangeListener();
+				addWindowFocusListener();
+				startPolling();
+			});
+			onMounted(() => {
+				addVisibilityChangeListener();
+				addWindowFocusListener();
+			});
+			onDeactivated(() => {
+				deactivated = true;
+				removeVisibilityChangeListener();
+				removeWindowFocusListener();
+				clearPolling();
+			});
+			onUnmounted(() => {
+				removeVisibilityChangeListener();
+				removeWindowFocusListener();
+				cancelPolling();
+			});
+			onUnmounted(() => {
+				unmounted = true;
+				if (abortOnUnmount) abort();
+			});
+			if (watchOptions) {
+				const normalizedWatchOptions = watchOptions === true ? {
+					params: true,
+					config: true
+				} : {
+					params: false,
+					config: false,
+					...watchOptions
+				};
+				const enableWatchParams = isFunction(initialParamsOrGetter) && normalizedWatchOptions.params;
+				const enableWatchConfig = isFunction(initialConfigOrGetter) && normalizedWatchOptions.config;
+				watch(() => [
+					enableWatchParams ? normalizeValueGetter(initialParamsOrGetter) : void 0,
+					enableWatchConfig ? normalizeValueGetter(initialConfigOrGetter) : void 0,
+					normalizedWatchOptions._custom ? normalizedWatchOptions._custom() : void 0
+				], () => {
+					runWithInitialConfig();
+				});
+			}
+		}
+		function runWithInitialConfig() {
+			return run({
+				url: normalizeValueGetter(initialUrlOrGetter),
+				params: normalizeValueGetter(initialParamsOrGetter),
+				config: normalizeValueGetter(initialConfigOrGetter)
+			});
+		}
+		function resetValue(options = {}) {
+			value.value = ((options.cloneResetValue ?? initialCloneResetValue ?? false) === true ? (v) => v == null ? null : JSON.parse(JSON.stringify(v)) : isFunction(initialCloneResetValue) ? initialCloneResetValue : (v) => v)(initialValue);
+		}
+		function abort() {
+			controller.abort();
+		}
+		function addWindowFocusListener() {
+			if (typeof window !== "undefined") window.addEventListener("focus", handleWindowFocus);
+		}
+		function removeWindowFocusListener() {
+			if (typeof window !== "undefined") window.removeEventListener("focus", handleWindowFocus);
+		}
+		function handleWindowFocus() {
+			if (refreshOnWindowFocus) runWithInitialConfig();
+		}
+		function addVisibilityChangeListener() {
+			if (typeof document !== "undefined") document.addEventListener("visibilitychange", handleVisibilityChange);
+		}
+		function removeVisibilityChangeListener() {
+			if (typeof document !== "undefined") document.removeEventListener("visibilitychange", handleVisibilityChange);
+		}
+		function handleVisibilityChange() {
+			hidden = document.visibilityState === "hidden";
+			if (pollingOnHidden) return;
+			hidden ? clearPolling() : startPolling();
+		}
+		function startPolling() {
+			if (pollingInterval == null || pollingCanceled.value || pollingTimer != null || deactivated && !pollingOnDeactivated || hidden && !pollingOnHidden) return;
+			pollingTimer = setTimeout(() => {
+				runWithInitialConfig();
+			}, pollingInterval);
+		}
+		function clearPolling() {
+			if (pollingTimer == null) return;
+			clearTimeout(pollingTimer);
+			pollingTimer = null;
+		}
+		function cancelPolling() {
+			clearPolling();
+			pollingCanceled.value = true;
+		}
+		function invalidateCache() {
+			const normalizedCacheKey = cacheKey ? normalizeValueGetter(cacheKey) : void 0;
+			if (!normalizedCacheKey || !cacheBuffer.has(normalizedCacheKey)) return;
+			cacheBuffer.delete(normalizedCacheKey);
+		}
+		return [
+			value,
+			run,
+			extra
+		];
+	};
+	return useAxle;
+}
+//#endregion
+export { cleanupCacheBuffer, createUseAxle, normalizeValueGetter };

package/package.json

@@ -1,76 +1,76 @@
 {
   "name": "@varlet/axle",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Progressive request tool based on axios",
   "keywords": [
-    "axle",
     "axios",
+    "axle",
+    "composition api",
     "helpers",
-    "vue3",
-    "composition api"
+    "vue3"
   ],
   "bugs": {
     "url": "https://github.com/varletjs/axle/issues"
   },
+  "license": "MIT",
+  "author": "haoziqaq <357229046@qq.com>",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/varletjs/axle.git"
   },
-  "license": "MIT",
-  "author": "haoziqaq <357229046@qq.com>",
-  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
   "type": "module",
+  "sideEffects": false,
+  "main": "dist/index.mjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.mts",
+  "typesVersions": {
+    "*": {
+      "use": [
+        "dist/use.d.mts"
+      ],
+      "api": [
+        "dist/api.d.mts"
+      ]
+    }
+  },
   "exports": {
     ".": {
-      "import": "./lib/index.js",
-      "require": "./lib/index.cjs",
-      "types": "./lib/index.d.ts"
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
     },
     "./use": {
-      "import": "./lib/use.js",
-      "require": "./lib/use.cjs",
-      "types": "./lib/use.d.ts"
+      "types": "./dist/use.d.mts",
+      "import": "./dist/use.mjs"
     },
     "./api": {
-      "import": "./lib/api.js",
-      "require": "./lib/api.cjs",
-      "types": "./lib/api.d.ts"
+      "types": "./dist/api.d.mts",
+      "import": "./dist/api.mjs"
     },
     "./*": "./*"
   },
-  "main": "lib/index.cjs",
-  "module": "lib/index.js",
-  "types": "index.d.ts",
-  "typesVersions": {
-    "*": {
-      "*": [
-        "./lib/*"
-      ]
-    }
-  },
-  "files": [
-    "lib"
-  ],
   "dependencies": {
     "axios": "1.7.3",
     "crypto-js": "^4.2.0",
     "lodash": "4.17.21",
     "qs": "^6.11.0",
-    "rattail": "1.0.0"
+    "rattail": "^1.8.1"
   },
   "devDependencies": {
     "@types/crypto-js": "^4.2.1",
     "@types/lodash": "4.14.202",
     "@types/qs": "^6.9.7",
-    "tsup": "7.2.0",
     "typescript": "^5.1.5",
+    "vite-plus": "^0.1.16",
     "vue": "3.3.4"
   },
   "peerDependencies": {
     "vue": "^3.2.0"
   },
   "scripts": {
-    "build": "tsup src/index.ts src/use.ts src/api.ts --format esm,cjs --out-dir=lib --dts --clean",
-    "dev": "tsup src/index.ts src/use.ts src/api.ts --format esm --out-dir=lib --watch --dts"
+    "build": "vp pack",
+    "dev": "vp pack --watch"
   }
 }

package/lib/api.cjs

@@ -1,89 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-var __objRest = (source, exclude) => {
-  var target = {};
-  for (var prop in source)
-    if (__hasOwnProp.call(source, prop) && exclude.indexOf(prop) < 0)
-      target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum.call(source, prop))
-        target[prop] = source[prop];
-    }
-  return target;
-};
-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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/api.ts
-var api_exports = {};
-__export(api_exports, {
-  createApi: () => createApi
-});
-module.exports = __toCommonJS(api_exports);
-var import_rattail = require("rattail");
-function createApi(axle, useAxle) {
-  return function api(url, method) {
-    function load(params, pathParams, config) {
-      return axle[method](patchUrl(url, pathParams != null ? pathParams : {}), params, config);
-    }
-    function use(options = {}) {
-      const _a = options, { pathParams = {}, watch: watchOptions } = _a, rest = __objRest(_a, ["pathParams", "watch"]);
-      const enableWatchPathParams = (0, import_rattail.isFunction)(pathParams) && ((watchOptions == null ? void 0 : watchOptions.pathParams) || watchOptions === true);
-      const normalizedWatchOptions = watchOptions === true ? { params: true, config: true, _custom: enableWatchPathParams ? pathParams : void 0 } : watchOptions === false ? { params: false, config: false } : __spreadProps(__spreadValues({ params: false, config: false }, watchOptions), { _custom: enableWatchPathParams ? pathParams : void 0 });
-      return useAxle(__spreadValues({
-        url: () => patchUrl(url, pathParams),
-        method,
-        watch: normalizedWatchOptions
-      }, rest));
-    }
-    function patchUrl(url2, pathParams) {
-      const params = (0, import_rattail.isFunction)(pathParams) ? pathParams() : pathParams;
-      Object.entries(params).forEach(([key, value]) => {
-        url2 = url2.replace(`:${key}`, value);
-      });
-      return url2;
-    }
-    return {
-      url,
-      load,
-      use,
-      patchUrl
-    };
-  };
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  createApi
-});

package/lib/api.d.cts

@@ -1,28 +0,0 @@
-import { e as AxleInstance, d as RunnerMethod, A as AxleRequestConfig } from './instance-857fe07c.js';
-import { WatchOptions, UseAxleOptions, UseAxleOptionsWithRunnable, UseAxle, UseAxleInstance } from './use.cjs';
-import 'axios';
-import 'vue';
-
-type ApiPathParams = Record<string, any> | (() => Record<string, any>);
-type ApiWatchOptions = WatchOptions & {
-    pathParams?: boolean;
-};
-type ApiUseOptions<V, R, P, D> = Partial<UseAxleOptions<V, R, P, D>> & {
-    pathParams?: ApiPathParams;
-    watch?: ApiWatchOptions;
-};
-type ApiUseOptionsWithRunnable<V, R, P, D> = Partial<Omit<UseAxleOptionsWithRunnable<V, R, P, D>, 'runnable'>> & Pick<UseAxleOptionsWithRunnable<V, R, P, D>, 'runnable'> & {
-    pathParams?: ApiPathParams;
-    watch?: ApiWatchOptions;
-};
-declare function createApi(axle: AxleInstance, useAxle: UseAxle): <R = any, P = Record<string, any>, D = Record<string, any>>(url: string, method: RunnerMethod) => {
-    url: string;
-    load: (params?: P | undefined, pathParams?: ApiPathParams, config?: AxleRequestConfig<D, Record<string, any>> | undefined) => Promise<R>;
-    use: {
-        <V = R>(options?: ApiUseOptionsWithRunnable<V, R, P, D> | undefined): UseAxleInstance<V, R | undefined, P, D>;
-        <V_1 = R>(options?: ApiUseOptions<V_1, R, P, D> | undefined): UseAxleInstance<V_1, R, P, D>;
-    };
-    patchUrl: (url: string, pathParams: ApiPathParams) => string;
-};
-
-export { ApiPathParams, ApiUseOptions, ApiUseOptionsWithRunnable, ApiWatchOptions, createApi };

package/lib/api.d.ts

@@ -1,28 +0,0 @@
-import { e as AxleInstance, d as RunnerMethod, A as AxleRequestConfig } from './instance-857fe07c.js';
-import { WatchOptions, UseAxleOptions, UseAxleOptionsWithRunnable, UseAxle, UseAxleInstance } from './use.js';
-import 'axios';
-import 'vue';
-
-type ApiPathParams = Record<string, any> | (() => Record<string, any>);
-type ApiWatchOptions = WatchOptions & {
-    pathParams?: boolean;
-};
-type ApiUseOptions<V, R, P, D> = Partial<UseAxleOptions<V, R, P, D>> & {
-    pathParams?: ApiPathParams;
-    watch?: ApiWatchOptions;
-};
-type ApiUseOptionsWithRunnable<V, R, P, D> = Partial<Omit<UseAxleOptionsWithRunnable<V, R, P, D>, 'runnable'>> & Pick<UseAxleOptionsWithRunnable<V, R, P, D>, 'runnable'> & {
-    pathParams?: ApiPathParams;
-    watch?: ApiWatchOptions;
-};
-declare function createApi(axle: AxleInstance, useAxle: UseAxle): <R = any, P = Record<string, any>, D = Record<string, any>>(url: string, method: RunnerMethod) => {
-    url: string;
-    load: (params?: P | undefined, pathParams?: ApiPathParams, config?: AxleRequestConfig<D, Record<string, any>> | undefined) => Promise<R>;
-    use: {
-        <V = R>(options?: ApiUseOptionsWithRunnable<V, R, P, D> | undefined): UseAxleInstance<V, R | undefined, P, D>;
-        <V_1 = R>(options?: ApiUseOptions<V_1, R, P, D> | undefined): UseAxleInstance<V_1, R, P, D>;
-    };
-    patchUrl: (url: string, pathParams: ApiPathParams) => string;
-};
-
-export { ApiPathParams, ApiUseOptions, ApiUseOptionsWithRunnable, ApiWatchOptions, createApi };

package/lib/api.js

@@ -1,41 +0,0 @@
-import {
-  __objRest,
-  __spreadProps,
-  __spreadValues
-} from "./chunk-G2ADBYYC.js";
-
-// src/api.ts
-import { isFunction } from "rattail";
-function createApi(axle, useAxle) {
-  return function api(url, method) {
-    function load(params, pathParams, config) {
-      return axle[method](patchUrl(url, pathParams != null ? pathParams : {}), params, config);
-    }
-    function use(options = {}) {
-      const _a = options, { pathParams = {}, watch: watchOptions } = _a, rest = __objRest(_a, ["pathParams", "watch"]);
-      const enableWatchPathParams = isFunction(pathParams) && ((watchOptions == null ? void 0 : watchOptions.pathParams) || watchOptions === true);
-      const normalizedWatchOptions = watchOptions === true ? { params: true, config: true, _custom: enableWatchPathParams ? pathParams : void 0 } : watchOptions === false ? { params: false, config: false } : __spreadProps(__spreadValues({ params: false, config: false }, watchOptions), { _custom: enableWatchPathParams ? pathParams : void 0 });
-      return useAxle(__spreadValues({
-        url: () => patchUrl(url, pathParams),
-        method,
-        watch: normalizedWatchOptions
-      }, rest));
-    }
-    function patchUrl(url2, pathParams) {
-      const params = isFunction(pathParams) ? pathParams() : pathParams;
-      Object.entries(params).forEach(([key, value]) => {
-        url2 = url2.replace(`:${key}`, value);
-      });
-      return url2;
-    }
-    return {
-      url,
-      load,
-      use,
-      patchUrl
-    };
-  };
-}
-export {
-  createApi
-};

package/lib/chunk-G2ADBYYC.js

@@ -1,37 +0,0 @@
-var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-var __objRest = (source, exclude) => {
-  var target = {};
-  for (var prop in source)
-    if (__hasOwnProp.call(source, prop) && exclude.indexOf(prop) < 0)
-      target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum.call(source, prop))
-        target[prop] = source[prop];
-    }
-  return target;
-};
-
-export {
-  __spreadValues,
-  __spreadProps,
-  __objRest
-};