data-navigator 1.2.1 → 1.2.3

package/README.md

@@ -40,15 +40,40 @@ npm install data-navigator
 ```
 
 ```js
-// to use it in a .js or .ts file
-import { default as dataNavigator } from 'data-navigator';
-console.log(dataNavigator);
+// to use it in a .js file
+import { default as dataNavigator } from "data-navigator"
+import rendering from "./node_modules/data-navigator/dist/rendering"
+
+// whole ecosystem
+console.log("dataNavigator", dataNavigator)
+
+// module within the ecosystem
+console.log("dataNavigator.rendering", dataNavigator.rendering)
+
+// just one module
+console.log("rendering", rendering)
+```
+
+```ts
+// to use it in a .ts file
+import { default as dataNavigator } from "./node_modules/data-navigator/dist"
+import rendering from "./node_modules/data-navigator/dist/rendering"
+
+// whole ecosystem
+console.log("dataNavigator", dataNavigator)
+
+// module within the ecosystem
+console.log("dataNavigator.rendering", dataNavigator.rendering)
+
+// just one module
+console.log("rendering", rendering)
 ```
 
 ```html
 <!-- and even as a script tag module loaded from a cdn -->
 <script type="module">
-    import dataNavigator from 'https://cdn.jsdelivr.net/npm/data-navigator@1.0.0/dist/index.mjs';
+    // pay attention to the version! the latest may be higher than this example
+    import dataNavigator from 'https://cdn.jsdelivr.net/npm/data-navigator@1.2.3/dist/index.mjs';
     console.log(dataNavigator);
 </script>
 ```

package/dist/data-navigator.d.ts

@@ -1,142 +1,112 @@
-// StructureOptions is still under development!
-// Our next major step is to build functions to automatically produce Structure
 type StructureOptions = {
-    [key: string | number]: any
-}
-
+    [key: string | number]: any;
+};
 type InputOptions = {
-    structure: Structure,
-    navigationRules: NavigationRules,
-    entryPoint?: NodeId,
-    exitPoint?: RenderId
-}
-
+    structure: Structure;
+    navigationRules: NavigationRules;
+    entryPoint?: NodeId;
+    exitPoint?: RenderId;
+};
 type RenderingOptions = {
-    elementData: ElementData | Nodes,
-    suffixId: string,
-    root: RootObject,
-    defaults?: RenderObject,
-    entryButton?: EntryObject,
-    exitElement?: ExitObject
-}
-
+    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
-
+    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?: any, DatumObject?: any) => SemanticsObject) | SemanticsObject;
+type Dimensions = ((RenderObject?: any, DatumObject?: any) => DimensionsObject) | DimensionsObject;
+type Attributes = ((RenderObject?: any, DatumObject?: any) => 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
-}
-
+    id: NodeId;
+    edges: EdgeList;
+    renderId?: RenderId;
+    [key: string | number]: any;
+};
 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
-}
-
+    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
-}
-
+    id: string;
+    cssClass?: string;
+    description?: string;
+    width?: string | number;
+    height?: string | number;
+};
 type EntryObject = {
-    include: boolean,
-    callbacks?: EntryCallbacks
-}
-
+    include: boolean;
+    callbacks?: EntryCallbacks;
+};
 type ExitObject = {
-    include: boolean,
-    callbacks?: ExitCallbacks
-}
-
+    include: boolean;
+    callbacks?: ExitCallbacks;
+};
 type SemanticsObject = {
-    label?: DynamicString,
-    elementType?: DynamicString,
-    role?: DynamicString,
-    attributes?: Attributes
-}
-
+    label?: DynamicString;
+    elementType?: DynamicString;
+    role?: DynamicString;
+    attributes?: Attributes;
+};
 type DimensionsObject = {
-    x?: DynamicNumber,
-    y?: DynamicNumber,
-    width?: DynamicNumber,
-    height?: DynamicNumber,
-    path?: DynamicString
-}
-
+    x?: DynamicNumber;
+    y?: DynamicNumber;
+    width?: DynamicNumber;
+    height?: DynamicNumber;
+    path?: DynamicString;
+};
 type DescriptionOptions = {
-    omitKeyNames?: boolean,
-    semanticLabel?: string
-}
-
+    omitKeyNames?: boolean;
+    semanticLabel?: string;
+};
 type ExistingElement = {
-    useForDimensions: boolean,
-    dimensions?: Dimensions
-}
-
+    useForDimensions: boolean;
+    dimensions?: Dimensions;
+};
 type EntryCallbacks = {
-    focus?: Function,
-    click?: Function
-}
-
+    focus?: Function;
+    click?: Function;
+};
 type ExitCallbacks = {
-    focus?: Function,
-    blur?: Function
-}
-
+    focus?: Function;
+    blur?: Function;
+};
 type DatumObject = {
-    [key: string | number]: any
-}
-
+    [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"
+    [key: string]: string;
+};
+type DynamicNumber = ((RenderObject?: any, DatumObject?: any) => number) | number;
+type DynamicString = ((RenderObject?: any, DatumObject?: any) => string) | string;
+type NodeId = string;
+type EdgeId = string;
+type RenderId = string;
+type NavId = string;
+type Direction = "target" | "source";

package/dist/examples/static-app.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/examples/vega-lite-app.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/examples/vis-demo.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/consts.d.ts

@@ -0,0 +1,4 @@
+export declare const defaultKeyBindings: DatumObject;
+export declare const GenericFullNavigationRules: NavigationRules;
+export declare const GenericLimitedNavigationRules: NavigationRules;
+export declare const NodeElementDefaults: RenderObject;

package/dist/src/index.d.ts

@@ -0,0 +1,11 @@
+declare const _default: {
+    structure: (options: StructureOptions) => {
+        nodes: {};
+        edges: {};
+        elementData: {};
+        navigationRules: NavigationRules;
+    };
+    input: (options: InputOptions) => any;
+    rendering: (options: RenderingOptions) => any;
+};
+export default _default;

package/dist/src/input.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (options: InputOptions) => any;
+export default _default;

package/dist/src/rendering.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (options: RenderingOptions) => any;
+export default _default;

package/dist/src/structure.d.ts

@@ -0,0 +1,14 @@
+declare const _default: (options: StructureOptions) => {
+    nodes: {};
+    edges: {};
+    elementData: {};
+    navigationRules: NavigationRules;
+};
+export default _default;
+export declare const buildNodeStructureFromVegaLite: (options: any) => {
+    nodes: {};
+    edges: {};
+    elementData: {};
+    navigationRules: NavigationRules;
+};
+export declare const buildNodeStructure: (options: any) => {};

package/dist/src/utilities.d.ts

@@ -0,0 +1 @@
+export declare const describeNode: (d: DatumObject, descriptionOptions?: DescriptionOptions) => string;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "data-navigator",
     "author": "Frank Elavsky",
-    "version": "1.2.1",
+    "version": "1.2.3",
     "main": "./dist/index.jsm",
     "module": "./dist/index",
     "types": "./dist/data-navigator.d.ts",
@@ -29,10 +29,9 @@
     "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:types && yarn build:modules",
+        "build": "yarn build:app && yarn build:index && 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}\"",

package/dist/chunk-JJEPMSK4.mjs

@@ -1 +0,0 @@
-var a=(t,c)=>{let s=Object.keys(t),e="";return s.forEach(o=>{e+=`${c.omitKeyNames?"":o+": "}${t[o]}. `}),e+=c.semanticLabel||"Data point.",e};export{a};