@xube/kit-request 0.0.1

package/dist/helpers.d.ts

@@ -0,0 +1 @@
+export declare const suggestSupportRequest: (message: string) => string;

package/dist/helpers.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.suggestSupportRequest = void 0;
+const suggestSupportRequest = (message) => message + " Please contact Xube support.";
+exports.suggestSupportRequest = suggestSupportRequest;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./helpers";
+export * from "./response/response";

package/dist/index.js

@@ -0,0 +1,18 @@
+"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("./helpers"), exports);
+__exportStar(require("./response/response"), exports);

package/dist/response/response.d.ts

@@ -0,0 +1,18 @@
+import { XubeLog } from "@xube/kit-log";
+import { DATA, ERROR, STATUS_CODE, StatusCode } from "@xube/kit-constants";
+export interface XubeResponseProps<TData> {
+    [STATUS_CODE]: StatusCode;
+    [ERROR]?: string;
+    [DATA]?: TData;
+}
+export declare class XubeResponse<TData> implements XubeResponseProps<TData> {
+    statusCode: StatusCode;
+    error?: string;
+    data?: TData;
+    constructor(props: XubeResponseProps<TData>);
+    isSuccessful: () => boolean;
+    hasFailed: () => boolean;
+}
+export declare const xubeResponseSucceeded: <TData>(xubeResponse: XubeResponse<TData>) => boolean;
+export declare const xubeResponseFailed: <TData>(xubeResponse: XubeResponse<TData>) => boolean;
+export declare const switchXubeResponseType: <TDATA_IN, TDATA_OUT>(inXubeResponse: XubeResponse<TDATA_IN>, log?: XubeLog) => XubeResponse<TDATA_OUT>;

package/dist/response/response.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.switchXubeResponseType = exports.xubeResponseFailed = exports.xubeResponseSucceeded = exports.XubeResponse = void 0;
+const kit_log_1 = require("@xube/kit-log");
+const kit_constants_1 = require("@xube/kit-constants");
+const helpers_1 = require("../helpers");
+class XubeResponse {
+    statusCode;
+    error;
+    data;
+    constructor(props) {
+        this.statusCode = props[kit_constants_1.STATUS_CODE];
+        this.error = props[kit_constants_1.ERROR] ? (0, helpers_1.suggestSupportRequest)(props[kit_constants_1.ERROR]) : undefined;
+        this.data = props[kit_constants_1.DATA];
+    }
+    isSuccessful = () => (0, exports.xubeResponseSucceeded)(this);
+    hasFailed = () => (0, exports.xubeResponseFailed)(this);
+}
+exports.XubeResponse = XubeResponse;
+const xubeResponseSucceeded = (xubeResponse) => xubeResponse.statusCode <= 300;
+exports.xubeResponseSucceeded = xubeResponseSucceeded;
+const xubeResponseFailed = (xubeResponse) => !(0, exports.xubeResponseSucceeded)(xubeResponse);
+exports.xubeResponseFailed = xubeResponseFailed;
+const switchXubeResponseType = (inXubeResponse, log = kit_log_1.XubeLog.getInstance()) => {
+    if (inXubeResponse.data) {
+        log.warn("Requester Response had data. Removing, but this could be undesired");
+        delete inXubeResponse.data;
+    }
+    return new XubeResponse({
+        statusCode: inXubeResponse.statusCode,
+        error: inXubeResponse.error,
+    });
+};
+exports.switchXubeResponseType = switchXubeResponseType;

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@xube/kit-request",
+  "version": "0.0.1",
+  "description": "",
+  "main": "dist/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/XubeLtd/data-logger.git"
+  },
+  "author": "Xube Pty Ltd",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/XubeLtd/data-logger/issues"
+  },
+  "homepage": "https://github.com/XubeLtd/data-logger#readme",
+  "dependencies": {
+    "@xube/kit-constants": "^0.0.1"
+  }
+}

package/src/helpers.ts

@@ -0,0 +1 @@
+export const suggestSupportRequest = (message: string) => message + " Please contact Xube support."

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./helpers";
+export * from "./response/response";

package/src/response/response.ts

@@ -0,0 +1,50 @@
+
+  import { XubeLog } from "@xube/kit-log";
+  import { DATA, ERROR, STATUS_CODE, StatusCode } from "@xube/kit-constants";
+import { suggestSupportRequest } from "../helpers";
+  
+  export interface XubeResponseProps<TData> {
+    [STATUS_CODE]: StatusCode;
+    [ERROR]?: string;
+    [DATA]?: TData;
+  }
+  
+  export class XubeResponse<TData> implements XubeResponseProps<TData> {
+    public statusCode: StatusCode;
+    public error?: string;
+    public data?: TData;
+  
+    constructor(props: XubeResponseProps<TData>) {
+      this.statusCode = props[STATUS_CODE];
+      this.error = props[ERROR] ? suggestSupportRequest(props[ERROR]) : undefined;
+      this.data = props[DATA];
+    }
+  
+    isSuccessful = (): boolean => xubeResponseSucceeded(this);
+    hasFailed = (): boolean => xubeResponseFailed(this);
+  }
+  
+  export const xubeResponseSucceeded = <TData>(
+    xubeResponse: XubeResponse<TData>
+  ): boolean => xubeResponse.statusCode <= 300;
+  
+  export const xubeResponseFailed = <TData>(
+    xubeResponse: XubeResponse<TData>
+  ): boolean => !xubeResponseSucceeded(xubeResponse);
+  
+  export const switchXubeResponseType = <TDATA_IN, TDATA_OUT>(
+    inXubeResponse: XubeResponse<TDATA_IN>,
+    log: XubeLog = XubeLog.getInstance()
+  ): XubeResponse<TDATA_OUT> => {
+    if (inXubeResponse.data) {
+      log.warn(
+        "Requester Response had data. Removing, but this could be undesired"
+      );
+      delete inXubeResponse.data;
+    }
+    return new XubeResponse<TDATA_OUT>({
+      statusCode: inXubeResponse.statusCode,
+      error: inXubeResponse.error,
+    });
+  };
+  

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../kit-build/tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist"
+  },
+  "exclude": ["**/*.test.ts", "**/*.mock.ts", "dist", "./src/generator.ts"],
+  "references": [
+    {
+      "path": "../kit-generator"
+    },
+    {
+      "path": "../kit-constants"
+    }
+  ]
+}