@pulsecharterconnect/types 0.0.1

package/README.md

@@ -0,0 +1,25 @@
+# Pulse Charter Connect Typescript Library
+
+This is a TypeScript library that provides various types and interfaces to enhance type safety in the Pulse Charter Connect Application across the frontend and backend
+
+## Installation
+
+You can install the library via npm:
+
+```
+npm install @pulsecharterconnect/types
+```
+
+## Usage
+
+To use the types and interfaces provided by this library, you can import them into your TypeScript files:
+
+```typescript
+import { ApiResult } from '@pulsecharterconnect/types';
+```
+
+## API Reference
+
+### Types
+
+- **ApiResult**: Used to respond to an HTTP request.

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./types"), exports);

package/dist/types/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/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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);

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@pulsecharterconnect/types",
+  "version": "0.0.1",
+  "description": "A TypeScript library for enhanced type safety.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "typescript",
+    "library",
+    "types",
+    "interfaces"
+  ],
+  "author": "Your Name",
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^4.0.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './types';

package/src/types/ApiResult.ts

@@ -0,0 +1,94 @@
+export enum ApiResultStatus {
+  Success = "success",
+  Failed = "failed"
+}
+
+export interface IApiResult<T = any> {
+  status: ApiResultStatus | `${ApiResultStatus}`,
+  data?: T,
+  message?: string
+}
+
+export default class ApiResult<TData = any> implements IApiResult<TData> {
+
+  /** Create a failed API result */
+  static failure<TData = any>(message: string = "", data: TData | undefined = undefined) {
+    return new ApiResult({
+      status: ApiResultStatus.Failed,
+      message,
+      data
+    })
+  }
+
+  /** Create a successful API result */
+  static success<TData = any>(data: TData | undefined = undefined, message: string | undefined = undefined) {
+    return new ApiResult({
+      status: ApiResultStatus.Success,
+      data,
+      message
+    });
+  }
+
+  /** Reconstruct an API result from JSON */
+  static fromJson<TData = any>(json: IApiResult<TData>): ApiResult<TData> {
+    return new ApiResult(json);
+  }
+
+  static isApiResult(resultData: any): resultData is IApiResult {
+    if (!resultData) return false;
+
+    return resultData.status && (resultData.status === ApiResultStatus.Success) || (resultData.status === ApiResultStatus.Failed);
+  }
+
+  status: ApiResultStatus | `${ApiResultStatus}`;
+  data?: TData extends object ? { [Property in keyof TData]: TData[Property] } : TData;
+  message?: string;
+
+  protected constructor(resultJson: Partial<IApiResult<TData>> = {}) {
+    this.status = ApiResultStatus.Success;
+    Object.assign(this, resultJson)
+  }
+
+  get isSuccess() {
+    return this.status === ApiResultStatus.Success;
+  }
+
+  get isFailure() {
+    return this.status === ApiResultStatus.Failed;
+  }
+
+  get asJson(): IApiResult {
+    return {
+      status: this.status,
+      data: this.data
+    }
+  }
+}
+
+/**
+ * Use this as a base class when the API returns a different data struct for an Error then a Success response. 
+ */
+export class ApiResultWithError<T = any, E = any> extends ApiResult<T> {
+  error?: E
+  protected constructor(resultJson: Partial<IApiResult<T>> = {}, error: E) {
+    super(resultJson);
+    this.error = error;
+  }
+  static override  failure<E = any>(message: string = "", error: E | undefined = undefined) {
+    return new ApiResultWithError({
+      status: ApiResultStatus.Failed,
+      message,
+    }, error)
+  }
+}
+
+
+// #######################
+// # Convenience Types
+// #######################
+
+/** Alias for a promise that resolves to an `ApiResult<T>` */
+export type AsyncApiResult<T = any> = Promise<ApiResult<T>>;
+
+/** Alias for a promise that resolves to an `ApiResultWithError<T, TErr>` */
+export type AsyncApiResultWithError<T = any, TErr = any> = Promise<ApiResultWithError<T, TErr>>;

package/src/types/index.ts

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

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES6",
+    "module": "commonjs",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./dist",
+    "rootDir": "./src"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "**/*.spec.ts"]
+}