@punks/backend-entity-manager 0.0.461 → 0.0.463

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -74,7 +74,7 @@ export type ImportEntry<TSheetItem, TEntityId> = {
74
74
  status: ImportEntryValidationResult;
75
75
  };
76
76
  export interface IEntitySerializer<TEntity, TEntityId, TEntitySearchParameters, TSheetItem, TPayload = unknown> {
77
- export(filters?: TEntitySearchParameters): Promise<TSheetItem[]>;
77
+ export(filters?: TEntitySearchParameters, payload?: TPayload): Promise<TSheetItem[]>;
78
78
  import(items: TSheetItem[], payload?: TPayload): Promise<void>;
79
79
  serialize(items: TSheetItem[], format: EntitySerializationFormat, payload?: TPayload): Promise<EntityExportFile>;
80
80
  parse<TPayload>(data: Buffer, format: EntitySerializationFormat, payload?: TPayload): Promise<ImportEntry<TSheetItem, TEntityId>[]>;
@@ -1,8 +1,8 @@
1
- import { IEntityGetAction } from "../abstractions/actions";
1
+ import { IEntityGetAction, IEntityGetActionOptions } from "../abstractions/actions";
2
2
  import { IEntitySearchParameters } from "../abstractions/searchParameters";
3
3
  import { EntityServiceLocator } from "../providers/services";
4
4
  export declare class EntityGetAction<TEntity, TEntityId, TEntityDto, TEntitySearchParameters extends IEntitySearchParameters<TEntity, unknown, unknown>> implements IEntityGetAction<TEntity, TEntityId, TEntityDto, TEntitySearchParameters> {
5
5
  private readonly services;
6
6
  constructor(services: EntityServiceLocator<TEntity, TEntityId>);
7
- execute(id: TEntityId): Promise<TEntityDto | undefined>;
7
+ execute(id: TEntityId, options?: IEntityGetActionOptions<TEntity, TEntitySearchParameters>): Promise<TEntityDto | undefined>;
8
8
  }
@@ -1,5 +1,5 @@
1
1
  import { IEntityFacets } from "../abstractions";
2
- import { IEntitiesSearchAction } from "../abstractions/actions";
2
+ import { IEntitiesSearchAction, IEntitiesSearchActionOptions } from "../abstractions/actions";
3
3
  import { SortingType } from "../abstractions/common";
4
4
  import { IEntitySearchParameters } from "../abstractions/searchParameters";
5
5
  import { IEntitiesSearchResults } from "../models";
@@ -7,5 +7,5 @@ import { EntityServiceLocator } from "../providers/services";
7
7
  export declare class EntitiesSearchAction<TEntity, TEntityId, TEntitySearchParameters extends IEntitySearchParameters<TEntity, TSorting, TCursor>, TListItemDto, TSorting extends SortingType, TCursor, TFacets extends IEntityFacets> implements IEntitiesSearchAction<TEntity, TEntitySearchParameters, TListItemDto, TSorting, TCursor, TFacets> {
8
8
  private readonly services;
9
9
  constructor(services: EntityServiceLocator<TEntity, TEntityId>);
10
- execute(request: TEntitySearchParameters): Promise<IEntitiesSearchResults<TEntity, TEntitySearchParameters, TListItemDto, TSorting, TCursor, TFacets>>;
10
+ execute(request: TEntitySearchParameters, options?: IEntitiesSearchActionOptions<TEntity, TEntitySearchParameters>): Promise<IEntitiesSearchResults<TEntity, TEntitySearchParameters, TListItemDto, TSorting, TCursor, TFacets>>;
11
11
  }
@@ -17,7 +17,7 @@ export declare abstract class EntitySerializer<TEntity, TEntityId, TEntitySearch
17
17
  private readonly logger;
18
18
  protected readonly entityName: string;
19
19
  constructor(services: EntityServiceLocator<TEntity, TEntityId>, options?: EntitySerializerOptions | undefined);
20
- export(filters?: TEntitySearchParameters): Promise<TSheetItem[]>;
20
+ export(filters?: TEntitySearchParameters, payload?: TPayload): Promise<TSheetItem[]>;
21
21
  import(items: TSheetItem[], payload?: TPayload): Promise<void>;
22
22
  parse<TPayload>(data: Buffer, format: EntitySerializationFormat, payload?: TPayload): Promise<ImportEntry<TSheetItem, TEntityId>[]>;
23
23
  private parseCsv;
@@ -29,7 +29,7 @@ export declare abstract class EntitySerializer<TEntity, TEntityId, TEntitySearch
29
29
  serialize(data: TSheetItem[], format: EntitySerializationFormat, payload?: TPayload): Promise<EntityExportFile>;
30
30
  protected abstract getDefinition(context: TContext, payload?: TPayload): Promise<EntitySerializerSheetDefinition<TSheetItem>>;
31
31
  protected abstract loadEntities(filters?: TEntitySearchParameters): Promise<TEntity[]>;
32
- protected abstract convertToSheetItems(entities: TEntity[]): Promise<TSheetItem[]>;
32
+ protected abstract convertToSheetItems(entities: TEntity[], payload?: TPayload): Promise<TSheetItem[]>;
33
33
  protected validateSheetItem(item: TSheetItem, allItems: TSheetItem[], context: TContext): void;
34
34
  protected abstract importItem(item: TSheetItem, context: TContext, payload?: TPayload): Promise<EntityReference<TEntityId>>;
35
35
  protected getContext(): Promise<TContext>;
package/dist/index.d.ts CHANGED
@@ -221,7 +221,7 @@ type ImportEntry<TSheetItem, TEntityId> = {
221
221
  status: ImportEntryValidationResult;
222
222
  };
223
223
  interface IEntitySerializer<TEntity, TEntityId, TEntitySearchParameters, TSheetItem, TPayload = unknown> {
224
- export(filters?: TEntitySearchParameters): Promise<TSheetItem[]>;
224
+ export(filters?: TEntitySearchParameters, payload?: TPayload): Promise<TSheetItem[]>;
225
225
  import(items: TSheetItem[], payload?: TPayload): Promise<void>;
226
226
  serialize(items: TSheetItem[], format: EntitySerializationFormat, payload?: TPayload): Promise<EntityExportFile>;
227
227
  parse<TPayload>(data: Buffer, format: EntitySerializationFormat, payload?: TPayload): Promise<ImportEntry<TSheetItem, TEntityId>[]>;
@@ -1742,7 +1742,7 @@ declare abstract class EntitySerializer<TEntity, TEntityId, TEntitySearchParamet
1742
1742
  private readonly logger;
1743
1743
  protected readonly entityName: string;
1744
1744
  constructor(services: EntityServiceLocator<TEntity, TEntityId>, options?: EntitySerializerOptions | undefined);
1745
- export(filters?: TEntitySearchParameters): Promise<TSheetItem[]>;
1745
+ export(filters?: TEntitySearchParameters, payload?: TPayload): Promise<TSheetItem[]>;
1746
1746
  import(items: TSheetItem[], payload?: TPayload): Promise<void>;
1747
1747
  parse<TPayload>(data: Buffer, format: EntitySerializationFormat, payload?: TPayload): Promise<ImportEntry<TSheetItem, TEntityId>[]>;
1748
1748
  private parseCsv;
@@ -1754,7 +1754,7 @@ declare abstract class EntitySerializer<TEntity, TEntityId, TEntitySearchParamet
1754
1754
  serialize(data: TSheetItem[], format: EntitySerializationFormat, payload?: TPayload): Promise<EntityExportFile>;
1755
1755
  protected abstract getDefinition(context: TContext, payload?: TPayload): Promise<EntitySerializerSheetDefinition<TSheetItem>>;
1756
1756
  protected abstract loadEntities(filters?: TEntitySearchParameters): Promise<TEntity[]>;
1757
- protected abstract convertToSheetItems(entities: TEntity[]): Promise<TSheetItem[]>;
1757
+ protected abstract convertToSheetItems(entities: TEntity[], payload?: TPayload): Promise<TSheetItem[]>;
1758
1758
  protected validateSheetItem(item: TSheetItem, allItems: TSheetItem[], context: TContext): void;
1759
1759
  protected abstract importItem(item: TSheetItem, context: TContext, payload?: TPayload): Promise<EntityReference<TEntityId>>;
1760
1760
  protected getContext(): Promise<TContext>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@punks/backend-entity-manager",
3
- "version": "0.0.461",
3
+ "version": "0.0.463",
4
4
  "description": "",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",