Remove support for deprecated OTP functionality

todinov · todinov · commit 155efe200af1 · 2024-11-01T13:14:25.000+02:00
diff --git a/cjs/client.cjs b/cjs/client.cjs
@@ -24331,17 +24331,6 @@ Client.prototype.authenticateWithNotificationPayload = function (payload, userPi
     this._authentication(payload["userID"], userPin, ["oidc"], callback);
 };
 
-/**
- * Fetch an OTP for the specified user ID
- *
- * @param {string} userId - The unique identifier of the user
- * @param {string} userPin - The PIN associated with the userId
- * @param {function(Error, Object)} callback
- */
-Client.prototype.generateOTP = function (userId, userPin, callback) {
-    this._authentication(userId, userPin, ["otp"], callback);
-};
-
 /**
  * Fetch a registration (bootstrap) code for the specified user ID
  *
diff --git a/cjs/promise.cjs b/cjs/promise.cjs
@@ -24331,17 +24331,6 @@ Client.prototype.authenticateWithNotificationPayload = function (payload, userPi
     this._authentication(payload["userID"], userPin, ["oidc"], callback);
 };
 
-/**
- * Fetch an OTP for the specified user ID
- *
- * @param {string} userId - The unique identifier of the user
- * @param {string} userPin - The PIN associated with the userId
- * @param {function(Error, Object)} callback
- */
-Client.prototype.generateOTP = function (userId, userPin, callback) {
-    this._authentication(userId, userPin, ["otp"], callback);
-};
-
 /**
  * Fetch a registration (bootstrap) code for the specified user ID
  *
@@ -24687,10 +24676,6 @@ class PromiseInterface extends Client {
         return promisify(super.authenticateWithNotificationPayload.bind(this), payload, userPin);
     }
 
-    generateOTP(userId, userPin) {
-        return promisify(super.generateOTP.bind(this), userId, userPin);
-    }
-
     generateQuickCode(userId, userPin) {
         return promisify(super.generateQuickCode.bind(this), userId, userPin);
     }
diff --git a/dist/client.js b/dist/client.js
@@ -24332,17 +24332,6 @@ Client.prototype.authenticateWithNotificationPayload = function (payload, userPi
     this._authentication(payload["userID"], userPin, ["oidc"], callback);
 };
 
-/**
- * Fetch an OTP for the specified user ID
- *
- * @param {string} userId - The unique identifier of the user
- * @param {string} userPin - The PIN associated with the userId
- * @param {function(Error, Object)} callback
- */
-Client.prototype.generateOTP = function (userId, userPin, callback) {
-    this._authentication(userId, userPin, ["otp"], callback);
-};
-
 /**
  * Fetch a registration (bootstrap) code for the specified user ID
  *
diff --git a/dist/client.min.js b/dist/client.min.js
diff --git a/dist/client.promise.js b/dist/client.promise.js
@@ -24332,17 +24332,6 @@ Client.prototype.authenticateWithNotificationPayload = function (payload, userPi
     this._authentication(payload["userID"], userPin, ["oidc"], callback);
 };
 
-/**
- * Fetch an OTP for the specified user ID
- *
- * @param {string} userId - The unique identifier of the user
- * @param {string} userPin - The PIN associated with the userId
- * @param {function(Error, Object)} callback
- */
-Client.prototype.generateOTP = function (userId, userPin, callback) {
-    this._authentication(userId, userPin, ["otp"], callback);
-};
-
 /**
  * Fetch a registration (bootstrap) code for the specified user ID
  *
@@ -24688,10 +24677,6 @@ class PromiseInterface extends Client {
         return promisify(super.authenticateWithNotificationPayload.bind(this), payload, userPin);
     }
 
-    generateOTP(userId, userPin) {
-        return promisify(super.generateOTP.bind(this), userId, userPin);
-    }
-
     generateQuickCode(userId, userPin) {
         return promisify(super.generateQuickCode.bind(this), userId, userPin);
     }
diff --git a/dist/client.promise.min.js b/dist/client.promise.min.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@miracl/client-js",
-  "version": "8.2.0",
+  "version": "8.3.0",
   "description": "MIRACL Trust client library",
   "main": "./src/client.js",
   "exports": {
diff --git a/src/client.js b/src/client.js
@@ -461,17 +461,6 @@ Client.prototype.authenticateWithNotificationPayload = function (payload, userPi
     this._authentication(payload["userID"], userPin, ["oidc"], callback);
 };
 
-/**
- * Fetch an OTP for the specified user ID
- *
- * @param {string} userId - The unique identifier of the user
- * @param {string} userPin - The PIN associated with the userId
- * @param {function(Error, Object)} callback
- */
-Client.prototype.generateOTP = function (userId, userPin, callback) {
-    this._authentication(userId, userPin, ["otp"], callback);
-};
-
 /**
  * Fetch a registration (bootstrap) code for the specified user ID
  *
diff --git a/src/promise.js b/src/promise.js
@@ -41,10 +41,6 @@ export default class PromiseInterface extends Client {
         return promisify(super.authenticateWithNotificationPayload.bind(this), payload, userPin);
     }
 
-    generateOTP(userId, userPin) {
-        return promisify(super.generateOTP.bind(this), userId, userPin);
-    }
-
     generateQuickCode(userId, userPin) {
         return promisify(super.generateQuickCode.bind(this), userId, userPin);
     }
diff --git a/test/test-authentication.js b/test/test-authentication.js
@@ -100,16 +100,6 @@ describe("Client _getPass2", function () {
         });
     });
 
-    it("should make a request for OTP", function (done) {
-        var stub = sinon.stub(client.http, "request").yields(null, { success: true });
-        sinon.stub(client.crypto, "calculatePass2").returns();
-
-        client._getPass2({}, ["otp"], "yHex", [], [], function (err, data) {
-            expect(stub.calledOnce).to.be.true;
-            done();
-        });
-    });
-
     afterEach(function () {
         client.http.request.restore && client.http.request.restore();
         client.crypto.calculatePass2.restore && client.crypto.calculatePass2.restore();
@@ -362,7 +352,7 @@ describe("Client _authentication", function () {
         sinon.stub(client, "_getPass1").yields(null, { success: true });
         sinon.stub(client, "_getPass2").yields(null, { success: true });
 
-        client._authentication("test@example.com", "1234", ["otp"], function (err, data) {
+        client._authentication("test@example.com", "1234", ["jwt"], function (err, data) {
             expect(err).to.be.null;
             expect(requestStub.callCount).to.equal(1);
             expect(data).to.exist;
@@ -377,7 +367,7 @@ describe("Client _authentication", function () {
         var requestStub = sinon.stub(client.http, "request").yields(null, { success: true });
         requestStub.onFirstCall().yields(new Error("Request error"), { status: 400 });
 
-        client._authentication("test@example.com", "1234", ["otp"], function (err, data) {
+        client._authentication("test@example.com", "1234", ["jwt"], function (err, data) {
             expect(err).to.exist;
             expect(err.message).to.equal("Authentication fail");
             done();
@@ -391,7 +381,7 @@ describe("Client _authentication", function () {
         var requestStub = sinon.stub(client.http, "request").yields(null, { success: true });
         requestStub.onFirstCall().yields(new Error("Request error"), { error: "UNSUCCESSFUL_AUTHENTICATION" });
 
-        client._authentication("test@example.com", "1234", ["otp"], function (err, data) {
+        client._authentication("test@example.com", "1234", ["jwt"], function (err, data) {
             expect(err).to.exist;
             expect(err.message).to.equal("Unsuccessful authentication");
             done();
@@ -407,7 +397,7 @@ describe("Client _authentication", function () {
 
         var userWriteSpy = sinon.spy(client.users, "write");
 
-        client._authentication("test@example.com", "1234", ["otp"], function (err, data) {
+        client._authentication("test@example.com", "1234", ["jwt"], function (err, data) {
             expect(err).to.exist;
             expect(err.message).to.equal("Revoked");
             expect(userWriteSpy.calledOnce).to.be.true;
@@ -561,34 +551,6 @@ describe("Client authenticateWithNotificationPayload", function () {
     });
 });
 
-describe("Client generateOTP", function () {
-    var client;
-
-    before(function () {
-        client = new Client(testData.init());
-        client.users.write("test@example.com", {
-            mpinId: "exampleMpinId",
-            state: "REGISTERED"
-        });
-    });
-
-    it("should call _authentication with scope 'otp'", function (done) {
-        var authenticationStub = sinon.stub(client, "_authentication").yields(null, { success: true });
-
-        client.generateOTP("test@example.com", "1234", function (err, data) {
-            expect(err).to.be.null;
-            expect(data.success).to.be.true;
-            expect(authenticationStub.calledOnce).to.be.true;
-            expect(authenticationStub.firstCall.args[2]).to.deep.equal(["otp"]);
-            done();
-        });
-    });
-
-    afterEach(function () {
-        client._authentication.restore && client._authentication.restore();
-    });
-});
-
 describe("Client generateQuickCode", function () {
     var client;
 
diff --git a/test/test-promise.js b/test/test-promise.js
@@ -200,24 +200,6 @@ describe("Promises", function() {
         throw new Error("Unexpected result");
     });
 
-    it("should call generateOTP", async function () {
-        sinon.stub(client, "_authentication").yields(null, { message: "OK" });
-        expect(await client.generateOTP("test@example.com", "1234")).to.deep.equal({ message: "OK" });
-    });
-
-    it("should fail on generateOTP error", async function () {
-        sinon.stub(client, "_authentication").yields(new Error("Authentication error"), null);
-
-        try {
-            await client.generateOTP("test@example.com", "1234")
-        } catch (err) {
-            expect(err.message).to.equal("Authentication error");
-            return;
-        }
-
-        throw new Error("Unexpected result");
-    });
-
     it("should call generateQuickCode", async function () {
         sinon.stub(client, "_authentication").yields(null, { message: "OK" });
         expect(await client.generateQuickCode("test@example.com", "1234")).to.deep.equal({ message: "OK" });

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@miracl/client-js",`
`3`		`- "version": "8.2.0",`
	`3`	`+ "version": "8.3.0",`
`4`	`4`	`"description": "MIRACL Trust client library",`
`5`	`5`	`"main": "./src/client.js",`
`6`	`6`	`"exports": {`
Original file line number	Diff line number	Diff line change
`@@ -41,10 +41,6 @@ export default class PromiseInterface extends Client {`
`41`	`41`	`return promisify(super.authenticateWithNotificationPayload.bind(this), payload, userPin);`
`42`	`42`	`}`
`43`	`43`
`44`		`- generateOTP(userId, userPin) {`
`45`		`- return promisify(super.generateOTP.bind(this), userId, userPin);`
`46`		`- }`
`47`		`-`
`48`	`44`	`generateQuickCode(userId, userPin) {`
`49`	`45`	`return promisify(super.generateQuickCode.bind(this), userId, userPin);`
`50`	`46`	`}`