@varlet/axle 1.0.0 → 1.0.2

package/lib/use.cjs

@@ -1,351 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-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 __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/use.ts
-var use_exports = {};
-__export(use_exports, {
-  cleanupCacheBuffer: () => cleanupCacheBuffer,
-  createUseAxle: () => createUseAxle,
-  normalizeValueGetter: () => normalizeValueGetter
-});
-module.exports = __toCommonJS(use_exports);
-var import_vue = require("vue");
-var import_rattail = require("rattail");
-function normalizeValueGetter(valueGetter) {
-  return (0, import_rattail.isFunction)(valueGetter) ? valueGetter() : valueGetter;
-}
-var 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 = (options2) => {
-    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 != null ? defaultOnTransform : (response) => response,
-      onSuccess = () => {
-      },
-      onError = () => {
-      }
-    } = options2;
-    const value = (0, import_vue.ref)(initialValue);
-    const loading = (0, import_vue.ref)(false);
-    const error = (0, import_vue.ref)();
-    const downloadProgress = (0, import_vue.ref)(0);
-    const uploadProgress = (0, import_vue.ref)(0);
-    const pollingCanceled = (0, import_vue.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 (options3 = {}) => {
-      var _a, _b, _c, _d, _e;
-      if (!runnable() || abortOnUnmount && unmounted) {
-        return;
-      }
-      pollingCanceled.value = false;
-      if (controller.signal.aborted) {
-        controller = new AbortController();
-      }
-      const resetValueOption = (_b = (_a = options3.resetValue) != null ? _a : initialResetValue) != null ? _b : false;
-      if (resetValueOption === true) {
-        resetValue(options3);
-      }
-      uploadProgress.value = 0;
-      downloadProgress.value = 0;
-      const url = (_c = options3.url) != null ? _c : normalizeValueGetter(initialUrlOrGetter);
-      const params = (_d = options3.params) != null ? _d : normalizeValueGetter(initialParamsOrGetter);
-      const config = (_e = options3.config) != null ? _e : 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, __spreadValues({
-          signal: controller.signal,
-          onUploadProgress(event) {
-            var _a2;
-            uploadProgress.value = (_a2 = event.progress) != null ? _a2 : 0;
-          },
-          onDownloadProgress(event) {
-            var _a2;
-            downloadProgress.value = (_a2 = event.progress) != null ? _a2 : 0;
-          }
-        }, config));
-      }
-      function shouldUseCache(key) {
-        if (!key || !cacheBuffer.has(key)) {
-          return false;
-        }
-        const buffer = cacheBuffer.get(key);
-        return buffer.response != null;
-      }
-      function shouldAwaitCachePromise(key) {
-        if (!key || !cacheBuffer.has(key)) {
-          return false;
-        }
-        const buffer = cacheBuffer.get(key);
-        return buffer.promise;
-      }
-      function shouldSetCachePromise(key) {
-        if (!key || cacheBuffer.has(key)) {
-          return false;
-        }
-        return true;
-      }
-      function shouldSetCacheResponse(key) {
-        if (!key || !cacheBuffer.has(key)) {
-          return false;
-        }
-        const buffer = cacheBuffer.get(key);
-        return buffer.response == null;
-      }
-    }, extra);
-    if (immediate) {
-      runWithInitialConfig();
-    }
-    if ((0, import_vue.getCurrentInstance)()) {
-      (0, import_vue.onActivated)(() => {
-        deactivated = false;
-        addVisibilityChangeListener();
-        addWindowFocusListener();
-        startPolling();
-      });
-      (0, import_vue.onMounted)(() => {
-        addVisibilityChangeListener();
-        addWindowFocusListener();
-      });
-      (0, import_vue.onDeactivated)(() => {
-        deactivated = true;
-        removeVisibilityChangeListener();
-        removeWindowFocusListener();
-        clearPolling();
-      });
-      (0, import_vue.onUnmounted)(() => {
-        removeVisibilityChangeListener();
-        removeWindowFocusListener();
-        cancelPolling();
-      });
-      (0, import_vue.onUnmounted)(() => {
-        unmounted = true;
-        if (abortOnUnmount) {
-          abort();
-        }
-      });
-      if (watchOptions) {
-        const normalizedWatchOptions = watchOptions === true ? { params: true, config: true } : __spreadValues({ params: false, config: false }, watchOptions);
-        const enableWatchParams = (0, import_rattail.isFunction)(initialParamsOrGetter) && normalizedWatchOptions.params;
-        const enableWatchConfig = (0, import_rattail.isFunction)(initialConfigOrGetter) && normalizedWatchOptions.config;
-        (0, import_vue.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(options3 = {}) {
-      var _a, _b;
-      const cloneResetValue = (_b = (_a = options3.cloneResetValue) != null ? _a : initialCloneResetValue) != null ? _b : false;
-      const cloneFn = cloneResetValue === true ? (v) => v == null ? null : JSON.parse(JSON.stringify(v)) : (0, import_rattail.isFunction)(initialCloneResetValue) ? initialCloneResetValue : (v) => v;
-      value.value = cloneFn(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;
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  cleanupCacheBuffer,
-  createUseAxle,
-  normalizeValueGetter
-});

package/lib/use.d.cts

@@ -1,85 +0,0 @@
-import { Ref } from 'vue';
-import { A as AxleRequestConfig, d as RunnerMethod, e as AxleInstance } from './instance-857fe07c.js';
-import 'axios';
-
-type Runnable = () => boolean;
-interface RunOptions<V, P, D> {
-    url?: string;
-    params?: P;
-    config?: AxleRequestConfig<D>;
-    resetValue?: boolean;
-    cloneResetValue?: boolean | ((value: V) => V);
-}
-type UseAxleExtra<V> = {
-    loading: Ref<boolean>;
-    error: Ref<Error | undefined>;
-    uploadProgress: Ref<number>;
-    downloadProgress: Ref<number>;
-    pollingCanceled: Ref<boolean>;
-    abort(): void;
-    resetValue(options?: ResetValueOptions<V>): void;
-    invalidateCache(): void;
-    cancelPolling(): void;
-};
-interface UseAxleRefs<V> {
-    value: Ref<V>;
-    loading: Ref<boolean>;
-    error: Ref<Error | undefined>;
-    uploadProgress: Ref<number>;
-    downloadProgress: Ref<number>;
-    pollingCanceled: Ref<boolean>;
-}
-type Run<V, R, P, D> = {
-    (options?: RunOptions<V, P, D>): Promise<R>;
-} & UseAxleExtra<V>;
-type WatchOptions = boolean | {
-    params?: boolean;
-    config?: boolean;
-    _custom?: () => any;
-};
-interface UseAxleOptions<V = any, R = any, P = Record<string, any>, D = Record<string, any>> {
-    url: string | (() => string);
-    method: RunnerMethod;
-    value?: V;
-    immediate?: boolean;
-    resetValue?: boolean;
-    cloneResetValue?: boolean | ((value: V) => V);
-    abortOnUnmount?: boolean;
-    cacheKey?: string | (() => string);
-    cacheTime?: number;
-    config?: AxleRequestConfig<D> | (() => AxleRequestConfig<D>);
-    watch?: WatchOptions;
-    pollingInterval?: number;
-    pollingOnHidden?: boolean;
-    pollingOnDeactivated?: boolean;
-    refreshOnWindowFocus?: boolean;
-    params?: P | (() => P);
-    onBefore?(refs: UseAxleRefs<V>): void;
-    onAfter?(refs: UseAxleRefs<V>): void;
-    onTransform?(response: R, refs: UseAxleRefs<V>): V | Promise<V>;
-    onSuccess?(response: R, refs: UseAxleRefs<V>): void;
-    onError?(error: Error, refs: UseAxleRefs<V>): void;
-}
-interface ResetValueOptions<V> {
-    cloneResetValue?: boolean | ((value: V) => V);
-}
-type UseAxleInstance<V, R, P, D> = [value: Ref<V>, run: Run<V, R, P, D>, extra: UseAxleExtra<V>];
-interface CreateUseAxleOptions {
-    axle: AxleInstance;
-    immediate?: boolean;
-    abortOnUnmount?: boolean;
-    cacheTime?: number;
-    onTransform?(response: any, refs: any): any;
-}
-type UseAxleOptionsWithRunnable<V = any, R = any, P = Record<string, any>, D = Record<string, any>> = UseAxleOptions<V, R, P, D> & {
-    runnable: Runnable;
-};
-interface UseAxle {
-    <V = any, R = any, P = Record<string, any>, D = Record<string, any>>(options: UseAxleOptionsWithRunnable<V, R, P, D>): UseAxleInstance<V, R | undefined, P, D>;
-    <V = any, R = any, P = Record<string, any>, D = Record<string, any>>(options: UseAxleOptions<V, R, P, D>): UseAxleInstance<V, R, P, D>;
-}
-declare function normalizeValueGetter<T>(valueGetter: T | (() => T)): T;
-declare function cleanupCacheBuffer(): void;
-declare function createUseAxle(options: CreateUseAxleOptions): UseAxle;
-
-export { CreateUseAxleOptions, ResetValueOptions, Run, RunOptions, Runnable, UseAxle, UseAxleExtra, UseAxleInstance, UseAxleOptions, UseAxleOptionsWithRunnable, UseAxleRefs, WatchOptions, cleanupCacheBuffer, createUseAxle, normalizeValueGetter };

package/lib/use.d.ts

@@ -1,85 +0,0 @@
-import { Ref } from 'vue';
-import { A as AxleRequestConfig, d as RunnerMethod, e as AxleInstance } from './instance-857fe07c.js';
-import 'axios';
-
-type Runnable = () => boolean;
-interface RunOptions<V, P, D> {
-    url?: string;
-    params?: P;
-    config?: AxleRequestConfig<D>;
-    resetValue?: boolean;
-    cloneResetValue?: boolean | ((value: V) => V);
-}
-type UseAxleExtra<V> = {
-    loading: Ref<boolean>;
-    error: Ref<Error | undefined>;
-    uploadProgress: Ref<number>;
-    downloadProgress: Ref<number>;
-    pollingCanceled: Ref<boolean>;
-    abort(): void;
-    resetValue(options?: ResetValueOptions<V>): void;
-    invalidateCache(): void;
-    cancelPolling(): void;
-};
-interface UseAxleRefs<V> {
-    value: Ref<V>;
-    loading: Ref<boolean>;
-    error: Ref<Error | undefined>;
-    uploadProgress: Ref<number>;
-    downloadProgress: Ref<number>;
-    pollingCanceled: Ref<boolean>;
-}
-type Run<V, R, P, D> = {
-    (options?: RunOptions<V, P, D>): Promise<R>;
-} & UseAxleExtra<V>;
-type WatchOptions = boolean | {
-    params?: boolean;
-    config?: boolean;
-    _custom?: () => any;
-};
-interface UseAxleOptions<V = any, R = any, P = Record<string, any>, D = Record<string, any>> {
-    url: string | (() => string);
-    method: RunnerMethod;
-    value?: V;
-    immediate?: boolean;
-    resetValue?: boolean;
-    cloneResetValue?: boolean | ((value: V) => V);
-    abortOnUnmount?: boolean;
-    cacheKey?: string | (() => string);
-    cacheTime?: number;
-    config?: AxleRequestConfig<D> | (() => AxleRequestConfig<D>);
-    watch?: WatchOptions;
-    pollingInterval?: number;
-    pollingOnHidden?: boolean;
-    pollingOnDeactivated?: boolean;
-    refreshOnWindowFocus?: boolean;
-    params?: P | (() => P);
-    onBefore?(refs: UseAxleRefs<V>): void;
-    onAfter?(refs: UseAxleRefs<V>): void;
-    onTransform?(response: R, refs: UseAxleRefs<V>): V | Promise<V>;
-    onSuccess?(response: R, refs: UseAxleRefs<V>): void;
-    onError?(error: Error, refs: UseAxleRefs<V>): void;
-}
-interface ResetValueOptions<V> {
-    cloneResetValue?: boolean | ((value: V) => V);
-}
-type UseAxleInstance<V, R, P, D> = [value: Ref<V>, run: Run<V, R, P, D>, extra: UseAxleExtra<V>];
-interface CreateUseAxleOptions {
-    axle: AxleInstance;
-    immediate?: boolean;
-    abortOnUnmount?: boolean;
-    cacheTime?: number;
-    onTransform?(response: any, refs: any): any;
-}
-type UseAxleOptionsWithRunnable<V = any, R = any, P = Record<string, any>, D = Record<string, any>> = UseAxleOptions<V, R, P, D> & {
-    runnable: Runnable;
-};
-interface UseAxle {
-    <V = any, R = any, P = Record<string, any>, D = Record<string, any>>(options: UseAxleOptionsWithRunnable<V, R, P, D>): UseAxleInstance<V, R | undefined, P, D>;
-    <V = any, R = any, P = Record<string, any>, D = Record<string, any>>(options: UseAxleOptions<V, R, P, D>): UseAxleInstance<V, R, P, D>;
-}
-declare function normalizeValueGetter<T>(valueGetter: T | (() => T)): T;
-declare function cleanupCacheBuffer(): void;
-declare function createUseAxle(options: CreateUseAxleOptions): UseAxle;
-
-export { CreateUseAxleOptions, ResetValueOptions, Run, RunOptions, Runnable, UseAxle, UseAxleExtra, UseAxleInstance, UseAxleOptions, UseAxleOptionsWithRunnable, UseAxleRefs, WatchOptions, cleanupCacheBuffer, createUseAxle, normalizeValueGetter };