Merge pull request #13 from spring-media/userinfo

SPR-4700: add userinfo a new function

Author: fgerardwltn24

.github/workflows/pull_request.yml

@@ -18,18 +18,20 @@ jobs:
       - name: Checkout branch
         if: github.event.action == 'opened' || github.event.action == 'edited' || github.event.action == 'synchronize'
         uses: actions/checkout@master
+        
+      - name: Set Node.js 10.x
+        if: github.event.action == 'opened' || github.event.action == 'edited' || github.event.action == 'synchronize'
+        uses: actions/setup-node@v1
+        with:
+          node-version: '10.x'
 
       - name: Install npm
         if: github.event.action == 'opened' || github.event.action == 'edited' || github.event.action == 'synchronize'
-        uses: actions/npm@master
-        with:
-          args: install
+        run: npm install
 
-      - name: Npm check
+      - name: Npm format-check
         if: github.event.action == 'opened' || github.event.action == 'edited' || github.event.action == 'synchronize'
-        uses: actions/npm@master
-        with:
-          args: run check --if-present
+        run: npm run check
 
   build:
     name: Build
@@ -52,20 +54,20 @@ jobs:
           git config --global user.email "[email protected]"
           git merge ${{ github.event.pull_request.head.sha }} -m"prchecker" --stat
 
-      - name: Install npm
+      - name: Set Node.js 10.x
         if: github.event.action == 'opened' || github.event.action == 'edited' || github.event.action == 'synchronize'
-        uses: actions/npm@master
+        uses: actions/setup-node@v1
         with:
-          args: install
+          node-version: '10.x'
+
+      - name: Install npm
+        if: github.event.action == 'opened' || github.event.action == 'edited' || github.event.action == 'synchronize'
+        run: npm install
 
       - name: Test npm
         if: github.event.action == 'opened' || github.event.action == 'edited' || github.event.action == 'synchronize'
-        uses: actions/npm@master
-        with:
-          args: run test
+        run: npm run test
 
       - name: Build npm
         if: github.event.action == 'opened' || github.event.action == 'edited' || github.event.action == 'synchronize'
-        uses: actions/npm@master
-        with:
-          args: run build
+        run: npm run build

.github/workflows/push_master.yml

@@ -12,15 +12,16 @@ jobs:
       - name: Checkout branch
         uses: actions/checkout@master
 
-      - name: Install npm
-        uses: actions/npm@master
+      - name: Set Node.js 10.x
+        uses: actions/setup-node@v1
         with:
-          args: install
+          node-version: '10.x'
 
-      - name: Npm check
-        uses: actions/npm@master
-        with:
-          args: run check --if-present
+      - name: Install npm
+        run: npm install
+
+      - name: Npm format-check
+        run: npm run check --if-present
 
   build:
     name: Build
@@ -29,18 +30,16 @@ jobs:
       - name: Checkout branch
         uses: actions/checkout@master
 
+      - name: Set Node.js 10.x
+        uses: actions/setup-node@v1
+        with:
+          node-version: '10.x'
 
       - name: Install npm
-        uses: actions/npm@master
-        with:
-          args: install
+        run: npm install
 
       - name: Test npm
-        uses: actions/npm@master
-        with:
-          args: run test
+        run: npm run test
 
       - name: Build npm
-        uses: actions/npm@master
-        with:
-          args: run build
+        run: npm run build

README.md

@@ -4,7 +4,7 @@ ps-web-apis is a client side library to interface with ps services on ps support
 
 # Installation
 
-`npm install --save github:spring-media/ps-web-apis#v1.4.0`
+`npm install --save github:spring-media/ps-web-apis#v1.6.0`
 
 # Usage
 

dist/ps-web-apis.d.ts

@@ -1,3 +1,8 @@
+export interface WhoamiUserInfo {
+    user_id: string;
+    first_name?: string;
+    last_name?: string;
+}
 export interface WhoamiV1 {
     /**
      * will assert valid not outdated session before fetch will be done. backend credentials will be added automatically
@@ -33,5 +38,10 @@ export interface WhoamiV1 {
      * will update access token and therefore content entitlements to current state
      */
     forceAccessTokenRefresh(): Promise<void>;
+    /**
+     * will request userinfo from whoami backend
+     * @return {WhoamiUserInfo} some relevant userdata
+     */
+    getUserInfo(): Promise<WhoamiUserInfo>;
 }
 export declare function whoamiV1(): Promise<WhoamiV1>;

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "ps-web-apis",
-  "version": "1.0.0",
+  "version": "1.6.0",
   "description": "",
   "main": "dist/ps-web-apis.cjs.js",
   "module": "dist/ps-web-apis.esm.js",

package.json

@@ -37,6 +37,12 @@ function requireApi<T>(name: string): Promise<T> {
     });
 }
 
+export interface WhoamiUserInfo {
+    user_id: string;
+    first_name?: string;
+    last_name?: string;
+}
+
 export interface WhoamiV1 {
     /**
      * will assert valid not outdated session before fetch will be done. backend credentials will be added automatically
@@ -72,6 +78,11 @@ export interface WhoamiV1 {
      * will update access token and therefore content entitlements to current state
      */
     forceAccessTokenRefresh(): Promise<void>;
+    /**
+     * will request userinfo from whoami backend
+     * @return {WhoamiUserInfo} some relevant userdata
+     */
+    getUserInfo(): Promise<WhoamiUserInfo>;
 }
 
 export function whoamiV1(): Promise<WhoamiV1> {