Merge pull request #278 from com-pas/Move_UserInfo_To_Compas_Foundation

Move user info to compas foundation

Author: pascalwilbrink

src/Hosting.ts

@@ -15,7 +15,8 @@ import { Drawer } from '@material/mwc-drawer';
 import { ActionDetail, List } from '@material/mwc-list';
 import { ListItem } from '@material/mwc-list/mwc-list-item';
 
-import { Mixin, newPendingStateEvent, UserInfoEvent } from './foundation.js';
+import { Mixin, newPendingStateEvent } from './foundation.js';
+import { UserInfoEvent } from './compas/foundation.js';
 import { LoggingElement } from './Logging.js';
 import { PluggingElement, Plugin, pluginIcons } from './Plugging.js';
 import { SettingElement } from './Setting.js';

src/compas/CompasUserInfo.ts

@@ -1,4 +1,4 @@
-import { newUserInfoEvent } from '../foundation.js';
+import { newUserInfoEvent } from './foundation.js';
 
 import { CompasUserInfoService } from '../compas-services/CompasUserInfoService.js';
 import { createLogEvent } from '../compas-services/foundation.js';

src/compas/foundation.ts

@@ -106,3 +106,25 @@ export function compareVersions(
   }
   return result;
 }
+
+/** Represents user information from a backend. */
+export interface UserInfoDetail {
+  name: string;
+}
+export type UserInfoEvent = CustomEvent<UserInfoDetail>;
+export function newUserInfoEvent(
+  name: string,
+  eventInitDict?: CustomEventInit<Partial<UserInfoDetail>>
+): UserInfoEvent {
+  return new CustomEvent<UserInfoDetail>('userinfo', {
+    bubbles: true,
+    composed: true,
+    ...eventInitDict,
+    detail: { name, ...eventInitDict?.detail },
+  });
+}
+declare global {
+  interface ElementEventMap {
+    ['userinfo']: UserInfoEvent;
+  }
+}

src/foundation.ts

@@ -479,23 +479,6 @@ export function newOpenDocEvent(
   });
 }
 
-/** Represents user information from a backend. */
-export interface UserInfoDetail {
-  name: string;
-}
-export type UserInfoEvent = CustomEvent<UserInfoDetail>;
-export function newUserInfoEvent(
-  name: string,
-  eventInitDict?: CustomEventInit<Partial<UserInfoDetail>>
-): UserInfoEvent {
-  return new CustomEvent<UserInfoDetail>('userinfo', {
-    bubbles: true,
-    composed: true,
-    ...eventInitDict,
-    detail: { name, ...eventInitDict?.detail },
-  });
-}
-
 /** @returns a reference to `element` with segments delimited by '/'. */
 // TODO(c-dinkel): replace with identity (FIXME)
 export function referencePath(element: Element): string {
@@ -2880,7 +2863,6 @@ declare global {
     ['pending-state']: PendingStateEvent;
     ['editor-action']: EditorActionEvent<EditorAction>;
     ['open-doc']: OpenDocEvent;
-    ['userinfo']: UserInfoEvent;
     ['wizard']: WizardEvent;
     ['validate']: ValidateEvent;
     ['log']: LogEvent;

test/integration/compas/foundation.test.ts

@@ -1,10 +1,12 @@
 import { expect, fixture, html } from '@open-wc/testing';
 
-import { updateDocumentInOpenSCD } from '../../../src/compas/foundation.js';
+import {
+  updateDocumentInOpenSCD,
+  newUserInfoEvent,
+} from '../../../src/compas/foundation.js';
 
 import { OpenSCD } from '../../../src/open-scd.js';
 import '../../../src/open-scd.js';
-import { newUserInfoEvent } from '../../../src/foundation.js';
 
 describe('compas-foundation', () => {
   let element: OpenSCD;