Merge pull request #42 from spring-media/SPR-20295

SPR-20295 adding new types for non auth fetch and timeout

Author: derzierau

.github/workflows/pull_request.yml

@@ -18,12 +18,12 @@ jobs:
       - name: Checkout branch
         if: github.event.action == 'opened' || github.event.action == 'edited' || github.event.action == 'synchronize'
         uses: actions/checkout@v1.2.0
-        
-      - name: Set Node.js 10.x
+
+      - name: Set Node.js 16
         if: github.event.action == 'opened' || github.event.action == 'edited' || github.event.action == 'synchronize'
         uses: actions/setup-node@v1
         with:
-          node-version: '10.x'
+          node-version: "16"
 
       - name: Install npm
         if: github.event.action == 'opened' || github.event.action == 'edited' || github.event.action == 'synchronize'
@@ -54,11 +54,11 @@ jobs:
           git config --global user.email "ps-support-og@moveoffice.com"
           git merge ${{ github.event.pull_request.head.sha }} -m"prchecker" --stat
 
-      - name: Set Node.js 10.x
+      - name: Set Node.js 16
         if: github.event.action == 'opened' || github.event.action == 'edited' || github.event.action == 'synchronize'
         uses: actions/setup-node@v1
         with:
-          node-version: '10.x'
+          node-version: "16"
 
       - name: Install npm
         if: github.event.action == 'opened' || github.event.action == 'edited' || github.event.action == 'synchronize'

.github/workflows/push_master.yml

@@ -12,10 +12,10 @@ jobs:
       - name: Checkout branch
         uses: actions/checkout@v1.2.0
 
-      - name: Set Node.js 10.x
+      - name: Set Node.js 16
         uses: actions/setup-node@v1
         with:
-          node-version: '10.x'
+          node-version: "16"
 
       - name: Install npm
         run: npm ci
@@ -30,10 +30,10 @@ jobs:
       - name: Checkout branch
         uses: actions/checkout@v1.2.0
 
-      - name: Set Node.js 10.x
+      - name: Set Node.js 16
         uses: actions/setup-node@v1
         with:
-          node-version: '10.x'
+          node-version: "16"
 
       - name: config npm
         run: |

.gitignore

@@ -4,3 +4,5 @@
 /.rpt2_cache
 
 .idea
+
+.dcc*

README.md

@@ -9,19 +9,22 @@ ps-web-apis is a client side library to interface with ps services on ps support
 # Usage
 
 ```javascript
-import {whoamiV1} from '@spring-media/ps-web-apis'
-
-whoamiV1().then(whoami => {
-    console.log(`user login status: ${whoami.isLoggedIn() ? 'logged in' : 'logged out'}`)
-}).catch(() => {
-    console.error('handle unavilability of whoami api')
-});
+import { whoamiV1 } from "@spring-media/ps-web-apis";
+
+whoamiV1()
+  .then((whoami) => {
+    console.log(
+      `user login status: ${whoami.isLoggedIn() ? "logged in" : "logged out"}`
+    );
+  })
+  .catch(() => {
+    console.error("handle unavilability of whoami api");
+  });
 ```
 
 # Building
 
 ```
-npm i 
+npm i
 npm run build
 ```
-

package-lock.json

@@ -1,6 +1,6 @@
-import { TealiumData } from "./model";
+import { provide } from "./apiprovide";
 
-function requireApi<T>(name: string): Promise<T> {
+function requirePackage<T>(name: string): Promise<T> {
     // -- START -- static loader
     const unresolvedPackages = {} as any;
     const providedPackages = {} as any;
@@ -48,13 +48,21 @@ export interface WhoamiUserInfo {
 export interface PurchaseData {
     entitlements: [string];
 }
+export type FetchOptions = RequestInit & { timeout?: number };
+
+/**
+ * Custom fetch interface which includes the possibility to customize timeouts for fetch requests
+ */
+export type Fetch = (input: RequestInfo, init?: FetchOptions) => Promise<Response>;
 
 export interface WhoamiV1 {
     /**
      * will assert valid not outdated session before fetch will be done. backend credentials will be added automatically
      * an error is resolved if session is invalid and not refeshable (= user logged out)
+     * Important: as of version 1.9.9 all requests are timeout after 5s by default.
+     * Can be changed by adding the field timeout to the FetchOptions Interface
      */
-    authorizedFetch: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+    authorizedFetch: Fetch;
     /**
      * gives information if user is currently loggedin from ui perspective
      */
@@ -100,6 +108,17 @@ export interface WhoamiV1 {
     getUnsafePurchaseData(): Promise<PurchaseData>;
 }
 
+export interface UtilsV1 {
+    fetchWithTimeout: Fetch;
+}
+
 export function whoamiV1(): Promise<WhoamiV1> {
-    return requireApi("whoami:v1");
+    return requirePackage("whoami:v1");
 }
+
+export function utilsV1(): Promise<UtilsV1> {
+    return requirePackage("utils:v1");
+}
+
+export const provideApi = provide;
+export const requireApi = requirePackage;