data-navigator 1.1.0 → 1.2.1

package/dist/data-navigator.d.ts

@@ -0,0 +1,142 @@
+// StructureOptions is still under development!
+// Our next major step is to build functions to automatically produce Structure
+type StructureOptions = {
+    [key: string | number]: any
+}
+
+type InputOptions = {
+    structure: Structure,
+    navigationRules: NavigationRules,
+    entryPoint?: NodeId,
+    exitPoint?: RenderId
+}
+
+type RenderingOptions = {
+    elementData: ElementData | Nodes,
+    suffixId: string,
+    root: RootObject,
+    defaults?: RenderObject,
+    entryButton?: EntryObject,
+    exitElement?: ExitObject
+}
+
+type Structure = {
+    nodes: Nodes,
+    edges: Edges,
+    navigationRules?: NavigationRules,
+    elementData?: ElementData
+}
+
+type Nodes = Record<NodeId, NodeObject>
+type Edges = Record<EdgeId, EdgeObject>
+type NavigationRules = Record<NavId, NavObject>
+type ElementData = Record<RenderId, RenderObject>
+
+type EdgeList = Array<EdgeId>
+type NavigationList = Array<NavId>
+
+type Semantics = ((RenderObject?,DatumObject?) => SemanticsObject) | SemanticsObject
+type Dimensions = ((RenderObject?,DatumObject?) => DimensionsObject) | DimensionsObject
+type Attributes = ((RenderObject?,DatumObject?) => AttributesObject) | AttributesObject
+
+type NodeObject = {
+    id: NodeId,
+    edges: EdgeList,
+    renderId?: RenderId,
+    [key: string | number]: any // NodeObjects can be lazily used as generic objects (like ElementObjects) too
+}
+
+type EdgeObject = {
+    source: (() => EdgeId) | EdgeId;
+    target: (() => EdgeId) | EdgeId;
+    navigationRules: NavigationList;
+}
+
+type NavObject = {
+    direction: Direction;
+    key?: string;
+}
+
+type RenderObject = {
+    cssClass?: DynamicString,
+    dimensions?: Dimensions,
+    semantics?: Semantics,
+    parentSemantics?: Semantics,
+    existingElement?: ExistingElement,
+    showText?: boolean
+}
+
+type RootObject = {
+    id: string,
+    cssClass?: string,
+    description?: string,
+    width?: string | number,
+    height?: string | number
+}
+
+type EntryObject = {
+    include: boolean,
+    callbacks?: EntryCallbacks
+}
+
+type ExitObject = {
+    include: boolean,
+    callbacks?: ExitCallbacks
+}
+
+type SemanticsObject = {
+    label?: DynamicString,
+    elementType?: DynamicString,
+    role?: DynamicString,
+    attributes?: Attributes
+}
+
+type DimensionsObject = {
+    x?: DynamicNumber,
+    y?: DynamicNumber,
+    width?: DynamicNumber,
+    height?: DynamicNumber,
+    path?: DynamicString
+}
+
+type DescriptionOptions = {
+    omitKeyNames?: boolean,
+    semanticLabel?: string
+}
+
+type ExistingElement = {
+    useForDimensions: boolean,
+    dimensions?: Dimensions
+}
+
+type EntryCallbacks = {
+    focus?: Function,
+    click?: Function
+}
+
+type ExitCallbacks = {
+    focus?: Function,
+    blur?: Function
+}
+
+type DatumObject = {
+    [key: string | number]: any
+}
+
+type AttributesObject = {
+    [key: string]: string
+}
+
+type DynamicNumber = ((RenderObject?,DatumObject?) => number) | number
+
+type DynamicString = ((RenderObject?,DatumObject?) => string) | string
+
+type NodeId = string
+
+type EdgeId = string
+
+type RenderId = string
+
+type NavId = string
+
+type Direction = "target" | "source"

package/package.json

@@ -1,21 +1,21 @@
 {
     "name": "data-navigator",
     "author": "Frank Elavsky",
-    "version": "1.1.0",
-    "main": "dist/index.jsm",
-    "module": "dist/index",
-    "types": "data-navigator.d.ts",
+    "version": "1.2.1",
+    "main": "./dist/index.jsm",
+    "module": "./dist/index",
+    "types": "./dist/data-navigator.d.ts",
     "files": [
         "dist/**/*"
     ],
     "exports": {
         ".": {
             "import": {
-                "types": "./data-navigator.d.ts",
+                "types": "./dist/data-navigator.d.ts",
                 "default": "./dist/index.js"
             },
             "require": {
-                "types": "./data-navigator.d.ts",
+                "types": "./dist/data-navigator.d.ts",
                 "default": "./dist/index.mjs"
             }
         }
@@ -29,9 +29,10 @@
     "description": "Data-navigator is a JavaScript library that allows for serial navigation of data structures using a variety of input modalities and assistive technologies.",
     "scripts": {
         "clean": "rm -rf ./dist && rm -rf ./app",
-        "build": "yarn build:app && yarn build:index && yarn build:modules",
+        "build": "yarn build:app && yarn build:index && yarn build:types && yarn build:modules",
         "build:app": "webpack",
         "build:index": "tsup src/index.ts --format cjs,esm",
+        "build:types": "cp data-navigator.d.ts ./dist/",
         "build:modules": "tsup src/structure.ts src/input.ts src/rendering.ts src/utilities.ts  src/consts.ts --format cjs,esm --minify",
         "server": "python -m http.server",
         "prettier-all-check": "prettier --config  ./.prettierrc --ignore ./.prettierignore --debug-check \"**/*.{js,jsx,ts,tsx,html,jsx,json,css,scss,md}\"",