@travetto/model-query-language 8.0.0-alpha.8 → 8.0.0

package/README.md

@@ -41,4 +41,4 @@ user.role in ['admin', 'root'] && (user.address.state == 'VA' || user.address.ci
 ```
 
 ### Regular Expression
-When querying with regular expressions, patterns can be specified as `'strings'` or as `/patterns/`.  The latter allows for the case insensitive modifier: `/pattern/i`.  Supporting the insensitive flag is up to the underlying model implementation.
+When querying with regular expressions, patterns can be specified as `'strings'` or as `/patterns/`. The latter allows for the case insensitive modifier: `/pattern/i`. Supporting the insensitive flag is up to the underlying model implementation.

package/__index__.ts

@@ -1,3 +1,3 @@
+export * from './src/model-query.ts';
 export * from './src/parser.ts';
 export * from './src/tokenizer.ts';
-export * from './src/model-query.ts';

package/package.json

@@ -1,38 +1,41 @@
 {
   "name": "@travetto/model-query-language",
-  "version": "8.0.0-alpha.8",
-  "type": "module",
+  "version": "8.0.0",
   "description": "Datastore query language.",
   "keywords": [
     "datastore",
+    "query-language",
     "schema",
-    "typescript",
     "travetto",
-    "query-language"
+    "typescript"
   ],
   "homepage": "https://travetto.io",
   "license": "MIT",
   "author": {
-    "email": "travetto.framework@gmail.com",
-    "name": "Travetto Framework"
+    "name": "Travetto Framework",
+    "email": "travetto.framework@gmail.com"
+  },
+  "repository": {
+    "url": "git+https://github.com/travetto/travetto.git",
+    "directory": "module/model-query"
   },
   "files": [
     "__index__.ts",
     "src",
     "support"
   ],
+  "type": "module",
   "main": "__index__.ts",
-  "repository": {
-    "url": "git+https://github.com/travetto/travetto.git",
-    "directory": "module/model-query"
+  "publishConfig": {
+    "access": "public"
   },
   "dependencies": {
-    "@travetto/model": "^8.0.0-alpha.8",
-    "@travetto/model-query": "^8.0.0-alpha.8",
-    "@travetto/schema": "^8.0.0-alpha.8"
+    "@travetto/model": "^8.0.0",
+    "@travetto/model-query": "^8.0.0",
+    "@travetto/schema": "^8.0.0"
   },
   "peerDependencies": {
-    "@travetto/test": "^8.0.0-alpha.8"
+    "@travetto/test": "^8.0.0"
   },
   "peerDependenciesMeta": {
     "@travetto/test": {
@@ -41,8 +44,5 @@
   },
   "travetto": {
     "displayName": "Data Model Query Language"
-  },
-  "publishConfig": {
-    "access": "public"
   }
 }

package/src/model-query.ts

@@ -1,10 +1,11 @@
-import { Schema } from '@travetto/schema';
 import type { PageableModelQuery } from '@travetto/model-query';
 import { JSONUtil } from '@travetto/runtime';
+import { Schema } from '@travetto/schema';
 
 import { QueryLanguageParser } from './parser.ts';
 
-const parse = <T>(key: string): T | undefined => !key || typeof key !== 'string' || !/^[\{\[]/.test(key) ? undefined : JSONUtil.fromUTF8(key);
+const parse = <T>(key: string): T | undefined =>
+  !key || typeof key !== 'string' || !/^[{[]/.test(key) ? undefined : JSONUtil.fromUTF8(key);
 
 @Schema()
 export class QueryLanguageModelQuery {
@@ -13,10 +14,11 @@ export class QueryLanguageModelQuery {
       ...(self.limit ? { limit: self.limit } : {}),
       ...(self.offset ? { offset: self.offset } : {}),
       ...(self.sort ? { sort: parse(self.sort) } : {}),
-      ...(self.where ? {
-        where: parse(self.where) ??
-          QueryLanguageParser.parseToQuery(self.where)
-      } : {}),
+      ...(self.where
+        ? {
+            where: parse(self.where) ?? QueryLanguageParser.parseToQuery(self.where)
+          }
+        : {})
     };
   }
 

package/src/parser.ts

@@ -1,8 +1,8 @@
-import { castTo } from '@travetto/runtime';
 import type { WhereClauseRaw } from '@travetto/model-query';
+import { castTo } from '@travetto/runtime';
 
 import { QueryLanguageTokenizer } from './tokenizer.ts';
-import { type Token, type Literal, type GroupNode, OPERATOR_TRANSLATION, type ArrayNode, type AllNode } from './types.ts';
+import { type AllNode, type ArrayNode, type GroupNode, type Literal, OPERATOR_TRANSLATION, type Token } from './types.ts';
 
 /**
  * Determine if a token is boolean
@@ -15,7 +15,6 @@ function isBoolean(value: unknown): value is Token & { type: 'boolean' } {
  * Language parser
  */
 export class QueryLanguageParser {
-
   /**
    * Handle all clauses
    */
@@ -101,7 +100,6 @@ export class QueryLanguageParser {
    * Parse all tokens
    */
   static parse(tokens: Token[], position: number = 0): AllNode {
-
     let top: (AllNode | Token)[] = [];
     const stack: (typeof top)[] = [top];
     let list: Literal[] | undefined;
@@ -111,7 +109,7 @@ export class QueryLanguageParser {
       switch (token.type) {
         case 'grouping':
           if (token.value === 'start') {
-            stack.push(top = []);
+            stack.push((top = []));
           } else {
             const group = stack.pop()!;
             top = stack.at(-1)!;
@@ -147,7 +145,7 @@ export class QueryLanguageParser {
         default:
           top.push(token);
       }
-      token = tokens[++position];
+      token = tokens[(position += 1)];
     }
 
     this.condense(top, 'or');
@@ -184,7 +182,8 @@ export class QueryLanguageParser {
         }
         return top;
       }
-      default: throw new Error(`Unexpected node type: ${node.type}`);
+      default:
+        throw new Error(`Unexpected node type: ${node.type}`);
     }
   }
 
@@ -196,4 +195,4 @@ export class QueryLanguageParser {
     const node = this.parse(tokens);
     return this.convert(node);
   }
-}
+}

package/src/tokenizer.ts

@@ -1,13 +1,40 @@
 import { TimeUtil } from '@travetto/runtime';
+
 import type { Token, TokenizeState, TokenType } from './types.ts';
 
-const OPEN_PARENS = 0x28, CLOSE_PARENS = 0x29, OPEN_BRACKET = 0x5b, CLOSE_BRACKET = 0x5d, COMMA = 0x2c;
-const GREATER_THAN = 0x3e, LESS_THAN = 0x3c, EQUAL = 0x3d, NOT = 0x21, MODULO = 0x25, TILDE = 0x7e, AND = 0x26, OR = 0x7c;
-const SPACE = 0x20, TAB = 0x09;
-const DBL_QUOTE = 0x22, SGL_QUOTE = 0x27, FORWARD_SLASH = 0x2f, BACKSLASH = 0x5c;
-const PERIOD = 0x2e, UNDERSCORE = 0x54, DOLLAR_SIGN = 0x24, DASH = 0x2d;
-const ZERO = 0x30, NINE = 0x39, UPPER_A = 0x41, UPPER_Z = 0x5a, LOWER_A = 0x61, LOWER_Z = 0x7a;
-const LOWER_I = 0x69, LOWER_G = 0x67, LOWER_M = 0x6d, LOWER_S = 0x73;
+const OPEN_PARENS = 0x28,
+  CLOSE_PARENS = 0x29,
+  OPEN_BRACKET = 0x5b,
+  CLOSE_BRACKET = 0x5d,
+  COMMA = 0x2c;
+const GREATER_THAN = 0x3e,
+  LESS_THAN = 0x3c,
+  EQUAL = 0x3d,
+  NOT = 0x21,
+  MODULO = 0x25,
+  TILDE = 0x7e,
+  AND = 0x26,
+  OR = 0x7c;
+const SPACE = 0x20,
+  TAB = 0x09;
+const DBL_QUOTE = 0x22,
+  SGL_QUOTE = 0x27,
+  FORWARD_SLASH = 0x2f,
+  BACKSLASH = 0x5c;
+const PERIOD = 0x2e,
+  UNDERSCORE = 0x54,
+  DOLLAR_SIGN = 0x24,
+  DASH = 0x2d;
+const ZERO = 0x30,
+  NINE = 0x39,
+  UPPER_A = 0x41,
+  UPPER_Z = 0x5a,
+  LOWER_A = 0x61,
+  LOWER_Z = 0x7a;
+const LOWER_I = 0x69,
+  LOWER_G = 0x67,
+  LOWER_M = 0x6d,
+  LOWER_S = 0x73;
 
 const ESCAPE: Record<string, string> = {
   '\\n': '\n',
@@ -26,7 +53,7 @@ const TOKEN_MAPPING: Record<string, Token> = {
   or: { type: 'boolean', value: 'or' },
   '||': { type: 'boolean', value: 'or' },
   in: { type: 'operator', value: 'in' },
-  ['not-in']: { type: 'operator', value: 'not-in' },
+  'not-in': { type: 'operator', value: 'not-in' },
   not: { type: 'unary', value: 'not' },
   '[': { type: 'array', value: 'start' },
   ']': { type: 'array', value: 'end' },
@@ -34,14 +61,13 @@ const TOKEN_MAPPING: Record<string, Token> = {
   ')': { type: 'grouping', value: 'end' },
   null: { type: 'literal', value: null },
   true: { type: 'literal', value: true },
-  false: { type: 'literal', value: false },
+  false: { type: 'literal', value: false }
 };
 
 /**
  * Tokenizer for the query language
  */
 export class QueryLanguageTokenizer {
-
   /**
    * Process the next token.  Can specify expected type as needed
    */
@@ -51,8 +77,7 @@ export class QueryLanguageTokenizer {
     let value: unknown = text;
     if (!result && state.mode === 'literal') {
       if (/^["']/.test(text)) {
-        value = text.substring(1, text.length - 1)
-          .replace(/\\[.]/g, (a, b) => ESCAPE[a] || b);
+        value = text.substring(1, text.length - 1).replace(/\\[.]/g, (a, b) => ESCAPE[a] || b);
       } else if (/^\//.test(text)) {
         const start = 1;
         const end = text.lastIndexOf('/');
@@ -94,13 +119,15 @@ export class QueryLanguageTokenizer {
    * Determine if valid token identifier
    */
   static #isValidIdentToken(ch: number): boolean {
-    return (ch >= ZERO && ch <= NINE) ||
+    return (
+      (ch >= ZERO && ch <= NINE) ||
       (ch >= UPPER_A && ch <= UPPER_Z) ||
       (ch >= LOWER_A && ch <= LOWER_Z) ||
-      (ch === UNDERSCORE) ||
-      (ch === DASH) ||
-      (ch === DOLLAR_SIGN) ||
-      (ch === PERIOD);
+      ch === UNDERSCORE ||
+      ch === DASH ||
+      ch === DOLLAR_SIGN ||
+      ch === PERIOD
+    );
   }
 
   /**
@@ -142,25 +169,39 @@ export class QueryLanguageTokenizer {
       const ch = text.charCodeAt(state.position);
       switch (ch) {
         // Handle punctuation
-        case OPEN_PARENS: case CLOSE_PARENS: case OPEN_BRACKET: case CLOSE_BRACKET: case COMMA:
+        case OPEN_PARENS:
+        case CLOSE_PARENS:
+        case OPEN_BRACKET:
+        case CLOSE_BRACKET:
+        case COMMA:
           this.#flush(state);
           state.mode = 'punctuation';
           break;
         // Handle operator
-        case GREATER_THAN: case LESS_THAN: case EQUAL:
-        case MODULO: case NOT: case TILDE: case AND: case OR:
+        case GREATER_THAN:
+        case LESS_THAN:
+        case EQUAL:
+        case MODULO:
+        case NOT:
+        case TILDE:
+        case AND:
+        case OR:
           this.#flush(state, 'operator');
           break;
         // Handle whitespace
-        case SPACE: case TAB:
+        case SPACE:
+        case TAB:
           this.#flush(state, 'whitespace');
           break;
         // Handle quotes and slashes
-        case DBL_QUOTE: case SGL_QUOTE: case FORWARD_SLASH:
+        case DBL_QUOTE:
+        case SGL_QUOTE:
+        case FORWARD_SLASH:
           this.#flush(state);
           state.mode = 'literal';
           state.position = this.readString(text, state.position) + 1;
-          if (ch === FORWARD_SLASH) { // Read modifiers, not used by all, but useful in general
+          if (ch === FORWARD_SLASH) {
+            // Read modifiers, not used by all, but useful in general
             while (this.#isValidRegexFlag(text.charCodeAt(state.position))) {
               state.position += 1;
             }
@@ -182,4 +223,4 @@ export class QueryLanguageTokenizer {
 
     return state.out;
   }
-}
+}

package/src/types.ts

@@ -1,10 +1,7 @@
 /**
  * Supported token types
  */
-export type TokenType =
-  'literal' | 'identifier' | 'boolean' |
-  'operator' | 'grouping' | 'array' |
-  'whitespace' | 'punctuation' | 'unary';
+export type TokenType = 'literal' | 'identifier' | 'boolean' | 'operator' | 'grouping' | 'array' | 'whitespace' | 'punctuation' | 'unary';
 
 /**
  * Tokenization state
@@ -76,11 +73,16 @@ export type AllNode = ArrayNode | UnaryNode | GroupNode | ClauseNode;
  * Translation of operators to model query keys
  */
 export const OPERATOR_TRANSLATION: Record<string, string> = {
-  '<': '$lt', '<=': '$lte',
-  '>': '$gt', '>=': '$gte',
-  '!=': '$ne', '==': '$eq',
-  '~': '$regex', '!': '$not',
-  in: '$in', 'not-in': '$nin'
+  '<': '$lt',
+  '<=': '$lte',
+  '>': '$gt',
+  '>=': '$gte',
+  '!=': '$ne',
+  '==': '$eq',
+  '~': '$regex',
+  '!': '$not',
+  in: '$in',
+  'not-in': '$nin'
 };
 
 export const VALID_OPERATORS = new Set(Object.keys(OPERATOR_TRANSLATION));