@documentdb-js/shell-runtime 0.8.0

package/dist/ResultTransformer.d.ts

@@ -0,0 +1,58 @@
+import { type ShellEvaluationResult } from './types';
+/**
+ * Transforms raw @mongosh `ShellResult` objects into clean `ShellEvaluationResult` values.
+ *
+ * Handles:
+ * - Cursor result unwrapping (`{ cursorHasMore, documents }` → plain array)
+ * - Array subclass normalization (CursorIterationResult → plain Array)
+ * - Source namespace extraction
+ */
+export declare class ResultTransformer {
+    /**
+     * Transform a raw @mongosh ShellResult into a ShellEvaluationResult.
+     *
+     * @param shellResult - Raw result from `ShellEvaluator.customEval()`.
+     *   Expected shape: `{ type: string | null, printable: unknown, source?: { namespace?: {...} } }`
+     * @param durationMs - Execution duration in milliseconds.
+     */
+    transform(shellResult: ShellResultLike, durationMs: number): ShellEvaluationResult;
+    /**
+     * Normalize the printable value from @mongosh.
+     *
+     * @mongosh wraps cursor results differently depending on execution context:
+     * - Worker context: `{ cursorHasMore: boolean, documents: unknown[] }`
+     * - In-process: `CursorIterationResult` (Array subclass)
+     *
+     * This normalizes both to a plain array.
+     */
+    private normalizePrintable;
+    /**
+     * Extract the cursorHasMore flag from the raw @mongosh result.
+     *
+     * @mongosh may deliver cursor results in two forms:
+     * - Object: `{ cursorHasMore: boolean, documents: unknown[] }` (from CursorIterationResult.asPrintable)
+     * - Array with property: `CursorIterationResult` (Array subclass with `cursorHasMore` as own property)
+     *
+     * Both are checked. Non-Cursor types always return undefined.
+     */
+    private extractCursorHasMore;
+    /**
+     * Extract source namespace from the @mongosh ShellResult.
+     */
+    private extractSource;
+}
+/**
+ * Shape of the raw @mongosh ShellResult.
+ * Declared as an interface to avoid depending on @mongosh/shell-api types.
+ */
+export interface ShellResultLike {
+    readonly type: string | null;
+    readonly printable: unknown;
+    readonly source?: {
+        readonly namespace?: {
+            readonly db: string;
+            readonly collection: string;
+        };
+    };
+}
+//# sourceMappingURL=ResultTransformer.d.ts.map

package/dist/ResultTransformer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResultTransformer.d.ts","sourceRoot":"","sources":["../src/ResultTransformer.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAErD;;;;;;;GAOG;AACH,qBAAa,iBAAiB;IAC1B;;;;;;OAMG;IACH,SAAS,CAAC,WAAW,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,GAAG,qBAAqB;IAclF;;;;;;;;OAQG;IACH,OAAO,CAAC,kBAAkB;IAoB1B;;;;;;;;OAQG;IACH,OAAO,CAAC,oBAAoB;IAgB5B;;OAEG;IACH,OAAO,CAAC,aAAa;CAWxB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE;QACd,QAAQ,CAAC,SAAS,CAAC,EAAE;YACjB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;YACpB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;SAC/B,CAAC;KACL,CAAC;CACL"}

package/dist/ResultTransformer.js

@@ -0,0 +1,96 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResultTransformer = void 0;
+/**
+ * Transforms raw @mongosh `ShellResult` objects into clean `ShellEvaluationResult` values.
+ *
+ * Handles:
+ * - Cursor result unwrapping (`{ cursorHasMore, documents }` → plain array)
+ * - Array subclass normalization (CursorIterationResult → plain Array)
+ * - Source namespace extraction
+ */
+class ResultTransformer {
+    /**
+     * Transform a raw @mongosh ShellResult into a ShellEvaluationResult.
+     *
+     * @param shellResult - Raw result from `ShellEvaluator.customEval()`.
+     *   Expected shape: `{ type: string | null, printable: unknown, source?: { namespace?: {...} } }`
+     * @param durationMs - Execution duration in milliseconds.
+     */
+    transform(shellResult, durationMs) {
+        const printable = this.normalizePrintable(shellResult.type, shellResult.printable);
+        const cursorHasMore = this.extractCursorHasMore(shellResult.type, shellResult.printable);
+        const source = this.extractSource(shellResult.source);
+        return {
+            type: shellResult.type,
+            printable,
+            durationMs,
+            cursorHasMore,
+            source,
+        };
+    }
+    /**
+     * Normalize the printable value from @mongosh.
+     *
+     * @mongosh wraps cursor results differently depending on execution context:
+     * - Worker context: `{ cursorHasMore: boolean, documents: unknown[] }`
+     * - In-process: `CursorIterationResult` (Array subclass)
+     *
+     * This normalizes both to a plain array.
+     */
+    normalizePrintable(type, printable) {
+        // Cursor result wrapped as { cursorHasMore, documents }
+        if (type === 'Cursor' &&
+            typeof printable === 'object' &&
+            printable !== null &&
+            'documents' in printable &&
+            Array.isArray(printable.documents)) {
+            return printable.documents;
+        }
+        // Array subclass (CursorIterationResult) — normalize to plain Array
+        if (Array.isArray(printable)) {
+            return Array.from(printable);
+        }
+        return printable;
+    }
+    /**
+     * Extract the cursorHasMore flag from the raw @mongosh result.
+     *
+     * @mongosh may deliver cursor results in two forms:
+     * - Object: `{ cursorHasMore: boolean, documents: unknown[] }` (from CursorIterationResult.asPrintable)
+     * - Array with property: `CursorIterationResult` (Array subclass with `cursorHasMore` as own property)
+     *
+     * Both are checked. Non-Cursor types always return undefined.
+     */
+    extractCursorHasMore(type, printable) {
+        if (type !== 'Cursor' || typeof printable !== 'object' || printable === null) {
+            return undefined;
+        }
+        // Object shape: { cursorHasMore, documents }
+        if ('cursorHasMore' in printable &&
+            typeof printable.cursorHasMore === 'boolean') {
+            return printable.cursorHasMore;
+        }
+        return undefined;
+    }
+    /**
+     * Extract source namespace from the @mongosh ShellResult.
+     */
+    extractSource(source) {
+        if (!source?.namespace) {
+            return undefined;
+        }
+        return {
+            namespace: {
+                db: source.namespace.db,
+                collection: source.namespace.collection,
+            },
+        };
+    }
+}
+exports.ResultTransformer = ResultTransformer;
+//# sourceMappingURL=ResultTransformer.js.map

package/dist/ResultTransformer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResultTransformer.js","sourceRoot":"","sources":["../src/ResultTransformer.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAIhG;;;;;;;GAOG;AACH,MAAa,iBAAiB;IAC1B;;;;;;OAMG;IACH,SAAS,CAAC,WAA4B,EAAE,UAAkB;QACtD,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;QACnF,MAAM,aAAa,GAAG,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;QACzF,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAEtD,OAAO;YACH,IAAI,EAAE,WAAW,CAAC,IAAI;YACtB,SAAS;YACT,UAAU;YACV,aAAa;YACb,MAAM;SACT,CAAC;IACN,CAAC;IAED;;;;;;;;OAQG;IACK,kBAAkB,CAAC,IAAmB,EAAE,SAAkB;QAC9D,wDAAwD;QACxD,IACI,IAAI,KAAK,QAAQ;YACjB,OAAO,SAAS,KAAK,QAAQ;YAC7B,SAAS,KAAK,IAAI;YAClB,WAAW,IAAI,SAAS;YACxB,KAAK,CAAC,OAAO,CAAE,SAAqC,CAAC,SAAS,CAAC,EACjE,CAAC;YACC,OAAQ,SAAsC,CAAC,SAAS,CAAC;QAC7D,CAAC;QAED,oEAAoE;QACpE,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC,IAAI,CAAC,SAAsB,CAAC,CAAC;QAC9C,CAAC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;;;;;;;OAQG;IACK,oBAAoB,CAAC,IAAmB,EAAE,SAAkB;QAChE,IAAI,IAAI,KAAK,QAAQ,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;YAC3E,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,6CAA6C;QAC7C,IACI,eAAe,IAAI,SAAS;YAC5B,OAAQ,SAAwC,CAAC,aAAa,KAAK,SAAS,EAC9E,CAAC;YACC,OAAQ,SAAwC,CAAC,aAAa,CAAC;QACnE,CAAC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;OAEG;IACK,aAAa,CAAC,MAAiC;QACnD,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC;YACrB,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,OAAO;YACH,SAAS,EAAE;gBACP,EAAE,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE;gBACvB,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,UAAU;aAC1C;SACJ,CAAC;IACN,CAAC;CACJ;AA1FD,8CA0FC"}

package/dist/ResultTransformer.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ResultTransformer.test.d.ts.map

package/dist/ResultTransformer.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResultTransformer.test.d.ts","sourceRoot":"","sources":["../src/ResultTransformer.test.ts"],"names":[],"mappings":""}

package/dist/ResultTransformer.test.js

@@ -0,0 +1,166 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+const ResultTransformer_1 = require("./ResultTransformer");
+describe('ResultTransformer', () => {
+    let transformer;
+    beforeEach(() => {
+        transformer = new ResultTransformer_1.ResultTransformer();
+    });
+    describe('transform', () => {
+        it('passes through simple string results', () => {
+            const shellResult = {
+                type: 'string',
+                printable: 'hello world',
+            };
+            const result = transformer.transform(shellResult, 42);
+            expect(result.type).toBe('string');
+            expect(result.printable).toBe('hello world');
+            expect(result.durationMs).toBe(42);
+            expect(result.source).toBeUndefined();
+        });
+        it('passes through numeric results', () => {
+            const shellResult = {
+                type: 'number',
+                printable: 123,
+            };
+            const result = transformer.transform(shellResult, 10);
+            expect(result.printable).toBe(123);
+        });
+        it('passes through object results', () => {
+            const doc = { _id: 'abc', name: 'test' };
+            const shellResult = {
+                type: 'Document',
+                printable: doc,
+            };
+            const result = transformer.transform(shellResult, 10);
+            expect(result.printable).toEqual(doc);
+        });
+        it('passes through null printable', () => {
+            const shellResult = {
+                type: null,
+                printable: null,
+            };
+            const result = transformer.transform(shellResult, 0);
+            expect(result.type).toBeNull();
+            expect(result.printable).toBeNull();
+        });
+        it('extracts source namespace when present', () => {
+            const shellResult = {
+                type: 'Cursor',
+                printable: [],
+                source: {
+                    namespace: {
+                        db: 'testdb',
+                        collection: 'users',
+                    },
+                },
+            };
+            const result = transformer.transform(shellResult, 10);
+            expect(result.source).toEqual({
+                namespace: { db: 'testdb', collection: 'users' },
+            });
+        });
+        it('returns undefined source when namespace is absent', () => {
+            const shellResult = {
+                type: 'string',
+                printable: 'hello',
+                source: {},
+            };
+            const result = transformer.transform(shellResult, 10);
+            expect(result.source).toBeUndefined();
+        });
+    });
+    describe('cursor result normalization', () => {
+        it('unwraps { cursorHasMore, documents } cursor results', () => {
+            const docs = [{ _id: 1 }, { _id: 2 }, { _id: 3 }];
+            const shellResult = {
+                type: 'Cursor',
+                printable: { cursorHasMore: false, documents: docs },
+            };
+            const result = transformer.transform(shellResult, 10);
+            expect(result.printable).toEqual(docs);
+            expect(Array.isArray(result.printable)).toBe(true);
+        });
+        it('unwraps cursor result with cursorHasMore: true', () => {
+            const docs = [{ _id: 1 }];
+            const shellResult = {
+                type: 'Cursor',
+                printable: { cursorHasMore: true, documents: docs },
+            };
+            const result = transformer.transform(shellResult, 10);
+            expect(result.printable).toEqual(docs);
+        });
+        it('normalizes Array subclass to plain Array', () => {
+            // Simulate CursorIterationResult (Array subclass)
+            class CursorIterationResult extends Array {
+            }
+            const arr = new CursorIterationResult();
+            arr.push({ _id: 1 }, { _id: 2 });
+            const shellResult = {
+                type: 'Cursor',
+                printable: arr,
+            };
+            const result = transformer.transform(shellResult, 10);
+            expect(result.printable).toEqual([{ _id: 1 }, { _id: 2 }]);
+            expect(Array.isArray(result.printable)).toBe(true);
+            // Should be a plain Array, not a CursorIterationResult
+            expect(result.printable.constructor).toBe(Array);
+        });
+        it('normalizes regular arrays to plain Array', () => {
+            const shellResult = {
+                type: 'Cursor',
+                printable: [{ _id: 1 }],
+            };
+            const result = transformer.transform(shellResult, 10);
+            expect(result.printable).toEqual([{ _id: 1 }]);
+        });
+        it('does not unwrap non-Cursor type even with documents field', () => {
+            const shellResult = {
+                type: 'Document',
+                printable: { documents: [{ _id: 1 }] },
+            };
+            const result = transformer.transform(shellResult, 10);
+            // Should not unwrap because type is not 'Cursor'
+            expect(result.printable).toEqual({ documents: [{ _id: 1 }] });
+        });
+    });
+    describe('cursorHasMore extraction', () => {
+        it('extracts cursorHasMore: true from cursor result', () => {
+            const shellResult = {
+                type: 'Cursor',
+                printable: { cursorHasMore: true, documents: [{ _id: 1 }] },
+            };
+            const result = transformer.transform(shellResult, 10);
+            expect(result.cursorHasMore).toBe(true);
+        });
+        it('extracts cursorHasMore: false from cursor result', () => {
+            const shellResult = {
+                type: 'Cursor',
+                printable: { cursorHasMore: false, documents: [{ _id: 1 }] },
+            };
+            const result = transformer.transform(shellResult, 10);
+            expect(result.cursorHasMore).toBe(false);
+        });
+        it('returns undefined cursorHasMore for non-Cursor types', () => {
+            const shellResult = {
+                type: 'Document',
+                printable: { name: 'test' },
+            };
+            const result = transformer.transform(shellResult, 10);
+            expect(result.cursorHasMore).toBeUndefined();
+        });
+        it('returns undefined cursorHasMore for plain array cursor results', () => {
+            const shellResult = {
+                type: 'Cursor',
+                printable: [{ _id: 1 }],
+            };
+            const result = transformer.transform(shellResult, 10);
+            expect(result.cursorHasMore).toBeUndefined();
+        });
+    });
+});
+//# sourceMappingURL=ResultTransformer.test.js.map

package/dist/ResultTransformer.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResultTransformer.test.js","sourceRoot":"","sources":["../src/ResultTransformer.test.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;AAEhG,2DAA8E;AAE9E,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IAC/B,IAAI,WAA8B,CAAC;IAEnC,UAAU,CAAC,GAAG,EAAE;QACZ,WAAW,GAAG,IAAI,qCAAiB,EAAE,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QACvB,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAC5C,MAAM,WAAW,GAAoB;gBACjC,IAAI,EAAE,QAAQ;gBACd,SAAS,EAAE,aAAa;aAC3B,CAAC;YACF,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAEtD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACnC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAC7C,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACnC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACtC,MAAM,WAAW,GAAoB;gBACjC,IAAI,EAAE,QAAQ;gBACd,SAAS,EAAE,GAAG;aACjB,CAAC;YACF,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAEtD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;YACrC,MAAM,GAAG,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YACzC,MAAM,WAAW,GAAoB;gBACjC,IAAI,EAAE,UAAU;gBAChB,SAAS,EAAE,GAAG;aACjB,CAAC;YACF,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAEtD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;YACrC,MAAM,WAAW,GAAoB;gBACjC,IAAI,EAAE,IAAI;gBACV,SAAS,EAAE,IAAI;aAClB,CAAC;YACF,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;YAErD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAC9C,MAAM,WAAW,GAAoB;gBACjC,IAAI,EAAE,QAAQ;gBACd,SAAS,EAAE,EAAE;gBACb,MAAM,EAAE;oBACJ,SAAS,EAAE;wBACP,EAAE,EAAE,QAAQ;wBACZ,UAAU,EAAE,OAAO;qBACtB;iBACJ;aACJ,CAAC;YACF,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAEtD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBAC1B,SAAS,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE;aACnD,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YACzD,MAAM,WAAW,GAAoB;gBACjC,IAAI,EAAE,QAAQ;gBACd,SAAS,EAAE,OAAO;gBAClB,MAAM,EAAE,EAAE;aACb,CAAC;YACF,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAEtD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,CAAC;QAC1C,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACzC,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC3D,MAAM,IAAI,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;YAClD,MAAM,WAAW,GAAoB;gBACjC,IAAI,EAAE,QAAQ;gBACd,SAAS,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;aACvD,CAAC;YACF,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAEtD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACvC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACtD,MAAM,IAAI,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;YAC1B,MAAM,WAAW,GAAoB;gBACjC,IAAI,EAAE,QAAQ;gBACd,SAAS,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;aACtD,CAAC;YACF,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAEtD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;YAChD,kDAAkD;YAClD,MAAM,qBAAsB,SAAQ,KAAc;aAAG;YACrD,MAAM,GAAG,GAAG,IAAI,qBAAqB,EAAE,CAAC;YACxC,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;YAEjC,MAAM,WAAW,GAAoB;gBACjC,IAAI,EAAE,QAAQ;gBACd,SAAS,EAAE,GAAG;aACjB,CAAC;YACF,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAEtD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3D,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnD,uDAAuD;YACvD,MAAM,CAAE,MAAM,CAAC,SAAuB,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;YAChD,MAAM,WAAW,GAAoB;gBACjC,IAAI,EAAE,QAAQ;gBACd,SAAS,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;aAC1B,CAAC;YACF,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAEtD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACjE,MAAM,WAAW,GAAoB;gBACjC,IAAI,EAAE,UAAU;gBAChB,SAAS,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE;aACzC,CAAC;YACF,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAEtD,iDAAiD;YACjD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;QACtC,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACvD,MAAM,WAAW,GAAoB;gBACjC,IAAI,EAAE,QAAQ;gBACd,SAAS,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE;aAC9D,CAAC;YACF,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YACtD,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YACxD,MAAM,WAAW,GAAoB;gBACjC,IAAI,EAAE,QAAQ;gBACd,SAAS,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE;aAC/D,CAAC;YACF,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YACtD,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;YAC5D,MAAM,WAAW,GAAoB;gBACjC,IAAI,EAAE,UAAU;gBAChB,SAAS,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;aAC9B,CAAC;YACF,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YACtD,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,aAAa,EAAE,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;YACtE,MAAM,WAAW,GAAoB;gBACjC,IAAI,EAAE,QAAQ;gBACd,SAAS,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;aAC1B,CAAC;YACF,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YACtD,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,aAAa,EAAE,CAAC;QACjD,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export { DocumentDBShellRuntime } from './DocumentDBShellRuntime';
+export { CommandInterceptor } from './CommandInterceptor';
+export { DocumentDBServiceProvider, type ServiceProviderWithBus } from './DocumentDBServiceProvider';
+export { HelpProvider, type HelpSurface } from './HelpProvider';
+export { ResultTransformer, type ShellResultLike } from './ResultTransformer';
+export { type ShellEvalOptions, type ShellEvaluationResult, type ShellRuntimeCallbacks, type ShellRuntimeOptions, } from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAGlE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,yBAAyB,EAAE,KAAK,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrG,OAAO,EAAE,YAAY,EAAE,KAAK,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAG9E,OAAO,EACH,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,GAC3B,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResultTransformer = exports.HelpProvider = exports.DocumentDBServiceProvider = exports.CommandInterceptor = exports.DocumentDBShellRuntime = void 0;
+// Main runtime
+var DocumentDBShellRuntime_1 = require("./DocumentDBShellRuntime");
+Object.defineProperty(exports, "DocumentDBShellRuntime", { enumerable: true, get: function () { return DocumentDBShellRuntime_1.DocumentDBShellRuntime; } });
+// Components (exposed for advanced usage and testing)
+var CommandInterceptor_1 = require("./CommandInterceptor");
+Object.defineProperty(exports, "CommandInterceptor", { enumerable: true, get: function () { return CommandInterceptor_1.CommandInterceptor; } });
+var DocumentDBServiceProvider_1 = require("./DocumentDBServiceProvider");
+Object.defineProperty(exports, "DocumentDBServiceProvider", { enumerable: true, get: function () { return DocumentDBServiceProvider_1.DocumentDBServiceProvider; } });
+var HelpProvider_1 = require("./HelpProvider");
+Object.defineProperty(exports, "HelpProvider", { enumerable: true, get: function () { return HelpProvider_1.HelpProvider; } });
+var ResultTransformer_1 = require("./ResultTransformer");
+Object.defineProperty(exports, "ResultTransformer", { enumerable: true, get: function () { return ResultTransformer_1.ResultTransformer; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,eAAe;AACf,mEAAkE;AAAzD,gIAAA,sBAAsB,OAAA;AAE/B,sDAAsD;AACtD,2DAA0D;AAAjD,wHAAA,kBAAkB,OAAA;AAC3B,yEAAqG;AAA5F,sIAAA,yBAAyB,OAAA;AAClC,+CAAgE;AAAvD,4GAAA,YAAY,OAAA;AACrB,yDAA8E;AAArE,sHAAA,iBAAiB,OAAA"}

package/dist/types.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Result of evaluating shell code through the DocumentDB shell runtime.
+ *
+ * This is the runtime's public result type — protocol-agnostic (no IPC
+ * serialization). Consumers that need to send results over IPC
+ * (e.g. worker → main thread) are responsible for serialization.
+ */
+export interface ShellEvaluationResult {
+    /** The @mongosh result type string (e.g. 'Cursor', 'Document', 'string', 'Help'). */
+    readonly type: string | null;
+    /** The printable result value — cursors already iterated, arrays normalized. */
+    readonly printable: unknown;
+    /** Execution duration in milliseconds. */
+    readonly durationMs: number;
+    /** Whether the cursor has more documents beyond the returned batch (only set for Cursor results). */
+    readonly cursorHasMore?: boolean;
+    /** Source namespace from the @mongosh ShellResult, if available. */
+    readonly source?: {
+        readonly namespace?: {
+            readonly db: string;
+            readonly collection: string;
+        };
+    };
+}
+/**
+ * Callbacks for runtime events. The runtime is environment-agnostic —
+ * it uses callbacks instead of directly calling VS Code APIs or postMessage.
+ */
+export interface ShellRuntimeCallbacks {
+    /** Called when user code produces console output (console.log, print, printjson). */
+    onConsoleOutput?: (output: string) => void;
+    /** Called for internal log messages from the runtime. */
+    onLog?: (level: 'trace' | 'debug' | 'info' | 'warn' | 'error', message: string) => void;
+}
+/**
+ * Configuration options for the shell runtime.
+ */
+export interface ShellRuntimeOptions {
+    /** Product name passed to @mongosh service provider. */
+    productName?: string;
+    /** Product documentation link passed to @mongosh service provider. */
+    productDocsLink?: string;
+    /** Default number of documents to display per cursor iteration (default: 50). */
+    displayBatchSize?: number;
+    /**
+     * When `true`, the runtime keeps the @mongosh `ShellInstanceState`,
+     * `ShellEvaluator`, and `vm.Context` alive across `evaluate()` calls.
+     * Variables, cursor state, and the `db` reference persist between evaluations.
+     *
+     * When `false` (default), a fresh context is created per `evaluate()` call —
+     * no variable leakage between runs.
+     *
+     * The interactive shell uses `persistent: true`; the query playground uses `false`.
+     */
+    persistent?: boolean;
+}
+/**
+ * Per-evaluation options that can override runtime defaults.
+ * Used to pass current user settings at eval time (F2: read per-eval).
+ */
+export interface ShellEvalOptions {
+    /** Override the display batch size for this evaluation. */
+    displayBatchSize?: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAKA;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IAClC,qFAAqF;IACrF,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,gFAAgF;IAChF,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,0CAA0C;IAC1C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,qGAAqG;IACrG,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IACjC,oEAAoE;IACpE,QAAQ,CAAC,MAAM,CAAC,EAAE;QACd,QAAQ,CAAC,SAAS,CAAC,EAAE;YACjB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;YACpB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;SAC/B,CAAC;KACL,CAAC;CACL;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IAClC,qFAAqF;IACrF,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAC3C,yDAAyD;IACzD,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CAC3F;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sEAAsE;IACtE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iFAAiF;IACjF,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,2DAA2D;IAC3D,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B"}

package/dist/types.js

@@ -0,0 +1,7 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;;gGAGgG"}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@documentdb-js/shell-runtime",
+  "version": "0.8.0",
+  "description": "Sandboxed JavaScript evaluation engine for DocumentDB — shell command handling, result transformation, and help generation",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p .",
+    "clean": "rimraf dist tsconfig.tsbuildinfo",
+    "test": "jest --config jest.config.js",
+    "prettier-fix": "prettier -w \"src/**/*.@(js|ts|jsx|tsx|json|md)\" \"./*.@(js|ts|jsx|tsx|json|md)\""
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/vscode-documentdb",
+    "directory": "packages/documentdb-js-shell-runtime"
+  },
+  "license": "MIT",
+  "peerDependencies": {
+    "mongodb": ">=6.0.0"
+  },
+  "dependencies": {
+    "@mongosh/service-provider-node-driver": "^5.0.6",
+    "@mongosh/shell-api": "^5.1.4",
+    "@mongosh/shell-evaluator": "^5.1.4"
+  }
+}