@clement_lores/adminjs 7.8.17 → 7.8.18

package/types/src/backend/actions/list/list-action.d.ts

@@ -1,33 +0,0 @@
-import { Action, ActionResponse } from '../action.interface.js';
-import { RecordJSON } from '../../../frontend/interfaces/index.js';
-/**
- * @implements Action
- * @category Actions
- * @module ListAction
- * @description
- * Returns selected Records in a list form
- * @private
- */
-export declare const ListAction: Action<ListActionResponse>;
-export default ListAction;
-/**
- * Response returned by List action
- * @memberof module:ListAction
- * @alias ListAction
- */
-export type ListActionResponse = ActionResponse & {
-    /**
-     * Paginated collection of records
-     */
-    records: Array<RecordJSON>;
-    /**
-     * Pagination metadata
-     */
-    meta: {
-        page: number;
-        perPage: number;
-        direction: 'asc' | 'desc';
-        sortBy: string;
-        total: number;
-    };
-};

package/types/src/backend/actions/new/new-action.d.ts

@@ -1,12 +0,0 @@
-import { Action, RecordActionResponse } from '../action.interface.js';
-/**
- * @implements Action
- * @category Actions
- * @module NewAction
- * @description
- * Shows form for creating a new record
- * Uses {@link NewAction} component to render form
- * @private
- */
-export declare const NewAction: Action<RecordActionResponse>;
-export default NewAction;

package/types/src/backend/actions/search/search-action.d.ts

@@ -1,25 +0,0 @@
-import { Action, ActionResponse } from '../action.interface.js';
-import { RecordJSON } from '../../../frontend/interfaces/index.js';
-/**
- * @implements Action
- * @category Actions
- * @module SearchAction
- * @description
- * Used to search particular record based on "title" property. It is used by
- * select fields with autocomplete.
- * Uses {@link ShowAction} component to render form
- * @private
- */
-export declare const SearchAction: Action<SearchActionResponse>;
-export default SearchAction;
-/**
- * Response of a [Search]{@link ApiController#search} action in the API
- * @memberof module:SearchAction
- * @alias SearchResponse
- */
-export type SearchActionResponse = ActionResponse & {
-    /**
-     * List of records
-     */
-    records: Array<RecordJSON>;
-};

package/types/src/backend/actions/show/show-action.d.ts

@@ -1,12 +0,0 @@
-import { Action, RecordActionResponse } from '../action.interface.js';
-/**
- * @implements Action
- * @category Actions
- * @module ShowAction
- * @description
- * Returns selected Record
- * Uses {@link ShowAction} component to render form
- * @private
- */
-export declare const ShowAction: Action<RecordActionResponse>;
-export default ShowAction;

package/types/src/backend/adapters/database/base-database.d.ts

@@ -1,28 +0,0 @@
-import BaseResource from '../resource/base-resource.js';
-/**
- * Representation of an ORM database in AdminJS
- * @category Base
- *
- * @mermaid
- *   graph LR
- *   A[BaseDatabase] -->|has many| B(BaseResource)
- *   B --> |has many|C(BaseRecord)
- *   B --> |has many|D(BaseProperty)
- */
-declare class BaseDatabase {
-    constructor(database: any);
-    /**
-     * Checks if given adapter supports database provided by user
-     *
-     * @param  {any}  database    database provided in AdminJSOptions#databases array
-     * @return {Boolean}          if given adapter supports this database - returns true
-     */
-    static isAdapterFor(database: any): boolean;
-    /**
-     * returns array of all resources (collections/tables) in the database
-     *
-     * @return {BaseResource[]}
-     */
-    resources(): Array<BaseResource>;
-}
-export default BaseDatabase;

package/types/src/backend/adapters/database/index.d.ts

@@ -1 +0,0 @@
-export { default as BaseDatabase } from './base-database.js';

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

@@ -1,4 +0,0 @@
-export * from './database/index.js';
-export * from './property/index.js';
-export * from './record/index.js';
-export * from './resource/index.js';

package/types/src/backend/adapters/property/base-property.d.ts

@@ -1,112 +0,0 @@
-export type PropertyType = 'string' | 'float' | 'number' | 'boolean' | 'date' | 'datetime' | 'mixed' | 'reference' | 'key-value' | 'richtext' | 'textarea' | 'password' | 'currency' | 'phone' | 'uuid';
-type BasePropertyAttrs = {
-    path: string;
-    type?: PropertyType;
-    isId?: boolean;
-    isSortable?: boolean;
-    position?: number;
-};
-/**
- * Represents Resource Property
- * @category Base
- */
-declare class BaseProperty {
-    private _path;
-    private _type;
-    private _isId;
-    private _isSortable;
-    private _position;
-    /**
-     * @param  {object} options
-     * @param  {string} options.path                     property path: usually it its key but when
-     *                                                   property is for an object the path can be
-     *                                                   divided to parts by dots: i.e.
-     *                                                   'address.street'
-     * @param  {PropertyType}  [options.type='string']
-     * @param  {boolean} [options.isId=false]            true when field should be treated as an ID
-     * @param  {boolean} [options.isSortable=true]       if property should be sortable
-     */
-    constructor({ path, type, isId, isSortable, position, }: BasePropertyAttrs);
-    /**
-     * Name of the property
-     * @return {string} name of the property
-     */
-    name(): string;
-    path(): string;
-    position(): number;
-    /**
-     * Return type of a property
-     * @return {PropertyType}
-     */
-    type(): PropertyType;
-    /**
-     * Return true if given property should be treated as a Record Title.
-     *
-     * @return {boolean}
-     */
-    isTitle(): boolean;
-    /**
-     * Indicates if given property should be visible
-     *
-     * @return {Boolean}
-     */
-    isVisible(): boolean;
-    /**
-     * Indicates if value of given property can be updated
-     *
-     * @return {boolean}
-     */
-    isEditable(): boolean;
-    /**
-     * Returns true if given property is a uniq key in a table/collection
-     *
-     * @return {boolean}
-     */
-    isId(): boolean;
-    /**
-     * If property is a reference to a record of different resource
-     * it should contain {@link BaseResource.id} of this resource.
-     *
-     * When property is responsible for the field: 'user_id' in SQL database
-     * reference should be the name of the Resource which it refers to: `Users`
-     */
-    reference(): string | null;
-    /**
-     * Returns all available values which field can accept. It is used in case of
-     * enums
-     *
-     * @return  {Array<String> | null}  array of all available values or null when field
-     *                                  is not an enum.
-     */
-    availableValues(): Array<string> | null;
-    /**
-     * Returns true when given property is an array
-     *
-     * @return  {boolean}
-     */
-    isArray(): boolean;
-    /**
-     * Returns true when given property has draggable elements.
-     * Only usable for array properties.
-     *
-     * @return  {boolean}
-     */
-    isDraggable(): boolean;
-    /**
-     * In case of `mixed` type returns all nested properties.
-     *
-     * @return  {Array<BaseProperty>} sub properties
-     */
-    subProperties(): Array<BaseProperty>;
-    /**
-     * Indicates if given property can be sorted
-     *
-     * @return {boolean}
-     */
-    isSortable(): boolean;
-    /**
-     * Indicates if given property is required
-     */
-    isRequired(): boolean;
-}
-export default BaseProperty;

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

@@ -1,2 +0,0 @@
-export { default as BaseProperty } from './base-property.js';
-export type { PropertyType } from './base-property.js';

package/types/src/backend/adapters/record/base-record.d.ts

@@ -1,183 +0,0 @@
-import { GetOptions } from '../../../utils/flat/index.js';
-import { ParamsType } from './params.type.js';
-import BaseResource from '../resource/base-resource.js';
-import { PropertyErrors } from '../../utils/errors/validation-error.js';
-import RecordError from '../../utils/errors/record-error.js';
-import { RecordJSON } from '../../../frontend/interfaces/index.js';
-import { CurrentAdmin } from '../../../current-admin.interface.js';
-import { ActionContext } from '../../actions/index.js';
-/**
- * Representation of an particular ORM/ODM Record in given Resource in AdminJS
- *
- * @category Base
- */
-declare class BaseRecord {
-    /**
-     * Resource to which record belongs
-     */
-    resource: BaseResource;
-    /**
-     * Actual record data stored as a flatten object. You shouldn't access them directly - always
-     * with {@link BaseRecord#get} and {@link BaseRecord#set} property.
-     */
-    params: ParamsType;
-    /**
-     * Object containing any base/overall validation error messages:
-     * this.baseError = { message: 'errorMessage' }
-     */
-    baseError: RecordError | null;
-    /**
-     * Object containing all validation errors: this.errors[path] = { message: 'errorMessage' }
-     */
-    errors: PropertyErrors;
-    /**
-     * Object containing all populated relations.
-     */
-    populated: {
-        [key: string]: BaseRecord;
-    };
-    /**
-     * @param  {ParamsType}   params         all resource data. I.e. field values
-     * @param  {BaseResource} resource       resource to which given record belongs
-     */
-    constructor(params: ParamsType, resource: BaseResource);
-    /**
-     * Returns value for given field.
-     * @param  {string} path      path (name) for given field: i.e. 'email' or 'authentication.email'
-     *                            if email is nested within the authentication object in the data
-     *                            store
-     * @return {any}              value for given field
-     * @deprecated in favour of {@link BaseRecord#get} and {@link BaseRecord#set} methods
-     */
-    param(path: string): any;
-    /**
-     * Returns unflatten (regular) value for given field. So if you have in the params following
-     * structure:
-     * ```javascript
-     * params = {
-     *   genre.0: 'male',
-     *   genre.1: 'female',
-     * }
-     * ```
-     *
-     * for `get('genre')` function will return ['male', 'female']
-     *
-     * @param {string} [propertyPath]     path for the property. If not set function returns an entire
-     *                                    unflatten object
-     * @param {GetOptions} [options]
-     * @return {any}                      unflatten data under given path
-     * @new in version 3.3
-     */
-    get(propertyPath?: string, options?: GetOptions): any;
-    /**
-     * Sets given value under the propertyPath. Value is flatten and all previous values under this
-     * path are replaced. When value is `undefined` function just clears the old values
-     *
-     * @param {string}    propertyPath
-     * @param {any}       value
-     * @returns           an entire, updated, params object
-     * @new in version 3.3
-     */
-    set(propertyPath: string, value: any): any;
-    /**
-     * Returns object containing all params keys starting with prefix
-     *
-     * @param   {string}  prefix
-     *
-     * @return  {object | undefined}
-     * @deprecated in favour of {@link selectParams}
-     */
-    namespaceParams(prefix: string): Record<string, any> | void;
-    /**
-     * Returns object containing all params keys starting with prefix
-     *
-     * @param   {string}  prefix
-     * @param {GetOptions} [options]
-     *
-     * @return  {object | undefined}
-     * @new in version 3.3
-     */
-    selectParams(prefix: string, options?: GetOptions): Record<string, any> | void;
-    /**
-     * Updates given Record in the data store. Practically it invokes
-     * {@link BaseResource.update} method.
-     *
-     * When validation error occurs it stores that to {@link BaseResource.errors}
-     *
-     * @param  {object} params all field with values which has to be updated
-     * @param  {ActionContext}           [context]
-     * @return {Promise<BaseRecord>}        given record (this)
-     */
-    update(params: any, context?: ActionContext): Promise<BaseRecord>;
-    /**
-     * Saves the record in the database. When record already exists - it updates, otherwise
-     * it creates new one.
-     *
-     * Practically it invokes
-     * {@link BaseResource#create} or {@link BaseResource#update} methods.
-     *
-     * When validation error occurs it stores that to {@link BaseResource#errors}
-     * @param  {ActionContext}           [context]
-     * @return {Promise<BaseRecord>}        given record (this)
-     */
-    save(context?: ActionContext): Promise<BaseRecord>;
-    /**
-     * Creates the record in the database
-     *
-     * Practically it invokes
-     * {@link BaseResource#create}.
-     *
-     * When validation error occurs it stores that to {@link BaseResource#errors}
-     *
-     *
-     * @return {Promise<BaseRecord>}        given record (this)
-     * @param  {ActionContext}           [context]
-     */
-    create(context?: ActionContext): Promise<BaseRecord>;
-    /**
-     * Returns uniq id of the Record.
-     * @return {string | number} id of the Record
-     */
-    id(): string;
-    /**
-     * Returns title of the record. Usually title is an value for fields like: email, topic,
-     * title etc.
-     *
-     * Title will be shown in the breadcrumbs for example.
-     *
-     * @return {string} title of the record
-     */
-    title(): string;
-    /**
-     * Return state of validation for given record
-     * @return {boolean} if record is valid or not.
-     */
-    isValid(): boolean;
-    /**
-     * Returns error message for given property path (name)
-     * @param  {string} path        (name) of property which we want to check if is valid
-     * @return {RecordError | null}      validation message of null
-     */
-    error(path: string): RecordError | null;
-    /**
-     * Populate record relations
-     *
-     * @param   {string}  propertyPath           name of the property which should be populated
-     * @param   {BaseRecord | null}  [record]    record to which property relates. If record is null
-     *                                           or undefined - function clears the previous value
-     */
-    populate(propertyPath: string, record?: BaseRecord | null): void;
-    /**
-     * Returns JSON representation of an record
-     * @param {CurrentAdmin} [currentAdmin]
-     * @return  {RecordJSON}
-     */
-    toJSON(currentAdmin?: CurrentAdmin): RecordJSON;
-    /**
-     * Stores incoming payloadData in record params
-     *
-     * @param {object} [payloadData]
-     */
-    storeParams(payloadData?: object): void;
-}
-export default BaseRecord;

package/types/src/backend/adapters/record/base-record.spec.d.ts

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

package/types/src/backend/adapters/record/index.d.ts

@@ -1,2 +0,0 @@
-export { default as BaseRecord } from './base-record.js';
-export * from './params.type.js';

package/types/src/backend/adapters/record/params.type.d.ts

@@ -1,10 +0,0 @@
-/**
- * @alias ParamsTypeValue
- * @memberof BaseRecord
- */
-export type ParamsTypeValue = string | number | boolean | null | undefined | [] | Record<string, unknown> | File;
-/**
- * @alias ParamsType
- * @memberof BaseRecord
- */
-export type ParamsType = Record<string, any>;

package/types/src/backend/adapters/resource/base-resource.d.ts

@@ -1,204 +0,0 @@
-import { SupportedDatabasesType } from './supported-databases.type.js';
-import { BaseProperty, BaseRecord, ParamsType } from '../index.js';
-import { Filter } from '../../utils/index.js';
-import { ResourceOptions, ResourceDecorator } from '../../decorators/index.js';
-import AdminJS from '../../../adminjs.js';
-import { ActionContext } from '../../actions/index.js';
-/**
- * Representation of a ORM Resource in AdminJS. Visually resource is a list item in the sidebar.
- * Each resource has many records and many properties.
- *
- * Analogy is REST resource.
- *
- * It is an __abstract class__ and all database adapters should implement extend it implement
- * following methods:
- *
- * - (static) {@link BaseResource.isAdapterFor isAdapterFor()}
- * - {@link BaseResource#databaseName databaseName()}
- * - {@link BaseResource#name name()}
- * - {@link BaseResource#id id()}
- * - {@link BaseResource#properties properties()}
- * - {@link BaseResource#property property()}
- * - {@link BaseResource#count count()}
- * - {@link BaseResource#find find()}
- * - {@link BaseResource#findOne findOne()}
- * - {@link BaseResource#findMany findMany()}
- * - {@link BaseResource#create create()}
- * - {@link BaseResource#update update()}
- * - {@link BaseResource#delete delete()}
- * @category Base
- * @abstract
- * @hideconstructor
- */
-declare class BaseResource {
-    _decorated: ResourceDecorator | null;
-    /**
-     * Checks if given adapter supports resource provided by the user.
-     * This function has to be implemented only if you want to create your custom
-     * database adapter.
-     *
-     * For one time Admin Resource creation - it is not needed.
-     *
-     * @param  {any}  rawResource resource provided in AdminJSOptions#resources array
-     * @return {Boolean}          if given adapter supports this resource - returns true
-     * @abstract
-     */
-    static isAdapterFor(rawResource: any): boolean;
-    /**
-     * Creates given resource based on the raw resource object
-     *
-     * @param   {Object}  [resource]
-     */
-    constructor(resource?: any);
-    /**
-     * The name of the database to which resource belongs. When resource is
-     * a mongoose model it should be database name of the mongo database.
-     *
-     * Visually, by default, all resources are nested in sidebar under their database names.
-     * @return {String}         database name
-     * @abstract
-     */
-    databaseName(): string;
-    /**
-     * Returns type of the database. It is used to compute sidebar icon for
-     * given resource. Default: 'database'
-     * @return {String}
-     */
-    databaseType(): SupportedDatabasesType | string;
-    /**
-     * Each resource has to have uniq id which will be put to an URL of AdminJS routes.
-     * For instance in {@link Router} path for the `new` form is `/resources/{resourceId}/new`
-     * @return {String} uniq resource id
-     * @abstract
-     */
-    id(): string;
-    /**
-     * returns array of all properties which belongs to resource
-     * @return {BaseProperty[]}
-     * @abstract
-     */
-    properties(): Array<BaseProperty>;
-    /**
-     * returns property object for given field
-     * @param {String} path           path/name of the property. Take a look at
-     *                                {@link BaseProperty} to learn more about
-     *                                property paths.
-     * @return {BaseProperty | null}
-     * @abstract
-     */
-    property(path: string): BaseProperty | null;
-    /**
-     * Returns number of elements for given resource by including filters
-     * @param  {Filter} filter        represents what data should be included
-     * @param  {ActionContext}           [context]
-     * @return {Promise<Number>}
-     * @abstract
-     */
-    count(filter: Filter, context?: ActionContext): Promise<number>;
-    /**
-     * Returns actual records for given resource
-     *
-     * @param  {Filter} filter                        what data should be included
-     * @param  {Object} options
-     * @param  {Number} [options.limit]                  how many records should be taken
-     * @param  {Number} [options.offset]                 offset
-     * @param  {Object} [options.sort]                   sort
-     * @param  {Number} [options.sort.sortBy]            sortable field
-     * @param  {Number} [options.sort.direction]         either asc or desc
-     * @param  {ActionContext}           [context]
-     * @return {Promise<BaseRecord[]>}                          list of records
-     * @abstract
-     * @example
-     * // filters example
-     * {
-     *    name: 'Tom',
-     *    createdAt: { from: '2019-01-01', to: '2019-01-18' }
-     * }
-     */
-    find(filter: Filter, options: {
-        limit?: number;
-        offset?: number;
-        sort?: {
-            sortBy?: string;
-            direction?: 'asc' | 'desc';
-        };
-    }, context?: ActionContext): Promise<Array<BaseRecord>>;
-    /**
-     * Finds one Record in the Resource by its id
-     *
-     * @param  {String} id      uniq id of the Resource Record
-     * @param  {ActionContext}           [context]
-     * @return {Promise<BaseRecord> | null}   record
-     * @abstract
-     */
-    findOne(id: string, context?: ActionContext): Promise<BaseRecord | null>;
-    /**
-     * Finds many records based on the resource ids
-     *
-     * @param   {Array<string>}          ids list of ids to find
-     * @param  {ActionContext}           [context]
-     *
-     * @return  {Promise<Array<BaseRecord>>} records
-     */
-    findMany(ids: Array<string | number>, context?: ActionContext): Promise<Array<BaseRecord>>;
-    /**
-     * Builds new Record of given Resource.
-     *
-     * Each Record is an representation of the resource item. Before it can be saved,
-     * it has to be instantiated.
-     *
-     * This function has to be implemented if you want to create new records.
-     *
-     * @param  {Record<string, any>} params
-     * @return {BaseRecord}
-     */
-    build(params: Record<string, any>): BaseRecord;
-    /**
-     * Creates new record
-     *
-     * @param  {Record<string, any>}     params
-     * @param  {ActionContext}           [context]
-     * @return {Promise<Object>}         created record converted to raw Object which
-     *                                   can be used to initiate new {@link BaseRecord} instance
-     * @throws {ValidationError}         If there are validation errors it should be thrown
-     * @abstract
-     */
-    create(params: Record<string, any>, context?: ActionContext): Promise<ParamsType>;
-    /**
-     * Updates the record.
-     *
-     * @param  {String} id               uniq id of the Resource Record
-     * @param  {Record<string, any>}     params
-     * @param  {ActionContext}           [context]
-     * @return {Promise<Object>}         created record converted to raw Object which
-     *                                   can be used to initiate new {@link BaseRecord} instance
-     * @throws {ValidationError}         If there are validation errors it should be thrown
-     * @abstract
-     */
-    update(id: string, params: Record<string, any>, context?: ActionContext): Promise<ParamsType>;
-    /**
-     * Delete given record by id
-     *
-     * @param  {String | Number}           id id of the Record
-     * @param  {ActionContext}           [context]
-     * @throws {ValidationError}           If there are validation errors it should be thrown
-     * @abstract
-     */
-    delete(id: string, context?: ActionContext): Promise<void>;
-    /**
-     * Assigns given decorator to the Resource. Than it will be available under
-     * resource.decorate() method
-     *
-     * @param  {BaseDecorator}  Decorator
-     * @param  {AdminJS}       admin         current instance of AdminJS
-     * @param  {ResourceOptions} [options]
-     * @private
-     */
-    assignDecorator(admin: AdminJS, options?: ResourceOptions): void;
-    /**
-     * Gets decorator object for given resource
-     * @return {BaseDecorator | null}
-     */
-    decorate(): ResourceDecorator;
-}
-export default BaseResource;

package/types/src/backend/adapters/resource/base-resource.spec.d.ts

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

package/types/src/backend/adapters/resource/index.d.ts

@@ -1,2 +0,0 @@
-export { default as BaseResource } from './base-resource.js';
-export * from './supported-databases.type.js';

package/types/src/backend/adapters/resource/supported-databases.type.d.ts

@@ -1 +0,0 @@
-export type SupportedDatabasesType = 'MySQL' | 'MariaDB' | 'Postgres' | 'CockroachDB' | 'SQLite' | 'MicrosoftSQLServer' | 'Oracle' | 'SAPHana' | 'MongoDB' | 'other';

package/types/src/backend/bundler/app.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/components.bundler.d.ts

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