gremlin 3.8.0 → 4.0.0-beta.2

package/build/esm/language/translator/GoTranslateVisitor.d.ts

@@ -0,0 +1,31 @@
+import TranslateVisitor from './TranslateVisitor.js';
+/**
+ * Converts a Gremlin traversal string into a Go source code representation.
+ * Assumes use of the gremlingo, math, time, and uuid packages.
+ */
+export default class GoTranslateVisitor extends TranslateVisitor {
+    constructor(graphTraversalSourceName?: string);
+    protected processGremlinSymbol(step: string): string;
+    protected getCardinalityFunctionClass(): string;
+    protected appendExplicitNaming(txt: string, prefix: string): void;
+    protected appendAnonymousSpawn(): void;
+    protected visitP(ctx: any, pClass: string, methodName: string): void;
+    visitTraversalGType(ctx: any): void;
+    visitNanLiteral(_ctx: any): void;
+    visitInfLiteral(ctx: any): void;
+    visitNullLiteral(_ctx: any): void;
+    visitStringNullableLiteral(ctx: any): void;
+    visitIntegerLiteral(ctx: any): void;
+    visitFloatLiteral(ctx: any): void;
+    visitDateLiteral(ctx: any): void;
+    visitGenericRangeLiteral(_ctx: any): void;
+    visitGenericSetLiteral(ctx: any): void;
+    visitGenericCollectionLiteral(ctx: any): void;
+    visitGenericMapLiteral(ctx: any): void;
+    visitMapEntry(ctx: any): void;
+    visitMapKey(ctx: any): void;
+    visitUuidLiteral(ctx: any): void;
+    visitTraversalStrategy(ctx: any): void;
+    visitConfiguration(ctx: any): void;
+    visitTraversalSourceSelfMethod_withoutStrategies(ctx: any): void;
+}

package/build/esm/language/translator/GoTranslateVisitor.js

@@ -0,0 +1,333 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+// Context parameters are typed as `any` because the generated grammar files
+// require accepting arbitrary context types at runtime.
+import TranslateVisitor from './TranslateVisitor.js';
+import { TranslatorException } from './TranslatorException.js';
+const GO_PACKAGE_NAME = 'gremlingo.';
+const STRATEGY_WITH_MAP_OPTS = new Set([
+    'OptionsStrategy',
+    'ReferenceElementStrategy', 'ComputerFinalizationStrategy', 'ProfileStrategy',
+    'ComputerVerificationStrategy', 'StandardVerificationStrategy', 'VertexProgramRestrictionStrategy',
+    'MessagePassingReductionStrategy',
+]);
+const STRATEGY_WITH_STRING_SLICE = new Set([
+    'ReservedKeysVerificationStrategy', 'ProductiveByStrategy',
+]);
+/**
+ * Converts a Gremlin traversal string into a Go source code representation.
+ * Assumes use of the gremlingo, math, time, and uuid packages.
+ */
+export default class GoTranslateVisitor extends TranslateVisitor {
+    constructor(graphTraversalSourceName = 'g') {
+        super(graphTraversalSourceName);
+    }
+    processGremlinSymbol(step) {
+        return SymbolHelper.toGo(step);
+    }
+    getCardinalityFunctionClass() {
+        return 'CardinalityValue';
+    }
+    appendExplicitNaming(txt, prefix) {
+        this.sb.push(GO_PACKAGE_NAME);
+        super.appendExplicitNaming(txt, prefix);
+    }
+    appendAnonymousSpawn() {
+        this.sb.push(GO_PACKAGE_NAME + 'T__.');
+    }
+    visitP(ctx, pClass, methodName) {
+        this.sb.push(GO_PACKAGE_NAME);
+        super.visitP(ctx, pClass, methodName);
+    }
+    visitTraversalGType(ctx) {
+        const parts = ctx.getText().split('.');
+        this.sb.push(GO_PACKAGE_NAME);
+        this.sb.push(this.processGremlinSymbol(parts[0]));
+        this.sb.push('.');
+        this.sb.push(this.processGremlinSymbol(parts[1].toLowerCase()));
+    }
+    visitNanLiteral(_ctx) {
+        this.sb.push('math.NaN()');
+    }
+    visitInfLiteral(ctx) {
+        if (ctx.SignedInfLiteral() != null && ctx.SignedInfLiteral().getText() === '-Infinity') {
+            this.sb.push('math.Inf(-1)');
+        }
+        else {
+            this.sb.push('math.Inf(1)');
+        }
+    }
+    visitNullLiteral(_ctx) {
+        this.sb.push('nil');
+    }
+    visitStringNullableLiteral(ctx) {
+        if (ctx.getText() === 'null') {
+            this.sb.push('nil');
+        }
+        else {
+            const text = TranslateVisitor.removeFirstAndLastCharacters(ctx.getText());
+            this.handleStringLiteralText(text);
+        }
+    }
+    visitIntegerLiteral(ctx) {
+        const integerLiteral = ctx.getText().toLowerCase();
+        const lastChar = integerLiteral[integerLiteral.length - 1];
+        const num = integerLiteral.slice(0, -1);
+        if (!/[a-z]/.test(lastChar)) {
+            this.sb.push(integerLiteral);
+            return;
+        }
+        switch (lastChar) {
+            case 'b':
+                this.sb.push('int8(');
+                this.sb.push(num);
+                this.sb.push(')');
+                break;
+            case 's':
+                this.sb.push('int16(');
+                this.sb.push(num);
+                this.sb.push(')');
+                break;
+            case 'i':
+                this.sb.push('int32(');
+                this.sb.push(num);
+                this.sb.push(')');
+                break;
+            case 'l':
+                this.sb.push('int64(');
+                this.sb.push(num);
+                this.sb.push(')');
+                break;
+            case 'n':
+                this.sb.push(GO_PACKAGE_NAME + 'ParseBigInt("');
+                this.sb.push(num);
+                this.sb.push('")');
+                break;
+            default:
+                this.sb.push(integerLiteral);
+        }
+    }
+    visitFloatLiteral(ctx) {
+        if (ctx.infLiteral() != null) {
+            this.visit(ctx.infLiteral());
+            return;
+        }
+        if (ctx.nanLiteral() != null) {
+            this.visit(ctx.nanLiteral());
+            return;
+        }
+        const floatLiteral = ctx.getText().toLowerCase();
+        const lastChar = floatLiteral[floatLiteral.length - 1];
+        const num = floatLiteral.slice(0, -1);
+        if (!/[a-z]/.test(lastChar)) {
+            this.sb.push(floatLiteral);
+            return;
+        }
+        switch (lastChar) {
+            case 'f':
+                this.sb.push('float32(');
+                this.sb.push(num);
+                this.sb.push(')');
+                break;
+            case 'd':
+                this.sb.push(num);
+                break;
+            case 'm':
+                this.sb.push(GO_PACKAGE_NAME + 'ParseBigDecimal("');
+                this.sb.push(num);
+                this.sb.push('")');
+                break;
+            default:
+                this.sb.push(floatLiteral);
+        }
+    }
+    visitDateLiteral(ctx) {
+        const dtString = ctx.getChild(2).getText();
+        const inner = TranslateVisitor.removeFirstAndLastCharacters(dtString);
+        const d = new Date(inner);
+        if (isNaN(d.getTime())) {
+            throw new TranslatorException(`Invalid datetime: ${inner}`);
+        }
+        const year = d.getUTCFullYear();
+        const month = d.getUTCMonth() + 1;
+        const day = d.getUTCDate();
+        const hours = d.getUTCHours();
+        const minutes = d.getUTCMinutes();
+        const seconds = d.getUTCSeconds();
+        const nanos = d.getUTCMilliseconds() * 1_000_000;
+        const totalSeconds = 0; // assume UTC when no offset specified
+        const zoneInfo = 'UTC+00:00';
+        this.sb.push(`time.Date(${year}, ${month}, ${day}, ${hours}, ${minutes}, ${seconds}, ${nanos}, time.FixedZone("${zoneInfo}", ${totalSeconds}))`);
+    }
+    visitGenericRangeLiteral(_ctx) {
+        throw new TranslatorException('Go does not support range literals');
+    }
+    visitGenericSetLiteral(ctx) {
+        this.sb.push(GO_PACKAGE_NAME + 'NewSimpleSet(');
+        const literals = ctx.genericLiteral();
+        for (let i = 0; i < literals.length; i++) {
+            this.visit(literals[i]);
+            if (i < literals.length - 1) {
+                this.sb.push(', ');
+            }
+        }
+        this.sb.push(')');
+    }
+    visitGenericCollectionLiteral(ctx) {
+        this.sb.push('[]interface{}{');
+        const literals = ctx.genericLiteral();
+        for (let i = 0; i < literals.length; i++) {
+            this.visit(literals[i]);
+            if (i < literals.length - 1) {
+                this.sb.push(', ');
+            }
+        }
+        this.sb.push('}');
+    }
+    visitGenericMapLiteral(ctx) {
+        this.sb.push('map[interface{}]interface{}{');
+        const entries = ctx.mapEntry();
+        for (let i = 0; i < entries.length; i++) {
+            this.visit(entries[i]);
+            if (i < entries.length - 1) {
+                this.sb.push(', ');
+            }
+        }
+        this.sb.push(' }');
+    }
+    visitMapEntry(ctx) {
+        this.visit(ctx.mapKey());
+        this.sb.push(': ');
+        this.visit(ctx.genericLiteral());
+    }
+    visitMapKey(ctx) {
+        const keyIndex = (ctx.LPAREN() != null && ctx.RPAREN() != null) ? 1 : 0;
+        this.visit(ctx.getChild(keyIndex));
+    }
+    visitUuidLiteral(ctx) {
+        if (ctx.stringLiteral() == null) {
+            this.sb.push('uuid.New()');
+            return;
+        }
+        this.sb.push('uuid.MustParse(');
+        this.visitStringLiteral(ctx.stringLiteral());
+        this.sb.push(')');
+    }
+    visitTraversalStrategy(ctx) {
+        if (ctx.getChildCount() === 1) {
+            this.sb.push(GO_PACKAGE_NAME);
+            this.sb.push(ctx.getText());
+            this.sb.push('()');
+            return;
+        }
+        const firstText = ctx.getChild(0).getText();
+        const strategyName = firstText === 'new' ? ctx.getChild(1).getText() : firstText;
+        this.sb.push(GO_PACKAGE_NAME);
+        this.sb.push(strategyName);
+        this.sb.push('(');
+        if (!STRATEGY_WITH_MAP_OPTS.has(strategyName)) {
+            this.sb.push(GO_PACKAGE_NAME);
+            this.sb.push(strategyName);
+            this.sb.push('Config{');
+        }
+        const configs = ctx.configuration();
+        for (let ix = 0; ix < configs.length; ix++) {
+            this.visit(configs[ix]);
+            if (ix < configs.length - 1) {
+                this.sb.push(', ');
+            }
+        }
+        if (strategyName !== 'OptionsStrategy') {
+            this.sb.push('}');
+        }
+        this.sb.push(')');
+    }
+    visitConfiguration(ctx) {
+        const parent = ctx.parent.getText();
+        const parenIdx = parent.indexOf('(');
+        const rawName = parenIdx > -1 ? parent.substring(0, parenIdx) : parent;
+        const parentName = rawName.startsWith('new') ? rawName.substring(3) : rawName;
+        if (STRATEGY_WITH_MAP_OPTS.has(parentName)) {
+            this.sb.push('map[string]interface{}{"');
+            this.sb.push(ctx.getChild(0).getText());
+            this.sb.push('": ');
+            this.visit(ctx.getChild(2));
+            this.sb.push('}');
+            return;
+        }
+        const key = ctx.getChild(0).getText();
+        this.sb.push(SymbolHelper.toGo(key));
+        this.sb.push(': ');
+        const startIdx = this.sb.length;
+        this.visit(ctx.genericArgument());
+        if (STRATEGY_WITH_STRING_SLICE.has(parentName)) {
+            // Replace []interface{} with []string if present
+            const idx = this.sb.indexOf('[]interface{}', startIdx);
+            if (idx > -1) {
+                this.sb[idx] = '[]string';
+            }
+        }
+        if (key === 'readPartitions') {
+            // Replace []interface{}{items} with gremlingo.NewSimpleSet(items)
+            const added = this.sb.splice(startIdx);
+            const joined = added.join('');
+            const transformed = joined.replace(/^\[\]interface\{\}\{([\s\S]*)\}$/, GO_PACKAGE_NAME + 'NewSimpleSet($1)');
+            this.sb.push(transformed);
+        }
+    }
+    visitTraversalSourceSelfMethod_withoutStrategies(ctx) {
+        this.sb.push('WithoutStrategies(');
+        this.sb.push(GO_PACKAGE_NAME);
+        this.sb.push(ctx.classType().getText());
+        this.sb.push('()');
+        if (ctx.classTypeList() != null && ctx.classTypeList().classTypeExpr() != null) {
+            for (const classTypeCtx of ctx.classTypeList().classTypeExpr().classType()) {
+                this.sb.push(', ');
+                this.sb.push(GO_PACKAGE_NAME);
+                this.sb.push(classTypeCtx.getText());
+                this.sb.push('()');
+            }
+        }
+        this.sb.push(')');
+    }
+}
+class SymbolHelper {
+    static TO_GO_MAP = {
+        'OUT': 'Out',
+        'IN': 'In',
+        'BOTH': 'Both',
+        'bigdecimal': 'BigDecimal',
+        'bigint': 'BigInt',
+        'datetime': 'DateTime',
+        'uuid': 'UUID',
+        'vproperty': 'VProperty',
+        'WithOptions': GO_PACKAGE_NAME + 'WithOptions',
+        'IO': GO_PACKAGE_NAME + 'IO',
+        '__': GO_PACKAGE_NAME + 'T__',
+    };
+    static toGo(symbol) {
+        if (symbol in SymbolHelper.TO_GO_MAP) {
+            return SymbolHelper.TO_GO_MAP[symbol];
+        }
+        // Capitalize first letter (mirrors Java StringUtils.capitalize)
+        if (!symbol)
+            return symbol;
+        return symbol.charAt(0).toUpperCase() + symbol.slice(1);
+    }
+}

package/build/esm/language/translator/GremlinTranslator.d.ts

@@ -0,0 +1,18 @@
+import { Translation } from './Translation.js';
+import TranslateVisitor from './TranslateVisitor.js';
+import { TranslatorKey } from './Translator.js';
+/**
+ * Translates a Gremlin string into a source code representation using ANTLR.
+ * Mirrors the Java GremlinTranslator with SLL → LL fallback parsing.
+ */
+export declare class GremlinTranslator {
+    /**
+     * Translates a Gremlin query string. Defaults to JavaScript output.
+     *
+     * @param query The Gremlin traversal string to translate.
+     * @param graphTraversalSourceName Name of the traversal source variable (default: 'g').
+     * @param translatorOrVisitor A TranslatorKey (e.g. 'JAVASCRIPT'), a custom
+     *   TranslateVisitor instance, or omit for the default JavaScript translator.
+     */
+    static translate(query: string, graphTraversalSourceName?: string, translatorOrVisitor?: TranslatorKey | TranslateVisitor): Translation;
+}

package/build/esm/language/translator/GremlinTranslator.js

@@ -0,0 +1,89 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { BaseErrorListener, CharStream, CommonTokenStream, PredictionMode } from 'antlr4ng';
+import { GremlinLexer } from '../grammar/GremlinLexer.js';
+import { GremlinParser } from '../grammar/GremlinParser.js';
+import { Translation } from './Translation.js';
+import { TranslatorException } from './TranslatorException.js';
+import JavascriptTranslateVisitor from './JavascriptTranslateVisitor.js';
+import { Translator } from './Translator.js';
+/**
+ * Error listener that throws TranslatorException on syntax errors.
+ */
+class ThrowingErrorListener extends BaseErrorListener {
+    syntaxError(_recognizer, _offendingSymbol, line, column, msg, _e) {
+        throw new TranslatorException(`Failed to interpret Gremlin query at line ${line}:${column} - ${msg}`);
+    }
+}
+const errorListener = new ThrowingErrorListener();
+/**
+ * Translates a Gremlin string into a source code representation using ANTLR.
+ * Mirrors the Java GremlinTranslator with SLL → LL fallback parsing.
+ */
+export class GremlinTranslator {
+    /**
+     * Translates a Gremlin query string. Defaults to JavaScript output.
+     *
+     * @param query The Gremlin traversal string to translate.
+     * @param graphTraversalSourceName Name of the traversal source variable (default: 'g').
+     * @param translatorOrVisitor A TranslatorKey (e.g. 'JAVASCRIPT'), a custom
+     *   TranslateVisitor instance, or omit for the default JavaScript translator.
+     */
+    static translate(query, graphTraversalSourceName, translatorOrVisitor) {
+        const sourceName = graphTraversalSourceName ?? 'g';
+        let visitor;
+        if (translatorOrVisitor == null) {
+            visitor = new JavascriptTranslateVisitor(sourceName);
+        }
+        else if (typeof translatorOrVisitor === 'string') {
+            visitor = Translator[translatorOrVisitor](sourceName);
+        }
+        else {
+            visitor = translatorOrVisitor;
+        }
+        const chars = CharStream.fromString(query);
+        const lexer = new GremlinLexer(chars);
+        lexer.removeErrorListeners();
+        lexer.addErrorListener(errorListener);
+        const tokens = new CommonTokenStream(lexer);
+        const parser = new GremlinParser(tokens);
+        // SLL mode is faster; fall back to LL on parse failure (mirrors Java impl)
+        parser.interpreter.predictionMode = PredictionMode.SLL;
+        parser.removeErrorListeners();
+        parser.addErrorListener(errorListener);
+        let queryContext;
+        try {
+            queryContext = parser.queryList();
+        }
+        catch (_ex) {
+            try {
+                tokens.seek(0);
+                lexer.reset();
+                parser.reset();
+                parser.interpreter.predictionMode = PredictionMode.LL;
+                queryContext = parser.queryList();
+            }
+            catch (e) {
+                throw new TranslatorException(`Failed to interpret Gremlin query: ${e instanceof Error ? e.message : String(e)}`);
+            }
+        }
+        visitor.visit(queryContext);
+        return new Translation(query, visitor.getTranslated(), visitor.getParameters());
+    }
+}

package/build/esm/language/translator/GroovyTranslateVisitor.d.ts

@@ -0,0 +1,34 @@
+import TranslateVisitor from './TranslateVisitor.js';
+/**
+ * Converts a Gremlin traversal string into a Groovy source code representation.
+ * Mirrors the Java GroovyTranslateVisitor.
+ */
+export default class GroovyTranslateVisitor extends TranslateVisitor {
+    constructor(graphTraversalSourceName?: string);
+    visitIntegerLiteral(ctx: any): void;
+    visitFloatLiteral(ctx: any): void;
+    visitInfLiteral(ctx: any): void;
+    visitUuidLiteral(ctx: any): void;
+    visitNullLiteral(ctx: any): void;
+    visitGenericSetLiteral(ctx: any): void;
+    visitStringLiteral(ctx: any): void;
+    visitStringNullableLiteral(ctx: any): void;
+    visitMapKey(ctx: any): void;
+    visitNakedKey(ctx: any): void;
+    visitKeyword(ctx: any): void;
+    visitTraversalStrategy(ctx: any): void;
+    visitTraversalSourceSpawnMethod_inject(ctx: any): void;
+    visitTraversalMethod_inject(ctx: any): void;
+    visitTraversalMethod_hasLabel_String_String(ctx: any): void;
+    visitTraversalMethod_option_Merge_Map(ctx: any): void;
+    visitTraversalMethod_mergeV_Map(ctx: any): void;
+    visitTraversalSourceSpawnMethod_mergeV_Map(ctx: any): void;
+    visitTraversalMethod_mergeE_Map(ctx: any): void;
+    visitTraversalSourceSpawnMethod_mergeE_Map(ctx: any): void;
+    private tryCastMapNullableArgument;
+    /**
+     * Special handling for inject with second `null` argument like g.inject(1, null).
+     * inject() is ambiguous in Groovy with jdk extension inject(Object, Closure).
+     */
+    private handleInject;
+}