react-use-resource/lib/index.js

Convert a promise returning function into a suspense compatible resource.

'use strict';

Object.defineProperty(exports, '__esModule', { value: true });

var React = require('react');

/*! *****************************************************************************
Copyright (c) Microsoft Corporation.

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
***************************************************************************** */

var __assign = function() {
    __assign = Object.assign || function __assign(t) {
        for (var s, i = 1, n = arguments.length; i < n; i++) {
            s = arguments[i];
            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
        }
        return t;
    };
    return __assign.apply(this, arguments);
};

var ResourcesContext = React.createContext(null);
function useResources() {
    var resources = React.useContext(ResourcesContext);
    if (resources === null) {
        throw new Error('No provider for ResourcesContext');
    }
    var getResource = function (id, service, dependencies) {
        var _a;
        if (resources[id] && resources[id].status === 'PENDING' && resources[id].cancel) {
            resources[id].isCanceled = true;
            resources[id].cancel();
        }
        var s = service.apply(void 0, dependencies);
        var promise = Array.isArray(s) ? s[0] : s;
        var cancel = Array.isArray(s) ? s[1] : null;
        resources[id] = {
            dependencies: dependencies,
            status: 'PENDING',
            result: promise
                .then(function (result) {
                resources[id] = __assign(__assign({}, resources[id]), { status: 'SUCCESS', result: result });
            })
                .catch(function (result) {
                if (resources[id].isCanceled) {
                    resources[id] = __assign(__assign({}, resources[id]), { isCanceled: false });
                }
                else {
                    resources[id] = __assign(__assign({}, resources[id]), { status: 'ERROR', result: result });
                }
            }),
            cancel: cancel,
            isCanceled: ((_a = resources[id]) === null || _a === void 0 ? void 0 : _a.isCanceled) || false
        };
    };
    return { resources: resources, getResource: getResource };
}

function ResourcesBoundary(_a) {
    var children = _a.children, _b = _a.cache, cache = _b === void 0 ? {} : _b;
    var resources = React.useState(cache)[0];
    return React.createElement(ResourcesContext.Provider, { value: resources }, children);
}

function isArrayEqual(a, b) {
    return a.length === b.length && a.every(function (val, index) { return val === b[index]; });
}

function useForceUpdate() {
    var _a = React.useState({}), setState = _a[1];
    return function () {
        setState({});
    };
}

/**
 * Convert a promise returning function into a resource.
 * @param id Resource ID.
 * @param service A promise returning function or a tuple of a promise returning function and a cancellation function.
 * @param dependencies Dependency list.
 */
function useResource(id, service, dependencies) {
    var _a = useResources(), resources = _a.resources, getResource = _a.getResource;
    var update = useForceUpdate();
    React.useEffect(function () {
        return function () {
            delete resources[id];
        };
    }, []);
    if (!(resources[id] && isArrayEqual(resources[id].dependencies, dependencies))) {
        getResource(id, service, dependencies);
    }
    return {
        read: function () {
            switch (resources[id].status) {
                case 'PENDING':
                case 'ERROR':
                    throw resources[id].result;
                case 'SUCCESS':
                    return resources[id].result;
            }
        },
        refresh: function () {
            getResource(id, service, dependencies);
            update();
        }
    };
}

/**
 * Convert a promise returning function into a lazy resource.
 * @param id Resource ID.
 * @param service A promise returning function or a tuple of a promise returning function and a cancellation function.
 * @param dependencies Dependency list.
 */
function useLazyResource(id, service, dependencies) {
    var _a = useResources(), resources = _a.resources, getResource = _a.getResource;
    var update = useForceUpdate();
    React.useEffect(function () {
        return function () {
            delete resources[id];
        };
    }, []);
    return {
        read: function () {
            if (!(resources[id] && isArrayEqual(resources[id].dependencies, dependencies))) {
                getResource(id, service, dependencies);
            }
            switch (resources[id].status) {
                case 'PENDING':
                case 'ERROR':
                    throw resources[id].result;
                case 'SUCCESS':
                    return resources[id].result;
            }
        },
        refresh: function () {
            getResource(id, service, dependencies);
            update();
        }
    };
}

exports.ResourcesBoundary = ResourcesBoundary;
exports.useLazyResource = useLazyResource;
exports.useResource = useResource;
//# sourceMappingURL=index.js.map