Updates

.gitignore

@@ -1,2 +1,2 @@
 node_modules/
-dist/
+.vscode

.mocharc.json

@@ -0,0 +1,17 @@
+{
+  "loader": "ts-node/esm",
+  "extensions": [
+    "ts",
+    "tsx"
+  ],
+  "spec": [
+    "src/**/*.test.*"
+  ],
+  "node-option": [
+    "experimental-specifier-resolution=node",
+    "loader=ts-node/esm"
+  ],
+  "watch-files": [
+    "src"
+  ]
+}

README.md

@@ -16,11 +16,63 @@ For development you will need to get the latest `woql.json` from the
 terminusdb repository. Assuming you have wget installed, you can run:
 
 ```
-$ npm run woql-get
+$ npm run woqlget
 ```
 
 After which you can build the new `woql.ts` file by running
 
 ```
 $ npx src/generate.ts
 ```
+
+## Usage example
+
+The WOQL below query identifies document identifiers that are not subdocuments.
+
+```javascript
+const woqlStr = `
+and(triple(doc, "rdf:type", type),
+  not(quad(type, "sys:subdocument", unbound, "schema")),
+)
+`
+const woql = parseWoqlString(woqlStr);
+const postBody = prepareWoqlHttpPostBody(woql);
+const result = await terminusClient.sendCustomRequest("POST", `http://localhost:6363/api/woql/admin/sandbox/local/branch/main`, postBody);
+```
+
+
+## Syntax options for variables
+
+The WOQL DSL parser and WOQL transformer supports new WOQL authoring styles. Variables can now be declared in multiple ways, and the DSL even support undeclared variables.
+
+* Variables get assigned through the new `(var1, var2, var3...) => { ... }`
+* Undeclared variables are supported for the DSL (similar to datalog variables)
+* Variables support the `v:` prefix to maintain backwards compatibility
+
+### Examples
+
+```javascript
+(doc, type, unbound) =>
+  and(
+    triple(doc, "rdf:type", type),
+    not(quad(type, "sys:subdocument", unbound, "schema")),
+  )
+```
+
+```javascript
+and(
+  triple(doc, "rdf:type", type),
+  not(quad(type, "sys:subdocument", unbound, "schema")),
+)
+```
+
+```javascript
+and(
+  triple("v:doc", "rdf:type", "v:type"),
+  not(quad("v:type", "sys:subdocument", "v:unbound", "schema")),
+)
+```
+
+## Unimplemented key functionality
+
+* As (for CSV Get handling to support previous functionality)

dist/generate.d.ts

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

dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './syntax.js';
+export * from './lib/index.js';
+export * as WOQL from './syntax.js';

dist/lib/AstTransformation/JsWoqlAstTransformer.d.ts

@@ -0,0 +1,14 @@
+import type { Node } from 'acorn';
+import type { Query } from '../../syntax.js';
+export declare class AstJsWoqlTransformer {
+    transform(node: Node): Query;
+    private visitNodeValue;
+    private visitNode;
+    private visitIdentifier;
+    private visitLiteral;
+    private readonly literalExceptions;
+    private currentCallExpression;
+    private visitCallExpression;
+    private readonly registeredVariableNames;
+    private visitArrowFunctionExpression;
+}

dist/lib/AstTransformation/JsWoqlAstTransformer.test.d.ts

@@ -0,0 +1,5 @@
+import type { Query } from '../../syntax.js';
+export interface MockData {
+    textWoql: string;
+    woqlAst: Query;
+}