initial commit

src/types/element.ts

@@ -0,0 +1,55 @@
+import type { Modality } from 'src/types/modality';
+
+export type BaseElement = {
+  id: string;
+  modality: Modality;
+  h: number;
+  w: number;
+
+  xWidget: number;
+  yWidget: number;
+
+  expirationInterval?: number;
+  expiration?: string;
+  onExpiration?: 'delete' | 'escalate' | 'deescalate';
+  interacted?: boolean;
+  canOverlap?: boolean;
+};
+
+export type TableElement = BaseElement & {
+  type: 'table';
+  /** additional properties here */
+};
+
+export type ButtonElement = BaseElement & {
+  type: 'button';
+  /** additional properties here */
+};
+
+export type TextElement = BaseElement & {
+  type: 'text';
+  /** additional properties here */
+};
+
+export type ImageElement = BaseElement & {
+  type: 'image';
+  /** additional properties here */
+};
+
+export type AudioElement = BaseElement & {
+  type: 'audio';
+  /** additional properties here */
+};
+
+export type IconElement = BaseElement & {
+  type: 'icon';
+  /** additional properties here */
+};
+
+export type Element =
+  | TableElement
+  | ButtonElement
+  | TextElement
+  | ImageElement
+  | AudioElement
+  | IconElement;

src/types/modalities.ts

@@ -1,36 +0,0 @@
-/* MODIFY AS REQUIRED */
-
-export type Modality =
-  | 'visual'
-  | 'auditory'
-  | 'tactile'
-  | 'olfactory'
-  | 'gustatory';
-
-export type Element = {
-  expirationInterval?: number;
-  expiration?: string;
-  onExpiration?: 'delete' | 'escalate' | 'deescalate';
-  interacted?: boolean;
-  id: string;
-  modality: Modality;
-  type: 'table' | 'button' | 'text' | 'image' | 'audio' | 'icon';
-  xWidget: number;
-  yWidget: number;
-  h: number;
-  w: number;
-  canOverlap?: boolean;
-};
-
-export type Widget = {
-  elements: Element[];
-  id: string;
-  type: 'tinder' | 'message' | 'highWarning' | 'lowWarning' | 'request';
-  maxAmount: number;
-  x: number;
-  y: number;
-  w: number;
-  h: number;
-  useElementLocation: boolean;
-  canOverlap: boolean;
-};

src/types/modality.ts

@@ -0,0 +1,6 @@
+export type Modality =
+  | 'visual'
+  | 'auditory'
+  | 'tactile'
+  | 'olfactory'
+  | 'gustatory';

src/types/widget.ts

@@ -0,0 +1,35 @@
+export type BaseWidget = {
+  element: Element[];
+  id: string;
+  x: number;
+  y: number;
+  w: number;
+  h: number;
+  canOverlap: boolean;
+};
+
+export type MessageWidget = BaseWidget & {
+  type: 'message';
+  /** additional properties here */
+};
+
+export type HighWarningWidget = BaseWidget & {
+  type: 'highWarning';
+  /** additional properties here */
+};
+
+export type LowWarningWidget = BaseWidget & {
+  type: 'lowWarning';
+  /** additional properties here */
+};
+
+export type RequestWidget = BaseWidget & {
+  type: 'request';
+  /** additional properties here */
+};
+
+export type Widget =
+  | MessageWidget
+  | HighWarningWidget
+  | LowWarningWidget
+  | RequestWidget;