@mindline/sync 1.0.11 → 1.0.13

package/configs.json

@@ -0,0 +1,21 @@
+[
+  {
+    "id": "1",
+    "name": "ProdSync",
+    "description": "Automated sync of users from Mindline1 to Mindline2",
+    "targetConfigs":
+    [ 
+        {
+            "tid": "7f4567b8-f9a9-4ad3-9cb5-ef16a80e5744",
+            "sourceGroups":  ["TODO"],
+            "targetGroup": ""
+        },
+        {
+            "tid": "df9c2e0a-f6fe-43bb-a155-d51f66dffe0e",
+            "sourceGroups":  [],
+            "targetGroup": "TODO"
+        }
+    ],
+    "enabled": "false"
+  }
+]

package/index.js

@@ -1,107 +1,201 @@
 //index.js
 
-// called by unit test
+// called by unit tests
 export function sum(a, b) {
   return a + b;
 }
-
-// called by simpleclass test app
 export function helloNpm() {
   return "hello NPM";
 }
 
+const FILTER_FIELD = "WorkspaceIDs";
+
 export class User {
   constructor(){
-    this.authority = "";
     this.oid = "";
-    this.tid = "";
-    this.upn = "";
     this.name = "";
+    this.mail = "";
+    this.authority = "";
+    this.tid = "";
+    this.companyName = "";
+    this.companyDomain = "";
+    this.associatedWorkspaces = {};
   }
 }
 
-export class UserConfigInfo {
-  constructor(){
-    this.vts = null;
-    this.sts = null;
-    this.scs = null;
-  }
-}
-
-// shared base class of virtual and sync tenants
-export class Tenant {
+export class Target {
   constructor(){
-    this.authority = "";
     this.tid = "";
     this.name = "";
     this.domain = "";
+    this.type = "";
+    this.authority = "";
+    this.readServicePrincipal = "";
+    this.writeServicePrincipal = "";
   }
 }
 
-// class for "hub" tenants
-export class VirtualTenant extends Tenant {
+export class Config {
   constructor(){
-    super();
+    this.id = "";
+    this.name = "";
     this.description = "";
+    this.targetConfigs = {};
+    this.enabled = false;
   }
 }
 
-// class for "spoke" tenants
-export class SyncTenant extends Tenant {
+export class Workspace {
   constructor(){
-    super();
-    this.tenantType = "";
-    this.readServicePrincipal = "";
-    this.writeServicePrincipal = "";
-    this.virtualTenantID = "";
+    this.id = "";
+    this.name = "";
+    this.associatedUsers = {};
+    this.associatedTargets = {};
+    this.associatedConfigs = {};
   }
 }
 
-// class for sync configuration
-export class SyncConfig {
-  constructor(){
-    this.enabled = "";
-    this.virtualTenantID = "";
-    this.deltaLink = "";
+export class PortalConfigInfo {
+  constructor() {
+    this.us = {};
+    this.ts = {};
+    this.cs = {};
+    this.ws = {};
+  }
+  tagWithWorkspaces() {
+    // for each Workspace tag associated User, Target, Config with Workspace.id
+    for (let workspace of this.ws) {
+      // find matching Users to tag with this workspace
+      for (let userID of workspace.associatedUsers) {
+        let user = this.us.find((currentUser) => currentUser.oid === userID);
+        if (user !== undefined) {
+          // we found the user
+          if (user[FILTER_FIELD] === undefined) {
+            // the user does not have the filter field yet
+            try {
+              user[FILTER_FIELD] = workspace.id;
+            } catch (e) {
+              debugger;
+              return false;
+            }
+          } else {
+            // the user does have the filter field
+            user[FILTER_FIELD] += ", ";
+            user[FILTER_FIELD] += workspace.id;
+          }
+        } else {
+          // we should not have PCI that does not have Workspace component objects
+          debugger;
+          return false;
+        }
+      }
+      // find matching Targets to tag with this workspace
+      for (let targetID of workspace.associatedTargets) {
+        let target = this.ts.find(
+          (currentTarget) => currentTarget.tid === targetID
+        );
+        if (target !== undefined) {
+          // we found the target
+          if (target[FILTER_FIELD] === undefined) {
+            // the target does not have the filter field yet
+            try {
+              target[FILTER_FIELD] = workspace.id;
+            } catch (e) {
+              debugger;
+              return false;
+            }
+          } else {
+            // the target does have the filter field
+            target[FILTER_FIELD] += ", ";
+            target[FILTER_FIELD] += workspace.id;
+          }
+        } else {
+          // we should not have PCI that does not have Workspace component objects
+          debugger;
+          return false;
+        }
+      }
+      // find matching Configs to tag with this workspace
+      for (let configID of workspace.associatedConfigs) {
+        let config = this.cs.find(
+          (currentConfig) => currentConfig.id === configID
+        );
+        if (config !== undefined) {
+          // we found the config
+          if (config[FILTER_FIELD] === undefined) {
+            // the config does not have the filter field yet
+            try {
+              config[FILTER_FIELD] = workspace.id;
+            } catch (e) {
+              debugger;
+              return false;
+            }
+          } else {
+            // the config does have the filter field
+            config[FILTER_FIELD] += ", ";
+            config[FILTER_FIELD] += workspace.id;
+          }
+        } else {
+          // we should not have PCI that does not have Workspace component objects
+          debugger;
+          return false;
+        }
+      }
+    }
+    return true;
   }
 }
 
 import { deserializeArray } from 'class-transformer';
-import virtualTenants from "./virtualTenants.json";
-import syncTenants from "./syncTenants.json";
-import syncConfigs from "./syncConfigs.json";
-
-// called by unit test
-export function readobjects() {
-  // convert read JSON to VirtualTenant array
-  debugger;
-  let virtuals = null;
-  var virtualTenantsString = JSON.stringify(virtualTenants);
-  try {
-    virtuals = deserializeArray(VirtualTenant, virtualTenantsString);
-  } catch (e) {
-    debugger;
-    return 0;
-  }
-  // make some assertion about the data we just read
-  return virtuals.length;
-}
+import users from "./users.json";
+import targets from "./targets.json";
+import configs from "./configs.json";
+import workspaces from "./workspaces.json";
 
-// retrievesync  configurations based on passed user information
-export function readConfigs(user, userConfigInfo)
+// retrieve Workspace(s), User(s), Target(s), Config(s) given logged in user
+export function InitPortal(user, portalConfigInfo)
 {
   debugger;
   // for now, just get hardcoded data from JSON
-  var virtualTenantsString = JSON.stringify(virtualTenants);
-  var syncTenantsString = JSON.stringify(syncTenants);
-  var syncConfigsString = JSON.stringify(syncConfigs);
+  var usersString = JSON.stringify(users);
+  var targetsString = JSON.stringify(targets);
+  var configsString = JSON.stringify(configs);
+  var workspacesString = JSON.stringify(workspaces);
   try {
-    userConfigInfo.vts = deserializeArray(VirtualTenant, virtualTenantsString);
-    userConfigInfo.sts = deserializeArray(SyncTenant, syncTenantsString);
-    userConfigInfo.scs = deserializeArray(SyncConfig, syncConfigsString);
+    portalConfigInfo.us = deserializeArray(User, usersString); 
+    portalConfigInfo.ts = deserializeArray(Target, targetsString);
+    portalConfigInfo.cs = deserializeArray(Config, configsString);
+    portalConfigInfo.ws = deserializeArray(Workspace, workspacesString);
+    portalConfigInfo.tagWithWorkspaces();
+    debugger;
   } catch (e) {
     debugger;
     return false;
   }
   return true;
+}
+
+export function AddTarget()
+{
+  return true;
+}
+
+export function CompleteTarget()
+{
+  return true;
+}
+
+export function AddUser()
+{
+  return true;
+}
+
+export function CompleteUser()
+{
+  return true;
+}
+
+export function CreateConfig()
+{
+  return true;
 }

package/index.test.js

@@ -1,15 +1,12 @@
-import {sum, readobjects, readConfigs, User, UserConfigInfo, VirtualTenant, SyncTenant, SyncConfig} from "./index.js";
+import {sum, User, PortalConfigInfo, InitPortal } from "./index.js";
 import {test, expect} from "vitest";
 
 test("adds 1 + 2 to equal 3", () => {
   expect(sum(1, 2)).toBe(3);
 });
-test("loads array of VirtualTenants from JSON and expects 2", () => {
-  expect(readobjects()).toBe(2);
-});
 test("loads config based on a user and expects function to return true", () => {
   let u = new User();
-  let uci = new UserConfigInfo();
-  expect(readConfigs(u, uci)).toBe(true);
-  expect(uci.vts.length).toBe(2);
+  let pci = new PortalConfigInfo();
+  expect(InitPortal(u, pci)).toBe(true);
+  expect(pci.us.length).toBe(2);
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mindline/sync",
   "type": "module",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "description": "sync is a node.js package encapsulating javscript classes required for configuring Mindline sync service.",
   "exports": "./index.js",
   "scripts": {

package/sync.d.ts

@@ -2,50 +2,65 @@ declare module "@mindline/sync" {
   export function sum(a: number, b: number): number;
   export function helloNpm(): string;
 
-  // user information passed to  back end
+  // admin
   export class User {
-    authority: string; // from AAD
-    oid: string; // from AAD
-    tid: string; // from AAD
-    upn: string; // from AAD
-    name: string; // from AAD
+    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[];
   }
 
-  // configuration information returned by back end
-  export class UserConfigInfo {
-    vts: VirtualTenant[];
-    sts: SyncTenant[];
-    scs: SyncConfig[];
+  // target (Azure AD tenant, AD domain, Google workspace)
+  enum TargetType { AAD = 1, AD, Google }
+  export class Target {
+    tid: string;        // from AAD ID token
+    name: string;       // findTenantInformationByTenantId
+    domain: string;     // findTenantInformationByTenantId
+    type: TargetType;   // always AAD for now
+    authority: string;  // from AAD ID auth response
+    readServicePrincipal: string; // from AAD consent
+    writeServicePrincipal: string; // from AAD consent
   }
 
-  // shared base class of virtual and sync tenants
-  export class Tenant {
-    authority: string;  // from AAD
-    tid: string;        // from AAD
-    name: string;       // from AAD: tenant display name
-    domain: string;     // from AAD: tenant default domain
+  // config
+  export class TargetConfigInfo {
+    tid: string;            // target identifier
+    sourceGroups: string[]; // source groups - we can confiure multiple source groups for reading (*may* slow things down, but less work for admin)
+    targetGroup: string;    // target group - we only write users to a single target group (complex to fiugure out which users get written to which groups)
   }
-
-  // class for "hub" tenants
-  export class VirtualTenant extends Tenant {
-    description: string; // from DB
+  export class Config {
+    id: string;
+    name: string;
+    description: string;
+    targetConfigs: TargetConfigInfo[];
+    enabled: boolean;
   }
 
-  // class for "spoke" tenants
-  export class SyncTenant extends Tenant {
-    tenantType: string; // from DB: AAD | AD | Google -- always AAD for now
-    readServicePrincipal: string; // from AAD
-    writeServicePrincipal: string; // from AAD
-    virtualTenantID: string;
+  // class to group Users, Tenants, and Configs
+  export class Workspace {
+    id: string;
+    name: string;
+    associatedUsers: string[];
+    associatedTargets: string[];
+    associatedConfigs: string[];
   }
 
-  // class for sync configuration
-  export class SyncConfig {
-    enabled: boolean; // from DB
-    virtualTenantID: string;
-    deltaLink: string;
+  export class PortalConfigInfo {
+    us: User[];
+    ts: Target[];
+    cs: Config[];
+    ws: Workspace[];
+    tagWithWorkspaces(): boolean;
   }
 
-  export function readobjects(): number;
-  export function readConfigs(u: User, uci: UserConfigInfo): boolean;
+  export function InitPortal(u: User, pci: PortalConfigInfo): boolean;
+  export function AddTarget(): boolean;
+  export function CompleteTarget(): boolean;
+  export function AddUser(): boolean;
+  export function CompleteUser(): boolean;
+  export function CreateConfig(): boolean;
 }

package/targets.json

@@ -0,0 +1,20 @@
+[
+  {
+    "tid": "7f4567b8-f9a9-4ad3-9cb5-ef16a80e5744",
+    "name": "Mindline1",
+    "domain": "mindline1.onmicrosoft.com",
+    "type": "1",
+    "authority": "https://login.microsoftonline.com/common/",
+    "readServicePrincipal": "TODO",
+    "writeServicePrincipal": "TODO"
+  },
+  {
+    "tid": "df9c2e0a-f6fe-43bb-a155-d51f66dffe0e",
+    "name": "Mindline2",
+    "domain": "mindline2.onmicrosoft.com",
+    "type": "1",
+    "authority": "https://login.microsoftonline.com/common/",
+    "readServicePrincipal": "TODO",
+    "writeServicePrincipal": "TODO"
+  }
+]

package/users.json

@@ -0,0 +1,22 @@
+[
+  {
+    "oid": "102bafe7-9e62-4993-b943-2f20c609e5c9",
+    "name": "Arvind Suthar",
+    "mail": "arvind@mindline1.onmicrosoft.com",
+    "authority": "https://login.microsoftonline.com/common/",
+    "tid": "7f4567b8-f9a9-4ad3-9cb5-ef16a80e5744",
+    "companyName": "Mindline1",
+    "companyDomain": "mindline1.onmicrosoft.com",
+    "associatedWorkspaces": [ "1" ]
+  },
+  {
+    "oid": "e5a42d0c-4fa5-4a65-8d9b-90f989ecae9b",
+    "name": "Arvind Suthar",
+    "mail": "arvind@mindline2.onmicrosoft.com",
+    "authority": "https://login.microsoftonline.com/common/",
+    "tid": "df9c2e0a-f6fe-43bb-a155-d51f66dffe0e",
+    "companyName": "Mindline2",
+    "companyDomain": "mindline2.onmicrosoft.com",
+    "associatedWorkspaces": [ "1" ]
+  }
+]

package/workspaces.json

@@ -0,0 +1,9 @@
+[
+  {
+    "id": "1",
+    "name": "Default",
+    "associatedUsers": [ "102bafe7-9e62-4993-b943-2f20c609e5c9", "e5a42d0c-4fa5-4a65-8d9b-90f989ecae9b" ],
+    "associatedTargets": [ "7f4567b8-f9a9-4ad3-9cb5-ef16a80e5744", "df9c2e0a-f6fe-43bb-a155-d51f66dffe0e" ],
+    "associatedConfigs": [ "1" ]
+  }
+]