@mindline/sync 1.0.34 → 1.0.36

package/.vs/VSWorkspaceState.json

@@ -2,6 +2,6 @@
   "ExpandedNodes": [
     ""
   ],
-  "SelectedNode": "\\index.d.ts",
+  "SelectedNode": "\\hybridspa.ts",
   "PreviewInSolutionExplorer": false
 }

package/README.md

@@ -17,13 +17,17 @@ npm install @azure/msal-browser --save
 # 2.	Latest releases
 # 3.	API references
 # 4. Unit Test
-### `npm test`
+
+	npm test
 # 6. Publish
-### `npm login`
-username, password, OTP code required
-### `npm version patch`
-### `npm publish --access=public --otp=XXXXXX`
-### `npm publish --dry-run`
-publishes package
+
+username, password, OTP code required to publish package
+
+	npm login
+	npm version patch
+	npm publish --access=public --otp=XXXXXX
+	npm publish --dry-run
+
+
 # 7. Contribute
 TODO: Explain how other users and developers can contribute to make your code better.

package/hybridspa.ts

@@ -112,7 +112,6 @@ export async function adminDelete(
     let url: URL | null = null;
     if (user.oid !== user.mail) {
         url = new URL(graphConfig.adminEndpoint);
-        url.searchParams.append("userId", user.oid);
         url.searchParams.append("workspaceId", workspaceId);
     }
     // or of an incomplete admin?
@@ -414,13 +413,14 @@ export async function configPut(
         // if last character is } we need a comma first
         let needComma: boolean = configBody.slice(-1) === "}";
         if (needComma) configBody += ",";
-        // decide whethere to send source group values
+        // TODO: more sophisticated source tenant user filtering
         configBody += `{
-      "tenantId": "${tci.tid}",
-      "sourceGroupId": "${tci.sourceGroupId}",
-      "sourceGroupName": "${tci.sourceGroupName}",
-      "configurationTenantType": "${tci.configurationTenantType}"
-    }`;
+          "tenantId": "${tci.tid}",
+          "sourceGroupId": "${tci.sourceGroupId}",
+          "sourceGroupName": "${tci.sourceGroupName}",
+          "configurationTenantType": "${tci.configurationTenantType}",
+          "deltaToken": "${tci.deltaToken}"
+        }`;
     });
     configBody += `]}`;
     let options = { method: "PUT", headers: headers, body: configBody };
@@ -805,9 +805,8 @@ export async function workspacesGet(
     }
     // create workspaces endpoint
     let workspaceEndpoint: string = graphConfig.workspaceEndpoint;
-    // add email parameter to endpoint
+    // create workspace endpoint
     let url: URL = new URL(workspaceEndpoint);
-    url.searchParams.append("userEmail", user.mail);
     // create workspace headers
     const headers = await defineHeaders(instance, authorizedUser);
     // make workspace endpoint call
@@ -864,14 +863,12 @@ export async function readerPost(
         return result;
     }
     // create reader endpoint with config ID
-    //let readerEndpoint: string = graphConfig.readerStartSyncEndpoint + config.id;
-    let readerEndpoint: string = graphConfig.readerApiEndpoint + config.id;
+    let readerEndpoint: string = graphConfig.readerStartSyncEndpoint + config.id;
     // create headers
     const headers = await defineHeaders(instance, authorizedUser);
     // make reader endpoint call
     let options = { method: "POST", headers: headers };
     try {
-        debugger;
         console.log("Attempting POST to /startSync: " + readerEndpoint);
         let response = await fetch(readerEndpoint, options);
         if (response.status === 200 && response.statusText === "OK") {

package/index.d.ts

@@ -1,185 +1,186 @@
 import { IPublicClientApplication } from "@azure/msal-browser";
 
 declare module "@mindline/sync" {
-  export function sum(a: number, b: number): number;
-  export function helloNpm(): string;
+    export function sum(a: number, b: number): number;
+    export function helloNpm(): string;
 
-  export class Group {
-    id: string;
-    displayName: string;
-    description: string;
-  }
-  // admin
-  export class User {
-    oid: string;  // from AAD ID token
-    name: string; // from AAD ID token
-    mail: string; // from AAD ID token TODO: preferred_username *may* differ from UPN, may differ from mail
-    authority: string; // from AAD auth response - cloud instance login endpoint
-    tid: string;  // from AAD ID token
-    companyName: string;    // findTenantInformationByTenantId TODO: process changes to company name
-    companyDomain: string;  // findTenantInformationByTenantId TODO: process changes to company name
-    associatedWorkspaces: string[];
-    workspaceIDs: string;
-    session: string;
-    spacode: string;
-    accessToken: string;
-    loginHint: string;
-    scopes: string[];
-    authTS: Date;
-    constructor();
-  }
-  // tenant (Azure AD tenant, AD domain, Google workspace)
-  export enum TenantType {
-    invalid = 0,
-    aad = 1,
-    ad = 2,
-    googleworkspace = 3
-  }
-  type TenantTypeStrings = keyof typeof TenantType;
-  export enum TenantPermissionType {
-    read = 1,
-    write = 2,
-    notassigned = 3
-  }
-  type TenantPermissionTypeStrings = keyof typeof TenantPermissionType;
-  export class Tenant {
-    tid: string; // from AAD ID token
-    name: string; // findTenantInformationByTenantId
-    domain: string; // findTenantInformationByTenantId
-    tenantType: TenantTypeStrings; // always "aad" for now
-    permissionType: TenantPermissionTypeStrings; // read/write/notassigned
-    onboarded: string;  // have we onboarded this tenant? "true" or "false"
-    authority: string;  // from AAD ID auth response
-    readServicePrincipal: string; // from AAD consent
-    writeServicePrincipal: string; // from AAD consent
-    workspaceIDs: string;
-    constructor();
-  }
-  // config
-  export enum TenantConfigType {
-    source = 1,
-    target = 2,
-    sourcetarget = 3
-  }
-  export type TenantConfigTypeStrings = keyof typeof TenantConfigType;
-  export class TenantConfigInfo {
-    tid: string;              // tenant identifier
-    sourceGroupId: string;    // source group - we can configure source group for reading
-    sourceGroupName: string;  // source group - we can configure source group for reading
-    configurationTenantType: TenantConfigTypeStrings;
-  }
-  export class Config {
-    id: string;
-    workspaceId: string;
-    name: string;
-    description: string;
-    tenants: TenantConfigInfo[];
-    isEnabled: boolean;
-    workspaceIDs: string;
-    constructor();
-  }
-  // class to group Users, Tenants, and Configs
-  export class Workspace {
-    id: string;
-    name: string;
-    associatedUsers: string[];
-    associatedTenants: string[];
-    associatedConfigs: string[];
-    constructor();
-  }
-  export class InitInfo {
-    us: User[];
-    ts: Tenant[];
-    cs: Config[];
-    ws: Workspace[];
-    constructor(bClearLocalStorage: boolean);
-    init(bClearLocalStorage: boolean): void;
-    save(): void;
-    tagWithWorkspaces(): boolean;
-  }
-  export type TaskType = "initialization" | 
+    export class Group {
+        id: string;
+        displayName: string;
+        description: string;
+    }
+    // admin
+    export class User {
+        oid: string;  // from AAD ID token
+        name: string; // from AAD ID token
+        mail: string; // from AAD ID token TODO: preferred_username *may* differ from UPN, may differ from mail
+        authority: string; // from AAD auth response - cloud instance login endpoint
+        tid: string;  // from AAD ID token
+        companyName: string;    // findTenantInformationByTenantId TODO: process changes to company name
+        companyDomain: string;  // findTenantInformationByTenantId TODO: process changes to company name
+        associatedWorkspaces: string[];
+        workspaceIDs: string;
+        session: string;
+        spacode: string;
+        accessToken: string;
+        loginHint: string;
+        scopes: string[];
+        authTS: Date;
+        constructor();
+    }
+    // tenant (Azure AD tenant, AD domain, Google workspace)
+    export enum TenantType {
+        invalid = 0,
+        aad = 1,
+        ad = 2,
+        googleworkspace = 3
+    }
+    type TenantTypeStrings = keyof typeof TenantType;
+    export enum TenantPermissionType {
+        read = 1,
+        write = 2,
+        notassigned = 3
+    }
+    type TenantPermissionTypeStrings = keyof typeof TenantPermissionType;
+    export class Tenant {
+        tid: string; // from AAD ID token
+        name: string; // findTenantInformationByTenantId
+        domain: string; // findTenantInformationByTenantId
+        tenantType: TenantTypeStrings; // always "aad" for now
+        permissionType: TenantPermissionTypeStrings; // read/write/notassigned
+        onboarded: string;  // have we onboarded this tenant? "true" or "false"
+        authority: string;  // from AAD ID auth response
+        readServicePrincipal: string; // from AAD consent
+        writeServicePrincipal: string; // from AAD consent
+        workspaceIDs: string;
+        constructor();
+    }
+    // config
+    export enum TenantConfigType {
+        source = 1,
+        target = 2,
+        sourcetarget = 3
+    }
+    export type TenantConfigTypeStrings = keyof typeof TenantConfigType;
+    export class TenantConfigInfo {
+        tid: string;              // tenant identifier
+        sourceGroupId: string;    // source group - we can configure source group for reading
+        sourceGroupName: string;  // source group - we can configure source group for reading
+        configurationTenantType: TenantConfigTypeStrings;
+        deltaToken: string;
+        filesWritten: number;
+        configId: string;
+    }
+    export class Config {
+        id: string;
+        workspaceId: string;
+        name: string;
+        description: string;
+        tenants: TenantConfigInfo[];
+        isEnabled: boolean;
+        workspaceIDs: string;
+        constructor();
+    }
+    // class to group Users, Tenants, and Configs
+    export class Workspace {
+        id: string;
+        name: string;
+        associatedUsers: string[];
+        associatedTenants: string[];
+        associatedConfigs: string[];
+        constructor();
+    }
+    export class InitInfo {
+        us: User[];
+        ts: Tenant[];
+        cs: Config[];
+        ws: Workspace[];
+        constructor(bClearLocalStorage: boolean);
+        init(bClearLocalStorage: boolean): void;
+        save(): void;
+        tagWithWorkspaces(): boolean;
+    }
+    export type TaskType = "initialization" | 
                             "authenticate user" | 
                             "reload React" | 
                             "PUT access token" | 
                             "GET tenant details" | 
                             "POST config init" |
                             "GET workspaces" |
-                          "onboard tenant" |
-                          "create 2nd tenant" |
-                          "invite 2nd admin" |
-                          "onboard 2nd tenant" | 
-                          "create config";
-  export class TaskArray {
-    tasks: Task[];  
-    constructor(bClearLocalStorage: boolean);
-    init(bClearLocalStorage: boolean): void;
-    setTaskStart(taskType: TaskType, startDate: Date): void;
-    setTaskEnd(taskType: TaskType, startDate: Date, status: string): void;
-  }
-  export class Task {
-    id: number;
-    task: string;
-    start: Date;
-    startDisplay: string;
-    end: Date;
-    endDisplay: string;
-    elapsedDisplay: string;
-    expected: number;
-    status: string;
-    expanded: boolean;
-    subtasks: Task[];
-    setEnd(endDate: Date): void;
-    setStart(startDate: Date): void;
-  }
-  export class BatchArray {
-    tenantNodes: TenantNode[];
-    constructor(config: Config|null, syncPortalGlobalState: InitInfo|null, bClearLocalStorage: boolean);
-    // populate tenantNodes based on config tenants
-    init(config: Config|null, syncPortalGlobalState: InitInfo|null, bClearLocalStorage: boolean): void;
-    startSync(instance: IPublicClientApplication, authorizedUser: User|undefined, config: Config|null|undefined): void;
-  }
-  export class TenantNode {
-    expanded: boolean;
-    status: string;
-    name: string;
-    tid: string;
-    total: number;
-    read: number;
-    written: number;
-    deferred: number;
-    targets: TenantNode[];
-    constructor(tid: string, name: string);
-    update(total: number, read: number, written: number, deferred: number): void;
-  }
-  export class APIResult {
-    result: boolean;
-    status: number;
-    error: string;
-    constructor();
-  }  
-  //
-  // Azure AD Graph API
-  //
-  export function groupGet(tenant: Tenant, groupid: string): Promise<{group: string, error: string}>;
-  export function groupsGet(tenant: Tenant, groupSearchString: string): Promise<{groups: Group[], error: string}>;
-  export function signIn(user: User, tasks: TaskArray): void;
-  export function signInIncrementally(user: User, scope: string): void;
-  export function signOut(user: User): void;
-  export function tenantRelationshipsGetByDomain(loggedInuser: User, tenant: Tenant, instance: IPublicClientApplication, debug: boolean): boolean;
-  export function tenantRelationshipsGetById(user: User, ii: InitInfo, instance: IPublicClientApplication, tasks: TaskArray, debug: boolean): boolean;
-  export function usersGet(tenant: Tenant): {users: string[], error: string};
-  //
-  // Mindline Config API
-  //
-  export function configEdit(instance: IPublicClientApplication, authorizedUser: User, config: Config, workspaceId: string, debug: boolean): APIResult;
-  export function configRemove(instance: IPublicClientApplication, authorizedUser: User, config: Config, workspaceId: string, debug: boolean): APIResult;
-  export function initGet(instance: IPublicClientApplication, authorizedUser: User, user: User, ii: InitInfo, tasks: TaskArray, debug: boolean): APIResult;
-  export function tenantAdd(instance: IPublicClientApplication, authorizedUser: User, tenant: Tenant, workspaceId: string): APIResult;
-  export function tenantComplete(instance: IPublicClientApplication, authorizedUser: User, tenant: Tenant, debug: boolean): APIResult;
-  export function tenantRemove(instance: IPublicClientApplication, authorizedUser: User, tenant: Tenant, workspaceId: string, debug: boolean): APIResult;
-  export function userAdd(instance: IPublicClientApplication, authorizedUser: User, user: User, workspaceId: string): APIResult;
+                            "onboard tenant" |
+                            "create 2nd tenant" |
+                            "invite 2nd admin" |
+                            "onboard 2nd tenant" | 
+                            "create config";
+    export class TaskArray {
+        tasks: Task[];  
+        constructor(bClearLocalStorage: boolean);
+        init(bClearLocalStorage: boolean): void;
+        setTaskStart(taskType: TaskType, startDate: Date): void;
+        setTaskEnd(taskType: TaskType, startDate: Date, status: string): void;
+    }
+    export class Task {
+        id: number;
+        task: string;
+        start: Date;
+        startDisplay: string;
+        end: Date;
+        endDisplay: string;
+        elapsedDisplay: string;
+        expected: number;
+        status: string;
+        expanded: boolean;
+        subtasks: Task[];
+        setEnd(endDate: Date): void;
+        setStart(startDate: Date): void;
+    }
+    export class BatchArray {
+        tenantNodes: TenantNode[];
+        constructor(config: Config|null, syncPortalGlobalState: InitInfo|null, bClearLocalStorage: boolean);
+        // populate tenantNodes based on config tenants
+        init(config: Config|null, syncPortalGlobalState: InitInfo|null, bClearLocalStorage: boolean): void;
+        startSync(instance: IPublicClientApplication, authorizedUser: User|null|undefined, config: Config|null|undefined): void;
+    }
+    export class TenantNode {
+        expanded: boolean;
+        status: string;
+        name: string;
+        tid: string;
+        total: number;
+        read: number;
+        written: number;
+        deferred: number;
+        targets: TenantNode[];
+        constructor(tid: string, name: string);
+        update(total: number, read: number, written: number, deferred: number): void;
+    }
+    export class APIResult {
+        result: boolean;
+        status: number;
+        error: string;
+        constructor();
+    }  
+    //
+    // Azure AD Graph API
+    //
+    export function groupGet(tenant: Tenant, groupid: string): Promise<{group: string, error: string}>;
+    export function groupsGet(tenant: Tenant, groupSearchString: string): Promise<{groups: Group[], error: string}>;
+    export function signIn(user: User, tasks: TaskArray): void;
+    export function signInIncrementally(user: User, scope: string): void;
+    export function signOut(user: User): void;
+    export function tenantRelationshipsGetByDomain(loggedInuser: User, tenant: Tenant, instance: IPublicClientApplication, debug: boolean): boolean;
+    export function tenantRelationshipsGetById(user: User, ii: InitInfo, instance: IPublicClientApplication, tasks: TaskArray, debug: boolean): boolean;
+    export function usersGet(tenant: Tenant): {users: string[], error: string};
+    //
+    // Mindline Config API
+    //
+    export function configEdit(instance: IPublicClientApplication, authorizedUser: User, config: Config, workspaceId: string, debug: boolean): APIResult;
+    export function configRemove(instance: IPublicClientApplication, authorizedUser: User, config: Config, workspaceId: string, debug: boolean): APIResult;
+    export function configsRefresh(instance: IPublicClientApplication, authorizedUser: User, workspaceId: string, ii: InitInfo, debug: boolean): APIResult;
+    export function initGet(instance: IPublicClientApplication, authorizedUser: User, user: User, ii: InitInfo, tasks: TaskArray, debug: boolean): APIResult;
+    export function tenantAdd(instance: IPublicClientApplication, authorizedUser: User, tenant: Tenant, workspaceId: string): APIResult;
+    export function tenantComplete(instance: IPublicClientApplication, authorizedUser: User, tenant: Tenant, debug: boolean): APIResult;
+    export function tenantRemove(instance: IPublicClientApplication, authorizedUser: User, tenant: Tenant, workspaceId: string, debug: boolean): APIResult;
+    export function userAdd(instance: IPublicClientApplication, authorizedUser: User, user: User, workspaceId: string): APIResult;
     export function userRemove(instance: IPublicClientApplication, authorizedUser: User, user: User, workspaceId: string): APIResult;
-  //
-  // Mindline Sync API
-  //
 }

package/index.ts

@@ -104,11 +104,17 @@ export class TenantConfigInfo {
     sourceGroupId: string;
     sourceGroupName: string;
     configurationTenantType: TenantConfigTypeStrings;
+    deltaToken: string;
+    filesWritten: number;
+    configId: string;
     constructor() {
         this.tid = "";
         this.sourceGroupId = "";
         this.sourceGroupName = "";
         this.configurationTenantType = "source";
+        this.deltaToken = "";
+        this.filesWritten = 0;
+        this.configId = "";
     }
 }
 export class Config {
@@ -643,18 +649,25 @@ export class BatchArray {
         }
     }
     */
-    // cycle through test state machine
-    startSync(instance: IPublicClientApplication, authorizedUser: User | undefined, config: Config | null | undefined): void {
+    // start a sync cycle
+    startSync(instance: IPublicClientApplication, authorizedUser: User | null | undefined, config: Config | null | undefined): void {
         if (this.tenantNodes == null || this.tenantNodes.length == 0) {
             // we should not have an empty batch array for a test
             debugger;
         }
+        // start SignalR connection
+        const connection = new signalR.HubConnectionBuilder()	// SignalR initialization
+            .withUrl("https://dev-signalrdispatcher-westus.azurewebsites.net/statsHub?statsId=df9c2e0a-f6fe-43bb-a155-d51f66dffe0e", { skipNegotiation: true, transport: signalR.HttpTransportType.WebSockets } )
+            .configureLogging(signalR.LogLevel.Information)
+            .build();
+        // when you get a message, log the message
+        connection.on("newMessage", function (message) {
+            console.log(message); // log the message
+        });
+        connection.start().catch(console.error); 
         // execute post to reader endpoint
         readerPost(instance, authorizedUser, config);
-
-        // start SignalR connection
-        //debugger;
-        //monitorSyncProgress();
+        // refresh delta tokens for this Configuration (we read all Configurations at once)
     }
 }
 export class TenantNode {
@@ -966,6 +979,34 @@ export async function configEdit(instance: IPublicClientApplication, authorizedU
 export async function configRemove(instance: IPublicClientApplication, authorizedUser: User, config: Config, workspaceId: string, debug: boolean): Promise<APIResult> {
     return configDelete(instance, authorizedUser, config, workspaceId, debug);
 }
+export async function configsRefresh(instance: IPublicClientApplication, authorizedUser: User, workspaceId: string, ii: InitInfo, debug: boolean): Promise<APIResult> {
+    let result: APIResult = new APIResult();
+    if (debug) debugger;
+    try {
+        let workspace: Workspace = ii.ws.find((w) => w.id === workspaceId);
+        if (workspace != null) {
+            // clear Config associations as we are about to reset
+            workspace.associatedConfigs.length = 0;
+            // GET configs associated with this workspace
+            let configsPromise: Promise<APIResult> = configsGet(instance, authorizedUser, workspace.id, debug);
+            // wait for query to finish, return on any failure
+            let [configsResult] = await Promise.all([configsPromise]);
+            if (!configsResult.result) return configsResult;
+            // process returned workspace components
+            processReturnedConfigs(workspace, ii, configsResult.array!);
+            // tag components with workspaceIDs
+            ii.tagWithWorkspaces();
+        }
+        return result;
+    }
+    catch (error: any) {
+        console.log(error.message);
+        result.error = error.message;
+    }
+    result.result = false;
+    result.status = 500;
+    return result;
+}
 // retrieve Workspace(s), User(s), Tenant(s), Config(s) given newly logged in user
 export async function initGet(instance: IPublicClientApplication, authorizedUser: User, user: User, ii: InitInfo, tasks: TaskArray, debug: boolean): Promise<APIResult> {
     let result: APIResult = new APIResult();
@@ -982,9 +1023,10 @@ export async function initGet(instance: IPublicClientApplication, authorizedUser
     if (result.result) {
         tasks.setTaskStart("GET workspaces", new Date());
         result = await workspaceInfoGet(instance, authorizedUser, user, ii, debug);
-        tasks.setTaskEnd("GET workspaces", new Date(), result ? "complete" : "failed");
+        tasks.setTaskEnd("GET workspaces", new Date(), result.result ? "complete" : "failed");
     }
     if (result.result) result.error = version;
+    else console.log("@mindline/sync package version: " + version);
     return result;
 }
 export async function tenantAdd(instance: IPublicClientApplication, authorizedUser: User, tenant: Tenant, workspaceId: string): Promise<APIResult> {
@@ -1104,6 +1146,8 @@ function processReturnedConfigs(workspace: Workspace, ii: InitInfo, returnedConf
             tenantConfigInfo.sourceGroupId = tci.sourceGroupId;
             tenantConfigInfo.sourceGroupName = tci.sourceGroupName;
             tenantConfigInfo.configurationTenantType = tci.configurationTenantType.toLowerCase();
+            tenantConfigInfo.deltaToken = tci.deltaToken ?? "";
+            tenantConfigInfo.configId = config!.id;
             config!.tenants.push(tenantConfigInfo);
         });
         // ensure this workspace tracks this config

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mindline/sync",
   "type": "module",
-  "version": "1.0.34",
+  "version": "1.0.36",
   "types": "index.d.ts",
   "exports": "./index.ts",
   "description": "sync is a node.js package encapsulating javscript classes required for configuring Mindline sync service.",
@@ -16,6 +16,7 @@
     "vitest": "^0.29.8"
   },
   "dependencies": {
+    "@microsoft/signalr": "^7.0.10",
     "class-transformer": "^0.5.1",
     "reflect-metadata": "^0.1.13"
   }