pyrus-api 2.0.0 → 2.2.0

package/build/cjs/index.cjs

@@ -122,7 +122,13 @@ function packDates(key, value) {
     }
     return value;
 }
-function trimTailingSlash(url) {
+function toJson(obj) {
+    return JSON.stringify(obj, packDates);
+}
+function fromJson(str) {
+    return JSON.parse(str, extractDates);
+}
+function trimTrailingSlash(url) {
     return url.endsWith("/") ? url.slice(0, -1) : url;
 }
 function toDateTimeString(date) {
@@ -455,8 +461,8 @@ class BaseApi {
             const { access_token, api_url, files_url } = yield this._authRequest;
             this._token = access_token;
             if (api_url && files_url) {
-                this._settings.apiUrl = trimTailingSlash(api_url);
-                this._settings.filesUrl = trimTailingSlash(files_url);
+                this._settings.apiUrl = trimTrailingSlash(api_url);
+                this._settings.filesUrl = trimTrailingSlash(files_url);
             }
             else {
                 this._settings.apiUrl =
@@ -485,7 +491,7 @@ class BaseApi {
             if (resp.ok) {
                 const contentType = resp.headers.get("Content-Type");
                 if (contentType && contentType.includes("application/json")) {
-                    return JSON.parse(yield resp.text(), extractDates);
+                    return fromJson(yield resp.text());
                 }
                 return yield resp.blob();
             }
@@ -664,6 +670,12 @@ class ListsApi extends BaseApi {
             return yield this.fetchApi(yield this.getModulePath(), "PUT", JSON.stringify(request));
         });
     }
+    get(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.fetchApi((yield this.getModulePath()) +
+                `/${request.id}`, "GET");
+        });
+    }
     delete(request) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.fetchApi((yield this.getModulePath()) + `/${request.id}`, "DELETE", JSON.stringify(request));
@@ -789,12 +801,12 @@ class TasksApi extends BaseApi {
     }
     create(request) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.fetchApi(yield this.getModulePath(), "POST", JSON.stringify(request, packDates));
+            return yield this.fetchApi(yield this.getModulePath(), "POST", toJson(request));
         });
     }
     addComment(id, request) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.fetchApi((yield this.getModulePath()) + `/${id}` + Endpoints.TasksComments, "POST", JSON.stringify(request, packDates));
+            return yield this.fetchApi((yield this.getModulePath()) + `/${id}` + Endpoints.TasksComments, "POST", toJson(request));
         });
     }
 }
@@ -819,7 +831,7 @@ class FormsApi extends BaseApi {
             const processedRequest = Object.assign(Object.assign({}, request), processFilters(request && request.filters));
             if (processedRequest.filters)
                 delete processedRequest.filters;
-            return yield this.fetchApi((yield this.getModulePath()) + `/${id}` + Endpoints.FormsRegister, "POST", JSON.stringify(processedRequest, packDates));
+            return yield this.fetchApi((yield this.getModulePath()) + `/${id}` + Endpoints.FormsRegister, "POST", toJson(processedRequest));
         });
     }
     getPermissions(_a) {
@@ -926,7 +938,8 @@ class BotApi extends BaseApi {
 class PyrusApiClient extends BaseApi {
     constructor(auth, settings) {
         const currentSettings = !!settings
-            ? Object.assign(Object.assign({}, defaults), settings) : defaults;
+            ? PyrusApiClient.extendDefaults(settings)
+            : defaults;
         super({ settings: currentSettings });
         if (typeof auth === "string")
             this._token = auth;
@@ -940,6 +953,18 @@ class PyrusApiClient extends BaseApi {
             });
         });
     }
+    static extendDefaults(settings) {
+        const extendedSettings = Object.assign(Object.assign({}, defaults), settings);
+        const needTrimKeys = [
+            "apiUrl",
+            "authUrl",
+            "filesUrl",
+        ];
+        for (const key of needTrimKeys) {
+            extendedSettings[key] = trimTrailingSlash(extendedSettings[key]);
+        }
+        return extendedSettings;
+    }
     get initParams() {
         return {
             authRequest: this._authRequest,
@@ -1034,6 +1059,8 @@ exports.PyrusApiClient = PyrusApiClient;
 exports.SendSmsError = SendSmsError;
 exports.SendSmsStatus = SendSmsStatus;
 exports.SourceType = SourceType;
+exports.fromJson = fromJson;
 exports.toDateString = toDateString;
 exports.toDateTimeString = toDateTimeString;
+exports.toJson = toJson;
 exports.toTimeString = toTimeString;

package/build/esm/index.js

@@ -120,7 +120,13 @@ function packDates(key, value) {
     }
     return value;
 }
-function trimTailingSlash(url) {
+function toJson(obj) {
+    return JSON.stringify(obj, packDates);
+}
+function fromJson(str) {
+    return JSON.parse(str, extractDates);
+}
+function trimTrailingSlash(url) {
     return url.endsWith("/") ? url.slice(0, -1) : url;
 }
 function toDateTimeString(date) {
@@ -453,8 +459,8 @@ class BaseApi {
             const { access_token, api_url, files_url } = yield this._authRequest;
             this._token = access_token;
             if (api_url && files_url) {
-                this._settings.apiUrl = trimTailingSlash(api_url);
-                this._settings.filesUrl = trimTailingSlash(files_url);
+                this._settings.apiUrl = trimTrailingSlash(api_url);
+                this._settings.filesUrl = trimTrailingSlash(files_url);
             }
             else {
                 this._settings.apiUrl =
@@ -483,7 +489,7 @@ class BaseApi {
             if (resp.ok) {
                 const contentType = resp.headers.get("Content-Type");
                 if (contentType && contentType.includes("application/json")) {
-                    return JSON.parse(yield resp.text(), extractDates);
+                    return fromJson(yield resp.text());
                 }
                 return yield resp.blob();
             }
@@ -662,6 +668,12 @@ class ListsApi extends BaseApi {
             return yield this.fetchApi(yield this.getModulePath(), "PUT", JSON.stringify(request));
         });
     }
+    get(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.fetchApi((yield this.getModulePath()) +
+                `/${request.id}`, "GET");
+        });
+    }
     delete(request) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.fetchApi((yield this.getModulePath()) + `/${request.id}`, "DELETE", JSON.stringify(request));
@@ -787,12 +799,12 @@ class TasksApi extends BaseApi {
     }
     create(request) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.fetchApi(yield this.getModulePath(), "POST", JSON.stringify(request, packDates));
+            return yield this.fetchApi(yield this.getModulePath(), "POST", toJson(request));
         });
     }
     addComment(id, request) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.fetchApi((yield this.getModulePath()) + `/${id}` + Endpoints.TasksComments, "POST", JSON.stringify(request, packDates));
+            return yield this.fetchApi((yield this.getModulePath()) + `/${id}` + Endpoints.TasksComments, "POST", toJson(request));
         });
     }
 }
@@ -817,7 +829,7 @@ class FormsApi extends BaseApi {
             const processedRequest = Object.assign(Object.assign({}, request), processFilters(request && request.filters));
             if (processedRequest.filters)
                 delete processedRequest.filters;
-            return yield this.fetchApi((yield this.getModulePath()) + `/${id}` + Endpoints.FormsRegister, "POST", JSON.stringify(processedRequest, packDates));
+            return yield this.fetchApi((yield this.getModulePath()) + `/${id}` + Endpoints.FormsRegister, "POST", toJson(processedRequest));
         });
     }
     getPermissions(_a) {
@@ -924,7 +936,8 @@ class BotApi extends BaseApi {
 class PyrusApiClient extends BaseApi {
     constructor(auth, settings) {
         const currentSettings = !!settings
-            ? Object.assign(Object.assign({}, defaults), settings) : defaults;
+            ? PyrusApiClient.extendDefaults(settings)
+            : defaults;
         super({ settings: currentSettings });
         if (typeof auth === "string")
             this._token = auth;
@@ -938,6 +951,18 @@ class PyrusApiClient extends BaseApi {
             });
         });
     }
+    static extendDefaults(settings) {
+        const extendedSettings = Object.assign(Object.assign({}, defaults), settings);
+        const needTrimKeys = [
+            "apiUrl",
+            "authUrl",
+            "filesUrl",
+        ];
+        for (const key of needTrimKeys) {
+            extendedSettings[key] = trimTrailingSlash(extendedSettings[key]);
+        }
+        return extendedSettings;
+    }
     get initParams() {
         return {
             authRequest: this._authRequest,
@@ -1017,4 +1042,4 @@ class PyrusApiClient extends BaseApi {
     }
 }
 
-export { ActivityAction, ApiError, ApprovalChoice, CallEventType, ErrorCodeType, FilterMask, Flag, FormFieldType, ListType, OperatorId, PermissionLevel, PersonRights, PersonType, PyrusApiClient, SendSmsError, SendSmsStatus, SourceType, toDateString, toDateTimeString, toTimeString };
+export { ActivityAction, ApiError, ApprovalChoice, CallEventType, ErrorCodeType, FilterMask, Flag, FormFieldType, ListType, OperatorId, PermissionLevel, PersonRights, PersonType, PyrusApiClient, SendSmsError, SendSmsStatus, SourceType, fromJson, toDateString, toDateTimeString, toJson, toTimeString };

package/build/types/index.d.ts

@@ -13,6 +13,8 @@ declare module "pyrus-api" {
 		operator_id: OperatorId;
 		values: string[];
 	};
+	export function toJson(obj: any): string;
+	export function fromJson<T = any>(str: string): T;
 	export function toDateTimeString(date: Date | string): string;
 	export function toDateString(date: Date | string): string;
 	export function toTimeString(date: Date | string): string;
@@ -951,6 +953,7 @@ declare module "pyrus-api" {
 		getTasksInList(listId: number, request?: TaskListRequest): Promise<TaskListResponse>;
 		getInbox(request?: InboxRequest): Promise<TaskListResponse>;
 		create(request: CreateListRequest): Promise<PlainTaskList>;
+		get(request: ById): Promise<TaskList>;
 		delete(request: ById): Promise<void>;
 		update(request: UpdateListRequest): Promise<PlainTaskList>;
 	}
@@ -1404,6 +1407,7 @@ declare module "pyrus-api" {
 		 */
 		constructor(auth: AuthRequest | string, settings?: Settings);
 		private _authenticateClient;
+		private static extendDefaults;
 		private get initParams();
 		get role(): RoleApi;
 		get profile(): ProfileApi;

package/package.json

@@ -1,48 +1,48 @@
-{
-    "name": "pyrus-api",
-    "version": "2.0.0",
-    "description": "Pyrus API client for TypeScript",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/simplygoodsoftware/pyrusapi-typescript.git"
-    },
-    "type": "module",
-    "main": "./build/cjs/index.js",
-    "module": "./build/esm/index.js",
-    "types": "./build/types/index.d.ts",
-    "exports": {
-        "require": {
-            "default": "./build/cjs/index.cjs"
-        },
-        "import": {
-            "default": "./build/esm/index.js"
-        },
-        "types": {
-            "default": "./build/types/index.d.ts"
-        }
-    },
-    "scripts": {
-        "build": "rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript && dts-bundle-generator --project tsconfig.types.json --no-banner -o ./build/types/index.d.ts index.ts && node ./module-wrapper.js",
-        "prepare": "husky"
-    },
-    "author": {
-        "name": "Pyrus",
-        "email": "contact@pyrus.com"
-    },
-    "license": "MIT",
-    "devDependencies": {
-        "@rollup/plugin-typescript": "^11.1.6",
-        "@types/node": "^22.5.4",
-        "@types/rollup": "^0.54.0",
-        "dts-bundle-generator": "^9.5.1",
-        "husky": "^9.1.6",
-        "lint-staged": "^15.2.10",
-        "prettier": "2.5.1",
-        "rollup": "^4.21.2",
-        "rollup-plugin-cleandir": "^3.0.0",
-        "rollup-plugin-typescript2": "^0.36.0"
-    },
-    "lint-staged": {
-        "**/*": "prettier --write --ignore-unknown"
-    }
-}
+{
+    "name": "pyrus-api",
+    "version": "2.2.0",
+    "description": "Pyrus API client for TypeScript",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/simplygoodsoftware/pyrusapi-typescript.git"
+    },
+    "type": "module",
+    "main": "./build/cjs/index.js",
+    "module": "./build/esm/index.js",
+    "types": "./build/types/index.d.ts",
+    "exports": {
+        "require": {
+            "default": "./build/cjs/index.cjs"
+        },
+        "import": {
+            "default": "./build/esm/index.js"
+        },
+        "types": {
+            "default": "./build/types/index.d.ts"
+        }
+    },
+    "scripts": {
+        "build": "rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript && dts-bundle-generator --project tsconfig.types.json --no-banner -o ./build/types/index.d.ts index.ts && node ./module-wrapper.js",
+        "prepare": "husky"
+    },
+    "author": {
+        "name": "Pyrus",
+        "email": "contact@pyrus.com"
+    },
+    "license": "MIT",
+    "devDependencies": {
+        "@rollup/plugin-typescript": "^11.1.6",
+        "@types/node": "^22.5.4",
+        "@types/rollup": "^0.54.0",
+        "dts-bundle-generator": "^9.5.1",
+        "husky": "^9.1.6",
+        "lint-staged": "^15.2.10",
+        "prettier": "2.5.1",
+        "rollup": "^4.21.2",
+        "rollup-plugin-cleandir": "^3.0.0",
+        "rollup-plugin-typescript2": "^0.36.0"
+    },
+    "lint-staged": {
+        "**/*": "prettier --write --ignore-unknown"
+    }
+}