rbxstudio-mcp 2.3.1 → 2.4.0

package/dist/__tests__/tools-bridge.test.js

@@ -0,0 +1,396 @@
+import { RobloxStudioTools } from '../tools/index';
+import { parseToolText } from './helpers';
+function setup(response = { success: true, value: 'studio-response' }) {
+    const bridge = {
+        sendRequest: jest.fn().mockResolvedValue(response),
+    };
+    const tools = new RobloxStudioTools(bridge);
+    return { bridge, tools };
+}
+const forwardCases = [
+    {
+        name: 'getFileTree',
+        call: (tools) => tools.getFileTree('game.Workspace'),
+        endpoint: '/api/file-tree',
+        payload: { path: 'game.Workspace' },
+    },
+    {
+        name: 'searchFiles',
+        call: (tools) => tools.searchFiles('Enemy', 'source'),
+        endpoint: '/api/search-files',
+        payload: { query: 'Enemy', searchType: 'source' },
+    },
+    {
+        name: 'getPlaceInfo',
+        call: (tools) => tools.getPlaceInfo(),
+        endpoint: '/api/place-info',
+        payload: {},
+    },
+    {
+        name: 'getServices',
+        call: (tools) => tools.getServices('Workspace'),
+        endpoint: '/api/services',
+        payload: { serviceName: 'Workspace' },
+    },
+    {
+        name: 'searchObjects',
+        call: (tools) => tools.searchObjects('Part', 'className', 'Name'),
+        endpoint: '/api/search-objects',
+        payload: { query: 'Part', searchType: 'className', propertyName: 'Name' },
+    },
+    {
+        name: 'getInstanceProperties',
+        call: (tools) => tools.getInstanceProperties('game.Workspace.Part'),
+        endpoint: '/api/instance-properties',
+        payload: { instancePath: 'game.Workspace.Part' },
+    },
+    {
+        name: 'getInstanceChildren',
+        call: (tools) => tools.getInstanceChildren('game.Workspace'),
+        endpoint: '/api/instance-children',
+        payload: { instancePath: 'game.Workspace' },
+    },
+    {
+        name: 'searchByProperty',
+        call: (tools) => tools.searchByProperty('Name', 'Part'),
+        endpoint: '/api/search-by-property',
+        payload: { propertyName: 'Name', propertyValue: 'Part' },
+    },
+    {
+        name: 'getClassInfo',
+        call: (tools) => tools.getClassInfo('Part'),
+        endpoint: '/api/class-info',
+        payload: { className: 'Part' },
+    },
+    {
+        name: 'getProjectStructure',
+        call: (tools) => tools.getProjectStructure('game', 5, true),
+        endpoint: '/api/project-structure',
+        payload: { path: 'game', maxDepth: 5, scriptsOnly: true },
+    },
+    {
+        name: 'grep',
+        call: (tools) => tools.grep('require', {
+            path: 'game.ServerScriptService',
+            glob: 'Main.*',
+            type: ['Script'],
+            caseInsensitive: true,
+            after: 1,
+            before: 2,
+            context: 3,
+            outputMode: 'content',
+            headLimit: 4,
+            multiline: true,
+        }),
+        endpoint: '/api/grep',
+        payload: {
+            pattern: 'require',
+            path: 'game.ServerScriptService',
+            glob: 'Main.*',
+            type: ['Script'],
+            caseInsensitive: true,
+            after: 1,
+            before: 2,
+            context: 3,
+            outputMode: 'content',
+            headLimit: 4,
+            multiline: true,
+        },
+    },
+    {
+        name: 'setProperty',
+        call: (tools) => tools.setProperty('game.Workspace.Part', 'Anchored', true),
+        endpoint: '/api/set-property',
+        payload: { instancePath: 'game.Workspace.Part', propertyName: 'Anchored', propertyValue: true },
+    },
+    {
+        name: 'massSetProperty',
+        call: (tools) => tools.massSetProperty(['a', 'b'], 'Transparency', 0.5),
+        endpoint: '/api/mass-set-property',
+        payload: { paths: ['a', 'b'], propertyName: 'Transparency', propertyValue: 0.5 },
+    },
+    {
+        name: 'massGetProperty',
+        call: (tools) => tools.massGetProperty(['a', 'b'], 'Name'),
+        endpoint: '/api/mass-get-property',
+        payload: { paths: ['a', 'b'], propertyName: 'Name' },
+    },
+    {
+        name: 'createObject',
+        call: (tools) => tools.createObject('Part', 'game.Workspace', 'Block'),
+        endpoint: '/api/create-object',
+        payload: { className: 'Part', parent: 'game.Workspace', name: 'Block' },
+    },
+    {
+        name: 'createObjectWithProperties',
+        call: (tools) => tools.createObjectWithProperties('Part', 'game.Workspace', 'Block', { Anchored: true }),
+        endpoint: '/api/create-object',
+        payload: {
+            className: 'Part',
+            parent: 'game.Workspace',
+            name: 'Block',
+            properties: { Anchored: true },
+        },
+    },
+    {
+        name: 'massCreateObjects',
+        call: (tools) => tools.massCreateObjects([{ className: 'Part', parent: 'game.Workspace' }]),
+        endpoint: '/api/mass-create-objects',
+        payload: { objects: [{ className: 'Part', parent: 'game.Workspace' }] },
+    },
+    {
+        name: 'massCreateObjectsWithProperties',
+        call: (tools) => tools.massCreateObjectsWithProperties([
+            { className: 'Part', parent: 'game.Workspace', properties: { Anchored: true } },
+        ]),
+        endpoint: '/api/mass-create-objects-with-properties',
+        payload: {
+            objects: [{ className: 'Part', parent: 'game.Workspace', properties: { Anchored: true } }],
+        },
+    },
+    {
+        name: 'deleteObject',
+        call: (tools) => tools.deleteObject('game.Workspace.Block'),
+        endpoint: '/api/delete-object',
+        payload: { instancePath: 'game.Workspace.Block' },
+    },
+    {
+        name: 'smartDuplicate',
+        call: (tools) => tools.smartDuplicate('game.Workspace.Block', 3, { namePattern: 'Block{n}' }),
+        endpoint: '/api/smart-duplicate',
+        payload: { instancePath: 'game.Workspace.Block', count: 3, options: { namePattern: 'Block{n}' } },
+    },
+    {
+        name: 'massDuplicate',
+        call: (tools) => tools.massDuplicate([{ instancePath: 'game.Workspace.Block', count: 2 }]),
+        endpoint: '/api/mass-duplicate',
+        payload: { duplications: [{ instancePath: 'game.Workspace.Block', count: 2 }] },
+    },
+    {
+        name: 'setCalculatedProperty',
+        call: (tools) => tools.setCalculatedProperty(['a'], 'Size', 'x * 2', { x: 3 }),
+        endpoint: '/api/set-calculated-property',
+        payload: { paths: ['a'], propertyName: 'Size', formula: 'x * 2', variables: { x: 3 } },
+    },
+    {
+        name: 'setRelativeProperty',
+        call: (tools) => tools.setRelativeProperty(['a'], 'Position', 'add', 5, 'X'),
+        endpoint: '/api/set-relative-property',
+        payload: { paths: ['a'], propertyName: 'Position', operation: 'add', value: 5, component: 'X' },
+    },
+    {
+        name: 'getScriptSource',
+        call: (tools) => tools.getScriptSource('game.ServerScriptService.Main', 2, 4),
+        endpoint: '/api/get-script-source',
+        payload: { instancePath: 'game.ServerScriptService.Main', startLine: 2, endLine: 4 },
+    },
+    {
+        name: 'setScriptSource',
+        call: (tools) => tools.setScriptSource('game.ServerScriptService.Main', 'print("hi")'),
+        endpoint: '/api/set-script-source',
+        payload: { instancePath: 'game.ServerScriptService.Main', source: 'print("hi")' },
+    },
+    {
+        name: 'editScript',
+        call: (tools) => tools.editScript('game.ServerScriptService.Main', 'old', 'new', true, false),
+        endpoint: '/api/edit-script',
+        payload: {
+            instancePath: 'game.ServerScriptService.Main',
+            oldString: 'old',
+            newString: 'new',
+            replaceAll: true,
+            validateAfter: false,
+        },
+    },
+    {
+        name: 'searchScript',
+        call: (tools) => tools.searchScript('game.ServerScriptService.Main', 'foo', true, 2),
+        endpoint: '/api/search-script',
+        payload: {
+            instancePath: 'game.ServerScriptService.Main',
+            pattern: 'foo',
+            useRegex: true,
+            contextLines: 2,
+        },
+    },
+    {
+        name: 'getScriptFunction',
+        call: (tools) => tools.getScriptFunction('game.ServerScriptService.Main', 'init'),
+        endpoint: '/api/get-script-function',
+        payload: { instancePath: 'game.ServerScriptService.Main', functionName: 'init' },
+    },
+    {
+        name: 'findAndReplaceInScripts',
+        call: (tools) => tools.findAndReplaceInScripts(['a', 'b'], 'old', 'new', false),
+        endpoint: '/api/find-and-replace-in-scripts',
+        payload: { paths: ['a', 'b'], oldString: 'old', newString: 'new', validateAfter: false },
+    },
+    {
+        name: 'getAttribute',
+        call: (tools) => tools.getAttribute('game.Workspace.Part', 'Health'),
+        endpoint: '/api/get-attribute',
+        payload: { instancePath: 'game.Workspace.Part', attributeName: 'Health' },
+    },
+    {
+        name: 'setAttribute',
+        call: (tools) => tools.setAttribute('game.Workspace.Part', 'Health', 100, 'number'),
+        endpoint: '/api/set-attribute',
+        payload: {
+            instancePath: 'game.Workspace.Part',
+            attributeName: 'Health',
+            attributeValue: 100,
+            valueType: 'number',
+        },
+    },
+    {
+        name: 'getAttributes',
+        call: (tools) => tools.getAttributes('game.Workspace.Part'),
+        endpoint: '/api/get-attributes',
+        payload: { instancePath: 'game.Workspace.Part' },
+    },
+    {
+        name: 'deleteAttribute',
+        call: (tools) => tools.deleteAttribute('game.Workspace.Part', 'Health'),
+        endpoint: '/api/delete-attribute',
+        payload: { instancePath: 'game.Workspace.Part', attributeName: 'Health' },
+    },
+    {
+        name: 'getTags',
+        call: (tools) => tools.getTags('game.Workspace.Part'),
+        endpoint: '/api/get-tags',
+        payload: { instancePath: 'game.Workspace.Part' },
+    },
+    {
+        name: 'addTag',
+        call: (tools) => tools.addTag('game.Workspace.Part', 'Enemy'),
+        endpoint: '/api/add-tag',
+        payload: { instancePath: 'game.Workspace.Part', tagName: 'Enemy' },
+    },
+    {
+        name: 'removeTag',
+        call: (tools) => tools.removeTag('game.Workspace.Part', 'Enemy'),
+        endpoint: '/api/remove-tag',
+        payload: { instancePath: 'game.Workspace.Part', tagName: 'Enemy' },
+    },
+    {
+        name: 'getTagged',
+        call: (tools) => tools.getTagged('Enemy'),
+        endpoint: '/api/get-tagged',
+        payload: { tagName: 'Enemy' },
+    },
+    {
+        name: 'getSelection',
+        call: (tools) => tools.getSelection(),
+        endpoint: '/api/get-selection',
+        payload: {},
+    },
+    {
+        name: 'getOutput',
+        call: (tools) => tools.getOutput(10, 123, ['MessageWarning'], true),
+        endpoint: '/api/get-output',
+        payload: { limit: 10, since: 123, messageTypes: ['MessageWarning'], clear: true },
+    },
+    {
+        name: 'cloneInstance',
+        call: (tools) => tools.cloneInstance('game.Workspace.Block', 'game.Workspace', 'Copy'),
+        endpoint: '/api/clone-instance',
+        payload: { sourcePath: 'game.Workspace.Block', targetParent: 'game.Workspace', newName: 'Copy' },
+    },
+    {
+        name: 'moveInstance',
+        call: (tools) => tools.moveInstance('game.Workspace.Block', 'game.ReplicatedStorage'),
+        endpoint: '/api/move-instance',
+        payload: { instancePath: 'game.Workspace.Block', newParent: 'game.ReplicatedStorage' },
+    },
+    {
+        name: 'validateScript',
+        call: (tools) => tools.validateScript(undefined, 'print("ok")'),
+        endpoint: '/api/validate-script',
+        payload: { instancePath: undefined, source: 'print("ok")' },
+    },
+    {
+        name: 'insertAsset',
+        call: (tools) => tools.insertAsset(123, 'Assets', 'game.Workspace'),
+        endpoint: '/api/insert-asset',
+        payload: { assetId: 123, folderName: 'Assets', targetParent: 'game.Workspace' },
+    },
+    {
+        name: 'focusCamera',
+        call: (tools) => tools.focusCamera('game.Workspace.Block', { angle: 'front', distance: 20, autoDistance: false }),
+        endpoint: '/api/focus-camera',
+        payload: {
+            instancePath: 'game.Workspace.Block',
+            angle: 'front',
+            distance: 20,
+            autoDistance: false,
+        },
+    },
+    {
+        name: 'executeLua',
+        call: (tools) => tools.executeLua('print("hi")'),
+        endpoint: '/api/execute-lua',
+        payload: { code: 'print("hi")' },
+    },
+];
+describe('RobloxStudioTools bridge forwarding', () => {
+    test.each(forwardCases)('$name forwards exact endpoint and payload', async (testCase) => {
+        const { bridge, tools } = setup();
+        const result = await testCase.call(tools);
+        expect(bridge.sendRequest).toHaveBeenCalledWith(testCase.endpoint, testCase.payload);
+        expect(parseToolText(result)).toEqual({ success: true, value: 'studio-response' });
+    });
+    test('grep fills Studio-side defaults', async () => {
+        const { bridge, tools } = setup();
+        await tools.grep('Enemy');
+        expect(bridge.sendRequest).toHaveBeenCalledWith('/api/grep', {
+            pattern: 'Enemy',
+            path: 'game',
+            glob: undefined,
+            type: ['LuaSourceContainer'],
+            caseInsensitive: false,
+            after: 0,
+            before: 0,
+            context: 0,
+            outputMode: 'files_with_matches',
+            headLimit: 0,
+            multiline: false,
+        });
+    });
+    test('undo, redo, and history clamp counts before crossing the bridge', async () => {
+        const { bridge, tools } = setup();
+        await tools.undo(250.9);
+        await tools.redo(0);
+        await tools.getHistory(-5, true);
+        expect(bridge.sendRequest).toHaveBeenNthCalledWith(1, '/api/undo', { count: 100 });
+        expect(bridge.sendRequest).toHaveBeenNthCalledWith(2, '/api/redo', { count: 1 });
+        expect(bridge.sendRequest).toHaveBeenNthCalledWith(3, '/api/get-history', {
+            limit: 1,
+            includeDetails: true,
+        });
+    });
+    test('captureScreenshot and renderObjectView forward defaults for non-image responses', async () => {
+        const { bridge, tools } = setup({ success: false, error: 'not available' });
+        expect(parseToolText(await tools.captureScreenshot())).toEqual({
+            success: false,
+            error: 'not available',
+        });
+        expect(parseToolText(await tools.renderObjectView('game.Workspace.Block'))).toEqual({
+            success: false,
+            error: 'not available',
+        });
+        expect(bridge.sendRequest).toHaveBeenNthCalledWith(1, '/api/capture-screenshot', {
+            maxWidth: 768,
+            maxHeight: 768,
+            returnBase64: true,
+        });
+        expect(bridge.sendRequest).toHaveBeenNthCalledWith(2, '/api/render-object-view', {
+            instancePath: 'game.Workspace.Block',
+            angle: 'iso',
+            resolution: { width: 768, height: 768 },
+            lighting: 'bright',
+            background: 'transparent',
+            autoDistance: true,
+        });
+    });
+});
+//# sourceMappingURL=tools-bridge.test.js.map

package/dist/__tests__/tools-bridge.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools-bridge.test.js","sourceRoot":"","sources":["../../src/__tests__/tools-bridge.test.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAM1C,SAAS,KAAK,CAAC,WAAgB,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,iBAAiB,EAAE;IACxE,MAAM,MAAM,GAAG;QACb,WAAW,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,QAAQ,CAAC;KACrC,CAAC;IAChB,MAAM,KAAK,GAAG,IAAI,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC5C,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AAC3B,CAAC;AASD,MAAM,YAAY,GAAkB;IAClC;QACE,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC;QACpD,QAAQ,EAAE,gBAAgB;QAC1B,OAAO,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE;KACpC;IACD;QACE,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC;QACrD,QAAQ,EAAE,mBAAmB;QAC7B,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;KAClD;IACD;QACE,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,EAAE;QACrC,QAAQ,EAAE,iBAAiB;QAC3B,OAAO,EAAE,EAAE;KACZ;IACD;QACE,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC;QAC/C,QAAQ,EAAE,eAAe;QACzB,OAAO,EAAE,EAAE,WAAW,EAAE,WAAW,EAAE;KACtC;IACD;QACE,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,CAAC;QACjE,QAAQ,EAAE,qBAAqB;QAC/B,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,EAAE;KAC1E;IACD;QACE,IAAI,EAAE,uBAAuB;QAC7B,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,qBAAqB,CAAC,qBAAqB,CAAC;QACnE,QAAQ,EAAE,0BAA0B;QACpC,OAAO,EAAE,EAAE,YAAY,EAAE,qBAAqB,EAAE;KACjD;IACD;QACE,IAAI,EAAE,qBAAqB;QAC3B,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,mBAAmB,CAAC,gBAAgB,CAAC;QAC5D,QAAQ,EAAE,wBAAwB;QAClC,OAAO,EAAE,EAAE,YAAY,EAAE,gBAAgB,EAAE;KAC5C;IACD;QACE,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC;QACvD,QAAQ,EAAE,yBAAyB;QACnC,OAAO,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE;KACzD;IACD;QACE,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC;QAC3C,QAAQ,EAAE,iBAAiB;QAC3B,OAAO,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE;KAC/B;IACD;QACE,IAAI,EAAE,qBAAqB;QAC3B,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,mBAAmB,CAAC,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC;QAC3D,QAAQ,EAAE,wBAAwB;QAClC,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE;KAC1D;IACD;QACE,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CACd,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE;YACpB,IAAI,EAAE,0BAA0B;YAChC,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,QAAQ,CAAC;YAChB,eAAe,EAAE,IAAI;YACrB,KAAK,EAAE,CAAC;YACR,MAAM,EAAE,CAAC;YACT,OAAO,EAAE,CAAC;YACV,UAAU,EAAE,SAAS;YACrB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,IAAI;SAChB,CAAC;QACJ,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE;YACP,OAAO,EAAE,SAAS;YAClB,IAAI,EAAE,0BAA0B;YAChC,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,QAAQ,CAAC;YAChB,eAAe,EAAE,IAAI;YACrB,KAAK,EAAE,CAAC;YACR,MAAM,EAAE,CAAC;YACT,OAAO,EAAE,CAAC;YACV,UAAU,EAAE,SAAS;YACrB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,IAAI;SAChB;KACF;IACD;QACE,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,qBAAqB,EAAE,UAAU,EAAE,IAAI,CAAC;QAC3E,QAAQ,EAAE,mBAAmB;QAC7B,OAAO,EAAE,EAAE,YAAY,EAAE,qBAAqB,EAAE,YAAY,EAAE,UAAU,EAAE,aAAa,EAAE,IAAI,EAAE;KAChG;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,cAAc,EAAE,GAAG,CAAC;QACvE,QAAQ,EAAE,wBAAwB;QAClC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,GAAG,EAAE;KACjF;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAC1D,QAAQ,EAAE,wBAAwB;QAClC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE;KACrD;IACD;QACE,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC;QACtE,QAAQ,EAAE,oBAAoB;QAC9B,OAAO,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,OAAO,EAAE;KACxE;IACD;QACE,IAAI,EAAE,4BAA4B;QAClC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CACd,KAAK,CAAC,0BAA0B,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QACzF,QAAQ,EAAE,oBAAoB;QAC9B,OAAO,EAAE;YACP,SAAS,EAAE,MAAM;YACjB,MAAM,EAAE,gBAAgB;YACxB,IAAI,EAAE,OAAO;YACb,UAAU,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;SAC/B;KACF;IACD;QACE,IAAI,EAAE,mBAAmB;QACzB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC;QAC3F,QAAQ,EAAE,0BAA0B;QACpC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC,EAAE;KACxE;IACD;QACE,IAAI,EAAE,iCAAiC;QACvC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CACd,KAAK,CAAC,+BAA+B,CAAC;YACpC,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,UAAU,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE;SAChF,CAAC;QACJ,QAAQ,EAAE,0CAA0C;QACpD,OAAO,EAAE;YACP,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,UAAU,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC;SAC3F;KACF;IACD;QACE,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,sBAAsB,CAAC;QAC3D,QAAQ,EAAE,oBAAoB;QAC9B,OAAO,EAAE,EAAE,YAAY,EAAE,sBAAsB,EAAE;KAClD;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,sBAAsB,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC;QAC7F,QAAQ,EAAE,sBAAsB;QAChC,OAAO,EAAE,EAAE,YAAY,EAAE,sBAAsB,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,EAAE;KAClG;IACD;QACE,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CACd,KAAK,CAAC,aAAa,CAAC,CAAC,EAAE,YAAY,EAAE,sBAAsB,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAC3E,QAAQ,EAAE,qBAAqB;QAC/B,OAAO,EAAE,EAAE,YAAY,EAAE,CAAC,EAAE,YAAY,EAAE,sBAAsB,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE;KAChF;IACD;QACE,IAAI,EAAE,uBAAuB;QAC7B,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;QAC9E,QAAQ,EAAE,8BAA8B;QACxC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE;KACvF;IACD;QACE,IAAI,EAAE,qBAAqB;QAC3B,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,GAAG,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC;QAC5E,QAAQ,EAAE,4BAA4B;QACtC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE;KAChG;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,+BAA+B,EAAE,CAAC,EAAE,CAAC,CAAC;QAC7E,QAAQ,EAAE,wBAAwB;QAClC,OAAO,EAAE,EAAE,YAAY,EAAE,+BAA+B,EAAE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;KACrF;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,+BAA+B,EAAE,aAAa,CAAC;QACtF,QAAQ,EAAE,wBAAwB;QAClC,OAAO,EAAE,EAAE,YAAY,EAAE,+BAA+B,EAAE,MAAM,EAAE,aAAa,EAAE;KAClF;IACD;QACE,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,+BAA+B,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC;QAC7F,QAAQ,EAAE,kBAAkB;QAC5B,OAAO,EAAE;YACP,YAAY,EAAE,+BAA+B;YAC7C,SAAS,EAAE,KAAK;YAChB,SAAS,EAAE,KAAK;YAChB,UAAU,EAAE,IAAI;YAChB,aAAa,EAAE,KAAK;SACrB;KACF;IACD;QACE,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,+BAA+B,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACpF,QAAQ,EAAE,oBAAoB;QAC9B,OAAO,EAAE;YACP,YAAY,EAAE,+BAA+B;YAC7C,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,CAAC;SAChB;KACF;IACD;QACE,IAAI,EAAE,mBAAmB;QACzB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,+BAA+B,EAAE,MAAM,CAAC;QACjF,QAAQ,EAAE,0BAA0B;QACpC,OAAO,EAAE,EAAE,YAAY,EAAE,+BAA+B,EAAE,YAAY,EAAE,MAAM,EAAE;KACjF;IACD;QACE,IAAI,EAAE,yBAAyB;QAC/B,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QAC/E,QAAQ,EAAE,kCAAkC;QAC5C,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE;KACzF;IACD;QACE,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,qBAAqB,EAAE,QAAQ,CAAC;QACpE,QAAQ,EAAE,oBAAoB;QAC9B,OAAO,EAAE,EAAE,YAAY,EAAE,qBAAqB,EAAE,aAAa,EAAE,QAAQ,EAAE;KAC1E;IACD;QACE,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,qBAAqB,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,CAAC;QACnF,QAAQ,EAAE,oBAAoB;QAC9B,OAAO,EAAE;YACP,YAAY,EAAE,qBAAqB;YACnC,aAAa,EAAE,QAAQ;YACvB,cAAc,EAAE,GAAG;YACnB,SAAS,EAAE,QAAQ;SACpB;KACF;IACD;QACE,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,qBAAqB,CAAC;QAC3D,QAAQ,EAAE,qBAAqB;QAC/B,OAAO,EAAE,EAAE,YAAY,EAAE,qBAAqB,EAAE;KACjD;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,qBAAqB,EAAE,QAAQ,CAAC;QACvE,QAAQ,EAAE,uBAAuB;QACjC,OAAO,EAAE,EAAE,YAAY,EAAE,qBAAqB,EAAE,aAAa,EAAE,QAAQ,EAAE;KAC1E;IACD;QACE,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,qBAAqB,CAAC;QACrD,QAAQ,EAAE,eAAe;QACzB,OAAO,EAAE,EAAE,YAAY,EAAE,qBAAqB,EAAE;KACjD;IACD;QACE,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,qBAAqB,EAAE,OAAO,CAAC;QAC7D,QAAQ,EAAE,cAAc;QACxB,OAAO,EAAE,EAAE,YAAY,EAAE,qBAAqB,EAAE,OAAO,EAAE,OAAO,EAAE;KACnE;IACD;QACE,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,qBAAqB,EAAE,OAAO,CAAC;QAChE,QAAQ,EAAE,iBAAiB;QAC3B,OAAO,EAAE,EAAE,YAAY,EAAE,qBAAqB,EAAE,OAAO,EAAE,OAAO,EAAE;KACnE;IACD;QACE,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC;QACzC,QAAQ,EAAE,iBAAiB;QAC3B,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE;KAC9B;IACD;QACE,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,EAAE;QACrC,QAAQ,EAAE,oBAAoB;QAC9B,OAAO,EAAE,EAAE;KACZ;IACD;QACE,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,gBAAgB,CAAC,EAAE,IAAI,CAAC;QACnE,QAAQ,EAAE,iBAAiB;QAC3B,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC,gBAAgB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE;KAClF;IACD;QACE,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,CAAC;QACtF,QAAQ,EAAE,qBAAqB;QAC/B,OAAO,EAAE,EAAE,UAAU,EAAE,sBAAsB,EAAE,YAAY,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE;KACjG;IACD;QACE,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,sBAAsB,EAAE,wBAAwB,CAAC;QACrF,QAAQ,EAAE,oBAAoB;QAC9B,OAAO,EAAE,EAAE,YAAY,EAAE,sBAAsB,EAAE,SAAS,EAAE,wBAAwB,EAAE;KACvF;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,SAAS,EAAE,aAAa,CAAC;QAC/D,QAAQ,EAAE,sBAAsB;QAChC,OAAO,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE;KAC5D;IACD;QACE,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,QAAQ,EAAE,gBAAgB,CAAC;QACnE,QAAQ,EAAE,mBAAmB;QAC7B,OAAO,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,gBAAgB,EAAE;KAChF;IACD;QACE,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CACd,KAAK,CAAC,WAAW,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC;QAClG,QAAQ,EAAE,mBAAmB;QAC7B,OAAO,EAAE;YACP,YAAY,EAAE,sBAAsB;YACpC,KAAK,EAAE,OAAO;YACd,QAAQ,EAAE,EAAE;YACZ,YAAY,EAAE,KAAK;SACpB;KACF;IACD;QACE,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC;QAChD,QAAQ,EAAE,kBAAkB;QAC5B,OAAO,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE;KACjC;CACF,CAAC;AAEF,QAAQ,CAAC,qCAAqC,EAAE,GAAG,EAAE;IACnD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,2CAA2C,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;QACtF,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,CAAC;QAElC,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE1C,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;QACrF,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,iBAAiB,EAAE,CAAC,CAAC;IACrF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,CAAC;QAElC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE1B,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,WAAW,EAAE;YAC3D,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,CAAC,oBAAoB,CAAC;YAC5B,eAAe,EAAE,KAAK;YACtB,KAAK,EAAE,CAAC;YACR,MAAM,EAAE,CAAC;YACT,OAAO,EAAE,CAAC;YACV,UAAU,EAAE,oBAAoB;YAChC,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,KAAK;SACjB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QACjF,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,CAAC;QAElC,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,MAAM,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QAEjC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;QACnF,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QACjF,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,kBAAkB,EAAE;YACxE,KAAK,EAAE,CAAC;YACR,cAAc,EAAE,IAAI;SACrB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iFAAiF,EAAE,KAAK,IAAI,EAAE;QACjG,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,CAAC;QAE5E,MAAM,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;YAC7D,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,eAAe;SACvB,CAAC,CAAC;QACH,MAAM,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YAClF,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,eAAe;SACvB,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,yBAAyB,EAAE;YAC/E,QAAQ,EAAE,GAAG;YACb,SAAS,EAAE,GAAG;YACd,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,yBAAyB,EAAE;YAC/E,YAAY,EAAE,sBAAsB;YACpC,KAAK,EAAE,KAAK;YACZ,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE;YACvC,QAAQ,EAAE,QAAQ;YAClB,UAAU,EAAE,aAAa;YACzB,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/__tests__/tools-docs.test.d.ts

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

package/dist/__tests__/tools-docs.test.d.ts.map

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

package/dist/__tests__/tools-docs.test.js

@@ -0,0 +1,112 @@
+import { promises as fs } from 'fs';
+import * as os from 'os';
+import * as path from 'path';
+import { BridgeService } from '../bridge-service';
+import { RobloxStudioTools } from '../tools/index';
+import { parseToolText } from './helpers';
+describe('Roblox documentation tools', () => {
+    let cacheDir;
+    let tools;
+    beforeAll(async () => {
+        cacheDir = await fs.mkdtemp(path.join(os.tmpdir(), 'rbxstudio-doc-tools-'));
+        process.env.RBXSTUDIO_DOCS_DIR = cacheDir;
+        const root = path.join(cacheDir, 'content', 'en-us');
+        await fs.mkdir(path.join(root, 'reference', 'engine', 'classes'), { recursive: true });
+        await fs.mkdir(path.join(root, 'reference', 'engine', 'datatypes'), { recursive: true });
+        await fs.mkdir(path.join(root, 'animation'), { recursive: true });
+        await fs.writeFile(path.join(root, 'reference', 'engine', 'classes', 'Part.yaml'), `name: Part
+type: class
+summary: |
+  A basic 3D object.
+properties:
+  - name: Anchored
+    summary: |
+      Determines whether physics moves the part.
+    type: boolean
+`, 'utf8');
+        await fs.writeFile(path.join(root, 'reference', 'engine', 'datatypes', 'CFrame.yaml'), `name: CFrame
+type: datatype
+summary: Coordinate frame value.
+`, 'utf8');
+        await fs.writeFile(path.join(root, 'animation', 'rigging.md'), `# Rigging
+Motor6D joints are used to connect body parts in Roblox rigs.
+`, 'utf8');
+        await fs.writeFile(path.join(cacheDir, 'meta.json'), JSON.stringify({
+            repo: 'Roblox/creator-docs',
+            branch: 'main',
+            sha: 'fixture-sha',
+            downloadedAt: new Date().toISOString(),
+            lastCheckedAt: new Date().toISOString(),
+            fileCount: 3,
+            bytesOnDisk: 1,
+            schemaVersion: 1,
+        }, null, 2), 'utf8');
+        tools = new RobloxStudioTools(new BridgeService());
+    });
+    afterAll(async () => {
+        delete process.env.RBXSTUDIO_DOCS_DIR;
+        if (cacheDir)
+            await fs.rm(cacheDir, { recursive: true, force: true });
+    });
+    test('searchRobloxDocs searches the fresh local docs cache', async () => {
+        const body = parseToolText(await tools.searchRobloxDocs('Anchored', {
+            semantic: false,
+            maxHits: 10,
+        }));
+        expect(body).toMatchObject({
+            mode: 'literal',
+            totalHits: 1,
+            filesScanned: 3,
+        });
+        expect(body.hits[0]).toMatchObject({
+            path: 'en-us/reference/engine/classes/Part.yaml',
+            text: '  - name: Anchored',
+        });
+    });
+    test('getRobloxDoc reads a single docs file by relative path', async () => {
+        const body = parseToolText(await tools.getRobloxDoc('en-us/animation/rigging.md'));
+        expect(body).toMatchObject({
+            path: 'en-us/animation/rigging.md',
+        });
+        expect(body.content).toContain('Motor6D joints');
+    });
+    test('listRobloxDocs returns paginated directory entries', async () => {
+        const body = parseToolText(await tools.listRobloxDocs('en-us/reference/engine', { limit: 1 }));
+        expect(body).toMatchObject({
+            path: 'en-us/reference/engine',
+            totalEntries: 2,
+            limit: 1,
+            truncated: true,
+        });
+        expect(body.entries[0]).toEqual({ name: 'classes', type: 'dir' });
+    });
+    test('getRobloxApiReference resolves names case-insensitively and parses YAML', async () => {
+        const body = parseToolText(await tools.getRobloxApiReference('part'));
+        expect(body).toMatchObject({
+            category: 'class',
+            name: 'Part',
+            path: 'en-us/reference/engine/classes/Part.yaml',
+        });
+        expect(body.data).toMatchObject({
+            name: 'Part',
+            type: 'class',
+            properties: [{ name: 'Anchored' }],
+        });
+        expect(body.raw).toContain('name: Part');
+    });
+    test('docs tools return structured not-found responses', async () => {
+        expect(parseToolText(await tools.getRobloxDoc('../secret'))).toMatchObject({
+            error: expect.stringContaining('Doc not found'),
+            cache: { sha: 'fixture-sha', fileCount: 3 },
+        });
+        expect(parseToolText(await tools.listRobloxDocs('../secret'))).toMatchObject({
+            error: expect.stringContaining('Path not found'),
+            cache: { sha: 'fixture-sha', fileCount: 3 },
+        });
+        expect(parseToolText(await tools.getRobloxApiReference('Nope'))).toMatchObject({
+            error: expect.stringContaining('No API reference found'),
+            cache: { sha: 'fixture-sha', fileCount: 3 },
+        });
+    });
+});
+//# sourceMappingURL=tools-docs.test.js.map

package/dist/__tests__/tools-docs.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools-docs.test.js","sourceRoot":"","sources":["../../src/__tests__/tools-docs.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,EAAE,EAAE,MAAM,IAAI,CAAC;AACpC,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C,IAAI,QAAgB,CAAC;IACrB,IAAI,KAAwB,CAAC;IAE7B,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,QAAQ,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,sBAAsB,CAAC,CAAC,CAAC;QAC5E,OAAO,CAAC,GAAG,CAAC,kBAAkB,GAAG,QAAQ,CAAC;QAE1C,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACrD,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACvF,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACzF,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAElE,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,CAAC,EAC9D;;;;;;;;;CASL,EACK,MAAM,CACP,CAAC;QACF,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,aAAa,CAAC,EAClE;;;CAGL,EACK,MAAM,CACP,CAAC;QACF,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,YAAY,CAAC,EAC1C;;CAEL,EACK,MAAM,CACP,CAAC;QACF,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,EAChC,IAAI,CAAC,SAAS,CACZ;YACE,IAAI,EAAE,qBAAqB;YAC3B,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,aAAa;YAClB,YAAY,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACtC,aAAa,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACvC,SAAS,EAAE,CAAC;YACZ,WAAW,EAAE,CAAC;YACd,aAAa,EAAE,CAAC;SACjB,EACD,IAAI,EACJ,CAAC,CACF,EACD,MAAM,CACP,CAAC;QAEF,KAAK,GAAG,IAAI,iBAAiB,CAAC,IAAI,aAAa,EAAE,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,KAAK,IAAI,EAAE;QAClB,OAAO,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;QACtC,IAAI,QAAQ;YAAE,MAAM,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACtE,MAAM,IAAI,GAAG,aAAa,CACxB,MAAM,KAAK,CAAC,gBAAgB,CAAC,UAAU,EAAE;YACvC,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,EAAE;SACZ,CAAC,CACH,CAAC;QAEF,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,SAAS;YACf,SAAS,EAAE,CAAC;YACZ,YAAY,EAAE,CAAC;SAChB,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;YACjC,IAAI,EAAE,0CAA0C;YAChD,IAAI,EAAE,oBAAoB;SAC3B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;QACxE,MAAM,IAAI,GAAG,aAAa,CAAC,MAAM,KAAK,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC,CAAC;QAEnF,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,4BAA4B;SACnC,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,IAAI,GAAG,aAAa,CAAC,MAAM,KAAK,CAAC,cAAc,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAE/F,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC;YACzB,IAAI,EAAE,wBAAwB;YAC9B,YAAY,EAAE,CAAC;YACf,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;SAChB,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;QACzF,MAAM,IAAI,GAAG,aAAa,CAAC,MAAM,KAAK,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC;QAEtE,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC;YACzB,QAAQ,EAAE,OAAO;YACjB,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,0CAA0C;SACjD,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC;YAC9B,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,OAAO;YACb,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;SACnC,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAClE,MAAM,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;YACzE,KAAK,EAAE,MAAM,CAAC,gBAAgB,CAAC,eAAe,CAAC;YAC/C,KAAK,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC,EAAE;SAC5C,CAAC,CAAC;QACH,MAAM,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;YAC3E,KAAK,EAAE,MAAM,CAAC,gBAAgB,CAAC,gBAAgB,CAAC;YAChD,KAAK,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC,EAAE;SAC5C,CAAC,CAAC;QACH,MAAM,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;YAC7E,KAAK,EAAE,MAAM,CAAC,gBAAgB,CAAC,wBAAwB,CAAC;YACxD,KAAK,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC,EAAE;SAC5C,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/__tests__/tools-guards.test.d.ts

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

package/dist/__tests__/tools-guards.test.d.ts.map

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