@aristid/leav-types 0.0.7-9ec784a → 0.0.7-a04a265e

package/apps/core/config/default.d.ts

@@ -25,6 +25,14 @@ export declare namespace db {
 export declare namespace diskCache {
     let directory: string;
 }
+export declare namespace dataLoaders {
+    namespace valueRepo {
+        namespace getValues {
+            let enableCache: string | boolean;
+            let useBatch: string | boolean;
+        }
+    }
+}
 export declare namespace auth {
     let scheme: string;
     let key: string;
@@ -41,6 +49,9 @@ export declare namespace auth {
         let wellKnownEndpoint: string;
         let clientId: string;
         let postLogoutRedirectUri: string;
+        let skipLogoutConfirmationPage: string | boolean;
+        let idTokenUserClaim: string;
+        let enableAutoProvisioning: string | boolean;
     }
     let testApiKey: string;
 }
@@ -67,10 +78,13 @@ export declare namespace logs {
     let level: string;
     let transport: string;
     let destinationFile: string;
+    let useJsonFormat: string | boolean;
 }
 export declare namespace permissions {
     let _default_1: boolean;
     export { _default_1 as default };
+    let enableCache_1: string | boolean;
+    export { enableCache_1 as enableCache };
 }
 export declare namespace amqp {
     namespace connOpt {
@@ -166,6 +180,7 @@ export declare namespace _import {
     export let sizeLimit: string | number;
     export let groupData: string | number;
     export let maxStackedElements: string | number;
+    export let delayTaskExecMs: string | number;
 }
 export declare namespace preview {
     let directory_3: string;
@@ -186,5 +201,5 @@ export declare namespace elasticSearch {
     let url_1: string;
     export { url_1 as url };
 }
-export declare let pluginsPath: string;
+export declare let pluginsPath: string | any[];
 export { _export as export, _import as import };

package/apps/core/config/development.d.ts

@@ -1,5 +1,6 @@
 export namespace server {
     let publicUrl: string;
+    let allowIntrospection: boolean;
 }
 export namespace logs {
     let level: string;

package/apps/core/config/test.d.ts

@@ -6,6 +6,7 @@ export namespace server {
         let password: string;
         let email: string;
     }
+    let allowIntrospection: boolean;
 }
 export namespace db {
     let name: string;
@@ -50,3 +51,4 @@ export let debug: boolean;
 export namespace redis {
     let database: number;
 }
+export let pluginsPath: string[];

package/apps/core/src/__tests__/e2e/api/e2eUtils.d.ts

@@ -20,6 +20,7 @@ export declare function gqlSaveAttribute(params: {
     multipleValues?: boolean;
     reverseLink?: string;
     actionsList?: ActionsListConfig;
+    required?: boolean;
 }): Promise<any>;
 export declare function gqlSaveTree(id: string, label: string, libraries: string[]): Promise<any>;
 export declare function gqlCreateRecord(library: string): Promise<string>;

package/apps/core/src/__tests__/e2e/api/getConditionPart/getConditionPart.test.d.ts

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

package/apps/core/src/__tests__/e2e/api/globalSetup.d.ts

@@ -1,3 +1,8 @@
+import { AwilixContainer } from 'awilix';
 import { IConfig } from '../../../_types/config';
-export declare const init: (conf: IConfig) => Promise<any>;
+import { IDbUtils } from 'infra/db/dbUtils';
+export declare const init: (conf: IConfig) => Promise<{
+    coreContainer: AwilixContainer;
+    dbUtils: IDbUtils;
+}>;
 export declare function setup(): Promise<void>;

package/apps/core/src/__tests__/e2e/api/joinLibraries/joinLibraries.test.d.ts

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

package/apps/core/src/__tests__/integration/globalSetup.d.ts

@@ -0,0 +1 @@
+export declare function setup(): Promise<void>;

package/apps/core/src/__tests__/integration/globalSetupHook.d.ts

@@ -0,0 +1 @@
+export default function (): Promise<any>;

package/apps/core/src/__tests__/integration/infra/attributeAdvancedLinkRepo.test.d.ts

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

package/apps/core/src/__tests__/integration/infra/attributeAdvancedRepo.test.d.ts

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

package/apps/core/src/__tests__/integration/infra/attributeSimpleLinkRepo.test.d.ts

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

package/apps/core/src/__tests__/integration/infra/attributeSimpleRepo.test.d.ts

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

package/apps/core/src/__tests__/integration/infra/attributeTreeRepo.test.d.ts

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

package/apps/core/src/__tests__/integration/infra/integrationTestRepoUtils.d.ts

@@ -0,0 +1,7 @@
+import { ILibraryRepo } from 'infra/library/libraryRepo';
+import { IRecordRepo } from 'infra/record/recordRepo';
+import { ITreeRepo } from 'infra/tree/treeRepo';
+export declare const getCoreDep: <T>(path: any) => T;
+export declare const getLibraryRepo: () => ILibraryRepo;
+export declare const getRecordRepo: () => IRecordRepo;
+export declare const getTreeRepo: () => ITreeRepo;

package/apps/core/src/__tests__/integration/infra/recordRepo.test.d.ts

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

package/apps/core/src/__tests__/integration/infra/treeRepo.test.d.ts

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

package/apps/core/src/__tests__/integration/teardown.d.ts

@@ -0,0 +1 @@
+export default function (): Promise<void>;

package/apps/core/src/__tests__/mockers/amqp.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    consumer: {
+        channel: {
+            ack: jest.Mock<any, any>;
+        };
+    };
+};
+export default _default;

package/apps/core/src/__tests__/mockers/logger.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    info: jest.Mock<any, any>;
+    warn: jest.Mock<any, any>;
+    error: jest.Mock<any, any>;
+    debug: jest.Mock<any, any>;
+};
+export default _default;

package/apps/core/src/__tests__/mocks/attribute.d.ts

@@ -1,5 +1,6 @@
-import { AttributeFormats, AttributeTypes, IAttribute } from '../../_types/attribute';
+import { AttributeFormats, AttributeTypes, MultiLinkDisplayOption, IAttribute } from '../../_types/attribute';
 export declare const mockAttrSimple: IAttribute;
+export declare const mockUniqueAttrSimple: IAttribute;
 export declare const mockAttrId: IAttribute;
 export declare const mockAttrAdv: IAttribute;
 export declare const mockAttrAdvMultiVal: IAttribute;
@@ -16,6 +17,7 @@ export declare const mockAttrTree: {
     system?: boolean;
     readonly?: boolean;
     required?: boolean;
+    character_limit?: number;
     format?: AttributeFormats;
     linked_library?: string;
     embedded_fields?: import("../../_types/attribute").IEmbeddedAttribute[];
@@ -27,8 +29,9 @@ export declare const mockAttrTree: {
     values_list?: import("../../_types/attribute").IValuesListConf;
     reverse_link?: string | IAttribute;
     unique?: boolean;
-    maxLength?: number;
     description?: import("../../_types/systemTranslation").ISystemTranslation;
+    settings?: import("../../_types/shared").IKeyValue<any>;
+    multi_link_display_option?: MultiLinkDisplayOption;
     label?: import("../../_types/systemTranslation").ISystemTranslation | string;
 };
 export declare const mockAttrTreeVersionable: IAttribute;

package/apps/core/src/__tests__/mocks/cache.d.ts

@@ -0,0 +1,4 @@
+import { Mockify } from '@leav/utils';
+import { ICacheService, ICachesService } from '../../infra/cache/cacheService';
+export declare const mockCacheService: Mockify<ICacheService>;
+export declare const mockCachesService: Mockify<ICachesService>;

package/apps/core/src/_constants/attributes.d.ts

@@ -0,0 +1 @@
+export declare const baseAttributes: string[];

package/apps/core/src/_types/attribute.d.ts

@@ -1,7 +1,7 @@
 import { ActionsListEvents, ActionsListIOTypes, ActionsListConfig } from './actionsList';
 import { ITreePermissionsConf } from './permissions';
 import { IRecord } from './record';
-import { IGetCoreEntitiesParams } from './shared';
+import { IGetCoreEntitiesParams, IKeyValue } from './shared';
 import { ISystemTranslation } from './systemTranslation';
 import { ITreeElement } from './tree';
 import { IDateRangeValue } from './value';
@@ -9,6 +9,7 @@ export interface IAttribute extends ICoreEntity {
     system?: boolean;
     readonly?: boolean;
     required?: boolean;
+    character_limit?: number;
     type: AttributeTypes;
     format?: AttributeFormats;
     linked_library?: string;
@@ -22,8 +23,9 @@ export interface IAttribute extends ICoreEntity {
     values_list?: IValuesListConf;
     reverse_link?: string | IAttribute;
     unique?: boolean;
-    maxLength?: number;
     description?: ISystemTranslation;
+    settings?: IKeyValue<any>;
+    multi_link_display_option?: MultiLinkDisplayOption;
 }
 export declare enum ValueVersionMode {
     SIMPLE = "simple",
@@ -87,6 +89,11 @@ export declare enum AttributeFormats {
     COLOR = "color",
     RICH_TEXT = "rich_text"
 }
+export declare enum MultiLinkDisplayOption {
+    AVATAR = "avatar",
+    TAG = "tag",
+    BADGE_QTY = "badge_qty"
+}
 export declare enum IOTypes {
     STRING = "string",
     NUMBER = "number",

package/apps/core/src/_types/config.d.ts

@@ -5,6 +5,7 @@ export interface IConfig {
     server: IServer;
     db: IDb;
     diskCache: IDiskCache;
+    dataLoaders: IDataLoaders;
     auth: IAuth;
     mailer: IMailer;
     lang: ILang;
@@ -28,7 +29,7 @@ export interface IConfig {
     dbProfiler: IDbProfilerConfig;
     instanceId: string;
     elasticSearch: IElasticSearchConfig;
-    pluginsPath: string;
+    pluginsPath: string[];
 }
 export declare enum CoreMode {
     SERVER = "server",
@@ -36,7 +37,8 @@ export declare enum CoreMode {
     FILES_MANAGER = "filesManager",
     INDEXATION_MANAGER = "indexationManager",
     TASKS_MANAGER_MASTER = "tasksManager:master",
-    TASKS_MANAGER_WORKER = "tasksManager:worker"
+    TASKS_MANAGER_WORKER = "tasksManager:worker",
+    CLI = "cli"
 }
 export interface IServer {
     host: string;
@@ -75,11 +77,16 @@ export interface IAuth {
         wellKnownEndpoint?: string;
         clientId?: string;
         postLogoutRedirectUri?: string;
+        skipLogoutConfirmationPage?: boolean;
+        idTokenUserClaim?: string;
     } | {
         enable: true;
         wellKnownEndpoint: string;
         clientId: string;
         postLogoutRedirectUri: string;
+        skipLogoutConfirmationPage?: boolean;
+        idTokenUserClaim: string;
+        enableAutoProvisioning: boolean;
     };
     testApiKey?: string;
 }
@@ -103,6 +110,7 @@ export interface ILogs {
 }
 export interface IPermissions {
     default: boolean;
+    enableCache: boolean;
 }
 export interface IAmqp {
     connOpt: Options.Connect;
@@ -171,6 +179,35 @@ export interface IImport {
     sizeLimit: number;
     groupData: number;
     maxStackedElements: number;
+    /**
+     * Hack for leav deploy on nfs which is asynchronous for file write (by default)
+     * Wait this delay before submitting import data job
+     */
+    delayTaskExecMs: number;
+}
+/**
+ * Data loaders configuration for performances
+ */
+export interface IDataLoaders {
+    valueRepo: {
+        getValues: {
+            /**
+             * @default false
+             *
+             * Enable cache inside data loaders in the query context
+             * Before enable, ensure that it has no side effects, for instance on saveValue/deleteValue mutations
+             */
+            enableCache: boolean;
+            /**
+             * @default true
+             *
+             * Enable: do batch arangodb query
+             * Disable: do one arangodb query per value, as before data loader use. For rollback if issue with batch query
+             * Temporary, to be removed in future
+             */
+            useBatch: boolean;
+        };
+    };
 }
 export interface IDiskCache {
     directory: string;

package/apps/core/src/_types/dbProfiler.d.ts

@@ -2,7 +2,26 @@ import { AqlQuery } from 'arangojs/aql';
 export interface IDbProfilerQuery {
     count: number;
     query: string | AqlQuery;
-    callers: Set<string>;
+    callers: Record<string, {
+        /**
+         * Stacktrace of caller
+         */
+        stack: string;
+        count: number;
+        /**
+         * Stats for each call for that query
+         */
+        stats: Array<{
+            /**
+             * Arangodb query execution time in ms
+             */
+            executionTimeMs: number | null;
+            /**
+             * Time spent in nodejs to process the query in ms
+             */
+            nodejsTimeMs: number;
+        }>;
+    }>;
 }
 export interface IDbProfiler {
     totalCount: number;

package/apps/core/src/_types/errors.d.ts

@@ -63,6 +63,7 @@ export declare enum Errors {
     PREVIEWS_SETTINGS_NOT_ALLOWED = "PREVIEWS_SETTINGS_NOT_ALLOWED",
     PROTECTED_ENDPOINT = "PROTECTED_ENDPOINT",
     READONLY_ATTRIBUTE = "READONLY_ATTRIBUTE",
+    RECORD_ACTIVATION_FAILED = "RECORD_ACTIVATION_FAILED",
     REQUIRED_ATTRIBUTE = "REQUIRED_ATTRIBUTE",
     REQUIRED_ATTRIBUTE_FORMAT = "REQUIRED_ATTRIBUTE_FORMAT",
     REQUIRED_ATTRIBUTE_LABEL = "REQUIRED_ATTRIBUTE_LABEL",
@@ -97,7 +98,8 @@ export declare enum Errors {
     UNKNOWN_VERSION_TREE = "UNKNOWN_VERSION_TREE",
     UNKNOWN_VIEW = "UNKNOWN_VIEW",
     USER_IS_NOT_VIEW_OWNER = "USER_IS_NOT_VIEW_OWNER",
-    VALUE_NOT_UNIQUE = "VALUE_NOT_UNIQUE"
+    VALUE_NOT_UNIQUE = "VALUE_NOT_UNIQUE",
+    VALUE_EXCEEDS_CHARACTER_LIMIT = "VALUE_EXCEEDS_CHARACTER_LIMIT"
 }
 export interface IExtendedErrorMsg {
     msg: Errors | string;

package/apps/core/src/_types/events.d.ts

@@ -0,0 +1,45 @@
+import { EventAction, IDbPayload } from '@leav/utils';
+import { IApiKey } from './apiKey';
+import { IApplication } from './application';
+import { IAttribute } from './attribute';
+import { IGlobalSettings } from './globalSettings';
+import { ILibraryDbEvent } from './library';
+import { IRecord } from './record';
+import { IValue } from './value';
+import { IVersionProfile } from './versionProfile';
+import { IPermission } from './permissions';
+import { ITree } from './tree';
+/**
+ * Maybe move all DBPayloadData types in @leav/utils type to allow event consumers outside core to use them
+ * without having to redeclare them. For now before and after are any in @leav/utils
+ */
+export interface IDbPayloadInternal<DBPayloadAction extends EventAction> extends IDbPayload {
+    action: DBPayloadAction;
+    before?: IDBPayloadData<DBPayloadAction>;
+    after?: IDBPayloadData<DBPayloadAction>;
+}
+interface IDBPayloadDataMap {
+    [EventAction.VALUE_SAVE]: IValue;
+    [EventAction.VALUE_DELETE]: IValue;
+    [EventAction.ATTRIBUTE_SAVE]: IAttribute;
+    [EventAction.ATTRIBUTE_DELETE]: IAttribute;
+    [EventAction.RECORD_SAVE]: IRecord;
+    [EventAction.RECORD_DELETE]: IRecord;
+    [EventAction.API_KEY_SAVE]: IApiKey;
+    [EventAction.API_KEY_DELETE]: IApiKey;
+    [EventAction.APP_SAVE]: IApplication;
+    [EventAction.APP_DELETE]: IApplication;
+    [EventAction.GLOBAL_SETTINGS_SAVE]: IGlobalSettings;
+    [EventAction.LIBRARY_SAVE]: ILibraryDbEvent;
+    [EventAction.LIBRARY_DELETE]: ILibraryDbEvent;
+    [EventAction.VERSION_PROFILE_SAVE]: IVersionProfile;
+    [EventAction.VERSION_PROFILE_DELETE]: IVersionProfile;
+    [EventAction.TREE_ADD_ELEMENT]: string;
+    [EventAction.TREE_DELETE_ELEMENT]: string;
+    [EventAction.TREE_MOVE_ELEMENT]: string;
+    [EventAction.TREE_SAVE]: ITree;
+    [EventAction.TREE_DELETE]: ITree;
+    [EventAction.PERMISSION_SAVE]: IPermission;
+}
+type IDBPayloadData<DBPayloadAction extends EventAction> = DBPayloadAction extends keyof IDBPayloadDataMap ? IDBPayloadDataMap[DBPayloadAction] : never;
+export {};

package/apps/core/src/_types/forms.d.ts

@@ -1,3 +1,4 @@
+import { IAttribute } from './attribute';
 import { IKeyValue } from './shared';
 import { IValue } from './value';
 export interface IForm extends ICoreEntity {
@@ -5,6 +6,11 @@ export interface IForm extends ICoreEntity {
     system?: boolean;
     dependencyAttributes?: string[];
     elements?: IFormDependentElements[];
+    sidePanel: IFormSidePanel;
+}
+export interface IFormSidePanel {
+    enable: boolean;
+    isOpenByDefault: boolean;
 }
 export interface IRecordForm {
     id: string;
@@ -13,6 +19,7 @@ export interface IRecordForm {
     recordId: string;
     dependencyAttributes?: string[];
     elements: IFormElementWithValues[];
+    sidePanel: IFormSidePanel;
 }
 export declare enum FormElementTypes {
     field = "field",
@@ -48,3 +55,6 @@ export type IFormElementWithValuesAndChildren = IFormElementWithValues & {
 export interface IFormFilterOptions extends ICoreEntityFilterOptions {
     library?: string;
 }
+export interface IFormElementJoinLibraryContext {
+    mandatoryAttribute: IAttribute;
+}

package/apps/core/src/_types/globalSettings.d.ts

@@ -1,3 +1,4 @@
+import { IKeyValue } from './shared';
 export interface IGlobalSettings {
     defaultApp: string;
     name: string;
@@ -9,4 +10,5 @@ export interface IGlobalSettings {
         library: string;
         recordId: string;
     };
+    settings?: IKeyValue<any>;
 }

package/apps/core/src/_types/library.d.ts

@@ -3,9 +3,11 @@ import { IPreviewVersion } from './filesManager';
 import { ITreePermissionsConf } from './permissions';
 import { IRecordIdentityConf } from './record';
 import { ISystemTranslation } from './systemTranslation';
+import { IKeyValue } from './shared';
 export interface ILibrary extends ICoreEntity {
     system?: boolean;
     behavior?: LibraryBehavior;
+    mandatoryAttribute?: string;
     /**
      * List of attributes usable in this library
      */
@@ -31,6 +33,14 @@ export interface ILibrary extends ICoreEntity {
         recordId: string;
     };
     previewsSettings?: ILibraryPreviewsSettings[];
+    settings?: IKeyValue<any>;
+}
+/**
+ * Library as stored in the DB, without embedded attributes
+ */
+export interface ILibraryDbEvent extends Omit<ILibrary, 'attributes' | 'fullTextAttributes'> {
+    attributes?: string[];
+    fullTextAttributes?: string[];
 }
 export interface ILibraryFilterOptions extends ICoreEntityFilterOptions {
     system?: boolean;
@@ -43,8 +53,9 @@ export interface ILibraryPreviewsSettings {
 }
 export declare enum LibraryBehavior {
     STANDARD = "standard",
+    DIRECTORIES = "directories",
     FILES = "files",
-    DIRECTORIES = "directories"
+    JOIN = "join"
 }
 export declare const USERS_LIBRARY = "users";
 export declare const USERS_GROUPS_LIBRARY = "users_groups";

package/apps/core/src/_types/permissions.d.ts

@@ -76,7 +76,9 @@ export declare enum AdminPermissionsActions {
     CREATE_API_KEY = "admin_create_api_key",
     EDIT_API_KEY = "admin_edit_api_key",
     DELETE_API_KEY = "admin_delete_api_key",
-    EDIT_GLOBAL_SETTINGS = "admin_edit_global_settings"
+    EDIT_GLOBAL_SETTINGS = "admin_edit_global_settings",
+    ACCESS_LOGS = "admin_access_logs",
+    IMPORT_CONFIG_CLEAR_DATABASE = "admin_import_config_clear_database"
 }
 export type PermissionsActions = LibraryPermissionsActions | RecordPermissionsActions | RecordAttributePermissionsActions | AdminPermissionsActions | AttributePermissionsActions | TreePermissionsActions | TreeNodePermissionsActions | ApplicationPermissionsActions;
 export interface ILabeledPermissionsAction {

package/apps/core/src/_types/queryInfos.d.ts

@@ -1,16 +1,21 @@
+import DataLoader from 'dataloader';
 import type LeavError from 'errors/LeavError';
 import { IDbProfiler } from './dbProfiler';
 import { IValueVersion } from './value';
 export interface IQueryInfos {
     userId: string;
+    groupsId?: string[];
     lang?: string;
     defaultLang?: string;
     queryId?: string;
     version?: IValueVersion;
     treeId?: string;
-    groupsId?: string[];
     applicationId?: string;
     dbProfiler?: IDbProfiler;
     trigger?: string;
     errors?: Array<LeavError<unknown>>;
+    /**
+     * For request duration store dataloader on demand with getOrCreateDataLoaderInCtx
+     */
+    dataLoaders?: Record<string, DataLoader<unknown, unknown>>;
 }

package/apps/core/src/_types/record.d.ts

@@ -75,10 +75,10 @@ export interface IQueryField {
 export interface IRecordIdentity {
     id: string;
     library: ILibrary;
-    label?: string;
-    subLabel?: string;
-    color?: string;
-    preview?: IPreview;
+    getLabel?: () => Promise<string | null>;
+    getSubLabel?: () => Promise<string | null>;
+    getColor?: () => Promise<string | null>;
+    getPreview?: () => Promise<IPreview | null>;
 }
 export interface IRecordIdentityConf {
     label?: string;

package/apps/core/src/_types/tree.d.ts

@@ -11,6 +11,7 @@ export interface ITree extends ICoreEntity {
     behavior?: TreeBehavior;
     system?: boolean;
     permissions_conf?: ITreeNodePermissionsConf;
+    settings?: IKeyValue<any>;
 }
 export interface ITreeFilterOptions extends ICoreEntityFilterOptions {
     system?: boolean;
@@ -37,7 +38,7 @@ export type ITreeNodeLight = Pick<ITreeNode, 'id' | 'order'>;
 export interface ITreeNodeWithTreeId extends ITreeNode {
     treeId: string;
 }
-export type TreePaths = ITreeNode[];
+export type TreePath = ITreeNode[];
 export declare enum TreeBehavior {
     STANDARD = "standard",
     FILES = "files"