caprover-api 0.0.5 → 0.0.7

package/README.md

@@ -19,13 +19,12 @@ import CapRoverAPI, { CapRoverModels } from 'caprover-api'
 
 const caprover = new CapRoverAPI(
     'https://captain.server.demo.caprover.com',
-    () => {
-        // get password and otp from user
+    new SimpleAuthenticationProvider(() => {
         return Promise.resolve({
             password: 'captain42',
-            otpToken: undefined, // only if 2FA is enabled
+            otpToken: undefined,
         })
-    }
+    })
 )
 
 caprover

package/dist/api/ApiManager.d.ts

@@ -28,14 +28,24 @@ export type AuthenticationContent = {
     password: string;
     otpToken?: string;
 };
-export type AuthRequiredCallback = () => Promise<AuthenticationContent>;
+export interface AuthenticationProvider {
+    onAuthTokenRequested(): Promise<string>;
+    onCredentialsRequested(): Promise<AuthenticationContent>;
+    onAuthTokenUpdated(authToken: string): void;
+}
+export declare class SimpleAuthenticationProvider implements AuthenticationProvider {
+    private onCredRequestedImpl;
+    private authToken;
+    constructor(onCredRequestedImpl: () => Promise<AuthenticationContent>);
+    onAuthTokenRequested(): Promise<string>;
+    onCredentialsRequested(): Promise<AuthenticationContent>;
+    onAuthTokenUpdated(newAuthToken: string): void;
+}
 export default class ApiManager {
-    private authCallback;
-    private authToken?;
     private http;
-    constructor(baseDomain: string, authCallback: AuthRequiredCallback, authToken?: string | undefined);
+    constructor(baseDomain: string, authProvider: AuthenticationProvider);
     destroy(): void;
-    getAuthToken(): Promise<string>;
+    login(password: string, otpToken?: string): Promise<string>;
     getAllThemes(): Promise<{
         themes: CapRoverTheme[] | undefined;
     }>;

package/dist/api/ApiManager.js

@@ -3,32 +3,55 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimpleAuthenticationProvider = void 0;
 const HttpClient_1 = __importDefault(require("./HttpClient"));
+class SimpleAuthenticationProvider {
+    constructor(onCredRequestedImpl) {
+        this.onCredRequestedImpl = onCredRequestedImpl;
+        this.authToken = '';
+    }
+    onAuthTokenRequested() {
+        return Promise.resolve(this.authToken);
+    }
+    onCredentialsRequested() {
+        return this.onCredRequestedImpl();
+    }
+    onAuthTokenUpdated(newAuthToken) {
+        this.authToken = newAuthToken;
+    }
+}
+exports.SimpleAuthenticationProvider = SimpleAuthenticationProvider;
 class ApiManager {
-    constructor(baseDomain, authCallback, authToken) {
-        this.authCallback = authCallback;
-        this.authToken = authToken;
+    constructor(baseDomain, authProvider) {
         const self = this;
         const URL = baseDomain + '/api/v2';
-        this.http = new HttpClient_1.default(URL, function () {
-            return self.getAuthToken();
-        }, authToken);
+        this.http = new HttpClient_1.default(URL, () => {
+            return authProvider.onAuthTokenRequested();
+        }, () => {
+            return Promise.resolve() //
+                .then(() => {
+                return authProvider.onCredentialsRequested();
+            })
+                .then((authContent) => {
+                return self.login(authContent.password, authContent.otpToken);
+            }) //
+                .then((authToken) => {
+                authProvider.onAuthTokenUpdated(authToken);
+            });
+        });
     }
     destroy() {
         this.http.destroy();
     }
-    getAuthToken() {
+    login(password, otpToken) {
         const self = this;
         const http = self.http;
         return Promise.resolve() //
-            .then(() => {
-            return self.authCallback();
-        })
             .then((authContent) => {
             return Promise.resolve() //
                 .then(http.fetch(http.POST, '/login', {
-                password: authContent?.password,
-                otpToken: authContent?.otpToken,
+                password: password,
+                otpToken: otpToken,
             }));
         })
             .then(function (data) {

package/dist/api/HttpClient.d.ts

@@ -1,13 +1,12 @@
 export default class HttpClient {
     private baseUrl;
-    private onAuthFailure;
-    private authToken?;
+    private authTokenProvider;
+    private onLoginRequested;
     readonly GET = "GET";
     readonly POST = "POST";
     isDestroyed: boolean;
-    constructor(baseUrl: string, onAuthFailure: () => Promise<string>, authToken?: string | undefined);
-    createHeaders(): any;
-    setAuthToken(authToken: string): void;
+    constructor(baseUrl: string, authTokenProvider: () => Promise<string>, onLoginRequested: () => Promise<void>);
+    createHeaders(): Promise<any>;
     destroy(): void;
     fetch(method: 'GET' | 'POST', endpoint: string, variables: any): () => Promise<any>;
     fetchInternal(method: 'GET' | 'POST', endpoint: string, variables: any): Promise<import("axios").AxiosResponse<any, any>>;

package/dist/api/HttpClient.js

@@ -9,27 +9,28 @@ let TOKEN_HEADER = 'x-captain-auth';
 let NAMESPACE = 'x-namespace';
 let CAPTAIN = 'captain';
 class HttpClient {
-    constructor(baseUrl, onAuthFailure, authToken) {
+    constructor(baseUrl, authTokenProvider, onLoginRequested) {
         this.baseUrl = baseUrl;
-        this.onAuthFailure = onAuthFailure;
-        this.authToken = authToken;
+        this.authTokenProvider = authTokenProvider;
+        this.onLoginRequested = onLoginRequested;
         this.GET = 'GET';
         this.POST = 'POST';
         this.isDestroyed = false;
-        if (!authToken) {
-            this.authToken = '';
-        }
+        //
     }
     createHeaders() {
         let headers = {};
-        if (this.authToken)
-            headers[TOKEN_HEADER] = this.authToken;
         headers[NAMESPACE] = CAPTAIN;
         // check user/appData or apiManager.uploadAppData before changing this signature.
-        return headers;
-    }
-    setAuthToken(authToken) {
-        this.authToken = authToken;
+        return Promise.resolve() //
+            .then(() => {
+            return this.authTokenProvider();
+        })
+            .then((authToken) => {
+            if (authToken)
+                headers[TOKEN_HEADER] = authToken;
+            return headers;
+        });
     }
     destroy() {
         this.isDestroyed = true;
@@ -43,11 +44,12 @@ class HttpClient {
             })
                 .then(function (axiosResponse) {
                 const data = axiosResponse.data; // this is an axios thing!
-                if (data.status === ErrorFactory_1.default.STATUS_AUTH_TOKEN_INVALID) {
+                if (
+                // if we ever get STATUS_ERROR_NOT_AUTHORIZED when trying to log in, we will end up in an infinite loop!
+                data.status === ErrorFactory_1.default.STATUS_AUTH_TOKEN_INVALID) {
                     return self
-                        .onAuthFailure() //
-                        .then(function (authToken) {
-                        self.setAuthToken(authToken);
+                        .onLoginRequested() //
+                        .then(function () {
                         return self
                             .fetchInternal(method, endpoint, variables)
                             .then(function (newAxiosResponse) {
@@ -55,15 +57,6 @@ class HttpClient {
                         });
                     })
                         .catch(function (error) {
-                        // Upon wrong password or back-off error, we force logout the user
-                        // to avoid getting stuck with wrong password loop
-                        if (error.captainStatus + '' ===
-                            ErrorFactory_1.default.STATUS_PASSWORD_BACK_OFF +
-                                '' ||
-                            error.captainStatus + '' ===
-                                ErrorFactory_1.default.STATUS_WRONG_PASSWORD + '') {
-                            self.setAuthToken('');
-                        }
                         return Promise.reject(error);
                     });
                 }
@@ -107,11 +100,16 @@ class HttpClient {
     }
     getReq(endpoint, variables) {
         const self = this;
-        return axios_1.default
-            .get(this.baseUrl + endpoint, {
-            params: variables,
-            headers: self.createHeaders(),
-        }) //
+        return Promise.resolve() //
+            .then(function () {
+            return self.createHeaders();
+        })
+            .then(function (headers) {
+            return axios_1.default.get(self.baseUrl + endpoint, {
+                params: variables,
+                headers: headers,
+            });
+        })
             .then(function (data) {
             // console.log(data);
             return data;
@@ -119,9 +117,14 @@ class HttpClient {
     }
     postReq(endpoint, variables) {
         const self = this;
-        return axios_1.default
-            .post(this.baseUrl + endpoint, variables, {
-            headers: self.createHeaders(),
+        return Promise.resolve() //
+            .then(function () {
+            return self.createHeaders();
+        })
+            .then(function (headers) {
+            return axios_1.default.post(self.baseUrl + endpoint, variables, {
+                headers: headers,
+            }); //
         }) //
             .then(function (data) {
             // console.log(data);

package/dist/example.js

@@ -1,16 +1,45 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-const index_1 = __importDefault(require("./index"));
-const caprover = new index_1.default('https://captain.server.demo.caprover.com', () => {
-    // get password and otp from user
+const index_1 = __importStar(require("./index"));
+const caprover = new index_1.default('https://captain.server.demo.caprover.com', new index_1.SimpleAuthenticationProvider(() => {
     return Promise.resolve({
         password: 'captain42',
         otpToken: undefined,
     });
-});
+}));
 console.log('===============================================');
 Promise.resolve()
     .then(() => {

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 import CapRoverAPI from './api/ApiManager';
 import * as CapRoverModels from './models';
+import { AuthenticationContent, SimpleAuthenticationProvider, AuthenticationProvider } from './api/ApiManager';
 export default CapRoverAPI;
 export { CapRoverModels };
+export { AuthenticationContent, SimpleAuthenticationProvider, AuthenticationProvider, };

package/dist/index.js

@@ -36,8 +36,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CapRoverModels = void 0;
+exports.SimpleAuthenticationProvider = exports.CapRoverModels = void 0;
 const ApiManager_1 = __importDefault(require("./api/ApiManager"));
 const CapRoverModels = __importStar(require("./models"));
 exports.CapRoverModels = CapRoverModels;
+const ApiManager_2 = require("./api/ApiManager");
+Object.defineProperty(exports, "SimpleAuthenticationProvider", { enumerable: true, get: function () { return ApiManager_2.SimpleAuthenticationProvider; } });
 exports.default = ApiManager_1.default;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "caprover-api",
-    "version": "0.0.5",
+    "version": "0.0.7",
     "description": "API client for CapRover",
     "types": "dist/index.d.ts",
     "main": "dist/index.js",

package/src/api/ApiManager.ts

@@ -36,24 +36,58 @@ export type AuthenticationContent = {
     otpToken?: string
 }
 
-export type AuthRequiredCallback = () => Promise<AuthenticationContent>
+export interface AuthenticationProvider {
+    onAuthTokenRequested(): Promise<string>
+    onCredentialsRequested(): Promise<AuthenticationContent>
+    onAuthTokenUpdated(authToken: string): void
+}
+
+export class SimpleAuthenticationProvider implements AuthenticationProvider {
+    private authToken: string = ''
+
+    constructor(
+        private onCredRequestedImpl: () => Promise<AuthenticationContent>
+    ) {}
+
+    onAuthTokenRequested(): Promise<string> {
+        return Promise.resolve(this.authToken)
+    }
+
+    onCredentialsRequested(): Promise<AuthenticationContent> {
+        return this.onCredRequestedImpl()
+    }
+
+    onAuthTokenUpdated(newAuthToken: string) {
+        this.authToken = newAuthToken
+    }
+}
 
 export default class ApiManager {
     private http: HttpClient
 
-    constructor(
-        baseDomain: string,
-        private authCallback: AuthRequiredCallback,
-        private authToken?: string
-    ) {
+    constructor(baseDomain: string, authProvider: AuthenticationProvider) {
         const self = this
         const URL = baseDomain + '/api/v2'
         this.http = new HttpClient(
             URL,
-            function () {
-                return self.getAuthToken()
+            () => {
+                return authProvider.onAuthTokenRequested()
             },
-            authToken
+            () => {
+                return Promise.resolve() //
+                    .then(() => {
+                        return authProvider.onCredentialsRequested()
+                    })
+                    .then((authContent) => {
+                        return self.login(
+                            authContent.password,
+                            authContent.otpToken
+                        )
+                    }) //
+                    .then((authToken) => {
+                        authProvider.onAuthTokenUpdated(authToken)
+                    })
+            }
         )
     }
 
@@ -61,20 +95,17 @@ export default class ApiManager {
         this.http.destroy()
     }
 
-    getAuthToken(): Promise<string> {
+    login(password: string, otpToken?: string): Promise<string> {
         const self = this
         const http = self.http
 
         return Promise.resolve() //
-            .then(() => {
-                return self.authCallback()
-            })
             .then((authContent) => {
                 return Promise.resolve() //
                     .then(
                         http.fetch(http.POST, '/login', {
-                            password: authContent?.password,
-                            otpToken: authContent?.otpToken,
+                            password: password,
+                            otpToken: otpToken,
                         })
                     )
             })

package/src/api/HttpClient.ts

@@ -1,5 +1,6 @@
 import axios from 'axios'
 import ErrorFactory from './ErrorFactory'
+import { AuthenticationProvider } from './ApiManager'
 
 let TOKEN_HEADER = 'x-captain-auth'
 let NAMESPACE = 'x-namespace'
@@ -12,25 +13,26 @@ export default class HttpClient {
 
     constructor(
         private baseUrl: string,
-        private onAuthFailure: () => Promise<string>,
-        private authToken?: string
+        private authTokenProvider: () => Promise<string>,
+        private onLoginRequested: () => Promise<void>
     ) {
-        if (!authToken) {
-            this.authToken = ''
-        }
+        //
     }
 
     createHeaders() {
         let headers: any = {}
-        if (this.authToken) headers[TOKEN_HEADER] = this.authToken
         headers[NAMESPACE] = CAPTAIN
 
         // check user/appData or apiManager.uploadAppData before changing this signature.
-        return headers
-    }
 
-    setAuthToken(authToken: string) {
-        this.authToken = authToken
+        return Promise.resolve() //
+            .then(() => {
+                return this.authTokenProvider()
+            })
+            .then((authToken) => {
+                if (authToken) headers[TOKEN_HEADER] = authToken
+                return headers
+            })
     }
 
     destroy() {
@@ -48,12 +50,12 @@ export default class HttpClient {
                     const data = axiosResponse.data // this is an axios thing!
 
                     if (
+                        // if we ever get STATUS_ERROR_NOT_AUTHORIZED when trying to log in, we will end up in an infinite loop!
                         data.status === ErrorFactory.STATUS_AUTH_TOKEN_INVALID
                     ) {
                         return self
-                            .onAuthFailure() //
-                            .then(function (authToken) {
-                                self.setAuthToken(authToken)
+                            .onLoginRequested() //
+                            .then(function () {
                                 return self
                                     .fetchInternal(method, endpoint, variables)
                                     .then(function (newAxiosResponse) {
@@ -61,18 +63,6 @@ export default class HttpClient {
                                     })
                             })
                             .catch(function (error) {
-                                // Upon wrong password or back-off error, we force logout the user
-                                // to avoid getting stuck with wrong password loop
-                                if (
-                                    error.captainStatus + '' ===
-                                        ErrorFactory.STATUS_PASSWORD_BACK_OFF +
-                                            '' ||
-                                    error.captainStatus + '' ===
-                                        ErrorFactory.STATUS_WRONG_PASSWORD + ''
-                                ) {
-                                    self.setAuthToken('')
-                                }
-
                                 return Promise.reject(error)
                             })
                     } else {
@@ -120,11 +110,16 @@ export default class HttpClient {
 
     getReq(endpoint: string, variables: any) {
         const self = this
-        return axios
-            .get(this.baseUrl + endpoint, {
-                params: variables,
-                headers: self.createHeaders(),
-            }) //
+        return Promise.resolve() //
+            .then(function () {
+                return self.createHeaders()
+            })
+            .then(function (headers) {
+                return axios.get(self.baseUrl + endpoint, {
+                    params: variables,
+                    headers: headers,
+                })
+            })
             .then(function (data) {
                 // console.log(data);
                 return data
@@ -133,9 +128,14 @@ export default class HttpClient {
 
     postReq(endpoint: string, variables: any) {
         const self = this
-        return axios
-            .post(this.baseUrl + endpoint, variables, {
-                headers: self.createHeaders(),
+        return Promise.resolve() //
+            .then(function () {
+                return self.createHeaders()
+            })
+            .then(function (headers) {
+                return axios.post(self.baseUrl + endpoint, variables, {
+                    headers: headers,
+                }) //
             }) //
             .then(function (data) {
                 // console.log(data);

package/src/example.ts

@@ -1,14 +1,16 @@
-import CapRoverAPI, { CapRoverModels } from './index'
+import CapRoverAPI, {
+    CapRoverModels,
+    SimpleAuthenticationProvider,
+} from './index'
 
 const caprover = new CapRoverAPI(
     'https://captain.server.demo.caprover.com',
-    () => {
-        // get password and otp from user
+    new SimpleAuthenticationProvider(() => {
         return Promise.resolve({
             password: 'captain42',
             otpToken: undefined,
         })
-    }
+    })
 )
 
 console.log('===============================================')

package/src/index.ts

@@ -1,5 +1,15 @@
 import CapRoverAPI from './api/ApiManager'
 import * as CapRoverModels from './models'
+import {
+    AuthenticationContent,
+    SimpleAuthenticationProvider,
+    AuthenticationProvider,
+} from './api/ApiManager'
 
 export default CapRoverAPI
 export { CapRoverModels }
+export {
+    AuthenticationContent,
+    SimpleAuthenticationProvider,
+    AuthenticationProvider,
+}