@pulsecharterconnect/types 0.0.2 → 0.0.3

package/dist/models/ApiResult.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiResultWithError = exports.ApiResultStatus = void 0;
+var ApiResultStatus;
+(function (ApiResultStatus) {
+    ApiResultStatus["Success"] = "success";
+    ApiResultStatus["Failed"] = "failed";
+})(ApiResultStatus = exports.ApiResultStatus || (exports.ApiResultStatus = {}));
+class ApiResult {
+    /** Create a failed API result */
+    static failure(message = "", data = undefined) {
+        return new ApiResult({
+            status: ApiResultStatus.Failed,
+            message,
+            data
+        });
+    }
+    /** Create a successful API result */
+    static success(data = undefined, message = undefined) {
+        return new ApiResult({
+            status: ApiResultStatus.Success,
+            data,
+            message
+        });
+    }
+    /** Reconstruct an API result from JSON */
+    static fromJson(json) {
+        return new ApiResult(json);
+    }
+    static isApiResult(resultData) {
+        if (!resultData)
+            return false;
+        return resultData.status && (resultData.status === ApiResultStatus.Success) || (resultData.status === ApiResultStatus.Failed);
+    }
+    constructor(resultJson = {}) {
+        this.status = ApiResultStatus.Success;
+        Object.assign(this, resultJson);
+    }
+    get isSuccess() {
+        return this.status === ApiResultStatus.Success;
+    }
+    get isFailure() {
+        return this.status === ApiResultStatus.Failed;
+    }
+    get asJson() {
+        return {
+            status: this.status,
+            data: this.data
+        };
+    }
+}
+exports.default = ApiResult;
+/**
+ * Use this as a base class when the API returns a different data struct for an Error then a Success response.
+ */
+class ApiResultWithError extends ApiResult {
+    constructor(resultJson = {}, error) {
+        super(resultJson);
+        this.error = error;
+    }
+    static failure(message = "", error = undefined) {
+        return new ApiResultWithError({
+            status: ApiResultStatus.Failed,
+            message,
+        }, error);
+    }
+}
+exports.ApiResultWithError = ApiResultWithError;

package/dist/types/ApiResultResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.js

@@ -14,4 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./ApiResult"), exports);
+__exportStar(require("./ApiResultResponse"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pulsecharterconnect/types",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "A TypeScript library for enhanced type safety.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,5 +19,8 @@
   "license": "MIT",
   "devDependencies": {
     "typescript": "^4.0.0"
+  },
+  "dependencies": {
+    "@types/express": "^5.0.0"
   }
 }

package/src/types/ApiResultResponse.ts

@@ -0,0 +1,7 @@
+import { Response } from "express"
+import ApiResult from "../models/ApiResult"
+
+
+/** alias for an express.js Response that returns an ApiResult with a given type for the data property (TData) */
+type ApiResultResponse<TData = any> = Response<ApiResult<TData>>;
+export default ApiResultResponse;

package/src/types/index.ts

@@ -1 +1 @@
-export * from './ApiResult';
+export * from './ApiResultResponse';