@jetstreamapp/soql-parser-js/dist/types/models.d.ts

Salesforce.com SOQL parser and composer

import { CstNode, IToken } from 'chevrotain';
import { LiteralType } from './api/api-models';
export declare type LiteralTypeWithSubquery = LiteralType | Omit<LiteralType, 'SUBQUERY'>[];
export interface ArrayExpressionWithType {
    type: string;
    value: string;
}
export interface ExpressionTree<T> {
    expressionTree?: T;
    prevExpression?: T;
}
interface WithIdentifier {
    Identifier: IToken[];
}
export interface SelectStatementContext {
    selectClause: CstNode[];
    fromClause: CstNode[];
    clauseStatements: CstNode[];
}
export interface ClauseStatementsContext {
    usingScopeClause?: CstNode[];
    whereClause?: CstNode[];
    withClause?: CstNode[];
    groupByClause?: CstNode[];
    havingClause?: CstNode[];
    orderByClause?: CstNode[];
    limitClause?: CstNode[];
    offsetClause?: CstNode[];
    forViewOrReference?: CstNode[];
    updateTrackingViewstat?: CstNode[];
}
export interface SelectClauseIdentifierContext extends WithIdentifier {
    alias?: IToken[];
}
export interface SelectClauseFunctionIdentifierContext extends WithIdentifier {
}
export interface SelectClauseContext {
    field: (IToken | CstNode)[];
}
export interface SelectClauseFieldIdentifierContext extends WithIdentifier {
    fn: CstNode[];
    alias?: IToken[];
}
export interface SelectClauseFunctionIdentifierContext extends WithIdentifier {
    fn: CstNode[];
    alias?: IToken[];
}
export interface SelectClauseSubqueryIdentifierContext extends WithIdentifier {
    selectStatement: CstNode[];
}
export interface SelectClauseTypeOfContext extends WithIdentifier {
    typeOfField: IToken[];
    selectClauseTypeOfThen: CstNode[];
    selectClauseTypeOfElse?: CstNode[];
}
export interface SelectClauseIdentifierContext extends WithIdentifier {
    field: IToken[];
    alias?: IToken[];
}
export interface SelectClauseTypeOfThenContext extends WithIdentifier {
    typeOfField: IToken[];
    field: IToken[];
}
export interface SelectClauseTypeOfElseContext extends WithIdentifier {
    field: IToken[];
}
export interface usingScopeClauseContext {
    UsingScopeEnumeration: IToken[];
}
export interface WhereClauseContext {
    conditionExpression: CstNode[];
}
export interface WhereClauseSubqueryContext {
    selectStatement: CstNode[];
}
export interface ConditionExpressionContext {
    logicalOperator?: IToken[];
    expressionNegation?: CstNode[];
    expression: CstNode[];
}
export declare type WithClauseContext = WithSecurityEnforcedClauseContext | WithAccessLevelClauseContext | WithDataCategoryClauseContext;
export interface WithSecurityEnforcedClauseContext {
    withSecurityEnforced: CstNode[];
    withAccessLevel?: never;
    withDataCategory?: never;
}
export interface WithAccessLevelClauseContext {
    withSecurityEnforced?: never;
    withAccessLevel: IToken[];
    withDataCategory?: never;
}
export interface WithDataCategoryClauseContext {
    withSecurityEnforced?: never;
    withAccessLevel?: never;
    withDataCategory: CstNode[];
}
export interface WithDateCategoryContext {
    withDataCategoryArr: CstNode[];
}
export interface WithDateCategoryConditionContext {
    dataCategoryGroupName: IToken[];
    filteringSelector: IToken[];
    dataCategoryName: IToken[];
}
export interface GroupByClauseContext {
    groupBy: (CstNode | IToken)[];
    havingClause: CstNode[];
}
export interface GroupByFieldListContext {
    field: IToken[];
}
export interface HavingClauseContext {
    conditionExpression: CstNode[];
}
export interface OrderByClauseContext {
    orderByExpressionOrFn: CstNode[];
}
export interface OrderByExpressionContext extends WithIdentifier {
    field: IToken[];
    order?: IToken[];
    nulls?: IToken[];
}
export interface OrderByGroupingFunctionExpressionContext extends WithIdentifier {
    fn: IToken[];
    order?: IToken[];
    nulls?: IToken[];
}
export interface OrderBySpecialFunctionExpressionContext {
    aggregateFunction?: CstNode[];
    dateFunction?: CstNode[];
    locationFunction?: CstNode[];
    order?: IToken[];
    nulls?: IToken[];
}
export interface ValueContext {
    value: IToken[];
}
export interface OperatorContext {
    operator: IToken[];
}
export declare type OperatorOrNotInContext = OperatorWithoutNotInContext | OperatorNotInContext;
export interface OperatorWithoutNotInContext extends OperatorContext {
    notIn?: never;
}
export interface OperatorNotInContext {
    operator?: never;
    notIn: CstNode[];
}
export interface BooleanContext {
    boolean: IToken[];
}
export interface DateLiteralContext {
    dateLiteral: IToken[];
}
export interface DateNLiteralContext {
    dateNLiteral: IToken[];
    variable: IToken[];
}
export interface FieldFunctionContext {
    [value: string]: any;
    functionExpression?: CstNode[];
    fn: IToken[];
}
export interface FieldsFunctionContext {
    fn: IToken[];
    params: IToken[];
}
export interface LocationFunctionContext {
    location1: IToken[];
    location2: IToken[] | CstNode[];
    unit: IToken[];
}
export interface GeoLocationFunctionContext {
    latitude: IToken[];
    longitude: IToken[];
}
export interface ExpressionContext {
    lhs: IToken[] | CstNode[];
    operator: CstNode[];
    L_PAREN?: IToken[];
    R_PAREN?: IToken[];
}
export interface ApexBindVariableExpressionContext {
    apex: CstNode[];
    COLON: IToken[];
    DECIMAL?: IToken[];
}
export interface ApexBindVariableIdentifierContext {
    Identifier: IToken[];
    apexBindVariableFunctionArrayAccessor?: CstNode[];
}
export interface ApexBindVariableNewInstantiationContext {
    new: IToken[];
    function: IToken[];
    apexBindVariableGeneric?: CstNode[];
    apexBindVariableFunctionParams: CstNode[];
    apexBindVariableFunctionArrayAccessor?: CstNode[];
}
export interface ApexBindVariableFunctionCallContext {
    function: IToken[];
    apexBindVariableFunctionParams: CstNode[];
    apexBindVariableFunctionArrayAccessor?: CstNode[];
}
export interface ApexBindVariableGenericContext {
    COMMA: IToken[];
    GREATER_THAN: IToken[];
    LESS_THAN: IToken[];
    parameter: IToken[];
}
export interface ApexBindVariableFunctionParamsContext {
    L_PAREN: IToken[];
    R_PAREN: IToken[];
    parameter?: IToken[];
}
export interface ApexBindVariableFunctionArrayAccessorContext {
    L_SQUARE_BRACKET: IToken[];
    R_SQUARE_BRACKET: IToken[];
    value: IToken[];
}
export declare type ExpressionOperatorContext = ExpressionOperatorRhsContext & ExpressionWithRelationalOrSetOperatorContext;
export interface ExpressionOperatorRhsContext {
    rhs: CstNode[];
}
declare type ExpressionWithRelationalOrSetOperatorContext = ExpressionWithRelationalOperatorContext | ExpressionWithSetOperatorOperatorContext;
export interface ExpressionWithRelationalOperatorContext {
    relationalOperator: CstNode[];
    setOperator?: never;
}
export interface ExpressionWithSetOperatorOperatorContext {
    relationalOperator?: never;
    setOperator: CstNode[];
}
export interface FromClauseContext extends WithIdentifier {
    alias?: IToken[];
}
export interface FunctionExpressionContext {
    params?: (CstNode | IToken)[];
}
export interface AtomicExpressionContext {
    apexBindVariableExpression?: CstNode[];
    NumberIdentifier?: IToken[];
    UnsignedInteger?: IToken[];
    SignedInteger?: IToken[];
    RealNumber?: IToken[];
    CurrencyPrefixedDecimal?: IToken[];
    CurrencyPrefixedInteger?: IToken[];
    DateIdentifier?: IToken[];
    DateTime?: IToken[];
    date?: IToken[];
    NULL?: IToken[];
    StringIdentifier?: IToken[];
    Identifier?: IToken[];
    booleanValue?: CstNode[];
    DateLiteral?: IToken[];
    dateNLiteral?: CstNode[];
    arrayExpression?: CstNode[];
    whereClauseSubqueryIdentifier?: CstNode[];
    DateToken?: IToken[];
}
export interface ExpressionWithAggregateFunctionContext {
    lhs: IToken[] | CstNode[];
    rhs: CstNode[];
    relationalOperator?: CstNode[];
    setOperator?: CstNode[];
}
export {};