@clement_lores/adminjs 7.8.17 → 7.8.18

package/types/src/frontend/hooks/use-record/is-entire-record-given.d.ts

@@ -1,3 +0,0 @@
-import { RecordJSON } from '../../interfaces/index.js';
-declare const isEntireRecordGiven: (propertyOrRecord: RecordJSON | string, value?: string) => boolean;
-export { isEntireRecordGiven as default, isEntireRecordGiven, };

package/types/src/frontend/hooks/use-record/merge-record-response.d.ts

@@ -1,14 +0,0 @@
-import { RecordJSON } from '../../interfaces/index.js';
-import { RecordActionResponse } from '../../../backend/actions/action.interface.js';
-/**
- * Handlers of all [Actions]{@link Action} of type `record` returns record.
- * Depending on a place and response we have to merge what was returned
- * to the actual state. It is done in following places:
- * - {@link useRecord} hook
- * - {@link RecordInList} component
- * - {@link RecordAction} component
- *
- * @private
- */
-declare const mergeRecordResponse: (record: RecordJSON, response: RecordActionResponse) => RecordJSON;
-export default mergeRecordResponse;

package/types/src/frontend/hooks/use-record/params-to-form-data.d.ts

@@ -1,17 +0,0 @@
-export declare const FORM_VALUE_NULL = "__FORM_VALUE_NULL__";
-export declare const FORM_VALUE_EMPTY_OBJECT = "__FORM_VALUE_EMPTY_OBJECT__";
-export declare const FORM_VALUE_EMPTY_ARRAY = "__FORM_VALUE_EMPTY_ARRAY__";
-/**
- * Changes RecordJSON that it can be send as a FormData to the backend.
- *
- * FormData is required because we are sending files via the wire. But it has limitations.
- * Namely it can only transport files and strings. That is why we have to convert some
- * standard types like NULL to constants so they can be property converted back by the backend.
- * And thus properly handled.
- *
- * @private
- * @param   {RecordJSON}  record
- * @return  {FormData}
- */
-declare function paramsToFormData(params: Record<string, any>): FormData;
-export { paramsToFormData as default, paramsToFormData, };

package/types/src/frontend/hooks/use-record/params-to-form-data.spec.d.ts

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

package/types/src/frontend/hooks/use-record/update-record.d.ts

@@ -1,29 +0,0 @@
-import { RecordJSON } from '../../interfaces/index.js';
-/**
- * HOF returning a function which takes a record and returns an updated record.
- * This way we can pass this to setState in react, which takes old state
- * (in our case previousRecord) as an argument.
- *
- * Function is used when to the {@link OnPropertyChange} callback, user passes
- * key (property name) and the value (followed by an optional selectedRecord).
- *
- * The responsibility of the function is to:
- * - clear old values under passed key: so when user passes property === `some.key`
- *   function removes `some.key.1`, `some.key.2` etc
- * - sets new value under the passed key for primitive types
- * - in case of objects - it flattens them first and then sets all the resulted values
- *   under the path provided in the property argument
- * - it fills value in RecordJSON#populated when selectedRecord is given
- * - finally it invalidates populated for given property
- *
- *
- * @param {string}      property        property that must be updated, supports nesting
- *                                      with dots
- * @param {any}         value           value that must be set, undefined or null if
- *                                      deleting, will be flattened
- * @param {RecordJSON}  selectedRecord  if value is reference ID, this must be a record
- *                                      it's referencing to
- * @private
- */
-export declare const updateRecord: (property: string, value: any, selectedRecord?: RecordJSON) => (previousRecord: RecordJSON) => RecordJSON;
-export default updateRecord;

package/types/src/frontend/hooks/use-record/update-record.spec.d.ts

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

package/types/src/frontend/hooks/use-record/use-record.d.ts

@@ -1,15 +0,0 @@
-import { RecordJSON } from '../../interfaces/index.js';
-import { UseRecordOptions, UseRecordResult } from './use-record.type.js';
-/**
- * @load ./use-record.doc.md
- * @subcategory Hooks
- * @class
- * @hideconstructor
- * @bundle
- * @param {RecordJSON} [initialRecord],
- * @param {string} resourceId
- * @param {UseRecordOptions} [options]
- * @return {UseRecordResult}
- */
-export declare const useRecord: (initialRecord: RecordJSON | undefined, resourceId: string, options?: UseRecordOptions) => UseRecordResult;
-export default useRecord;

package/types/src/frontend/hooks/use-record/use-record.type.d.ts

@@ -1,92 +0,0 @@
-/// <reference types="react" resolution-mode="require"/>
-import { AxiosResponse } from 'axios';
-import { OnPropertyChange } from '../../components/property-type/base-property-props.js';
-import { RecordActionResponse } from '../../../backend/actions/action.interface.js';
-import { RecordJSON } from '../../interfaces/index.js';
-/**
- * Custom options passed to useRecord as the third argument.
- *
- * Example of restricting useRecord to operate only on a finite set of properties:
- *
- * ```javascript
- * const { record, handleChange, submit } = useRecord(initialRecord, resource.id, {
- *   includeParams: ['name', 'surname', 'school.name'],
- * })
- *
- * // handleChange('otherProperty', 'value') wont affect the `record`
- * ```
- *
- * @memberof useRecord
- * @alias UseRecordOptions
- */
-export type UseRecordOptions = {
-    /**
-     * If set, useRecord will operate only on selected params. The rules here will be applied to
-     * both initialRecord params and all the params set by handleChange. It wont be applied to params
-     * set in submit
-     */
-    includeParams?: Array<string>;
-};
-/**
- * Submit function which either creates a record or updates it. By default, after successful
- * execution function updates its inner state with the returned by the backend record. This might
- * not be the need in your case, so you can turn it of by setting `updateOnSave` to false.
- *
- * @memberof useRecord
- * @alias UseRecordSubmitFunction
- * @param {boolean} [options.updateOnSave] Indicates if record should be updated after the
- *                                         submit action, which returns updated record.
- *                                         You might turn this of if you use function like lodash
- *                                         debounce, where you might have old
- *                                         state in the action response.
- */
-export type UseRecordSubmitFunction = (
-/**
- * Any additional parameters you want to be merged to the payload.
- */
-customParams?: Record<string, string>, 
-/**
- * Custom options passed to submit function
- */
-options?: {
-    updateOnSave?: boolean;
-}) => Promise<AxiosResponse<RecordActionResponse>>;
-/**
- * Result of useRecord hook
- *
- * @memberof useRecord
- * @alias UseRecordResult
- */
-export type UseRecordResult = {
-    /**
-     * recordJSON instance for given resource.
-     */
-    record: RecordJSON;
-    /**
-     * Function compatible with onChange method supported by all the components wrapped by
-     * {@link BasePropertyComponent}.
-     */
-    handleChange: OnPropertyChange;
-    /**
-     * Triggers submission of the record. Returns a promise.
-     */
-    submit: UseRecordSubmitFunction;
-    /**
-     * Flag indicates loading.
-     */
-    loading: boolean;
-    /**
-     * Upload progress
-     */
-    progress: number;
-    /**
-     * Sets value for the record from the outside. You might use it when you update the record
-     * simultaneously in an another place.
-     */
-    setRecord: React.Dispatch<React.SetStateAction<RecordJSON>>;
-    /**
-     * Indicates if record is in "synced" state. It is when it was either just created from initial
-     * record or submitted. After at least one handleChange it is false until the successful submit
-     */
-    isSynced: boolean;
-};

package/types/src/frontend/hooks/use-records/index.d.ts

@@ -1,2 +0,0 @@
-export * from './use-records.js';
-export * from './use-records-result.type.js';

package/types/src/frontend/hooks/use-records/use-records-result.type.d.ts

@@ -1,29 +0,0 @@
-import { AxiosResponse } from 'axios';
-import { ListActionResponse } from '../../../backend/index.js';
-import { RecordJSON } from '../../interfaces/index.js';
-/**
- * Result of the {@link useRecords} hook.
- * It is a object containing multiple tools you can use in your component
- * @memberof useRecords
- * @alias UseRecordsResult
- */
-export type UseRecordsResult = {
-    /**
-     * Array of records fetched from the backend
-     */
-    records: Array<RecordJSON>;
-    /** loading state */
-    loading: boolean;
-    /** current page (in pagination) */
-    page: number;
-    /** perPage limit returned by the backend */
-    perPage: number;
-    /** total number of pages in for current query */
-    total: number;
-    /** sort direction */
-    direction: 'asc' | 'desc';
-    /** field used as a sortBy column */
-    sortBy?: string;
-    /** function which triggers fetching the data */
-    fetchData: () => Promise<AxiosResponse<ListActionResponse>>;
-};

package/types/src/frontend/hooks/use-records/use-records.d.ts

@@ -1,14 +0,0 @@
-import { UseRecordsResult } from './use-records-result.type.js';
-/**
- * @load ./use-records.doc.md
- * @subcategory Hooks
- * @class
- * @hideconstructor
- *
- * @param {string} resourceId      id of a resource for which you want to fetch records
- * @return {UseRecordsResult}
- * @bundle
- * @type {Function}
- */
-declare function useRecords(resourceId: string): UseRecordsResult;
-export { useRecords as default, useRecords, };

package/types/src/frontend/hooks/use-resource/index.d.ts

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

package/types/src/frontend/hooks/use-resource/use-resource.d.ts

@@ -1,11 +0,0 @@
-import { ResourceJSON } from '../../interfaces/resource-json.interface.js';
-/**
- * @load ./use-resource.doc.md
- * @subcategory Hooks
- * @class
- * @hideconstructor
- * @bundle
- * @param {string} resourceId    Id of a resource you want to get
- */
-declare const useResource: (resourceId: string) => ResourceJSON | undefined;
-export { useResource as default, useResource, };

package/types/src/frontend/hooks/use-selected-records/index.d.ts

@@ -1,2 +0,0 @@
-export * from './use-selected-records.js';
-export * from './use-selected-records-result.type.js';

package/types/src/frontend/hooks/use-selected-records/use-selected-records-result.type.d.ts

@@ -1,17 +0,0 @@
-import { RecordJSON } from '../../interfaces/index.js';
-/**
- * Result of the {@link useSelectedRecords} hook.
- * It is a object containing multiple tools you can use in your component
- * @memberof useSelectedRecords
- * @alias UseSelectedRecordsResult
- */
-export type UseSelectedRecordsResult = {
-    /** Array of selected records */
-    selectedRecords: Array<RecordJSON>;
-    /** Sets selected records */
-    setSelectedRecords: (records: Array<RecordJSON>) => void;
-    /** handler function for single select action */
-    handleSelect: (record: RecordJSON) => void;
-    /** handler function for `select all records` action */
-    handleSelectAll: () => void;
-};

package/types/src/frontend/hooks/use-selected-records/use-selected-records.d.ts

@@ -1,14 +0,0 @@
-import { RecordJSON } from '../../interfaces/index.js';
-import { UseSelectedRecordsResult } from './use-selected-records-result.type.js';
-/**
- * @load ./use-selected-records.doc.md
- * @subcategory Hooks
- * @class
- * @hideconstructor
- * @param {Array<RecordJSON>} records     List of records on which you can perform `select` action
- * @return {UseSelectedRecordsResult}
- * @bundle
- * @type {Function}
- */
-declare function useSelectedRecords(records: Array<RecordJSON>): UseSelectedRecordsResult;
-export { useSelectedRecords as default, useSelectedRecords, };

package/types/src/frontend/hooks/use-translation.d.ts

@@ -1,51 +0,0 @@
-import { TFunction, i18n } from 'i18next';
-import { TranslateFunctions } from '../../utils/translate-functions.factory.js';
-/**
- * Extends {@link TranslateFunctions}. Apart from that it also returns all the properties
- * defined below.
- *
- * ```javascript
- * import { useTranslation } from 'adminjs'
- *
- * const MyComponent = () => {
- *   const { translateButton } = useTranslation()
- *
- *   return (
- *     <Box>
- *       <Button variant="contained" onClick={...}>{translateButton('save')}<Button>
- *     </Box>
- *   )
- * }
- * ```
- *
- * @memberof useTranslation
- * @alias UseTranslationResponse
- *
- * @property {TranslateFunction} ... All functions defined in {@link TranslateFunctions}
- */
-export type UseTranslationResponse = TranslateFunctions & {
-    t: TFunction;
-    /**
-     * Current i18n instance.
-     */
-    i18n: i18n;
-    /**
-     * Indicates if translation system is ready. In AdminJS it is always ready :).
-     */
-    ready: boolean;
-};
-/**
- * @classdesc
- * Extends the useTranslation hook from react-i18next library.
- *
- * Returns all the {@link TranslateFunctions} + methods returned by the original
- * useTranslation method from react-i18next like: `i18n` instance and `ready` flag.
- *
- * @class
- * @subcategory Hooks
- * @bundle
- * @hideconstructor
- * @returns {UseTranslationResponse}
- */
-export declare const useTranslation: () => UseTranslationResponse;
-export default useTranslation;

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

@@ -1,6 +0,0 @@
-export * from './components/index.js';
-export * from './hoc/index.js';
-export * from './hooks/index.js';
-export * from './interfaces/index.js';
-export * from './store/index.js';
-export * from './utils/index.js';

package/types/src/frontend/interfaces/action/action-has-component.d.ts

@@ -1,3 +0,0 @@
-import { ActionJSON } from './action-json.interface.js';
-export declare const actionHasDisabledComponent: (action: ActionJSON) => boolean;
-export declare const actionHasCustomComponent: (action: ActionJSON) => boolean;

package/types/src/frontend/interfaces/action/action-href.d.ts

@@ -1,3 +0,0 @@
-import { DifferentActionParams } from '../../hooks/index.js';
-import { ActionJSON } from './action-json.interface.js';
-export declare const actionHref: (action: ActionJSON, params: DifferentActionParams) => string | null;

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

@@ -1,84 +0,0 @@
-import type { ButtonProps, IconProps, VariantType } from '@clement_lores/admin-design-system';
-import { ParsedLayoutElement } from '../../../backend/utils/layout-element-parser/index.js';
-/**
- * JSON representation of an {@link Action}
- * @see Action
- * @subcategory Frontend
- */
-export interface ActionJSON {
-    /**
-     * Unique action name
-     */
-    name: string;
-    /**
-     * Type of an action
-     */
-    actionType: 'record' | 'resource' | 'bulk';
-    /**
-     * Action icon
-     */
-    icon?: IconProps['icon'];
-    /**
-     * Action label - visible on the frontend
-     */
-    label: string;
-    /**
-     * Guarding message which should be presented in `alert()` after clicking the action button
-     */
-    guard?: string;
-    /**
-     * If action should have a filter (for resource actions)
-     */
-    showFilter: boolean;
-    /**
-     * If action should have resource actions buttons displayed above action header.
-     *
-     * Defaults to `true`
-     */
-    showResourceActions: boolean;
-    /**
-     * Action component. When set to false action will be invoked immediately after clicking it,
-     * to put in another words: there wont be an action view
-     */
-    component?: string | false | null;
-    /**
-     * Whether given action should be seen in a drawer
-     */
-    showInDrawer: boolean;
-    /**
-     * Whether given action have an action header
-     */
-    hideActionHeader: boolean;
-    /**
-     * containerWidth passed from the action setup.
-     */
-    containerWidth: string | number | Array<string | number>;
-    /**
-     * Id of a resource to which given action belongs.
-     */
-    resourceId: string;
-    /**
-     * Parsed layout passed in {@link Action#layout}
-     */
-    layout: Array<ParsedLayoutElement> | null;
-    /**
-     * Action variant
-     */
-    variant: VariantType;
-    /**
-     * Action color
-     */
-    color?: ButtonProps['color'];
-    /**
-     * If action is nested
-     */
-    parent: string | null;
-    /**
-     * Indicates if action has action handler defined
-     */
-    hasHandler: boolean;
-    /**
-     * Any custom options passed from the {@link Action} configuration.
-     */
-    custom: Record<string, any>;
-}

package/types/src/frontend/interfaces/action/build-action-api-call-trigger.d.ts

@@ -1,12 +0,0 @@
-import { AxiosResponse } from 'axios';
-import { ActionResponse } from '../../../backend/index.js';
-import { DifferentActionParams, useActionResponseHandler } from '../../hooks/index.js';
-import { ActionJSON } from './action-json.interface.js';
-export type CallApiFunction<K extends ActionResponse> = () => Promise<AxiosResponse<K>>;
-export type BuildActionCallApiTriggerOptions = {
-    action: ActionJSON;
-    params: DifferentActionParams;
-    actionResponseHandler: ReturnType<typeof useActionResponseHandler>;
-    search?: Location['search'];
-};
-export declare const buildActionCallApiTrigger: <K extends ActionResponse>(options: BuildActionCallApiTriggerOptions) => CallApiFunction<K>;

package/types/src/frontend/interfaces/action/build-action-click-handler.d.ts

@@ -1,16 +0,0 @@
-import { NavigateFunction, Location } from 'react-router';
-import { DifferentActionParams, useActionResponseHandler } from '../../hooks/index.js';
-import { ActionJSON } from './action-json.interface.js';
-import { TranslateFunctions } from '../../../utils/index.js';
-import { ModalFunctions } from '../modal.interface.js';
-export type BuildActionClickOptions = {
-    action: ActionJSON;
-    params: DifferentActionParams;
-    actionResponseHandler: ReturnType<typeof useActionResponseHandler>;
-    navigate: NavigateFunction;
-    translateFunctions: TranslateFunctions;
-    modalFunctions: ModalFunctions;
-    location?: Location;
-};
-export type BuildActionClickReturn = (event: any) => any | Promise<any>;
-export declare const buildActionClickHandler: (options: BuildActionClickOptions) => BuildActionClickReturn;

package/types/src/frontend/interfaces/action/build-action-test-id.d.ts

@@ -1,2 +0,0 @@
-import { ActionJSON } from './action-json.interface.js';
-export declare const buildActionTestId: (action: ActionJSON) => string;

package/types/src/frontend/interfaces/action/call-action-api.d.ts

@@ -1,5 +0,0 @@
-import { AxiosResponse } from 'axios';
-import { ActionResponse } from '../../../backend/index.js';
-import { DifferentActionParams } from '../../hooks/index.js';
-import { ActionJSON } from './action-json.interface.js';
-export declare function callActionApi<K extends ActionResponse>(action: ActionJSON, params: DifferentActionParams, search?: Location['search']): Promise<AxiosResponse<K>>;

package/types/src/frontend/interfaces/action/index.d.ts

@@ -1,10 +0,0 @@
-export * from './action-has-component.js';
-export * from './action-href.js';
-export * from './action-json.interface.js';
-export * from './build-action-api-call-trigger.js';
-export * from './build-action-test-id.js';
-export * from './build-action-click-handler.js';
-export * from './call-action-api.js';
-export * from './is-bulk-action.js';
-export * from './is-resource-action.js';
-export * from './is-record-action.js';

package/types/src/frontend/interfaces/action/is-bulk-action.d.ts

@@ -1,4 +0,0 @@
-import { BulkActionParams } from '../../../backend/utils/view-helpers/view-helpers.js';
-import { ActionJSON } from '../action/index.js';
-import { DifferentActionParams } from '../../hooks/use-action/use-action.types.js';
-export declare const isBulkAction: (params: DifferentActionParams, action: ActionJSON) => params is BulkActionParams;

package/types/src/frontend/interfaces/action/is-record-action.d.ts

@@ -1,4 +0,0 @@
-import { RecordActionParams } from '../../../backend/utils/view-helpers/view-helpers.js';
-import { ActionJSON } from '../action/index.js';
-import { DifferentActionParams } from '../../hooks/use-action/use-action.types.js';
-export declare const isRecordAction: (params: DifferentActionParams, action: ActionJSON) => params is RecordActionParams;

package/types/src/frontend/interfaces/action/is-resource-action.d.ts

@@ -1,3 +0,0 @@
-import { ActionJSON } from '../action/index.js';
-import { DifferentActionParams } from '../../hooks/use-action/use-action.types.js';
-export declare const isResourceAction: (params: DifferentActionParams, action: ActionJSON) => params is import("../../../backend/utils/view-helpers/view-helpers.js").ActionParams;

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

@@ -1,7 +0,0 @@
-export * from './action/index.js';
-export * from './modal.interface.js';
-export * from './noticeMessage.interface.js';
-export * from './page-json.interface.js';
-export * from './property-json/index.js';
-export * from './record-json.interface.js';
-export * from './resource-json.interface.js';

package/types/src/frontend/interfaces/modal.interface.d.ts

@@ -1,19 +0,0 @@
-import type { ModalProps } from '@clement_lores/admin-design-system';
-import { SHOW_MODAL, HIDE_MODAL } from '../store/index.js';
-export interface ModalData {
-    modalProps: ModalProps;
-    type?: 'alert' | 'confirm';
-    resourceId?: string;
-    confirmAction?: () => void;
-}
-export type ModalFunctions = {
-    openModal: (data: ModalData) => void;
-    closeModal: () => void;
-};
-export type ShowModalResponse = {
-    type: typeof SHOW_MODAL;
-    data: ModalData;
-};
-export type HideModalResponse = {
-    type: typeof HIDE_MODAL;
-};

package/types/src/frontend/interfaces/noticeMessage.interface.d.ts

@@ -1,14 +0,0 @@
-import { type MessageBoxProps } from '@clement_lores/admin-design-system';
-import { type TOptions } from 'i18next';
-import { type ReactNode } from 'react';
-/**
- * NoticeMessage which can be presented as a "Toast" message.
- * @alias NoticeMessage
- */
-export type NoticeMessage = {
-    message: string;
-    type?: MessageBoxProps['variant'] | 'error';
-    options?: TOptions;
-    resourceId?: string;
-    body?: ReactNode;
-};

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

@@ -1,19 +0,0 @@
-import type { IconProps } from '@clement_lores/admin-design-system';
-/**
- * Representing the page in the sidebar
- * @subcategory Frontend
- */
-export interface PageJSON {
-    /**
-     * Page name
-     */
-    name: string;
-    /**
-     * Page component. Bundled with {@link ComponentLoader}
-     */
-    component: string;
-    /**
-     * Page icon
-     */
-    icon?: IconProps['icon'];
-}

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

@@ -1 +0,0 @@
-export * from './property-json.interface.js';