wizard-ql 2.1.1 → 4.0.0

package/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2025 Guidance Analytics
+   Copyright 2026 Arthur Neuman
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -16,10 +16,15 @@
   𝗟<sub>anguage</sub>
 </h2>
 
-#### WizardQL is a natural-language-like query language for constructing data queries for resources that meet conditions.
+#### WizardQL is a natural-language-like query language for constructing data queries for resources that meet conditions, fitted with extensive type completion.
+
+[Demo](https://exoRift.github.io/wizard-ql)
+
+## Installation
+`npm i wizard-ql`
 
 ## Examples
-`parse('(rank >= 10 & role = admin) | banned')`
+`WizardParser.parse('(rank >= 10 & role = admin) | banned')`
 
 > ```js
 > {
@@ -35,27 +40,27 @@
 >           field: "rank",
 >           operation: "GEQ",
 >           value: 10,
->           validated: false,
+>           validated: false
 >         }, {
 >           type: "condition",
 >           field: "role",
 >           operation: "EQUAL",
 >           value: "admin",
->           validated: false,
+>           validated: false
 >         }
->       ],
+>       ]
 >     }, {
 >       type: "condition",
 >       field: "banned",
 >       operation: "EQUAL",
 >       value: true,
->       validated: false,
+>       validated: false
 >     }
->   ],
+>   ]
 > }
 > ```
 
-`parse('flagged OR (name MATCHES "decorative_.*" AND !(price >= 20 AND price <= 30))')`
+`WizardParser.parse('flagged OR (name MATCHES "decorative_.*" AND !(price >= 20 AND price <= 30))')`
 
 > ```js
 > {
@@ -67,7 +72,7 @@
 >       field: "flagged",
 >       operation: "EQUAL",
 >       value: true,
->       validated: false,
+>       validated: false
 >     }, {
 >       type: "group",
 >       operation: "AND",
@@ -77,7 +82,7 @@
 >           field: "name",
 >           operation: "MATCH",
 >           value: "decorative_.*",
->           validated: false,
+>           validated: false
 >         }, {
 >           type: "group",
 >           operation: "OR",
@@ -87,19 +92,19 @@
 >               field: "price",
 >               operation: "LESS",
 >               value: 20,
->               validated: false,
+>               validated: false
 >             }, {
 >               type: "condition",
 >               field: "price",
 >               operation: "GREATER",
 >               value: 30,
->               validated: false,
+>               validated: false
 >             }
->           ],
+>           ]
 >         }
->       ],
+>       ]
 >     }
->   ],
+>   ]
 > }
 > ```
 
@@ -128,10 +133,13 @@ Simply denoting a field name (`field`) transforms it into `field = true`
 
 (`!field`) transforms it into `field = false`
 
+> [!NOTE]
+> This is true for the default operator set. If custom operators are defined, a custom [implicit condition](#implicit-condition) can be defined as well.
+
 ### Group
 *A group is multiple conditions joined by a junction operator such as AND or OR.*
 `({CONDITION} [...{J_OPERATOR} {CONDITION}])`
-Groups are implicit when junction operators are used (follows PEMDAS [ANDs grouped before ORs]). Parentheses can be used to denote them explicitly.
+Groups are implicit when junction operators are used (follows PEMDAS \[ANDs grouped before ORs\]). Parentheses can be used to denote them explicitly.
 
 Groups can be nested.
 > Example: `user.activated & ((user.role = member & user.group : [abc, xyz]) | (user.role = admin & user.privileged))`
@@ -139,7 +147,7 @@ Groups can be nested.
 Groups can also be negated
 > `!(firstname = John & lastname = Doe)` &rarr; `firstname != John | lastname != Doe`
 
-## Operators
+## Default Operators
 ### Junction Operators
 <details>
 <summary>AND</summary>
@@ -159,7 +167,7 @@ Groups can also be negated
 - `V`
 </details>
 
-### Comparison Operators
+### Condition Operators
 <details>
 <summary>EQUAL</summary>
 
@@ -243,10 +251,61 @@ Groups can also be negated
 - `!~`
 </details>
 
+## Custom Operators
+If the default operators don't fulfill your needs, a custom operator set can be defined.
+
+```js
+new WizardParser({
+  operators: {
+    [OPERATOR_NAME]: {
+      negationName: NEGATION_OPERATOR_NAME,
+      aliases: ['ALIAS'],
+      type: 'numeric',
+      negationAliases: ['NEGALIAS']
+    },
+    ...
+  }
+})
+```
+
+An operator is inherently two operators: the base operator and its negation. When defining an operator, you must also define its `negationName`. You can also define aliases for operators and their negations.
+
+Lastly, you must supply the data type the operator functions on. This type also determines the operator type (condition/junction \[a junction joins conditions together into a group\]).
+- For **condition operators**, `type` can be `'primitive'`, `'boolean'`, `'string'`, `'number'`, `'date'`, `'numeric'`, or `'array'`. `primitive` allows all data types (singular). `array` allows all data types within an array. `numeric` allows `number` or `date`; however, `number` will be used unless the condition's field is only of type `date`.
+- For **junction operators**, `type` can be `sumjunction` or `productjunction`. They're both group operators, but have different precedence for logical PEMDAS. For example, `A & B | C` becomes `(A & B) | C`. In logic, "and" is a product junction, and "or" is a sum junction. The negation of a sum junction is a product junction and vice-versa.
+
+When defining custom operators, their names should be all uppercase. Two operators should not share names or aliases. This applies to the keys of the operator record, `negationName`, `aliases`, and `negationAliases`.
+
+For condition operators, if, for whatever reason, you want to define the negation operators first, you can supply `exclusionary: true` which marks the operator you defined in the record as the negatory one.
+
+## Implicit Condition
+You may have noted the existed of [implicit boolean](#implicit-boolean) for the default operator set. Once you start defining custom operators, there is no longer a default implicit condition. One can optionally be defined.
+
+```js
+new WizardParser({
+  operators: {
+    [OPERATOR_NAME]: {
+      negationName: NEGATION_OPERATOR_NAME,
+      aliases: ['ALIAS'],
+      type: 'numeric',
+      negationAliases: ['NEGALIAS']
+    },
+    ...
+  },
+  implicitCondition: {
+    operator: OPERATOR_NAME, // The operator to use
+    value: '0', // The value, as a string
+    asType: 'number' // What datatype should the value be read as
+  }
+})
+```
+
+The implicit condition is applied when a field name is denoted without any operator. Example: (`field = value | otherfield`). In this case, `otherfield` would be parsed as `otherfield OPERATOR_NAME 0`. If a negator precedes the field (`!otherfield`), it uses the negated variant of the implicit operator.
+
 ## Constraints
-The `parse` function can be passed an object containing various constraints as its second parameter
+When constructing a WizardParser instance (`new WizardParser()`), the constructor can be passed properties containing various constraints.
 
-### `restricted`
+### Restricted Fields (`restricted`)
 A record mapping field names to restrictions. A value of `true` totally prohibits the usage of a field.
 
 Otherwise, a tuple can be passed
@@ -257,38 +316,38 @@ Values can be direct values (string, number, boolean) or regex expressions
 "allow" will allow the values/patterns and deny all others
 "deny" will deny the values/patterns and allow all others
 
-### `types`
+### Field Types (`types`)
 A record mapping field names to (`boolean`, `string`, `number`, `date`). The value in the record can either be a single allowed type or an array of allowed types. Only operators that can function on that type can be used for that field. By default, fields will be treated as being able to be any of the three types.
 
 > Example:
 > ```js
-> parse('field1 = value', {
+> new WizardParser({
 >   types: {
 >     field1: 'string',
 >     field2: ['string', 'number']
 >   }
-> })
+> }).parse('field1 = value')
 > ```
 
 > [!NOTE]
-> A value will only be attempted to be parsed as a date if `'date'` is included in the field's type record.
-> If the value is a number, it will be parsed as number of milliseconds. Any non-number character will cause the value to be parsed as a string
+> A value will only be attempted to be parsed as a date if `'date'` is included in the field's type record or if the operator is exclusively a date operator.
+> According to the default date parser, if the value is a number, it will be parsed as number of milliseconds. Any non-number character will cause the value to be parsed as a string (See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Date)
 
 The type coercion priority chain is as follows:
 `boolean` -> `date` -> `number` -> `string`
 > [!WARNING]
-> This can cause issues for numbers with leading zeros. If this is a potential problem, make sure to exclude `number` from the types and include `string`
+> This can cause issues for numbers with leading zeros. If this is a potential problem, make sure to exclude `number` from the field types and include `string`
 
 ### Regarding constraints: `validated` property
 When a field has matched either a key in `types` or a field in `restricted`, the `validated` property on the parsed condition will be true. This is due to a limitation with TypeScript's type checking.
 
 Therefore, type inference would look something like this:
 ```js
-const parsed = parse('field = value', {
+const parsed = new WizardParser({
   types: {
     field: ['string', 'number']
   }
-})
+}).parse('field = value')
 
 if (parsed.validated) {
   switch (parsed.type) {
@@ -304,6 +363,9 @@ if (parsed.validated) {
 }
 ```
 
+### `disallowUnvalidated`
+Fields that are not present in the type or restriction record will considered invalid fields. This will make resulting parsed expression types far more usable without having to check if `validated === true`
+
 ### `caseInsensitive`
 Type/constraint checks will be case-insensitive on the field name
 > [!NOTE]
@@ -312,41 +374,78 @@ Type/constraint checks will be case-insensitive on the field name
 > [!WARNING]
 > Mismatching casing between the restricted record and the type record will prioritize the restricted record
 
-### `disallowUnvalidated`
-Fields that are not present in the type or restriction record will considered invalid fields
-
 ### `dateInterpreter`
 A callback that determines how WizardQL interprets dates. Wizard will attempt to parse a value as a date if `'date'` is supplied in its type record
 
 By default, this is simply `(v) => new Date(v)`
 
 ## Stringification
-Parsed expressions can be converted back into strings using the `stringify` function. The stringify function comes with its own slew of options as its second parameter
+Parsed expressions can be converted back into strings using the `stringify` method. The stringify method comes with its own options as its second parameter (or it can just be a string, selecting the dialect)
+
+```js
+const parser = new WizardParser()
 
-### `junctionNotation`
-The notation to use for junction operators
+const parsed = parser.parse('...')
+if (parsed) console.log(parser.stringify(parsed, DIALECT))
+```
+
+### `dialect`
+The dialect determines how operators are stringified.
+
+Custom dialects can be supplied in the WizardParser constructor. If using the default operators, the default dialects are:
 - Programmatic: `&`
 - Linguistic: `AND`
 - Formal: `^`
 
-### `comparisonNotation`
-The notation to use for comparison operators
-- Programmatic: `=`
-- Linguistic: `EQUALS`
-
 ### `alwaysParenthesize`
 Always put parentheses around every group
 
 ### `compact`
-Don't include spaces in the output (except for surrounding lingustic operators)
+Don't include spaces in the output. Operators that contain alpha characters will always be surrounded with spaces.
+
+### `condenseImplicit`
+Conditions that are an instance of the [implicit condition](#implicit-condition) or its negation will be condensed into the implicit notation (`field`, `!field`).
+
+For example, if the default condition is `some_field LESS 0` (assuming the LESS operator is defined), `field < 0` becomes `field` and `field >= 0` becomes `!field`. There is a special exception for booleans (also utilized for the default operator [implicit boolean](#implicit-boolean)) where `field = false`, which is technically not a negation of the implicit condition (`field != true`), is still condensed to `!field`
 
-### `condenseBoolean`
-`EQUAL`/`NOTEQUAL` regarding booleans will be condensed into [implicit form](#implicit-boolean)
+### Date Serialization
+A custom callback can be supplied to the parser constructor for how dates should be stringified. The default simply calls `Date.toISOString()`
+
+```js
+new WizardParser({
+  dateSerializer: (d) => d.getTime().toString() // Serialize to time in milliseconds instead
+})
+```
+
+### Custom Dialects
+> See the default dialects [here](#dialect)
+
+Whether using the default operator set or custom operators (must define custom dialects for custom operators if you're looking to stringify), custom dialects can be defined. This determines how `WizardParser.stringify()` prints operator names to the resulting string.
+
+```js
+new WizardParser({
+  operators: {
+    [OPERATOR_NAME]: {
+      negationName: NEGATION_OPERATOR_NAME,
+      aliases: ['ALIAS'],
+      type: 'numeric',
+      negationAliases: ['NEGALIAS']
+    },
+    ...
+  },
+  dialects: {
+    [DIALECT_NAME]: {
+      [OPERATOR_NAME]: 'operator_denotation',
+      ...
+    }
+  }
+})
+```
 
 ## Summarize
-You can use the `summarize` function to summarize a parsed expression, aggregated by field name across groups
+You can use the `summarize` method to summarize a parsed expression, aggregated by field name across groups. This is useful for authorization checks
 
-`summarize(parse('(foo in [1, 2] and (bar = 2 or baz)) V (bar !: [1, 3] and foo = 3)'))`
+`WizardParser.summarize(parse('(foo in [1, 2] and (bar = 2 or baz)) V (bar !: [1, 3] and foo = 3)'))`
 > ```js
 > [
 >     ['foo', [
@@ -384,15 +483,15 @@ You can use the `summarize` function to summarize a parsed expression, aggregate
 > ```
 
 > [!NOTE]
-> `exclusionary` implies a negative operation (once that excludes the value)
+> `exclusionary` implies a negatory operation (one that excludes the value)
 
 ## Execution Example
-Below is an example of how a Wizard query would be executed in the context of a [KnexJS Query](https://knexjs.org/)
+Below is an example of how a Wizard query would be safely executed in the context of a [KnexJS Query](https://knexjs.org)
 
-https://github.com/guidance-analytics/wizard-ql/blob/bf8693e2cb5678ef855600d70bc495a614aa3d0b/src/execute.ts#L1-L35
+https://github.com/exoRift/wizard-ql/blob/424c92e8fc205cf22a639887ebbafd822a7c8731/src/execute.ts#L1-L36
 
 ## DOM Input
-Wizard comes pre-packaged with a DOM input that applies classes for tokens, making for query input with syntax highlighting (up to discretion)
+Wizard comes pre-packaged with a DOM input that applies classes for tokens, making for a query input with syntax highlighting (up to discretion)
 
 ```js
 // NOTE: The input element should be a regular div element, not an input element
@@ -408,14 +507,16 @@ Depending on a token's type, attributes will be applied to the contents of the i
 - `data-node` - An actual token
   - `data-quoted` - Quoted text
   - `data-number` - A number
-  - `data-bracket` - A parenthesis or array bracket
-  - `data-delimiter` - A comma
-  - `data-negation` - A negatory exclamation mark
-  - `data-operation` - A comparison or junction operator
+  - `data-bracket` - A parenthesis or array bracket (value is the bracket)
+  - `data-delimiter` - An array delimiter (comma)
+  - `data-negator` - A negation operator (exclamation mark)
+  - `data-operator` - A condition or junction operator (value will be 'junction' or 'condition')
 
 A token can also possess `data-error` if it is part of an error span
 
 The input itself can have the following attributes:
 - `data-error-message` - The error message
 - `data-error-start` - The starting token index for the error
-- `data-error-end` - The end token index for the error
+- `data-error-end` - The end token index for the error
+
+An example for styling this input can be found [here](./test/preview/index.css)

package/dist/dominput.d.ts

@@ -1,10 +1,10 @@
-import { type Token, type TypeRecord } from './spec';
-import { type ExpressionConstraints, parse } from './parse';
+import { WizardParser, type WizardParserConfig } from './parser';
 import { ConstraintError, ParseError } from './errors';
-interface DOMInputOptions<T extends TypeRecord, V extends boolean> {
+import type { ClassifiedToken, FieldTypeRecord, OperatorRecord } from './spec';
+interface DOMInputOptions<F extends FieldTypeRecord, O extends OperatorRecord, V extends boolean, D extends string> {
     input: HTMLElement;
-    constraints?: ExpressionConstraints<T, V>;
-    onUpdate?: (expression: ReturnType<typeof parse<T, V>> | ParseError | ConstraintError, tokens: Token[], string: string) => void;
+    config?: WizardParserConfig<F, O, V, D>;
+    onUpdate?: (expression: ReturnType<WizardParser<F, O, V, D>['parse']> | ParseError | ConstraintError, tokens: ClassifiedToken[], string: string) => void;
     parseOnInitialize?: boolean;
 }
 /**
@@ -12,5 +12,5 @@ interface DOMInputOptions<T extends TypeRecord, V extends boolean> {
  * @warn This is a DOM function that is not meant for the backend
  * @returns A destroy function (destroys listening and functionality, not the element)
  */
-export declare function createDOMInput<const T extends TypeRecord, const V extends boolean>({ input, constraints, onUpdate, parseOnInitialize }: DOMInputOptions<T, V>): () => void;
+export declare function createDOMInput<const F extends FieldTypeRecord, const O extends OperatorRecord, const V extends boolean, const D extends string>({ input, config, onUpdate, parseOnInitialize }: DOMInputOptions<F, O, V, D>): () => void;
 export {};

package/dist/errors.d.ts

@@ -15,7 +15,7 @@ export declare class ParseError extends Error {
     /** The end token index */
     readonly endIndex: number | undefined;
     /** The tokens being parsed */
-    readonly tokens: Token[] | undefined;
+    readonly tokens: readonly Token[] | undefined;
     /**
      * Construct a Parsing Error
      * @param message    The error message
@@ -25,7 +25,7 @@ export declare class ParseError extends Error {
      * @param endToken   The last token this error pertains to
      * @param endIndex   The end token index
      */
-    constructor(message: string, tokens: Token[] | undefined, startToken: Token | undefined, startIndex: number | undefined, endToken?: Token | undefined, endIndex?: number | undefined);
+    constructor(message: string, tokens: readonly Token[] | undefined, startToken: Token | undefined, startIndex: number | undefined, endToken?: Token | undefined, endIndex?: number | undefined);
 }
 /**
  * A WizardQL string expression parsing constraint error
@@ -43,7 +43,7 @@ export declare class ConstraintError extends Error {
     /** The end token index */
     readonly endIndex: number | undefined;
     /** The tokens being parsed */
-    readonly tokens: Token[] | undefined;
+    readonly tokens: readonly Token[] | undefined;
     /**
      * Construct a Constraint Error
      * @param message    The error message
@@ -53,5 +53,5 @@ export declare class ConstraintError extends Error {
      * @param endToken   The last token this error pertains to
      * @param endIndex   The end token index
      */
-    constructor(message: string, tokens: Token[] | undefined, startToken: Token | undefined, startIndex: number | undefined, endToken?: Token | undefined, endIndex?: number | undefined);
+    constructor(message: string, tokens: readonly Token[] | undefined, startToken: Token | undefined, startIndex: number | undefined, endToken?: Token | undefined, endIndex?: number | undefined);
 }

package/dist/index.d.ts

@@ -1,7 +1,4 @@
-export { type Operation, type ComparisonOperation, type JunctionOperation, type Expression, type UncheckedExpression, type Condition, type UncheckedCondition, type Group, type Primitive, type TypeRecord, type Token, type ComparisonTypeToTSType, OPERATION_PURPOSE_DICTIONARY, COMPARISON_TYPE_DICTIONARY, OPERATION_ALIAS_DICTIONARY } from './spec';
-export { type ExpressionConstraints, QUOTE_EDGE_REGEX, parse, tokenize } from './parse';
-export { executeAsKnex } from './execute';
-export { type AggregationValue, summarize } from './summarize';
-export { type StringifyOptions, stringify } from './stringify';
+export * from './spec';
+export * from './parser';
 export { ParseError, ConstraintError } from './errors';
 export { createDOMInput } from './dominput';