bitburner-studio 0.1.0

package/README.md

@@ -0,0 +1,169 @@
+ Bitburner Studio
+
+> Build, learn, and automate.
+
+A modern development environment for Bitburner featuring workspace synchronization, TypeScript support, live compilation, extensible modules, visual scripting, and future AI-assisted learning tools.
+
+---
+
+## Vision
+
+Bitburner Studio aims to make Bitburner feel like a real software development environment while remaining approachable for new programmers.
+
+The project is built around a simple idea:
+
+> Learn programming through creation, not repetition.
+
+Users should be able to start with visual tools, inspect the generated TypeScript, understand how it works, and eventually write their own code.
+
+---
+
+## Current Features
+
+### Workspace Synchronization
+
+- Download files from Bitburner
+- Upload local changes automatically
+- Keep local and in-game workspaces synchronized
+
+### TypeScript Support
+
+- Automatic TypeScript detection
+- Incremental compilation
+- Watch mode support
+- Generated JavaScript deployment
+
+### Strongly Typed Configuration
+
+```ts
+const root = config.get('workspace.root');
+const autoWatch = config.get('typescript.auto-watch');
+```
+
+Full autocomplete and type safety.
+
+### Live Development Workflow
+
+- File watching
+- Incremental builds
+- Automatic uploads
+- Fast iteration loop
+
+---
+
+## Planned Features
+
+### Module System
+
+```json
+{
+  "modules": {
+    "ui": true,
+    "remote": true,
+    "source-manager": true
+  }
+}
+```
+
+Modules will be able to:
+
+- Install automatically
+- Download sources
+- Generate typings
+- Configure dependencies
+- Integrate into the workspace
+
+### Visual Programming
+
+Node-based scripting for Bitburner.
+
+```text
+Scan Network
+      ↓
+Find Targets
+      ↓
+Analyze
+      ↓
+Hack
+```
+
+Generated code remains visible and editable.
+
+### AI Assistant
+
+Future AI features may include:
+
+- Code explanation
+- Error diagnosis
+- Script generation
+- Learning assistance
+- Contract guidance
+
+The goal is to teach programming, not hide it.
+
+---
+
+## Roadmap
+
+### Core
+
+- [x] Workspace synchronization
+- [x] Automatic uploads
+- [x] Automatic downloads
+- [x] TypeScript support
+- [x] Watch mode
+- [x] Typed configuration
+
+### Modules
+
+- [ ] Module manager
+- [ ] Module registry
+- [ ] Dependency management
+- [ ] Automatic typings
+
+### UI
+
+- [ ] Vizui integration
+- [ ] Dashboard
+- [ ] Monitoring tools
+- [ ] Contract utilities
+
+### Visual Development
+
+- [ ] Node editor
+- [ ] Flow execution
+- [ ] Code generation
+- [ ] Visual debugging
+
+### AI
+
+- [ ] AI assistant
+- [ ] Error explanations
+- [ ] Learning mode
+- [ ] Context-aware guidance
+
+---
+
+## Philosophy
+
+Bitburner Studio should:
+
+- Encourage learning
+- Generate readable code
+- Remain transparent
+- Stay modular
+- Scale from beginner to advanced users
+
+---
+
+## Status
+
+Early development.
+
+Expect rapid changes before the first stable release.
+
+---
+
+## License
+
+Apache-2.0

package/assets/.gitignore

@@ -0,0 +1,18 @@
+# Build setting
+**/node_modules/
+**/dist/
+**/dist-*/
+**/.**
+**/*.log
+**/*.env
+**/*.tsbuildinfo
+!.gitignore
+
+# Work space setting
+!.vscode/
+
+# Bitburner Workspace setting
+**/.shared/
+**/.backup/
+!home/
+!remote/

package/dist/BBApi.js

@@ -0,0 +1,65 @@
+import Logger from '@netfeez/vterm';
+import { API, NSInput, NSOutput } from './contract.js';
+export * from './contract.js';
+const logger = new Logger({ name: 'BBC' });
+export class BBApi {
+    ws;
+    pending = new Map();
+    index = 0;
+    constructor(ws) {
+        this.ws = ws;
+    }
+    send(method, params) {
+        const id = this.index++;
+        const entry = API[method];
+        const processedParams = entry.input.processUnknown(params);
+        return new Promise((resolve, reject) => {
+            const success = (data) => {
+                try {
+                    const parsed = entry.output.processUnknown(data);
+                    resolve(parsed);
+                }
+                catch (error) {
+                    throw (new Error(`Failed to parse response for method ${method}: ${error} | data: ${data}`));
+                }
+            };
+            this.pending.set(id, { method, success, fail: reject });
+            const request = NSInput.processData({ id, method, params: processedParams });
+            const json = JSON.stringify(request);
+            this.ws.send(json);
+        });
+    }
+    handleMessage(message) {
+        let json;
+        let data;
+        try {
+            json = JSON.parse(message);
+            data = NSOutput.processUnknown(json);
+        }
+        catch (error) {
+            logger.error('Failed to parse message', error);
+            if (json)
+                logger.error(json);
+            logger.error(error);
+            return;
+        }
+        const pending = this.pending.get(data.id);
+        if (!pending)
+            return logger.error('No pending request for id', data.id);
+        this.pending.delete(data.id);
+        try {
+            if ('error' in data)
+                throw new Error(`${typeof data.error === 'string' ? data.error : JSON.stringify(data.error)}`);
+            pending.success(data.result);
+        }
+        catch (error) {
+            pending.fail(error);
+        }
+    }
+    rejectAll(error) {
+        this.pending.forEach((entry) => { entry.fail(error); });
+        this.pending.clear();
+    }
+}
+export default BBApi;
+//# sourceMappingURL=BBApi.js.map

package/dist/BBApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BBApi.js","sourceRoot":"","sources":["../src/BBApi.ts"],"names":[],"mappings":"AACA,OAAO,MAAM,MAAM,gBAAgB,CAAC;AAEpC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEvD,cAAc,eAAe,CAAC;AAE9B,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;AAE3C,MAAM,OAAO,KAAK;IAKA;IAJJ,OAAO,GAAoC,IAAI,GAAG,EAAE,CAAC;IACrD,KAAK,GAAG,CAAC,CAAC;IAEpB,YACc,EAA8B;QAA9B,OAAE,GAAF,EAAE,CAA4B;IACzC,CAAC;IAEG,IAAI,CAAyB,MAAS,EAAE,MAAwB;QACnE,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QACxB,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC;QAC1B,MAAM,eAAe,GAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAE3D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,MAAM,OAAO,GAAG,CAAC,IAA+B,EAAE,EAAE;gBAChD,IAAI,CAAC;oBACD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;oBACjD,OAAO,CAAC,MAAM,CAAC,CAAC;gBACpB,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACb,MAAK,CAAC,IAAI,KAAK,CAAC,uCAAuC,MAAM,KAAK,KAAK,YAAY,IAAI,EAAE,CAAC,CAAC,CAAC;gBAChG,CAAC;YACL,CAAC,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;YAExD,MAAM,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC,CAAC;YAC7E,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACrC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,aAAa,CAAC,OAAe;QAChC,IAAI,IAAa,CAAC;QAClB,IAAI,IAAkB,CAAC;QACvB,IAAI,CAAC;YACD,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC3B,IAAI,GAAG,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;YAC/C,IAAI,IAAI;gBAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC7B,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACpB,OAAO;QACX,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,OAAO;YAAE,OAAO,MAAM,CAAC,KAAK,CAAC,2BAA2B,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7B,IAAI,CAAC;YACD,IAAI,OAAO,IAAI,IAAI;gBAAE,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACpH,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAAC,CAAC;IAC5C,CAAC;IAEM,SAAS,CAAC,KAAY;QACzB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACxD,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IACzB,CAAC;CACJ;AAoBD,eAAe,KAAK,CAAC"}

package/dist/BBClient.js

@@ -0,0 +1,142 @@
+import Logger from '@netfeez/vterm';
+import BBApi, { IS_VALID_FILENAME } from './BBApi.js';
+const logger = new Logger({ name: 'BBC' });
+export class BBClient {
+    ws;
+    static BACKUP_FORMAT = '{DD}-{MM}-{YYYY}/{HH}-{mm}-{ss}-{ms}';
+    static WORKSPACE = '.workspace';
+    static SHARED = '.shared';
+    static BACKUP = '.backup';
+    static DEFINITION_FILE = 'NetScript.d.ts';
+    api;
+    preBind;
+    constructor(ws) {
+        this.ws = ws;
+        this.api = new BBApi(ws);
+        this.preBind = {
+            message: this.api.handleMessage.bind(this.api),
+            close: this.closeHandler.bind(this)
+        };
+        this.ws.on('close', this.preBind.close);
+        this.ws.on('message:text', this.preBind.message);
+    }
+    get online() { return this.ws.status === 'open'; }
+    disconnect() { this.ws.close(); }
+    /**
+     * Retrieves the content of a specific file on the specified server by sending a request to the client with the server name and file path, and awaiting the response, which is expected to contain the contents of the file as a string.
+     * The function returns a promise that resolves to the contents of the specified file on the specified server as a string.
+     * @param server - The name of the server where the file is located.
+     * @param path - The path to the file on the server for which to retrieve the content.
+     * @returns A promise that resolves to the contents of the specified file on the specified server as a string.
+     */
+    async getFile(server, path) {
+        return await this.api.send('getFile', { server, filename: path });
+    }
+    /**
+     * Retrieves a list of all files on the specified server by sending a request to the client and awaiting the response, which is expected to be an array of file entries containing metadata about each file.
+     * The function returns a promise that resolves to an array of file entries, which can be used to access the metadata for each file on the server.
+     * @param server - The name of the server for which to retrieve the files.
+     * @returns A promise that resolves to an array of file entries containing metadata about each file on the specified server.
+     */
+    async getFiles(server) {
+        return await this.api.send('getAllFiles', { server });
+    }
+    /**
+     * Retrieves a list of file names on the specified server by sending a request to the client and awaiting the response, which is expected to be an array of strings representing the file names on the server.
+     * The function returns a promise that resolves to an array of file names on the specified server.
+     * @param server - The name of the server for which to retrieve the file names.
+     * @returns A promise that resolves to an array of strings representing the file names on the specified server.
+     */
+    async getFileNames(server) {
+        return await this.api.send('getFileNames', { server });
+    }
+    /**
+     * Retrieves metadata for a specific file on the specified server by sending a request to the client with the server name and file path, and awaiting the response, which is expected to contain metadata about the file such as its size and last modified date.
+     * The function returns a promise that resolves to an object containing the file metadata, which can be used to access information about the file on the server.
+     * @param server - The name of the server where the file is located.
+     * @param path - The path to the file on the server for which to retrieve metadata.
+     * @returns A promise that resolves to an object containing metadata about the specified file on the specified server.
+     */
+    async getFileMetadata(server, path) {
+        return await this.api.send('getFileMetadata', { server, filename: path });
+    }
+    /**
+     * Retrieves metadata for all files on the specified server by sending a request to the client with the server name and awaiting the response, which is expected to be an array of metadata objects for each file on the server.
+     * The function returns a promise that resolves to an array of file metadata objects, which can be used to access information about all files on the specified server.
+     * @param server - The name of the server for which to retrieve metadata for all files.
+     * @returns A promise that resolves to an array of file metadata objects for all files on the specified server.
+     */
+    async getAllFilesMetadata(server) {
+        return await this.api.send('getAllFileMetadata', { server });
+    }
+    /**
+     * Updates a file on the specified server by sending a request to the client with the server name, file path, and new content.
+     * The client is expected to handle the request and update the file accordingly.
+     * The function returns a boolean indicating whether the update was successful.
+     * @param server - The name of the server where the file is located.
+     * @param path - The path to the file on the server.
+     * @param content - The new content to be written to the file.
+     * @returns A promise that resolves to true if the update was successful, or false if it failed.
+     */
+    async updateFile(server, path, content) {
+        if (!IS_VALID_FILENAME.test(path))
+            throw new Error(`Invalid file name: ${path}`);
+        const result = await this.api.send('pushFile', { server, filename: path, content });
+        if (result !== 'OK')
+            throw new Error(`Failed to update file ${path} on server ${server}. Server responded with: ${result}`);
+        return true;
+    }
+    async getAllServers() {
+        return await this.api.send('getAllServers', {});
+    }
+    /**
+     * Deletes a file on the specified server by sending a request to the client with the server name and file path.
+     * The client is expected to handle the request and delete the file accordingly.
+     * The function returns a boolean indicating whether the deletion was successful.
+     * @param server - The name of the server where the file is located.
+     * @param path - The path to the file on the server that should be deleted.
+     * @returns A promise that resolves to true if the deletion was successful, or false if it failed.
+     */
+    async deleteFile(server, path) {
+        const result = await this.api.send('deleteFile', { server, filename: path });
+        if (result !== 'OK')
+            throw new Error(`Failed to delete file ${path} on server ${server}. Server responded with: ${result}`);
+        return true;
+    }
+    /**
+     * Retrieves a backup of the current state of the game by sending a request to the client and awaiting the response, which is expected to contain the backup data.
+     * The function returns a promise that resolves to the backup data, which can be used to restore the game state at a later time.
+     */
+    async backup() {
+        return await this.api.send('getSaveFile', {});
+    }
+    /**
+     * Retrieves the definition file from the client by sending a request and awaiting the response, which is expected to contain the contents of the definition file as a string.
+     * If the convertInGlobal parameter is set to true, the function wraps the contents of the definition file in a declare global block and adds an export statement at the end, allowing the definitions to be used in a global context.
+     * The function returns a promise that resolves to the contents of the definition file as a string, either in its original form or wrapped in a global declaration depending on the value of convertInGlobal.
+     * @param convertInGlobal - A boolean indicating whether to wrap the definition file contents in a declare global block for use in a global context.
+     * @returns A promise that resolves to the contents of the definition file as a string, optionally wrapped in a declare global block if convertInGlobal is true.
+     */
+    async getDefinitionFile(convertInGlobal = false) {
+        const definitions = await this.api.send('getDefinitionFile', {});
+        if (!convertInGlobal)
+            return definitions;
+        return [
+            'declare global {',
+            ...definitions.split(/[\r\n]/).map(line => `    ${line}`),
+            '}',
+            'export {};',
+        ].join('\n');
+    }
+    /**
+     * Handles the WebSocket connection close event.
+     * Rejects all pending API requests and removes event listeners.
+     */
+    closeHandler() {
+        this.api.rejectAll(new Error('WebSocket connection closed'));
+        this.ws.off('message:text', this.preBind.message);
+        this.ws.off('close', this.preBind.close);
+    }
+}
+export default BBClient;
+//# sourceMappingURL=BBClient.js.map

package/dist/BBClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BBClient.js","sourceRoot":"","sources":["../src/BBClient.ts"],"names":[],"mappings":"AAGA,OAAO,MAAM,MAAM,gBAAgB,CAAC;AAGpC,OAAO,KAAK,EAAE,EAA2B,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAE/E,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;AAE3C,MAAM,OAAO,QAAQ;IAeN;IAdJ,MAAM,CAAU,aAAa,GAAG,sCAAsC,CAAC;IACvE,MAAM,CAAU,SAAS,GAAG,YAAY,CAAC;IACzC,MAAM,CAAU,MAAM,GAAG,SAAS,CAAC;IACnC,MAAM,CAAU,MAAM,GAAG,SAAS,CAAC;IACnC,MAAM,CAAU,eAAe,GAAG,gBAAgB,CAAC;IAE1C,GAAG,CAAQ;IAER,OAAO,CAGxB;IAEF,YACW,EAA8B;QAA9B,OAAE,GAAF,EAAE,CAA4B;QAErC,IAAI,CAAC,GAAG,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG;YACX,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;YAC9C,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;SACtC,CAAC;QACF,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACxC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC;IACD,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,EAAE,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC;IAC3D,UAAU,KAAK,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IACxC;;;;;;OAMG;IACI,KAAK,CAAC,OAAO,CAAC,MAAc,EAAE,IAAY;QAC7C,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACtE,CAAC;IACD;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CAAC,MAAc;QAChC,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC1D,CAAC;IACD;;;;;OAKG;IACI,KAAK,CAAC,YAAY,CAAC,MAAc;QACpC,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3D,CAAC;IACD;;;;;;OAMG;IACI,KAAK,CAAC,eAAe,CAAC,MAAc,EAAE,IAAY;QACrD,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9E,CAAC;IACD;;;;;OAKG;IACI,KAAK,CAAC,mBAAmB,CAAC,MAAc;QAC3C,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACjE,CAAC;IACD;;;;;;;;OAQG;IACI,KAAK,CAAC,UAAU,CAAC,MAAc,EAAE,IAAY,EAAE,OAAe;QACjE,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,EAAE,CAAC,CAAC;QACjF,MAAM,MAAM,GAAE,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QACnF,IAAI,MAAM,KAAK,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,IAAI,cAAc,MAAM,4BAA4B,MAAM,EAAE,CAAC,CAAC;QAC5H,OAAO,IAAI,CAAC;IAChB,CAAC;IACM,KAAK,CAAC,aAAa;QACtB,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;IACpD,CAAC;IACD;;;;;;;OAOG;IACI,KAAK,CAAC,UAAU,CAAC,MAAc,EAAE,IAAY;QAChD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7E,IAAI,MAAM,KAAK,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,IAAI,cAAc,MAAM,4BAA4B,MAAM,EAAE,CAAC,CAAC;QAC5H,OAAO,IAAI,CAAC;IAChB,CAAC;IACD;;;OAGG;IACI,KAAK,CAAC,MAAM;QACf,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IAClD,CAAC;IACD;;;;;;OAMG;IACI,KAAK,CAAC,iBAAiB,CAAC,kBAA2B,KAAK;QAC3D,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;QACjE,IAAI,CAAC,eAAe;YAAE,OAAO,WAAW,CAAC;QACzC,OAAO;YACH,kBAAkB;YAClB,GAAG,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,IAAI,EAAE,CAAC;YACzD,GAAG;YACH,YAAY;SACf,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAChB,CAAC;IACD;;;OAGG;IACO,YAAY;QAClB,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC,CAAC;QAC7D,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;;AAGL,eAAe,QAAQ,CAAC"}

package/dist/Config.js

@@ -0,0 +1,139 @@
+import { Flatten, Schema } from "@netfeez/common";
+import { File, Path } from "@netfeez/common-node";
+export const workspaceSchema = new Schema({
+    type: 'object',
+    properties: {
+        download: { type: 'boolean', default: true },
+        typescript: { type: 'boolean', default: true },
+        root: { type: 'string', default: '.' }
+    },
+    additionalProperties: false,
+});
+export const typescriptSchema = new Schema({
+    type: 'object',
+    properties: {
+        "auto-watch": { type: 'boolean', default: true }
+    },
+    additionalProperties: false,
+});
+export const schema = new Schema({
+    type: 'object',
+    properties: {
+        host: { type: 'string', default: 'localhost' },
+        port: { type: 'number', default: 3000 },
+        workspace: workspaceSchema.root,
+        typescript: typescriptSchema.root
+    },
+    additionalProperties: false,
+});
+export class Config {
+    static CONFIG_FILE = 'bb-connect.config.json';
+    vData;
+    vPlainData;
+    debouncedSave;
+    path;
+    constructor(data, path = Config.CONFIG_FILE) {
+        this.path = Path.resolve(path);
+        this.vData = schema.processData(data);
+        this.vPlainData = Flatten.object(this.vData);
+        this.debouncedSave = Config.debounce(this.save.bind(this), 1000);
+    }
+    /**
+     * Gets the configuration data.
+     * The data is returned in its processed form, with any transformations defined in the schema applied.
+     * @returns The configuration data.
+     */
+    get data() { return this.vData; }
+    /**
+     * Sets the configuration data and saves it to the file.
+     * The data is processed through the schema before being saved.
+     * @param value The configuration data to set.
+     * @remarks This method is debounced, so it will delay saving the configuration until after 1 second has elapsed since the last time it was called. This is to prevent excessive file writes when multiple values are set in quick succession.
+     */
+    set data(value) {
+        this.vData = schema.processData(value);
+        this.vPlainData = Flatten.object(this.vData);
+        this.debouncedSave();
+    }
+    /**
+     * Gets a value from the configuration. The value is returned in its plain form, without any processing from the schema.
+     * @param key The key of the value to get.
+     * @returns The value associated with the given key.
+     */
+    get(key) { return this.vPlainData[key]; }
+    /**
+     * Sets a value in the configuration and saves it to the file.
+     * The value is processed through the schema before being saved.
+     * @param key The key of the value to set.
+     * @param value The value to set.
+     */
+    set(key, value) {
+        const old = this.vPlainData[key];
+        try {
+            this.vPlainData[key] = value;
+            this.vData = schema.processData(this.vPlainData);
+        }
+        catch (error) {
+            this.vPlainData[key] = old;
+            throw error;
+        }
+        this.debouncedSave();
+    }
+    /**
+     * Saves the current configuration to the specified path.
+     * If no path is provided, it will save to the path specified in the constructor.
+     * @param path The path to save the configuration to.
+     */
+    async save(path = this.path) {
+        const processed = schema.processData(this.vData);
+        const json = JSON.stringify(processed, null, 4);
+        await File.write(path, json, 'utf-8');
+    }
+    /**
+     * Saves the current configuration to the specified path.
+     * @param data The configuration data to save.
+     * @param path The path to save the configuration to.
+     */
+    static async save(data, path) {
+        path = Path.resolve(path);
+        const processed = schema.processData(data);
+        const json = JSON.stringify(processed, null, 4);
+        await File.write(path, json, 'utf-8');
+    }
+    /**
+     * Loads the configuration from the specified path. If the file does not exist, a new configuration will be created with default values and saved to the path.
+     * @param path The path to load the configuration from.
+     * @returns The loaded configuration.
+     */
+    static async load(path) {
+        path = Path.resolve(path);
+        if (!await File.exists(path)) {
+            const config = new Config(schema.processData({}), path);
+            await config.save();
+            return config;
+        }
+        const json = await File.read(path, 'utf-8');
+        const data = JSON.parse(json);
+        return new Config(data, path);
+    }
+    toJSON() { return this.vData; }
+    /**
+     * Creates a debounced version of the given function that delays invoking the function until after wait milliseconds have elapsed since the last time the debounced function was invoked.
+     * @param func The function to debounce.
+     * @param wait The number of milliseconds to delay.
+     * @returns A debounced version of the given function.
+     */
+    static debounce(func, wait) {
+        let timeout = null;
+        return function (...args) {
+            if (timeout)
+                clearTimeout(timeout);
+            timeout = setTimeout(() => {
+                func.apply(this, args);
+                timeout = null;
+            }, wait);
+        };
+    }
+}
+export default Config;
+//# sourceMappingURL=Config.js.map

package/dist/Config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Config.js","sourceRoot":"","sources":["../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAElD,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,MAAM,CAAC;IACtC,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACR,QAAQ,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE;QAC5C,UAAU,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE;QAC9C,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KACzC;IACD,oBAAoB,EAAE,KAAK;CAC9B,CAAC,CAAC;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,MAAM,CAAC;IACvC,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACR,YAAY,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE;KACnD;IACD,oBAAoB,EAAE,KAAK;CAC9B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;IAC7B,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACR,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE;QAC9C,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE;QACvC,SAAS,EAAE,eAAe,CAAC,IAAI;QAC/B,UAAU,EAAE,gBAAgB,CAAC,IAAI;KACpC;IACD,oBAAoB,EAAE,KAAK;CAC9B,CAAC,CAAC;AAEH,MAAM,OAAO,MAAM;IACR,MAAM,CAAU,WAAW,GAAG,wBAAwB,CAAC;IACpD,KAAK,CAAc;IACnB,UAAU,CAAmB;IAC7B,aAAa,CAAa;IAC1B,IAAI,CAAS;IAEvB,YAAmB,IAAkC,EAAE,OAAe,MAAM,CAAC,WAAW;QACpF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;IACrE,CAAC;IACD;;;;OAIG;IACH,IAAW,IAAI,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACxC;;;;;OAKG;IACH,IAAW,IAAI,CAAC,KAAkB;QAC9B,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,aAAa,EAAE,CAAC;IACzB,CAAC;IACD;;;;OAIG;IACI,GAAG,CAAsC,GAAS,IAA4B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACnH;;;;;OAKG;IACI,GAAG,CAAsC,GAAS,EAAE,KAA6B;QACpF,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;QAChC,IAAI,CAAC;YACD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YAC7B,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;YAC3B,MAAM,KAAK,CAAC;QAChB,CAAC;QACD,IAAI,CAAC,aAAa,EAAE,CAAC;IACzB,CAAC;IACD;;;;OAIG;IACI,KAAK,CAAC,IAAI,CAAC,OAAe,IAAI,CAAC,IAAI;QACtC,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAChD,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAiB,EAAE,IAAY;QACpD,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1B,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAChD,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAY;QACjC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1B,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACxD,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;YACpB,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC9B,OAAO,IAAI,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAClC,CAAC;IACM,MAAM,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACtC;;;;;OAKG;IACO,MAAM,CAAC,QAAQ,CAAqC,IAAO,EAAE,IAAY;QAC/E,IAAI,OAAO,GAA0B,IAAI,CAAC;QAC1C,OAAO,UAAoB,GAAG,IAAmB;YAC7C,IAAI,OAAO;gBAAE,YAAY,CAAC,OAAO,CAAC,CAAC;YACnC,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;gBACtB,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACvB,OAAO,GAAG,IAAI,CAAC;YACnB,CAAC,EAAE,IAAI,CAAC,CAAC;QACb,CAAM,CAAC;IACX,CAAC;;AAML,eAAe,MAAM,CAAC"}

package/dist/Workspace/Default.js

@@ -0,0 +1,34 @@
+export const TSCONFIG = {
+    compilerOptions: {
+        target: 'EsNext',
+        module: 'NodeNext',
+        moduleResolution: 'NodeNext',
+        outDir: './shared',
+        rootDir: './server',
+        types: [],
+        lib: ['DOM', 'ESNext'],
+        declaration: false,
+        sourceMap: false
+    },
+    include: ['./server/**/*.ts', 'bin/**/*.d.ts']
+};
+export const PACKAGE = {
+    name: 'bitburner-connect-workspace',
+    description: 'A workspace for Bitburner Connect',
+    version: '1.0.0',
+    type: 'module',
+    scripts: {
+        start: 'cd ../; node dist/server.js',
+        dev: 'npx tsc --watch',
+        build: 'npx tsc'
+    },
+    keywords: [],
+    author: '',
+    license: 'ISC',
+    devDependencies: {
+        typescript: '^6.0.3'
+    }
+};
+const Defaults = { TSCONFIG, PACKAGE };
+export default Defaults;
+//# sourceMappingURL=Default.js.map

package/dist/Workspace/Default.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Default.js","sourceRoot":"","sources":["../../src/Workspace/Default.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,QAAQ,GAAG;IACpB,eAAe,EAAE;QACb,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,UAAU;QAClB,gBAAgB,EAAE,UAAU;QAC5B,MAAM,EAAE,UAAU;QAClB,OAAO,EAAE,UAAU;QACnB,KAAK,EAAE,EAAE;QACT,GAAG,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC;QACtB,WAAW,EAAE,KAAK;QAClB,SAAS,EAAE,KAAK;KACnB;IACD,OAAO,EAAE,CAAC,kBAAkB,EAAE,eAAe,CAAC;CACjD,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG;IACnB,IAAI,EAAE,6BAA6B;IACnC,WAAW,EAAE,mCAAmC;IAChD,OAAO,EAAE,OAAO;IAChB,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACL,KAAK,EAAE,6BAA6B;QACpC,GAAG,EAAE,iBAAiB;QACtB,KAAK,EAAE,SAAS;KACnB;IACD,QAAQ,EAAE,EAAE;IACZ,MAAM,EAAE,EAAE;IACV,OAAO,EAAE,KAAK;IACd,eAAe,EAAE;QACb,UAAU,EAAE,QAAQ;KACvB;CACJ,CAAC;AACF,MAAM,QAAQ,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AACvC,eAAe,QAAQ,CAAC"}