@pulsecharterconnect/types 0.0.3 → 0.0.5

package/dist/index.d.ts

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

package/dist/types/ApiResult.d.ts

@@ -0,0 +1,39 @@
+export declare 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): ApiResult<TData>;
+    /** Create a successful API result */
+    static success<TData = any>(data?: TData | undefined, message?: string | undefined): ApiResult<TData>;
+    /** Reconstruct an API result from JSON */
+    static fromJson<TData = any>(json: IApiResult<TData>): ApiResult<TData>;
+    static isApiResult(resultData: any): resultData is IApiResult;
+    status: ApiResultStatus | `${ApiResultStatus}`;
+    data?: TData extends object ? {
+        [Property in keyof TData]: TData[Property];
+    } : TData;
+    message?: string;
+    protected constructor(resultJson?: Partial<IApiResult<TData>>);
+    get isSuccess(): boolean;
+    get isFailure(): boolean;
+    get asJson(): IApiResult;
+}
+/**
+ * Use this as a base class when the API returns a different data struct for an Error then a Success response.
+ */
+export declare class ApiResultWithError<T = any, E = any> extends ApiResult<T> {
+    error?: E;
+    protected constructor(resultJson: Partial<IApiResult<T>> | undefined, error: E);
+    static failure<E = any>(message?: string, error?: E | undefined): ApiResultWithError<any, E | undefined>;
+}
+/** 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/dist/types/index.d.ts

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

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("./ApiResultResponse"), exports);
+__exportStar(require("./ApiResult"), exports);

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@pulsecharterconnect/types",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "A TypeScript library for enhanced type safety.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
   "scripts": {
     "build": "tsc",
     "test": "echo \"Error: no test specified\" && exit 1",

package/dist/models/ApiResult.js

@@ -1,68 +0,0 @@
-"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

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

package/src/index.ts

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

package/src/models/ApiResult.ts

@@ -1,94 +0,0 @@
-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/ApiResultResponse.ts

@@ -1,7 +0,0 @@
-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 +0,0 @@
-export * from './ApiResultResponse';

package/tsconfig.json

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