minh-custom-hooks-release/dist/cjs/hooks/useTaskEffect.js

My custom hooks for working easier while developing react web app

"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
    return new (P || (P = Promise))(function (resolve, reject) {
        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
        step((generator = generator.apply(thisArg, _arguments || [])).next());
    });
};
var __generator = (this && this.__generator) || function (thisArg, body) {
    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
    function verb(n) { return function (v) { return step([n, v]); }; }
    function step(op) {
        if (f) throw new TypeError("Generator is already executing.");
        while (g && (g = 0, op[0] && (_ = 0)), _) try {
            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
            if (y = 0, t) op = [op[0] & 2, t.value];
            switch (op[0]) {
                case 0: case 1: t = op; break;
                case 4: _.label++; return { value: op[1], done: false };
                case 5: _.label++; y = op[1]; op = [0]; continue;
                case 7: op = _.ops.pop(); _.trys.pop(); continue;
                default:
                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
                    if (t[2]) _.ops.pop();
                    _.trys.pop(); continue;
            }
            op = body.call(thisArg, _);
        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
    }
};
var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
        if (ar || !(i in from)) {
            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
            ar[i] = from[i];
        }
    }
    return to.concat(ar || Array.prototype.slice.call(from));
};
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.default = useTaskEffect;
var react_1 = require("react");
var react_native_uuid_1 = __importDefault(require("react-native-uuid"));
var useTask_1 = require("./useTask");
function useTaskEffect(_a) {
    var _this = this;
    var task = _a.task, onBeforeStart = _a.onBeforeStart, onInit = _a.onInit, onSuccess = _a.onSuccess, onError = _a.onError, onFinally = _a.onFinally, _b = _a.preserve, preserve = _b === void 0 ? true : _b, _c = _a.preserveWhenError, preserveWhenError = _c === void 0 ? false : _c, deps = _a.deps, _d = _a.enabled, enabled = _d === void 0 ? true : _d, loadingAtInit = _a.loadingAtInit, _e = _a.startLoadingOnBeforeStart, startLoadingOnBeforeStart = _e === void 0 ? true : _e, debounceTime = _a.debounceTime, _f = _a.resetOnUnmount, resetOnUnmount = _f === void 0 ? true : _f, immediateFirstFetch = _a.immediateFirstFetch;
    var isInitRef = (0, react_1.useRef)(false);
    var _g = (0, react_1.useState)(), taskData = _g[0], setTaskData = _g[1];
    var _h = (0, react_1.useState)(), taskError = _h[0], setTaskError = _h[1];
    var _j = (0, react_1.useState)(loadingAtInit ? useTask_1.EnumTaskState.PENDING : useTask_1.EnumTaskState.IDLE), taskState = _j[0], setTaskState = _j[1];
    var _k = (0, react_1.useState)(false), isFirstFetch = _k[0], setIsFirstFetch = _k[1];
    // For debounce time
    var timeoutId = (0, react_1.useRef)();
    var rejectRef = (0, react_1.useRef)();
    // STORE NEWEST TASK ID TO MAKE SURE TASK DATA AND TASK STATE IS NEWEST
    var newestTask = (0, react_1.useRef)();
    var runTask = function () {
        var _ = [];
        for (var _i = 0; _i < arguments.length; _i++) {
            _[_i] = arguments[_i];
        }
        var taskAsync = function () { return __awaiter(_this, void 0, void 0, function () {
            var taskId, continueRunningTask, err_1, res, err_2;
            return __generator(this, function (_a) {
                switch (_a.label) {
                    case 0:
                        taskId = react_native_uuid_1.default.v4();
                        newestTask.current = taskId;
                        setTaskState(useTask_1.EnumTaskState.PENDING);
                        !preserve && setTaskData(undefined);
                        continueRunningTask = true;
                        if (!onBeforeStart) return [3 /*break*/, 4];
                        startLoadingOnBeforeStart && setTaskState(useTask_1.EnumTaskState.PENDING);
                        _a.label = 1;
                    case 1:
                        _a.trys.push([1, 3, , 4]);
                        return [4 /*yield*/, onBeforeStart()];
                    case 2:
                        continueRunningTask = _a.sent();
                        if (!continueRunningTask)
                            setTaskState(useTask_1.EnumTaskState.IDLE);
                        return [3 /*break*/, 4];
                    case 3:
                        err_1 = _a.sent();
                        continueRunningTask = false;
                        setTaskState(useTask_1.EnumTaskState.FAIL);
                        return [3 /*break*/, 4];
                    case 4:
                        if (!continueRunningTask) return [3 /*break*/, 10];
                        setTaskState(useTask_1.EnumTaskState.PENDING);
                        _a.label = 5;
                    case 5:
                        _a.trys.push([5, 8, 9, 10]);
                        if (!(newestTask.current === taskId)) return [3 /*break*/, 7];
                        return [4 /*yield*/, task()];
                    case 6:
                        res = _a.sent();
                        onSuccess && onSuccess(res);
                        setTaskData(res);
                        setTaskState(useTask_1.EnumTaskState.SUCCESS);
                        _a.label = 7;
                    case 7: return [3 /*break*/, 10];
                    case 8:
                        err_2 = _a.sent();
                        onError && onError(err_2);
                        !preserveWhenError && setTaskData(undefined);
                        setTaskState(useTask_1.EnumTaskState.FAIL);
                        setTaskError(err_2);
                        return [3 /*break*/, 10];
                    case 9:
                        if (newestTask.current === taskId) {
                            onFinally && onFinally();
                        }
                        return [7 /*endfinally*/];
                    case 10: return [2 /*return*/];
                }
            });
        }); };
        taskAsync();
    };
    var runTaskDebounce = function () {
        var _ = [];
        for (var _i = 0; _i < arguments.length; _i++) {
            _[_i] = arguments[_i];
        }
        clearTimeout(timeoutId.current);
        setTaskState(useTask_1.EnumTaskState.PENDING);
        timeoutId.current = setTimeout(function () {
            runTask();
        }, debounceTime);
    };
    var runTaskAsync = function () {
        var _ = [];
        for (var _i = 0; _i < arguments.length; _i++) {
            _[_i] = arguments[_i];
        }
        return __awaiter(_this, void 0, void 0, function () {
            var taskId, continueRunningTask, err_3, res, err_4;
            return __generator(this, function (_a) {
                switch (_a.label) {
                    case 0:
                        taskId = react_native_uuid_1.default.v4();
                        newestTask.current = taskId;
                        !preserve && setTaskData(undefined);
                        continueRunningTask = true;
                        if (!onBeforeStart) return [3 /*break*/, 4];
                        startLoadingOnBeforeStart && setTaskState(useTask_1.EnumTaskState.PENDING);
                        _a.label = 1;
                    case 1:
                        _a.trys.push([1, 3, , 4]);
                        return [4 /*yield*/, onBeforeStart()];
                    case 2:
                        continueRunningTask = _a.sent();
                        if (!continueRunningTask)
                            setTaskState(useTask_1.EnumTaskState.IDLE);
                        return [3 /*break*/, 4];
                    case 3:
                        err_3 = _a.sent();
                        continueRunningTask = false;
                        setTaskState(useTask_1.EnumTaskState.FAIL);
                        return [3 /*break*/, 4];
                    case 4:
                        if (!continueRunningTask) return [3 /*break*/, 11];
                        setTaskState(useTask_1.EnumTaskState.PENDING);
                        _a.label = 5;
                    case 5:
                        _a.trys.push([5, 8, 9, 10]);
                        if (!(newestTask.current === taskId)) return [3 /*break*/, 7];
                        return [4 /*yield*/, task()];
                    case 6:
                        res = _a.sent();
                        onSuccess && onSuccess(res);
                        setTaskData(res);
                        setTaskState(useTask_1.EnumTaskState.SUCCESS);
                        return [2 /*return*/, res];
                    case 7: return [2 /*return*/, undefined];
                    case 8:
                        err_4 = _a.sent();
                        onError && onError(err_4);
                        !preserveWhenError && setTaskData(undefined);
                        setTaskState(useTask_1.EnumTaskState.FAIL);
                        setTaskError(err_4);
                        throw err_4;
                    case 9:
                        if (newestTask.current === taskId) {
                            // If newest task !== taskId, new task has been created, and it will surely reach finally and off loading would be trigger
                            // else if it is canceled, the task state and loading state is immediately set when cancel function is triggered
                            onFinally && onFinally();
                        }
                        return [7 /*endfinally*/];
                    case 10: return [3 /*break*/, 12];
                    case 11: return [2 /*return*/, undefined];
                    case 12: return [2 /*return*/];
                }
            });
        });
    };
    var runTaskDebounceAsync = function () {
        var _ = [];
        for (var _i = 0; _i < arguments.length; _i++) {
            _[_i] = arguments[_i];
        }
        return __awaiter(_this, void 0, void 0, function () {
            var _a;
            var _b;
            return __generator(this, function (_c) {
                switch (_c.label) {
                    case 0:
                        (_b = rejectRef.current) === null || _b === void 0 ? void 0 : _b.call(rejectRef, false);
                        clearTimeout(timeoutId.current);
                        _c.label = 1;
                    case 1:
                        _c.trys.push([1, 3, , 4]);
                        setTaskState(useTask_1.EnumTaskState.PENDING);
                        return [4 /*yield*/, new Promise(function (resolve, reject) {
                                rejectRef.current = reject;
                                setTimeout(function () {
                                    resolve(true);
                                }, debounceTime);
                            })];
                    case 2:
                        _c.sent();
                        return [2 /*return*/, runTaskAsync()];
                    case 3:
                        _a = _c.sent();
                        return [2 /*return*/, undefined];
                    case 4: return [2 /*return*/];
                }
            });
        });
    };
    var cancelTask = (0, react_1.useCallback)(function () {
        newestTask.current = undefined;
        setTaskState(useTask_1.EnumTaskState.CANCELED);
        clearTimeout(timeoutId.current);
    }, []);
    var reset = (0, react_1.useCallback)(function () {
        cancelTask();
        setTaskData(undefined);
        setTaskState(useTask_1.EnumTaskState.IDLE);
    }, []);
    (0, react_1.useEffect)(function () {
        if (!isInitRef.current) {
            onInit === null || onInit === void 0 ? void 0 : onInit(debounceTime ? runTaskDebounce : runTask, cancelTask, reset);
            isInitRef.current = true;
            if (immediateFirstFetch && !isFirstFetch) {
                (0, react_1.startTransition)(function () {
                    if (enabled) {
                        setIsFirstFetch(true);
                        debounceTime && debounceTime > 0 ? runTaskDebounce() : runTask();
                    }
                });
            }
        }
        else {
            if (immediateFirstFetch && !isFirstFetch) {
                if (enabled) {
                    setIsFirstFetch(true);
                    debounceTime && debounceTime > 0 ? runTaskDebounce() : runTask();
                }
            }
        }
    }, [enabled]);
    (0, react_1.useEffect)(function () {
        if (!isInitRef.current) {
            onInit === null || onInit === void 0 ? void 0 : onInit(debounceTime ? runTaskDebounce : runTask, cancelTask, reset);
            isInitRef.current = true;
            if (!immediateFirstFetch || isFirstFetch) {
                (0, react_1.startTransition)(function () {
                    if (enabled) {
                        debounceTime && debounceTime > 0 ? runTaskDebounce() : runTask();
                    }
                });
            }
        }
        else {
            if (!immediateFirstFetch || isFirstFetch) {
                if (enabled) {
                    debounceTime && debounceTime > 0 ? runTaskDebounce() : runTask();
                }
            }
        }
    }, __spreadArray([], (Array.isArray(deps) ? deps : [deps]), true));
    (0, react_1.useEffect)(function () {
        return function () {
            resetOnUnmount && reset();
        };
    }, [resetOnUnmount]);
    return {
        data: taskData,
        error: taskError,
        state: taskState,
        isIdle: taskState === useTask_1.EnumTaskState.IDLE,
        isLoading: taskState === useTask_1.EnumTaskState.PENDING,
        isSuccess: taskState === useTask_1.EnumTaskState.SUCCESS,
        isError: taskState === useTask_1.EnumTaskState.FAIL,
        isEnabled: enabled,
        refetch: enabled ? (debounceTime && debounceTime > 0 ? runTaskDebounce : runTask) : function () { },
        refetchAsync: enabled ? (debounceTime && debounceTime > 0 ? runTaskDebounceAsync : runTaskAsync) : function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
            return [2 /*return*/];
        }); }); },
        cancel: cancelTask,
        reset: reset,
    };
}
//# sourceMappingURL=useTaskEffect.js.map