@clement_lores/adminjs 7.8.17 → 7.8.18

package/types/src/frontend/interfaces/property-json/property-json.interface.d.ts

@@ -1,157 +0,0 @@
-import { PropertyType } from '../../../backend/adapters/property/base-property.js';
-export type PropertyPlace = 'show' | 'list' | 'edit' | 'filter';
-/**
- * JSON representation of a Property.
- * @subcategory Frontend
- */
-export interface PropertyJSON {
-    /**
-     * If given property should be treated as a title
-     */
-    isTitle: boolean;
-    /**
-     * If given property should be treated as a Id field
-     */
-    isId: boolean;
-    /**
-     * Property position on a list
-     */
-    position: number;
-    /**
-     * If property is sortable
-     */
-    isSortable: boolean;
-    /**
-     * If property has restricted number of values
-     */
-    availableValues: Array<{
-        label?: string;
-        value: string | number;
-    }> | null;
-    /**
-     * Property uniq name
-     */
-    name: string;
-    /**
-     * Property uniq path. For top level properties - the same as name, but for nested
-     * properties it is separated with dot notation: `nested.property`
-     */
-    propertyPath: string;
-    /**
-     * Path of the actual value inside the record. It is usually the same as propertyPath, with the
-     * exception of array values.
-     */
-    path: string;
-    /**
-     * Property label
-     */
-    label: 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",
-     *           },
-     *         },
-     *       },
-     *     },
-     *   },
-     * });
-     * ```
-     */
-    description?: string;
-    /**
-     * One of {@link PropertyType}s
-     */
-    type: PropertyType;
-    /**
-     * Has a name of a resource to which it is a reference.
-     * For instance property `userId` will have here `Users`
-     */
-    reference: string | null;
-    /**
-     * Indicates if property is an array of properties
-     */
-    isArray: boolean;
-    /**
-     * Indicates if array elements should be draggable when editing.
-     * It is only usable if the property is an array.
-     */
-    isDraggable: boolean;
-    /**
-     * Contain list of all sub properties.
-     * This is the case for nested schemas in MongoDB.
-     */
-    subProperties: Array<BasePropertyJSON>;
-    /**
-     * All component names overridden by the user in PropertyOptions
-     */
-    components?: {
-        show?: string;
-        edit?: string;
-        filter?: string;
-        list?: string;
-    };
-    /**
-     * Custom parameters passed from the {@link PropertyOptions.custom}.
-     */
-    custom: {
-        [key: string]: any;
-    };
-    /**
-     * Additional props passed to the actual react component
-     */
-    props: {
-        [key: string]: any;
-    };
-    /**
-     * Whether the field should be disabled in edition
-     */
-    isDisabled: boolean;
-    /**
-     * Whether the field should be marked as required (with a star)
-     */
-    isRequired: boolean;
-    /**
-     * if label above the input should be hidden
-     */
-    hideLabel: boolean;
-    /**
-     * Resource to which given property belongs
-     */
-    resourceId: string;
-    /**
-     * Indicates if given property has been created in AdminJS {@link PropertyOptions} and hasn't
-     * been returned by the database adapter.
-     */
-    isVirtual: boolean;
-}
-export type BasePropertyJSON = Omit<PropertyJSON, 'path'>;
-/**
- * Property without the path. Defined as `Omit<PropertyJSON, 'path'>`
- *
- * @typedef {Object} BasePropertyJSON
- * @property {any} ...   properties from {@link PropertyJSON} except `path`
- * @alias BasePropertyJSON
- * @memberof PropertyJSON
- */

package/types/src/frontend/interfaces/record-json.interface.d.ts

@@ -1,51 +0,0 @@
-import { ErrorTypeEnum } from '../../utils/error-type.enum.js';
-import { ParamsType, RecordError } from '../../backend/index.js';
-import { ActionJSON } from './action/action-json.interface.js';
-/**
- * @memberof {RecordJSON}
- * @alias ErrorMessage
- */
-export type ErrorMessage = {
-    /** Human readable message */
-    message: string;
-    /** Error type */
-    type?: ErrorTypeEnum | string;
-};
-/**
- * JSON representation of an record
- * @subcategory Frontend
- */
-export interface RecordJSON {
-    /**
-     * all flatten params of given record
-     */
-    params: ParamsType;
-    /**
-     * If the record has properties which are references - here there will be populated records
-     */
-    populated: Record<string, RecordJSON | null | undefined>;
-    /**
-     * Any base/overall validation error for the record
-     */
-    baseError: RecordError | null;
-    /**
-     * List of all validation errors
-     */
-    errors: Record<string, ErrorMessage>;
-    /**
-     * Uniq Id of a record. Not present if the record is new (in NewAction)
-     */
-    id: string;
-    /**
-     * Title of an record. Not present if the record is new (in NewAction)
-     */
-    title: string;
-    /**
-     * Actions which can be performed on this record.
-     */
-    recordActions: Array<ActionJSON>;
-    /**
-     * Actions which can be performed on this record in a bulk.
-     */
-    bulkActions: Array<ActionJSON>;
-}

package/types/src/frontend/interfaces/resource-json.interface.d.ts

@@ -1,71 +0,0 @@
-import { BasePropertyJSON } from './property-json/index.js';
-import { ActionJSON } from './action/action-json.interface.js';
-/**
- * Resource object accessible on the fronted
- * @alias ResourceJSON
- * @subcategory Frontend
- */
-export interface ResourceJSON {
-    /**
-     * Unique Id of a resource
-     */
-    id: string;
-    /**
-     * Resource name
-     */
-    name: string;
-    /**
-     * url to a resource list action. If null - resource should not be seen in the sidebar.
-     */
-    href: string | null;
-    /**
-     * Resource parent - visible on the sidebar
-     */
-    navigation: {
-        /**
-         * Parent name
-         */
-        name: string | null;
-        /**
-         * Parent icon
-         */
-        icon: string;
-        /**
-         * Visibility
-         */
-        show: boolean;
-    } | null;
-    /**
-     * Property which should be treated as a Main property
-     */
-    titleProperty: BasePropertyJSON;
-    /**
-     * Actions available for entire resource with type: resource
-     */
-    resourceActions: Array<ActionJSON>;
-    /**
-     * All actions - whether they are available or not.
-     */
-    actions: Array<ActionJSON>;
-    /**
-     * Properties which should be visible on the list
-     */
-    listProperties: Array<BasePropertyJSON>;
-    /**
-     * Properties which should be visible on the edit view
-     */
-    editProperties: Array<BasePropertyJSON>;
-    /**
-     * Properties which should be visible on the show view
-     */
-    showProperties: Array<BasePropertyJSON>;
-    /**
-     * Properties which should be visible on the filter
-     */
-    filterProperties: Array<BasePropertyJSON>;
-    /**
-     * Map of all properties inside the resource. It also contains nested properties.
-     * So this is the easies way of getting any property you like from a resource.
-     */
-    properties: Record<string, BasePropertyJSON>;
-}

package/types/src/frontend/layout-template.d.ts

@@ -1,14 +0,0 @@
-import AdminJS from '../adminjs.js';
-import { CurrentAdmin } from '../current-admin.interface.js';
-/**
- * Renders (SSR) html for given location
- *
- * @param {AdminJS} admin
- * @param {Object} [currentAdmin]
- * @param {String} currentAdmin.email
- * @param {String} location='/'
- *
- * @private
- */
-declare const html: (admin: AdminJS, currentAdmin?: CurrentAdmin, location?: string) => Promise<string>;
-export default html;

package/types/src/frontend/layout-template.spec.d.ts

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

package/types/src/frontend/login-template.d.ts

@@ -1,8 +0,0 @@
-import AdminJS from '../adminjs.js';
-export type LoginTemplateAttributes = {
-    errorMessage?: string | null;
-    action?: string;
-    [name: string]: any;
-};
-declare const html: (admin: AdminJS, attributes: LoginTemplateAttributes) => Promise<string>;
-export default html;

package/types/src/frontend/login-template.spec.d.ts

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

package/types/src/frontend/store/actions/add-notice.d.ts

@@ -1,8 +0,0 @@
-import { type NoticeMessage } from '../../interfaces/noticeMessage.interface.js';
-import { type NoticeMessageInState } from '../reducers/noticesReducer.js';
-export declare const ADD_NOTICE = "ADD_NOTICE";
-export type AddNoticeResponse = {
-    type: typeof ADD_NOTICE;
-    data: NoticeMessageInState;
-};
-export declare const addNotice: (data: NoticeMessage) => AddNoticeResponse;

package/types/src/frontend/store/actions/drop-notice.d.ts

@@ -1,8 +0,0 @@
-export declare const DROP_NOTICE = "DROP_NOTICE";
-export type DropNoticeResponse = {
-    type: typeof DROP_NOTICE;
-    data: {
-        noticeId: string;
-    };
-};
-export declare const dropNotice: (noticeId: string) => DropNoticeResponse;

package/types/src/frontend/store/actions/filter-drawer.d.ts

@@ -1,11 +0,0 @@
-export declare const OPEN_FILTER_DRAWER = "OPEN_FILTER_DRAWER";
-export declare const CLOSE_FILTER_DRAWER = "CLOSE_FILTER_DRAWER";
-export type FilterDrawerAction = {
-    type: typeof OPEN_FILTER_DRAWER;
-    isVisible: true;
-} | {
-    type: typeof CLOSE_FILTER_DRAWER;
-    isVisible: false;
-};
-export declare const showFilterDrawer: () => FilterDrawerAction;
-export declare const hideFilterDrawer: () => FilterDrawerAction;

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

@@ -1,16 +0,0 @@
-export * from './add-notice.js';
-export * from './drop-notice.js';
-export * from './initialize-assets.js';
-export * from './initialize-branding.js';
-export * from './initialize-dashboard.js';
-export * from './initialize-locale.js';
-export * from './initialize-pages.js';
-export * from './initialize-paths.js';
-export * from './initialize-resources.js';
-export * from './initialize-theme.js';
-export * from './initialize-versions.js';
-export * from './modal.js';
-export * from './route-changed.js';
-export * from './set-current-admin.js';
-export * from './set-drawer-preroute.js';
-export * from './set-notice-progress.js';

package/types/src/frontend/store/actions/initialize-assets.d.ts

@@ -1,7 +0,0 @@
-import type { Assets } from '../../../adminjs-options.interface.js';
-export declare const ASSETS_INITIALIZE = "ASSETS_INITIALIZE";
-export type initializeAssetsResponse = {
-    type: string;
-    data: Assets;
-};
-export declare const initializeAssets: (data: Assets) => initializeAssetsResponse;

package/types/src/frontend/store/actions/initialize-branding.d.ts

@@ -1,7 +0,0 @@
-import type { BrandingOptions } from '../../../adminjs-options.interface.js';
-export declare const BRANDING_INITIALIZE = "BRANDING_INITIALIZE";
-export type InitializeBrandingResponse = {
-    type: typeof BRANDING_INITIALIZE;
-    data: BrandingOptions;
-};
-export declare const initializeBranding: (data: BrandingOptions) => InitializeBrandingResponse;

package/types/src/frontend/store/actions/initialize-dashboard.d.ts

@@ -1,7 +0,0 @@
-import { DashboardInState } from '../reducers/dashboardReducer.js';
-export declare const DASHBOARD_INITIALIZE = "DASHBOARD_INITIALIZE";
-export type InitializeDashboardResponse = {
-    type: typeof DASHBOARD_INITIALIZE;
-    data: DashboardInState;
-};
-export declare const initializeDashboard: (data: DashboardInState) => InitializeDashboardResponse;

package/types/src/frontend/store/actions/initialize-locale.d.ts

@@ -1,7 +0,0 @@
-import { Locale } from '../../../locale/config.js';
-export declare const LOCALE_INITIALIZE = "LOCALE_INITIALIZE";
-export type InitializeLocaleResponse = {
-    type: typeof LOCALE_INITIALIZE;
-    data: Locale;
-};
-export declare const initializeLocale: (data: Locale) => InitializeLocaleResponse;

package/types/src/frontend/store/actions/initialize-pages.d.ts

@@ -1,7 +0,0 @@
-import { AdminPage } from '../../../adminjs-options.interface.js';
-export declare const PAGES_INITIALIZE = "PAGES_INITIALIZE";
-export type InitializePagesResponse = {
-    type: typeof PAGES_INITIALIZE;
-    data: Array<AdminPage>;
-};
-export declare const initializePages: (data: Array<AdminPage>) => InitializePagesResponse;

package/types/src/frontend/store/actions/initialize-paths.d.ts

@@ -1,7 +0,0 @@
-import type { PathsInState } from '../reducers/pathsReducer.js';
-export declare const PATHS_INITIALIZE = "PATHS_INITIALIZE";
-export type InitializePathsResponse = {
-    type: typeof PATHS_INITIALIZE;
-    data: PathsInState;
-};
-export declare const initializePaths: (data: PathsInState) => InitializePathsResponse;

package/types/src/frontend/store/actions/initialize-resources.d.ts

@@ -1,7 +0,0 @@
-import { ResourceJSON } from '../../interfaces/index.js';
-export declare const RESOURCES_INITIALIZE = "RESOURCES_INITIALIZE";
-export type InitializeResourcesResponse = {
-    type: typeof RESOURCES_INITIALIZE;
-    data: Array<ResourceJSON>;
-};
-export declare const initializeResources: (data: Array<ResourceJSON>) => InitializeResourcesResponse;

package/types/src/frontend/store/actions/initialize-theme.d.ts

@@ -1,7 +0,0 @@
-import type { ThemeInState } from '../reducers/themeReducer.js';
-export declare const THEME_INITIALIZE = "THEME_INITIALIZE";
-export type initializeThemeResponse = {
-    type: typeof THEME_INITIALIZE;
-    data: ThemeInState;
-};
-export declare const initializeTheme: (data: ThemeInState) => initializeThemeResponse;

package/types/src/frontend/store/actions/initialize-versions.d.ts

@@ -1,7 +0,0 @@
-import { VersionProps } from '../../../adminjs-options.interface.js';
-export declare const VERSIONS_INITIALIZE = "VERSIONS_INITIALIZE";
-export type InitializeVersionsResponse = {
-    type: typeof VERSIONS_INITIALIZE;
-    data: VersionProps;
-};
-export declare const initializeVersions: (data: VersionProps) => InitializeVersionsResponse;

package/types/src/frontend/store/actions/modal.d.ts

@@ -1,5 +0,0 @@
-import type { ModalData, ShowModalResponse, HideModalResponse } from '../../interfaces/index.js';
-export declare const SHOW_MODAL = "SHOW_MODAL";
-export declare const HIDE_MODAL = "HIDE_MODAL";
-export declare const showModal: (data: ModalData) => ShowModalResponse;
-export declare const hideModal: () => HideModalResponse;

package/types/src/frontend/store/actions/route-changed.d.ts

@@ -1,9 +0,0 @@
-import type { useLocation } from 'react-router';
-export declare const INITIAL_ROUTE = "INITIAL_ROUTE";
-export declare const ROUTE_CHANGED = "ROUTE_CHANGED";
-export type RouteChangedResponse = {
-    type: typeof ROUTE_CHANGED;
-    data: any;
-};
-export declare const initializeRoute: (location: Partial<ReturnType<typeof useLocation>>) => RouteChangedResponse;
-export declare const changeRoute: (location: ReturnType<typeof useLocation>) => RouteChangedResponse;

package/types/src/frontend/store/actions/set-current-admin.d.ts

@@ -1,7 +0,0 @@
-import type { SessionInState } from '../reducers/sessionReducer.js';
-export declare const SESSION_INITIALIZE = "SESSION_INITIALIZE";
-export type SetCurrentAdminResponse = {
-    type: typeof SESSION_INITIALIZE;
-    data: SessionInState;
-};
-export declare const setCurrentAdmin: (data?: SessionInState) => SetCurrentAdminResponse;

package/types/src/frontend/store/actions/set-drawer-preroute.d.ts

@@ -1,11 +0,0 @@
-import type { useLocation } from 'react-router';
-export declare const DRAWER_PREROUTE_SET = "DRAWER_PREROUTE_SET";
-export type SetDrawerPreRouteResponse = {
-    type: typeof DRAWER_PREROUTE_SET;
-    data: {
-        previousRoute: Partial<ReturnType<typeof useLocation>> | null;
-    };
-};
-export declare const setDrawerPreRoute: (data: {
-    previousRoute: Partial<ReturnType<typeof useLocation>> | null;
-}) => SetDrawerPreRouteResponse;

package/types/src/frontend/store/actions/set-notice-progress.d.ts

@@ -1,10 +0,0 @@
-export declare const SET_NOTICE_PROGRESS = "SET_NOTICE_PROGRESS";
-export type SetNoticeProgress = {
-    noticeId: string;
-    progress: number;
-};
-export type SetNoticeProgressResponse = {
-    type: typeof SET_NOTICE_PROGRESS;
-    data: SetNoticeProgress;
-};
-export declare const setNoticeProgress: (data: SetNoticeProgress) => SetNoticeProgressResponse;

package/types/src/frontend/store/index.d.ts

@@ -1,5 +0,0 @@
-export * from './actions/index.js';
-export * from './initialize-store.js';
-export * from './reducers/index.js';
-export * from './store.js';
-export { default as createStore } from './store.js';

package/types/src/frontend/store/initialize-store.d.ts

@@ -1,6 +0,0 @@
-import { Store } from 'redux';
-import { ReduxState } from './store.js';
-import AdminJS from '../../adminjs.js';
-import { CurrentAdmin } from '../../current-admin.interface.js';
-export declare const initializeStore: (admin: AdminJS, currentAdmin?: CurrentAdmin) => Promise<Store<ReduxState>>;
-export default initializeStore;

package/types/src/frontend/store/reducers/assetsReducer.d.ts

@@ -1,5 +0,0 @@
-import type { Assets } from '../../../adminjs-options.interface.js';
-export declare const assetsReducer: (state: {} | undefined, action: {
-    type: string;
-    data: Assets;
-}) => {};

package/types/src/frontend/store/reducers/brandingReducer.d.ts

@@ -1,5 +0,0 @@
-import type { BrandingOptions } from '../../../adminjs-options.interface.js';
-export declare const brandingReducer: (state: {} | undefined, action: {
-    type: string;
-    data: BrandingOptions;
-}) => {};

package/types/src/frontend/store/reducers/dashboardReducer.d.ts

@@ -1,7 +0,0 @@
-export type DashboardInState = {
-    component?: string;
-};
-export declare const dashboardReducer: (state: {} | undefined, action: {
-    type: string;
-    data: DashboardInState;
-}) => DashboardInState;

package/types/src/frontend/store/reducers/drawerReducer.d.ts

@@ -1,10 +0,0 @@
-import { SetDrawerPreRouteResponse } from '../actions/set-drawer-preroute.js';
-export type DrawerInState = SetDrawerPreRouteResponse['data'];
-export declare const drawerReducer: (state: {
-    previousRoute: Partial<import("react-router").Location> | null;
-} | undefined, action: {
-    type: string;
-    data: DrawerInState;
-}) => {
-    previousRoute: Partial<import("react-router").Location> | null;
-};

package/types/src/frontend/store/reducers/filterDrawerReducer.d.ts

@@ -1,7 +0,0 @@
-import { type FilterDrawerAction } from '../actions/filter-drawer.js';
-export type FilterDrawerInState = ReturnType<typeof filterDrawerReducer>;
-export declare const filterDrawerReducer: (state: {
-    isVisible: boolean;
-} | undefined, action: FilterDrawerAction) => {
-    isVisible: boolean;
-};

package/types/src/frontend/store/reducers/index.d.ts

@@ -1,15 +0,0 @@
-export * from './assetsReducer.js';
-export * from './brandingReducer.js';
-export * from './dashboardReducer.js';
-export * from './drawerReducer.js';
-export * from './filterDrawerReducer.js';
-export * from './localesReducer.js';
-export * from './modalReducer.js';
-export * from './noticesReducer.js';
-export * from './pagesReducer.js';
-export * from './pathsReducer.js';
-export * from './resourcesReducer.js';
-export * from './routerReducer.js';
-export * from './sessionReducer.js';
-export * from './themeReducer.js';
-export * from './versionsReducer.js';

package/types/src/frontend/store/reducers/localesReducer.d.ts

@@ -1,6 +0,0 @@
-import type { Locale } from '../../../locale/config.js';
-export type LolcaleInState = Locale;
-export declare const localesReducer: (state: Locale | undefined, action: {
-    type: string;
-    data: Locale;
-}) => Locale;

package/types/src/frontend/store/reducers/modalReducer.d.ts

@@ -1,10 +0,0 @@
-import type { ModalData } from '../../interfaces/index.js';
-export type ModalInState = (ModalData & {
-    show: true;
-}) | {
-    show: false;
-};
-export declare const modalReducer: (state: ModalInState | undefined, action: {
-    type: string;
-    data: ModalData;
-}) => ModalInState;

package/types/src/frontend/store/reducers/noticesReducer.d.ts

@@ -1,12 +0,0 @@
-import { type NoticeMessage } from '../../interfaces/noticeMessage.interface.js';
-import { AddNoticeResponse } from '../actions/add-notice.js';
-import { DropNoticeResponse } from '../actions/drop-notice.js';
-import { SetNoticeProgressResponse } from '../actions/set-notice-progress.js';
-export interface NoticeMessageInState extends NoticeMessage {
-    id: string;
-    progress: number;
-}
-export type NoticesInState = Array<NoticeMessageInState>;
-type NoticeActionResponse = AddNoticeResponse | DropNoticeResponse | SetNoticeProgressResponse;
-export declare const noticesReducer: (state: NoticesInState | undefined, action: NoticeActionResponse) => NoticesInState;
-export {};

package/types/src/frontend/store/reducers/pagesReducer.d.ts

@@ -1,6 +0,0 @@
-import type { PageJSON } from '../../interfaces/page-json.interface.js';
-export type PagesInState = Array<PageJSON>;
-export declare const pagesReducer: (state: PagesInState | undefined, action: {
-    type: string;
-    data: PagesInState;
-}) => PagesInState;

package/types/src/frontend/store/reducers/pathsReducer.d.ts

@@ -1,10 +0,0 @@
-export type PathsInState = {
-    rootPath: string;
-    logoutPath: string;
-    loginPath: string;
-    assetsCDN?: string;
-};
-export declare const pathsReducer: (state: PathsInState | undefined, action: {
-    type: string;
-    data: PathsInState;
-}) => PathsInState;

package/types/src/frontend/store/reducers/resourcesReducer.d.ts

@@ -1,6 +0,0 @@
-import type { ResourceJSON } from '../../interfaces/resource-json.interface.js';
-export type ResourcesInState = Array<ResourceJSON>;
-export declare const resourcesReducer: (state: ResourcesInState | undefined, action: {
-    type: string;
-    data: ResourcesInState;
-}) => ResourcesInState;

package/types/src/frontend/store/reducers/routerReducer.d.ts

@@ -1,22 +0,0 @@
-import type { Location } from 'react-router';
-import { ROUTE_CHANGED, INITIAL_ROUTE } from '../actions/route-changed.js';
-export type RouterInState = {
-    from: Partial<Location>;
-    to: Partial<Location>;
-};
-export declare const routerReducer: (state: RouterInState | undefined, action: {
-    type: typeof INITIAL_ROUTE | typeof ROUTE_CHANGED;
-    data: any;
-}) => {
-    from: any;
-    to: Partial<Location>;
-} | {
-    from: {
-        state?: any;
-        key?: string | undefined;
-        pathname?: string | undefined;
-        search?: string | undefined;
-        hash?: string | undefined;
-    };
-    to: any;
-};