@mindline/sync 1.0.8 → 1.0.10

package/README.md

@@ -5,31 +5,6 @@ TODO: Guide users through getting your code up and running on their own system.
 # 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

package/index.js

@@ -1,90 +1,80 @@
 //index.js
 
 // called by unit test
-function sum(a, b) {
+export function sum(a, b) {
   return a + b;
 }
 
 // called by simpleclass test app
-function helloNpm() {
+export function helloNpm() {
   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";
+export class User {
+  constructor(){
+    this.authority = "";
+    this.oid = "";
+    this.tid = "";
+    this.upn = "";
+    this.name = "";
+  }
+}
 
-class User{
-  authority;  // from AAD 
-  oid;        // from AAD 
-  tid;        // from AAD 
-  upn;        // from AAD
-  name;       // from AAD
+export class UserConfigInfo {
+  constructor(){
+    this.vts = null;
+    this.sts = null;
+    this.scs = null;
+  }
 }
 
 // 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
-  
-  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
-};
+export class Tenant {
+  constructor(){
+    this.authority = "";
+    this.tid = "";
+    this.name = "";
+    this.domain = "";
+  }
+}
 
 // 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() {}
-};
+export class VirtualTenant extends Tenant {
+  constructor(){
+    super();
+    this.description = "";
+  }
+}
 
 // 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() {}
-};
+export class SyncTenant extends Tenant {
+  constructor(){
+    super();
+    this.tenantType = "";
+    this.readServicePrincipal = "";
+    this.writeServicePrincipal = "";
+    this.virtualTenantID = "";
+  }
+}
 
 // class for sync configuration
-class SyncConfig {
-  enabled;      // from DB
-  virtualTenantID;
-  deltaLink;
-};
+export class SyncConfig {
+  constructor(){
+    this.enabled = "";
+    this.virtualTenantID = "";
+    this.deltaLink = "";
+  }
+}
+
+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";
 
 // called by unit test
-function readobjects() {
+export function readobjects() {
   // convert read JSON to VirtualTenant array
   debugger;
   let virtuals = null;
@@ -100,7 +90,7 @@ function readobjects() {
 }
 
 // retrievesync  configurations based on passed user information
-function readConfigs(user, virtuals, syncs, configs)
+export function readConfigs(user, userConfigInfo)
 {
   debugger;
   // for now, just get hardcoded data from JSON
@@ -108,20 +98,12 @@ function readConfigs(user, virtuals, syncs, configs)
   var syncTenantsString = JSON.stringify(syncTenants);
   var syncConfigsString = JSON.stringify(syncConfigs);
   try {
-    virtuals = deserializeArray(VirtualTenant, virtualTenantsString);
-    syncs = deserializeArray(SyncTenant, syncTenantsString);
-    configs = deserializeArray(SyncConfig, syncConfigsString);
+    userConfigInfo.vts = deserializeArray(VirtualTenant, virtualTenantsString);
+    userConfigInfo.sts = deserializeArray(SyncTenant, syncTenantsString);
+    userConfigInfo.scs = deserializeArray(SyncConfig, syncConfigsString);
   } catch (e) {
     debugger;
     return false;
   }
   return true;
-}
-
-export { 
-  sum, 
-  helloNpm, 
-  readobjects, 
-  User, VirtualTenant, SyncTenant, SyncConfig,
-  readConfigs
-};
+}

package/index.test.js

@@ -1,4 +1,5 @@
-import {sum, readobjects, readConfigs, User, VirtualTenant, SyncTenant, SyncConfig} from "./index.js";
+import {sum, readobjects, readConfigs, User, UserConfigInfo, VirtualTenant, SyncTenant, SyncConfig} from "./index.js";
+import {test, expect} from "vitest";
 
 test("adds 1 + 2 to equal 3", () => {
   expect(sum(1, 2)).toBe(3);
@@ -7,9 +8,8 @@ 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 vts = new Array();
-  let sts = new Array();
-  let scs = new Array();
-  expect(readConfigs(u, vts, sts, scs)).toBe(true);
+  let u = new User();
+  let uci = new UserConfigInfo();
+  expect(readConfigs(u, uci)).toBe(true);
+  expect(uci.vts.length).toBe(2);
 });

package/package.json

@@ -1,23 +1,18 @@
 {
   "name": "@mindline/sync",
   "type": "module",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "sync is a node.js package encapsulating javscript classes required for configuring Mindline sync service.",
   "exports": "./index.js",
   "scripts": {
-    "test": "jest"
-  },
-  "jest": {
-    "transform": {
-      "^.+\\.[t|j]sx?$": "babel-jest"
-    }
+    "test": "vitest",
+    "coverage": "vitest run --coverage"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "@babel/preset-env": "^7.20.2",
-    "jest": "^29.5.0"
+    "vitest": "^0.29.8"
   },
   "dependencies": {
     "class-transformer": "^0.5.1",

package/sync.d.ts

@@ -1,12 +1,51 @@
-declare module '@mindline/sync' {
-    //export interface SomeType {
-      // type definition here
-    //}
-  
-    //sum, 
-    export function helloNpm(): string;
-
-    //readobjects, 
-    //User, VirtualTenant, SyncTenant, SyncConfig,
-    //export function readConfigs(u: User, vts: Array, sts: Array, scs: Array): boolean;
-  }
+declare module "@mindline/sync" {
+  export function sum(a: number, b: number): number;
+  export function helloNpm(): string;
+
+  // user information passed to  back end
+  export class User {
+    authority: string; // from AAD
+    oid: string; // from AAD
+    tid: string; // from AAD
+    upn: string; // from AAD
+    name: string; // from AAD
+  }
+
+  // configuration information returned by back end
+  export class UserConfigInfo {
+    vts: VirtualTenant[];
+    sts: SyncTenant[];
+    scs: SyncConfig[];
+  }
+
+  // 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
+  }
+
+  // class for "hub" tenants
+  export class VirtualTenant extends Tenant {
+    description: string; // from DB
+  }
+
+  // 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 for sync configuration
+  export class SyncConfig {
+    enabled: boolean; // from DB
+    virtualTenantID: string;
+    deltaLink: string;
+  }
+
+  export function readobjects(): number;
+  export function readConfigs(u: User, uci: UserConfigInfo): boolean;
+}

package/vitest.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    // ...
+  },
+})

package/babel.config.json

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