ra-core
Version:
Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React
268 lines • 11.6 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.useConfigureAdminRouterFromChildren = void 0;
const React = __importStar(require("react"));
const react_1 = require("react");
const useLogout_1 = __importDefault(require("../auth/useLogout.cjs"));
const usePermissions_1 = __importDefault(require("../auth/usePermissions.cjs"));
const useResourceDefinitionContext_1 = require("./useResourceDefinitionContext.cjs");
/**
* This hook inspects the CoreAdminRouter children and returns them separated in three groups:
* - Custom routes without layout
* - Custom routes with layout
* - Resources
*
* It also returns a status:
* - loading: still loading children from a function child
* - empty: no resources were provided among children
* - ready: admin is ready to be rendered
*
* @example
* const {
* customRoutesWithLayout,
* customRoutesWithoutLayout,
* resources,
* status,
* } = useConfigureAdminRouterFromChildren(children);
*/
const useConfigureAdminRouterFromChildren = (children) => {
const { permissions, isPending } = (0, usePermissions_1.default)();
// Whenever children are updated, update our custom routes and resources
const [routesAndResources, status] = useRoutesAndResourcesFromChildren(children, permissions, isPending);
// Whenever the resources change, we must ensure they're all registered
useRegisterResources(routesAndResources.resources, permissions);
return {
customRoutesWithLayout: routesAndResources.customRoutesWithLayout,
customRoutesWithoutLayout: routesAndResources.customRoutesWithoutLayout,
status,
resources: routesAndResources.resources,
};
};
exports.useConfigureAdminRouterFromChildren = useConfigureAdminRouterFromChildren;
/**
* A hook that determine the routes and resources from React nodes and permissions.
* Returns a tuple with the routes and resources as a single object, and the status.
* @param children React nodes to inspect
* @param permissions The permissions
*/
const useRoutesAndResourcesFromChildren = (children, permissions, isLoading) => {
// Gather custom routes and resources that were declared as direct children of CoreAdminRouter
// e.g. Not returned from the child function (if any)
// We need to know right away whether some resources were declared to correctly
// initialize the status at the next stop
const doLogout = (0, useLogout_1.default)();
const [routesAndResources, setRoutesAndResources, mergeRoutesAndResources] = useRoutesAndResourcesState(getRoutesAndResourceFromNodes(children));
const [status, setStatus] = (0, react_1.useState)(() => getStatus({
children,
...routesAndResources,
}));
if (!status) {
throw new Error('Status should be defined');
}
(0, react_1.useEffect)(() => {
const resolveChildFunction = async (childFunc) => {
try {
const childrenFuncResult = childFunc(permissions);
if (childrenFuncResult?.then) {
childrenFuncResult.then(resolvedChildren => {
mergeRoutesAndResources(getRoutesAndResourceFromNodes(resolvedChildren));
setStatus('ready');
});
}
else {
mergeRoutesAndResources(getRoutesAndResourceFromNodes(childrenFuncResult));
setStatus('ready');
}
}
catch (error) {
console.error(error);
doLogout();
}
};
const updateFromChildren = async () => {
const functionChild = getSingleChildFunction(children);
const newRoutesAndResources = getRoutesAndResourceFromNodes(children);
setRoutesAndResources(newRoutesAndResources);
setStatus(functionChild
? 'loading'
: newRoutesAndResources.resources.length > 0 ||
newRoutesAndResources.customRoutesWithLayout.length >
0 ||
newRoutesAndResources.customRoutesWithoutLayout.length >
0
? 'ready'
: 'empty');
if (functionChild) {
resolveChildFunction(functionChild);
}
};
if (!isLoading) {
updateFromChildren();
}
}, [
children,
doLogout,
isLoading,
mergeRoutesAndResources,
permissions,
setRoutesAndResources,
setStatus,
]);
return [routesAndResources, status];
};
/*
* A hook that store the routes and resources just like setState but also provides an additional function
* to merge new routes and resources with the existing ones.
*/
const useRoutesAndResourcesState = (initialState) => {
const [routesAndResources, setRoutesAndResources] = (0, react_1.useState)(initialState);
const mergeRoutesAndResources = (0, react_1.useCallback)((newRoutesAndResources) => {
setRoutesAndResources(previous => ({
customRoutesWithLayout: previous.customRoutesWithLayout.concat(newRoutesAndResources.customRoutesWithLayout),
customRoutesWithoutLayout: previous.customRoutesWithoutLayout.concat(newRoutesAndResources.customRoutesWithoutLayout),
resources: previous.resources.concat(newRoutesAndResources.resources),
}));
}, []);
return [routesAndResources, setRoutesAndResources, mergeRoutesAndResources];
};
/**
* A hook that register resources and unregister them when the calling component is unmounted.
* @param resources: An array of Resource elements
* @param permissions: The permissions
*/
const useRegisterResources = (resources, permissions) => {
const { register, unregister } = (0, useResourceDefinitionContext_1.useResourceDefinitionContext)();
(0, react_1.useEffect)(() => {
resources.forEach(resource => {
if (typeof resource.type.registerResource === 'function') {
const definition = resource.type.registerResource(resource.props, permissions);
register(definition);
}
else {
throw new Error('When using a custom Resource element, it must have a static registerResource method accepting its props and returning a ResourceDefinition');
}
});
return () => {
resources.forEach(resource => {
if (typeof resource.type.registerResource === 'function') {
const definition = resource.type.registerResource(resource.props, permissions);
unregister(definition);
}
else {
throw new Error('When using a custom Resource element, it must have a static registerResource method accepting its props and returning a ResourceDefinition');
}
});
};
}, [permissions, register, resources, unregister]);
};
const getStatus = ({ children, resources, customRoutesWithLayout, customRoutesWithoutLayout, }) => {
return getSingleChildFunction(children)
? 'loading'
: resources.length > 0 ||
customRoutesWithLayout.length > 0 ||
customRoutesWithoutLayout.length > 0
? 'ready'
: 'empty';
};
/**
* Inspect the children of a CoreAdminRouter to see if one of them is a function.
* Throws an error if there are more than one function child.
* Returns the function child if one was provided, or null otherwise.
*/
const getSingleChildFunction = (children) => {
const childrenArray = Array.isArray(children) ? children : [children];
const functionChildren = childrenArray.filter(child => typeof child === 'function');
if (functionChildren.length > 1) {
throw new Error('You can only provide one function child to AdminRouter');
}
if (functionChildren.length === 0) {
return null;
}
return functionChildren[0];
};
/**
* Inspect the children and return an object with the following keys:
* - customRoutesWithLayout: an array of the custom routes to render inside the layout
* - customRoutesWithoutLayout: an array of custom routes to render outside the layout
* - resources: an array of resources elements
*/
const getRoutesAndResourceFromNodes = (children) => {
const customRoutesWithLayout = [];
const customRoutesWithoutLayout = [];
const resources = [];
if (typeof children === 'function') {
return {
customRoutesWithLayout: [],
customRoutesWithoutLayout: [],
resources: [],
};
}
// @ts-ignore
react_1.Children.forEach(children, element => {
if (!React.isValidElement(element)) {
// Ignore non-elements. This allows people to more easily inline
// conditionals in their route config.
return;
}
if (element.type === react_1.Fragment) {
const customRoutesFromFragment = getRoutesAndResourceFromNodes(element.props.children);
customRoutesWithLayout.push(...customRoutesFromFragment.customRoutesWithLayout);
customRoutesWithoutLayout.push(...customRoutesFromFragment.customRoutesWithoutLayout);
resources.push(...customRoutesFromFragment.resources);
}
if (element.type.raName === 'CustomRoutes') {
const customRoutesElement = element;
if (customRoutesElement.props.noLayout) {
customRoutesWithoutLayout.push(customRoutesElement.props.children);
}
else {
customRoutesWithLayout.push(customRoutesElement.props.children);
}
}
else if (element.type.raName === 'Resource') {
resources.push(element);
}
});
return {
customRoutesWithLayout,
customRoutesWithoutLayout,
resources,
};
};
//# sourceMappingURL=useConfigureAdminRouterFromChildren.js.map