SDK updates (#118)

* SDK updates

* get user by identifier

* Change files

* read me

* add package

* fix test

* typo

* to lower case

* added back models that were removed

* phone test

* update package

* deprecated tag

* new file and update file index.ts

* pr comments: add passkey to deprecated models

---------

Co-authored-by: github-actions <[email protected]>
Co-authored-by: Tamara Deshong <[email protected]>

Author: 3 people

README.md

@@ -101,6 +101,34 @@ app.get('/authenticatedRoute', passageAuthMiddleware, async (req, res) => {
 });
 ```
 
+## Retrieve User Info By Identifier
+
+To retrieve information about a user, you could also use the `passage.user.getUserByIdentifier()` function. You will need to use a Passage API key, which can be created in the Passage Console under your Application Settings. This API key grants your web server access to the Passage management APIs to get and update information about users. This API key must be protected and stored in an appropriate secure storage location. It should never be hard-coded in the repository.
+
+```javascript
+import Passage from '@passageidentity/passage-node';
+import express from 'express';
+
+const app = express();
+const port = 3000;
+
+let passageConfig = {
+    appID: 'YOUR_APP_ID',
+    apiKey: 'YOUR_API_KEY',
+};
+let passage = new Passage(passageConfig);
+
+// example authenticated route
+app.get('/authenticatedRoute', passageAuthMiddleware, async (req, res) => {
+    // get passage user identifier from middleware
+    let userIdentifier = res.userIdentifier;
+
+    // get user info
+    let passageUser = await passage.user.getUserByIdentifier(userIdentifier);
+    console.log(passageUser.email);
+});
+```
+
 ## Activate/Deactivate User
 
 You can also activate or deactivate a user using the Passage SDK. These actions require an API Key and deactivating a user will prevent them from logging into your application with Passage.

change/@passageidentity-passage-node-f7f50a9d-a9b6-4022-b069-ded159e71eaa.json

@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Added new method to get user by identifier, getUserByIdentifier",
+  "packageName": "@passageidentity/passage-node",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

package-lock.json

@@ -12,7 +12,7 @@
         "babel-jest": "^27.2.0",
         "beachball": "^2.37.0",
         "dotenv": "^10.0.0",
-        "eslint": "^8.5.0",
+        "eslint": "^8.57.0",
         "eslint-config-google": "^0.14.0",
         "eslint-config-prettier": "^8.3.0",
         "eslint-plugin-prettier": "^4.0.0",
@@ -24,7 +24,8 @@
         "supertest": "^6.1.6",
         "ts-jest": "^27.0.5",
         "ts-node-dev": "^2.0.0",
-        "typescript": "^4.4.3"
+        "typescript": "^4.4.3",
+        "@faker-js/faker": "^8.4.1"
     },
     "name": "@passageidentity/passage-node",
     "main": "./lib/cjs/index.js",

package.json

@@ -70,6 +70,34 @@ export default class User {
         }
     }
 
+    /**
+     * Get a user's object using their user identifier.
+     *
+     * @param {string} identifier The Passage user email or phone number
+     * @return {Promise<UserInfo>} Passage User object
+     */
+    async getUserByIdentifier(identifier: string): Promise<UserInfo> {
+        this._apiKeyCheck();
+
+        try {
+            const response = await this.#client.listPaginatedUsers({
+                appId: this.#appID,
+                limit: 1,
+                identifier: identifier.toLowerCase(),
+            });
+
+            const users = response.users;
+            if (!users.length) {
+                throw new PassageError('Could not find user with that identifier.');
+            }
+
+            return this.get(users[0].id);
+
+        } catch (err) {
+            throw new PassageError('Could not fetch user by identifier.', err as ResponseError);
+        }
+    }
+
     /**
      * Deactivate a user using their user ID.
      *

src/classes/User.ts

@@ -18,24 +18,28 @@ models/GithubUserSocialConnection.ts
 models/GoogleUserSocialConnection.ts
 models/LayoutConfig.ts
 models/Layouts.ts
+models/Link.ts
 models/ListDevicesResponse.ts
+models/ListPaginatedUsersItem.ts
+models/ListPaginatedUsersResponse.ts
 models/MagicLink.ts
 models/MagicLinkAuthMethod.ts
 models/MagicLinkChannel.ts
 models/MagicLinkResponse.ts
 models/MagicLinkType.ts
 models/Model400Error.ts
 models/Model401Error.ts
+models/Model403Error.ts
 models/Model404Error.ts
 models/Model500Error.ts
+models/Nonce.ts
 models/OtpAuthMethod.ts
+models/PaginatedLinks.ts
 models/PasskeysAuthMethod.ts
 models/Technologies.ts
 models/TtlDisplayUnit.ts
-models/UpdateMagicLinkAuthMethod.ts
-models/UpdateOtpAuthMethod.ts
-models/UpdatePasskeysAuthMethod.ts
 models/UpdateUserRequest.ts
+models/UserEventStatus.ts
 models/UserInfo.ts
 models/UserMetadataField.ts
 models/UserMetadataFieldType.ts

src/generated/.openapi-generator/FILES

@@ -19,6 +19,7 @@ import type {
   MagicLinkResponse,
   Model400Error,
   Model401Error,
+  Model403Error,
   Model404Error,
   Model500Error,
 } from '../models/index';
@@ -31,6 +32,8 @@ import {
     Model400ErrorToJSON,
     Model401ErrorFromJSON,
     Model401ErrorToJSON,
+    Model403ErrorFromJSON,
+    Model403ErrorToJSON,
     Model404ErrorFromJSON,
     Model404ErrorToJSON,
     Model500ErrorFromJSON,

src/generated/apis/MagicLinksApi.ts

@@ -16,12 +16,15 @@
 import * as runtime from '../runtime';
 import type {
   Model401Error,
+  Model403Error,
   Model404Error,
   Model500Error,
 } from '../models/index';
 import {
     Model401ErrorFromJSON,
     Model401ErrorToJSON,
+    Model403ErrorFromJSON,
+    Model403ErrorToJSON,
     Model404ErrorFromJSON,
     Model404ErrorToJSON,
     Model500ErrorFromJSON,