result-tsk - npm Package Compare versions

Comparing version 2.1.3 to 2.1.4

CHANGELOG.md

@@ -106,1 +106,8 @@ # Changelog
 - Packages was updated and some methods was added
+
+## [2.1.4] — 2023-12-09
+
+### Update
+
+- Packages was updated
+- Feature to execute promise and control the error was added to able the perform to use of pure functions

lib/generic/Result.d.ts

 import { Metadata } from "../Result.interface";
 import { IResult } from "./Result.interface";
 import { ResultDto } from "../ResultDto";
+import { ResultExecution } from "../Types";
 export declare class Result<T> implements IResult<T> {
@@ -22,3 +23,6 @@ #private;
     setData(data: string | T, statusCode: number | string, message?: string): void;
+    execute<RO>(promise: Promise<ResultExecution<RO>>): Promise<IResult<T> & {
+        value: RO;
+    }>;
     toResultDto(): ResultDto;
 }

lib/generic/Result.interface.d.ts

 import { IBaseResult } from "../Result.interface";
+import { ResultExecution } from "../Types";
 import { ResultDto } from "../ResultDto";
@@ -9,2 +10,5 @@ export interface IResult<T> extends IBaseResult {
     toResultDto(): ResultDto;
+    execute<RO>(promise: Promise<ResultExecution<RO>>): Promise<IResult<T> & {
+        value: RO;
+    }>;
 }

lib/generic/Result.interface.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });

lib/generic/Result.js

 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
@@ -66,2 +75,15 @@ if (kind === "m") throw new TypeError("Private method is not writable");
     }
+    execute(promise) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let value = undefined;
+            const execution = yield promise;
+            if (execution.error) {
+                this.setError(execution.error, execution.statusCode);
+            }
+            else {
+                value = execution.value;
+            }
+            return Object.assign(Object.assign({}, this), { value });
+        });
+    }
     toResultDto() {
@@ -68,0 +90,0 @@ const result = new ResultDto_1.ResultDto();

lib/index.d.ts

@@ -5,1 +5,2 @@ export { IResult } from "./Result.interface";
 export { Result as ResultT } from "./generic/Result";
+export { ResultExecution, ResultExecutionPromise } from "./Types";

lib/index.js

@@ -0,0 +0,0 @@ "use strict";

lib/Result.d.ts

@@ -0,1 +1,2 @@
+import { ResultExecution } from "./Types";
 import { Metadata, IResult } from "./Result.interface";
@@ -18,3 +19,6 @@ import { ResultDto } from "./ResultDto";
     hasMessage(): boolean;
+    execute<RO>(promise: Promise<ResultExecution<RO>>): Promise<IResult & {
+        value: RO;
+    }>;
     toResultDto(): ResultDto;
 }

lib/Result.interface.d.ts

@@ -0,3 +1,4 @@
+import { ResultExecution } from "./Types";
 import { ResultDto } from "./ResultDto";
-declare type Metadata = Record<string, any>;
+type Metadata = Record<string, any>;
 export interface IResult {
@@ -18,4 +19,7 @@ statusCode: number | string;
     hasMetadata(): boolean;
+    execute<RO>(promise: Promise<ResultExecution<RO>>): Promise<IResult & {
+        value: RO;
+    }>;
 }
-export declare type IBaseResult = Omit<IResult, "toResultDto">;
+export type IBaseResult = Omit<IResult, "toResultDto">;
 export { Metadata };

lib/Result.interface.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });

lib/Result.js

 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
@@ -55,2 +64,15 @@ if (kind === "m") throw new TypeError("Private method is not writable");
     }
+    execute(promise) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let value = undefined;
+            const execution = yield promise;
+            if (execution.error) {
+                this.setError(execution.error, execution.statusCode);
+            }
+            else {
+                value = execution.value;
+            }
+            return Object.assign(Object.assign({}, this), { value });
+        });
+    }
     toResultDto() {
@@ -57,0 +79,0 @@ const result = new ResultDto_1.ResultDto();

lib/ResultDto.d.ts

@@ -0,0 +0,0 @@ export declare class ResultDto {

lib/ResultDto.js

@@ -0,0 +0,0 @@ "use strict";

package.json

 {
   "name": "result-tsk",
-  "version": "2.1.3",
+  "version": "2.1.4",
   "description": "result tool to use with or without NodeTskeleton template project",
@@ -34,6 +34,6 @@ "repository": {
   "devDependencies": {
-    "@types/node": "^18.0.6",
-    "typescript": "^4.7.4"
+    "@types/node": "^18.19.3",
+    "typescript": "^5.3.3"
   },
   "dependencies": {}
 }

README.md

@@ -14,3 +14,3 @@ # Result tool 🧰
 ```ts
-import { IResultT, ResultT } from "result-tsk";
+import { IResultT, ResultT,  } from "result-tsk";
 
@@ -25,2 +25,3 @@ export class UseCaseProductGet extends BaseUseCase {
 		const result = new ResultT<ProductDto>();
+
 		// With the resulting object we can control validations within other functions.
@@ -30,2 +31,3 @@ if (!this.validator.isValidEntry(result, { productMaskId: idMask })) {
 		}
+
 		const product: Product = await this.productQueryService.getByMaskId(idMask);
@@ -40,5 +42,11 @@ if (!product) {
 		}
+
 		// Or
 		if (result.hasError()) return result;
 
+		// Or
+		// The result object helps us with manage the executing flow.
+		const { value: product } = await result.execute(this.getProduct());
+		if (result.hasError()) return result;
+
 		const productDto = this.mapper.mapObject<Product, ProductDto>(product, new ProductDto());
@@ -50,2 +58,15 @@ // The result object also helps you with the response data.
 	}
+
+	private async getProduct(): ResultExecutionPromise<Product> {
+		const product: Product = await this.productQueryService.getByMaskId(idMask);
+		if (!product) {
+			return {
+				error: this.resources.get(this.resourceKeys.PRODUCT_DOES_NOT_EXIST),
+				statusCode: this.resultCodes.NOT_FOUND,
+				value: null,
+			}
+		}
+
+		return { value: product };
+	}
 }
@@ -52,0 +73,0 @@ ```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

23420

increased by18.48%

Number of package files

19

increased by11.76%

Lines of code

336

increased by25.84%

Number of lines in readme file

175

increased by13.64%

Worsened metrics

Number of medium maintenance alerts

1

increased byInfinity%

No dependency changes