Enable usage in OpenAI streamed chat completions

Author: Nihhaar Saini

.github/workflows/test.yml

@@ -27,6 +27,7 @@ jobs:
           rm package-lock.json
           npm install -g npm@latest
           npm install
+          npm run build
           npm run test
 
   api-test:
@@ -51,7 +52,15 @@ jobs:
           pip install -r ./tests/ci/requirements.txt
           ./tests/ci/api-test.py
 
+      - uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
+        with:
+          name: (api-test) server-logs
+          path: /tmp/backend.log
+          retention-days: 3
+
   playwright-test:
+    if: false
     name: puterjs (browser env, playwright)
     runs-on: ubuntu-latest
     timeout-minutes: 10
@@ -84,7 +93,7 @@ jobs:
       - uses: actions/upload-artifact@v4
         if: ${{ !cancelled() }}
         with:
-          name: server-logs
+          name: (playwright) server-logs
           path: |
             /tmp/backend.log
             /tmp/fs-tree-manager.log
@@ -93,7 +102,7 @@ jobs:
       - uses: actions/upload-artifact@v4
         if: ${{ !cancelled() }}
         with:
-          name: config-files
+          name: (playwright) config-files
           path: |
             ./volatile/config/config.json
             ./src/fs_tree_manager/config.yaml
@@ -104,7 +113,7 @@ jobs:
         if: ${{ !cancelled() }}
         id: playwright-report
         with:
-          name: playwright-report
+          name: (playwright) playwright-report
           path: tests/playwright/playwright-report/
           retention-days: 3
 

Dockerfile

@@ -24,6 +24,7 @@ COPY package*.json ./
 COPY . .
 
 # Install mocha
+RUN npm i -g npm@latest
 RUN npm install -g mocha
 
 # Install node modules

README.md

@@ -27,7 +27,7 @@
 
 ## Puter
 
-Puter is an advanced, open-source internet operating system designed to be feature-rich, exceptionally fast, and highly extensible. Puter can be used as:
+Puter is an advanced, open-source internet operating system designed to be feature-rich, fast, and highly extensible. Puter can be used as:
 
 - A privacy-first personal cloud to keep all your files, apps, and games in one secure place, accessible from anywhere at any time.
 - A platform for building and publishing websites, web apps, and games.
@@ -152,7 +152,7 @@ This repository, including all its contents, sub-projects, modules, and componen
 - [Farsi / فارسی](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.fa.md)
 - [Finnish / Suomi](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.fi.md)
 - [French / Français](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.fr.md)
-- [German/ Deutsch](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.de.md)
+- [German /  Deutsch](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.de.md)
 - [Hebrew/ עברית](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.he.md)
 - [Hindi / हिंदी](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.hi.md)
 - [Hungarian / Magyar](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.hu.md)

doc/contributors/extensions/README.md

@@ -67,7 +67,7 @@ in order to access `db` from callbacks.
 ```javascript
 const ext = extension;
 
-extension.get('/user-count', { noauth: true }, (req, res) => {
+extension.get('/user-count', { noauth: true, mw: [] }, (req, res) => {
     const [count] = await ext.db.read(
         'SELECT COUNT(*) as c FROM `user`'
     );

doc/contributors/extensions/gen.js

@@ -4,23 +4,23 @@ import events from './events.json.js';
 const mdlib = {};
 mdlib.h = (out, n, str) => {
     out(`${'#'.repeat(n)} ${str}\n\n`);
-}
+};
 
 const N_START = 3;
 
 const out = str => process.stdout.write(str);
 for ( const event of events ) {
     mdlib.h(out, N_START, `\`${event.id}\``);
-    out(dedent(event.description) + '\n\n');
-    
+    out(`${dedent(event.description) }\n\n`);
+
     for ( const k in event.properties ) {
         const prop = event.properties[k];
         mdlib.h(out, N_START + 1, `Property \`${k}\``);
-        out(prop.summary + '\n');
+        out(`${prop.summary }\n`);
         out(`- **Type**: ${prop.type}\n`);
         out(`- **Mutability**: ${prop.mutability}\n`);
         if ( prop.notes ) {
-            out(`- **Notes**:\n`);
+            out('- **Notes**:\n');
             for ( const note of prop.notes ) {
                 out(`  - ${note}\n`);
             }
@@ -29,7 +29,7 @@ for ( const event of events ) {
     }
 
     if ( event.example ) {
-        mdlib.h(out, N_START + 1, `Example`);
+        mdlib.h(out, N_START + 1, 'Example');
         out(`\`\`\`${event.example.language}\n${dedent(event.example.code)}\n\`\`\`\n`);
     }
 

doc/contributors/extensions/manual_overrides.json.js

@@ -12,15 +12,15 @@ export default [
                 summary: 'the email being validated',
                 notes: [
                     'The email may have already been cleaned.',
-                ]
+                ],
             },
             allow: {
                 type: 'boolean',
                 mutability: 'mutable',
                 summary: 'whether the email is allowed',
                 notes: [
                     'If set to false, the email will be considered invalid.',
-                ]
+                ],
             },
         },
     },
@@ -44,8 +44,8 @@ export default [
                         measurements: data.measurements
                     });
                 });
-            `
-        }
+            `,
+        },
     },
     {
         id: 'core.fs.create.directory',
@@ -61,8 +61,8 @@ export default [
             context: {
                 type: 'Context',
                 mutability: 'no-effect',
-                summary: 'current context'
+                summary: 'current context',
             },
-        }
+        },
     },
 ];

doc/i18n/README.pa.md

@@ -0,0 +1,182 @@
+<h3 align="center"><img width="80" alt="Puter.com, The Personal Cloud Computer: All your files, apps, and games in one place accessible from anywhere at any time." src="https://assets.puter.site/puter-logo.png"></h3>
+
+<h3 align="center">ਇੰਟਰਨੇਟ ਓਐਸ! ਮੁਫ਼ਤ, ਖੁੱਲ੍ਹੇ ਸਰੋਤ ਵਾਲਾ, ਅਤੇ ਆਪ ਸਵੈ-ਹੋਸਟ ਕਰ ਸਕਦੇ ਹੋ।</h3>
+
+<p align="center">
+    <a href="https://puter.com/?ref=github.com"><strong>« LIVE DEMO »</strong></a>
+    <br />
+    <br />
+    <a href="https://puter.com/?ref=github.com">Puter.com</a>
+    ·
+    <a href="https://puter.com/app/app-center">ਐਪ ਸਟੋਰ</a>
+    ·
+    <a href="https://developer.puter.com" target="_blank">ਡਿਵੈਲਪਰ</a>
+    ·
+    <a href="https://github.com/heyputer/puter-cli" target="_blank">CLI</a>
+    ·
+    <a href="https://discord.com/invite/PQcx7Teh8u">Discord</a>
+    ·
+    <a href="https://reddit.com/r/puter">Reddit</a>
+    ·
+    <a href="https://twitter.com/HeyPuter">X</a>
+</p>
+
+<h3 align="center"><img width="800" style="border-radius:5px;" alt="screenshot" src="https://assets.puter.site/puter.com-screenshot-3.webp"></h3>
+
+<br/>
+
+## Puter
+
+Puter ਇੱਕ ਵਿਕਸਤ, ਖੁੱਲ੍ਹਾ-ਸਰੋਤ ਇੰਟਰਨੇਟ ਓਪਰੇਟਿੰਗ ਸਿਸਟਮ ਹੈ ਜੋ ਫੀਚਰ-ਭਰਪੂਰ, ਬਹੁਤ ਤੇਜ਼, ਅਤੇ ਵਧੀਆ ਤਰੀਕੇ ਨਾਲ ਵਧਾਏ ਜਾਣ ਵਾਲਾ ਬਣਾਇਆ ਗਿਆ ਹੈ। Puter ਇਸ ਤਰ੍ਹਾਂ ਵਰਤਿਆ ਜਾ ਸਕਦਾ ਹੈ:
+
+- ਇੱਕ ਪਰਾਈਵੇਸੀ-ਪਹਿਲਾਂ ਨਿੱਜੀ ਕਲਾਊਡ ਵਜੋਂ ਜਿੱਥੇ ਤੁਹਾਡੀਆਂ ਸਾਰੀਆਂ ਫਾਈਲਾਂ, ਐਪਸ, ਅਤੇ ਗੇਮਜ਼ ਇੱਕ ਸੁਰੱਖਿਅਤ ਜਗ੍ਹਾ 'ਤੇ, ਕਿਸੇ ਵੀ ਸਮੇਂ-ਕਿਤੇ ਵੀ ਤੋਂ ਪਹੁੰਚਯੋਗ।
+- ਵੈਬਸਾਈਟਾਂ, ਵੈਬ ਐਪਸ, ਅਤੇ ਗੇਮ ਬਣਾਉਣ ਅਤੇ ਪ੍ਰਕਾਸ਼ਿਤ ਕਰਨ ਲਈ ਇੱਕ ਪਲੇਟਫਾਰਮ।
+- Dropbox, Google Drive, OneDrive ਆਦਿ ਦਾ ਇੱਕ ਆਧੁਨਿਕ ਵਿਕਲਪ, ਨਵੀਂ ਇੰਟਰਫੇਸ ਅਤੇ ਸ਼ਕਤੀਸ਼ਾਲੀ ਫੀਚਰਾਂ ਨਾਲ।
+- ਸਰਵਰਾਂ ਅਤੇ ਵਰਕਸਟੇਸ਼ਨਾਂ ਲਈ ਰਿਮੋਟ ਡੈਸਕਟਾਪ Environment।
+- ਵੈਬ ਡਿਵੈਲਪਮੈਂਟ, ਕਲਾਊਡ ਕੰਪਿਊਟਿੰਗ, ਡਿਸਟ੍ਰੀਬਿਊਟਡ ਸਿਸਟਮ ਅਤੇ ਹੋਰ ਬਹੁਤ ਕੁਝ ਸਿੱਖਣ ਲਈ ਇੱਕ ਮਿੱਤਰਤਾਪੂ, ਖੁੱਲ੍ਹੇ-ਸਰੋਤ ਵਾਲਾ ਪ੍ਰੋਜੈਕਟ ਅਤੇ ਸਮੂਹ!
+
+<br/>
+
+## Getting Started
+
+### 💻 Local Development
+
+```bash
+git clone https://github.com/HeyPuter/puter
+cd puter
+npm install
+npm start
+```
+**→** ਇਹ Puter ਨੂੰ ਇਸ ਪਤੇ 'ਤੇ ਚਲਾਉਣਾ ਚਾਹੀਦਾ ਹੈ 
+<font color="red"> http://puter.localhost:4100 (ਜਾਂ ਅਗਲਾ ਉਪਲਬਧ ਪੋਰਟ). </font>
+
+ਜੇ ਇਹ ਕੰਮ ਨਹੀਂ ਕਰਦਾ, ਤਾੰ [First Run Issues](./doc/self-hosters/first-run-issues.md) ਵੇਖੋ
+ਟ੍ਰਬਲਸ਼ੂਟਿੰਗ ਲਈ।
+
+<br/>
+
+### 🐳 Docker
+
+```bash
+mkdir puter && cd puter && mkdir -p puter/config puter/data && sudo chown -R 1000:1000 puter && docker run --rm -p 4100:4100 -v `pwd`/puter/config:/etc/puter -v `pwd`/puter/data:/var/puter  ghcr.io/heyputer/puter
+```
+**→** ਇਹ Puter ਨੂੰ ਇਸ ਪਤੇ 'ਤੇ ਚਲਾਉਣਾ ਚਾਹੀਦਾ ਹੈ 
+<font color="red"> http://puter.localhost:4100 (ਜਾਂ ਅਗਲਾ ਉਪਲਬਧ ਪੋਰਟ). </font>
+
+<br/>
+
+### 🐙 Docker Compose
+
+#### Linux/macOS
+
+```bash
+mkdir -p puter/config puter/data
+sudo chown -R 1000:1000 puter
+wget https://raw.githubusercontent.com/HeyPuter/puter/main/docker-compose.yml
+docker compose up
+```
+**→** ਇਹ ਇਸ ਪਤੇ 'ਤੇ ਉਪਲਬਧ ਹੋਣਾ ਚਾਹੀਦਾ ਹੈ 
+<font color="red"> http://puter.localhost:4100 (ਜਾਂ ਅਗਲਾ ਉਪਲਬਧ ਪੋਰਟ). </font>
+
+<br/>
+
+#### Windows
+
+```powershell
+mkdir -p puter
+cd puter
+New-Item -Path "puter\config" -ItemType Directory -Force
+New-Item -Path "puter\data" -ItemType Directory -Force
+Invoke-WebRequest -Uri "https://raw.githubusercontent.com/HeyPuter/puter/main/docker-compose.yml" -OutFile "docker-compose.yml"
+docker compose up
+```
+**→** ਇਹ Puter ਨੂੰ ਇਸ ਪਤੇ 'ਤੇ ਚਲਾਉਣਾ ਚਾਹੀਦਾ ਹੈ 
+<font color="red"> http://puter.localhost:4100 (ਜਾਂ ਅਗਲਾ ਉਪਲਬਧ ਪੋਰਟ). </font>
+
+<br/>
+
+### 🚀 Self-Hosting
+
+Puter ਨੂੰ ਖੁਦ ਹੋਸਟ ਕਰਨ ਲਈ, ਕਨਫਿਗੁਰੇਸ਼ਨ ਵਿਕਲਪ ਅਤੇ ਬਿਹਤਰੀਨ ਕਾਇਦੇ, ਸਾਰੇ ਵਿਸਥਾਰ ਲਈ ਸਾਡੇ [Self-Hosting Documentation](https://github.com/HeyPuter/puter/blob/main/doc/self-hosters/instructions.md) ਵੇਖੋ।
+
+<br/>
+
+### ☁️ Puter.com
+
+Puter [**puter.com**](https://puter.com) 'ਤੇ ਇੱਕ ਹੋਸਟ ਕੀਤੀ ਸੇਵਾ ਵਜੋਂ ਉਪਲਬਧ ਹੈ।
+
+<br/>
+
+## System Requirements
+
+- **Operating Systems:** Linux, macOS, Windows
+- **RAM:** ਘੱਟੋ-ਘੱਟ 2GB (4GB ਸਿਫ਼ਾਰਸ਼ੀ)
+- **Disk Space:** 1GB ਖਾਲੀ ਜਗ੍ਹਾ
+- **Node.js:** Version 20.19.5+ (23+ ਸਿਫ਼ਾਰਸ਼ੀ)
+- **npm:** ਨਵੀਨਤਮ ਸਥਿਰ ਵਰਜਨ
+
+<br/>
+
+## Support
+
+ਮੈਂਟੇਨਰਾਂ ਅਤੇ ਕਮਿਊਨਿਟੀ ਨਾਲ ਇੱਥੇ ਸੰਪਰਕ ਕਰੋ:
+
+- ਬੱਗ ਜਾਂ ਫੀਚਰ ਰਿਕਵੇਸਟ? ਕਿਰਪਾ ਕਰਕੇ [issue ਖੋਲ੍ਹੋ](https://github.com/HeyPuter/puter/issues/new/choose)।
+- Discord: [discord.com/invite/PQcx7Teh8u](https://discord.com/invite/PQcx7Teh8u)
+- X (Twitter): [x.com/HeyPuter](https://x.com/HeyPuter)
+- Reddit: [reddit.com/r/puter/](https://www.reddit.com/r/puter/)
+- Mastodon: [mastodon.social/@puter](https://mastodon.social/@puter)
+- ਸੁਰੱਖਿਆ ਮਸਲੇ? [security@puter.com](mailto:security@puter.com)
+- ਮੇਂਟੇਨਰਾਂ ਨੂੰ ਈਮੇਲ ਕਰੋ [hi@puter.com](mailto:hi@puter.com)
+
+ਅਸੀਂ ਹਮੇਸ਼ਾ ਤੁਹਾਡੀਆਂ ਕਿਸੇ ਵੀ ਪ੍ਰਸ਼ਨਾਂ ਵਿੱਚ ਮਦਦ ਕਰਨ ਲਈ ਤਿਆਰ ਹਾਂ। ਬੇਝਿਝਕ ਪੁੱਛੋ!
+
+<br/>
+
+## License
+
+ਇਹ ਰਿਪੋਜ਼ਟਰੀ, ਆਪਣੇ ਸਾਰੇ ਸਮੱਗਰੀ, ਸਬ-ਪ੍ਰੋਜੈਕਟ, ਮੋਡੀਊਲ, ਅਤੇ ਕੰਪੋਨੈਂਟ ਸਮੇਤ, [AGPL-3.0](https://github.com/HeyPuter/puter/blob/main/LICENSE.txt) ਅਧੀਨ ਲਾਇਸੈਂਸਡ ਹੈ ਜੇ ਤਕ ਹੋਰ ਸਪਸ਼ਟ ਤੌਰ 'ਤੇ ਨਹੀਂ ਕਿਹਾ ਗਿਆ। ਤੀਜੀ ਪੱਖ ਦੀਆਂ ਲਾਇਬ੍ਰੇਰੀਆਂ ਆਪਣੇ ਲਾਇਸੈਂਸਾਂ ਅਨੁਸਾਰ ਹੋ ਸਕਦੀਆਂ ਹਨ।
+
+<br/>
+
+## Translations
+
+- [Arabic / العربية](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ar.md)
+- [Armenian / Հայերեն](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.hy.md)
+- [Bengali / বাংলা](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.bn.md)
+- [Chinese / 中文](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.zh.md)
+- [Danish / Dansk](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.da.md)
+- [English](https://github.com/HeyPuter/puter/blob/main/README.md)
+- [Farsi / فارسی](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.fa.md)
+- [Finnish / Suomi](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.fi.md)
+- [French / Français](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.fr.md)
+- [German /  Deutsch](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.de.md)
+- [Hebrew/ עברית](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.he.md)
+- [Hindi / हिंदी](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.hi.md)
+- [Hungarian / Magyar](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.hu.md)
+- [Indonesian / Bahasa Indonesia](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.id.md)
+- [Italian / Italiano](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.it.md)
+- [Japanese / 日本語](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.jp.md)
+- [Korean / 한국어](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ko.md)
+- [Malay / Bahasa Malaysia](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.my.md)
+- [Malayalam / മലയാളം](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ml.md)
+- [Punjabi / ਪੰਜਾਬੀ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.pa.md)
+- [Polish / Polski](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.pl.md)
+- [Portuguese / Português](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.pt.md)
+- [Romanian / Română](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ro.md)
+- [Russian / Русский](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ru.md)
+- [Spanish / Español](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.es.md)
+- [Swedish / Svenska](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.sv.md)
+- [Tamil / தமிழ்](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ta.md)
+- [Telugu / తెలుగు](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.te.md)
+- [Thai / ไทย](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.th.md)
+- [Turkish / Türkçe](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.tr.md)
+- [Ukrainian / Українська](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ua.md)
+- [Urdu / اردو](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ur.md)
+- [Vietnamese / Tiếng Việt](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.vi.md)
+
+## Links to Other READMEs
+### Backend
+- [PuterAI Module](./src/backend/doc/modules/puterai/README.md)
+- [Metering Service](./src/backend/src/services/MeteringService/README.md)
+- [Extensions Development Guide](./extensions/README.md)