@dronedeploy/rocos-js-sdk 2.6.1 → 3.0.0-alpha.20

package/services/AssetStorageService.js

@@ -1,18 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AssetStorageService = void 0;
-const api_1 = require("../constants/api");
-const RocosError_1 = require("../models/RocosError");
-const BaseServiceAbstract_1 = require("./BaseServiceAbstract");
-const RocosLogger_1 = require("../logger/RocosLogger");
-const formatServiceUrl_1 = require("../helpers/formatServiceUrl");
-class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
+import { API_PROJECT_ASSET_PATH_URL, API_PROJECT_ASSET_PROFILES_SYNC_DEFINITION_PATH_URL, API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL, API_PROJECT_ASSET_URL, API_PROJECT_FLOW_ASSET_PATH_URL, API_PROJECT_MAPPED_ASSETS_PATH_URL, API_PROJECT_MISSION_ASSETS_PATH_URL, API_PROJECT_MISSION_ASSET_PATH_URL, API_PROJECT_ROBOT_ASSET_PATH_URL, } from '../constants/api';
+import { RocosError, errorCodes } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { RocosLogger } from '../logger/RocosLogger';
+import { formatServiceUrl } from '../helpers/formatServiceUrl';
+export class AssetStorageService extends BaseServiceAbstract {
     constructor(config) {
         super(config);
-        this.logger = RocosLogger_1.RocosLogger.getInstance(`AssetStorageService(${this.config.url})`);
+        this.logger = RocosLogger.getInstance(`AssetStorageService(${this.config.url})`);
     }
     getError(e) {
-        return new RocosError_1.RocosError(e, RocosError_1.errorCodes.ASSET_STORAGE_SERVICE_ERROR);
+        return new RocosError(e, errorCodes.ASSET_STORAGE_SERVICE_ERROR);
     }
     getStatus() {
         return true;
@@ -28,7 +25,7 @@ class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
     async create(projectId, filePath, file) {
         const formData = new FormData();
         formData.append('file', file);
-        return this.callPut(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), formData, `Failed to create asset for ${projectId}, filePath ${filePath}.`);
+        return this.callPut(formatServiceUrl(API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), formData, `Failed to create asset for ${projectId}, filePath ${filePath}.`);
     }
     /**
      * Update a project asset
@@ -41,7 +38,7 @@ class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
     async update(projectId, filePath, file) {
         const formData = new FormData();
         formData.append('file', file);
-        return this.callPost(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), formData, `Failed to update asset for ${projectId}, filePath ${filePath}.`);
+        return this.callPost(formatServiceUrl(API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), formData, `Failed to update asset for ${projectId}, filePath ${filePath}.`);
     }
     /**
      * Delete a project asset
@@ -51,7 +48,7 @@ class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
      */
     // TODO: map the response object
     async delete(projectId, filePath) {
-        return this.callDelete(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), `Failed to delete asset for ${projectId}, filePath ${filePath}.`);
+        return this.callDelete(formatServiceUrl(API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), `Failed to delete asset for ${projectId}, filePath ${filePath}.`);
     }
     /**
      * Lost assets for a project or project file path
@@ -63,10 +60,10 @@ class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
     async list(projectId, filePath) {
         let url = '';
         if (filePath) {
-            url = formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure);
+            url = formatServiceUrl(API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure);
         }
         else {
-            url = formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_ASSET_URL, { url: this.config.url, projectId }, this.config.insecure);
+            url = formatServiceUrl(API_PROJECT_ASSET_URL, { url: this.config.url, projectId }, this.config.insecure);
         }
         return this.callGet(url, `Failed to get asset list for ${projectId}, filePath ${filePath}.`);
     }
@@ -78,7 +75,7 @@ class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
      */
     // TODO: map the response object
     async getAsset(projectId, filePath) {
-        return this.callGet(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), `Failed to get asset for ${projectId}, filePath ${filePath}.`, undefined, {
+        return this.callGet(formatServiceUrl(API_PROJECT_ASSET_PATH_URL, { url: this.config.url, projectId, filePath }, this.config.insecure), `Failed to get asset for ${projectId}, filePath ${filePath}.`, undefined, {
             responseType: 'blob',
         });
     }
@@ -91,7 +88,7 @@ class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param signedURL
      */
     async listRobotAssets(projectId, callsign, parent = '/', signedURL = false) {
-        return this.callGet(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_ROBOT_ASSET_PATH_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get asset for ${projectId}, callsign ${callsign}.`, { parent, signedURL });
+        return this.callGet(formatServiceUrl(API_PROJECT_ROBOT_ASSET_PATH_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get asset for ${projectId}, callsign ${callsign}.`, { parent, signedURL });
     }
     /**
      * List assets for a flow
@@ -103,7 +100,40 @@ class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param signedURL
      */
     async listFlowAssets(projectId, flowId, flowInstance, parent = '/', signedURL = false) {
-        return this.callGet(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_FLOW_ASSET_PATH_URL, { url: this.config.url, projectId, flowId, flowInstance }, this.config.insecure), `Failed to get asset for ${projectId}, flow ${flowId}, flow instance ${flowInstance}.`, { parent, signedURL });
+        return this.callGet(formatServiceUrl(API_PROJECT_FLOW_ASSET_PATH_URL, { url: this.config.url, projectId, flowId, flowInstance }, this.config.insecure), `Failed to get asset for ${projectId}, flow ${flowId}, flow instance ${flowInstance}.`, { parent, signedURL });
+    }
+    /**
+     * List assets for a mission
+     *
+     * @param projectId
+     * @param assetIdList
+     */
+    async listMissionAssets(projectId, assetIdList) {
+        const searchParams = new URLSearchParams();
+        assetIdList.forEach((assetId) => searchParams.append('assetID', assetId));
+        return this.callGet(formatServiceUrl(API_PROJECT_MISSION_ASSETS_PATH_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to get asset for ${projectId}, assetIdList ${assetIdList}.`, searchParams);
+    }
+    /**
+     * Get a single asset for a mission
+     *
+     * @param projectId
+     * @param assetId
+     */
+    async getMissionAsset(projectId, assetId) {
+        return this.callGet(formatServiceUrl(API_PROJECT_MISSION_ASSET_PATH_URL, { url: this.config.url, projectId, assetId }, this.config.insecure), `Failed to get asset for ${projectId}, dataUUID ${assetId}.`, undefined);
+    }
+    /**
+     * Lists mapped assets
+     *
+     * @param projectId
+     * @param start Start date for the query (optional)
+     * @param end End date for the query (optional)
+     */
+    async listMappedAssets(projectId, start, end) {
+        return this.callGet(formatServiceUrl(API_PROJECT_MAPPED_ASSETS_PATH_URL, { url: this.config.url, projectId }, this.config.insecure), `Failed to list mapped assets for ${projectId}.`, {
+            start: start?.toISOString() ?? '',
+            end: end?.toISOString() ?? '',
+        });
     }
     /**
      * Set Robot Sync Definitions
@@ -117,7 +147,7 @@ class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
                 'content-type': 'application/json',
             },
         };
-        return this.callPost(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), definition, `Failed to update asset for ${projectId}, callsign ${callsign}.`, httpOptions);
+        return this.callPost(formatServiceUrl(API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), definition, `Failed to update asset for ${projectId}, callsign ${callsign}.`, httpOptions);
     }
     /**
      * Get Robot Sync Definitions
@@ -125,7 +155,7 @@ class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param callsign
      */
     getRobotSyncDefinitions(projectId, callsign) {
-        return this.callGet(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get asset for ${projectId}, callsign ${callsign}.`, undefined);
+        return this.callGet(formatServiceUrl(API_PROJECT_ASSET_ROBOTS_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, callsign }, this.config.insecure), `Failed to get asset for ${projectId}, callsign ${callsign}.`, undefined);
     }
     /**
      * Set Profile Sync Definitions
@@ -139,7 +169,7 @@ class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
                 'content-type': 'application/json',
             },
         };
-        return this.callPost(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_ASSET_PROFILES_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, profileId }, this.config.insecure), definition, `Failed to update sync-definition for ${projectId}, callsign ${profileId}.`, httpOptions);
+        return this.callPost(formatServiceUrl(API_PROJECT_ASSET_PROFILES_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, profileId }, this.config.insecure), definition, `Failed to update sync-definition for ${projectId}, callsign ${profileId}.`, httpOptions);
     }
     /**
      * Get Profile Sync Definitions
@@ -147,7 +177,6 @@ class AssetStorageService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * @param profileId
      */
     getProfileSyncDefinition(projectId, profileId) {
-        return this.callGet(formatServiceUrl_1.formatServiceUrl(api_1.API_PROJECT_ASSET_PROFILES_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, profileId }, this.config.insecure), `Failed to get sync-definition for ${projectId}, callsign ${profileId}.`, undefined);
+        return this.callGet(formatServiceUrl(API_PROJECT_ASSET_PROFILES_SYNC_DEFINITION_PATH_URL, { url: this.config.url, projectId, profileId }, this.config.insecure), `Failed to get sync-definition for ${projectId}, callsign ${profileId}.`, undefined);
     }
 }
-exports.AssetStorageService = AssetStorageService;

package/services/AuthService.d.ts

@@ -1,61 +1,93 @@
-import { RocosError } from '../models/RocosError';
+import { IBaseService, IRocosSDKConfig, RocosError, Token } from '../models';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
-import { IBaseService } from '../models/IBaseService';
-import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
-import { ISignupParams } from '../models/ISignupParams';
-import { Token } from '../models/Token';
 export declare class AuthService extends BaseServiceAbstract implements IBaseService {
     protected config: IRocosSDKConfig;
     private token?;
+    private tokenRefreshTimeoutId?;
     constructor(config: IRocosSDKConfig);
     getStatus(): boolean;
+    teardown(): void;
     protected getError(e: RocosError): RocosError;
     /**
      * Set the Auth token
      * @param value - Token value
-     * @param expiresIn - Token expiry time
      */
-    setToken(value: string, expiresIn: number): void;
+    setToken(value: string | Token): void;
     /**
-     * Cleat auto token
+     * @deprecated `expiresIn` is now derived from the token. Use `setToken(value: string | Token)` instead
+     */
+    setToken(value: string | Token, expiresIn: number): void;
+    /**
+     * Clear token
      */
     clearToken(): void;
     /**
      * Get the authentication token for application Id and application Key.
      */
     getAppToken(): Promise<Token>;
-    /**
-     * Get the authentication token for logged in username and password
-     */
-    getUserToken(): Promise<Token>;
     /**
      * Get new auth token for a user
      * @desc This only works for user auth tokens, not appId auth tokens
      */
     getNewUserToken(): Promise<Token>;
+    /**
+     * Get new auth token for a user.
+     *
+     * Uses the OTP flow to exchange an external token for a user token.
+     *
+     * @desc This only works for user auth tokens, not appId auth tokens
+     */
+    private getNewUserTokenFromExternalToken;
     /**
      * Get the authentication token
+     *
+     * This will return the current token if it is not expired, otherwise it will get a new token based on your config.
      */
     getToken(): Promise<Token>;
     /**
-     * Login with email and password.
+     * Refresh the authentication token
+     *
+     * This only works for user auth tokens, not appId auth tokens.
      *
-     * @deprecated SDK can only be configured with appId and appKey or an existing token
-     * @param email - Email address
-     * @param password - Password
-     * @param invitationCode - Invitation Code (Optional)
+     * The new token is not automatically set as the current token. Use `setToken` to set the new token.
+     *
+     * @see setToken
+     * @param token the token to refresh. If not provided, the current token will be used.
      */
-    login(email: string, password: string, invitationCode?: string): Promise<any>;
-    /**
-     * Sign up
-     * @deprecated SDK can only be configured with appId and appKey or an existing token
-     * @param params = Signup payload {@link ISignupParams}
+    refreshToken(token?: Token): Promise<Token>;
+    /** Refresh the token if it is expired or will expire in the next `minutes` minutes
+     *
+     * This only works for user auth tokens, not appId auth tokens.
+     *
+     * If you want to refresh the token regardless of the expiry time, use `refreshToken`.
+     *
+     * @param minutes the number of minutes before the token expires to refresh the token
+     * @see refreshToken
      */
-    signup(params: ISignupParams): Promise<any>;
+    refreshTokenIfExpired(minutes: number): Promise<void>;
+    /** Start a 5-minute loop to check if the token needs to be refreshed
+     *
+     * This is useful when you are using GRPC services (i.e. telemetry) which does not automatically refresh the token.
+     * It is not required when using REST services as the token is refreshed automatically.
+     *
+     * The loop will stop when `stopTokenRefreshChecker` is called.
+     *
+     * @see stopTokenRefreshChecker
+     */
+    startTokenRefreshChecker(): void;
     /**
-     * Reset users password.
-     * @deprecated SDK can only be configured with appId and appKey or an existing token
-     * @param model - Reset payload
+     * Stop the token refresh checker
+     * @see startTokenRefreshChecker
+     */
+    stopTokenRefreshChecker(): void;
+    /** Check if the token refresh checker is running
+     *
+     * @see startTokenRefreshChecker
+     * @see stopTokenRefreshChecker
+     * @returns true if the token refresh checker is running
      */
-    resetPassword(model: any): Promise<any>;
+    isTokenRefreshCheckerRunning(): boolean;
+    /** Checks if the token is valid for use with the API */
+    isTokenValid(token: Token): boolean;
+    private isTokenIssuedByApp;
 }

package/services/AuthService.js

@@ -1,39 +1,48 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AuthService = void 0;
-const api_1 = require("../constants/api");
-const RocosError_1 = require("../models/RocosError");
-const BaseServiceAbstract_1 = require("./BaseServiceAbstract");
-const RocosLogger_1 = require("../logger/RocosLogger");
-const RocosStore_1 = require("../store/RocosStore");
-const Token_1 = require("../models/Token");
-const formatServiceUrl_1 = require("../helpers/formatServiceUrl");
-class AuthService extends BaseServiceAbstract_1.BaseServiceAbstract {
+import { API_APPLICATION_AUTH_URL, API_OTP_AUTH_URL, API_OTP_URL, API_USER_TOKEN_URL } from '../constants/api';
+import { RocosError, Token, errorCodes } from '../models';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { RocosLogger } from '../logger/RocosLogger';
+import { RocosStore } from '../store/RocosStore';
+import { formatServiceUrl } from '../helpers/formatServiceUrl';
+import { issuer } from '../constants/auth';
+export class AuthService extends BaseServiceAbstract {
     constructor(config) {
         super(config);
         this.config = config;
         this.config = config;
-        this.logger = RocosLogger_1.RocosLogger.getInstance(`AuthService(${this.config.url})`);
+        this.logger = RocosLogger.getInstance(`AuthService(${this.config.url})`);
+        if (this.config.token) {
+            this.setToken(this.config.token);
+        }
     }
     getStatus() {
         return true;
     }
+    teardown() {
+        if (this.isTokenRefreshCheckerRunning()) {
+            this.logger.debug('Stopping token refresh checker');
+            this.stopTokenRefreshChecker();
+        }
+    }
     getError(e) {
-        return new RocosError_1.RocosError(e, RocosError_1.errorCodes.AUTH_ERROR, e === null || e === void 0 ? void 0 : e.statusCode);
+        return new RocosError(e, errorCodes.AUTH_ERROR, e?.statusCode);
     }
-    /**
-     * Set the Auth token
-     * @param value - Token value
-     * @param expiresIn - Token expiry time
-     */
     setToken(value, expiresIn) {
-        this.token = new Token_1.Token({ value, expiresIn });
+        if (expiresIn !== undefined) {
+            this.logger.warn('setToken(value, expiresIn) is deprecated. Use setToken(value) instead');
+        }
+        if (typeof value === 'string') {
+            this.token = new Token(value);
+        }
+        else {
+            this.token = value;
+        }
         this.config.token = this.token.value;
         // output a message for token change
-        RocosStore_1.RocosStore.getChangeSubject().next({ type: 'token', url: this.config.url, data: this.token.value });
+        RocosStore.getChangeSubject().next({ type: 'token', url: this.config.url, data: this.token.value });
     }
     /**
-     * Cleat auto token
+     * Clear token
      */
     clearToken() {
         this.token = undefined;
@@ -44,111 +53,183 @@ class AuthService extends BaseServiceAbstract_1.BaseServiceAbstract {
      */
     async getAppToken() {
         if (!('appId' in this.config) || !this.config.appId || !('appKey' in this.config) || !this.config.appKey) {
-            throw new RocosError_1.RocosError('Can not get app token, missing appId and appKey', RocosError_1.errorCodes.AUTH_ERROR);
+            throw new RocosError('Can not get app token, missing appId and appKey', errorCodes.AUTH_ERROR);
         }
-        const res = await this.callPost(formatServiceUrl_1.formatServiceUrl(api_1.API_APPLICATION_AUTH_URL, { url: this.config.url }, this.config.insecure), {
+        const res = await this.callPost(formatServiceUrl(API_APPLICATION_AUTH_URL, { url: this.config.url }, this.config.insecure), {
             applicationId: this.config.appId,
             secret: this.config.appKey,
         }, 'Failed to get users auth token.', { public: true });
-        return new Token_1.Token({ value: res.token, expiresIn: res.expiresIn });
+        return new Token(res.token);
     }
     /**
-     * Get the authentication token for logged in username and password
+     * Get new auth token for a user
+     * @desc This only works for user auth tokens, not appId auth tokens
      */
-    async getUserToken() {
-        if (!('email' in this.config) || !this.config.email || !('password' in this.config) || !this.config.password) {
-            throw new RocosError_1.RocosError('Can not get user token, missing email and password', RocosError_1.errorCodes.AUTH_ERROR);
+    async getNewUserToken() {
+        if (!('token' in this.config) || !this.config.token) {
+            throw new RocosError('Can not get new app token, missing token', errorCodes.AUTH_ERROR);
         }
-        try {
-            // TODO: there is no token expiry returned on user token
-            const { token, expiresIn } = await this.login(this.config.email, this.config.password, this.config.invitationCode);
-            return new Token_1.Token({ value: token, expiresIn });
+        const token = new Token(this.config.token, this.config.refreshToken);
+        if (token?.isExpired()) {
+            throw new RocosError('Token expired', errorCodes.AUTH_ERROR);
         }
-        catch (e) {
-            const message = 'Failed to get users auth token.';
-            this.logger.error(message, e);
-            e.message = message;
-            throw new RocosError_1.RocosError(e, RocosError_1.errorCodes.AUTH_ERROR);
+        if (!this.isTokenIssuedByApp(token)) {
+            this.logger.info('Token is not issued by app. Getting new token from DD token.');
+            return this.getNewUserTokenFromExternalToken();
         }
+        return this.refreshToken(token);
     }
     /**
-     * Get new auth token for a user
+     * Get new auth token for a user.
+     *
+     * Uses the OTP flow to exchange an external token for a user token.
+     *
      * @desc This only works for user auth tokens, not appId auth tokens
      */
-    async getNewUserToken() {
-        if (!('token' in this.config)) {
-            throw new RocosError_1.RocosError('Can not get new app token, missing token', RocosError_1.errorCodes.AUTH_ERROR);
+    async getNewUserTokenFromExternalToken() {
+        if (!('token' in this.config) || !this.config.token) {
+            throw new RocosError('Can not get new token, missing token', errorCodes.AUTH_ERROR);
         }
-        const res = await this.callGet(formatServiceUrl_1.formatServiceUrl(api_1.API_USER_TOKEN_URL, { url: this.config.url }, this.config.insecure), 'Failed to get users auth token.', undefined, { public: true, headers: { Authorization: `Bearer ${this.config.token}` } });
-        return new Token_1.Token({ value: res.token });
+        const ddToken = new Token(this.config.token);
+        const { otp } = await this.callPost(formatServiceUrl(API_OTP_URL, { url: this.config.url }, this.config.insecure), undefined, 'Failed to get one time password.', { public: true, headers: { Authorization: ddToken.bearer } });
+        const { token, refreshToken } = await this.callPost(formatServiceUrl(API_OTP_AUTH_URL, { url: this.config.url }, this.config.insecure), { otp }, 'Failed to get users auth token.', { public: true });
+        return new Token(token, refreshToken);
     }
     /**
      * Get the authentication token
+     *
+     * This will return the current token if it is not expired, otherwise it will get a new token based on your config.
      */
     async getToken() {
-        if (this.token && !this.token.isExpired()) {
+        if (this.token && this.isTokenValid(this.token)) {
+            if (this.token.isExpiredIn(15, 'minutes')) {
+                this.logger.info('Token expires within 15 minutes. Refreshing.');
+                const newToken = await this.refreshToken();
+                this.setToken(newToken);
+                return newToken;
+            }
             return this.token;
         }
+        let token;
         try {
             if ('appId' in this.config && 'appKey' in this.config) {
-                this.token = await this.getAppToken();
-            }
-            else if ('email' in this.config && 'password' in this.config) {
-                this.token = await this.getUserToken();
+                token = await this.getAppToken();
             }
             else if ('token' in this.config) {
-                this.token = await this.getNewUserToken();
-            }
-            else {
-                throw new Error('Config invalid');
+                token = await this.getNewUserToken();
             }
-            this.config.token = this.token.value;
-            // output a message for token change
-            RocosStore_1.RocosStore.getChangeSubject().next({ type: 'token', url: this.config.url, data: this.token.value });
-            return this.token;
         }
         catch (e) {
             const message = 'Failed to get auth token.';
             this.logger.error(message, e);
-            e.message = message;
-            throw new RocosError_1.RocosError(e, RocosError_1.errorCodes.AUTH_ERROR);
+            if (e instanceof Error) {
+                e.message = message;
+                throw new RocosError(e, errorCodes.AUTH_ERROR);
+            }
+            else {
+                throw new RocosError(message, errorCodes.AUTH_ERROR);
+            }
+        }
+        if (!token) {
+            const message = 'Failed to get auth token. Config invalid.';
+            this.logger.error(message);
+            throw new RocosError(message, errorCodes.AUTH_ERROR);
         }
+        this.setToken(token);
+        return token;
     }
     /**
-     * Login with email and password.
+     * Refresh the authentication token
+     *
+     * This only works for user auth tokens, not appId auth tokens.
      *
-     * @deprecated SDK can only be configured with appId and appKey or an existing token
-     * @param email - Email address
-     * @param password - Password
-     * @param invitationCode - Invitation Code (Optional)
+     * The new token is not automatically set as the current token. Use `setToken` to set the new token.
+     *
+     * @see setToken
+     * @param token the token to refresh. If not provided, the current token will be used.
      */
-    // TODO: map the response object
-    async login(email, password, invitationCode) {
-        return this.callPost(formatServiceUrl_1.formatServiceUrl(api_1.API_USER_AUTH_URL, { url: this.config.url }, this.config.insecure), {
-            email,
-            password,
-            invitationCode,
-        }, 'Failed to login user.', { public: true });
+    async refreshToken(token) {
+        const tokenToRefresh = token ?? this.token;
+        if (!tokenToRefresh) {
+            throw new RocosError('No token to refresh', errorCodes.AUTH_ERROR);
+        }
+        const res = await this.callGet(formatServiceUrl(API_USER_TOKEN_URL, { url: this.config.url }, this.config.insecure), 'Failed to get users auth token.', undefined, { public: true, headers: { Authorization: tokenToRefresh.bearer } });
+        return new Token(res.token, res.refreshToken);
     }
-    /**
-     * Sign up
-     * @deprecated SDK can only be configured with appId and appKey or an existing token
-     * @param params = Signup payload {@link ISignupParams}
+    /** Refresh the token if it is expired or will expire in the next `minutes` minutes
+     *
+     * This only works for user auth tokens, not appId auth tokens.
+     *
+     * If you want to refresh the token regardless of the expiry time, use `refreshToken`.
+     *
+     * @param minutes the number of minutes before the token expires to refresh the token
+     * @see refreshToken
      */
-    // TODO: map the response object
-    async signup(params) {
-        return this.callPost(formatServiceUrl_1.formatServiceUrl(api_1.API_USER_URL, { url: this.config.url }, this.config.insecure), params, 'Failed to sign up user.', { public: true });
+    async refreshTokenIfExpired(minutes) {
+        if (this.token?.isExpiredIn(minutes, 'minutes')) {
+            this.logger.info('Token expires in 15 minutes. Refreshing.');
+            const newToken = await this.refreshToken();
+            this.setToken(newToken);
+        }
+    }
+    /** Start a 5-minute loop to check if the token needs to be refreshed
+     *
+     * This is useful when you are using GRPC services (i.e. telemetry) which does not automatically refresh the token.
+     * It is not required when using REST services as the token is refreshed automatically.
+     *
+     * The loop will stop when `stopTokenRefreshChecker` is called.
+     *
+     * @see stopTokenRefreshChecker
+     */
+    startTokenRefreshChecker() {
+        const maxInterval = 1000 * 60 * 10; // 10 minutes
+        const minInterval = 1000 * 60; // 1 minute
+        const threshold = 1000 * 60 * 15; // 15 minutes
+        if (this.isTokenRefreshCheckerRunning())
+            return;
+        if (!this.token)
+            throw new RocosError('No token to refresh', errorCodes.AUTH_ERROR);
+        if (!this.isTokenValid(this.token))
+            throw new RocosError('Token is not valid', errorCodes.AUTH_ERROR);
+        const loop = () => {
+            this.logger.debug('Checking scheduled token refresh');
+            this.refreshTokenIfExpired(15)
+                .catch((e) => {
+                this.logger.error('Failed to refresh token', e);
+            })
+                .finally(() => {
+                if (!this.token?.expires)
+                    return;
+                // schedule next check
+                const timeTillThreshold = this.token.expires.getTime() - Date.now() - threshold;
+                const interval = Math.max(minInterval, Math.min(maxInterval, timeTillThreshold));
+                this.tokenRefreshTimeoutId = setTimeout(() => loop(), interval);
+            });
+        };
+        loop();
     }
     /**
-     * Reset users password.
-     * @deprecated SDK can only be configured with appId and appKey or an existing token
-     * @param model - Reset payload
+     * Stop the token refresh checker
+     * @see startTokenRefreshChecker
      */
-    // TODO: map the request model
-    // TODO: map the response object
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async resetPassword(model) {
-        return this.callPost(formatServiceUrl_1.formatServiceUrl(api_1.API_USER_PASSWORD_RESET_URL, { url: this.config.url }, this.config.insecure), model, 'Failed to reset password.', { public: true });
+    stopTokenRefreshChecker() {
+        clearTimeout(this.tokenRefreshTimeoutId);
+        this.tokenRefreshTimeoutId = undefined;
+    }
+    /** Check if the token refresh checker is running
+     *
+     * @see startTokenRefreshChecker
+     * @see stopTokenRefreshChecker
+     * @returns true if the token refresh checker is running
+     */
+    isTokenRefreshCheckerRunning() {
+        return this.tokenRefreshTimeoutId !== undefined;
+    }
+    /** Checks if the token is valid for use with the API */
+    isTokenValid(token) {
+        return !token.isExpired() && this.isTokenIssuedByApp(token);
+    }
+    isTokenIssuedByApp(token) {
+        return token.issuer === issuer;
     }
 }
-exports.AuthService = AuthService;

package/services/AuthService.spec.d.ts

@@ -0,0 +1 @@
+export {};