Update Symbiosis To 0.0.31 (#140)

Author: henriqueleite42

CHANGELOG.md

@@ -15,6 +15,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+## [0.0.18] - 2022-02-14
+
+### Added
+
+### Changed
+
+- Update `@techmmunity/symbiosis` to [0.0.31](https://github.com/techmmunity-symbiosis/symbiosis/blob/master/CHANGELOG.md#0031---2022-02-12)
+
+### Fixed
+
+### Removed
+
 ## [0.0.17] - 2021-12-05
 
 ### Added

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@techmmunity/symbiosis-dynamodb",
-	"version": "0.0.17",
+	"version": "0.0.18",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "Apache-2.0",
@@ -38,7 +38,7 @@
 	},
 	"devDependencies": {
 		"@techmmunity/eslint-config": "^5.2.2",
-		"@techmmunity/symbiosis": "^0.0.30",
+		"@techmmunity/symbiosis": "^0.0.31",
 		"@types/jest": "^27.0.1",
 		"@vercel/ncc": "^0.33.2",
 		"eslint": "^8.9.0",

src/lib/repository/delete/index.ts

@@ -34,9 +34,11 @@ export const del = async <Entity>(
 
 	await context.connectionInstance.send(deleteItemCommand);
 
-	return context.afterDelete({
-		dataToReturn: 1,
-		where: rawWhere,
-		options: rawOptions,
-	});
+	return {
+		data: await context.afterDelete({
+			dataToReturn: 1,
+			where: rawWhere,
+			options: rawOptions,
+		}),
+	};
 };

src/lib/repository/find-one/index.ts

@@ -58,9 +58,11 @@ export const findOne = async <Entity>(
 
 	const result = item ? unmarshall(item) : undefined;
 
-	return context.afterFindOne({
-		dataToReturn: result as DatabaseEntity,
-		conditions: rawConditions,
-		options: rawOptions,
-	});
+	return {
+		data: context.afterFindOne({
+			dataToReturn: result as DatabaseEntity,
+			conditions: rawConditions,
+			options: rawOptions,
+		}),
+	};
 };

src/lib/repository/find/index.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/naming-convention */
 
 import { unmarshall } from "@aws-sdk/util-dynamodb";
+import type { ClassType } from "@techmmunity/symbiosis";
 import type { BeforeFindInput } from "@techmmunity/symbiosis/lib/repository/methods/find/before";
 import { isNotEmptyObject } from "@techmmunity/utils";
 
@@ -60,13 +61,22 @@ export const find = async <Entity>(
 		...whereProps,
 	});
 
-	const { Items } = await context.connectionInstance.send(findCommand);
+	const { Items, LastEvaluatedKey } = await context.connectionInstance.send(
+		findCommand,
+	);
 
 	const result = Items?.map(item => unmarshall(item)) || [];
 
-	return context.afterFind({
-		dataToReturn: result as Array<Entity>,
-		conditions: rawConditions,
-		options: rawOptions,
-	});
+	return {
+		data: context.afterFind({
+			dataToReturn: result as Array<Entity>,
+			conditions: rawConditions,
+			options: rawOptions,
+		}),
+		...(LastEvaluatedKey
+			? {
+					cursor: unmarshall(LastEvaluatedKey) as ClassType<Entity>,
+			  }
+			: {}),
+	};
 };

src/lib/repository/index.ts

@@ -14,6 +14,7 @@ import type {
 	FindOptions,
 	SaveData,
 	SingleSaveData,
+	ArraySaveData,
 	Logger,
 } from "@techmmunity/symbiosis";
 import { BaseRepository, SymbiosisError } from "@techmmunity/symbiosis";
@@ -27,6 +28,17 @@ import { upsert } from "./upsert";
 import { handleDatabaseError } from "../utils/handle-database-error";
 
 import type { ExtraMetadata } from "../types/extra-metadata";
+import type { CountOutput } from "../types/methods-outputs/count";
+import type { DeleteOutput } from "../types/methods-outputs/delete";
+import type { FindOutput } from "../types/methods-outputs/find";
+import type { FindOneOutput } from "../types/methods-outputs/find-one";
+import type { InsertOutput } from "../types/methods-outputs/insert";
+import type { PerformativeCountOutput } from "../types/methods-outputs/performative-count";
+import type { RecoverOutput } from "../types/methods-outputs/recover";
+import type { SaveOutput } from "../types/methods-outputs/save";
+import type { SoftDeleteOutput } from "../types/methods-outputs/soft-delete";
+import type { UpdateOutput } from "../types/methods-outputs/update";
+import type { UpsertOutput } from "../types/methods-outputs/upsert";
 
 export class Repository<Entity> extends BaseRepository<Entity, ExtraMetadata> {
 	public constructor(
@@ -54,10 +66,18 @@ export class Repository<Entity> extends BaseRepository<Entity, ExtraMetadata> {
 	 * @param options Options for this operation
 	 * @returns The entity as it's saved on the database
 	 */
-	public save<Result = Array<Entity> | Entity>(
+	public save(
+		data: SingleSaveData<Entity>,
+		options?: BaseQueryOptions,
+	): Promise<SaveOutput<Entity>>;
+	public save(
+		data: ArraySaveData<Entity>,
+		options?: BaseQueryOptions,
+	): Promise<SaveOutput<Array<Entity>>>;
+	public save(
 		data: SaveData<Entity>,
 		options?: BaseQueryOptions,
-	): Promise<Result> {
+	): Promise<SaveOutput<Array<Entity> | Entity>> {
 		return save(this as any, {
 			data,
 			options,
@@ -69,10 +89,18 @@ export class Repository<Entity> extends BaseRepository<Entity, ExtraMetadata> {
 	/**
 	 * ## NOT IMPLEMENTED!
 	 */
-	public insert<Result = Array<Entity> | Entity>(
+	public insert(
+		data: SingleSaveData<Entity>,
+		options?: BaseQueryOptions,
+	): Promise<InsertOutput<Entity>>;
+	public insert(
+		data: ArraySaveData<Entity>,
+		options?: BaseQueryOptions,
+	): Promise<InsertOutput<Array<Entity>>>;
+	public insert(
 		_data: SaveData<Entity>,
 		_options?: BaseQueryOptions,
-	): Promise<Result> {
+	): Promise<InsertOutput<Array<Entity> | Entity>> {
 		// Delete this after the method is implemented
 		throw new SymbiosisError({
 			code: "NOT_IMPLEMENTED",
@@ -109,11 +137,11 @@ export class Repository<Entity> extends BaseRepository<Entity, ExtraMetadata> {
 	/**
 	 * ## NOT IMPLEMENTED!
 	 */
-	public update<Result = Array<Entity> | Entity>(
+	public update(
 		_conditions: FindConditions<Entity>,
 		_data: SingleSaveData<Entity>,
 		_options?: BaseQueryOptions,
-	): Promise<Result> {
+	): Promise<UpdateOutput<Entity>> {
 		// Delete this after the method is implemented
 		throw new SymbiosisError({
 			code: "NOT_IMPLEMENTED",
@@ -157,11 +185,11 @@ export class Repository<Entity> extends BaseRepository<Entity, ExtraMetadata> {
 	 * @param options Options for this operation
 	 * @returns The updated record
 	 */
-	public upsert<Result = Array<Entity> | Entity>(
+	public upsert(
 		conditions: FindConditions<Entity>,
 		data: SingleSaveData<Entity>,
 		options?: BaseQueryOptions,
-	): Promise<Result> {
+	): Promise<UpsertOutput<Entity>> {
 		return upsert(this as any, {
 			conditions,
 			data,
@@ -174,7 +202,7 @@ export class Repository<Entity> extends BaseRepository<Entity, ExtraMetadata> {
 	public find(
 		conditions: FindOptions<Entity>,
 		options?: BaseQueryOptions,
-	): Promise<Array<Entity>> {
+	): Promise<FindOutput<Entity>> {
 		return find(this as any, {
 			conditions,
 			options,
@@ -186,7 +214,7 @@ export class Repository<Entity> extends BaseRepository<Entity, ExtraMetadata> {
 	public findOne(
 		conditions: FindOneOptions<Entity>,
 		options?: BaseQueryOptions,
-	): Promise<Entity> {
+	): Promise<FindOneOutput<Entity>> {
 		return findOne(this as any, {
 			conditions,
 			options,
@@ -207,7 +235,7 @@ export class Repository<Entity> extends BaseRepository<Entity, ExtraMetadata> {
 	public delete(
 		where: FindConditions<Entity>,
 		options?: BaseQueryOptions,
-	): Promise<number> {
+	): Promise<DeleteOutput> {
 		return del(this as any, {
 			where,
 			options,
@@ -222,7 +250,7 @@ export class Repository<Entity> extends BaseRepository<Entity, ExtraMetadata> {
 	public softDelete(
 		_where: FindConditions<Entity>,
 		_options?: BaseQueryOptions,
-	): Promise<number> {
+	): Promise<SoftDeleteOutput> {
 		// Delete this after the method is implemented
 		throw new SymbiosisError({
 			code: "NOT_IMPLEMENTED",
@@ -263,7 +291,7 @@ export class Repository<Entity> extends BaseRepository<Entity, ExtraMetadata> {
 	public recover(
 		_where: FindConditions<Entity>,
 		_options?: BaseQueryOptions,
-	): Promise<number> {
+	): Promise<RecoverOutput> {
 		// Delete this after the method is implemented
 		throw new SymbiosisError({
 			code: "NOT_IMPLEMENTED",
@@ -304,7 +332,7 @@ export class Repository<Entity> extends BaseRepository<Entity, ExtraMetadata> {
 	public count(
 		_where: FindConditions<Entity>,
 		_options?: BaseQueryOptions,
-	): Promise<number> {
+	): Promise<CountOutput> {
 		// Delete this after the method is implemented
 		throw new SymbiosisError({
 			code: "NOT_IMPLEMENTED",
@@ -345,7 +373,7 @@ export class Repository<Entity> extends BaseRepository<Entity, ExtraMetadata> {
 	public performativeCount(
 		_where: FindConditions<Entity>,
 		_options?: BaseQueryOptions,
-	): Promise<number> {
+	): Promise<PerformativeCountOutput> {
 		// Delete this after the method is implemented
 		throw new SymbiosisError({
 			code: "NOT_IMPLEMENTED",

src/lib/repository/save/index.ts

@@ -54,10 +54,12 @@ export const save = async <Entity>(
 		});
 	}
 
-	return context.afterSave({
-		// Dynamo doesn't return the new values, so we have to return the same data that we receive
-		data: [data as DatabaseEntity],
-		returnArray,
-		options: rawOptions,
-	});
+	return {
+		data: context.afterSave({
+			// Dynamo doesn't return the new values, so we have to return the same data that we receive
+			data: [data as DatabaseEntity],
+			returnArray,
+			options: rawOptions,
+		}),
+	};
 };

src/lib/repository/upsert/index.ts

@@ -79,9 +79,11 @@ export const upsert = async <Entity>(
 		});
 	}
 
-	return context.afterUpsert({
-		conditions: rawConditions,
-		data: unmarshall(Attributes),
-		options: rawOptions,
-	});
+	return {
+		data: context.afterUpsert({
+			conditions: rawConditions,
+			data: unmarshall(Attributes),
+			options: rawOptions,
+		}),
+	};
 };

src/lib/types/methods-outputs/count.ts

@@ -0,0 +1,3 @@
+import type { BaseCountOutput } from "@techmmunity/symbiosis";
+
+export type CountOutput = BaseCountOutput;

src/lib/types/methods-outputs/delete.ts

@@ -0,0 +1,3 @@
+import type { BaseDeleteOutput } from "@techmmunity/symbiosis";
+
+export type DeleteOutput = BaseDeleteOutput;