@witchcraft/expressit 0.1.2 → 0.2.0

package/src/ast/classes/GroupNode.ts

@@ -1,127 +0,0 @@
-import type { ConditionNode } from "./ConditionNode.js"
-import type { ErrorToken } from "./ErrorToken.js"
-import type { ExpressionNode } from "./ExpressionNode.js"
-import { Node } from "./Node.js"
-import { ValidToken } from "./ValidToken.js"
-
-import { AST_TYPE, type NodeDelimiters, type TOKEN_TYPE } from "../../types/ast.js"
-
-
-/**
- * A node that symbolizes a parenthesized expression (might be negated), and if `prefixableGroups` is enabled, a prefixed expression @see ParserOptions .
- *
- * ```txt
- * (a || b)
- *  |----| ExpressionNode
- * |------| GroupNode
- *
- * !(a || b)
- * ^ prefix: "not" Token
- *   |----| ExpressionNode
- * |-------| GroupNode
- * ```
- *
- * If `prefixableGroups` is enabled:
- * ```txt
- * prefix(a || b)
- * |----| prefix: ConditionNode
- *        |----| ExpressionNode
- * |------------| GroupNode
- *
- * !prefix(a || b)
- * |-----| prefix: ConditionNode
- *         |----| ExpressionNode
- * |-------------| GroupNode
- *
- * !(a || b)
- * ^ prefix: STILL a "not" Token
- * ```
- */
-
-export class GroupNode<
-	TValid extends boolean = boolean,
-	TPrefixable extends boolean = true,
-	TPrefix extends
-		TPrefixable extends true
-			? ConditionNode<TValid> |
-			ValidToken<TOKEN_TYPE.NOT> |
-			undefined
-			: ValidToken<TOKEN_TYPE.NOT> |
-			undefined =
-		TPrefixable extends true
-			? ConditionNode<TValid> |
-			ValidToken<TOKEN_TYPE.NOT> |
-			undefined
-			: ValidToken<TOKEN_TYPE.NOT>,
->
-	extends Node<AST_TYPE.GROUP> {
-	/**
-	 * If the condition is negated this will contain a "not" **token**, @see ValidToken .
-	 *
-	 * If `prefixableGroups` is enabled and the group is prefixed by a **condition**, this will be an @see ConditionNode.
-	 *
-	 * **Careful:** `!(a)` here this would not be a **condition** since it's just a regular negation.
-	 *
-	 * See examples at @see GroupNode .
-	 */
-	readonly prefix: TPrefix
-
-	expression:
-	| ConditionNode<TValid>
-	| GroupNode<TValid>
-	| ExpressionNode<TValid>
-	| (TValid extends false ? ErrorToken<TOKEN_TYPE.VALUE> : never)
-
-	/**
-	 * The parenthesis tokens, @see ValidToken . These will always be defined (although not necessarily with valid tokens).
-	 */
-	readonly paren: NodeDelimiters<TOKEN_TYPE.PARENL, TOKEN_TYPE.PARENR>
-
-	#parent: any
-
-	#setParent: boolean = false
-
-	get parent(): ExpressionNode | undefined {
-		return this.#parent
-	}
-
-	set parent(value: ExpressionNode | undefined) {
-		if (this.#setParent) {throw new Error("parent property is readonly")}
-		this.#parent = value
-		this.#setParent = true
-	}
-
-	constructor({ prefix, expression, paren, start, end }: {
-		prefix: TPrefix
-		expression: GroupNode<TValid>["expression"]
-		paren: GroupNode<TValid>["paren"]
-		start: number
-		end: number
-	}) {
-		super(AST_TYPE.GROUP, start, end)
-		this.prefix = prefix
-		this.expression = expression
-		this.paren = paren
-		// @ts-expect-error ignore readonly
-		this.valid = (
-			(
-				this.prefix === undefined ||
-				this.prefix instanceof ValidToken ||
-				(
-					this.prefix instanceof Node &&
-					this.prefix.valid
-				)
-			) &&
-			this.expression instanceof Node &&
-			this.expression.valid &&
-			(
-				this.paren === undefined ||
-				(
-					this.paren.left instanceof ValidToken &&
-					this.paren.right instanceof ValidToken
-				)
-			)
-		) as TValid
-	}
-}
-

package/src/ast/classes/Node.ts

@@ -1,47 +0,0 @@
-import type { ArrayNode } from "./ArrayNode.js"
-import type { ConditionNode } from "./ConditionNode.js"
-import type { ExpressionNode } from "./ExpressionNode.js"
-import type { GroupNode } from "./GroupNode.js"
-
-import { BooleanParserLibraryError } from "../../helpers/errors.js"
-import type { AST_TYPE } from "../../types/ast.js"
-import { ERROR_CODES } from "../../types/errors.js"
-
-/**
- * The base AST node class all node types extend from. Can be used to check if an object is an ast node.
- * ```ts
- * if (group.prefix instanceof Node) {
- * 	//...
- * }
- * ```
- */
-export class Node<
-	TType extends AST_TYPE = AST_TYPE,
-	TValid extends boolean = boolean,
-> {
-	readonly type: TType
-
-	readonly start: number
-
-	readonly end: number
-
-	readonly valid!: TValid
-
-	get parent():
-	ConditionNode |
-	GroupNode |
-	ExpressionNode |
-	ArrayNode |
-	undefined {
-		return undefined as any
-	}
-
-	constructor(type: TType, start: number, end: number) {
-		this.type = type
-		if (start === undefined || end === undefined) {
-			throw new BooleanParserLibraryError(ERROR_CODES.PARSER_POSITION_ERROR, { start, end })
-		}
-		this.start = start
-		this.end = end
-	}
-}

package/src/ast/classes/Token.ts

@@ -1,59 +0,0 @@
-import type { ArrayNode } from "./ArrayNode.js"
-import type { ConditionNode } from "./ConditionNode.js"
-import type { ExpressionNode } from "./ExpressionNode.js"
-import type { GroupNode } from "./GroupNode.js"
-import type { VariableNode } from "./VariableNode.js"
-
-import { BooleanParserLibraryError } from "../../helpers/errors.js"
-import type { TOKEN_TYPE } from "../../types/ast.js"
-import { ERROR_CODES } from "../../types/errors.js"
-
-/**
- * The base class from which @see ValidToken and @see ErrorToken extend.
- *
- * Mostly for internal use, and I would suggest using @see AnyToken instead of this for typing things, but can be used to check whether an object is a token:
- * ```ts
- * if (group.prefix instanceof Token) {
- * 	//...
- * }
- * ```
- * Only really takes care of setting the start/end position.
- */
-export class Token<
-	TValid extends boolean = boolean,
-	TType extends
-		TValid extends true ? TOKEN_TYPE : never =
-		TValid extends true ? TOKEN_TYPE : never,
-	TValue extends
-		TValid extends true ? string : never =
-		TValid extends true ? string : never,
-	TExpected extends
-		TValid extends false ? TOKEN_TYPE[] : never =
-		TValid extends false ? TOKEN_TYPE[] : never,
-> {
-	readonly type!: TType
-
-	readonly value!: TValue
-
-	readonly expected!: TExpected
-
-	readonly start!: number
-
-	readonly end!: number
-
-	get parent(): VariableNode |
-	GroupNode |
-	ExpressionNode |
-	ArrayNode |
-	ConditionNode {
-		return undefined as any
-	}
-
-	constructor(start: number, end: number) {
-		if (start === undefined || end === undefined) {
-			throw new BooleanParserLibraryError(ERROR_CODES.PARSER_POSITION_ERROR, { start, end })
-		}
-		this.start = start
-		this.end = end
-	}
-}

package/src/ast/classes/ValidToken.ts

@@ -1,56 +0,0 @@
-import type { ArrayNode } from "./ArrayNode.js"
-import type { ConditionNode } from "./ConditionNode.js"
-import type { ExpressionNode } from "./ExpressionNode.js"
-import type { GroupNode } from "./GroupNode.js"
-import { Token } from "./Token.js"
-import type { VariableNode } from "./VariableNode.js"
-
-import type { TOKEN_TYPE } from "../../types/ast.js"
-
-
-/**
- * The class for all *valid* tokens.
- *
- * Valid tokens always have a value, even if it might be an empty string.
- */
-export class ValidToken<
-	TType extends TOKEN_TYPE = TOKEN_TYPE,
-> extends Token<true, TType, string, never> {
-	readonly type: TType
-
-	readonly value: string
-
-	#parent: any
-
-	get parent():
-	| VariableNode
-	| GroupNode
-	| ExpressionNode
-	| ConditionNode
-	| ArrayNode {
-		return this.#parent
-	}
-
-	set parent(value:
-	| VariableNode
-	| GroupNode
-	| ExpressionNode
-	| ConditionNode
-	| ArrayNode,
-	) {
-		if (this.#parent) {throw new Error("parent property is readonly")}
-		this.#parent = value
-	}
-
-	constructor({ type, value, start, end }: {
-		type: TType
-		value: string
-		start: number
-		end: number
-	},
-	) {
-		super(start, end)
-		this.type = type
-		this.value = value
-	}
-}

package/src/ast/classes/VariableNode.ts

@@ -1,67 +0,0 @@
-import type { ArrayNode } from "./ArrayNode.js"
-import type { ConditionNode } from "./ConditionNode.js"
-import type { ErrorToken } from "./ErrorToken.js"
-import { Node } from "./Node.js"
-import { ValidToken } from "./ValidToken.js"
-
-import { type AnyToken, AST_TYPE, type NodeDelimiters, type TOKEN_TYPE, type TokenQuoteTypes } from "../../types/ast.js"
-
-/**
- * A variable represents **just** a string value (NOT it's boolean value).
- *
- * The parser will never return just a variable, they are always wrapped in an @see ConditionNode to give them a boolean value.
- *
- * A variable might or might not be quoted. If it is, the `quote` property will contain the quote tokens, @see ValidToken . While they will always be of the same quote type, one might be valid while the other might not (@see ErrorToken).
- *
- * `value` will contain the string value of the variable. The text is not processed and might still contain escaped characters (even if unquoted!) that need to be removed to get the intended value. This is so that the position of the node is accurate. @see evaluate will take care of unescaping when needed.
- *
- * If `prefixableStrings` is true, the `prefix` property might contain a value token.
- */
-export class VariableNode<
-	TValid extends boolean = boolean,
-> extends Node<AST_TYPE.VARIABLE, TValid> {
-	readonly value: TValid extends boolean
-		? AnyToken<TOKEN_TYPE.VALUE>
-		: TValid extends true
-		? ValidToken<TOKEN_TYPE.VALUE>
-	: ErrorToken<TOKEN_TYPE.VALUE>
-
-	readonly prefix?: ValidToken<TOKEN_TYPE.VALUE> // todo
-
-	readonly quote?: NodeDelimiters<TokenQuoteTypes, TokenQuoteTypes>
-
-	#parent: any
-
-	#setParent: boolean = false
-
-	get parent(): ConditionNode | ArrayNode | undefined {
-		return this.#parent
-	}
-
-	set parent(value: ConditionNode | ArrayNode | undefined) {
-		if (this.#setParent) {throw new Error("parent property is readonly")}
-		this.#parent = value
-		this.#setParent = true
-	}
-
-	constructor({ prefix, value, quote, start, end }: {
-		prefix?: VariableNode<TValid>["prefix"]
-		value: VariableNode<TValid>["value"]
-		quote?: VariableNode<TValid>["quote"]
-		start: number
-		end: number
-	}) {
-		super(AST_TYPE.VARIABLE, start, end)
-		this.prefix = prefix
-		this.value = value
-		this.quote = quote
-		// @ts-expect-error ignore readonly
-		this.valid = (this.value instanceof ValidToken && (
-			this.quote === undefined ||
-			(
-				this.quote.left instanceof ValidToken &&
-				this.quote.right instanceof ValidToken
-			)
-		)) as TValid
-	}
-}

package/src/ast/classes/index.ts

@@ -1,13 +0,0 @@
-/* Autogenerated Index [Ignore] */
-
-export { ArrayNode } from "./ArrayNode.js"
-export { Condition } from "./Condition.js"
-export { ConditionNode } from "./ConditionNode.js"
-export { ErrorToken } from "./ErrorToken.js"
-export { Expression } from "./Expression.js"
-export { ExpressionNode } from "./ExpressionNode.js"
-export { GroupNode } from "./GroupNode.js"
-export { Node } from "./Node.js"
-export { Token } from "./Token.js"
-export { ValidToken } from "./ValidToken.js"
-export { VariableNode } from "./VariableNode.js"

package/src/helpers/index.ts

@@ -1,6 +0,0 @@
-export * as general from "./general/index.js"
-export * as parser from "./parser/index.js"
-
-/* Autogenerated Index [Ignore] */
-
-export { BooleanParserLibraryError } from "./errors.js"

package/src/helpers/parser/assignParents.ts

@@ -1,51 +0,0 @@
-import { ArrayNode } from "../../ast/classes/ArrayNode.js"
-import { ConditionNode } from "../../ast/classes/ConditionNode.js"
-import { ExpressionNode } from "../../ast/classes/ExpressionNode.js"
-import { GroupNode } from "../../ast/classes/GroupNode.js"
-import { Node } from "../../ast/classes/Node.js"
-import { VariableNode } from "../../ast/classes/VariableNode.js"
-import type { Nodes } from "../../types/ast.js"
-
-/** @internal */
-export function assignParents(ast: Nodes): void {
-	if (ast instanceof VariableNode) {
-		if (ast.prefix) ast.prefix.parent = ast
-		if (ast.quote?.left) ast.quote.left.parent = ast
-		if (ast.quote?.right) ast.quote.right.parent = ast
-		if (ast.quote?.flags) ast.quote.flags.parent = ast
-		ast.value.parent = ast
-	} else if (ast instanceof ConditionNode) {
-		if (ast.operator) ast.operator.parent = ast
-		if (ast.property) {
-			ast.property.parent = ast
-			if (ast.property instanceof Node) assignParents(ast.property)
-		}
-		if (ast.propertyOperator) ast.propertyOperator.parent = ast
-		if (ast.sep?.left) ast.sep.left.parent = ast
-		if (ast.sep?.right) ast.sep.right.parent = ast
-		ast.value.parent = ast
-		if (ast.value instanceof Node) assignParents(ast.value)
-	} else if (ast instanceof ExpressionNode) {
-		if (ast.operator) ast.operator.parent = ast
-		ast.right.parent = ast
-		if (ast.right instanceof Node) assignParents(ast.right)
-		ast.left.parent = ast
-		if (ast.left instanceof Node) assignParents(ast.left)
-	} else if (ast instanceof GroupNode) {
-		if (ast.prefix) {
-			ast.prefix.parent = ast
-			if (ast.prefix instanceof Node) assignParents(ast.prefix)
-		}
-		if (ast.paren?.left) ast.paren.left.parent = ast
-		if (ast.paren?.right) ast.paren.right.parent = ast
-		ast.expression.parent = ast
-		if (ast.expression instanceof Node) assignParents(ast.expression)
-	} else if (ast instanceof ArrayNode) {
-		if (ast.bracket.left) ast.bracket.left.parent = ast
-		if (ast.bracket.right) ast.bracket.right.parent = ast
-		for (const val of ast.values) {
-			val.parent = ast
-			assignParents(val)
-		}
-	}
-}

package/src/helpers/parser/index.ts

@@ -1,10 +0,0 @@
-/* Autogenerated Index [Ignore] */
-
-export { assignParents } from "./assignParents.js"
-export { checkParserOpts } from "./checkParserOpts.js"
-export { extractPosition } from "./extractPosition.js"
-export { getUnclosedRightParenCount } from "./getUnclosedRightParenCount.js"
-export { parseParserOptions } from "./parseParserOptions.js"
-export { seal } from "./seal.js"
-export { setParent } from "./setParent.js"
-export { unescape } from "./unescape.js"

package/src/helpers/parser/seal.ts

@@ -1,14 +0,0 @@
-import { assignParents } from "./assignParents.js"
-
-import { Node } from "../../ast/classes/Node.js"
-import type { AnyToken, Nodes } from "../../types/ast.js"
-
-/**
- * set and "seals" all parent properties
- *
- * @internal
- */
-export function seal(ast: Nodes | AnyToken): void {
-	if (ast instanceof Node) assignParents(ast)
-	ast.parent = undefined
-}

package/src/helpers/parser/setParent.ts

@@ -1,5 +0,0 @@
-/**
- * @internal
- * @see assignParents
- */
-export const setParent: unique symbol = Symbol("private set parent key")