@rentman/rm-core 12.0.5-7 → 12.0.5

package/dist/types/src/classes/BusinessLogicManager/BusinessLogicManager.d.ts

@@ -6,7 +6,6 @@ import { PromiseInterface } from '../../types/PromiseInterface';
 import { ApiFormatter } from '../ApiFormatter';
 import { TransactionCache } from '../cache/transaction/TransactionCache';
 import { ChangesDelta } from '../ChangesDelta';
-import { ContactAddressBusinessLogicRule } from './Contact/ContactAddressBusinessLogicRule';
 import { CustomFieldTypeBusinessLogicRule } from './Customfield/CustomFieldTypeBusinessLogicRule';
 import { DocumentTemplateBusinessLogicRule } from './Documents/DocumentTemplateBusinessLogicRule';
 import { ExemplaarAanschafdatumBusinessLogicRule } from './Exemplaar/ExemplaarAanschafdatumBusinessLogicRule';
@@ -52,7 +51,6 @@ export declare class BusinessLogicManager {
         FunctieTwowayBusinessLogicRule: FunctieTwowayBusinessLogicRule;
         FunctieNaaminternBusinessLogicRule: FunctieNaaminternBusinessLogicRule;
         CustomFieldTypeBusinessLogicRule: CustomFieldTypeBusinessLogicRule;
-        ContactAddressBusinessLogicRule: ContactAddressBusinessLogicRule;
         RolDocumentAccessBusinessLogicRule: RolDocumentAccessBusinessLogicRule;
         RolEditOwnDataBusinessLogicRule: RolEditOwnDataBusinessLogicRule;
         RolFileAccessBusinessLogicRule: RolFileAccessBusinessLogicRule;

package/dist/types/src/classes/ChangesDeltaBase.d.ts

@@ -5,25 +5,10 @@ export declare type ChangesDeltaResult = {
     created: ItemEntry[];
 };
 export declare enum ChangesDeltaItemUpdateMode {
-    /**
-     * For create/update responses you always want to overwrite whatever is cached
-     */
     CLEAR_ALWAYS = "overwrite",
-    /**
-     * For socket messages you want to clear the user's changes if they are the same as what is received
-     */
     CLEAR_WHEN_SAME = "same",
-    /**
-     * For user changes you want to store them if they are different than on a parent
-     */
     KEEP_WHEN_DIFFERENT = "different",
-    /**
-     * Used when expanding local items
-     */
     APPEND = "append",
-    /**
-     * Used for query responses (you don't want to do anything with user changes)
-     */
     QUERY = "query"
 }
 /**

package/dist/types/src/classes/cache/AbstractCache.d.ts

@@ -61,9 +61,16 @@ export declare abstract class AbstractCache {
      * @internal
      */
     abstract applyChangesFromParent(parentChangesDelta: ParentChangesDelta, isCalledAfterSocketUpdate: boolean): void;
-    getParent<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fromInitial?: boolean): EntryParentNull;
+    abstract getParent<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fromInitial?: boolean, providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
     abstract getLocalItemEntryChangesTuple<ItemTypeType extends ApiEnumItemType>(itemEntryId: ItemEntry<ItemTypeType>['id']): ItemEntryChangesTuple<ItemTypeType>;
     abstract applyChangesDelta(changesDelta: ChangesDelta): PromiseInterface<ChangesDeltaResult>;
+    /**
+     * Differs from {@link getParent getParent} that it only does minimal field lookups (but you cannot provide it with fields) instead of doing {@link ItemHandlerBase.collectFields collectFields}
+     * todo: clean this up some time (merge the 2 functions)
+     *
+     * @param itemEntry
+     */
+    getParentFast(itemEntry: ItemEntry): EntryParentNull;
     protected getParentFromFields<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fields?: FieldMap<ItemTypeType>): EntryParentNull;
     /**
      * @description

package/dist/types/src/classes/cache/server/ServerCache.d.ts

@@ -1,5 +1,5 @@
 import { ApiEnumItemType } from '@rentman/backend-types';
-import { AbstractCache, ApiRequestColumnArray, ApiRequestColumnMap, ApiResponseProcessor, CachedQueryItem, ChangesDelta, ChangesDeltaResult, CollectionQuery, CollectionResourceParentIdMap, EntryParent, FieldMap, ItemEntry, ItemEntryChangesTuple, ItemIdConversionMap, OnAfterCreateCallback, ParentChangesDelta, PromiseInterface, ResponseItemUpdateModeMap, RmCore, ServerCacheDependencyInterface, ServerCachedQueryHandler, ServerItemHandler, TransactionCache, TransactionOptions, TransactionValidatorFactory } from '../../../internal';
+import { AbstractCache, ApiRequestColumnArray, ApiRequestColumnMap, ApiResponseProcessor, CachedQueryItem, ChangesDelta, ChangesDeltaResult, CollectionQuery, CollectionResourceParentIdMap, EntryParent, EntryParentNull, FieldMap, ItemEntry, ItemEntryChangesTuple, ItemIdConversionMap, OnAfterCreateCallback, ParentChangesDelta, PromiseInterface, ResponseItemUpdateModeMap, RmCore, ServerCacheDependencyInterface, ServerCachedQueryHandler, ServerItemHandler, TransactionCache, TransactionOptions, TransactionValidatorFactory } from '../../../internal';
 /**
  * @description
  * The {@link ServerCache ServerCache} is responsible for keeping track of {@link ItemEntry ItemEntries} and {@link CollectionEntry CollectionEntries}
@@ -37,6 +37,18 @@ export declare class ServerCache extends AbstractCache {
      * Gets the fields required to set the parent
      */
     getLinkFieldsByParent<ItemTypeType extends ApiEnumItemType>(parent: EntryParent, itemType: ItemTypeType): Partial<FieldMap<ItemTypeType>>;
+    /**
+     * @description
+     * Gets the entry's parent
+     *
+     * @param itemEntry The entry to get the parent from
+     * @param _fromInitial Unused parameter, there for alignment with {@link TransactionCache.getParent TransactionCache.getParent]
+     * @param _providedFields Unused parameter, there for alignment with {@link TransactionCache.getParent TransactionCache.getParent]
+     *
+     * @remark
+     * Use {@link CollectionResource.getParent CollectionResource.getParent} instead of {@link TransactionCache.getParent TransactionCache.getParent} if you're getting the parent in the onRemove callback
+     */
+    getParent<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, _fromInitial?: boolean, _providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
     /**
      * @description
      * Only takes the local changes into account, used for saving

package/dist/types/src/classes/cache/transaction/TransactionCache.d.ts

@@ -1,5 +1,5 @@
 import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
-import { AbstractCache, AbstractCacheDependencyInterface, ApiQuery, ApiRequestColumnArray, ApiRequestColumns, CachedQueryItem, CachedQueryItemTree, ChangesDelta, ChangesDeltaResult, ChildCollectionOptions, ChildCollectionResources, ChildCollectionResourcesNull, CollectionDefinition, CollectionOptionsInterface, CollectionQuery, CollectionResource, CollectionResourceParentIdMap, ConversionMap, CreateRequestParameterMap, DeregFunction, FieldChangeCallback, InternalChangesDelta, ItemEntry, ItemEntryChangesTuple, ItemEntryOptions, ItemIdConversionMap, ItemOptionsInterface, ItemResource, ItemResourcesItemTypeMap, ItemTypeColumnIds, ItemTypeMap, LinkCollectionDefinition, ModuleChangesCompilationResult, OnAfterCreateCallback, ParentChangesDelta, ParentItemMap, PromiseInterface, RmCore, ServerCache, TransactionCacheCallbackCondition, TransactionCacheCallbackType, TransactionCachedQueryHandler, TransactionCollectionHandler, TransactionEventHandler, TransactionItemHandler, TransactionOptions, TransactionValidatorFactory } from '../../../internal';
+import { AbstractCache, AbstractCacheDependencyInterface, ApiQuery, ApiRequestColumnArray, ApiRequestColumns, CachedQueryItem, CachedQueryItemTree, ChangesDelta, ChangesDeltaResult, ChildCollectionOptions, ChildCollectionResources, ChildCollectionResourcesNull, CollectionDefinition, CollectionOptionsInterface, CollectionQuery, CollectionResource, CollectionResourceParentIdMap, ConversionMap, CreateRequestParameterMap, DeregFunction, EntryParentNull, FieldChangeCallback, FieldMap, InternalChangesDelta, ItemEntry, ItemEntryChangesTuple, ItemEntryOptions, ItemIdConversionMap, ItemOptionsInterface, ItemResource, ItemResourcesItemTypeMap, ItemTypeColumnIds, ItemTypeMap, LinkCollectionDefinition, ModuleChangesCompilationResult, OnAfterCreateCallback, ParentChangesDelta, ParentItemMap, PromiseInterface, RmCore, ServerCache, TransactionCacheCallbackCondition, TransactionCacheCallbackType, TransactionCachedQueryHandler, TransactionCollectionHandler, TransactionEventHandler, TransactionItemHandler, TransactionOptions, TransactionValidatorFactory } from '../../../internal';
 declare type ItemResourceLinks<ItemTypeType extends ApiEnumItemType> = {
     main: ItemResource<ItemTypeType>;
     linked: ItemResourcesItemTypeMap;
@@ -146,6 +146,18 @@ export declare class TransactionCache extends AbstractCache {
      */
     applyChangesDelta(changesDelta: ChangesDelta | InternalChangesDelta): PromiseInterface<ChangesDeltaResult>;
     getServerCache(): ServerCache;
+    /**
+     * @description
+     * Gets the entry's parent from the closest transaction
+     *
+     * @param itemEntry The entry to get the parent from
+     * @param fromInitial If `true` the parent values will be read from {@link TransactionItemEntryChanges.initial initial} (Useful for when you've moved an entry)
+     * @param providedFields Use the provided fields instead of the cached fields, used by {@link CollectionResource.getParent CollectionResource.getParent}
+     *
+     * @remark
+     * Use {@link CollectionResource.getParent CollectionResource.getParent} instead of {@link TransactionCache.getParent TransactionCache.getParent} if you're getting the parent in the onRemove callback
+     */
+    getParent<ItemTypeType extends ApiEnumItemType = any>(itemEntry: ItemEntry<ItemTypeType>, fromInitial?: boolean, providedFields?: FieldMap<ItemTypeType>): EntryParentNull;
     getCollectionChangesRecursively<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, parsedQuery: CollectionQuery): CachedQueryItem<ItemTypeType> | undefined;
     /**
      * @description

package/dist/types/src/classes/cache/transaction/TransactionItemHandler.d.ts

@@ -20,7 +20,7 @@ export declare class TransactionItemHandler extends ItemHandlerBase {
         };
     };
     constructor(dependencies: TransactionItemHandlerDependencyInterface, transaction: TransactionCache, validator?: TransactionValidator | undefined);
-    updateLocalItemIdReferences(itemType: ApiEnumItemType, oldItemId: ItemId, newItemId: ItemId, changesDelta?: ChangesDeltaBase): void;
+    updateLocalItemIdReferences(itemType: ApiEnumItemType, oldItemId: ItemId, newItemId: ItemId): void;
     registerFieldChangeCallback<ItemTypeType extends ApiEnumItemType>(itemType: ItemTypeType, itemId: ItemId, callback: FieldChangeCallback<ItemTypeType>): DeregFunction;
     createItemEntry(createTuple: ChangesDeltaItemCreateDelta): ItemEntry;
     /**

package/dist/types/src/models/ItemResource.d.ts

@@ -15,11 +15,6 @@ export declare class ItemResource<ItemTypeType extends ApiEnumItemType = any, Co
     initial: Readonly<FieldMap<ItemTypeType, ColumnIds>>;
     constructor(factory: ItemResourceFactory, entry: ItemEntry<ItemTypeType>, transaction: TransactionCache, children: Children, _isNew: boolean);
     onConstruct(): void;
-    /**
-     * Collects all the fields from this item, useful while debugging when you want to look at the complete fieldset
-     * (because this.fields is now a proxy class)
-     */
-    collectFields(): FieldMap<ItemTypeType, ColumnIds>;
     /**
      * @description
      * Updates the fields of the item and calls onChange, when updating many fields of many items it's better to create a {@link ChangesDelta ChangesDelta} yourself so all changes can be applied at once

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rentman/rm-core",
-  "version": "12.0.5-7",
+  "version": "12.0.5",
   "description": "Rentman core functionalities",
   "main": "./dist/rm-core.js",
   "types": "./dist/types/src/index.d.ts",

package/dist/types/src/classes/BusinessLogicManager/Contact/ContactAddressBusinessLogicRule.d.ts

@@ -1,14 +0,0 @@
-import { ApiEnumItemType, ItemId } from '@rentman/backend-types';
-import { ItemResource } from '../../../models/ItemResource';
-import { TransactionCache } from '../../cache/transaction/TransactionCache';
-import { ChangesDelta } from '../../ChangesDelta';
-import { BusinessLogicRule } from '../BusinessLogicRule';
-declare type ConditionResult = ItemId[];
-declare type Dependency = ItemResource<ApiEnumItemType.Contact, ['bezoekstraat', 'bezoekhuisnummer', 'bezoekpostcode', 'bezoekstad', 'bezoekprovincie', 'bezoekland', 'poststraat', 'posthuisnummer', 'postpostcode', 'poststad', 'postprovincie', 'postland', 'factuurstraat', 'factuurhuisnummer', 'factuurpostcode', 'factuurstad', 'factuurprovincie', 'factuurland']>[];
-export declare class ContactAddressBusinessLogicRule extends BusinessLogicRule<ConditionResult, Dependency> {
-    condition(changesDelta: ChangesDelta, transaction: TransactionCache): ConditionResult | undefined;
-    dependency(transaction: TransactionCache, contactIds: ConditionResult): Promise<Dependency>;
-    apply(changesDelta: ChangesDelta, destinationChangesDelta: ChangesDelta, contactResources: Dependency): void;
-    private addressEqualsVisitingAddress;
-}
-export {};