@c8y/client 1022.45.2 → 1023.0.0

package/lib/src/user/UserService.d.ts

@@ -14,6 +14,7 @@ export declare class UserService extends Service<IUser> {
     protected baseUrl: string;
     protected currentUserUrl: string;
     protected passwordResetUrl: string;
+    protected validateResetTokenUrl: string;
     protected currentUserPhoneUrl: string;
     protected verifyTFACodeUrl: string;
     protected totpCurrentUserURL: string;
@@ -230,6 +231,30 @@ export declare class UserService extends Service<IUser> {
      * ```
      */
     resetPassword(newPassword: IResetPassword, tenantId?: string): Promise<IResult<null>>;
+    /**
+     * Validates a password reset token for a specific user and tenant.
+     *
+     * @param token - The reset token to validate.
+     * @param email - The email address of the user.
+     * @returns A promise that resolves to an IResult object containing the response and null data.
+     *
+     * @example
+     * ```typescript
+     * async function checkTokenStatus(token: string, email: string) {
+     *   try {
+     *     await userService.validateResetToken(token, email);
+     *     return 'valid';
+     *   } catch (e) {
+     *     if (e.res?.status === 422) {
+     *       return 'expired';
+     *     } else {
+     *       return 'invalid';
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    validateResetToken(token: string, email: string): Promise<IResult<null>>;
     /**
      * Verifies TFA code which is sent via SMS. If invoked with string '0', new TFA code will be sent.
      *

package/lib/src/user/UserService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UserService.d.ts","sourceRoot":"","sources":["../../../src/user/UserService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAiB,MAAM,SAAS,CAAC;AACvE,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;GAGG;AACH,qBAAa,WAAY,SAAQ,OAAO,CAAC,KAAK,CAAC;IAC7C,SAAS,KAAK,OAAO,WAEpB;IACD,SAAS,CAAC,OAAO,SAAU;IAC3B,SAAS,CAAC,cAAc,SAAiB;IACzC,SAAS,CAAC,gBAAgB,SAAmB;IAC7C,SAAS,CAAC,mBAAmB,SAAsB;IACnD,SAAS,CAAC,gBAAgB,SAAS;IACnC,SAAS,CAAC,kBAAkB,SAAuC;IACnE,SAAS,CAAC,iBAAiB,SAAuC;IAClE,SAAS,CAAC,mBAAmB,SAAyC;IACtE,SAAS,CAAC,mBAAmB,SAAuB;IACpD,SAAS,KAAK,mBAAmB,WAEhC;IACD,SAAS,KAAK,sBAAsB,WAEnC;IACD,SAAS,KAAK,kBAAkB,WAE/B;IACD,SAAS,CAAC,YAAY,SAAW;IAEjC;;;;;;;;;;;;;;;;;;;OAmBG;IACG,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,EAAE,MAAM,GAAE,MAAW;IAIrE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,MAAM,CAAC,MAAM,EAAE,KAAK;IAI1B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC;IAInC;;;;;;;;;;;;;;;;;;;OAmBG;IACG,IAAI,CAAC,MAAM,GAAE,MAAW;IAI9B;;;;;;;;;;;;;;;;OAgBG;IACG,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,WAAW;IAItD;;;;;;;;;;;;;;;;;OAiBG;IACH,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK;IAIvD;;;;;;;;;;;;;;OAcG;IACG,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAUxC;;;;;;;;;;;;OAYG;IACG,yBAAyB,IAAI,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAUjE;;;;;;OAMG;IACG,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IASlE;;;;;;;;;;;;;;;;;OAiBG;IACG,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAUrF;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,aAAa,CAAC,WAAW,EAAE,cAAc,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAU3F;;;;;;;;;;;;;;OAcG;IACG,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAQxD;;;;;;;;;;;;;;OAcG;IACG,cAAc,CAAC,IAAI,KAAA,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAQlD;;;;;;;;;;;;OAYG;IACG,YAAY,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAQ5C;;;;;;;;;;;;;OAaG;IACG,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAQtD;;;;;;;;;;;;;OAaG;IACG,kBAAkB,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAQnD;;;;;;OAMG;IACG,gBAAgB,CAAC,IAAI,EAAE,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAQ3D;;;;OAIG;IACG,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAc1E;;;;OAIG;IACG,mBAAmB,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAWrD;;;;;;;;OAQG;IACG,kBAAkB,CACtB,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,EACnC,WAAW,EAAE,MAAM,EACnB,mBAAmB,EAAE,MAAM,GAC1B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAQzB;;;;;;;OAOG;IACG,yBAAyB,CAC7B,WAAW,EAAE,MAAM,EACnB,mBAAmB,EAAE,MAAM,GAC1B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAQzB;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAO5C,OAAO,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;IAI5D,WAAW,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO;IAInE,UAAU,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO;IAIlE,gBAAgB,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,OAAO;IAI9E,YAAY,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY;IAIvC,aAAa,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY;IAIxC,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,GAAG;IAOnD,SAAS,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM;IAInE,SAAS,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM;IAY5D,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY,EAAE,MAAM,KAAA;IAQ1D,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY,EAAE,MAAM,KAAA;IAO5D,SAAS,CAAC,mBAAmB,CAAC,UAAU,KAAA,EAAE,MAAM,KAAA;IAIhD,SAAS,CAAC,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK;IAInE,SAAS,CAAC,mBAAmB,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY,EAAE,YAAY,EAAE,MAAM;CAK/E"}
+{"version":3,"file":"UserService.d.ts","sourceRoot":"","sources":["../../../src/user/UserService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAiB,MAAM,SAAS,CAAC;AACvE,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;GAGG;AACH,qBAAa,WAAY,SAAQ,OAAO,CAAC,KAAK,CAAC;IAC7C,SAAS,KAAK,OAAO,WAEpB;IACD,SAAS,CAAC,OAAO,SAAU;IAC3B,SAAS,CAAC,cAAc,SAAiB;IACzC,SAAS,CAAC,gBAAgB,SAAmB;IAC7C,SAAS,CAAC,qBAAqB,SAA4B;IAC3D,SAAS,CAAC,mBAAmB,SAAsB;IACnD,SAAS,CAAC,gBAAgB,SAAS;IACnC,SAAS,CAAC,kBAAkB,SAAuC;IACnE,SAAS,CAAC,iBAAiB,SAAuC;IAClE,SAAS,CAAC,mBAAmB,SAAyC;IACtE,SAAS,CAAC,mBAAmB,SAAuB;IACpD,SAAS,KAAK,mBAAmB,WAEhC;IACD,SAAS,KAAK,sBAAsB,WAEnC;IACD,SAAS,KAAK,kBAAkB,WAE/B;IACD,SAAS,CAAC,YAAY,SAAW;IAEjC;;;;;;;;;;;;;;;;;;;OAmBG;IACG,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,EAAE,MAAM,GAAE,MAAW;IAIrE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,MAAM,CAAC,MAAM,EAAE,KAAK;IAI1B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC;IAInC;;;;;;;;;;;;;;;;;;;OAmBG;IACG,IAAI,CAAC,MAAM,GAAE,MAAW;IAI9B;;;;;;;;;;;;;;;;OAgBG;IACG,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,WAAW;IAItD;;;;;;;;;;;;;;;;;OAiBG;IACH,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK;IAIvD;;;;;;;;;;;;;;OAcG;IACG,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAUxC;;;;;;;;;;;;OAYG;IACG,yBAAyB,IAAI,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAUjE;;;;;;OAMG;IACG,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IASlE;;;;;;;;;;;;;;;;;OAiBG;IACG,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAUrF;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,aAAa,CAAC,WAAW,EAAE,cAAc,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAU3F;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAS9E;;;;;;;;;;;;;;OAcG;IACG,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAQxD;;;;;;;;;;;;;;OAcG;IACG,cAAc,CAAC,IAAI,KAAA,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAQlD;;;;;;;;;;;;OAYG;IACG,YAAY,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAQ5C;;;;;;;;;;;;;OAaG;IACG,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAQtD;;;;;;;;;;;;;OAaG;IACG,kBAAkB,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAQnD;;;;;;OAMG;IACG,gBAAgB,CAAC,IAAI,EAAE,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAQ3D;;;;OAIG;IACG,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAc1E;;;;OAIG;IACG,mBAAmB,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAWrD;;;;;;;;OAQG;IACG,kBAAkB,CACtB,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,EACnC,WAAW,EAAE,MAAM,EACnB,mBAAmB,EAAE,MAAM,GAC1B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAQzB;;;;;;;OAOG;IACG,yBAAyB,CAC7B,WAAW,EAAE,MAAM,EACnB,mBAAmB,EAAE,MAAM,GAC1B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAQzB;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAO5C,OAAO,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;IAI5D,WAAW,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO;IAInE,UAAU,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO;IAIlE,gBAAgB,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,OAAO;IAI9E,YAAY,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY;IAIvC,aAAa,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY;IAIxC,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,GAAG;IAOnD,SAAS,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM;IAInE,SAAS,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM;IAY5D,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY,EAAE,MAAM,KAAA;IAQ1D,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY,EAAE,MAAM,KAAA;IAO5D,SAAS,CAAC,mBAAmB,CAAC,UAAU,KAAA,EAAE,MAAM,KAAA;IAIhD,SAAS,CAAC,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK;IAInE,SAAS,CAAC,mBAAmB,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY,EAAE,YAAY,EAAE,MAAM;CAK/E"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@c8y/client",
-  "version": "1022.45.2",
+  "version": "1023.0.0",
   "license": "Apache-2.0",
   "author": "Cumulocity",
   "description": "Client application programming interface to access the Cumulocity IoT-Platform REST services.",
@@ -45,7 +45,7 @@
   "types": "lib/index.d.ts",
   "dependencies": {
     "@types/cometd": "4.0.8",
-    "@types/node": "18",
+    "@types/node": "20",
     "b2a": "1.1.2",
     "cometd": "4.0.8",
     "cometd-nodejs-client": "1.0.2",
@@ -61,7 +61,7 @@
     "ncp": "2.0.0",
     "rimraf": "2.6.2",
     "ts-jest": "^29.4.0",
-    "typedoc": "0.28.13",
+    "typedoc": "0.28.14",
     "typescript": "5.5.4"
   }
 }