@aristid/leav-types 0.0.3 → 0.0.4-b0a5cfe

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

@@ -0,0 +1,29 @@
+import { IActionsListFunction } from './actionsList';
+import { IAppGraphQLSchema } from './graphql';
+import { PermissionTypes } from './permissions';
+import { PluginRegisterRoute } from './endpoint';
+export interface IExtensionPoints {
+    [name: string]: (...args: any[]) => void;
+}
+export interface IExtensionPointsFunctions extends IExtensionPoints {
+    /**
+     * Method to extend graphQL schema.
+     *
+     * This method is called automatically by `leav-engine/apps/core/src/pluginsLoader.ts`.
+     *
+     * @param {IAppGraphQLSchema} schemaPart
+     */
+    registerGraphQLSchema: (schemaPart: IAppGraphQLSchema) => void;
+    registerTranslations: (path: string) => Promise<void>;
+    registerPermissionActions: (type: PermissionTypes, actions: string[], applyOn?: string[]) => void;
+    registerEventActions: (actions: string[], prefix: string) => void;
+    registerActions: (actions: IActionsListFunction[]) => void;
+    /**
+     * Method to register some Express routes inside LEAV Core.
+     *
+     * This method is called automatically by `leav-engine/apps/core/src/pluginsLoader.ts`.
+     *
+     * @param {PluginRegisterRoute[]} routes - list of routes to register
+     */
+    registerRoutes: (routes: PluginRegisterRoute[]) => void;
+}

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

@@ -0,0 +1,90 @@
+import { IEmbeddedAttribute } from './attribute';
+export declare enum FileEvents {
+    CREATE = "CREATE",
+    REMOVE = "REMOVE",
+    UPDATE = "UPDATE",
+    MOVE = "MOVE"
+}
+export declare enum FilesAttributes {
+    ROOT_KEY = "root_key",
+    FILE_PATH = "file_path",
+    FILE_NAME = "file_name",
+    INODE = "inode",
+    ACTIVE = "active",
+    HASH = "hash",
+    FILE_SIZE = "file_size",
+    MIME_TYPE1 = "mime_type1",
+    MIME_TYPE2 = "mime_type2",
+    HAS_CLIPPING_PATH = "has_clipping_path",
+    COLOR_SPACE = "color_space",
+    COLOR_PROFILE = "color_profile",
+    WIDTH = "width",
+    HEIGHT = "height",
+    PRINT_WIDTH = "print_width",
+    PRINT_HEIGHT = "print_height",
+    RESOLUTION = "resolution"
+}
+export declare const PREVIEWS_ATTRIBUTE_SUFFIX = "previews";
+export declare const PREVIEWS_STATUS_ATTRIBUTE_SUFFIX = "previews_status";
+export interface IFileEventData {
+    event: FileEvents;
+    time: number;
+    pathBefore: string | null;
+    pathAfter: string | null;
+    inode: number;
+    rootKey: string;
+    isDirectory: boolean;
+    hash?: string;
+    recordId?: string;
+}
+export interface IPreviewVersionSize {
+    size: number;
+    name: string;
+    output?: string;
+}
+export interface IPreviewVersion {
+    background: boolean | string;
+    density: number;
+    pdf?: string;
+    sizes: IPreviewVersionSize[];
+}
+export interface IPreviewMessage {
+    input: string;
+    context: any;
+    versions: IPreviewVersion[];
+}
+export interface IPreviewsStatus {
+    [sizeName: string]: {
+        status: number;
+        message: string;
+    };
+}
+export interface IPreviews {
+    [sizeName: string]: string;
+}
+export interface IPreviewResponseResult {
+    error: number;
+    error_detail: string;
+    params?: {
+        background?: true | false | string;
+        density?: number;
+        size: number;
+        output: string;
+        name: string;
+    };
+}
+export interface IPreviewResponseContext {
+    library: string;
+    recordId: string;
+}
+export interface IPreviewResponse {
+    context: IPreviewResponseContext;
+    input: string;
+    results?: IPreviewResponseResult[];
+}
+export interface IPreviewAttributesSettings {
+    [attributeId: string]: IEmbeddedAttribute[];
+}
+export type IFileMetadata = {
+    [key in FilesAttributes]?: string | number | boolean;
+};

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

@@ -0,0 +1,50 @@
+import { IKeyValue } from './shared';
+import { IValue } from './value';
+export interface IForm extends ICoreEntity {
+    library: string;
+    system?: boolean;
+    dependencyAttributes?: string[];
+    elements?: IFormDependentElements[];
+}
+export interface IRecordForm {
+    id: string;
+    library: string;
+    system: boolean;
+    recordId: string;
+    dependencyAttributes?: string[];
+    elements: IFormElementWithValues[];
+}
+export declare enum FormElementTypes {
+    field = "field",
+    layout = "layout"
+}
+export type IFormStrict = Required<IForm>;
+export interface IFormElementsDependency {
+    attribute: string;
+    value: string;
+}
+export interface IFormDependentElements {
+    dependencyValue?: IFormElementsDependency | null;
+    elements: IFormElement[];
+}
+export interface IFormElement {
+    id: string;
+    order: number;
+    type: FormElementTypes;
+    uiElementType: string;
+    containerId: string;
+    settings?: IKeyValue<any>;
+}
+export interface IFormElementWithValues extends IFormElement {
+    values?: IValue[];
+    valueError?: string;
+}
+export type IFormElementWithValuesAndChildren = IFormElementWithValues & {
+    children: IFormElementWithValuesAndChildren[];
+};
+/**
+ * Accepted fields to filter attributes list
+ */
+export interface IFormFilterOptions extends ICoreEntityFilterOptions {
+    library?: string;
+}

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

@@ -0,0 +1,11 @@
+export interface IGlobalSettings {
+    name: string;
+    icon?: {
+        library: string;
+        recordId: string;
+    };
+    favicon?: {
+        library: string;
+        recordId: string;
+    };
+}

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

@@ -0,0 +1,4 @@
+export interface IAppGraphQLSchema {
+    typeDefs: string;
+    resolvers: any;
+}

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

@@ -0,0 +1,63 @@
+import { IValueMetadata } from './value';
+export declare enum ImportType {
+    IGNORE = "IGNORE",
+    STANDARD = "STANDARD",
+    LINK = "LINK"
+}
+export declare enum ImportMode {
+    INSERT = "insert",
+    UPDATE = "update",
+    UPSERT = "upsert"
+}
+export declare enum Action {
+    ADD = "add",
+    REPLACE = "replace",
+    UPDATE = "update",
+    REMOVE = "remove"
+}
+export interface IMatch {
+    attribute: string;
+    value: string;
+}
+export interface IValue {
+    library?: string;
+    payload: string | IMatch[];
+    metadata?: IValueMetadata;
+    version?: IImportValueVersion[];
+}
+export interface IImportValueVersion {
+    treeId: string;
+    element: IMatch[];
+    library?: string;
+}
+export interface IData {
+    attribute: string;
+    values: IValue[];
+    action: Action;
+}
+export interface IElement {
+    library: string;
+    matches: IMatch[];
+    mode: ImportMode;
+    data: IData[];
+}
+export interface ITree {
+    library: string;
+    treeId: string;
+    matches: IMatch[];
+    parent?: {
+        library: string;
+        matches: IMatch[];
+    };
+    action: Action;
+    order?: number;
+}
+export interface IFile {
+    elements: IElement[];
+    trees: ITree[];
+}
+export interface ICacheParams {
+    cacheDataPath: string;
+    cacheKey: number;
+    isCacheActive: boolean;
+}

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

@@ -0,0 +1,50 @@
+import { IAttribute } from './attribute';
+import { IPreviewVersion } from './filesManager';
+import { ITreePermissionsConf } from './permissions';
+import { IRecordIdentityConf } from './record';
+import { ISystemTranslation } from './systemTranslation';
+export interface ILibrary extends ICoreEntity {
+    system?: boolean;
+    behavior?: LibraryBehavior;
+    /**
+     * List of attributes usable in this library
+     */
+    attributes?: IAttribute[];
+    /**
+     * Records permissions settings for this library
+     */
+    permissions_conf?: ITreePermissionsConf;
+    /**
+     * Records identity settings for this library
+     */
+    recordIdentityConf?: IRecordIdentityConf;
+    /**
+     * List of indexed attributes
+     */
+    fullTextAttributes?: IAttribute[];
+    /**
+     * ID of default view
+     */
+    defaultView?: string;
+    icon?: {
+        libraryId: string;
+        recordId: string;
+    };
+    previewsSettings?: ILibraryPreviewsSettings[];
+}
+export interface ILibraryFilterOptions extends ICoreEntityFilterOptions {
+    system?: boolean;
+}
+export interface ILibraryPreviewsSettings {
+    label: ISystemTranslation;
+    description?: ISystemTranslation;
+    system: boolean;
+    versions: IPreviewVersion;
+}
+export declare enum LibraryBehavior {
+    STANDARD = "standard",
+    FILES = "files",
+    DIRECTORIES = "directories"
+}
+export declare const USERS_LIBRARY = "users";
+export declare const USERS_GROUPS_LIBRARY = "users_groups";

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

@@ -0,0 +1,31 @@
+export interface IList<T> {
+    totalCount: number;
+    list: T[];
+}
+export declare enum CursorDirection {
+    PREV = "prev",
+    NEXT = "next"
+}
+export interface IPaginationCursors {
+    prev?: string;
+    next?: string;
+}
+export interface IListWithCursor<T> extends IList<T> {
+    cursor: IPaginationCursors;
+}
+export interface IPaginationParams {
+    limit: number;
+    offset: number;
+}
+export interface ICursorPaginationParams {
+    limit: number;
+    cursor: string;
+}
+export declare enum SortOrder {
+    ASC = "asc",
+    DESC = "desc"
+}
+export interface ISortParams {
+    field: string;
+    order: SortOrder;
+}

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

@@ -0,0 +1,37 @@
+import { EventAction } from '@leav/utils';
+export interface ILogTopicFilter {
+    record?: {
+        id: string;
+        libraryId: string;
+    };
+    library?: string;
+    attribute?: string;
+    tree?: string;
+    profile?: string;
+    permission?: {
+        type?: string;
+        applyTo?: any;
+    };
+    apiKey?: string;
+    application?: string;
+    filename?: string;
+}
+export interface ILogFilters {
+    actions?: EventAction[];
+    time?: {
+        from?: number;
+        to?: number;
+    };
+    userId?: string;
+    queryId?: string;
+    instanceId?: string;
+    topic?: ILogTopicFilter;
+}
+export interface ILogSort {
+    field: string;
+    order: 'asc' | 'desc';
+}
+export interface ILogPagination {
+    limit: number;
+    offset: number;
+}

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

@@ -0,0 +1,4 @@
+import { IQueryInfos } from '_types/queryInfos';
+export interface IMigration {
+    run(ctx: IQueryInfos): Promise<void>;
+}

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

@@ -0,0 +1,137 @@
+import { ISystemTranslation } from './systemTranslation';
+export declare enum PermissionTypes {
+    RECORD = "record",
+    RECORD_ATTRIBUTE = "record_attribute",
+    ADMIN = "admin",
+    LIBRARY = "library",
+    ATTRIBUTE = "attribute",
+    TREE = "tree",
+    TREE_NODE = "tree_node",
+    TREE_LIBRARY = "tree_library",
+    APPLICATION = "application"
+}
+export declare enum LibraryPermissionsActions {
+    ACCESS_LIBRARY = "access_library",
+    ADMIN_LIBRARY = "admin_library",
+    ACCESS_RECORD = "access_record",
+    CREATE_RECORD = "create_record",
+    EDIT_RECORD = "edit_record",
+    DELETE_RECORD = "delete_record"
+}
+export declare enum RecordPermissionsActions {
+    ACCESS_RECORD = "access_record",
+    CREATE_RECORD = "create_record",
+    EDIT_RECORD = "edit_record",
+    DELETE_RECORD = "delete_record"
+}
+export declare enum RecordAttributePermissionsActions {
+    ACCESS_ATTRIBUTE = "access_attribute",
+    EDIT_VALUE = "edit_value"
+}
+export declare enum AttributePermissionsActions {
+    ACCESS_ATTRIBUTE = "access_attribute",
+    EDIT_VALUE = "edit_value"
+}
+export declare enum TreePermissionsActions {
+    ACCESS_TREE = "access_tree",
+    EDIT_CHILDREN = "edit_children"
+}
+export declare enum TreeNodePermissionsActions {
+    ACCESS_TREE = "access_tree",
+    DETACH = "detach",
+    EDIT_CHILDREN = "edit_children"
+}
+export declare enum ApplicationPermissionsActions {
+    ADMIN_APPLICATION = "admin_application",
+    ACCESS_APPLICATION = "access_application"
+}
+export declare enum AdminPermissionsActions {
+    ACCESS_LIBRARIES = "admin_access_libraries",
+    CREATE_LIBRARY = "admin_create_library",
+    EDIT_LIBRARY = "admin_edit_library",
+    DELETE_LIBRARY = "admin_delete_library",
+    ACCESS_TASKS = "admin_access_tasks",
+    DELETE_TASK = "admin_delete_task",
+    CANCEL_TASK = "admin_cancel_task",
+    ACCESS_ATTRIBUTES = "admin_access_attributes",
+    CREATE_ATTRIBUTE = "admin_create_attribute",
+    EDIT_ATTRIBUTE = "admin_edit_attribute",
+    DELETE_ATTRIBUTE = "admin_delete_attribute",
+    ACCESS_TREES = "admin_access_trees",
+    CREATE_TREE = "admin_create_tree",
+    EDIT_TREE = "admin_edit_tree",
+    DELETE_TREE = "admin_delete_tree",
+    ACCESS_VERSION_PROFILES = "admin_access_version_profiles",
+    CREATE_VERSION_PROFILE = "admin_create_version_profile",
+    EDIT_VERSION_PROFILE = "admin_edit_version_profile",
+    DELETE_VERSION_PROFILE = "admin_delete_version_profile",
+    ACCESS_PERMISSIONS = "admin_access_permissions",
+    EDIT_PERMISSION = "admin_edit_permission",
+    MANAGE_GLOBAL_PREFERENCES = "admin_manage_global_preferences",
+    ACCESS_APPLICATIONS = "admin_access_applications",
+    CREATE_APPLICATION = "admin_create_application",
+    EDIT_APPLICATION = "admin_edit_application",
+    DELETE_APPLICATION = "admin_delete_application",
+    ACCESS_API_KEYS = "admin_access_api_keys",
+    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"
+}
+export type PermissionsActions = LibraryPermissionsActions | RecordPermissionsActions | RecordAttributePermissionsActions | AdminPermissionsActions | AttributePermissionsActions | TreePermissionsActions | TreeNodePermissionsActions | ApplicationPermissionsActions;
+export interface ILabeledPermissionsAction {
+    label: ISystemTranslation;
+    name: PermissionsActions | string;
+}
+export declare enum PermissionsRelations {
+    AND = "and",
+    OR = "or"
+}
+export interface ITreeNodePermissionsConf {
+    [libraryId: string]: ITreePermissionsConf;
+}
+export interface ITreePermissionsConf {
+    /**
+     * IDs of attributes used for permissions
+     */
+    permissionTreeAttributes: string[];
+    /**
+     * Relation between those trees when retrieving permission
+     */
+    relation: PermissionsRelations;
+}
+export interface IPermissionsTreeTarget {
+    /**
+     * Tree ID
+     */
+    tree: string;
+    /**
+     * Tree element's ID
+     */
+    nodeId: string | null;
+}
+export interface IPermission {
+    /**
+     * Permission type
+     */
+    type: PermissionTypes;
+    /**
+     * What this permission applies to? Can be a library, an attribute...
+     */
+    applyTo?: string;
+    /**
+     * Users group concerned by this permission. If null, applies to root level
+     */
+    usersGroup: string | null;
+    /**
+     * Permission by action: create, edit...
+     * Set an action to null to herit from its parent when using in a record or attribute permission
+     */
+    actions: {
+        [name: string]: boolean | null;
+    };
+    /**
+     * What element on permissions tree is concerned by this permission
+     */
+    permissionTreeTarget?: IPermissionsTreeTarget;
+}

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

@@ -0,0 +1,14 @@
+import { IExtensionPointsFunctions } from './extensionPoints';
+export interface IPluginInfos {
+    name: string;
+    description: string;
+    version: string;
+    author: string;
+}
+export interface IRegisteredPlugin {
+    path: string;
+    infos: IPluginInfos;
+}
+export interface IPluginInitModule {
+    init: (extensionPoints: IExtensionPointsFunctions) => void;
+}

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

@@ -0,0 +1,6 @@
+import { IRecord } from './record';
+export type IPreview = {
+    [x: string]: string;
+} & {
+    file?: IRecord;
+};

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

@@ -0,0 +1,16 @@
+import type LeavError from 'errors/LeavError';
+import { IDbProfiler } from './dbProfiler';
+import { IValueVersion } from './value';
+export interface IQueryInfos {
+    userId: string;
+    lang?: string;
+    defaultLang?: string;
+    queryId?: string;
+    version?: IValueVersion;
+    treeId?: string;
+    groupsId?: string[];
+    applicationId?: string;
+    dbProfiler?: IDbProfiler;
+    trigger?: string;
+    errors?: Array<LeavError<unknown>>;
+}

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

@@ -0,0 +1,111 @@
+import { IAttributeWithRevLink } from 'infra/attributeTypes/attributeTypesRepo';
+import { ILibrary } from './library';
+import { IPreview } from './preview';
+import { IValue } from './value';
+export interface IRecord {
+    id?: string;
+    library?: string;
+    created_at?: number;
+    created_by?: string;
+    modified_at?: number;
+    modified_by?: string;
+    active?: boolean;
+    [attributeName: string]: any;
+}
+export declare enum Operator {
+    AND = "AND",
+    OR = "OR",
+    OPEN_BRACKET = "OPEN_BRACKET",
+    CLOSE_BRACKET = "CLOSE_BRACKET"
+}
+export declare enum AttributeCondition {
+    EQUAL = "EQUAL",
+    NOT_EQUAL = "NOT_EQUAL",
+    BEGIN_WITH = "BEGIN_WITH",
+    END_WITH = "END_WITH",
+    CONTAINS = "CONTAINS",
+    NOT_CONTAINS = "NOT_CONTAINS",
+    GREATER_THAN = "GREATER_THAN",
+    LESS_THAN = "LESS_THAN",
+    IS_EMPTY = "IS_EMPTY",
+    IS_NOT_EMPTY = "IS_NOT_EMPTY",
+    BETWEEN = "BETWEEN",
+    TODAY = "TODAY",
+    YESTERDAY = "YESTERDAY",
+    TOMORROW = "TOMORROW",
+    NEXT_MONTH = "NEXT_MONTH",
+    LAST_MONTH = "LAST_MONTH",
+    START_ON = "START_ON",
+    START_BEFORE = "START_BEFORE",
+    START_AFTER = "START_AFTER",
+    END_ON = "END_ON",
+    END_BEFORE = "END_BEFORE",
+    END_AFTER = "END_AFTER",
+    VALUES_COUNT_EQUAL = "VALUES_COUNT_EQUAL",
+    VALUES_COUNT_GREATER_THAN = "VALUES_COUNT_GREATER_THAN",
+    VALUES_COUNT_LOWER_THAN = "VALUES_COUNT_LOWER_THAN"
+}
+export declare enum TreeCondition {
+    CLASSIFIED_IN = "CLASSIFIED_IN",
+    NOT_CLASSIFIED_IN = "NOT_CLASSIFIED_IN"
+}
+export interface IDateFilterValue {
+    from: number;
+    to: number;
+}
+export interface IRecordFilterOption {
+    attributes?: IAttributeWithRevLink[];
+    value?: string | number | boolean;
+    condition?: AttributeCondition | TreeCondition;
+    operator?: Operator;
+    treeId?: string;
+}
+export interface IRecordSort {
+    attributes: IAttributeWithRevLink[];
+    order: string;
+}
+export interface IQueryField {
+    name: string;
+    fields: IQueryField[];
+    arguments: Array<{
+        name: string;
+        value: string;
+    }>;
+}
+export interface IRecordIdentity {
+    id: string;
+    library: ILibrary;
+    label?: string;
+    subLabel?: string;
+    color?: string;
+    preview?: IPreview;
+}
+export interface IRecordIdentityConf {
+    label?: string;
+    color?: string;
+    preview?: string;
+    treeColorPreview?: string;
+    subLabel?: string;
+}
+export interface IRecordUpdateEvent {
+    record: IRecord;
+    updatedValues: Array<{
+        attribute: string;
+        value: IValue;
+    }>;
+}
+export interface IRecordUpdateEventFilters {
+    libraries?: string[];
+    records?: string[];
+}
+export interface IRecordFilterLight {
+    field?: string;
+    value?: string;
+    condition?: AttributeCondition | TreeCondition;
+    operator?: Operator;
+    treeId?: string;
+}
+export interface IRecordSortLight {
+    field: string;
+    order: string;
+}

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

@@ -0,0 +1,28 @@
+import { IExtensionPoints } from './extensionPoints';
+import { IPaginationParams, ISortParams } from './list';
+import { ISystemTranslation } from './systemTranslation';
+export interface IGetCoreEntitiesParams {
+    filters?: ICoreEntityFilterOptions;
+    strictFilters?: boolean;
+    withCount?: boolean;
+    pagination?: IPaginationParams;
+    sort?: ISortParams;
+}
+export interface IAppModule {
+    extensionPoints?: IExtensionPoints;
+}
+export interface IKeyValue<T> {
+    [key: string]: T;
+}
+declare global {
+    interface ICoreEntity {
+        id?: string;
+        label?: ISystemTranslation | string;
+    }
+    interface ICoreEntityFilterOptions {
+        id?: string | string[];
+        label?: string | string[];
+        system?: boolean;
+        key?: string;
+    }
+}