@mindline/sync 1.0.0 → 1.0.1

package/README.md

@@ -1,15 +1,49 @@
 # Introduction 
 sync is a node.js package encapsulating javscript classes required for configuring Mindline sync service.
-
 # Getting Started
 TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
-1.	Installation process
-2.	Software dependencies
-3.	Latest releases
-4.	API references
-
-# Build and Test
-TODO: Describe and show how to build your code and run the tests. Jest?
-
-# Contribute
+# 1.	Installation process
+## install Node
+https://nodejs.org/en/download
+## Enable jest for ES6 to enable Jest operation on my codebase
+See this article
+https://stackoverflow.com/questions/59879689/jest-syntaxerror-cannot-use-import-statement-outside-a-module
+### install babel-jest
+### `npm install --save-dev babel-jest`
+### modify package.json file to use babel-jest
+``` js
+  "jest": {
+    "transform": {
+      "^.+\\.[t|j]sx?$": "babel-jest"
+    }
+  },
+``` 
+### create .babelrc configuration file
+Create a babel.config.json config in your project root and enable some presets.
+To start, you can use the env preset, which enables transforms for ES2015+
+``` js
+npm install @babel/preset-env --save-dev
+```
+In order to enable the preset you have to define it in your babel.config.json file, like this:
+``` js
+{
+  "presets": ["@babel/preset-env"]
+}
+```
+## install class transformer packages to convert JSON file imports into class objects
+``` js
+npm install class-transformer --save
+npm install reflect-metadata --save
+```
+# 2.	Latest releases
+# 3.	API references
+# 4. Unit Test
+### `npm test`
+# 6. Publish
+### `npm login`
+username, password, OTP code required
+### `npm publish --access=public --otp=XXXXXX`
+### `npm publish --dry-run`
+publishes package
+# 7. Contribute
 TODO: Explain how other users and developers can contribute to make your code better.

package/auditLogs.json

@@ -0,0 +1,14 @@
+[
+  {
+    "virtualTenantID": "85132631-cac3-4708-86b9-b4019f2132e9",
+    "Time Stamp": "07:25 PST 25 Feb 2023",
+    "Actor": "joe@customerx.com",
+    "Action": "sync config modified"
+  },
+  {
+    "virtualTenantID": "85132631-cac3-4708-86b9-b4019f2132e8",
+    "Time Stamp": "05:47 PST 25 Feb 2023",
+    "Actor": "admin@customerx.com",
+    "Action": "sync config created"
+  }
+]

package/babel.config.json

@@ -0,0 +1,3 @@
+{
+  "presets": ["@babel/preset-env"]
+}

package/index.js

@@ -1,7 +1,127 @@
 //index.js
 
+// called by unit test
+function sum(a, b) {
+  return a + b;
+}
+
+// called by simpleclass test app
 function helloNpm() {
-    return "hello NPM"
-  }
+  return "hello NPM";
+}
+
+import { deserializeArray } from 'class-transformer';
+import virtualTenants from "./virtualTenants.json";
+import syncTenants from "./syncTenants.json";
+import syncConfigs from "./syncConfigs.json";
+import auditLogs from "./auditLogs.json";
+import provisioningLogs from "./provisioningLogs.json";
+
+class User{
+  authority;  // from AAD 
+  oid;        // from AAD 
+  tid;        // from AAD 
+  upn;        // from AAD
+  name;       // from AAD
+}
+
+// shared base class of virtual and sync tenants
+class Tenant{
+  authority;  // from AAD 
+  tid;        // from AAD 
+  name;       // from AAD: tenant display name
+  domain;     // from AAD: tenant default domain
   
-  module.exports = helloNpm
+  validate() {} // populate tenantId,tenantName based on tenantDomain
+
+  // TODO: can we just reference  response object
+  SignIn() {}   // sign in and set signinToken
+  SignOut() {}  // sign out and clear signinToken
+  SignInToken() {} // session access
+};
+
+// class for "hub" tenants
+class VirtualTenant extends Tenant{
+  description;  // from DB
+  
+  // save or remove this tenant from our DB
+  Save() {}
+  Remove() {}
+
+  // admin console reads all tenants configured in AAD OR present in our database that connect to this virtual tenant
+  ReadSyncTenants() {}
+
+  // admin console can add sync tenants in sovereign clouds that are NOT configured in AAD to sync to/from this virtual tenant
+  AddSyncTenant() {}
+  RemoveSyncTenant() {}
+};
+
+// class for "spoke" tenants
+class SyncTenant extends Tenant{
+  tenantType;             // from DB: AAD | AD | Google -- always AAD for now
+  readServicePrincipal;   // from AAD
+  writeServicePrincipal;  // from AAD
+  virtualTenantID;
+
+  // start/stop tracking this tenant
+  Save() {}
+  Remove() {}
+
+  // service principal creation in AAD
+  CreateReadSP() {}
+  CreateWriteSP() {}
+
+  // service principal removal from AAD
+  RemoveReadSP() {}
+  RemoveWriteSP() {}
+};
+
+// class for sync configuration
+class SyncConfig {
+  enabled;      // from DB
+  virtualTenantID;
+  deltaLink;
+};
+
+// called by unit test
+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;
+}
+
+// retrievesync  configurations based on passed user information
+function readConfigs(user, virtuals, syncs, configs)
+{
+  debugger;
+  // for now, just get hardcoded data from JSON
+  var virtualTenantsString = JSON.stringify(virtualTenants);
+  var syncTenantsString = JSON.stringify(syncTenants);
+  var syncConfigsString = JSON.stringify(syncConfigs);
+  try {
+    virtuals = deserializeArray(VirtualTenant, virtualTenantsString);
+    syncs = deserializeArray(SyncTenant, syncTenantsString);
+    configs = deserializeArray(SyncConfig, syncConfigsString);
+  } catch (e) {
+    debugger;
+    return false;
+  }
+  return true;
+}
+
+module.exports = { 
+  sum, 
+  helloNpm, 
+  readobjects, 
+  User, VirtualTenant, SyncTenant, SyncConfig,
+  readConfigs
+};

package/index.test.js

@@ -0,0 +1,16 @@
+import {sum, readobjects, readConfigs, User, VirtualTenant, SyncTenant, SyncConfig} from "./index.js";
+
+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", () => {
+  debugger;
+  let u = new User;
+  let vts = new Array();
+  let sts = new Array();
+  let scs = new Array();
+  expect(readConfigs(u, vts, sts, scs)).toBe(true);
+});

package/package.json

@@ -1,12 +1,25 @@
-{
-  "name": "@mindline/sync",
-  "version": "1.0.0",
-  "description": "sync is a node.js package encapsulating javscript classes required for configuring Mindline sync service.",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC"
-}
+{
+  "name": "@mindline/sync",
+  "version": "1.0.1",
+  "description": "sync is a node.js package encapsulating javscript classes required for configuring Mindline sync service.",
+  "main": "index.js",
+  "scripts": {
+    "test": "jest"
+  },
+  "jest": {
+    "transform": {
+      "^.+\\.[t|j]sx?$": "babel-jest"
+    }
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@babel/preset-env": "^7.20.2",
+    "jest": "^29.5.0"
+  },
+  "dependencies": {
+    "class-transformer": "^0.5.1",
+    "reflect-metadata": "^0.1.13"
+  }
+}

package/provisioningLogs.json

@@ -0,0 +1,20 @@
+[
+  {
+    "virtualTenantID": "85132631-cac3-4708-86b9-b4019f2132e9",
+    "Time Stamp": "07:25 PST 25 Feb 2023",
+    "Actor": "ProdSync",
+    "Action": "user 'user1' created",
+    "Source": "Subsidiary Y",
+    "Target": "Customer X",
+    "Status": "Success"
+  },
+  {
+    "virtualTenantID": "85132631-cac3-4708-86b9-b4019f2132e8",
+    "Time Stamp": "07:25 PST 25 Feb 2023",
+    "Actor": "ProdSync",
+    "Action": "user 'user2' created",
+    "Source": "Subsidiary Y",
+    "Target": "Customer X",
+    "Status": "Success"
+  }
+]

package/syncConfigs.json

@@ -0,0 +1,26 @@
+[
+  {
+    "virtualTenantID": "85132631-cac3-4708-86b9-b4019f2132e9",
+    "name": "ProdSync",
+    "tenantCount": "2",
+    "description": "Production Mindline Sync Configuration."
+  },
+  {
+    "virtualTenantID": "85132631-cac3-4708-86b9-b4019f2132e9",
+    "name": "TestSync",
+    "tenantCount": "2",
+    "description": "Test Mindline Sync Configuration."
+  },
+  {
+    "virtualTenantID": "85132631-cac3-4708-86b9-b4019f2132e8",
+    "name": "ProdSync",
+    "tenantCount": "2",
+    "description": "Automated sync of users from Subsidiary Y to Customer X."
+  },
+  {
+    "virtualTenantID": "85132631-cac3-4708-86b9-b4019f2132e8",
+    "name": "TestSync",
+    "tenantCount": "2",
+    "description": "Test automated sync of users from Subsidiary Y to Customer X."
+  }
+]

package/syncTenants.json

@@ -0,0 +1,34 @@
+[
+  {
+    "virtualTenantID": "85132631-cac3-4708-86b9-b4019f2132e9",
+    "name": "Mindline1",
+    "direction": "Outbound",
+    "readServicePrincipal": "1234",
+    "writeServicePrincipal": "N/A",
+    "session": "Off"
+  },
+  {
+    "virtualTenantID": "85132631-cac3-4708-86b9-b4019f2132e9",
+    "name": "Mindline2",
+    "direction": "Inbound",
+    "readServicePrincipal": "9101",
+    "writeServicePrincipal": "1121",
+    "session": "Off"
+  },
+  {
+    "virtualTenantID": "85132631-cac3-4708-86b9-b4019f2132e8",
+    "name": "Customer X",
+    "direction": "Inbound",
+    "readServicePrincipal": "1234",
+    "writeServicePrincipal": "5678",
+    "session": "Off"
+  },
+  {
+    "virtualTenantID": "85132631-cac3-4708-86b9-b4019f2132e8",
+    "name": "Subisidiary Y",
+    "direction": "Outbound",
+    "readServicePrincipal": "9101",
+    "writeServicePrincipal": "N/A",
+    "session": "Off"
+  }
+]

package/virtualTenants.json

@@ -0,0 +1,16 @@
+[
+  {
+    "tenantID": "85132631-cac3-4708-86b9-b4019f2132e9",
+    "name": "Mindline",
+    "domain": "bellevuearvindhotmail.onmicrosoft.com",
+    "description": "Mindline virtual tenant.",
+    "session": "Off"
+  },
+  {
+    "tenantID": "85132631-cac3-4708-86b9-b4019f2132e8",
+    "name": "virttenant",
+    "domain": "virttenant.onmicrosoft.com",
+    "description": "Prod virtual tenant for CustomerX.",
+    "session": "Off"
+  }
+]