@dronedeploy/rocos-js-sdk 3.0.1-alpha.16 → 3.0.1-alpha.19

package/cjs/models/device-credentials/DeviceCredentials.d.ts

@@ -21,7 +21,7 @@ export interface DeviceCredentialCreate {
     /**
      * Will automatically be generated if not provided
      */
-    key?: string;
+    secret?: string;
     /**
      * The agent component the credentials are for e.g. dji, spot, etc.
      */
@@ -30,7 +30,22 @@ export interface DeviceCredentialCreate {
      * The system the credentials are for e.g. mqtt, rtmp, etc.
      */
     system: string;
+    /**
+     * Access control list for the credentials
+     */
+    acl?: DeviceCredentialACLItem[];
+}
+export interface DeviceCredentialACLItem {
+    /**
+     * The resource the ACL item is for e.g. /sys/product/{device_sn}/*
+     */
+    resource: string;
+    /**
+     * The action the ACL item is for e.g. allow, deny, ignore
+     */
+    action: DeviceCredentialAuthAction;
 }
+export type DeviceCredentialAuthAction = 'allow' | 'deny' | 'ignore';
 export interface DeviceCredentialAuth extends DeviceCredential {
     /**
      * The agent component the credentials are for e.g. dji, spot, etc.

package/cjs/services/AuthService.d.ts

@@ -1,10 +1,20 @@
 import { IBaseService, IRocosSDKConfig, RocosError, Token } from '../models';
+import { Observable } from 'rxjs';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 export declare class AuthService extends BaseServiceAbstract implements IBaseService {
     protected config: IRocosSDKConfig;
     private token?;
     private tokenRefreshTimeoutId?;
+    private tokenSubject$;
     constructor(config: IRocosSDKConfig);
+    /** Observable for token updates
+     *
+     * This is useful for getting notified when the token changes.
+     * i.e. when the token is refreshed from the token refresh checker.
+     *
+     * This will not emit until the token is set, either by `setToken` or by getting a new token.
+     */
+    get tokenUpdates$(): Observable<Token>;
     getStatus(): boolean;
     teardown(): void;
     protected getError(e: RocosError): RocosError;
@@ -62,9 +72,10 @@ export declare class AuthService extends BaseServiceAbstract implements IBaseSer
      * 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
+     * @returns true if the token was refreshed
      * @see refreshToken
      */
-    refreshTokenIfExpired(minutes: number): Promise<void>;
+    refreshTokenIfExpired(minutes: number): Promise<boolean>;
     /** 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.

package/cjs/services/AuthService.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuthService = void 0;
 const api_1 = require("../constants/api");
 const models_1 = require("../models");
+const rxjs_1 = require("rxjs");
 const BaseServiceAbstract_1 = require("./BaseServiceAbstract");
 const RocosLogger_1 = require("../logger/RocosLogger");
 const RocosStore_1 = require("../store/RocosStore");
@@ -12,11 +13,25 @@ class AuthService extends BaseServiceAbstract_1.BaseServiceAbstract {
     constructor(config) {
         super(config);
         this.config = config;
+        this.tokenSubject$ = new rxjs_1.Subject();
         this.config = config;
         this.logger = RocosLogger_1.RocosLogger.getInstance(`AuthService(${this.config.url})`);
         if (this.config.token) {
             this.setToken(this.config.token);
         }
+        this.tokenUpdates$.subscribe((token) => {
+            RocosStore_1.RocosStore.getChangeSubject().next({ type: 'token', url: this.config.url, data: token.value });
+        });
+    }
+    /** Observable for token updates
+     *
+     * This is useful for getting notified when the token changes.
+     * i.e. when the token is refreshed from the token refresh checker.
+     *
+     * This will not emit until the token is set, either by `setToken` or by getting a new token.
+     */
+    get tokenUpdates$() {
+        return this.tokenSubject$.asObservable();
     }
     getStatus() {
         return true;
@@ -42,7 +57,7 @@ class AuthService extends BaseServiceAbstract_1.BaseServiceAbstract {
         }
         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 });
+        this.tokenSubject$?.next(this.token);
     }
     /**
      * Clear token
@@ -166,6 +181,7 @@ class AuthService extends BaseServiceAbstract_1.BaseServiceAbstract {
      * 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
+     * @returns true if the token was refreshed
      * @see refreshToken
      */
     async refreshTokenIfExpired(minutes) {
@@ -173,7 +189,9 @@ class AuthService extends BaseServiceAbstract_1.BaseServiceAbstract {
             this.logger.info('Token expires in 15 minutes. Refreshing.');
             const newToken = await this.refreshToken();
             this.setToken(newToken);
+            return true;
         }
+        return false;
     }
     /** Start a 5-minute loop to check if the token needs to be refreshed
      *

package/esm/models/device-credentials/DeviceCredentials.d.ts

@@ -21,7 +21,7 @@ export interface DeviceCredentialCreate {
     /**
      * Will automatically be generated if not provided
      */
-    key?: string;
+    secret?: string;
     /**
      * The agent component the credentials are for e.g. dji, spot, etc.
      */
@@ -30,7 +30,22 @@ export interface DeviceCredentialCreate {
      * The system the credentials are for e.g. mqtt, rtmp, etc.
      */
     system: string;
+    /**
+     * Access control list for the credentials
+     */
+    acl?: DeviceCredentialACLItem[];
+}
+export interface DeviceCredentialACLItem {
+    /**
+     * The resource the ACL item is for e.g. /sys/product/{device_sn}/*
+     */
+    resource: string;
+    /**
+     * The action the ACL item is for e.g. allow, deny, ignore
+     */
+    action: DeviceCredentialAuthAction;
 }
+export type DeviceCredentialAuthAction = 'allow' | 'deny' | 'ignore';
 export interface DeviceCredentialAuth extends DeviceCredential {
     /**
      * The agent component the credentials are for e.g. dji, spot, etc.

package/esm/services/AuthService.d.ts

@@ -1,10 +1,20 @@
 import { IBaseService, IRocosSDKConfig, RocosError, Token } from '../models';
+import { Observable } from 'rxjs';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 export declare class AuthService extends BaseServiceAbstract implements IBaseService {
     protected config: IRocosSDKConfig;
     private token?;
     private tokenRefreshTimeoutId?;
+    private tokenSubject$;
     constructor(config: IRocosSDKConfig);
+    /** Observable for token updates
+     *
+     * This is useful for getting notified when the token changes.
+     * i.e. when the token is refreshed from the token refresh checker.
+     *
+     * This will not emit until the token is set, either by `setToken` or by getting a new token.
+     */
+    get tokenUpdates$(): Observable<Token>;
     getStatus(): boolean;
     teardown(): void;
     protected getError(e: RocosError): RocosError;
@@ -62,9 +72,10 @@ export declare class AuthService extends BaseServiceAbstract implements IBaseSer
      * 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
+     * @returns true if the token was refreshed
      * @see refreshToken
      */
-    refreshTokenIfExpired(minutes: number): Promise<void>;
+    refreshTokenIfExpired(minutes: number): Promise<boolean>;
     /** 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.

package/esm/services/AuthService.js

@@ -1,5 +1,6 @@
 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 { Subject } from 'rxjs';
 import { BaseServiceAbstract } from './BaseServiceAbstract';
 import { RocosLogger } from '../logger/RocosLogger';
 import { RocosStore } from '../store/RocosStore';
@@ -9,11 +10,25 @@ export class AuthService extends BaseServiceAbstract {
     constructor(config) {
         super(config);
         this.config = config;
+        this.tokenSubject$ = new Subject();
         this.config = config;
         this.logger = RocosLogger.getInstance(`AuthService(${this.config.url})`);
         if (this.config.token) {
             this.setToken(this.config.token);
         }
+        this.tokenUpdates$.subscribe((token) => {
+            RocosStore.getChangeSubject().next({ type: 'token', url: this.config.url, data: token.value });
+        });
+    }
+    /** Observable for token updates
+     *
+     * This is useful for getting notified when the token changes.
+     * i.e. when the token is refreshed from the token refresh checker.
+     *
+     * This will not emit until the token is set, either by `setToken` or by getting a new token.
+     */
+    get tokenUpdates$() {
+        return this.tokenSubject$.asObservable();
     }
     getStatus() {
         return true;
@@ -39,7 +54,7 @@ export class AuthService extends BaseServiceAbstract {
         }
         this.config.token = this.token.value;
         // output a message for token change
-        RocosStore.getChangeSubject().next({ type: 'token', url: this.config.url, data: this.token.value });
+        this.tokenSubject$?.next(this.token);
     }
     /**
      * Clear token
@@ -163,6 +178,7 @@ export class AuthService extends BaseServiceAbstract {
      * 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
+     * @returns true if the token was refreshed
      * @see refreshToken
      */
     async refreshTokenIfExpired(minutes) {
@@ -170,7 +186,9 @@ export class AuthService extends BaseServiceAbstract {
             this.logger.info('Token expires in 15 minutes. Refreshing.');
             const newToken = await this.refreshToken();
             this.setToken(newToken);
+            return true;
         }
+        return false;
     }
     /** Start a 5-minute loop to check if the token needs to be refreshed
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dronedeploy/rocos-js-sdk",
-  "version": "3.0.1-alpha.16",
+  "version": "3.0.1-alpha.19",
   "description": "Javascript SDK for rocos",
   "main": "cjs/index.js",
   "module": "esm/index.js",