@mindline/sync 1.0.101 → 1.0.103

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mindline/sync",
-  "version": "1.0.101",
+  "version": "1.0.103",
   "description": "sync is a node.js package encapsulating JavaScript classes required for configuring Mindline sync service.",
   "main": "dist/sync.es.js",
   "types": "dist/index.d.ts",

package/src/index.d.ts

@@ -137,7 +137,7 @@ declare module "@mindline/sync" {
         isReadPermissionConsented: boolean;
         isWritePermissionConsented: boolean;
     }
-    export class Config {
+    export class SyncConfig {
         id: string;
         workspaceId: string;
         name: string;
@@ -154,11 +154,15 @@ declare module "@mindline/sync" {
         name: string;
         description: string;
         isEnabled: boolean;
+        isReadPermissionConsented: boolean;
         email: string;
         tenantId: string;
         sel: boolean; // selection state
         constructor();
     }
+
+    export type ConfigType = 'sync' | 'auditlogs';
+
     // class to group Users, Tenants, and Configs
     export class Workspace {
         id: string;
@@ -175,7 +179,8 @@ declare module "@mindline/sync" {
         tab: number;
         us: User[];
         ts: Tenant[];
-        cs: Config[];
+        cs: SyncConfig[];
+        acs: AuditConfig[];
         ws: Workspace[];
         configlevelconsent_configid: string;
         configlevelconsent_access: TenantConfigType;
@@ -252,13 +257,13 @@ declare module "@mindline/sync" {
         pb_total: number;
         pb_timer: NodeJS.Timer;
         milestoneArray: MilestoneArray;
-        constructor(config: Config|null, syncPortalGlobalState: InitInfo|null, bClearLocalStorage: boolean);
+        constructor(config: SyncConfig|null, syncPortalGlobalState: InitInfo|null, bClearLocalStorage: boolean);
         // populate tenantNodes based on config tenants
-        init(config: Config|null|undefined, syncPortalGlobalState: InitInfo|null, bClearLocalStorage: boolean): void;
+        init(config: SyncConfig|null|undefined, syncPortalGlobalState: InitInfo|null, bClearLocalStorage: boolean): void;
         initializeProgressBar(setSyncProgress: (progress: number) => void, setConfigSyncResult: (result: string) => void, setIdleText: (idleText: string) => void, setMilestones: (milestones: Milestone[]) => void): void;
         uninitializeProgressBar(setSyncProgress: (progress: number) => void, setConfigSyncResult: (result: string) => void, setIdleText: (idleText: string) => void, setMilestones: (milestones: Milestone[]) => void): void;
         initializeSignalR(
-            config: Config | null | undefined,
+            config: SyncConfig | null | undefined,
             syncPortalGlobalState: InitInfo | null,
             batchIdArray: Array<Object>,
             setRefreshDeltaTrigger: (workspace: string) => void,
@@ -269,7 +274,7 @@ declare module "@mindline/sync" {
             setMilestones: (milestones: Milestone[]) => void,
             setConfigSyncResult: (result: string) => void,
             bClearLocalStorage: boolean): void;
-        startSync(instance: IPublicClientApplication, authorizedUser: User | null | undefined, config: Config | null | undefined): APIResult;
+        startSync(instance: IPublicClientApplication, authorizedUser: User | null | undefined, config: SyncConfig | null | undefined): APIResult;
     }
     export class TenantNode {
         expanded: boolean;
@@ -330,16 +335,16 @@ declare module "@mindline/sync" {
     export function userDelegatedScopesGet(instance: IPublicClientApplication, loggedInUser: User, tenant: Tenant): { scopes: string, id: string, error: string };
     export function userDelegatedScopesRemove(instance: IPublicClientApplication, loggedInUser: User, tenant: Tenant, scope: string): boolean;
     export function usersGet(instance: IPublicClientApplication, user: User | undefined): { users: string[], error: string };
-    // ======================= Mindline Config API ===============================
+    // ======================= Mindline SyncConfig API ===============================
     export function auditConfigAdd(instance: IPublicClientApplication, user: User, ac: AuditConfig, debug: boolean): Promise<APIResult>;
     export function auditConfigRetrieve(instance: IPublicClientApplication, user: User, debug: boolean): Promise<APIResult>;
     export function auditEventsRetrieve(instance: IPublicClientApplication, user: User, debug: boolean): Promise<APIResult>;
-    export function configEdit(instance: IPublicClientApplication, authorizedUser: User, config: Config, setConfigId: (id: string) => void, setSelectedConfigs: (selectedConfigs: { [id: string]: boolean | number[] }) => void, workspace: Workspace, ii: InitInfo, debug: boolean): APIResult;
+    export function configEdit(instance: IPublicClientApplication, authorizedUser: User, config: SyncConfig, setConfigId: (id: string) => void, setSelectedConfigs: (selectedConfigs: { [id: string]: boolean | number[] }) => void, workspace: Workspace, ii: InitInfo, debug: boolean): APIResult;
     export function configEnable(instance: IPublicClientApplication, authorizedUser: User, configurationId: string, enabled: boolean, debug: boolean): APIResult;
     export function configConsentForRead(instance: IPublicClientApplication, authorizedUser: User, configId: string, tid: string, consent: boolean): Promise<APIResult>;
     export function configConsentForWrite(instance: IPublicClientApplication, authorizedUser: User, configId: string, tid: string, consent: boolean): Promise<APIResult>;
     export function configsRefresh(instance: IPublicClientApplication, authorizedUser: User, workspaceId: string, ii: InitInfo, debug: boolean): APIResult;
-    export function configRemove(instance: IPublicClientApplication, authorizedUser: User, config: Config, workspaceId: string, debug: boolean): APIResult;
+    export function configRemove(instance: IPublicClientApplication, authorizedUser: User, config: SyncConfig, workspaceId: string, debug: boolean): APIResult;
     export function initGet(instance: IPublicClientApplication, user: User, ii: InitInfo, tasks: TaskArray, debug: boolean): APIResult;
     export function tenantAdd(instance: IPublicClientApplication, authorizedUser: User, tenant: Tenant, workspaceId: string): APIResult;
     export function tenantRemove(instance: IPublicClientApplication, authorizedUser: User, tenant: Tenant, workspaceId: string, debug: boolean): APIResult;

package/src/index.ts

@@ -1,4 +1,4 @@
-//index.ts - published interface - AAD implementations, facade to Mindline Config API
+//index.ts - published interface - AAD implementations, facade to Mindline SyncConfig API
 import * as signalR from "@microsoft/signalr"
 import { AccountInfo } from "@azure/msal-common";
 import { IPublicClientApplication, AuthenticationResult } from "@azure/msal-browser"
@@ -167,6 +167,7 @@ export class User {
         this.loggingIn = false;
     }
 }
+
 export enum TenantType {
     invalid = 0,
     aad = 1,
@@ -262,7 +263,7 @@ export class TenantConfigInfo {
         this.isWritePermissionConsented = false;
     }
 }
-export class Config {
+export class SyncConfig {
     id: string;
     workspaceId: string;
     name: string;
@@ -302,6 +303,9 @@ export class AuditConfig {
         this.sel = false;
     }
 }
+
+export type ConfigType = 'sync' | 'auditlogs';
+
 export class Workspace {
     id: string;
     name: string;
@@ -352,7 +356,8 @@ export class InitInfo {
     tab: number = 0;
     us: User[] = [];
     ts: Tenant[] = [];
-    cs: Config[] = [];
+    cs: SyncConfig[] = [];
+    acs: AuditConfig[] = [];
     ws: Workspace[] = [];
     configlevelconsent_configid: string = "";
     configlevelconsent_access: TenantConfigType = TenantConfigType.sourcetarget;
@@ -391,7 +396,7 @@ export class InitInfo {
         try {
             this.us = deserializeArray(User, usersString);
             this.ts = deserializeArray(Tenant, tenantsString);
-            this.cs = deserializeArray(Config, configsString);
+            this.cs = deserializeArray(SyncConfig, configsString);
             this.ws = deserializeArray(Workspace, workspacesString);
             this.tagWithWorkspaces();
         } catch (e) {
@@ -498,11 +503,11 @@ export class InitInfo {
             });
         }
         if (typeof ii.cs === "undefined") {
-            this.cs = new Array<Config>();
+            this.cs = new Array<SyncConfig>();
         }
         else {
-            this.cs = ii.cs.map((config: Config) => {
-                let newconfig: Config = new Config();
+            this.cs = ii.cs.map((config: SyncConfig) => {
+                let newconfig: SyncConfig = new SyncConfig();
                 newconfig.id = config.id;
                 newconfig.workspaceId = config.workspaceId;
                 newconfig.name = config.name;
@@ -720,7 +725,7 @@ export class Task {
         this.startDisplay = `${this.start.getMinutes().toString().padStart(2, "0")}:${this.start.getSeconds().toString().padStart(2, "0")}`;
     };
 }
-// class corresponding to an execution of a Config - a *TenantNode* for each source tenant, each with a *TenantNode* array of target tenants
+// class corresponding to an execution of a SyncConfig - a *TenantNode* for each source tenant, each with a *TenantNode* array of target tenants
 export class Milestone {
     Run: number = 0;
     Start: Date = new Date();
@@ -912,7 +917,7 @@ export class BatchArray {
     pb_timer: NodeJS.Timeout | null;
     milestoneArray: MilestoneArray;
     constructor(
-        config: Config | null,
+        config: SyncConfig | null,
         syncPortalGlobalState: InitInfo | null,
         bClearLocalStorage: boolean
     ) {
@@ -929,7 +934,7 @@ export class BatchArray {
     }
     // populate tenantNodes based on config tenants
     init(
-        config: Config | null | undefined,
+        config: SyncConfig | null | undefined,
         syncPortalGlobalState: InitInfo | null,
         bClearLocalStorage: boolean
     ): void {
@@ -943,7 +948,7 @@ export class BatchArray {
                 this.milestoneArray.init(bClearLocalStorage);
             }
         }
-        // create BatchArray if passed Config and InitInfo
+        // create BatchArray if passed SyncConfig and InitInfo
         if (config != null &&
             config.tenants != null &&
             syncPortalGlobalState != null) {
@@ -1059,7 +1064,7 @@ export class BatchArray {
         this.milestoneArray.unstart(setMilestones);
     }
     initializeSignalR(
-        config: Config | null | undefined,
+        config: SyncConfig | null | undefined,
         syncPortalGlobalState: InitInfo | null,
         batchIdArray: Array<Object>,
         setRefreshDeltaTrigger: (workspace: string) => void,
@@ -1274,7 +1279,7 @@ export class BatchArray {
         });
     }
     // start a sync cycle
-    async startSync(instance: IPublicClientApplication, authorizedUser: User | null | undefined, config: Config | null | undefined): Promise<APIResult>
+    async startSync(instance: IPublicClientApplication, authorizedUser: User | null | undefined, config: SyncConfig | null | undefined): Promise<APIResult>
     {
         let result: APIResult = new APIResult();
         if (this.tenantNodes == null || this.tenantNodes.length == 0) {
@@ -2019,7 +2024,7 @@ export async function usersGet(instance: IPublicClientApplication, user: User |
         return { users: [], error: `Exception: ${error}` };
     }
 }
-// ======================= Mindline Config API ===============================
+// ======================= Mindline SyncConfig API ===============================
 export async function auditConfigAdd(instance: IPublicClientApplication, user: User, ac: AuditConfig, debug: boolean): Promise<APIResult> {
     return auditConfigPost(instance, user, ac, debug);
 }
@@ -2032,7 +2037,7 @@ export async function auditEventsRetrieve(instance: IPublicClientApplication, au
 export async function configEdit(
     instance: IPublicClientApplication,
     authorizedUser: User,
-    config: Config,
+    config: SyncConfig,
     setConfigId: (id: string) => void,
     setSelectedConfigs: (selectedConfigs: { [id: string]: boolean | number[] }) => void,
     workspace: Workspace,
@@ -2088,7 +2093,7 @@ export async function configsRefresh(instance: IPublicClientApplication, authori
     try {
         let workspace: Workspace | undefined = ii.ws.find((w) => w.id === workspaceId);
         if (workspace != null) {
-            // clear Config associations as we are about to reset
+            // clear SyncConfig associations as we are about to reset
             workspace.associatedConfigs.length = 0;
             // GET configs associated with this workspace
             let result: APIResult = await configsGet(instance, authorizedUser, workspace.id, debug);
@@ -2096,7 +2101,7 @@ export async function configsRefresh(instance: IPublicClientApplication, authori
             // process returned workspace components
             let configSelectedId: string = "";
             for (let cid of workspace.associatedConfigs) {
-                let config = ii.cs.find((c: Config) => c.id === cid);
+                let config = ii.cs.find((c: SyncConfig) => c.id === cid);
                 if (config != null && config.sel) {
                     configSelectedId = config.id;
                 }
@@ -2115,7 +2120,7 @@ export async function configsRefresh(instance: IPublicClientApplication, authori
     result.status = 500;
     return result;
 }
-export async function configRemove(instance: IPublicClientApplication, authorizedUser: User, config: Config, workspaceId: string, debug: boolean): Promise<APIResult> {
+export async function configRemove(instance: IPublicClientApplication, authorizedUser: User, config: SyncConfig, workspaceId: string, debug: boolean): Promise<APIResult> {
     return configDelete(instance, authorizedUser, config, workspaceId, debug);
 }
 export async function initGet(instance: IPublicClientApplication, user: User, ii: InitInfo, tasks: TaskArray, debug: boolean): Promise<APIResult> {
@@ -2174,7 +2179,7 @@ export async function workspaceEdit(instance: IPublicClientApplication, authoriz
 {
     return await workspacePut(instance, authorizedUser, workspaceId, workspaceName);
 }
-// retrieve Workspace(s), User(s), Tenant(s), Config(s) given newly logged in user
+// retrieve Workspace(s), User(s), Tenant(s), SyncConfig(s) given newly logged in user
 function processReturnedAdmins(workspace: Workspace, ii: InitInfo, returnedAdmins: Array<Object>, adminSelectedId: string) {
     returnedAdmins.map((item: any) => {
         // are we already tracking this user?
@@ -2212,7 +2217,7 @@ function processReturnedAdmins(workspace: Workspace, ii: InitInfo, returnedAdmin
         // *try* to set authority/companyName/companyDomain from tenant returned in previous call processReturnedTenants (it may not be there)
         // ASSUMPTION: in terms of setting authority, user either comes from
         //      1. .NET session, in which case user has an authority from the token
-        //      2. Config API, in which case either
+        //      2. SyncConfig API, in which case either
         //          a. associated tenant with authority exists for this user (i.e. workspace owner has called POST init/configuration and created Admin and Tenant at same time)
         //          b. user has never logged in (i.e. workspace owner has invited an incomplete admin to the workspace and there is no corresponding tenant)
         //              i. this means that we *may* not have an authority stored for this user
@@ -2277,7 +2282,7 @@ function processReturnedConfigs(workspace: Workspace, ii: InitInfo, returnedConf
     // process returned configs
     returnedConfigs.map((item: any) => {
         // are we already tracking this config?
-        let config: Config | null | undefined = null;
+        let config: SyncConfig | null | undefined = null;
         let csIndex = ii.cs.findIndex((c) => c.id === item.id);
         if (csIndex === -1) {
             // start tracking
@@ -2285,7 +2290,7 @@ function processReturnedConfigs(workspace: Workspace, ii: InitInfo, returnedConf
             if (dummyIndex !== -1) {
                 // clear and overwrite dummy
                 config = ii.cs.at(dummyIndex);
-                // replace dummy Config id "1" with real id in associatedConfigs of this workspace
+                // replace dummy SyncConfig id "1" with real id in associatedConfigs of this workspace
                 let idx: number = workspace.associatedConfigs.findIndex((id: string) => id == "1");
                 if (idx !== -1) {
                     workspace.associatedConfigs.splice(idx, 1);
@@ -2293,7 +2298,7 @@ function processReturnedConfigs(workspace: Workspace, ii: InitInfo, returnedConf
                 }
             } else {
                 // create and track new workspace
-                config = new Config();
+                config = new SyncConfig();
                 ii.cs.push(config);
             }
         } else {
@@ -2374,7 +2379,7 @@ async function workspaceInfoGet(instance: IPublicClientApplication, user: User,
                 }
                 let configSelectedId: string = "";
                 for (let cid of workspace!.associatedConfigs) {
-                    let config = ii.cs.find((c: Config) => c.id === cid);
+                    let config = ii.cs.find((c: SyncConfig) => c.id === cid);
                     if (config != null && config.sel) {
                         configSelectedId = config.id;
                     }
@@ -2591,7 +2596,7 @@ async function readResources(instance: IPublicClientApplication, user: User): Pr
     }
     return resources;
 }
-// ======================= HYBRIDSPA.TS -- Mindline Config API helper functions ===============================
+// ======================= HYBRIDSPA.TS -- Mindline SyncConfig API helper functions ===============================
 function getAPIScope(user: User): string {
     let apiAppID: string = "8d95d21c-c378-4bb0-9f52-88c30d271e7a";
     let authority: string = user.authority.toLowerCase();
@@ -2662,7 +2667,7 @@ export async function processErrors(response: Response): Promise<string> {
         if (errorString != "") return errorString;
     }
     let data = await response.json();
-    // process errors from Mindline Config API
+    // process errors from Mindline SyncConfig API
     if (data.error !== undefined) {
         errorString = `Error: ${data.error} Message: ${data.message}`;
     } else if (data.errors !== undefined) {
@@ -3045,7 +3050,7 @@ export async function configConsentWritePut(instance: IPublicClientApplication,
 export async function configDelete(
     instance: IPublicClientApplication,
     authorizedUser: User,
-    config: Config,
+    config: SyncConfig,
     workspaceId: string,
     debug: boolean
 ): Promise<APIResult> {
@@ -3141,7 +3146,7 @@ export async function configPatch(
 export async function configPost(
     instance: IPublicClientApplication,
     authorizedUser: User,
-    config: Config,
+    config: SyncConfig,
     workspaceId: string,
     debug: boolean
 ): Promise<APIResult> {
@@ -3218,7 +3223,7 @@ export async function configPost(
 export async function configPut(
     instance: IPublicClientApplication,
     authorizedUser: User,
-    config: Config,
+    config: SyncConfig,
     debug: boolean
 ): Promise<APIResult> {
     let result: APIResult = new APIResult();
@@ -3674,7 +3679,7 @@ export async function workspacesGet(
 export async function readerPost(
     instance: IPublicClientApplication,
     authorizedUser: User,
-    config: Config
+    config: SyncConfig
 ): Promise<APIResult> {
     let result: APIResult = new APIResult();
     if (instance == null || authorizedUser == null) {