@clement_lores/adminjs 7.8.17 → 7.8.18

package/types/src/backend/utils/errors/forbidden-error.d.ts

@@ -1,26 +0,0 @@
-import RecordError from './record-error.js';
-/**
- * Error which is thrown when user
- * doesn't have an access to a given resource/action.
- *
- * @category Errors
- */
-export declare class ForbiddenError extends Error {
-    /**
-     * HTTP Status code: 403
-     */
-    statusCode: number;
-    /**
-     * Base error message and type which is stored in the record
-     */
-    baseError: RecordError;
-    /**
-     * Any custom message which should be seen in the UI
-     */
-    baseMessage?: string;
-    /**
-     * @param {string} [message]
-     */
-    constructor(message?: string);
-}
-export default ForbiddenError;

package/types/src/backend/utils/errors/index.d.ts

@@ -1,7 +0,0 @@
-export * from './app-error.js';
-export * from './configuration-error.js';
-export * from './forbidden-error.js';
-export * from './not-found-error.js';
-export * from './not-implemented-error.js';
-export * from './record-error.js';
-export * from './validation-error.js';

package/types/src/backend/utils/errors/not-found-error.d.ts

@@ -1,27 +0,0 @@
-import RecordError from './record-error.js';
-/**
- * Error which is thrown when given record/resource/action hasn't been found.
- *
- * @category Errors
- */
-export declare class NotFoundError extends Error {
-    /**
-     * HTTP Status code: 404
-     */
-    statusCode: number;
-    /**
-     * Base error message and type which is stored in the record
-     */
-    baseError: RecordError;
-    /**
-     * Any custom message which should be seen in the UI
-     */
-    baseMessage?: string;
-    /**
-     * @param   {string}  fnName  name of the function, base on which error will
-     * print on the output link to the method documentation.
-     * @param {string} message
-     */
-    constructor(message: any, fnName: any);
-}
-export default NotFoundError;

package/types/src/backend/utils/errors/not-implemented-error.d.ts

@@ -1,13 +0,0 @@
-/**
- * Error which is thrown when an abstract method is not implemented
- *
- * @category Errors
- */
-export declare class NotImplementedError extends Error {
-    /**
-     * @param   {string}  fnName  name of the function, base on which error will
-     * print on the output link to the method documentation.
-     */
-    constructor(fnName: string);
-}
-export default NotImplementedError;

package/types/src/backend/utils/errors/record-error.d.ts

@@ -1,17 +0,0 @@
-import { ErrorTypeEnum } from '../../../utils/error-type.enum.js';
-/**
- * Record Error
- * @alias RecordError
- * @memberof ValidationError
- */
-export type RecordError = {
-    /**
-     * error type (i.e. required)
-     */
-    type?: ErrorTypeEnum | string;
-    /**
-     * Code of message
-     */
-    message: string;
-};
-export default RecordError;

package/types/src/backend/utils/errors/validation-error.d.ts

@@ -1,34 +0,0 @@
-import RecordError from './record-error.js';
-/**
- * Property Errors
- * @alias PropertyErrors
- * @memberof ValidationError
- */
-export type PropertyErrors = {
-    [key: string]: RecordError;
-};
-/**
- * Error which is thrown when there are validation errors with records
- * @category Errors
- */
-export declare class ValidationError extends Error {
-    /**
-     * Validation errors for all properties
-     */
-    propertyErrors: PropertyErrors;
-    /**
-     * One root validation error i.e. thrown when user wants to perform
-     * an action which violates foreign key constraint
-     */
-    baseError: RecordError | null;
-    /**
-     * HTTP Status code: 400
-     */
-    statusCode: number;
-    /**
-     * @param {PropertyErrors} propertyErrors     error messages
-     * @param {RecordError} [baseError]           base error message
-     */
-    constructor(propertyErrors: PropertyErrors, baseError?: RecordError);
-}
-export default ValidationError;

package/types/src/backend/utils/filter/filter.d.ts

@@ -1,66 +0,0 @@
-import BaseProperty from '../../adapters/property/base-property.js';
-import BaseRecord from '../../adapters/record/base-record.js';
-import { ActionContext } from '../../actions/index.js';
-export declare const PARAM_SEPARATOR = "~~";
-export type FilterElement = {
-    path: string;
-    property: BaseProperty;
-    value: string | {
-        from: string;
-        to: string;
-    };
-    populated?: BaseRecord | null;
-};
-interface ReduceCallback<T> {
-    (memo: T, element: FilterElement): T;
-}
-/**
- * Filter object wrapping up selected filters.
- * @private
- */
-export declare class Filter {
-    filters: {
-        [key: string]: FilterElement;
-    };
-    private resource;
-    /**
-     * Changes raw nested filters to form Object<path, value>.
-     *
-     * @example
-     * const filters = {
-     *  nested: {field: 'ala'},
-     *  'dataField~~from': '2019-08-14'
-     * }
-     *
-     * const normalized = Filter.normalizeFilters(filters)
-     * // {
-     * //   'nested.filter': 'ala',
-     * //   'dataField': {from: '2019-08-14'}
-     * // }
-     *
-     *
-     * @param   {Object}  filters
-     *
-     * @return  {Object}
-     */
-    static normalizeKeys(filters: any): Map<string, any>;
-    /**
-     * @param   {Object<String,Object | String>}  filters   selected filters
-     * @param   {BaseResource}                    resource    resource which is filtered
-     */
-    constructor(filters: {} | undefined, resource: any);
-    /**
-     * Returns filter for a given property key
-     *
-     * @param {String} key      property key
-     * @returns {Filter.Property | undefined}
-     */
-    get(key: string): FilterElement | null;
-    /**
-     * Populates all filtered properties which refers to other resources
-     */
-    populate(context: ActionContext): Promise<Filter>;
-    reduce<T>(callback: ReduceCallback<T>, initial: T): T;
-    isVisible(): boolean;
-}
-export default Filter;

package/types/src/backend/utils/filter/index.d.ts

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

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

@@ -1,13 +0,0 @@
-export * from './auth/index.js';
-export * from './build-feature/index.js';
-export * from './errors/index.js';
-export * from './filter/index.js';
-export * from './layout-element-parser/index.js';
-export * from './options-parser/index.js';
-export * from './populator/index.js';
-export * from './request-parser/index.js';
-export * from './resources-factory/index.js';
-export * from './view-helpers/index.js';
-export * from './router/index.js';
-export * from './uploaded-file.type.js';
-export * from './component-loader.js';

package/types/src/backend/utils/layout-element-parser/index.d.ts

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

package/types/src/backend/utils/layout-element-parser/layout-element-parser.d.ts

@@ -1,82 +0,0 @@
-import { BoxProps, HeaderProps, TextProps, BadgeProps, ButtonProps, LinkProps, LabelProps, IconProps } from '@clement_lores/admin-design-system';
-import { PropsWithChildren } from 'react';
-import { CurrentAdmin } from '../../../current-admin.interface.js';
-export type LayoutElement = string | Array<string> | Array<LayoutElement> | [
-    string,
-    PropsWithChildren<BoxProps>
-] | [
-    PropsWithChildren<BoxProps>,
-    Array<LayoutElement>
-] | [
-    '@Header',
-    PropsWithChildren<HeaderProps>
-] | [
-    '@H1',
-    PropsWithChildren<HeaderProps>
-] | [
-    '@H2',
-    PropsWithChildren<HeaderProps>
-] | [
-    '@H3',
-    PropsWithChildren<HeaderProps>
-] | [
-    '@H4',
-    PropsWithChildren<HeaderProps>
-] | [
-    '@H5',
-    PropsWithChildren<HeaderProps>
-] | [
-    '@Text',
-    PropsWithChildren<TextProps>
-] | [
-    '@Badge',
-    PropsWithChildren<BadgeProps>
-] | [
-    '@Button',
-    PropsWithChildren<ButtonProps>
-] | [
-    '@Link',
-    PropsWithChildren<LinkProps>
-] | [
-    '@Label',
-    PropsWithChildren<LabelProps>
-] | [
-    '@Icon',
-    PropsWithChildren<IconProps>
-] | [
-    string,
-    PropsWithChildren<any>
-];
-/**
- * Function returning Array<LayoutElement> used by {@link Action#layout}
- *
- * @return  {Array<LayoutElement>}
- * @memberof Action
- * @alias LayoutElementFunction
- */
-export type LayoutElementFunction = (currentAdmin?: CurrentAdmin) => Array<LayoutElement>;
-/**
- * It is generated from {@link Array<LayoutElement>} passed in {@link Action#layout}
- *
- * @alias ParsedLayoutElement
- * @memberof ActionJSON
- */
-export type ParsedLayoutElement = {
-    /** List of paths to properties which should be rendered by given element */
-    properties: Array<string>;
-    /** props passed to React component which wraps elements */
-    props: PropsWithChildren<any>;
-    /** Nested layout elements */
-    layoutElements: Array<ParsedLayoutElement>;
-    /** Component which should be used as a wrapper */
-    component: string;
-};
-export declare const layoutElementParser: (layoutElement: LayoutElement) => ParsedLayoutElement;
-export default layoutElementParser;
-/**
- * @load layout-element.doc.md
- * @name LayoutElement
- * @typedef {String | Array} LayoutElement
- * @memberof Action
- * @alias LayoutElement
- */

package/types/src/backend/utils/layout-element-parser/layout-element-parser.spec.d.ts

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

package/types/src/backend/utils/options-parser/index.d.ts

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

package/types/src/backend/utils/options-parser/options-parser.d.ts

@@ -1,10 +0,0 @@
-import { Assets, BrandingOptions } from '../../../adminjs-options.interface.js';
-import AdminJS from '../../../adminjs.js';
-import { CurrentAdmin } from '../../../current-admin.interface.js';
-import { ThemeInState } from '../../../frontend/store/index.js';
-import { Locale } from '../../../locale/index.js';
-export declare const getAssets: (admin: AdminJS, currentAdmin?: CurrentAdmin) => Promise<Assets>;
-export declare const getBranding: (admin: AdminJS, currentAdmin?: CurrentAdmin) => Promise<BrandingOptions>;
-export declare const getLocales: (admin: AdminJS, currentAdmin?: CurrentAdmin) => Promise<Locale>;
-export declare const getTheme: (admin: AdminJS, currentAdmin?: CurrentAdmin) => Promise<ThemeInState>;
-export declare const getFaviconFromBranding: (branding: BrandingOptions) => string;

package/types/src/backend/utils/populator/index.d.ts

@@ -1,2 +0,0 @@
-export * from './populator.js';
-export * from './populate-property.js';

package/types/src/backend/utils/populator/populate-property.d.ts

@@ -1,13 +0,0 @@
-import { BaseRecord } from '../../adapters/index.js';
-import PropertyDecorator from '../../decorators/property/property-decorator.js';
-import { ActionContext } from '../../actions/index.js';
-/**
- * It populates one property in given records
- *
- * @param {Array<BaseRecord>} records   array of records to populate
- * @param {PropertyDecorator} property  Decorator for the reference property to populate
- * @param context
- * @private
- * @hide
- */
-export declare function populateProperty(records: Array<BaseRecord> | null, property: PropertyDecorator, context?: ActionContext): Promise<Array<BaseRecord> | null>;

package/types/src/backend/utils/populator/populate-property.spec.d.ts

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

package/types/src/backend/utils/populator/populator.d.ts

@@ -1,10 +0,0 @@
-import BaseRecord from '../../adapters/record/base-record.js';
-import { ActionContext } from '../../actions/index.js';
-/**
- * @load ./populator.doc.md
- * @param {Array<BaseRecord>} records
- * @param context
- * @new In version 3.3
- */
-export declare function populator(records: Array<BaseRecord>, context?: ActionContext): Promise<Array<BaseRecord>>;
-export default populator;

package/types/src/backend/utils/populator/populator.spec.d.ts

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

package/types/src/backend/utils/request-parser/index.d.ts

@@ -1 +0,0 @@
-export * from './request-parser.js';

package/types/src/backend/utils/request-parser/request-parser.d.ts

@@ -1,14 +0,0 @@
-import { ActionRequest } from '../../actions/index.js';
-import { BaseResource } from '../../adapters/index.js';
-/**
- * Takes the original ActionRequest and convert string values to a corresponding
- * types. It
- *
- * @param {ActionRequest} originalRequest
- * @param {BaseResource}  resource
- * @returns {ActionRequest}
- *
- * @private
- */
-export declare const requestParser: (originalRequest: ActionRequest, resource: BaseResource) => ActionRequest;
-export default requestParser;

package/types/src/backend/utils/request-parser/request-parser.spec.d.ts

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

package/types/src/backend/utils/resources-factory/index.d.ts

@@ -1 +0,0 @@
-export { default as ResourcesFactory } from './resources-factory.js';

package/types/src/backend/utils/resources-factory/resources-factory.d.ts

@@ -1,57 +0,0 @@
-import BaseResource from '../../adapters/resource/base-resource.js';
-import { Adapter } from '../../../adminjs.js';
-import { ResourceWithOptions } from '../../../adminjs-options.interface.js';
-export declare class NoDatabaseAdapterError extends Error {
-    private database;
-    constructor(database: string);
-}
-export declare class NoResourceAdapterError extends Error {
-    private resource;
-    constructor(resource: BaseResource);
-}
-export declare class ResourcesFactory {
-    private adapters;
-    private admin;
-    constructor(admin: any, adapters?: Array<Adapter>);
-    buildResources({ databases, resources }: {
-        databases: any;
-        resources: any;
-    }): Array<BaseResource>;
-    /**
-     * Changes database give by the user in configuration to list of supported resources
-     * @param  {Array<any>} databases    list of all databases given by the user in
-     *                                   {@link AdminJSOptions}
-     * @return {Array<BaseResource>}     list of all resources from given databases
-    */
-    _convertDatabases(databases: Array<any>): Array<BaseResource>;
-    /**
-     * Maps resources given by user to resources supported by AdminJS.
-     *
-     * @param  {any[]}           resources                array of all resources given by the user
-     *                                                    in {@link AdminJSOptions}
-     * @param  {any}             resources[].resource     optionally user can give resource along
-     *                                                    with options
-     * @param  {Object}          resources[].options      options given along with the resource
-     * @return {Object[]}                                 list of Objects with resource and options
-     *                                                    keys
-     *
-     * @example
-     * AdminJS._convertResources([rawAdminModel, {resource: rawUserMode, options: {}}])
-     * // => returns: [AdminModel, {resource: UserModel, options: {}}]
-     * // where AdminModel and UserModel were converted by appropriate database adapters.
-     */
-    _convertResources(resources: Array<any | ResourceWithOptions>): Array<any>;
-    /**
-     * Assigns decorator to each resource and initializes it with `options` and current `admin`
-     * instance
-     * @param  {Array<Object | BaseResource>} resources    array of all mapped resources given by the
-     *                                                     user in {@link AdminJSOptions} along with
-     *                                                     options
-     * @param  {BaseResource}  resources[].resource        optionally user can give resource along
-     *                                                     with options
-     * @param  {Object} [resources[].options]              options for given resource
-     * @return {BaseResource[]}                            list of resources with decorator assigned
-     */
-    _decorateResources(resources: Array<ResourceWithOptions>): Array<BaseResource>;
-}
-export default ResourcesFactory;

package/types/src/backend/utils/router/index.d.ts

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

package/types/src/backend/utils/router/router.d.ts

@@ -1,24 +0,0 @@
-/**
- * Type representing the AdminJS.Router
- * @memberof Router
- * @alias RouterType
- */
-export type RouterType = {
-    assets: Array<{
-        path: string;
-        src: string;
-    }>;
-    routes: Array<{
-        method: string;
-        path: string;
-        Controller: any;
-        action: string;
-        contentType?: string;
-    }>;
-};
-/**
- * @load ./router.doc.md
- * @namespace
- */
-export declare const Router: RouterType;
-export default Router;

package/types/src/backend/utils/router/router.spec.d.ts

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

package/types/src/backend/utils/uploaded-file.type.d.ts

@@ -1,25 +0,0 @@
-/**
- * File uploaded via FormData to the backend.
- *
- * @memberof AdminJS
- * @alias UploadedFile
- */
-export type UploadedFile = {
-    /**
-     * The size of the uploaded file in bytes.
-     * this property says how many bytes of the file have been written to disk yet.
-     */
-    size: number;
-    /**
-     * The path this file is being written to.
-     */
-    path: string;
-    /**
-     * The mime type of this file, according to the uploading client.
-     */
-    type: string;
-    /**
-     * The name this file had according to the uploading client.
-     */
-    name: string | null;
-};

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

@@ -1 +0,0 @@
-export * from './view-helpers.js';