@aristid/leav-types 0.0.7 → 1.0.0-7bbc7ed2

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

@@ -0,0 +1,11 @@
+export declare const mockApiKey: {
+    id: string;
+    label: string;
+    key: string;
+    createdAt: number;
+    createdBy: string;
+    modifiedAt: number;
+    modifiedBy: string;
+    expiresAt: number;
+    userId: string;
+};

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

@@ -0,0 +1,3 @@
+import { IApplication } from '../../_types/application';
+export declare const mockApplication: MandatoryId<IApplication>;
+export declare const mockApplicationExternal: IApplication;

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

@@ -0,0 +1,41 @@
+import { AttributeFormats, AttributeTypes, MultiDisplayOption, 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;
+export declare const mockAttrAdvVersionable: IAttribute;
+export declare const mockAttrAdvVersionableSimple: IAttribute;
+export declare const mockAttrAdvWithMetadata: IAttribute;
+export declare const mockAttrSimpleLink: IAttribute;
+export declare const mockAttrAdvLink: IAttribute;
+export declare const mockAttrAdvLinkMultiVal: IAttribute;
+export declare const mockAttrTree: {
+    id: string;
+    type: AttributeTypes.TREE;
+    linked_tree: string;
+    system?: boolean;
+    readonly?: boolean;
+    required?: boolean;
+    character_limit?: number;
+    format?: AttributeFormats;
+    linked_library?: string;
+    embedded_fields?: import("../../_types/attribute").IEmbeddedAttribute[];
+    actions_list?: import("../../_types/actionsList").ActionsListConfig;
+    permissions_conf?: import("../../_types/permissions").ITreePermissionsConf;
+    multiple_values?: boolean;
+    versions_conf?: import("../../_types/attribute").IAttributeVersionsConf;
+    metadata_fields?: string[];
+    values_list?: import("../../_types/attribute").IValuesListConf;
+    reverse_link?: string | IAttribute;
+    unique?: boolean;
+    description?: import("../../_types/systemTranslation").ISystemTranslation;
+    settings?: import("../../_types/shared").IKeyValue<any>;
+    multi_link_display_option?: MultiDisplayOption;
+    multi_tree_display_option?: MultiDisplayOption;
+    label?: import("../../_types/systemTranslation").ISystemTranslation | string;
+};
+export declare const mockAttrTreeVersionable: IAttribute;
+export declare const mockAttrTreeVersionableSimple: IAttribute;
+export declare const mockAttrTreeMultival: IAttribute;
+export declare const dateRangeAttributeMock: 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/__tests__/mocks/file.d.ts

@@ -0,0 +1,29 @@
+import { IFileMetadata } from '../../_types/filesManager';
+export declare const mockFileMetadataRaw: {
+    MIMEType: string;
+    XResolution: number;
+    ImageWidth: number;
+    ExifImageWidth: number;
+    ImageHeight: number;
+    ExifImageHeight: number;
+    ColorMode: string;
+    ColorSpace: string;
+    FileSize: number;
+    ClippingPathName: string;
+    ICCProfileName: string;
+};
+export declare const mockFileMetadata: IFileMetadata;
+export declare const mockFileMetadataPdfRaw: {
+    MIMEType: string;
+    XResolution: number;
+    ImageWidth: any;
+    ExifImageWidth: any;
+    ImageHeight: any;
+    ExifImageHeight: any;
+    ColorMode: any;
+    ColorSpace: any;
+    FileSize: number;
+    ClippingPathName: string;
+    ICCProfileName: any;
+};
+export declare const mockFileMetadataPdf: IFileMetadata;

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

@@ -0,0 +1,4 @@
+import { IFormElement, IFormStrict } from '../../_types/forms';
+export declare const formField: IFormElement;
+export declare const formLayoutElement: IFormElement;
+export declare const mockForm: IFormStrict;

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

@@ -0,0 +1,2 @@
+import { IGlobalSettings } from '_types/globalSettings';
+export declare const mockGlobalSettings: IGlobalSettings;

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

@@ -0,0 +1,4 @@
+import { ILibrary } from '_types/library';
+export declare const mockLibrary: ILibrary;
+export declare const mockLibraryFiles: ILibrary;
+export declare const mockLibraryDirectories: MandatoryId<ILibrary>;

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

@@ -0,0 +1,2 @@
+import { Log } from '@leav/utils';
+export declare const mockLog: Log;

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

@@ -0,0 +1,2 @@
+import { IPluginInfos } from '_types/plugin';
+export declare const mockPlugin: IPluginInfos;

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

@@ -0,0 +1,3 @@
+import { IRecord } from '_types/record';
+export declare const mockRecord: IRecord;
+export declare const mockFileRecord: IRecord;

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

@@ -0,0 +1,2 @@
+import { IQueryInfos } from '_types/queryInfos';
+export declare const mockCtx: IQueryInfos;

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

@@ -0,0 +1,2 @@
+import { ITask } from '../../_types/tasksManager';
+export declare const mockTask: ITask;

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

@@ -0,0 +1,3 @@
+import { i18n } from 'i18next';
+export declare const mockTranslator: Mockify<i18n>;
+export declare const mockTranslatorWithOptions: Mockify<i18n>;

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

@@ -0,0 +1,3 @@
+import { ITree } from '../../_types/tree';
+export declare const mockTree: MandatoryId<ITree>;
+export declare const mockFilesTree: ITree;

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

@@ -0,0 +1,2 @@
+import { IStandardValue } from '_types/value';
+export declare const mockStandardValue: IStandardValue;

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

@@ -0,0 +1,2 @@
+import { IVersionProfile } from '_types/versionProfile';
+export declare const mockVersionProfile: IVersionProfile;

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

@@ -0,0 +1,3 @@
+import { IView } from '../../_types/views';
+export declare const mockViewBeforeCreation: IView;
+export declare const mockView: MandatoryId<IView>;

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

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

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

@@ -0,0 +1,2 @@
+export declare const APP_DEFAULT_NAME = "LEAV Engine";
+export declare const DEFAULT_APPLICATION = "portal";

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

@@ -0,0 +1 @@
+export declare const usersLibraryId = "users";

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

@@ -0,0 +1,4 @@
+export declare const adminsGroupId = "1";
+export declare const filesAdminsGroupId = "2";
+export declare const adminUserId = "1";
+export declare const systemUserId = "2";

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

@@ -0,0 +1,78 @@
+import { IQueryInfos } from '_types/queryInfos';
+import { IAttribute } from './attribute';
+import { ISystemTranslation } from './systemTranslation';
+import { IValue } from './value';
+import { Errors } from './errors';
+export declare enum ActionsListEvents {
+    SAVE_VALUE = "saveValue",
+    DELETE_VALUE = "deleteValue",
+    GET_VALUE = "getValue"
+}
+export declare enum ActionsListIOTypes {
+    STRING = "string",
+    NUMBER = "number",
+    OBJECT = "object",
+    BOOLEAN = "boolean"
+}
+export type ActionsListValueType = string | number | boolean | {};
+export type ActionsListConfig = {
+    [Event in ActionsListEvents]?: IActionsListSavedAction[];
+};
+export interface IActionsListContext extends IQueryInfos {
+    attribute?: IAttribute;
+    library?: string;
+    recordId?: string;
+}
+export type ActionsListParams<T extends string | number | symbol> = Record<T, any>;
+export type ActionsListParamsConfig<ParamsRequired extends Record<string, boolean>> = {
+    [Name in keyof ParamsRequired]: {
+        name: Name;
+        type: 'boolean' | 'string' | 'number';
+        description: string;
+        required: ParamsRequired[Name];
+        helper_value: string;
+    };
+}[keyof ParamsRequired];
+export interface IActionsListFunctionResult {
+    values: IValue[];
+    errors: Array<{
+        errorType: Errors;
+        attributeValue: IValue;
+        message?: string;
+    }>;
+}
+type PartialByCondition<TargetType, RequiredValues extends Record<keyof TargetType, boolean>> = {
+    [FieldName in keyof TargetType as RequiredValues[FieldName] extends true ? FieldName : never]: TargetType[FieldName];
+} & {
+    [FieldName in keyof TargetType as RequiredValues[FieldName] extends false ? FieldName : never]?: TargetType[FieldName];
+};
+/**
+ * @types ParamsRequired is record of params key with matching boolean for required option: `{ paramName: isRequired }`
+ */
+export interface IActionsListFunction<ParamsRequired extends Record<string | number | symbol, boolean> = Record<string | number | symbol, boolean>> {
+    id: string;
+    name: string;
+    description: string;
+    input_types: ActionsListIOTypes[];
+    output_types: ActionsListIOTypes[];
+    params?: Array<ActionsListParamsConfig<ParamsRequired>>;
+    error_message?: ISystemTranslation;
+    compute: boolean;
+    action: (values: IValue[], params: PartialByCondition<ActionsListParams<keyof ParamsRequired>, ParamsRequired>, ctx: IActionsListContext) => IActionsListFunctionResult | Promise<IActionsListFunctionResult>;
+}
+export interface IActionsListSavedAction {
+    id: string;
+    name: string;
+    is_system?: boolean;
+    params?: Array<{
+        name: string;
+        value: string;
+    }>;
+    error_message?: ISystemTranslation;
+}
+export interface IRunActionsListCtx extends IQueryInfos {
+    attribute?: IAttribute;
+    recordId?: string;
+    library?: string;
+}
+export {};

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

@@ -0,0 +1,23 @@
+import { IGetCoreEntitiesParams } from './shared';
+export interface IApiKey {
+    id?: string;
+    label: string;
+    key?: string;
+    createdAt?: number;
+    createdBy?: string;
+    modifiedAt?: number;
+    modifiedBy?: string;
+    expiresAt: number;
+    userId: string;
+}
+/**
+ * Accepted fields to filter api keys list
+ */
+export interface IApiKeyFilterOptions extends Omit<ICoreEntityFilterOptions, 'system'> {
+    userId?: string;
+    createdBy?: string;
+    modifiedBy?: string;
+}
+export interface IGetCoreApiKeysParams extends IGetCoreEntitiesParams {
+    filters?: IApiKeyFilterOptions;
+}

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

@@ -0,0 +1,46 @@
+import { IRecord } from './record';
+import { IGetCoreEntitiesParams, IKeyValue } from './shared';
+import { ISystemTranslation } from './systemTranslation';
+export declare const APPS_URL_PREFIX = "app";
+export declare enum ApplicationTypes {
+    INTERNAL = "internal",
+    EXTERNAL = "external"
+}
+export interface IApplication extends ICoreEntity {
+    system?: boolean;
+    description: ISystemTranslation;
+    type: ApplicationTypes;
+    color?: string;
+    icon?: IRecord;
+    module: string;
+    endpoint: string;
+    settings?: IKeyValue<any>;
+}
+/**
+ * Accepted fields to filter attributes list
+ */
+export interface IApplicationFilterOptions extends ICoreEntityFilterOptions {
+    endpoint?: string;
+    component?: string;
+    color?: string;
+}
+export interface IGetCoreApplicationsParams extends IGetCoreEntitiesParams {
+    filters?: IApplicationFilterOptions;
+}
+export interface IApplicationModule {
+    id: string;
+    description: string;
+    version: string;
+}
+export declare enum ApplicationEventTypes {
+    SAVE = "SAVE",
+    DELETE = "DELETE"
+}
+export interface IApplicationEvent {
+    type: ApplicationEventTypes;
+    application: IApplication;
+}
+export interface IApplicationEventFilters {
+    applicationId: string;
+    events: ApplicationEventTypes[];
+}

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

@@ -0,0 +1,103 @@
+import { ActionsListEvents, ActionsListIOTypes, ActionsListConfig } from './actionsList';
+import { ITreePermissionsConf } from './permissions';
+import { IRecord } from './record';
+import { IGetCoreEntitiesParams, IKeyValue } from './shared';
+import { ISystemTranslation } from './systemTranslation';
+import { ITreeElement } from './tree';
+import { IDateRangeValue } from './value';
+export interface IAttribute extends ICoreEntity {
+    system?: boolean;
+    readonly?: boolean;
+    required?: boolean;
+    character_limit?: number;
+    type: AttributeTypes;
+    format?: AttributeFormats;
+    linked_library?: string;
+    linked_tree?: string;
+    embedded_fields?: IEmbeddedAttribute[];
+    actions_list?: ActionsListConfig;
+    permissions_conf?: ITreePermissionsConf;
+    multiple_values?: boolean;
+    versions_conf?: IAttributeVersionsConf;
+    metadata_fields?: string[];
+    values_list?: IValuesListConf;
+    reverse_link?: string | IAttribute;
+    unique?: boolean;
+    description?: ISystemTranslation;
+    settings?: IKeyValue<any>;
+    multi_link_display_option?: MultiDisplayOption;
+    multi_tree_display_option?: MultiDisplayOption;
+}
+export declare enum ValueVersionMode {
+    SIMPLE = "simple",
+    SMART = "smart"
+}
+export interface IAttributeVersionsConf {
+    versionable: boolean;
+    mode?: ValueVersionMode;
+    profile?: string;
+}
+export interface IEmbeddedAttribute {
+    id: string;
+    label?: ISystemTranslation;
+    description?: ISystemTranslation;
+    format?: AttributeFormats;
+    validation_regex?: string;
+    embedded_fields?: IEmbeddedAttribute[];
+}
+/**
+ * Accepted fields to filter attributes list
+ */
+export interface IAttributeFilterOptions extends ICoreEntityFilterOptions {
+    type?: AttributeTypes[];
+    format?: AttributeFormats[];
+    system?: boolean;
+    linked_library?: string;
+    linked_tree?: string;
+    multiple_values?: boolean;
+    libraries?: string[];
+    librariesExcluded?: string[];
+    versionable?: boolean;
+    metadata_fields?: string[];
+}
+export interface IGetCoreAttributesParams extends IGetCoreEntitiesParams {
+    filters?: IAttributeFilterOptions;
+}
+export interface IValuesListConf {
+    enable: boolean;
+    values?: string[] | IDateRangeValue[] | IRecord[] | ITreeElement[];
+    allowFreeEntry?: boolean;
+    allowListUpdate?: boolean;
+}
+export type IOAllowedTypes = {
+    [eventName in ActionsListEvents]: ActionsListIOTypes[];
+};
+export declare enum AttributeTypes {
+    SIMPLE = "simple",
+    SIMPLE_LINK = "simple_link",
+    ADVANCED = "advanced",
+    ADVANCED_LINK = "advanced_link",
+    TREE = "tree"
+}
+export declare enum AttributeFormats {
+    TEXT = "text",
+    NUMERIC = "numeric",
+    DATE = "date",
+    DATE_RANGE = "date_range",
+    ENCRYPTED = "encrypted",
+    BOOLEAN = "boolean",
+    EXTENDED = "extended",
+    COLOR = "color",
+    RICH_TEXT = "rich_text"
+}
+export declare enum MultiDisplayOption {
+    AVATAR = "avatar",
+    TAG = "tag",
+    BADGE_QTY = "badge_qty"
+}
+export declare enum IOTypes {
+    STRING = "string",
+    NUMBER = "number",
+    BOOLEAN = "boolean",
+    OBJECT = "object"
+}

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

@@ -0,0 +1,7 @@
+export declare const ACCESS_TOKEN_COOKIE_NAME = "accessToken";
+export declare const REFRESH_TOKEN_COOKIE_NAME = "refreshToken";
+export declare const API_KEY_PARAM_NAME = "key";
+export interface ITokenUserData {
+    userId: string;
+    groupsId: string[];
+}

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

@@ -0,0 +1,230 @@
+import { Options } from 'amqplib';
+import { IKeyValue } from './shared';
+export interface IConfig {
+    coreMode: CoreMode;
+    server: IServer;
+    db: IDb;
+    diskCache: IDiskCache;
+    dataLoaders: IDataLoaders;
+    auth: IAuth;
+    mailer: IMailer;
+    lang: ILang;
+    logs: ILogs;
+    permissions: IPermissions;
+    amqp: IAmqp;
+    redis: IRedis;
+    filesManager: IFilesManager;
+    indexationManager: IIndexationManager;
+    tasksManager: ITasksManager;
+    eventsManager: IEventsManager;
+    debug?: boolean;
+    env?: string;
+    defaultUserId: string;
+    export: IExport;
+    import: IImport;
+    plugins: IKeyValue<IKeyValue<any>>;
+    preview: IPreview;
+    applications: IApplicationsConfig;
+    files: IFilesConfig;
+    dbProfiler: IDbProfilerConfig;
+    instanceId: string;
+    elasticSearch: IElasticSearchConfig;
+    pluginsPath: string[];
+}
+export declare enum CoreMode {
+    SERVER = "server",
+    MIGRATE = "migrate",
+    FILES_MANAGER = "filesManager",
+    INDEXATION_MANAGER = "indexationManager",
+    TASKS_MANAGER_MASTER = "tasksManager:master",
+    TASKS_MANAGER_WORKER = "tasksManager:worker",
+    CLI = "cli"
+}
+export interface IServer {
+    host: string;
+    port: number;
+    publicUrl: string;
+    allowIntrospection: boolean;
+    wsUrl: string;
+    uploadLimit: number | string;
+    supportEmail: string;
+    admin: {
+        login: string;
+        password: string;
+        email: string;
+    };
+    systemUser: {
+        email: string;
+    };
+}
+export interface IDb {
+    url: string;
+    name: string;
+}
+export interface IAuth {
+    scheme: string;
+    key: string;
+    algorithm: string;
+    tokenExpiration: string;
+    refreshTokenExpiration: string;
+    cookie: {
+        sameSite: 'none' | 'lax' | 'strict';
+        secure: boolean;
+    };
+    resetPasswordExpiration: string;
+    oidc: {
+        enable: false;
+        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;
+}
+export interface IMailer {
+    host: string;
+    port: number;
+    secure: boolean;
+    auth: {
+        user: string;
+        password: string;
+    };
+}
+export interface ILang {
+    available: string[];
+    default: string;
+}
+export interface ILogs {
+    level: string;
+    transport: string;
+    destinationFile?: string;
+}
+export interface IPermissions {
+    default: boolean;
+    enableCache: boolean;
+}
+export interface IAmqp {
+    connOpt: Options.Connect;
+    exchange: string;
+    type: string;
+    prefetch?: number;
+}
+export interface IRedis {
+    host: string;
+    port: number;
+    database: number;
+}
+export interface IFilesManager {
+    queues: {
+        events: string;
+        previewRequest: string;
+        previewResponse: string;
+    };
+    routingKeys: {
+        events: string;
+        previewRequest: string;
+        previewResponse: string;
+    };
+    rootKeys: {
+        files1: string;
+    };
+    userId: string;
+    userGroupsIds: string;
+    allowFilesList: string;
+    ignoreFilesList: string;
+}
+export interface IEventsManager {
+    routingKeys: {
+        data_events: string;
+        pubsub_events: string;
+    };
+    queues: {
+        pubsub_events: string;
+    };
+}
+export interface IIndexationManager {
+    queues: {
+        events: string;
+    };
+}
+export interface ITasksManager {
+    checkingInterval: number;
+    workerPrefetch: number;
+    restartWorker: boolean;
+    queues: {
+        execOrders: string;
+        cancelOrders: string;
+    };
+    routingKeys: {
+        execOrders: string;
+        cancelOrders: string;
+    };
+}
+export interface IExport {
+    directory: string;
+    endpoint: string;
+}
+export interface IImport {
+    directory: string;
+    endpoint: string;
+    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;
+}
+export interface IPreview {
+    directory: string;
+}
+export interface IApplicationsConfig {
+    rootFolder: string;
+}
+export interface IFilesConfig {
+    rootPaths: string;
+    originalsPathPrefix: string;
+}
+export interface IDbProfilerConfig {
+    enable: boolean;
+}
+export interface IElasticSearchConfig {
+    url: string;
+}