@clement_lores/adminjs 7.8.17 → 7.8.18

package/types/src/backend/bundler/generate-user-component-entry.d.ts

@@ -1,16 +0,0 @@
-import AdminJS from '../../adminjs.js';
-/**
- * Generates entry file for all UsersComponents.
- * Entry consists of 3 parts:
- * 1. Setup AdminJS.UserComponents map.
- * 2. List of all environmental variables passed to AdminJS in configuration option.
- * 3. Imports of user components defined by ComponentLoader.
- *
- * @param {AdminJS}    admin
- * @param {String}      entryPath  path to folder where entry file is located
- * @return {String}     content of an entry file
- *
- * @private
- */
-declare const generateUserComponentEntry: (admin: AdminJS, entryPath: string) => string;
-export default generateUserComponentEntry;

package/types/src/backend/bundler/globals.bundler.d.ts

@@ -1,3 +0,0 @@
-import { AssetBundler } from './utils/asset-bundler.js';
-declare const bundler: AssetBundler;
-export default bundler;

package/types/src/backend/bundler/index.d.ts

@@ -1,6 +0,0 @@
-export { default as appBundler } from './app.bundler.js';
-export { default as globalsBundler } from './globals.bundler.js';
-export { default as componentsBundler } from './components.bundler.js';
-export { default as generateUserComponentEntry } from './generate-user-component-entry.js';
-export * from './utils/constants.js';
-export { AssetBundler } from './utils/asset-bundler.js';

package/types/src/backend/bundler/utils/asset-bundler.d.ts

@@ -1,32 +0,0 @@
-import { InputOptions, OutputOptions } from 'rollup';
-export declare class AssetBundler {
-    static DEFAULT_EXTENSIONS: string[];
-    static DEFAULT_GLOBALS: {
-        react: string;
-        redux: string;
-        'react-feather': string;
-        '@clement_lores/admin-design-system/styled-components': string;
-        'prop-types': string;
-        'react-dom': string;
-        'react-redux': string;
-        'react-router': string;
-        'react-router-dom': string;
-        adminjs: string;
-        '@clement_lores/admin-design-system': string;
-    };
-    static DEFAULT_EXTERNALS: string[];
-    protected inputOptions: InputOptions;
-    protected outputOptions: OutputOptions;
-    constructor(input: InputOptions, output: OutputOptions);
-    build(): Promise<void>;
-    watch(): Promise<void>;
-    createEntry({ dir, content, }: {
-        write?: boolean;
-        dir?: string;
-        content: string;
-    }): Promise<void>;
-    getOutput(): Promise<string | null>;
-    createConfiguration(input: InputOptions, output: OutputOptions): void;
-    setInputOption<T = any>(key: string, value: T): this;
-    setOutputOption<T = any>(key: string, value: T): this;
-}

package/types/src/backend/bundler/utils/constants.d.ts

@@ -1,4 +0,0 @@
-export declare const NODE_ENV: string;
-export declare const ADMIN_JS_TMP_DIR: string;
-export declare const COMPONENTS_ENTRY_PATH: string;
-export declare const COMPONENTS_OUTPUT_PATH: string;

package/types/src/backend/controllers/api-controller.d.ts

@@ -1,131 +0,0 @@
-import { ActionContext, ActionRequest, RecordActionResponse, ActionResponse, BulkActionResponse } from '../actions/action.interface.js';
-import { SearchActionResponse } from '../actions/search/search-action.js';
-/**
- * Controller responsible for the auto-generated API: `/admin_root/api/...`, where
- * _admin_root_ is the `rootPath` given in {@link AdminJSOptions}.
- *
- * The best way to utilise it is to use {@link ApiClient} on the frontend.
- *
- * ### Available API endpoints
- *
- * <div class='table-container'>
- *
- * | Endpoint                 | Method                | Description |
- * |--------------------------|-----------------------|-------------|
- * | .../api/resources/{resourceId}/actions/{action} | {@link ApiController#resourceAction} | Perform customized resource action |
- * | .../api/resources/{resourceId}/records/{recordId}/{action} | {@link ApiController#recordAction} | Perform customized record action |
- * | .../api/resources/{resourceId}/bulk/{action}?recordIds={recordIds} | {@link ApiController#bulkAction} | Perform customized bulk action |
- * | .../api/pages/{pageName}_ | {@link ApiController#page} | Perform customized page action |
- * | .../api/dashboard_ | {@link ApiController#dashboard} | Perform customized dashboard action |
- *
- * </div>
- *
- * ### Responsibility
- *
- * In general this controllers takes handler functions you define in {@link AdminJSOptions} and:
- * - find all the [context information]{@link ActionContext} which is needed by the action
- *   and is passed to the {@link Action#handler}, {@link Action#before} and {@link Action#after}
- * - checks if action can be invoked by particular user {@link Action#isAccessible}
- * - invokes {@link Action#before} and {@link Action#after} hooks
- *
- * You probably don't want to modify it, but you can call its methods by using {@link ApiClient}
- *
- * @hideconstructor
- */
-declare class ApiController {
-    private _admin;
-    private currentAdmin;
-    /**
-     * @param {Object} options
-     * @param {AdminJSOptions} options.admin
-     * @param {CurrentAdmin} [currentAdmin]
-     */
-    constructor({ admin }: {
-        admin: any;
-    }, currentAdmin: any);
-    /**
-     * Returns context for given action
-     * @private
-     *
-     * @param   {ActionRequest}  request  request object
-     * @return  {Promise<ActionContext>} action context
-     */
-    getActionContext(request: ActionRequest): Promise<ActionContext>;
-    /**
-     * Search records by query string.
-     *
-     * Handler function responsible for a _.../api/resources/{resourceId}/search/{query}_ route
-     *
-     * @param   {ActionRequest}  request with __params.query__ set
-     * @param   {any}            response
-     *
-     * @return  {Promise<SearchActionResponse>}    found records
-     */
-    search(request: ActionRequest, response: any): Promise<SearchActionResponse>;
-    /**
-     * Performs a customized {@link Action resource action}.
-     * To call it use {@link ApiClient#resourceAction} method.
-     *
-     * Handler function responsible for a _.../api/resources/{resourceId}/actions/{action}_
-     *
-     * @param   {ActionRequest}  originalRequest
-     * @param   {any}            response object from the plugin (i.e. adminjs-expressjs)
-     *
-     * @return  {Promise<ActionResponse>}  action response
-     */
-    resourceAction(originalRequest: ActionRequest, response: any): Promise<ActionResponse>;
-    /**
-     * Performs a customized {@link Action record action}.
-     * To call it use {@link ApiClient#recordAction} method.
-     *
-     * Handler function responsible for a _.../api/resources/{resourceId}/records/{recordId}/{action}_
-     *
-     * @param   {ActionRequest}  originalRequest
-     * @param   {any}  response
-     *
-     * @return  {Promise<RecordActionResponse>}  action response
-     * @throws  ConfigurationError      When given record action doesn't return {@link RecordJSON}
-     * @throws  ConfigurationError      when action handler doesn't return Promise<{@link RecordActionResponse}>
-     */
-    recordAction(originalRequest: ActionRequest, response: any): Promise<RecordActionResponse>;
-    /**
-     * Performs a customized {@link Action bulk action}.
-     * To call it use {@link ApiClient#bulkAction} method.
-     *
-     * Handler function responsible for a _.../api/resources/{resourceId}/bulk/{action}?recordIds={recordIds}_
-     *
-     * @param   {ActionRequest}  request
-     * @param   {any}  response
-     *
-     * @return  {Promise<BulkActionResponse>}  action response
-     * @throws  NotFoundError           when recordIds are missing in query or they don't exists in
-     *                                  the database
-     * @throws  ConfigurationError      when action handler doesn't return Promise<{@link BulkActionResponse}>
-     */
-    bulkAction(originalRequest: ActionRequest, response: any): Promise<BulkActionResponse>;
-    /**
-     * Gets optional data needed by the dashboard.
-     * To call it use {@link ApiClient#getDashboard} method.
-     *
-     * Handler function responsible for a _.../api/dashboard_
-     *
-     * @param   {ActionRequest}  request
-     * @param   {any}  response
-     *
-     * @return  {Promise<any>}  action response
-     */
-    dashboard(request: any, response: any): Promise<any>;
-    /**
-     * Gets optional data needed by the page.
-     * To call it use {@link ApiClient#getPage} method.
-     *
-     * Handler function responsible for a _.../api/pages/{pageName}_
-     *
-     * @param   {ActionRequest}  request
-     * @param   {any}  response
-     *
-     * @return  {Promise<any>}  action response
-     */
-    page(request: any, response: any): Promise<any>;
-}
-export default ApiController;

package/types/src/backend/controllers/app-controller.d.ts

@@ -1,16 +0,0 @@
-import { ActionRequest } from '../actions/action.interface.js';
-export default class AppController {
-    private _admin;
-    private h;
-    private currentAdmin;
-    constructor({ admin }: {
-        admin: any;
-    }, currentAdmin: any);
-    index(): Promise<string>;
-    resourceAction({ params }: ActionRequest): Promise<string>;
-    bulkAction({ params, query }: ActionRequest): Promise<string>;
-    resource({ params }: ActionRequest): Promise<string>;
-    recordAction({ params }: ActionRequest): Promise<string>;
-    page({ params }: ActionRequest): Promise<string>;
-    bundleComponents(): Promise<string | null>;
-}

package/types/src/backend/controllers/index.d.ts

@@ -1,2 +0,0 @@
-export { default as AppController } from './app-controller.js';
-export { default as ApiController } from './api-controller.js';

package/types/src/backend/decorators/action/action-decorator.d.ts

@@ -1,130 +0,0 @@
-import { VariantType } from '@clement_lores/admin-design-system';
-import AdminJS from '../../../adminjs.js';
-import BaseResource from '../../adapters/resource/base-resource.js';
-import { Action, ActionContext, ActionRequest, ActionResponse } from '../../actions/action.interface.js';
-import { CurrentAdmin } from '../../../current-admin.interface.js';
-import { ActionJSON } from '../../../frontend/interfaces/action/action-json.interface.js';
-import BaseRecord from '../../adapters/record/base-record.js';
-import { ParsedLayoutElement } from '../../utils/layout-element-parser/index.js';
-/**
- * Decorates an action
- *
- * @category Decorators
- */
-declare class ActionDecorator {
-    name: string;
-    private _admin;
-    private _resource;
-    private h;
-    private action;
-    /**
-     * @param {Object}        params
-     * @param {Action}        params.action
-     * @param {BaseResource}  params.resource
-     * @param {AdminJS}      params.admin  current instance of AdminJS
-     */
-    constructor({ action, admin, resource }: {
-        action: Action<ActionResponse>;
-        admin: AdminJS;
-        resource: BaseResource;
-    });
-    /**
-     * Original handler wrapped with the hook `before` and `after` methods.
-     *
-     * @param {ActionRequest} request
-     * @param {any} response
-     * @param {ActionContext} context
-     *
-     * @return {Promise<any>}
-     */
-    handler(request: ActionRequest, response: any, context: ActionContext): Promise<any>;
-    /**
-     * Invokes before action hooks if there are any
-     *
-     * @param {ActionRequest} request
-     * @param {ActionContext} context
-     *
-     * @return {Promise<ActionRequest>}
-     */
-    invokeBeforeHook(request: ActionRequest, context: ActionContext): Promise<ActionRequest>;
-    /**
-     * Invokes action handler if there is any
-     *
-     * @param {ActionRequest} request
-     * @param {any} response
-     * @param {ActionContext} context
-     *
-     * @return {Promise<ActionResponse>}
-     */
-    invokeHandler(request: ActionRequest, response: any, context: ActionContext): Promise<ActionResponse>;
-    /**
-     * Invokes after action hooks if there are any
-     *
-     * @param {ActionResponse} response
-     * @param {ActionRequest} request
-     * @param {ActionContext} context
-     *
-     * @return {Promise<ActionResponse>}
-     */
-    invokeAfterHook(response: ActionResponse, request: ActionRequest, context: ActionContext): Promise<ActionResponse>;
-    /**
-     * Returns true when action can be performed on a record
-     *
-     * @return  {Boolean}
-     */
-    isRecordType(): boolean;
-    /**
-     * Returns true when action can be performed on an entire resource
-     *
-     * @return  {Boolean}
-     */
-    isResourceType(): boolean;
-    /**
-     * Returns true when action can be performed on selected records
-     *
-     * @return  {Boolean}
-     */
-    isBulkType(): boolean;
-    is(what: 'isAccessible' | 'isVisible', currentAdmin?: CurrentAdmin, record?: BaseRecord): boolean;
-    /**
-     * Is action visible in the UI
-     * @param {CurrentAdmin} [currentAdmin]   currently logged in admin user
-     * @param {BaseRecord} [record]
-     *
-     * @return  {Boolean}
-     */
-    isVisible(currentAdmin?: CurrentAdmin, record?: BaseRecord): boolean;
-    /**
-     * Is action accessible
-     *
-     * @param {CurrentAdmin} [currentAdmin]   currently logged in admin user
-     * @param {BaseRecord} [record]
-     * @return  {Boolean}
-     */
-    isAccessible(currentAdmin?: CurrentAdmin, record?: BaseRecord): boolean;
-    /**
-     * Indicates if user can invoke given action
-     *
-     * @param   {ActionContext}  context  passed action context
-     *
-     * @return  {boolean}                 true given user has rights to the action
-     * @throws  {ForbiddenError}          when user cannot perform given action
-     */
-    canInvokeAction(context: ActionContext): boolean;
-    containerWidth(): ActionJSON['containerWidth'];
-    layout(currentAdmin?: CurrentAdmin): Array<ParsedLayoutElement> | null;
-    variant(): VariantType;
-    parent(): string | null;
-    custom(): Record<string, any>;
-    hasHandler(): boolean;
-    showResourceActions(): boolean;
-    /**
-     * Serializes action to JSON format
-     *
-     * @param {CurrentAdmin} [currentAdmin]
-     *
-     * @return  {ActionJSON}  serialized action
-     */
-    toJSON(currentAdmin?: CurrentAdmin): ActionJSON;
-}
-export default ActionDecorator;

package/types/src/backend/decorators/action/action-decorator.spec.d.ts

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

package/types/src/backend/decorators/action/index.d.ts

@@ -1 +0,0 @@
-export { default as ActionDecorator } from './action-decorator.js';

package/types/src/backend/decorators/index.d.ts

@@ -1,3 +0,0 @@
-export * from './action/index.js';
-export * from './property/index.js';
-export * from './resource/index.js';

package/types/src/backend/decorators/property/index.d.ts

@@ -1,3 +0,0 @@
-export { PropertyDecorator } from './property-decorator.js';
-export type { default as PropertyOptions } from './property-options.interface.js';
-export * from './property-options.interface.js';

package/types/src/backend/decorators/property/property-decorator.d.ts

@@ -1,164 +0,0 @@
-import AdminJS from '../../../adminjs.js';
-import { BasePropertyJSON, PropertyPlace } from '../../../frontend/interfaces/index.js';
-import BaseProperty, { PropertyType } from '../../adapters/property/base-property.js';
-import BaseResource from '../../adapters/resource/base-resource.js';
-import ResourceDecorator from '../resource/resource-decorator.js';
-import PropertyOptions from './property-options.interface.js';
-/**
- * Decorates property
- *
- * @category Decorators
- */
-export declare class PropertyDecorator {
-    property: BaseProperty;
-    /**
-     * Property path including all parents.
-     * For root property (this without a parent) it will be its name.
-     * But when property has children their paths will include parent path:
-     * `parentName.subPropertyName`.
-     *
-     * This path serves as a key in {@link PropertyOptions} to identify which
-     * property has to be updated
-     */
-    propertyPath: string;
-    /**
-     * Indicates if given property has been created in AdminJS and hasn't been returned by the
-     * database adapter
-     */
-    isVirtual: boolean;
-    private _admin;
-    private _resource;
-    options: PropertyOptions;
-    /**
-     * Array of all subProperties which were added in {@link ResourceOption} interface rather than
-     * in the database
-     *
-     * @private
-     */
-    private virtualSubProperties;
-    /**
-     * @param {Object} opts
-     * @param {BaseProperty}        opts.property
-     * @param  {AdminJS}           opts.admin  current instance of AdminJS
-     * @param {PropertyOptions}     opts.options
-     * @param {ResourceDecorator}   opts.resource
-     */
-    constructor({ property, admin, options, resource, path, isVirtual }: {
-        property: BaseProperty;
-        admin: AdminJS;
-        options?: PropertyOptions;
-        resource: ResourceDecorator;
-        path?: string;
-        isVirtual?: boolean;
-    });
-    /**
-     * True if given property can be sortable
-     *
-     * @returns {boolean}
-     */
-    isSortable(): boolean;
-    /**
-     * When given property is a reference to another Resource - it returns this Resource
-     *
-     * @return  {BaseResource} reference resource
-     */
-    reference(): BaseResource | null;
-    referenceName(): string | null;
-    /**
-     * Name of the property
-     *
-     * @returns {string}
-     */
-    name(): string;
-    /**
-     * Resource decorator of given property
-     */
-    resource(): ResourceDecorator;
-    /**
-     * Label of a property
-     *
-     * @return  {string}
-     */
-    label(): string;
-    /**
-     * Property type
-     *
-     * @returns {PropertyType}
-     */
-    type(): PropertyType;
-    /**
-     * If given property has limited number of available values
-     * it returns them.
-     *
-     * @returns {Array<{value: string, label: string}>}
-     */
-    availableValues(): null | Array<{
-        value: string | number;
-        label?: string;
-    }>;
-    isArray(): boolean;
-    isDraggable(): boolean;
-    /**
-     * Indicates if given property should be visible
-     *
-     * @param {'list' | 'edit' | 'show' | 'filter'} where
-     */
-    isVisible(where: PropertyPlace): boolean;
-    /**
-     * Position of the field
-     *
-     * @return {number}
-     */
-    position(): number;
-    /**
-     * If property should be treated as an ID field
-     *
-     * @return {boolean}
-     */
-    isId(): boolean;
-    /**
-     * If property should be marked as a required with a star (*)
-     *
-     * @return {boolean}
-     */
-    isRequired(): boolean;
-    /**
-     * If property should be treated as an title field
-     * Title field is used as a link to the resource page
-     * in the list view and in the breadcrumbs
-     *
-     * @return {boolean}
-     */
-    isTitle(): boolean;
-    /**
-     * If property should be disabled in the UI
-     *
-     * @return  {boolean}
-     */
-    isDisabled(): boolean;
-    /**
-     * Returns JSON representation of a property
-     *
-     * @param {PropertyPlace} [where]
-     *
-     * @return {PropertyJSON}
-     */
-    toJSON(where?: PropertyPlace): BasePropertyJSON;
-    /**
-     * Decorates subProperties
-     *
-     * @return  {Array<PropertyDecorator>}  decorated subProperties
-     */
-    subProperties(): Array<PropertyDecorator>;
-    addSubProperty(subProperty: PropertyDecorator): void;
-    /**
-     * Returns PropertyOptions passed by the user for a subProperty. Furthermore
-     * it changes property name to the nested property key.
-     *
-     * @param   {String}     propertyPath
-     * @return  {PropertyOptions}
-     * @private
-     */
-    private getOptionsForSubProperty;
-}
-export default PropertyDecorator;

package/types/src/backend/decorators/property/property-decorator.spec.d.ts

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

package/types/src/backend/decorators/property/property-options.interface.d.ts

@@ -1,137 +0,0 @@
-import { PropertyType } from '../../adapters/property/base-property.js';
-/**
- * Options passed to a given property
- */
-export default interface PropertyOptions {
-    /**
-     * if given property should be visible. It can be either boolean for all possible views, or
-     * you can verify which view in particular should be hidden/shown.
-     */
-    isVisible?: boolean | {
-        show?: boolean;
-        list?: boolean;
-        edit?: boolean;
-        filter?: boolean;
-    };
-    /**
-     * List of possible overridden components for given property.
-     */
-    components?: {
-        show?: string;
-        list?: string;
-        edit?: string;
-        filter?: string;
-    };
-    /**
-     * Property type
-     */
-    type?: PropertyType;
-    /**
-     * Indicates if property should be treated as an ID
-     */
-    isId?: boolean;
-    /**
-     * One of given property should be treated as an "title property". Title property is "clickable"
-     * when user sees the record in a list or show views.
-     *
-     * @deprecated Use ResourceOptions#titleProperty
-     */
-    isTitle?: boolean;
-    /**
-     * Indicates if given property should be treated as array of elements.
-     * @new In version 3.3
-     */
-    isArray?: boolean;
-    /**
-     * Indicates if array elements should be draggable when editing.
-     * It is only usable if the property is an array.
-     * @new In version 3.5
-     */
-    isDraggable?: boolean;
-    /**
-     * position of the field in a list,
-     * title field (isTitle) gets position -1 by default other
-     * fields gets position = 100.
-     */
-    position?: number;
-    /**
-     * If options should be limited to finite set. After setting this
-     * in the UI you will see select box instead of the input
-     */
-    availableValues?: Array<{
-        value: string | number;
-        label?: string;
-    }>;
-    /**
-     * Custom properties passed to the frontend in {@link PropertyJSON}
-     */
-    custom?: {
-        [key: string]: any;
-    };
-    /**
-     * Additional props passed to the actual React component rendering given property in Edit
-     * component.
-     *
-     * @new in version 3.3
-     */
-    props?: {
-        [key: string]: any;
-    };
-    /**
-     * Whether given property should be editable or not.
-     */
-    isDisabled?: boolean;
-    /**
-     * Whether given property should be sortable on list or not.
-     */
-    isSortable?: boolean;
-    /**
-     * Whether given property should be marked as required.
-     */
-    isRequired?: boolean;
-    /**
-     * Whether label should be hidden - false by default
-     */
-    hideLabel?: boolean;
-    /**
-     * Name of the resource to which this property should be a reference.
-     * If set - {@link PropertyOptions.type} always returns `reference`
-     * @new In version 3.3
-     */
-    reference?: string;
-    /**
-     * Description of field. Shown as hoverable hint after label.
-     *
-     * To use translations provide it in locale with specified options key from resource
-     * @example
-     * ```js
-     * new AdminJS({
-     *   resources: [
-     *     {
-     *       resource: myResource,
-     *       options: {
-     *         properties: {
-     *           myAwesomeProperty: {
-     *             description: "Plane description" || "awesomeHint", // <- message key in locale
-     *           },
-     *         },
-     *       },
-     *     },
-     *   ],
-     *   locale: {
-     *     translations: {
-     *       resources: {
-     *         myResource: {
-     *           messages: {
-     *             awesomeHint: "Locale description",
-     *           },
-     *         },
-     *       },
-     *     },
-     *   },
-     * });
-     * ```
-     * @new In version 5.6
-     */
-    description?: string;
-}

package/types/src/backend/decorators/property/utils/index.d.ts

@@ -1 +0,0 @@
-export * from './override-from-options.js';

package/types/src/backend/decorators/property/utils/override-from-options.d.ts

@@ -1,4 +0,0 @@
-import { BaseProperty } from '../../../adapters/property/index.js';
-import PropertyOptions from '../property-options.interface.js';
-export type OverridableFromOptionsType = keyof Pick<BaseProperty, 'isSortable' | 'type' | 'isId' | 'isRequired' | 'isTitle'>;
-export declare function overrideFromOptions<T extends OverridableFromOptionsType>(optionName: T, property: BaseProperty, options: PropertyOptions): ReturnType<BaseProperty[OverridableFromOptionsType]> | null | undefined;

package/types/src/backend/decorators/property/utils/override-from-options.spec.d.ts

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