@clement_lores/adminjs 7.8.17 → 7.8.18

package/types/src/backend/utils/view-helpers/view-helpers.d.ts

@@ -1,184 +0,0 @@
-import { AdminJSOptions, Assets } from '../../../adminjs-options.interface.js';
-import type { PathsInState } from '../../../index.js';
-type Paths = PathsInState;
-/**
- * Base Params for a any function
- * @alias ActionParams
- * @memberof ViewHelpers
- */
-export type ActionParams = {
-    /**
-     * Unique Resource ID
-     */
-    resourceId: string;
-    /**
-     * Action name
-     */
-    actionName: string;
-    /**
-     * Optional query string: ?....
-     */
-    search?: string;
-};
-/**
- * Params for a record action
- * @alias RecordActionParams
- * @extends ActionParams
- * @memberof ViewHelpers
- */
-export type RecordActionParams = ActionParams & {
-    /**
-     * Record ID
-     */
-    recordId: string;
-};
-/**
- * Params for a bulk action
- * @alias BulkActionParams
- * @extends ActionParams
- * @memberof ViewHelpers
- */
-export type BulkActionParams = ActionParams & {
-    /**
-     * Array of Records ID
-     */
-    recordIds?: Array<string>;
-};
-/**
- * Params for a resource action
- * @alias ResourceActionParams
- * @extends ActionParams
- * @memberof ViewHelpers
- */
-export type ResourceActionParams = ActionParams;
-/**
- * Collection of helper methods available in the views
- */
-export declare class ViewHelpers {
-    options: Paths;
-    constructor({ options }?: {
-        options?: AdminJSOptions;
-    });
-    static getPaths(options?: AdminJSOptions): Paths;
-    /**
-     * To each related path adds rootPath passed by the user, as well as a query string
-     * @private
-     * @param  {Array<string>} [paths]      list of parts of the url
-     * @return {string}       path
-     * @return {query}        [search=''] query string which can be fetch
-     *                                    from `location.search`
-     */
-    urlBuilder(paths?: Array<string>, search?: string): string;
-    /**
-     * Returns login URL
-     * @return {string}
-     */
-    loginUrl(): string;
-    /**
-     * Returns logout URL
-     * @return {string}
-     */
-    logoutUrl(): string;
-    /**
-     * Returns URL for the dashboard
-     * @return {string}
-     */
-    dashboardUrl(): string;
-    /**
-     * Returns URL for given page name
-     * @param {string} pageName       page name which is a unique key specified in
-     *                                {@link AdminJSOptions}
-     * @return {string}
-     */
-    pageUrl(pageName: string): string;
-    /**
-     * Returns url for a `edit` action in given Resource. Uses {@link recordActionUrl}
-     *
-     * @param {string} resourceId  id to the resource
-     * @param {string} recordId    id to the record
-     * @param {string} [search]        optional query string
-     */
-    editUrl(resourceId: string, recordId: string, search?: string): string;
-    /**
-     * Returns url for a `show` action in given Resource. Uses {@link recordActionUrl}
-     *
-     * @param {string} resourceId  id to the resource
-     * @param {string} recordId    id to the record
-     * @param {string} [search]        optional query string
-     */
-    showUrl(resourceId: string, recordId: string, search?: string): string;
-    /**
-     * Returns url for a `delete` action in given Resource. Uses {@link recordActionUrl}
-     *
-     * @param {string} resourceId  id to the resource
-     * @param {string} recordId    id to the record
-     * @param {string} [search]        optional query string
-     */
-    deleteUrl(resourceId: string, recordId: string, search?: string): string;
-    /**
-     * Returns url for a `new` action in given Resource. Uses {@link resourceActionUrl}
-     *
-     * @param {string} resourceId  id to the resource
-     * @param {string} [search]        optional query string
-     */
-    newUrl(resourceId: string, search?: string): string;
-    /**
-     * Returns url for a `list` action in given Resource. Uses {@link resourceActionUrl}
-     *
-     * @param {string} resourceId  id to the resource
-     * @param {string} [search]        optional query string
-     */
-    listUrl(resourceId: string, search?: string): string;
-    /**
-     * Returns url for a `bulkDelete` action in given Resource. Uses {@link bulkActionUrl}
-     *
-     * @param {string} resourceId  id to the resource
-     * @param {Array<string>} recordIds   separated by comma records
-     * @param {string} [search]        optional query string
-     */
-    bulkDeleteUrl(resourceId: string, recordIds: Array<string>, search?: string): string;
-    /**
-     * Returns resourceAction url
-     *
-     * @param   {ResourceActionParams}  options
-     * @param   {string}  options.resourceId
-     * @param   {string}  options.actionName
-     * @param   {string}  [options.search]        optional query string
-     *
-     * @return  {string}
-     */
-    resourceActionUrl({ resourceId, actionName, search }: ResourceActionParams): string;
-    resourceUrl({ resourceId, search }: Omit<ResourceActionParams, 'actionName'>): string;
-    /**
-     * Returns recordAction url
-     *
-     * @param   {RecordActionParams}  options
-     * @param   {string}  options.resourceId
-     * @param   {string}  options.recordId
-     * @param   {string}  options.actionName
-     *
-     * @return  {string}
-     */
-    recordActionUrl({ resourceId, recordId, actionName, search }: RecordActionParams): string;
-    /**
-     * Returns bulkAction url
-     *
-     * @param   {BulkActionParams}  options
-     * @param   {string}  options.resourceId
-     * @param   {Array<string>}  [options.recordIds]
-     * @param   {string}  options.actionName
-     *
-     * @return  {string}
-     */
-    bulkActionUrl({ resourceId, recordIds, actionName, search }: BulkActionParams): string;
-    /**
-     * Returns absolute path to a given asset.
-     * @private
-     *
-     * @param  {string} asset
-     * @param  {Assets | undefined} assetsConfig
-     * @return {string}
-     */
-    assetPath(asset: string, assetsConfig?: Assets): string;
-}
-export default ViewHelpers;

package/types/src/backend/utils/view-helpers/view-helpers.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/types/src/constants.d.ts

@@ -1,7 +0,0 @@
-export declare const DOCS = "https://docs.adminjs.co";
-export declare const DEFAULT_PATHS: {
-    rootPath: string;
-    logoutPath: string;
-    loginPath: string;
-    refreshTokenPath: string;
-};

package/types/src/core-scripts.interface.d.ts

@@ -1,41 +0,0 @@
-/**
- * @memberof Assets
- * @alias CoreScripts
- *
- * Optional mapping of core AdminJS browser scripts:
- * - app.bundle.js
- * - components.bundle.js
- * - design-system.bundle.js
- * - global.bundle.js
- *
- * You may want to use it if you'd like to version assets for caching. This
- * will only work if you have also configured `assetsCDN` in AdminJS options.
- *
- * Example:
- * ```
- * {
- *   'app.bundle.js': 'app.bundle.123456.js',
- *   'components.bundle.js': 'components.bundle.123456.js',
- *   'design-system.bundle.js': 'design-system.bundle.123456.js',
- *   'global.bundle.js': 'global.bundle.123456.js',
- * }
- * ```
- */
-export interface CoreScripts {
-    /**
-     * App Bundle
-     */
-    'app.bundle.js': string;
-    /**
-     * Custom Components
-     */
-    'components.bundle.js': string;
-    /**
-     * Design System Bundle
-     */
-    'design-system.bundle.js': string;
-    /**
-     * Global bundle
-     */
-    'global.bundle.js': string;
-}

package/types/src/current-admin.interface.d.ts

@@ -1,42 +0,0 @@
-/**
- * Currently logged in admin.
- *
- * ### Usage with TypeScript
- *
- * ```typescript
- * import { CurrentAdmin } from 'adminjs'
- * ```
- *
- * @alias CurrentAdmin
- * @memberof AdminJS
- */
-export interface CurrentAdmin {
-    /**
-     * Admin has one required field which is an email
-     */
-    email: string;
-    /**
-     * Optional title/role of an admin - this will be presented below the email
-     */
-    title?: string;
-    /**
-     * Optional url for an avatar photo
-     */
-    avatarUrl?: string;
-    /**
-     * Id of your admin user
-     */
-    id?: string;
-    /**
-     * Optional ID of theme to use
-     */
-    theme?: string;
-    /**
-     * Extra metadata specific to given Auth Provider
-     */
-    _auth?: Record<string, any>;
-    /**
-     * Also you can put as many other fields to it as you like.
-     */
-    [key: string]: any;
-}

package/types/src/frontend/components/actions/action.props.d.ts

@@ -1,29 +0,0 @@
-import { Dispatch, SetStateAction } from 'react';
-import { ActionJSON, RecordJSON, ResourceJSON } from '../../interfaces/index.js';
-/**
- * Props which are passed to all action components
- * @alias ActionProps
- * @memberof BaseActionComponent
- */
-export type ActionProps = {
-    /**
-     * Action object describing the action
-     */
-    action: ActionJSON;
-    /**
-     * Object of type: {@link ResourceJSON}
-     */
-    resource: ResourceJSON;
-    /**
-     * Selected record. Passed for actions with "record" actionType
-     */
-    record?: RecordJSON;
-    /**
-     * Selected records. Passed for actions with "bulk" actionType
-     */
-    records?: Array<RecordJSON>;
-    /**
-     * Sets tag in a header of an action. It is a function taking tag as an argument
-     */
-    setTag?: Dispatch<SetStateAction<string>>;
-};

package/types/src/frontend/components/actions/bulk-delete.d.ts

@@ -1,15 +0,0 @@
-import React from 'react';
-declare const FormattedBulkDelete: import("react-redux").ConnectedComponent<any, {
-    context?: React.Context<import("react-redux").ReactReduxContextValue<any, import("redux").AnyAction>> | undefined;
-    store?: import("redux").Store<any, import("redux").AnyAction> | undefined;
-}>;
-declare const OverridableFormattedBulkDelete: React.ComponentType<{
-    context?: React.Context<import("react-redux").ReactReduxContextValue<any, import("redux").AnyAction>> | undefined;
-    store?: import("redux").Store<any, import("redux").AnyAction> | undefined;
-} & {
-    OriginalComponent?: React.ComponentType<{
-        context?: React.Context<import("react-redux").ReactReduxContextValue<any, import("redux").AnyAction>> | undefined;
-        store?: import("redux").Store<any, import("redux").AnyAction> | undefined;
-    }> | undefined;
-}>;
-export { OverridableFormattedBulkDelete as default, OverridableFormattedBulkDelete as BulkDelete, FormattedBulkDelete as OriginalBulkDelete, };

package/types/src/frontend/components/actions/edit.d.ts

@@ -1,7 +0,0 @@
-import React, { FC } from 'react';
-import { ActionProps } from './action.props.js';
-declare const Edit: FC<ActionProps>;
-declare const OverridableEdit: React.ComponentType<ActionProps & {
-    OriginalComponent?: React.ComponentType<ActionProps> | undefined;
-}>;
-export { OverridableEdit as default, OverridableEdit as Edit, Edit as OriginalEdit, };

package/types/src/frontend/components/actions/index.d.ts

@@ -1,31 +0,0 @@
-/// <reference types="react" resolution-mode="require"/>
-export * from './new.js';
-export * from './action.props.js';
-export * from './edit.js';
-export * from './show.js';
-export * from './list.js';
-export * from './bulk-delete.js';
-export * from './utils/index.js';
-export declare const actions: {
-    new: import("react").ComponentType<import("./action.props.js").ActionProps & {
-        OriginalComponent?: import("react").ComponentType<import("./action.props.js").ActionProps> | undefined;
-    }>;
-    edit: import("react").ComponentType<import("./action.props.js").ActionProps & {
-        OriginalComponent?: import("react").ComponentType<import("./action.props.js").ActionProps> | undefined;
-    }>;
-    show: import("react").ComponentType<import("./action.props.js").ActionProps & {
-        OriginalComponent?: import("react").ComponentType<import("./action.props.js").ActionProps> | undefined;
-    }>;
-    list: import("react").ComponentType<import("./action.props.js").ActionProps & {
-        OriginalComponent?: import("react").ComponentType<import("./action.props.js").ActionProps> | undefined;
-    }>;
-    bulkDelete: import("react").ComponentType<{
-        context?: import("react").Context<import("react-redux").ReactReduxContextValue<any, import("redux").AnyAction>> | undefined;
-        store?: import("redux").Store<any, import("redux").AnyAction> | undefined;
-    } & {
-        OriginalComponent?: import("react").ComponentType<{
-            context?: import("react").Context<import("react-redux").ReactReduxContextValue<any, import("redux").AnyAction>> | undefined;
-            store?: import("redux").Store<any, import("redux").AnyAction> | undefined;
-        }> | undefined;
-    }>;
-};

package/types/src/frontend/components/actions/list.d.ts

@@ -1,7 +0,0 @@
-import React from 'react';
-import { ActionProps } from './action.props.js';
-declare const List: React.FC<ActionProps>;
-declare const OverridableList: React.ComponentType<ActionProps & {
-    OriginalComponent?: React.ComponentType<ActionProps> | undefined;
-}>;
-export { OverridableList as default, OverridableList as List, List as OriginalList, };

package/types/src/frontend/components/actions/new.d.ts

@@ -1,7 +0,0 @@
-import React, { FC } from 'react';
-import { ActionProps } from './action.props.js';
-declare const New: FC<ActionProps>;
-declare const OverridableNew: React.ComponentType<ActionProps & {
-    OriginalComponent?: React.ComponentType<ActionProps> | undefined;
-}>;
-export { OverridableNew as default, OverridableNew as New, New as OriginalNew, };

package/types/src/frontend/components/actions/show.d.ts

@@ -1,14 +0,0 @@
-import React from 'react';
-import { ActionProps } from './action.props.js';
-/**
- * @name ShowAction
- * @category Actions
- * @description Shows a given record.
- * @component
- * @private
- */
-declare const Show: React.FC<ActionProps>;
-declare const OverridableShow: React.ComponentType<ActionProps & {
-    OriginalComponent?: React.ComponentType<ActionProps> | undefined;
-}>;
-export { OverridableShow as default, OverridableShow as Show, Show as OriginalShow, };

package/types/src/frontend/components/actions/utils/append-force-refresh.d.ts

@@ -1,13 +0,0 @@
-export declare const REFRESH_KEY = "refresh";
-export declare const IGNORE_PARAMS_KEY = "ignore_params";
-/**
- * Adds refresh=true to the url, which in turn should cause list to reload.
- *
- * @param {string} url      url to which function should add `refresh`
- * @param {string} [search] optional search query which should be updated,
- *                          if not given function will use window.location.search
- * @private
- */
-export declare const appendForceRefresh: (url: string, search?: string) => string;
-export declare const hasForceRefresh: (search: string) => boolean;
-export declare const removeForceRefresh: (search: string) => string;

package/types/src/frontend/components/actions/utils/append-force-refresh.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/types/src/frontend/components/actions/utils/index.d.ts

@@ -1 +0,0 @@
-export * from './layout-element-renderer.js';

package/types/src/frontend/components/actions/utils/layout-element-renderer.d.ts

@@ -1,12 +0,0 @@
-import React from 'react';
-import { ActionProps } from '../action.props.js';
-import { PropertyPlace } from '../../../interfaces/property-json/property-json.interface.js';
-import { ParsedLayoutElement } from '../../../../backend/utils/layout-element-parser/index.js';
-import { BasePropertyProps } from '../../property-type/base-property-props.js';
-type Props = ActionProps & {
-    layoutElement: ParsedLayoutElement;
-    where: PropertyPlace;
-    onChange?: BasePropertyProps['onChange'];
-};
-export declare const LayoutElementRenderer: React.FC<Props>;
-export default LayoutElementRenderer;

package/types/src/frontend/components/app/action-button/action-button.d.ts

@@ -1,40 +0,0 @@
-import React from 'react';
-import { ActionResponse } from '../../../../backend/actions/action.interface.js';
-import { ActionJSON } from '../../../interfaces/index.js';
-/**
- * @alias ActionButtonProps
- * @memberof ActionButton
- */
-export type ActionButtonProps = {
-    /** Action to which button should redirect */
-    action: ActionJSON;
-    /** Id of a resource of an action */
-    resourceId: string;
-    /** Optional recordId for _record_ action */
-    recordId?: string;
-    /** Optional recordIds for _bulk_ action */
-    recordIds?: Array<string>;
-    /** optional callback function which will be triggered when action is performed */
-    actionPerformed?: (action: ActionResponse) => any;
-    children?: React.ReactNode;
-    search?: string;
-    queryParams?: Record<string, unknown>;
-};
-/**
- * Renders Button which redirects to given action
- *
- * ### Usage
- *
- * ```
- * import { ActionButton } from 'adminjs'
- * ```
- *
- * @component
- * @subcategory Application
- */
-declare const ActionButton: React.FC<ActionButtonProps>;
-declare const OverridableActionButton: React.ComponentType<ActionButtonProps & {
-    /** Optional recordId for _record_ action */
-    OriginalComponent?: React.ComponentType<ActionButtonProps> | undefined;
-}>;
-export { OverridableActionButton as default, OverridableActionButton as ActionButton, ActionButton as OriginalActionButton, };

package/types/src/frontend/components/app/action-button/index.d.ts

@@ -1 +0,0 @@
-export * from './action-button.js';

package/types/src/frontend/components/app/action-header/action-header-props.d.ts

@@ -1,24 +0,0 @@
-import { ActionJSON, RecordJSON, ResourceJSON } from '../../../interfaces/index.js';
-import { ActionResponse } from '../../../../backend/actions/action.interface.js';
-/**
- * @memberof ActionHeader
- * @alias ActionHeaderProps
- */
-export type ActionHeaderProps = {
-    /** Resource for the action */
-    resource: ResourceJSON;
-    /** Optional record - for _record_ actions */
-    record?: RecordJSON;
-    /** If given, action header will render Filter button */
-    toggleFilter?: (() => any) | boolean;
-    /**
-     * It indicates if action without a component was performed.
-     */
-    actionPerformed?: (action: ActionResponse) => any;
-    /** An action objet */
-    action: ActionJSON;
-    /** Optional tag which will be rendered as a {@link Badge} */
-    tag?: string;
-    /** If set, component wont render actions */
-    omitActions?: boolean;
-};

package/types/src/frontend/components/app/action-header/action-header.d.ts

@@ -1,19 +0,0 @@
-import React from 'react';
-import { ActionHeaderProps } from './action-header-props.js';
-/**
- * Header of an action. It renders Action name with buttons for all the actions.
- *
- * ### Usage
- *
- * ```
- * import { ActionHeader } from 'adminjs'
- * ```
- *
- * @component
- * @subcategory Application
- */
-declare const ActionHeader: React.FC<ActionHeaderProps>;
-declare const OverridableActionHeader: React.ComponentType<ActionHeaderProps & {
-    OriginalComponent?: React.ComponentType<ActionHeaderProps> | undefined;
-}>;
-export { OverridableActionHeader as default, OverridableActionHeader as ActionHeader, ActionHeader as OriginalActionHeader, };

package/types/src/frontend/components/app/action-header/actions-to-button-group.d.ts

@@ -1,12 +0,0 @@
-import { ButtonGroupProps, ButtonInGroupProps } from '@clement_lores/admin-design-system';
-import { ActionJSON, ModalFunctions } from '../../../interfaces/index.js';
-import { DifferentActionParams } from '../../../hooks/index.js';
-import { TranslateFunctions } from '../../../../utils/index.js';
-export type actionsToButtonGroupOptions = {
-    actions: Array<ActionJSON>;
-    params: DifferentActionParams;
-    handleClick: ButtonInGroupProps['onClick'];
-    translateFunctions: TranslateFunctions;
-    modalFunctions: ModalFunctions;
-};
-export declare const actionsToButtonGroup: (options: actionsToButtonGroupOptions) => ButtonGroupProps['buttons'];

package/types/src/frontend/components/app/action-header/actions-to-button-group.spec.d.ts

@@ -1 +0,0 @@
-import '../../spec/action-json.factory.js';

package/types/src/frontend/components/app/action-header/index.d.ts

@@ -1,2 +0,0 @@
-export * from './action-header.js';
-export * from './action-header-props.js';

package/types/src/frontend/components/app/action-header/styled-back-button.d.ts

@@ -1,9 +0,0 @@
-import React from 'react';
-export type StyledBackButtonProps = {
-    showInDrawer: boolean;
-};
-declare const StyledBackButton: React.FC<StyledBackButtonProps>;
-declare const OverridableStyledBackButton: React.ComponentType<StyledBackButtonProps & {
-    OriginalComponent?: React.ComponentType<StyledBackButtonProps> | undefined;
-}>;
-export { OverridableStyledBackButton as default, OverridableStyledBackButton as StyledBackButton, StyledBackButton as OriginalStyledBackButton, };

package/types/src/frontend/components/app/admin-modal.d.ts

@@ -1,3 +0,0 @@
-import { FC } from 'react';
-export declare const AdminModal: FC;
-export default AdminModal;

package/types/src/frontend/components/app/app-loader.d.ts

@@ -1,2 +0,0 @@
-import { FC } from 'react';
-export declare const AppLoader: FC;

package/types/src/frontend/components/app/auth-background-component.d.ts

@@ -1,6 +0,0 @@
-import React from 'react';
-declare const AuthenticationBackgroundComponent: React.FC;
-declare const OverridableAuthenticationBackgroundComponent: React.ComponentType<{
-    OriginalComponent?: React.ComponentType<{}> | undefined;
-}>;
-export { OverridableAuthenticationBackgroundComponent as default, OverridableAuthenticationBackgroundComponent as AuthenticationBackgroundComponent, AuthenticationBackgroundComponent as OriginalAuthenticationBackgroundComponent, };

package/types/src/frontend/components/app/base-action-component.d.ts

@@ -1,52 +0,0 @@
-import React from 'react';
-import { ActionProps } from '../actions/action.props.js';
-/**
- * Component which renders all the default and custom actions for both the Resource and the Record.
- *
- * It passes all props down to the actual Action component.
- *
- * Example of creating your own actions:
- * ```
- * // AdminJS options
- * const AdminJSOptions = {
- *   resources: [
- *      resource,
- *      options: {
- *        actions: {
- *           myNewAction: {
- *             label: 'amazing action',
- *             icon: 'Add',
- *             inVisible: (resource, record) => record.param('email') !== '',
- *             actionType: 'record',
- *             component: 'MyNewAction',
- *             handler: (request, response, data) => {
- *               return {
- *                  ...
- *               }
- *             }
- *           }
- *        }
- *      }
- *   ]
- * }
- * ```
- *
- * ```
- * // ./my-new-action.js
- * import { Box } from 'adminjs'
- *
- * const MyNewAction = (props) => {
- *   const { resource, action, record } = props
- *   // do something with the props and render action
- *   return (
- *     <Box>Some Action Content</Box>
- *   )
- * }
- * ```
- *
- * @component
- * @name BaseActionComponent
- * @subcategory Application
- */
-export declare const BaseActionComponent: React.FC<ActionProps>;
-export default BaseActionComponent;

package/types/src/frontend/components/app/breadcrumbs.d.ts

@@ -1,30 +0,0 @@
-import React from 'react';
-import { RecordJSON, ResourceJSON } from '../../interfaces/index.js';
-export declare const BreadcrumbLink: any;
-export declare const BreadcrumbText: any;
-/**
- * @memberof Breadcrumbs
- */
-export type BreadcrumbProps = {
-    /**
-     * Resource
-     */
-    resource: ResourceJSON;
-    /**
-     * record
-     */
-    record?: RecordJSON | null;
-    /**
-     * Name of an action
-     */
-    actionName: string;
-};
-/**
- * @component
- * @private
- */
-declare const Breadcrumbs: React.FC<BreadcrumbProps>;
-declare const OverridableBreadcrumbs: React.ComponentType<BreadcrumbProps & {
-    OriginalComponent?: React.ComponentType<BreadcrumbProps> | undefined;
-}>;
-export { OverridableBreadcrumbs as default, OverridableBreadcrumbs as Breadcrumbs, Breadcrumbs as OriginalBreadcrumbs, };

package/types/src/frontend/components/app/default-dashboard.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-export declare const DashboardHeader: React.FC;
-export declare const Dashboard: React.FC;
-export default Dashboard;