making API for javascripty

.eslintrc.json

@@ -32,6 +32,7 @@
     "functional/immutable-data": "off",
     "functional/prefer-immutable-types": "off",
     "functional/no-throw-statements": "off",
+    "functional/no-mixed-types": "off",
     "functional/functional-parameters": "off",
     "functional/prefer-type-literal": "off",
     "no-constant-condition": "off",

docs/docs/api.constant.mdx

@@ -1,11 +1,7 @@
-import FLOAT, {toc as FloatToc} from '../generated/variables/lib_constant.FLOAT.mdx'
-import INTEGER, {toc as IntegerToc} from '../generated/variables/lib_constant.INTEGER.mdx'
-import NULL, {toc as NullToc} from '../generated/variables/lib_constant.NULL.mdx'
-import STRING, {toc as StringToc} from '../generated/variables/lib_constant.STRING.mdx'
-import SYMBOL, {toc as SymbolToc} from '../generated/variables/lib_constant.SYMBOL.mdx'
-import Quote, {toc as QuoteToc} from '../generated/functions/lib_constant.quote.mdx'
-import Evaluate, {toc as EvaluateToc} from '../generated/functions/lib_constant.evaluate.mdx'
-import Type, {toc as TypeToc} from '../generated/functions/lib_constant.type-1.mdx'
+import ConstantTypeEnum, {toc as ConstantTypeEnumToc} from '../generated/enums/lib_constant.ConstantType.mdx'
+import QuoteConstant, {toc as QuoteConstantToc} from '../generated/functions/lib_constant.quoteConstant.mdx'
+import EvaluateConstant, {toc as EvaluateConstantToc} from '../generated/functions/lib_constant.evaluateConstant.mdx'
+import ConstantType, {toc as ConstantTypeToc} from '../generated/functions/lib_constant.constantType-1.mdx'
 
 # constant
 
@@ -19,28 +15,17 @@ value, is used when an attribute is missing its target, but aside from
 robustness measures it is not a supported datatype.
 
 
-
-
-<Quote />
+<QuoteConstant />
 ___
-<Evaluate />
+<EvaluateConstant />
 ___
-<Type />
+<ConstantType />
 ___
-
-<FLOAT />
-<INTEGER />
-<NULL />
-<STRING />
-<SYMBOL />
+<ConstantTypeEnum />
 
 export const toc = [
-  ...QuoteToc,
-  ...EvaluateToc,
-  ...TypeToc,
-  ...FloatToc,
-  ...IntegerToc,
-  ...NullToc,
-  ...StringToc,
-  ...SymbolToc,
+  ...QuoteConstantToc,
+  ...EvaluateConstantToc,
+  ...ConstantTypeToc,
+  ...ConstantTypeEnumToc,
 ]

docs/docs/api.graph.mdx

@@ -1,8 +1,8 @@
 import Graph, { toc as GraphToc } from '../generated/classes/lib_graph.Graph.mdx';
-import Triple, { toc as TripleToc } from '../generated/types/lib_graph.Triple.mdx';
-import Instance, { toc as InstanceToc } from '../generated/types/lib_graph.Instance.mdx';
-import Edge, { toc as EdgeToc } from '../generated/types/lib_graph.Edge.mdx';
-import Attribute, { toc as AttributeToc } from '../generated/types/lib_graph.Attribute.mdx';
+import Triple, { toc as TripleToc } from '../generated/types/lib_types.Triple.mdx';
+import Instance, { toc as InstanceToc } from '../generated/types/lib_types.Instance.mdx';
+import Edge, { toc as EdgeToc } from '../generated/types/lib_types.Edge.mdx';
+import Attribute, { toc as AttributeToc } from '../generated/types/lib_types.Attribute.mdx';
 
 
 # graph

package.json

@@ -15,14 +15,6 @@
     ".": {
       "import": "./build/module/index.js",
       "require": "./build/main/index.js"
-    },
-    "./*": {
-      "import": "./build/module/*.js",
-      "require": "./build/main/*.js"
-    },
-    "./models/*": {
-      "import": "./build/module/lib/models/*.js",
-      "require": "./build/main/lib/models/*.js"
     }
   },
   "scripts": {

src/index.ts

@@ -1,8 +1,31 @@
-export { parse, iterparse, parseTriples } from './lib/_parse';
-export { format, formatTriples } from './lib/_format';
-export { interpret, configure } from './lib/layout';
-export { Tree } from './lib/tree';
-export { Graph, Triple } from './lib/graph';
+export { parse, iterparse, parseTriples } from './lib/parse';
+export { format, formatTriples } from './lib/format';
+export {
+  LayoutMarker,
+  Push,
+  Pop,
+  POP,
+  interpret,
+  rearrange,
+  configure,
+  reconfigure,
+  getPushedVariable,
+  appearsInverted,
+  nodeContexts,
+} from './lib/layout';
+export { Tree, isAtomic } from './lib/tree';
+export { Graph } from './lib/graph';
+export {
+  Triple,
+  Instance,
+  Edge,
+  Attribute,
+  Branch,
+  Node,
+  Constant,
+  Variable,
+  Role,
+} from './lib/types';
 export {
   PENMANCodec,
   decode,
@@ -13,4 +36,36 @@ export {
   load,
   loads,
 } from './lib/codec';
-export { DecodeError, PenmanError } from './lib/exceptions';
+export {
+  canonicalizeRoles,
+  reifyEdges,
+  dereifyEdges,
+  reifyAttributes,
+  indicateBranches,
+} from './lib/transform';
+export {
+  AlignmentMarker,
+  Alignment,
+  RoleAlignment,
+  alignments,
+  roleAlignments,
+} from './lib/surface';
+export { Model } from './lib/model';
+export { amrModel } from './lib/models/amr';
+export { noopModel } from './lib/models/noop';
+export {
+  PenmanError,
+  ConstantError,
+  GraphError,
+  LayoutError,
+  DecodeError,
+  SurfaceError,
+  ModelError,
+} from './lib/exceptions';
+export { Epidatum } from './lib/epigraph';
+export {
+  ConstantType,
+  constantType,
+  evaluateConstant,
+  quoteConstant,
+} from './lib/constant';

src/lib/_lexer.ts

@@ -120,6 +120,9 @@ export class TokenIterator {
       this._next = null;
     }
     this._last = current;
+    if (current == null) {
+      throw new Error('Unexpected end of input');
+    }
     return current;
   }
 
@@ -155,7 +158,7 @@ export class TokenIterator {
   }
 
   error(message: string, token?: Token): DecodeError {
-    let line: string | null = null;
+    let line: string | undefined;
     let lineno: number;
     let offset: number;
     if (token == null) {
@@ -226,7 +229,7 @@ const _lex = function* (
             `capturing group:\n${regex.source}`,
         );
       }
-      const token: Token = [typ, val, i, m.index, line];
+      const token: Token = [typ, val, i, m.index ?? 0, line];
       debug(`${token}`);
       yield token;
     }

src/lib/codec.spec.ts

@@ -166,7 +166,7 @@ test('decode_alignments', (t) => {
   const expectedRoleAlignments = new ArrayKeysMap();
   expectedRoleAlignments.set(
     ['a', ':ARG', 'b'],
-    new surface.RoleAlignment([1, 2], 'e.'),
+    new surface.RoleAlignment([1, 2], { prefix: 'e.' }),
   );
   t.deepEqual(surface.roleAlignments(g2), expectedRoleAlignments);
 
@@ -239,7 +239,7 @@ test('encode', (t) => {
   t.is(codec.encode(g), '()');
 
   // unlabeled single node
-  g = new Graph([], 'a');
+  g = new Graph([], { top: 'a' });
   t.is(codec.encode(g), '(a)');
 
   // labeled node
@@ -255,19 +255,19 @@ test('encode', (t) => {
   t.is(codec.encode(g), '(a : b)');
   const epidata = new EpidataMap();
   epidata.set(['a', ':', 'b'], [new layout.Push('b')]);
-  g = new Graph([['a', ':', 'b']], undefined, epidata);
+  g = new Graph([['a', ':', 'b']], { epidata });
   t.is(codec.encode(g), '(a : (b))');
 
   // inverted unlabeled edge
-  g = new Graph([['a', '', 'b']], 'b');
+  g = new Graph([['a', '', 'b']], { top: 'b' });
   t.is(codec.encode(g), '(b :-of a)');
 
   // labeled edge to unlabeled node
   g = new Graph([['a', 'ARG', 'b']]);
   t.is(codec.encode(g), '(a :ARG b)');
 
   // inverted edge
-  g = new Graph([['a', 'ARG', 'b']], 'b');
+  g = new Graph([['a', 'ARG', 'b']], { top: 'b' });
   t.is(codec.encode(g), '(b :ARG-of a)');
 });
 
@@ -304,9 +304,9 @@ test('encode issue 61', (t) => {
       ['i', ':instance', 'i'],
       ['i2', ':ARG0', 'i'],
     ],
-    'i2',
+    { top: 'i2' },
   );
-  t.is(codec.encode(g, undefined, null), '(i2 / i :ARG0 (i / i))');
+  t.is(codec.encode(g, { indent: null }), '(i2 / i :ARG0 (i / i))');
 });
 
 test('encode issue 67', (t) => {
@@ -318,13 +318,13 @@ test('encode issue 67', (t) => {
     ['h', ':ARG2', 'a'],
   ];
   t.is(
-    codec.encode(new Graph(triples, 'a')),
+    codec.encode(new Graph(triples, { top: 'a' })),
     `(a / activist
    :ARG0-of (h / have-org-role-91)
    :ARG2-of h)`,
   );
   t.is(
-    codec.encode(new Graph(triples, 'h')),
+    codec.encode(new Graph(triples, { top: 'h' })),
     `(h / have-org-role-91
    :ARG0 (a / activist)
    :ARG2 a)`,