@aristid/leav-types 1.5.0-36efa9cc → 1.5.0-3c3ef771

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

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

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

@@ -0,0 +1 @@
+export declare const MASKED_VALUE = "\u25CF\u25CF\u25CF\u25CF\u25CF\u25CF\u25CF";

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

@@ -8,15 +8,16 @@ import { type IRecord } from './record';
 import { type IValue } from './value';
 import { type IVersionProfile } from './versionProfile';
 import { type IPermission } from './permissions';
-import { type ITree } from './tree';
+import { type ITreeDbEvent, type ITree } from './tree';
+type OnlyObject<T> = T extends object ? T : never;
 /**
  * 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>;
+    before?: OnlyObject<IDBPayloadData<DBPayloadAction>>;
+    after?: OnlyObject<IDBPayloadData<DBPayloadAction>>;
 }
 interface IDBPayloadDataMap {
     [EventAction.VALUE_SAVE]: IValue;
@@ -34,9 +35,9 @@ interface IDBPayloadDataMap {
     [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_ADD_ELEMENT]: ITreeDbEvent;
+    [EventAction.TREE_DELETE_ELEMENT]: ITreeDbEvent;
+    [EventAction.TREE_MOVE_ELEMENT]: ITreeDbEvent;
     [EventAction.TREE_SAVE]: ITree;
     [EventAction.TREE_DELETE]: ITree;
     [EventAction.PERMISSION_SAVE]: IPermission;

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

@@ -62,3 +62,8 @@ export interface ITreeEvent {
     };
     order: number;
 }
+export interface ITreeDbEvent {
+    parentNode: {
+        id: string;
+    };
+}

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

@@ -106,6 +106,7 @@ export interface IValuesOptions {
     version?: IValueVersion;
     forceArray?: boolean;
     forceGetAllValues?: boolean;
+    skipActions?: boolean;
     [optionName: string]: any;
 }
 export interface IFindValueTree {

package/apps/core/src/domain/record/helpers/findRecords.d.ts

@@ -0,0 +1,38 @@
+import { type ILibraryPermissionDomain } from 'domain/permission/libraryPermissionDomain';
+import { type IRecordRepo } from 'infra/record/recordRepo';
+import { type IQueryInfos } from '../../../_types/queryInfos';
+import { type IRecord } from '../../../_types/record';
+import { type IFindRecordParams } from '../_types';
+import { type IPermissionRepo } from '../../../infra/permission/permissionRepo';
+import { type IListWithCursor } from '../../../_types/list';
+import { type IValidateHelper } from '../../helpers/validate';
+import { type IUtils } from '../../../utils/utils';
+import { type IAttributeDomain } from '../../attribute/attributeDomain';
+import { type ILibraryRepo } from '../../../infra/library/libraryRepo';
+import { type ITreeRepo } from '../../../infra/tree/treeRepo';
+import { type GetCoreEntityByIdFunc } from '../../helpers/getCoreEntityById';
+import { type IElementAncestorsHelper } from '../../tree/helpers/elementAncestors';
+import { type IDefaultPermissionHelper } from '../../permission/helpers/defaultPermission';
+/**
+ * Search records
+ * Filters to apply on records selection
+ * Fields to retrieve on each records
+ */
+export type FindRecordsHelper = ({ params, ctx, }: {
+    params: IFindRecordParams;
+    ctx: IQueryInfos;
+}) => Promise<IListWithCursor<IRecord>>;
+export interface IFindRecordsHelperDeps {
+    'core.domain.helpers.validate': IValidateHelper;
+    'core.domain.permission.library': ILibraryPermissionDomain;
+    'core.domain.attribute': IAttributeDomain;
+    'core.infra.record': IRecordRepo;
+    'core.infra.library': ILibraryRepo;
+    'core.infra.tree': ITreeRepo;
+    'core.utils': IUtils;
+    'core.domain.helpers.getCoreEntityById': GetCoreEntityByIdFunc;
+    'core.domain.tree.helpers.elementAncestors': IElementAncestorsHelper;
+    'core.domain.permission.helpers.defaultPermission': IDefaultPermissionHelper;
+    'core.infra.permission': IPermissionRepo;
+}
+export default function ({ 'core.domain.helpers.validate': validateHelper, 'core.domain.attribute': attributeDomain, 'core.domain.permission.helpers.defaultPermission': defaultPermHelper, 'core.infra.library': libraryRepo, 'core.domain.permission.library': libraryPermissionDomain, 'core.infra.record': recordRepo, 'core.domain.helpers.getCoreEntityById': getCoreEntityById, 'core.infra.tree': treeRepo, 'core.domain.tree.helpers.elementAncestors': elementAncestorsHelper, 'core.infra.permission': permissionRepo, 'core.utils': utils, }: IFindRecordsHelperDeps): FindRecordsHelper;

package/apps/core/src/domain/record/helpers/findRecords.spec.d.ts

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

package/apps/core/src/domain/record/helpers/getRecordFieldValue.d.ts

@@ -0,0 +1,31 @@
+import { type IQueryInfos } from '../../../_types/queryInfos';
+import { type IRecord } from '../../../_types/record';
+import { type IAttributeDomain } from '../../attribute/attributeDomain';
+import { type IValue, type IValuesOptions } from '../../../_types/value';
+import { type IRecordAttributePermissionDomain } from '../../permission/recordAttributePermissionDomain';
+import { type IValueDomain } from '../../value/valueDomain';
+/**
+ * Get the value of targeted attribute with actions applied on it including metadata.
+ *
+ * Avoid requesting DB if attribute already found in `record` param.
+ *
+ * @param {Object} params
+ * @param params.library
+ * @param params.record Could be emulated with only `{ id: <real_id> }`
+ * @param params.attributeId
+ * @param params.options
+ * @param params.ctx
+ */
+export type GetRecordFieldValueHelper = ({ library, record, attributeId, options, ctx, }: {
+    library: string;
+    record: IRecord;
+    attributeId: string;
+    options?: IValuesOptions;
+    ctx: IQueryInfos;
+}) => Promise<IValue[]>;
+export interface IGetRecordFieldValueHelperDeps {
+    'core.domain.attribute': IAttributeDomain;
+    'core.domain.value': IValueDomain;
+    'core.domain.permission.recordAttribute': IRecordAttributePermissionDomain;
+}
+export default function ({ 'core.domain.attribute': attributeDomain, 'core.domain.value': valueDomain, 'core.domain.permission.recordAttribute': recordAttributePermissionDomain, }: IGetRecordFieldValueHelperDeps): GetRecordFieldValueHelper;

package/apps/core/src/domain/record/helpers/getRecordFieldValue.spec.d.ts

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

package/apps/core/src/domain/record/helpers/index.d.ts

@@ -2,3 +2,5 @@ export { default as createRecord } from './createRecord';
 export { default as deleteRecord } from './deleteRecord';
 export { default as sendRecordUpdateEvent } from './sendRecordUpdateEvent';
 export { default as getAccessPermissionFilters } from './getAccessPermissionFilters';
+export { default as findRecords } from './findRecords';
+export { default as getRecordFieldValue } from './getRecordFieldValue';

package/apps/core/src/domain/record/recordDomain.d.ts

@@ -1,12 +1,9 @@
 import { type IEventsManagerDomain } from 'domain/eventsManager/eventsManagerDomain';
 import { type GetCoreEntityByIdFunc } from 'domain/helpers/getCoreEntityById';
 import { type IValidateHelper } from 'domain/helpers/validate';
-import { type ILibraryPermissionDomain } from 'domain/permission/libraryPermissionDomain';
 import { type IValueDomain } from 'domain/value/valueDomain';
 import { type i18n } from 'i18next';
-import { type ILibraryRepo } from 'infra/library/libraryRepo';
 import { type IRecordRepo } from 'infra/record/recordRepo';
-import { type ITreeRepo } from 'infra/tree/treeRepo';
 import { type IUtils } from 'utils/utils';
 import type * as Config from '_types/config';
 import { type IListWithCursor } from '_types/list';
@@ -19,13 +16,12 @@ import { type IRecordPermissionDomain } from '../permission/recordPermissionDoma
 import { type SendRecordUpdateEventHelper } from './helpers/sendRecordUpdateEvent';
 import { type ICreateRecordResult, type IFindRecordParams } from './_types';
 import { type IFormRepo } from 'infra/form/formRepo';
-import { type IRecordAttributePermissionDomain } from '../permission/recordAttributePermissionDomain';
-import { type IPermissionRepo } from '../../infra/permission/permissionRepo';
-import { type IDefaultPermissionHelper } from 'domain/permission/helpers/defaultPermission';
 import { type DeleteRecordHelper } from './helpers/deleteRecord';
 import { type CreateRecordHelper } from './helpers/createRecord';
 import { type IElementAncestorsHelper } from 'domain/tree/helpers/elementAncestors';
 import { type ILogger } from '@leav/logger';
+import { type FindRecordsHelper } from './helpers/findRecords';
+import { type GetRecordFieldValueHelper } from './helpers/getRecordFieldValue';
 export declare const ATTRIBUTE_ACTIVE = "active";
 export interface IRecordDomain {
     /**
@@ -122,23 +118,19 @@ export interface IRecordDomainDeps {
     'core.domain.attribute': IAttributeDomain;
     'core.domain.value': IValueDomain;
     'core.domain.permission.record': IRecordPermissionDomain;
-    'core.domain.permission.library': ILibraryPermissionDomain;
-    'core.domain.permission.recordAttribute': IRecordAttributePermissionDomain;
-    'core.domain.permission.helpers.defaultPermission': IDefaultPermissionHelper;
     'core.domain.helpers.getCoreEntityById': GetCoreEntityByIdFunc;
     'core.domain.helpers.validate': IValidateHelper;
     'core.domain.record.helpers.createRecord': CreateRecordHelper;
     'core.domain.record.helpers.deleteRecord': DeleteRecordHelper;
+    'core.domain.record.helpers.findRecords': FindRecordsHelper;
+    'core.domain.record.helpers.getRecordFieldValue': GetRecordFieldValueHelper;
     'core.domain.record.helpers.sendRecordUpdateEvent': SendRecordUpdateEventHelper;
-    'core.infra.library': ILibraryRepo;
-    'core.infra.tree': ITreeRepo;
     'core.domain.tree.helpers.elementAncestors': IElementAncestorsHelper;
     'core.infra.form': IFormRepo;
-    'core.infra.permission': IPermissionRepo;
     'core.domain.eventsManager': IEventsManagerDomain;
     'core.infra.cache.cacheService': ICachesService;
     'core.utils.logger': ILogger;
     'core.utils': IUtils;
     translator: i18n;
 }
-export default function ({ config, 'core.infra.record': recordRepo, 'core.domain.attribute': attributeDomain, 'core.domain.value': valueDomain, 'core.domain.permission.record': recordPermissionDomain, 'core.domain.permission.library': libraryPermissionDomain, 'core.domain.permission.recordAttribute': recordAttributePermissionDomain, 'core.domain.permission.helpers.defaultPermission': defaultPermHelper, 'core.domain.helpers.getCoreEntityById': getCoreEntityById, 'core.domain.helpers.validate': validateHelper, 'core.domain.record.helpers.createRecord': createRecordHelper, 'core.domain.record.helpers.deleteRecord': deleteRecordHelper, 'core.domain.record.helpers.sendRecordUpdateEvent': sendRecordUpdateEvent, 'core.infra.library': libraryRepo, 'core.infra.tree': treeRepo, 'core.domain.tree.helpers.elementAncestors': elementAncestorsHelper, 'core.infra.form': formRepo, 'core.infra.permission': permissionRepo, 'core.domain.eventsManager': eventsManager, 'core.infra.cache.cacheService': cacheService, 'core.utils.logger': logger, 'core.utils': utils, translator, }: IRecordDomainDeps): IRecordDomain;
+export default function ({ config, 'core.infra.record': recordRepo, 'core.domain.attribute': attributeDomain, 'core.domain.value': valueDomain, 'core.domain.permission.record': recordPermissionDomain, 'core.domain.record.helpers.findRecords': findRecordsHelper, 'core.domain.record.helpers.getRecordFieldValue': getRecordFieldValueHelper, 'core.domain.helpers.getCoreEntityById': getCoreEntityById, 'core.domain.helpers.validate': validateHelper, 'core.domain.record.helpers.createRecord': createRecordHelper, 'core.domain.record.helpers.deleteRecord': deleteRecordHelper, 'core.domain.record.helpers.sendRecordUpdateEvent': sendRecordUpdateEvent, 'core.domain.tree.helpers.elementAncestors': elementAncestorsHelper, 'core.infra.form': formRepo, 'core.domain.eventsManager': eventsManager, 'core.infra.cache.cacheService': cacheService, 'core.utils.logger': logger, 'core.utils': utils, translator, }: IRecordDomainDeps): IRecordDomain;

package/apps/core/src/domain/user/userDomain.d.ts

@@ -20,6 +20,7 @@ export interface IUserDomain {
     saveUserData(params: ISaveUserDataParams): Promise<IUserData>;
     getUserData(keys: string[], global: boolean, ctx: IQueryInfos): Promise<IUserData>;
     sendResetPasswordEmail(email: string, token: string, login: string, browser: string, os: string, lang: 'fr' | 'en', ctx: IQueryInfos): Promise<void>;
+    verifyPassword(userId: string, password: string, ctx: IQueryInfos): Promise<boolean>;
 }
 export interface IUserDomainDeps {
     config: Config.IConfig;

package/apps/core/src/infra/db/migrations/013-passwordAttributeMaskValue.d.ts

@@ -0,0 +1,7 @@
+import { type IAttributeRepo } from 'infra/attribute/attributeRepo';
+import { type IMigration } from '../../../_types/migration';
+interface IDeps {
+    'core.infra.attribute'?: IAttributeRepo;
+}
+export default function ({ 'core.infra.attribute': attributeRepo }: IDeps): IMigration;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aristid/leav-types",
-  "version": "1.5.0-36efa9cc",
+  "version": "1.5.0-3c3ef771",
   "description": "Shared Leav types",
   "scripts": {
     "tscheck": "",