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

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

@@ -0,0 +1,139 @@
+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",
+    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 {
+    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,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;
+    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

@@ -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;
+    getLabel?: () => Promise<string | null>;
+    getSubLabel?: () => Promise<string | null>;
+    getColor?: () => Promise<string | null>;
+    getPreview?: () => Promise<IPreview | null>;
+}
+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;
+    }
+}

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

@@ -0,0 +1,3 @@
+export interface ISystemTranslation {
+    [lang: string]: string;
+}

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

@@ -0,0 +1,97 @@
+import { ISystemTranslation } from './systemTranslation';
+export declare enum OrderType {
+    CREATE = "CREATE",
+    CANCEL = "CANCEL",
+    DELETE = "DELETE"
+}
+export declare enum TaskStatus {
+    CREATED = "CREATED",
+    PENDING = "PENDING",
+    RUNNING = "RUNNING",
+    FAILED = "FAILED",
+    DONE = "DONE",
+    PENDING_CANCEL = "PENDING_CANCEL",
+    CANCELED = "CANCELED"
+}
+export declare enum TaskPriority {
+    LOW = 0,
+    MEDIUM = 1,
+    HIGH = 2
+}
+export type ITaskCreatePayload = Pick<ITask, 'label' | 'func' | 'priority' | 'callbacks'> & Partial<Pick<ITask, 'id' | 'startAt' | 'role'>>;
+export type ITaskCancelPayload = Pick<ITask, 'id'>;
+export type ITaskDeletePayload = Pick<ITask, 'id'> & {
+    archive: boolean;
+};
+export type Payload = ITaskCreatePayload | ITaskCancelPayload | ITaskDeletePayload;
+export interface ITaskOrder {
+    time: number;
+    userId: string;
+    payload: Payload;
+}
+export interface ITaskFunc {
+    moduleName: string;
+    subModuleName?: string;
+    name: string;
+    args: {
+        [key: string]: any;
+    };
+}
+export declare enum TaskCallbackType {
+    ON_SUCCESS = "ON_SUCCESS",
+    ON_FAILURE = "ON_FAILURE",
+    ON_CANCEL = "ON_CANCEL"
+}
+export declare enum TaskCallbackStatus {
+    PENDING = "PENDING",
+    RUNNING = "RUNNING",
+    FAILED = "FAILED",
+    DONE = "DONE",
+    SKIPPED = "SKIPPED"
+}
+export type ITaskCallback = ITaskFunc & {
+    args: any[];
+    type: TaskCallbackType[];
+    status?: TaskCallbackStatus;
+};
+export interface ITaskFuncParams {
+    id?: string;
+    startAt?: number;
+    callbacks?: ITaskCallback[];
+}
+export declare enum TaskType {
+    EXPORT = "EXPORT",
+    IMPORT_CONFIG = "IMPORT_CONFIG",
+    IMPORT_DATA = "IMPORT_DATA",
+    INDEXATION = "INDEXATION"
+}
+export interface ITaskRole {
+    type: TaskType;
+    detail?: string;
+}
+export interface ITask {
+    id: string;
+    label: ISystemTranslation;
+    created_at: number;
+    created_by: string;
+    modified_at: number;
+    func: ITaskFunc;
+    startAt: number;
+    status: TaskStatus;
+    priority: TaskPriority;
+    archive: boolean;
+    role?: ITaskRole;
+    canceledBy?: string;
+    progress?: {
+        percent?: number;
+        description?: ISystemTranslation;
+    };
+    startedAt?: number;
+    completedAt?: number;
+    link?: {
+        name: string;
+        url: string;
+    };
+    callbacks?: ITaskCallback[];
+    workerId?: number;
+}

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

@@ -0,0 +1,64 @@
+import { ITreeNodePermissionsConf } from './permissions';
+import { IRecord } from './record';
+import { IGetCoreEntitiesParams, IKeyValue } from './shared';
+export interface ITreeLibrarySettings {
+    allowMultiplePositions: boolean;
+    allowedChildren: string[];
+    allowedAtRoot: boolean;
+}
+export interface ITree extends ICoreEntity {
+    libraries: IKeyValue<ITreeLibrarySettings>;
+    behavior?: TreeBehavior;
+    system?: boolean;
+    permissions_conf?: ITreeNodePermissionsConf;
+    settings?: IKeyValue<any>;
+}
+export interface ITreeFilterOptions extends ICoreEntityFilterOptions {
+    system?: boolean;
+    library?: string;
+}
+export interface IGetCoreTreesParams extends IGetCoreEntitiesParams {
+    filters?: ITreeFilterOptions;
+}
+export interface ITreeElement {
+    id: string;
+    library: string;
+}
+export interface ITreeNode {
+    id: string;
+    order?: number;
+    childrenCount?: number;
+    record?: IRecord;
+    parent?: ITreeNode[];
+    ancestors?: ITreeNode[];
+    children?: ITreeNode[];
+    linkedRecords?: IRecord[];
+}
+export type ITreeNodeLight = Pick<ITreeNode, 'id' | 'order'>;
+export interface ITreeNodeWithTreeId extends ITreeNode {
+    treeId: string;
+}
+export type TreePath = ITreeNode[];
+export declare enum TreeBehavior {
+    STANDARD = "standard",
+    FILES = "files"
+}
+export declare enum TreeEventTypes {
+    ADD = "add",
+    REMOVE = "remove",
+    MOVE = "move"
+}
+export interface ITreeEvent {
+    type: TreeEventTypes;
+    treeId: string;
+    element: ITreeNodeLight & {
+        treeId: string;
+    };
+    parentNode?: ITreeNodeLight & {
+        treeId: string;
+    };
+    parentNodeBefore?: ITreeNodeLight & {
+        treeId: string;
+    };
+    order: number;
+}

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

@@ -0,0 +1,4 @@
+export interface IUserData {
+    global: boolean;
+    data: any;
+}

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

@@ -0,0 +1,3 @@
+export type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;

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

@@ -0,0 +1,139 @@
+import { AnyPrimitive, Override } from '@leav/utils';
+import { IDbEdge } from 'infra/db/_types';
+import { IRecord } from './record';
+import { ITreeNode, TreePath } from './tree';
+import { EMPTY_VALUE } from 'infra/value/valueRepo';
+import { AttributeTypes } from './attribute';
+export type IValueFromGql = Override<Omit<IValue, 'version'>, {
+    value: IValue['payload'];
+    metadata: Array<{
+        name: string;
+        value: string;
+    }>;
+}>;
+export interface IValueVersion {
+    [treeName: string]: string;
+}
+export type IValueVersionFromGql = Array<{
+    treeId: string;
+    treeNodeId: string;
+}>;
+export type IValueFromGraphql = Override<IValue, {
+    metadata: Array<{
+        name: string;
+        value: string;
+    }>;
+}>;
+export interface IDbValueVersion {
+    [treeName: string]: string;
+}
+export interface IValueMetadata {
+    [fieldName: string]: IStandardValue | AnyPrimitive;
+}
+export type EmptyValue = typeof EMPTY_VALUE;
+interface ICommonGenericSaveValue {
+    /**
+     * The id of the edge for advanced, advanced link or tree values
+     * In case of advanced reverse link from simple link, this is the id of the linked record
+     */
+    id_value?: string | null;
+    attribute?: string;
+    created_at?: number;
+    modified_at?: number;
+    created_by?: string;
+    modified_by?: string;
+    version?: IValueVersion;
+    metadata?: IValueMetadata;
+}
+export interface IGenericValue extends ICommonGenericSaveValue {
+    isInherited?: boolean;
+    isCalculated?: boolean;
+}
+export interface IStandardValue extends IGenericValue {
+    /**
+     * Computed value after get actions on attribute are done
+     * TODO remove that any when possible
+     * TODO remove optional when possible
+     */
+    payload?: any | EmptyValue;
+    /**
+     * Raw value from the database, before any computation
+     * TODO, remove that any when possible
+     */
+    raw_payload?: any;
+}
+export interface ILinkValue extends IGenericValue {
+    /**
+     * Linked record
+     * TODO remove optional when possible
+     */
+    payload?: IRecord;
+}
+export interface ITreeValue extends IGenericValue {
+    /**
+     * Linked tree node
+     * TODO remove optional when possible
+     */
+    payload?: ITreeNode;
+    treeId: string;
+}
+export type IValue = IStandardValue | ILinkValue | ITreeValue;
+type IGenericSaveValue = ICommonGenericSaveValue;
+export interface ISaveStandardValue extends IGenericSaveValue {
+    /**
+     * Any base type value to save
+     */
+    payload: number | string | boolean | EmptyValue | null;
+}
+export interface ISaveLinkValue extends IGenericSaveValue {
+    /**
+     * Record id to link
+     */
+    payload: string | null;
+}
+export interface ISaveTreeValue extends IGenericSaveValue {
+    /**
+     * Tree node id to link
+     */
+    payload: string | null;
+}
+export type ISaveValue = ISaveStandardValue | ISaveLinkValue | ISaveTreeValue;
+export interface IDateRangeValue<T = string | number> {
+    from: T;
+    to: T;
+}
+export interface IValuesOptions {
+    version?: IValueVersion;
+    forceArray?: boolean;
+    forceGetAllValues?: boolean;
+    [optionName: string]: any;
+}
+export interface IFindValueTree {
+    name: string;
+    currentIndex: number;
+    elements: TreePath;
+}
+export interface IValueEdge extends IDbEdge {
+    attribute: string;
+    modified_at: number;
+    modified_by: string;
+    created_at: number;
+    created_by: string;
+    version?: IDbValueVersion;
+    metadata?: IValueMetadata;
+}
+export interface IValueByAttributeType {
+    [AttributeTypes.SIMPLE]: IStandardValue;
+    [AttributeTypes.SIMPLE_LINK]: ILinkValue;
+    [AttributeTypes.ADVANCED]: IStandardValue;
+    [AttributeTypes.ADVANCED_LINK]: ILinkValue;
+    [AttributeTypes.TREE]: ITreeValue;
+}
+export interface ISaveValueByAttributeType {
+    [AttributeTypes.SIMPLE]: ISaveStandardValue;
+    [AttributeTypes.SIMPLE_LINK]: ISaveLinkValue;
+    [AttributeTypes.ADVANCED]: ISaveStandardValue;
+    [AttributeTypes.ADVANCED_LINK]: ISaveLinkValue;
+    [AttributeTypes.TREE]: ISaveTreeValue;
+}
+export {};

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

@@ -0,0 +1,17 @@
+import { IGetCoreEntitiesParams } from './shared';
+import { ISystemTranslation } from './systemTranslation';
+export interface IVersionProfile {
+    id: string;
+    label: ISystemTranslation;
+    description?: ISystemTranslation;
+    trees: string[];
+}
+/**
+ * Accepted fields to filter version profiles list
+ */
+export interface IVersionProfileFilterOptions extends ICoreEntityFilterOptions {
+    trees?: string;
+}
+export interface IGetCoreVersionProfileParams extends IGetCoreEntitiesParams {
+    filters?: IVersionProfileFilterOptions;
+}