gps-global-types 1.0.2 → 1.0.4

package/link.types.tsx

@@ -1,22 +1,22 @@
-import {BaseType,Selection, SimulationLinkDatum, SimulationNodeDatum} from 'd3';
-import { mstGlobalTypes } from './mst.types';
+import type { BaseType, Selection, SimulationLinkDatum, SimulationNodeDatum } from 'd3';
+import type { mstGlobalTypes } from './mst.types.tsx';
 interface coords {
-    x:number,
-    y:number
+    x: number,
+    y: number
 }
- export interface EdgeType   { // extends SimulationLinkDatum<NodeType>} anything not defined here was added by d3 (or i fucked up)
- source:coords // node _id edge to
- target:coords // node _id edge from
- value:number // distance between source and target
+export interface EdgeType { // extends SimulationLinkDatum<NodeType>} anything not defined here was added by d3 (or i fucked up)
+    source: coords // node _id edge to
+    target: coords // node _id edge from
+    value: number // distance between source and target
 }
 
-export type gLinkType =  Selection<SVGGElement, EdgeType, BaseType, unknown>
+export type gLinkType = Selection<SVGGElement, EdgeType, BaseType, unknown>
 export interface LinkType {
-    g:gLinkType
+    g: gLinkType
 }
 
-export interface LinkProps   {
+export interface LinkProps {
     data: EdgeType[],
-    force:mstGlobalTypes
+    force: mstGlobalTypes
 }
 export type svgSelection = Selection<BaseType, gLinkType, Element, LinkType>; //Selection<Element,LinkType,Element,any>

package/mst.types.tsx

@@ -1,4 +1,6 @@
-import { armordAccessionNumber, Color, mrsnId, ObjectId, RegexMatchedString } from "./global.types";
+import type { armordAccessionNumber, Color, mrsnId, ObjectId, RegexMatchedString } from "./global.types.js";
+import type { EdgeType } from "./link.types.js";
+import type { NodeType } from "./pie.types.js";
 
 export interface mstGlobalTypes {
     //form values
@@ -11,15 +13,15 @@ export interface mstGlobalTypes {
     fuzzyThreshold: number, //= 0, // nodes outside of requested list that are x alleles away from the original mst
     neighbor: number, //= 1, // how many isolate neighbors to return (minimum) 
     slim?: boolean, //false //are the node labels collapsed or expanded?
-    
+
     //interactive nodes
     //  checkedNodes:mrsnId[], ????
     //  highlightedNodes:mrsnId[] ????
 }
 
-export const colorFields= ['armordPatientId','mlst','sampleType','armordFacility','armordCountry','custom color'] as const; //no :string[] ! removes 'const'
-export const dateFields= ['armordCultureDate','month','quarter','year'] as const;
-export const labelFields= ['armordMrsnIdLBL','mrsnIdLBL','armordAccessionNumberLBL','armordPatientIdLBL','custom label'] as const;
+export const colorFields = ['armordPatientId', 'mlst', 'sampleType', 'armordFacility', 'armordCountry', 'custom color'] as const; //no :string[] ! removes 'const'
+export const dateFields = ['armordCultureDate', 'month', 'quarter', 'year'] as const;
+export const labelFields = ['armordMrsnIdLBL', 'mrsnIdLBL', 'armordAccessionNumberLBL', 'armordPatientIdLBL', 'custom label'] as const;
 
 export type colorKey = typeof colorFields[number];
 export type dateKey = typeof dateFields[number];
@@ -29,101 +31,81 @@ export type labelKey = typeof labelFields[number];
 
 
 
-interface ColorType {
-    color:Color, //unique hex of parameter
-    value:number //count of how many times value will be represented in the pie
-}
-type LabelType = RegexMatchedString<'(\w&)*'> // if many, seperated by '&' qhich are interpreted as newlines in front-end. var names ends with 'LBL'.
-type DateType = string | Date  // must be able to be interpreted as date type by Date js object
-
-
-interface ExtraNodeTypeFields {
-id:ObjectId,//unique identifier referenced by Graph.links and d3 Force. String but it's a string of a mongo id
-beforeAndAfter?:ColorType[] //[=[{color:'#fff',value:1}]] so it doesnt break on recalculation
-dateArr:DateType[], // array of armordCultureDates used for beforeAndAfter coloring
-hover?:String, // [=""] //unique fieldfields \/ \/ list seperated by ', ' (only tier1 alleles for now)
-mrsnIds: String[] // for selection logic between table and node=
-}
-
-type NodeType = ExtraNodeTypeFields | Record<colorKey|dateKey, ColorType[]> | Record<labelKey, LabelType[]>;
-
-interface EdgeType {
-    source:string, //node _id edge to
-    target:string, //node _id edge from
-    value:number   //distance between source and target
-}
-
-type CustomDictEntry  = Record<colorKey|dateKey,Color> | Record<labelKey,string>;
-type CustomDict = Record<ObjectId,CustomDictEntry>
 
+type CustomDictEntry = Record<colorKey | dateKey, Color> | Record<labelKey, string>;
+export type CustomDict = Record<ObjectId, CustomDictEntry>
 
 
+export interface LatestNodes { armordCultureDate: Date | string, isos: NodeType[], _id: ObjectId[] }
 export interface MSTGraph {
-nodes :NodeType[] // core parameter of d3tree.js . keeps all isolates collection data
-links :EdgeType[] // core parameter of d3tree.js
-latest :{armordCultureDate:Date, armordMrsnId:mrsnId[]} // earliest node for easy toggling
-custom :CustomDict // . I KNOW THIS IS DUMB but from user's pov it results in seamless color transitions across pages
-legend :MSTLegend // saves legend configs across all color fields
+    name?:string,
+    snapshotData?:SnapshotType
+    nodes: NodeType[] // core parameter of d3tree.js . keeps all isolates collection data
+    links: EdgeType[] // core parameter of d3tree.js
+    latest: LatestNodes // earliest node for easy toggling
+    custom: CustomDict // . I KNOW THIS IS DUMB but from user's pov it results in seamless color transitions across pages
+    legend: MSTLegend // saves legend configs across all color fields
+    missing:Record<string,any>[]  //todo: isolate.types. global 
 }interface FlashTable {
-  "_id": ObjectId,
-  "MRSN ID¹": mrsnId,
-  "Cx Date": Date|string,
-  "Cx Source": string,
-  "Wards": string,
-  "Prev Report #²": string,
-  "Accession #": armordAccessionNumber,
-  "Last Name": "...",
-  "DOD ID": "..."
+    "_id": ObjectId,
+    "MRSN ID¹": mrsnId,
+    "Cx Date": Date | string,
+    "Cx Source": string,
+    "Wards": string,
+    "Prev Report #²": string,
+    "Accession #": armordAccessionNumber,
+    "Last Name": "...",
+    "DOD ID": "..."
 }
 
 interface FlashData { //todo: add 'tier1s' here
-    dateCreated:Date,
-    first:boolean, //first node added to thec cluster
-    isolateCount:number, 
-    lastModified:Date,
-    mostRecent:{
-        _id:ObjectId[],
-        armordCultureDate:Date|string,
-        isos:Record<string,any>[], //todo
+    dateCreated: Date,
+    first: boolean, //first node added to thec cluster
+    isolateCount: number,
+    lastModified: Date,
+    mostRecent: {
+        _id: ObjectId[],
+        armordCultureDate: Date | string,
+        isos: Record<string, any>[], //todo
     }
-    mostCloselyRelated:{
-        _id:ObjectId,
-        armordCultureDate:Date|string,
-        distance:number
+    mostCloselyRelated: {
+        _id: ObjectId,
+        armordCultureDate: Date | string,
+        distance: number
     },
-    patientCount:number,
-    st:string,
-    table:FlashTable[],
-    wardCount:string,
-    wgsId:string
+    patientCount: number,
+    st: string,
+    table: FlashTable[],
+    wardCount: string,
+    wgsId: string
 }
 
 
 interface MSTResult {
-    flash:FlashData,
-    graph:MSTGraph,
-    tabular:{
-        isolate:Record<string,any>[],
-        amr:Record<string,any>[]
+    flash: FlashData,
+    graph: MSTGraph,
+    tabular: {
+        isolate: Record<string, any>[],
+        amr: Record<string, any>[]
     }
 }
 
 interface LegendBullet { //or custom upload data
-    color:Color,
-    label:string
+    color: Color,
+    label: string
 }
 
-type MSTLegend = Record<colorKey,LegendBullet[]>|Record<dateKey,'date'> | {'beforeAndAfter':[{color:'#666666', label:'Before '} ,{color:'#4a64aa', label:'After '}]}
+export type MSTLegend = Record<colorKey, LegendBullet[]> | Record<dateKey, 'date'> | { 'beforeAndAfter': [{ color: '#666666', label: 'Before ' }, { color: '#4a64aa', label: 'After ' }] }
 
 
 
-interface SnapshotType {
-    _id:ObjectId,
-   form:mstGlobalTypes,
-   legend:LegendBullet[],
-   nodes:Record<ObjectId,LegendBullet>,
-   scheme:string,
-   transforms:Record<ObjectId,{x:number,y:number}>
+export interface SnapshotType {
+    _id: ObjectId,
+    form: mstGlobalTypes,
+    legend: LegendBullet[],
+    nodes: Record<ObjectId, LegendBullet>,
+    scheme: string,
+    transforms: Record<ObjectId, { x: number, y: number }>
 }
 /** /mst route RESULT
 
@@ -132,7 +114,7 @@ interface SnapshotType {
  * @property {MSTGraph} data except it only requires links,nodes,legend, and custom
  * @property {ForceObject} form
  * @property {String|null} _id cluster _id
- * @property {function(Snapshot)} setSnapshot 
+ * @property {function(Snapshot)} setSnapshot
  * @property {function(MSTGraph)} setData trigger parent data state which affects variables in parent
  * @property {function([[import('../../typedefs/MSTree').mrsnId[],Boolean ]])} setSelected connects nodes to table rows on click
  */
@@ -143,7 +125,7 @@ interface SnapshotType {
  */
 /**string
  * @typedef ItolProps
- * @property {string} scheme 
+ * @property {string} scheme
  * @property {ObjectId[]} isolates targets centered for analysis
  * @property {int} neighbors min # of nearest samples to include (beyond targets)
  * @property {int} threshold max allelic distance from the targets to include
@@ -156,13 +138,13 @@ interface SnapshotType {
  * @property {Date} lastModified
  * @property {Date} dateModified
  *
- * 
- * 
- * 
- * 
- * 
+ *
+ *
+ *
+ *
+ *
 * @typedef {{...SplashReq,...MstFields}} MSTreeReq
      *
 */
-    // module.exports = { MSTGraph, MSTLegend, NodeType,EdgeType,Hex, ColorField,LabelField}
-    // exports.unused = {};
+// module.exports = { MSTGraph, MSTLegend, NodeType,EdgeType,Hex, ColorField,LabelField}
+// exports.unused = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gps-global-types",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "types shared between front-end and back-end",
   "main": "index.js",
   "scripts": {
@@ -14,6 +14,7 @@
     "react": "^19.1.1"
   },
   "devDependencies": {
+    "@types/d3": "^7.4.3",
     "typescript": "^5.9.2"
   }
 }

package/pie.types.tsx

@@ -1,6 +1,6 @@
-import { BaseType, Selection, SimulationNodeDatum } from "d3"
-import { ObjectId, Color, RegexMatchedString } from "./global.types"
-import { colorKey, dateKey, labelKey } from "./mst.types"
+import type { BaseType, Selection, SimulationNodeDatum } from "d3";
+import type { ObjectId, Color, RegexMatchedString } from "./global.types.tsx"
+import type  { colorKey, dateKey, labelKey } from "./mst.types.tsx"
 
 export interface ColorField {//TYPES OF GRAPH FIELDS ColorField datefields become colorFields but require additional processing  
     color: string, //  unique hex or rgb  of parameter