@mindline/sync 1.0.29 → 1.0.30

package/index.d.ts

@@ -4,6 +4,11 @@ declare module "@mindline/sync" {
   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
@@ -18,56 +23,160 @@ declare module "@mindline/sync" {
     session: string;
     spacode: string;
     accessToken: string;
+    loginHint: string;
+    scopes: string[];
+    authTS: Date;
+    constructor();
   }
-
-  // target (Azure AD tenant, AD domain, Google workspace)
-  export class Target {
-    tid: string;        // from AAD ID token
-    name: string;       // findTenantInformationByTenantId
-    domain: string;     // findTenantInformationByTenantId
-    type: string;       // always AAD=1 for now
+  // 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 class TargetConfigInfo {
-    tid: string;            // target identifier
-    sourceGroups: string[]; // source groups - we can configure 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)
+  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;
-    targetConfigs: TargetConfigInfo[];
-    enabled: boolean;
+    tenants: TenantConfigInfo[];
+    isEnabled: boolean;
     workspaceIDs: string;
+    constructor();
   }
-
   // class to group Users, Tenants, and Configs
   export class Workspace {
     id: string;
     name: string;
     associatedUsers: string[];
-    associatedTargets: string[];
+    associatedTenants: string[];
     associatedConfigs: string[];
+    constructor();
   }
-
   export class InitInfo {
     us: User[];
-    ts: Target[];
+    ts: Tenant[];
     cs: Config[];
     ws: Workspace[];
+    constructor(bClearLocalStorage: boolean);
+    init(bClearLocalStorage: boolean): void;
+    save(): void;
     tagWithWorkspaces(): boolean;
   }
-
-  export function InitGet(ii: InitInfo, instance: IPublicClientApplication, debug: boolean): boolean;
-  export function AddTarget(): boolean;
-  export function CompleteTarget(): boolean;
-  export function AddUser(): boolean;
-  export function CompleteUser(): boolean;
-  export function CreateConfig(): 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;
+    test(): 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;
+  export function userRemove(instance: IPublicClientApplication, authorizedUser: User, user: User, workspaceId: string): APIResult;
 }

package/index.test.ts

@@ -1,12 +1,6 @@
-import {sum, InitInfo, InitGet} from "./index";
+import {sum} from "./index";
 import {test, expect} from "vitest";
-import {stubbedPublicClientApplication} from "@azure/msal-browser/dist";
 
 test("adds 1 + 2 to equal 3", () => {
   expect(sum(1, 2)).toBe(3);
-});
-test("loads config based on a user and expects function to return true", () => {
-  let ii = new InitInfo();
-  let bResult:boolean = InitGet(ii, stubbedPublicClientApplication, true);
-  expect(bResult);
 });