Spaces:
Sleeping
Sleeping
Upload folder using huggingface_hub
Browse filesThis view is limited to 50 files because it contains too many changes.
See raw diff
- .dockerignore +4 -0
- .env.example +1 -0
- .gitattributes +25 -35
- .github/FUNDING.yml +1 -0
- .github/workflows/docker-image.yaml +84 -0
- .github/workflows/main.yml +40 -0
- .github/workflows/release-please.yml +18 -0
- .github/workflows/test.yml +131 -0
- .gitmodules +12 -0
- .husky/pre-commit +1 -0
- .idx/dev.nix +57 -0
- .idx/icon.png +0 -0
- .is_puter_repository +0 -0
- .npmrc +1 -0
- .prettierignore +3 -0
- BUG-BOUNTY.md +66 -0
- CHANGELOG.md +726 -0
- CONTRIBUTING.md +78 -0
- LICENSE.txt +661 -0
- README.md +187 -10
- SECURITY-ACKNOWLEDGEMENTS.md +9 -0
- SECURITY.md +40 -0
- TRADEMARK.md +214 -0
- doc/AI.md +38 -0
- doc/File Structure.drawio +214 -0
- doc/File Structure.drawio.png +3 -0
- doc/README.md +45 -0
- doc/RFCS/20250826_captcha_cloudflare_turnstile.md +57 -0
- doc/api/README.md +5 -0
- doc/api/concepts/share-link.md +9 -0
- doc/api/drivers.md +60 -0
- doc/api/group.md +219 -0
- doc/api/notifications.md +112 -0
- doc/api/share.md +367 -0
- doc/api/type-tagged.md +79 -0
- doc/api/types/app-share.md +26 -0
- doc/api/types/file-share.md +32 -0
- doc/contributors/comment_prefixes.md +33 -0
- doc/contributors/email_testing.md +105 -0
- doc/contributors/extensions.md +38 -0
- doc/contributors/extensions/README.md +89 -0
- doc/contributors/extensions/definitions.md +14 -0
- doc/contributors/extensions/events.json.js +830 -0
- doc/contributors/extensions/events.md +761 -0
- doc/contributors/extensions/gen.js +38 -0
- doc/contributors/extensions/manual_overrides.json.js +68 -0
- doc/contributors/image.png +3 -0
- doc/contributors/structure.md +64 -0
- doc/contributors/vscode.md +2 -0
- doc/devlog.md +103 -0
.dockerignore
ADDED
|
@@ -0,0 +1,4 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.dockerignore
|
| 2 |
+
Dockerfile
|
| 3 |
+
node_modules
|
| 4 |
+
/puter
|
.env.example
ADDED
|
@@ -0,0 +1 @@
|
|
|
|
|
|
|
| 1 |
+
PORT=4000
|
.gitattributes
CHANGED
|
@@ -1,35 +1,25 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
saved_model/**/* filter=lfs diff=lfs merge=lfs -text
|
| 27 |
-
*.tar.* filter=lfs diff=lfs merge=lfs -text
|
| 28 |
-
*.tar filter=lfs diff=lfs merge=lfs -text
|
| 29 |
-
*.tflite filter=lfs diff=lfs merge=lfs -text
|
| 30 |
-
*.tgz filter=lfs diff=lfs merge=lfs -text
|
| 31 |
-
*.wasm filter=lfs diff=lfs merge=lfs -text
|
| 32 |
-
*.xz filter=lfs diff=lfs merge=lfs -text
|
| 33 |
-
*.zip filter=lfs diff=lfs merge=lfs -text
|
| 34 |
-
*.zst filter=lfs diff=lfs merge=lfs -text
|
| 35 |
-
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
|
|
|
| 1 |
+
# Auto detect text files and perform LF normalization
|
| 2 |
+
* text=auto
|
| 3 |
+
doc/contributors/image.png filter=lfs diff=lfs merge=lfs -text
|
| 4 |
+
doc/File[[:space:]]Structure.drawio.png filter=lfs diff=lfs merge=lfs -text
|
| 5 |
+
src/backend/doc/assets/puter-backend-map.drawio.png filter=lfs diff=lfs merge=lfs -text
|
| 6 |
+
src/backend/src/modules/test-drivers/assets/starry.jpg filter=lfs diff=lfs merge=lfs -text
|
| 7 |
+
src/backend/src/modules/test-drivers/assets/wave.jpg filter=lfs diff=lfs merge=lfs -text
|
| 8 |
+
src/backend/src/public/assets/img/logo-bold.psd filter=lfs diff=lfs merge=lfs -text
|
| 9 |
+
src/backend/src/public/assets/img/logo-margin.png filter=lfs diff=lfs merge=lfs -text
|
| 10 |
+
src/backend/src/public/assets/img/logo.psd filter=lfs diff=lfs merge=lfs -text
|
| 11 |
+
src/backend/src/public/assets/img/screenshot.png filter=lfs diff=lfs merge=lfs -text
|
| 12 |
+
src/dev-center/icon.png filter=lfs diff=lfs merge=lfs -text
|
| 13 |
+
src/gui/src/audio/puter_theme_song.mp3 filter=lfs diff=lfs merge=lfs -text
|
| 14 |
+
src/gui/src/fonts/Inter-Black.ttf filter=lfs diff=lfs merge=lfs -text
|
| 15 |
+
src/gui/src/fonts/Inter-Bold.ttf filter=lfs diff=lfs merge=lfs -text
|
| 16 |
+
src/gui/src/fonts/Inter-ExtraBold.ttf filter=lfs diff=lfs merge=lfs -text
|
| 17 |
+
src/gui/src/fonts/Inter-ExtraLight.ttf filter=lfs diff=lfs merge=lfs -text
|
| 18 |
+
src/gui/src/fonts/Inter-Light.ttf filter=lfs diff=lfs merge=lfs -text
|
| 19 |
+
src/gui/src/fonts/Inter-Medium.ttf filter=lfs diff=lfs merge=lfs -text
|
| 20 |
+
src/gui/src/fonts/Inter-Regular.ttf filter=lfs diff=lfs merge=lfs -text
|
| 21 |
+
src/gui/src/fonts/Inter-SemiBold.ttf filter=lfs diff=lfs merge=lfs -text
|
| 22 |
+
src/gui/src/fonts/Inter-Thin.ttf filter=lfs diff=lfs merge=lfs -text
|
| 23 |
+
src/gui/src/images/screenshot.png filter=lfs diff=lfs merge=lfs -text
|
| 24 |
+
src/gui/src/images/wallpaper.webp filter=lfs diff=lfs merge=lfs -text
|
| 25 |
+
src/puter-js/src/bg.png filter=lfs diff=lfs merge=lfs -text
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.github/FUNDING.yml
ADDED
|
@@ -0,0 +1 @@
|
|
|
|
|
|
|
| 1 |
+
github: ['HeyPuter']
|
.github/workflows/docker-image.yaml
ADDED
|
@@ -0,0 +1,84 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#
|
| 2 |
+
name: Docker Image CI
|
| 3 |
+
|
| 4 |
+
# Configures this workflow to run every time a change is pushed to the
|
| 5 |
+
# branch called `main`.
|
| 6 |
+
on:
|
| 7 |
+
push:
|
| 8 |
+
tags:
|
| 9 |
+
- '*.*.*'
|
| 10 |
+
branches:
|
| 11 |
+
- 'main'
|
| 12 |
+
|
| 13 |
+
# Defines two custom environment variables for the workflow. These are used
|
| 14 |
+
# for the Container registry domain, and a name for the Docker image that
|
| 15 |
+
# this workflow builds.
|
| 16 |
+
env:
|
| 17 |
+
REGISTRY: ghcr.io
|
| 18 |
+
IMAGE_NAME: ${{ github.repository }}
|
| 19 |
+
|
| 20 |
+
# There is a single job in this workflow. It's configured to run on the
|
| 21 |
+
# latest available version of Ubuntu.
|
| 22 |
+
jobs:
|
| 23 |
+
build-and-push-image:
|
| 24 |
+
runs-on: ubuntu-latest
|
| 25 |
+
|
| 26 |
+
# Sets the permissions granted to the `GITHUB_TOKEN` for the actions
|
| 27 |
+
# in this job.
|
| 28 |
+
permissions:
|
| 29 |
+
contents: read
|
| 30 |
+
packages: write
|
| 31 |
+
|
| 32 |
+
steps:
|
| 33 |
+
- name: Checkout repository
|
| 34 |
+
uses: actions/checkout@v4
|
| 35 |
+
|
| 36 |
+
# Uses the `docker/login-action` action to log in to the Container
|
| 37 |
+
# registry using the account and password that will publish the packages.
|
| 38 |
+
# Once published, the packages are scoped to the account defined here.
|
| 39 |
+
- name: Log in to GitHub Package Container registry
|
| 40 |
+
uses: docker/login-action@v3
|
| 41 |
+
with:
|
| 42 |
+
registry: ${{ env.REGISTRY }}
|
| 43 |
+
username: ${{ github.actor }}
|
| 44 |
+
password: ${{ secrets.GITHUB_TOKEN }}
|
| 45 |
+
|
| 46 |
+
- name: Set up QEMU
|
| 47 |
+
uses: docker/setup-qemu-action@v3
|
| 48 |
+
|
| 49 |
+
- name: Set up Docker Buildx
|
| 50 |
+
uses: docker/setup-buildx-action@v3
|
| 51 |
+
|
| 52 |
+
# This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about)
|
| 53 |
+
# to extract tags and labels that will be applied to the specified image.
|
| 54 |
+
# The `id` "meta" allows the output of this step to be referenced in
|
| 55 |
+
# a subsequent step. The `images` value provides the base name for the
|
| 56 |
+
# tags and labels.
|
| 57 |
+
- name: Extract metadata (tags, labels) for Docker
|
| 58 |
+
id: meta
|
| 59 |
+
uses: docker/metadata-action@v5
|
| 60 |
+
with:
|
| 61 |
+
images: "${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}"
|
| 62 |
+
tags: |
|
| 63 |
+
type=semver,pattern={{version}}
|
| 64 |
+
type=ref,event=branch
|
| 65 |
+
|
| 66 |
+
# This step uses the `docker/build-push-action` action to build the
|
| 67 |
+
# image, based on your repository's `Dockerfile`. If the build succeeds,
|
| 68 |
+
# it pushes the image to GitHub Packages.
|
| 69 |
+
# It uses the `context` parameter to define the build's context as the
|
| 70 |
+
# set of files located in the specified path. For more information, see
|
| 71 |
+
# "[Usage](https://github.com/docker/build-push-action#usage)" in the
|
| 72 |
+
# README of the `docker/build-push-action` repository.
|
| 73 |
+
# It uses the `tags` and `labels` parameters to tag and label the image
|
| 74 |
+
# with the output from the "meta" step.
|
| 75 |
+
- name: Build and push Docker image
|
| 76 |
+
uses: docker/build-push-action@v5
|
| 77 |
+
with:
|
| 78 |
+
platforms: linux/amd64,linux/arm64
|
| 79 |
+
context: .
|
| 80 |
+
push: ${{ github.event_name != 'pull_request' }}
|
| 81 |
+
tags: ${{ steps.meta.outputs.tags }}
|
| 82 |
+
labels: ${{ steps.meta.outputs.labels }}
|
| 83 |
+
cache-from: type=gha
|
| 84 |
+
cache-to: type=gha,mode=max
|
.github/workflows/main.yml
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
name: Maintain Release Merge PR
|
| 2 |
+
|
| 3 |
+
on:
|
| 4 |
+
push:
|
| 5 |
+
branches:
|
| 6 |
+
- main
|
| 7 |
+
|
| 8 |
+
jobs:
|
| 9 |
+
update-release-pr:
|
| 10 |
+
runs-on: ubuntu-latest
|
| 11 |
+
steps:
|
| 12 |
+
- uses: actions/checkout@v3
|
| 13 |
+
- name: Setup Git
|
| 14 |
+
run: |
|
| 15 |
+
git config user.name github-actions
|
| 16 |
+
git config user.email github-actions@github.com
|
| 17 |
+
- name: Check for existing PR
|
| 18 |
+
id: find-pr
|
| 19 |
+
uses: juliangruber/find-pull-request-action@v1
|
| 20 |
+
with:
|
| 21 |
+
github-token: ${{ secrets.GITHUB_TOKEN }}
|
| 22 |
+
branch: release
|
| 23 |
+
- uses: actions/checkout@v4
|
| 24 |
+
if: steps.find-pr.outputs.number == ''
|
| 25 |
+
with:
|
| 26 |
+
ref: release
|
| 27 |
+
- name: Reset release branch
|
| 28 |
+
if: steps.find-pr.outputs.number == ''
|
| 29 |
+
run: |
|
| 30 |
+
git fetch origin main:main
|
| 31 |
+
git reset --hard main
|
| 32 |
+
- name: Create/Update PR
|
| 33 |
+
if: steps.find-pr.outputs.number == ''
|
| 34 |
+
uses: peter-evans/create-pull-request@v6
|
| 35 |
+
with:
|
| 36 |
+
token: ${{ secrets.GITHUB_TOKEN }}
|
| 37 |
+
commit-message: Update release branch
|
| 38 |
+
title: Merge Release Auto-PR
|
| 39 |
+
body: Merging this PR will invoke release actions
|
| 40 |
+
branch: auto-update/release
|
.github/workflows/release-please.yml
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
on:
|
| 2 |
+
push:
|
| 3 |
+
branches:
|
| 4 |
+
- main
|
| 5 |
+
|
| 6 |
+
permissions:
|
| 7 |
+
contents: write
|
| 8 |
+
pull-requests: write
|
| 9 |
+
|
| 10 |
+
name: release-please
|
| 11 |
+
|
| 12 |
+
jobs:
|
| 13 |
+
release-please:
|
| 14 |
+
runs-on: ubuntu-latest
|
| 15 |
+
steps:
|
| 16 |
+
- uses: google-github-actions/release-please-action@v4
|
| 17 |
+
with:
|
| 18 |
+
release-type: node
|
.github/workflows/test.yml
ADDED
|
@@ -0,0 +1,131 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
name: test
|
| 2 |
+
|
| 3 |
+
on:
|
| 4 |
+
push:
|
| 5 |
+
branches: ["main"]
|
| 6 |
+
pull_request:
|
| 7 |
+
branches: ["main"]
|
| 8 |
+
|
| 9 |
+
jobs:
|
| 10 |
+
test-backend:
|
| 11 |
+
runs-on: ubuntu-latest
|
| 12 |
+
|
| 13 |
+
strategy:
|
| 14 |
+
matrix:
|
| 15 |
+
node-version: [20.x, 22.x]
|
| 16 |
+
|
| 17 |
+
steps:
|
| 18 |
+
- uses: actions/checkout@v4
|
| 19 |
+
|
| 20 |
+
- name: Use Node.js ${{ matrix.node-version }}
|
| 21 |
+
uses: actions/setup-node@v4
|
| 22 |
+
with:
|
| 23 |
+
node-version: ${{ matrix.node-version }}
|
| 24 |
+
|
| 25 |
+
- name: Backend Tests (with coverage)
|
| 26 |
+
run: |
|
| 27 |
+
rm package-lock.json
|
| 28 |
+
npm install -g npm@latest
|
| 29 |
+
npm install
|
| 30 |
+
npm run build
|
| 31 |
+
npm run test:backend -- --coverage
|
| 32 |
+
|
| 33 |
+
- name: Upload backend coverage report
|
| 34 |
+
if: ${{ always() && hashFiles('coverage/**/coverage-summary.json') != '' }}
|
| 35 |
+
uses: actions/upload-artifact@v4
|
| 36 |
+
with:
|
| 37 |
+
name: backend-coverage-${{ matrix.node-version }}
|
| 38 |
+
path: coverage
|
| 39 |
+
retention-days: 5
|
| 40 |
+
|
| 41 |
+
- name: Publish backend coverage summary
|
| 42 |
+
if: ${{ always() && matrix.node-version == '22.x' }}
|
| 43 |
+
uses: actions/github-script@v7
|
| 44 |
+
with:
|
| 45 |
+
script: |
|
| 46 |
+
const fs = require('fs');
|
| 47 |
+
const path = require('path');
|
| 48 |
+
const globModule = require('glob');
|
| 49 |
+
|
| 50 |
+
const matches = globModule.sync('coverage/**/coverage-summary.json', {
|
| 51 |
+
cwd: process.cwd(),
|
| 52 |
+
ignore: ['**/node_modules/**'],
|
| 53 |
+
});
|
| 54 |
+
|
| 55 |
+
if (!matches.length) {
|
| 56 |
+
core.warning('Coverage summary not found (expected coverage/**/coverage-summary.json). Did Vitest run with --coverage and include the json-summary reporter?');
|
| 57 |
+
return;
|
| 58 |
+
}
|
| 59 |
+
|
| 60 |
+
const summaryPath = path.resolve(matches[0]);
|
| 61 |
+
const summary = JSON.parse(fs.readFileSync(summaryPath, 'utf8'));
|
| 62 |
+
const metrics = ['lines', 'statements', 'branches', 'functions']
|
| 63 |
+
.map((key) => ({
|
| 64 |
+
label: key.charAt(0).toUpperCase() + key.slice(1),
|
| 65 |
+
...summary.total[key],
|
| 66 |
+
}));
|
| 67 |
+
|
| 68 |
+
core.summary
|
| 69 |
+
.addHeading('Backend coverage')
|
| 70 |
+
.addTable([
|
| 71 |
+
['Metric', 'Covered', 'Total', 'Pct'],
|
| 72 |
+
...metrics.map(({ label, covered, total, pct }) => [
|
| 73 |
+
label,
|
| 74 |
+
`${covered}`,
|
| 75 |
+
`${total}`,
|
| 76 |
+
`${pct}%`,
|
| 77 |
+
]),
|
| 78 |
+
])
|
| 79 |
+
.addRaw('Full HTML report is available in the uploaded `backend-coverage-${{ matrix.node-version }}` artifact.')
|
| 80 |
+
.write();
|
| 81 |
+
|
| 82 |
+
api-test:
|
| 83 |
+
name: API tests (node env, api-test)
|
| 84 |
+
runs-on: ubuntu-latest
|
| 85 |
+
timeout-minutes: 10
|
| 86 |
+
|
| 87 |
+
strategy:
|
| 88 |
+
matrix:
|
| 89 |
+
node-version: [22.x]
|
| 90 |
+
|
| 91 |
+
steps:
|
| 92 |
+
- uses: actions/checkout@v4
|
| 93 |
+
|
| 94 |
+
- name: Use Node.js ${{ matrix.node-version }}
|
| 95 |
+
uses: actions/setup-node@v4
|
| 96 |
+
with:
|
| 97 |
+
node-version: ${{ matrix.node-version }}
|
| 98 |
+
|
| 99 |
+
- name: API Test
|
| 100 |
+
run: |
|
| 101 |
+
pip install -r ./tests/ci/requirements.txt
|
| 102 |
+
./tests/ci/api-test.py
|
| 103 |
+
|
| 104 |
+
- uses: actions/upload-artifact@v4
|
| 105 |
+
if: ${{ !cancelled() }}
|
| 106 |
+
with:
|
| 107 |
+
name: (api-test) server-logs
|
| 108 |
+
path: /tmp/backend.log
|
| 109 |
+
retention-days: 3
|
| 110 |
+
|
| 111 |
+
vitest:
|
| 112 |
+
name: puterjs (node env, vitest)
|
| 113 |
+
runs-on: ubuntu-latest
|
| 114 |
+
timeout-minutes: 10
|
| 115 |
+
|
| 116 |
+
strategy:
|
| 117 |
+
matrix:
|
| 118 |
+
node-version: [22.x]
|
| 119 |
+
|
| 120 |
+
steps:
|
| 121 |
+
- uses: actions/checkout@v4
|
| 122 |
+
|
| 123 |
+
- name: Use Node.js ${{ matrix.node-version }}
|
| 124 |
+
uses: actions/setup-node@v4
|
| 125 |
+
with:
|
| 126 |
+
node-version: ${{ matrix.node-version }}
|
| 127 |
+
|
| 128 |
+
- name: Vitest Test
|
| 129 |
+
run: |
|
| 130 |
+
pip install -r ./tests/ci/requirements.txt
|
| 131 |
+
./tests/ci/vitest.py
|
.gitmodules
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
[submodule "submodules/v86"]
|
| 2 |
+
path = submodules/v86
|
| 3 |
+
url = git@github.com:HeyPuter/v86.git
|
| 4 |
+
[submodule "submodules/twisp"]
|
| 5 |
+
path = submodules/twisp
|
| 6 |
+
url = git@github.com:MercuryWorkshop/twisp.git
|
| 7 |
+
[submodule "submodules/epoxy-tls"]
|
| 8 |
+
path = submodules/epoxy-tls
|
| 9 |
+
url = git@github.com:MercuryWorkshop/epoxy-tls.git
|
| 10 |
+
[submodule "submodules/wiki"]
|
| 11 |
+
path = submodules/wiki
|
| 12 |
+
url = https://github.com/HeyPuter/puter.wiki.git
|
.husky/pre-commit
ADDED
|
@@ -0,0 +1 @@
|
|
|
|
|
|
|
| 1 |
+
node tools/validate-eslint.js
|
.idx/dev.nix
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# To learn more about how to use Nix to configure your environment
|
| 2 |
+
# see: https://developers.google.com/idx/guides/customize-idx-env
|
| 3 |
+
{ pkgs, ... }: {
|
| 4 |
+
# Which nixpkgs channel to use.
|
| 5 |
+
channel = "stable-25.05"; # or "unstable"
|
| 6 |
+
|
| 7 |
+
# Use https://search.nixos.org/packages to find packages
|
| 8 |
+
packages = [
|
| 9 |
+
pkgs.python3
|
| 10 |
+
pkgs.nodejs_24
|
| 11 |
+
];
|
| 12 |
+
|
| 13 |
+
# Sets environment variables in the workspace
|
| 14 |
+
env = {};
|
| 15 |
+
idx = {
|
| 16 |
+
# Search for the extensions you want on https://open-vsx.org/ and use "publisher.id"
|
| 17 |
+
extensions = [
|
| 18 |
+
# "vscodevim.vim"
|
| 19 |
+
];
|
| 20 |
+
|
| 21 |
+
# Enable previews and customize configuration
|
| 22 |
+
previews = {
|
| 23 |
+
# Currently disabled because the preview system wasn't working
|
| 24 |
+
enable = false;
|
| 25 |
+
previews = {
|
| 26 |
+
web = {
|
| 27 |
+
command = [
|
| 28 |
+
"npm"
|
| 29 |
+
"run"
|
| 30 |
+
"start"
|
| 31 |
+
"--"
|
| 32 |
+
"--port"
|
| 33 |
+
"$PORT"
|
| 34 |
+
"--host"
|
| 35 |
+
"0.0.0.0"
|
| 36 |
+
"--disable-host-check"
|
| 37 |
+
];
|
| 38 |
+
manager = "web";
|
| 39 |
+
};
|
| 40 |
+
};
|
| 41 |
+
};
|
| 42 |
+
|
| 43 |
+
# Workspace lifecycle hooks
|
| 44 |
+
workspace = {
|
| 45 |
+
# Runs when a workspace is first created
|
| 46 |
+
onCreate = {
|
| 47 |
+
# npm-install = "npm install";
|
| 48 |
+
# Currently disabled because the preview system wasn't working
|
| 49 |
+
};
|
| 50 |
+
# Runs when the workspace is (re)started
|
| 51 |
+
onStart = {
|
| 52 |
+
# npm-install = "npm install";
|
| 53 |
+
# Currently disabled because the preview system wasn't working
|
| 54 |
+
};
|
| 55 |
+
};
|
| 56 |
+
};
|
| 57 |
+
}
|
.idx/icon.png
ADDED
|
|
.is_puter_repository
ADDED
|
File without changes
|
.npmrc
ADDED
|
@@ -0,0 +1 @@
|
|
|
|
|
|
|
| 1 |
+
engine-strict=true
|
.prettierignore
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
node_modules
|
| 2 |
+
dist
|
| 3 |
+
build
|
BUG-BOUNTY.md
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Puter Bug Bounty Program
|
| 2 |
+
|
| 3 |
+
We at **Puter** are committed to maintaining a secure experience for our users and community. We greatly value the contributions of security researchers and welcome responsible disclosure of security issues.
|
| 4 |
+
|
| 5 |
+
## Scope
|
| 6 |
+
|
| 7 |
+
The following are in scope for this program:
|
| 8 |
+
|
| 9 |
+
* **The Puter open-source project** (available at [github.com/HeyPuter](https://github.com/HeyPuter/puter))
|
| 10 |
+
* **`puter.com`**
|
| 11 |
+
* **`api.puter.com`**
|
| 12 |
+
|
| 13 |
+
Out-of-scope:
|
| 14 |
+
|
| 15 |
+
* Third-party services, applications, or libraries not maintained by Puter.
|
| 16 |
+
* Social engineering attacks (e.g., phishing against staff).
|
| 17 |
+
* Denial of Service (DoS), spam, or volumetric attacks.
|
| 18 |
+
* Physical security issues.
|
| 19 |
+
|
| 20 |
+
## Rules of Engagement
|
| 21 |
+
|
| 22 |
+
To participate, you must:
|
| 23 |
+
|
| 24 |
+
1. **Report responsibly**: Provide detailed steps to reproduce the issue, including proof-of-concept code or screenshots where applicable.
|
| 25 |
+
2. **Do no harm**: Do not exfiltrate, modify, or delete data. Only access your own account or test data.
|
| 26 |
+
3. **Respect availability**: Do not perform denial-of-service attacks or automated scans that degrade service.
|
| 27 |
+
4. **Follow disclosure policy**: Do not publicly disclose vulnerabilities until we have confirmed and patched the issue.
|
| 28 |
+
5. **Act in good faith**: Make every effort to avoid privacy violations, destruction of data, and interruption or degradation of services.
|
| 29 |
+
|
| 30 |
+
Reports that do not meet these guidelines may not be eligible for a reward.
|
| 31 |
+
|
| 32 |
+
## Reporting Process
|
| 33 |
+
|
| 34 |
+
To report a vulnerability, email us at: **[security@puter.com](mailto:security@puter.com)**.
|
| 35 |
+
Include:
|
| 36 |
+
|
| 37 |
+
* A description of the vulnerability
|
| 38 |
+
* Steps to reproduce
|
| 39 |
+
* Potential impact
|
| 40 |
+
* Suggested remediation (if available)
|
| 41 |
+
|
| 42 |
+
We aim to acknowledge receipt within **72 hours** and provide a resolution timeline.
|
| 43 |
+
|
| 44 |
+
## Reward Structure
|
| 45 |
+
|
| 46 |
+
We offer monetary rewards based on the severity of the vulnerability, as determined by our internal assessment (using CVSS as a guide).
|
| 47 |
+
|
| 48 |
+
* **Critical: \$1,000 – \$2,000**
|
| 49 |
+
* **High: \$500 – \$1,000**
|
| 50 |
+
* **Medium: \$200 – \$500**
|
| 51 |
+
* **Low: \$50 – \$100**
|
| 52 |
+
|
| 53 |
+
Non-security issues, suggestions, and best practices feedback are always welcome, but may not qualify for a reward.
|
| 54 |
+
If multiple researchers report the same issue, the bounty will be awarded to the first eligible report we receive.
|
| 55 |
+
|
| 56 |
+
## Payments Disclaimer
|
| 57 |
+
|
| 58 |
+
All reward amounts are **guidelines only**. Final decisions about eligibility, severity classification, and payout amount are made at the sole discretion of the Puter security team. We reserve the right to determine whether a report qualifies for a bounty, and whether any payment will be issued at all. Submitting a report does not guarantee compensation.
|
| 59 |
+
|
| 60 |
+
### Payment Method Requirement
|
| 61 |
+
|
| 62 |
+
At this time, **payments will only be made via PayPal**. To be eligible to receive a bounty, researchers must have a valid PayPal account capable of receiving payments. We are unable to process payments through other services or methods at this time.
|
| 63 |
+
|
| 64 |
+
## Legal Safe Harbor
|
| 65 |
+
|
| 66 |
+
If you make a good-faith effort to comply with this policy, we will consider your research to be authorized. If you inadvertently access data outside your own account, stop immediately and include details in your report so we can investigate and remediate.
|
CHANGELOG.md
ADDED
|
@@ -0,0 +1,726 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Changelog
|
| 2 |
+
|
| 3 |
+
## v2.5.1 (2025-02-13)
|
| 4 |
+
|
| 5 |
+
### Puter
|
| 6 |
+
|
| 7 |
+
#### Bug Fixes
|
| 8 |
+
|
| 9 |
+
- phoenix changelog ([0bcbc8f](https://github.com/HeyPuter/puter/commit/0bcbc8f7845de99305f53c6da2bb1f365b87ac50))
|
| 10 |
+
- update package.json ([c2c5d88](https://github.com/HeyPuter/puter/commit/c2c5d883365ae33749709d11e0c2de9050ca144e))
|
| 11 |
+
- oops, no export (putility.libs.event) ([fa4b38c](https://github.com/HeyPuter/puter/commit/fa4b38cd028be4b19ec98bcf588227e0fc92af9d))
|
| 12 |
+
- broken test in putility ([a803d55](https://github.com/HeyPuter/puter/commit/a803d55cfbdd5b15e7fe48df3f4363c1658f0930))
|
| 13 |
+
- parse body before auth for /down ([70fde95](https://github.com/HeyPuter/puter/commit/70fde95255532a7fe0d99c64a4efb1ae625776a4))
|
| 14 |
+
- fix previous fix ([e5c3769](https://github.com/HeyPuter/puter/commit/e5c3769bd813b1510dd0429e1e4eca8e277af7c7))
|
| 15 |
+
- potential fix for /down auth ([390230c](https://github.com/HeyPuter/puter/commit/390230c5a07b1774f84a1b3505f7531ce81dc2cc))
|
| 16 |
+
- allow command provider to not implement complete method ([2000b89](https://github.com/HeyPuter/puter/commit/2000b8909f08d91147b86fce22fe006e0c3152d2))
|
| 17 |
+
- unfixed fix from earlier ([e6fc773](https://github.com/HeyPuter/puter/commit/e6fc7737066d09509f0c7b38e4c51f25e86e12d0))
|
| 18 |
+
- parser error for empty json buffer ([484bb5c](https://github.com/HeyPuter/puter/commit/484bb5c201e17bf45e1a1d97b1e9b2d61d6087dc))
|
| 19 |
+
- fix name and id for openai tool calls ([d2358d2](https://github.com/HeyPuter/puter/commit/d2358d234b45d719a2cc4e92582ed89d2d1832ab))
|
| 20 |
+
- let messages with tool_calls have content=null ([29c0241](https://github.com/HeyPuter/puter/commit/29c024111943267b741b1b4a8933e1ea1a35a65e))
|
| 21 |
+
- repair stream end ([8f27742](https://github.com/HeyPuter/puter/commit/8f277420380e9c6fa8a9925a3e9651f48b8734e6))
|
| 22 |
+
- add type=text ([e2797c3](https://github.com/HeyPuter/puter/commit/e2797c38d0754930033780d5270cc64cbba2c94e))
|
| 23 |
+
- various issues with Mail module ([55d052c](https://github.com/HeyPuter/puter/commit/55d052cfc2549bfdf72f3a8b27cdc7dc4294bc54))
|
| 24 |
+
- buffer incomplete JSON objects from AI stream ([60eef2f](https://github.com/HeyPuter/puter/commit/60eef2fc6734f88df06e2f85db9b9368cc8c227f))
|
| 25 |
+
- mistake in 0c42613 ([8ffd000](https://github.com/HeyPuter/puter/commit/8ffd0004b3b7b34cd6a9c43c6ca960c7a1cbbe15))
|
| 26 |
+
- fix microcents to USD conversion in AIChatService ([dcd47bc](https://github.com/HeyPuter/puter/commit/dcd47bc4cfc5f8a67ea86e0485d08c2417f899ed))
|
| 27 |
+
- claude duplicate messages in stream ([0fac03a](https://github.com/HeyPuter/puter/commit/0fac03a05a4f597f7ed531651c830e44012b646b))
|
| 28 |
+
- skip request-count usage check via AIChatService ([6083e3a](https://github.com/HeyPuter/puter/commit/6083e3ac52fcde7f598c838bc49085e6b3de7162))
|
| 29 |
+
- remove log from InternetModule ([c7f3e0b](https://github.com/HeyPuter/puter/commit/c7f3e0b937f5d72d6f30dba25d7c351e2e14f289))
|
| 30 |
+
- small workaround for duplicate close ([06452f5](https://github.com/HeyPuter/puter/commit/06452f5283085b18266ee7fb89136b9c23879243))
|
| 31 |
+
- race condition and buffer issue in puter.http ([36dc966](https://github.com/HeyPuter/puter/commit/36dc9664ad5520b21c07a1b5c85c8aff7cbe423b))
|
| 32 |
+
- missing some buffer contents in no-keepalive ([3f5b34c](https://github.com/HeyPuter/puter/commit/3f5b34cd341b9063d01baba72e708a9ebb16485b))
|
| 33 |
+
- new edge cases with function calls / tools ([9cbb741](https://github.com/HeyPuter/puter/commit/9cbb741a8ae8ea6b869b6ccf64cd3152b28c2b8c))
|
| 34 |
+
- oops, we're passing negative values; let's just remove this ([cf7aa27](https://github.com/HeyPuter/puter/commit/cf7aa27543700d6268ee709f127e73f7cfe12a5a))
|
| 35 |
+
- oops we still need that ([61824ea](https://github.com/HeyPuter/puter/commit/61824ea04b0cb7611d2acdf45e0a1ecc2856901a))
|
| 36 |
+
- remove hard-coded token limit for OpenAI ([8143e57](https://github.com/HeyPuter/puter/commit/8143e5700f53279a5a18d21b7c5466f3b9bb6ce6))
|
| 37 |
+
- wisp relay authentication ([6f39365](https://github.com/HeyPuter/puter/commit/6f39365b24cda53a6cac7e203b9d8cbc09bb0ba3))
|
| 38 |
+
- reduce code paths for querystrings ([e8f5450](https://github.com/HeyPuter/puter/commit/e8f5450cb05213c3c06802442103f5c414eee5cc))
|
| 39 |
+
- icons ([d03952b](https://github.com/HeyPuter/puter/commit/d03952b23712ae8a61c7f2c7582d297691e0ecc1))
|
| 40 |
+
- subdomains to deleted files tried to deref fs node ([38ccc82](https://github.com/HeyPuter/puter/commit/38ccc82c8e95636ee4b7c5ca2f761098f12affa2))
|
| 41 |
+
- app icon empty string should be skipped ([37ca892](https://github.com/HeyPuter/puter/commit/37ca89228cc2f978602098ee4aae1ecb3d333526))
|
| 42 |
+
- save_account case for disable_user_signup ([766c235](https://github.com/HeyPuter/puter/commit/766c235cc738051588a67ff5ab4230e76b64173c))
|
| 43 |
+
- use .get() for Map lookup. fix: correctly set url and url_paths. fix: null check to throw error. ([78ac033](https://github.com/HeyPuter/puter/commit/78ac033a1ca4f51b71c2bcb185b305903f7be495))
|
| 44 |
+
- ensure puter.signup emit resolves ([113ed31](https://github.com/HeyPuter/puter/commit/113ed31336c494a3f7a9e744a34de35b3785c033))
|
| 45 |
+
- --onlycase param broke cartesian tests ([d9822a4](https://github.com/HeyPuter/puter/commit/d9822a4f09e3e0c5fbed8c655435f534af949290))
|
| 46 |
+
- empty response when mkdir is a no-op ([f359ae1](https://github.com/HeyPuter/puter/commit/f359ae193e87552b3a2e2aafa3fda389478fca38))
|
| 47 |
+
- mkdir with create_missing when some parents exist ([807c3ba](https://github.com/HeyPuter/puter/commit/807c3ba5eca02f69b5e6ce547420312b68c7993f))
|
| 48 |
+
- possible out-or-order response objects from batch ([fb70251](https://github.com/HeyPuter/puter/commit/fb7025164e3f42cae1365ec65960019b24f4360d))
|
| 49 |
+
- app data check error in write ([5ef75e5](https://github.com/HeyPuter/puter/commit/5ef75e5df35ae95242da97235512495b7585bd0d))
|
| 50 |
+
- missing parent dirs created in move ([9d9d97f](https://github.com/HeyPuter/puter/commit/9d9d97fd0074058506b0506d5027b0c6b8a26845))
|
| 51 |
+
- missing changes to run-selfhosted.js ([6f4b1bf](https://github.com/HeyPuter/puter/commit/6f4b1bf94a031b3324f5ecd51557b1298a1c3175))
|
| 52 |
+
- appease mocha's import requirements ([d6bbba7](https://github.com/HeyPuter/puter/commit/d6bbba7bf064991d59fbfe74db5221e0118a781c))
|
| 53 |
+
- error msg for invalid puter-ocr urls ([6a6bfa0](https://github.com/HeyPuter/puter/commit/6a6bfa034fe16dba7172ab5adbf23f00df38301d))
|
| 54 |
+
- improper 500 in wisp token verify ([75aaaa6](https://github.com/HeyPuter/puter/commit/75aaaa66a8c7df00e1fb80c353d890269296839c))
|
| 55 |
+
- actor param in legacy /write ([7aa886d](https://github.com/HeyPuter/puter/commit/7aa886d573362e6739bd99bbed02f4831557ccb4))
|
| 56 |
+
- new desktop height calculation when resizing browser window ([a295420](https://github.com/HeyPuter/puter/commit/a295420f58326b04c976cf92bd2d582d2eafa71b))
|
| 57 |
+
- circular imports ([8fabf01](https://github.com/HeyPuter/puter/commit/8fabf014a9eb783183e87489ae2b6c6bbc42c99a))
|
| 58 |
+
- test and improve boolify ([44ad3c5](https://github.com/HeyPuter/puter/commit/44ad3c578106d2b01007240188db57760c15af96))
|
| 59 |
+
- skip test files in mod lib loading ([f60c008](https://github.com/HeyPuter/puter/commit/f60c008158127458e02e3bb92287617d9f1f9514))
|
| 60 |
+
- shortcut issue ([6d196d5](https://github.com/HeyPuter/puter/commit/6d196d59f026bec4acb0296d8f0f38c7cee2e8c2))
|
| 61 |
+
- test for get-launch-apps ([740fdb5](https://github.com/HeyPuter/puter/commit/740fdb592e494bf5b197493774cef6559bfb50b9))
|
| 62 |
+
- add package-lock.json ([3097b86](https://github.com/HeyPuter/puter/commit/3097b86597218de9e59b450b70185634a94be210))
|
| 63 |
+
- try redundant npm install after build stage ([8963eb0](https://github.com/HeyPuter/puter/commit/8963eb0c4f1220dd515ac6ed7a2a8f1de26655ae))
|
| 64 |
+
- I'ma buy GitHub a coffee and spill it on their servers if this works ([686d3de](https://github.com/HeyPuter/puter/commit/686d3de518e6e090d683294ad3dd856db26856a0))
|
| 65 |
+
- oh, right; there's two of them ([a13af7e](https://github.com/HeyPuter/puter/commit/a13af7e31aa4cd36457a90a7d75878b6d39ba73b))
|
| 66 |
+
|
| 67 |
+
## v2.5.0 (2025-01-07)
|
| 68 |
+
|
| 69 |
+
### Puter
|
| 70 |
+
|
| 71 |
+
#### Features
|
| 72 |
+
|
| 73 |
+
- hash-based distributed cache inval ([d386096](https://github.com/HeyPuter/puter/commit/d38609646793a5a14b8af96964fc7176725a0531))
|
| 74 |
+
- add Escape key functionality to UIPrompt for closing the prompt ([e1b6c83](https://github.com/HeyPuter/puter/commit/e1b6c83813d03809aba0abdecbf6de5529728031))
|
| 75 |
+
- set max token to 8096 ([b2ea8a3](https://github.com/HeyPuter/puter/commit/b2ea8a3888c5496858d257018071ba54abd6f4a8))
|
| 76 |
+
- added tagify in Filetype-Association input in dev center ([0cd1f15](https://github.com/HeyPuter/puter/commit/0cd1f151b5986ede431f1792139fa1a5471ae059))
|
| 77 |
+
- add reset edit changes button to dev-center ([55ffd80](https://github.com/HeyPuter/puter/commit/55ffd801e007723758eacc17ec732ee5a336123e))
|
| 78 |
+
- enable/disable save button in dev-center iff changes made ([63a0053](https://github.com/HeyPuter/puter/commit/63a0053da8c76bf4ac175c7f17353225443dd342))
|
| 79 |
+
- record signup metadata for abuse prevention ([66016b9](https://github.com/HeyPuter/puter/commit/66016b9db602ca85e8f0ddc846865d4641e64190))
|
| 80 |
+
- add support for categories in the Dev Center ([7cf215a](https://github.com/HeyPuter/puter/commit/7cf215ab677e3fc912a3bd1ac52795c1e8860c32))
|
| 81 |
+
- puter.js's showSpinner() will keep the spinner active for at least 1200ms ([fc5aca1](https://github.com/HeyPuter/puter/commit/fc5aca1f72de22c1530054272b55a59021ba9caa))
|
| 82 |
+
- allow developers to set social media images for their apps ([be36d31](https://github.com/HeyPuter/puter/commit/be36d31509280340e2a62a8c478b1e64617792a4))
|
| 83 |
+
- automatically open the browser when starting Puter ([2d43129](https://github.com/HeyPuter/puter/commit/2d4312972a1377a64732694811fe889f59573432))
|
| 84 |
+
- spinner for the `showWorking()` overlay in puter.js ([1062363](https://github.com/HeyPuter/puter/commit/1062363096418f164a6d00ed8872770ff64237b5))
|
| 85 |
+
- show profile pics in sharing notifications ([0e45132](https://github.com/HeyPuter/puter/commit/0e45132c05aa1106503fef02b7e4c97ecc675e10))
|
| 86 |
+
- Implement profile pictures ([0885937](https://github.com/HeyPuter/puter/commit/0885937f033caf35503eeb9e65bb390952992faf))
|
| 87 |
+
- allow `launchApp` to open explorer at a specific path ([8fefd4a](https://github.com/HeyPuter/puter/commit/8fefd4a61f0005d4f3ec2e43f7249f3edd91c837))
|
| 88 |
+
- Require email confirmation before sharing ([cdd1a8c](https://github.com/HeyPuter/puter/commit/cdd1a8c4e379b885ff48a874ae5577d2f0efae06))
|
| 89 |
+
- show unread notification count in the browser tab's title ([045259c](https://github.com/HeyPuter/puter/commit/045259cefbe24e3f52fe3840e4975d3243e99957))
|
| 90 |
+
- in Share window, display access level next to recipient ([cf4b6aa](https://github.com/HeyPuter/puter/commit/cf4b6aa1c24d936f9a42ca1e2945eea40939c970))
|
| 91 |
+
- when sharing, users can choose between 'viewer' and 'editor' for permissions ([0cbe013](https://github.com/HeyPuter/puter/commit/0cbe0139d7f306ce62992f1eda94d99e09b32df8))
|
| 92 |
+
- handle `notif.ack` in desktop ([a6650ee](https://github.com/HeyPuter/puter/commit/a6650ee2d8074aeb7c476e5572334853f1b6d7e8))
|
| 93 |
+
- add error handling to the share flow ([b5bb95e](https://github.com/HeyPuter/puter/commit/b5bb95e2d7f6021a6341e26cf15d5449ada48830))
|
| 94 |
+
- search ([55d2af1](https://github.com/HeyPuter/puter/commit/55d2af189e9479fb5980ce149ce74e890b325014))
|
| 95 |
+
- search endpoint ([b589512](https://github.com/HeyPuter/puter/commit/b589512c9dedec22fd41b92cbba2570042149873))
|
| 96 |
+
- the `socialLink` UI component ([1adfe5c](https://github.com/HeyPuter/puter/commit/1adfe5c70947d9de008c9d601f91b1ee14128d5d))
|
| 97 |
+
- Reaload App option in the window title bar context menu ([27c01c9](https://github.com/HeyPuter/puter/commit/27c01c9bd991ef871153eb5931f78fec265a62e4))
|
| 98 |
+
- add puter.auth.whoami() ([da0022a](https://github.com/HeyPuter/puter/commit/da0022abf0f880c7b52d2cd937ef9d1298fc09cc))
|
| 99 |
+
- add puter.log ([755736e](https://github.com/HeyPuter/puter/commit/755736edee9baa783be9b7d96083d908a2f2f750))
|
| 100 |
+
- collapsible sidebar menu in Dev Center ([1056231](https://github.com/HeyPuter/puter/commit/1056231004a629f3f76f2525ec7d83b67d3d7fa5))
|
| 101 |
+
- customize the order of Explorer sidebar items ([ff30de1](https://github.com/HeyPuter/puter/commit/ff30de1d6947e4692b5cf0da2e19ab37aacf1ec8))
|
| 102 |
+
- add extension API for modules ([14d45a2](https://github.com/HeyPuter/puter/commit/14d45a27edb99f63b4f6e010221e3a0880ae246d))
|
| 103 |
+
- first extension that implements a custom user options menu ([fc5e15f](https://github.com/HeyPuter/puter/commit/fc5e15f2a6d4eb5e5847fa7f2dd87b1fa382fc7c))
|
| 104 |
+
- add support for extensions ([b018571](https://github.com/HeyPuter/puter/commit/b018571a86f4114eab9b5edde4ecd87e343d22a7))
|
| 105 |
+
- add an 'Upload' button at the bottom of `OpenFilePicker` ([54ae69b](https://github.com/HeyPuter/puter/commit/54ae69b7b76016307c3b92437ca06dc2aa1eddb9))
|
| 106 |
+
- Allow apps to toggle `credentialless` via Dev Center ([af511c0](https://github.com/HeyPuter/puter/commit/af511c05e3ddddcce661c5406d5c831a21689608))
|
| 107 |
+
- add config for blocked email domains ([955b087](https://github.com/HeyPuter/puter/commit/955b087297f829b11b82dc9bd79a0e03721c5f33))
|
| 108 |
+
- add support for `fadeIn` effect for `UIWindow` ([13248a9](https://github.com/HeyPuter/puter/commit/13248a99bfa318e84cb99e2954a5f46805eda34f))
|
| 109 |
+
- welcome screen to quickly explain what Puter is ([564ff65](https://github.com/HeyPuter/puter/commit/564ff65363258cab4196b967dd556105e424d48c))
|
| 110 |
+
- v86 9p server support ([b145e30](https://github.com/HeyPuter/puter/commit/b145e30a90ff2f0d44d89f83dbda4de1bf2991d4))
|
| 111 |
+
- support readdir for directory symlinks ([7f1b870](https://github.com/HeyPuter/puter/commit/7f1b870d302421972c4f6221ae6d93b5979d51dd))
|
| 112 |
+
- allow passing cli args via url ([5317adf](https://github.com/HeyPuter/puter/commit/5317adf8a4961be3f0ca2a8c403c922633f934fa))
|
| 113 |
+
- add -c flag for phoenix ([b6c0cb6](https://github.com/HeyPuter/puter/commit/b6c0cb6abc1c29846b4b7e696812476bea24bbc7))
|
| 114 |
+
- translate README.md to Dutch ([31e2773](https://github.com/HeyPuter/puter/commit/31e2773743c336630c917e893b0148441f5fc515))
|
| 115 |
+
- add connectToInstance method to puter.ui ([62634b0](https://github.com/HeyPuter/puter/commit/62634b0afe4d33da08768975322d4deb23041442))
|
| 116 |
+
- add method to list models ([fd86934](https://github.com/HeyPuter/puter/commit/fd86934bc9021541810447cf7e2a5f33b3e283b3))
|
| 117 |
+
- add streaming to XHR driver client ([7600d9b](https://github.com/HeyPuter/puter/commit/7600d9b07c5b719d529f8a48c38d9178efefa266))
|
| 118 |
+
- add writable attribute to fs items ([2386d87](https://github.com/HeyPuter/puter/commit/2386d87229aa6205ef8ced6563371ab40a0def62))
|
| 119 |
+
- report feature flags in /whoami ([4561b89](https://github.com/HeyPuter/puter/commit/4561b8937de025471c2dfb1771465d779cefab5d))
|
| 120 |
+
- make public folders a config opt-in ([209555c](https://github.com/HeyPuter/puter/commit/209555c1d93845fa129bea450f9c25d595a3c60f))
|
| 121 |
+
- add feature flag for /share ([461ea3e](https://github.com/HeyPuter/puter/commit/461ea3eae6ad32bf34c43a822de7a06f08efb556))
|
| 122 |
+
- add message encryption between Puter peers ([cea2964](https://github.com/HeyPuter/puter/commit/cea29645fec493020a4f66e378b087fa17ae03d4))
|
| 123 |
+
- add test_mode flag ([9a9bd5e](https://github.com/HeyPuter/puter/commit/9a9bd5eaf0aca8fd1cc57455db03dba55801d5a0))
|
| 124 |
+
- add tts driver to puterai module ([78fa77d](https://github.com/HeyPuter/puter/commit/78fa77d9200e0b9fafc4014f8d0cb08c74cd16cb))
|
| 125 |
+
- add image generation driver to puterai module ([fb26fdb](https://github.com/HeyPuter/puter/commit/fb26fdbc561d5545d28352427553695cd3237ad5))
|
| 126 |
+
- add chat completions driver to puterai module ([4e3bd18](https://github.com/HeyPuter/puter/commit/4e3bd1831e92e83ce9b4e30a16afd562b0221dd8))
|
| 127 |
+
- add --overwrite-config and configurable uuid masking ([ef6671d](https://github.com/HeyPuter/puter/commit/ef6671da18f6841cb2143808fe21586ac3505942))
|
| 128 |
+
- add textract driver to puterai module ([f924d48](https://github.com/HeyPuter/puter/commit/f924d48b02f39884931db45a05dd61b65f2cee4a))
|
| 129 |
+
- add password reset from server console ([984ae9e](https://github.com/HeyPuter/puter/commit/984ae9e6a23da17414e43d58fc0e861827031269))
|
| 130 |
+
- add server command to scan permissions ([54471fa](https://github.com/HeyPuter/puter/commit/54471fada946a70eaa0df6bfceae995bc4e5848c))
|
| 131 |
+
- grant user driver perms from admin ([c9ded89](https://github.com/HeyPuter/puter/commit/c9ded89b22bb822c20aea379a17a8bdf74a658de))
|
| 132 |
+
- replace default_user with admin ([f0c36a1](https://github.com/HeyPuter/puter/commit/f0c36a1cdf16f11765c29360a5c38140008b90c7))
|
| 133 |
+
- add system user ([ab15629](https://github.com/HeyPuter/puter/commit/ab156297a746c0754145c2abdb2c99bb1b30651a))
|
| 134 |
+
- add options to disable winston and devwatch ([5d5f566](https://github.com/HeyPuter/puter/commit/5d5f5660b4020650b68b79ccf3860d3fb0bf98a9))
|
| 135 |
+
- add new file templates ([1f7f094](https://github.com/HeyPuter/puter/commit/1f7f094282fae915a2436701cfb756444cd3f781))
|
| 136 |
+
- add cross_origin_isolation option ([e539932](https://github.com/HeyPuter/puter/commit/e53993207077aecd2c01712519251993bb2562bc))
|
| 137 |
+
- add option to disable temporary users ([f9333b3](https://github.com/HeyPuter/puter/commit/f9333b3d1e05bd0dffaecd2e29afd08ea61559fc))
|
| 138 |
+
- add some default groups ([ba50d0f](https://github.com/HeyPuter/puter/commit/ba50d0f96d58075abec067d24e6532bd874093f0))
|
| 139 |
+
- Add support for dropping multiple Puter items onto Dev Center (close #311) ([8e7306c](https://github.com/HeyPuter/puter/commit/8e7306c23be01ee6c31cdb4c99f2fb1f71a2247f))
|
| 140 |
+
|
| 141 |
+
#### Translations
|
| 142 |
+
|
| 143 |
+
|
| 144 |
+
- complete Hungarian translation of Puter #972 ([7d2787d](https://github.com/HeyPuter/puter/commit/7d2787d26b3a64cbc128fb2cb3871b43b41912fe))
|
| 145 |
+
- add missing Igbo translations for billing-related terms ([f0f19e7](https://github.com/HeyPuter/puter/commit/f0f19e727e574a8558fcbbf27ba501f434db69f8))
|
| 146 |
+
- Complete the Vietnamese translation of Puter #954 ([56489c3](https://github.com/HeyPuter/puter/commit/56489c33f611fc053096b455e4cb7b3d8f20852c))
|
| 147 |
+
- Complete the French (Français) translation of Puter #975 ([c840bc8](https://github.com/HeyPuter/puter/commit/c840bc8161055b90e040bdae3196817e0791ecf5))
|
| 148 |
+
- Complete the German (Deutsch) translation of Puter ([05fef67](https://github.com/HeyPuter/puter/commit/05fef6749e8d80f13ab94a4e0ea49ce4972a0961))
|
| 149 |
+
- (#954) Add Vietnamese translations for billing-related terms ([267a55a](https://github.com/HeyPuter/puter/commit/267a55aae50f87edb483abb375029ff79e736112))
|
| 150 |
+
- add vietnamese translations for billing in vi.js ([3e26dbe](https://github.com/HeyPuter/puter/commit/3e26dbe6a0411fe75c36cf2866d34f28a2dcb553))
|
| 151 |
+
- added a few Korean translatations ([b23e800](https://github.com/HeyPuter/puter/commit/b23e800f4e70f162b52cc15053d03961a37033bb))
|
| 152 |
+
- add brazillian translations for billing-related terms in br.js (revision) ([fdfc90a](https://github.com/HeyPuter/puter/commit/fdfc90a9317a19d45a0b2b3ad283be9a10a92732))
|
| 153 |
+
- add brazillian translations for billing-related terms in br.js ([e66df14](https://github.com/HeyPuter/puter/commit/e66df14862e6dd7278623279e43e2189e7ddafe5))
|
| 154 |
+
- Add Indonesian Translation for i18n ([033643b](https://github.com/HeyPuter/puter/commit/033643b0e757b51ea0be90e2198bbec65d31cfc5))
|
| 155 |
+
- add Polish translations for billing-related terms ([15f9ade](https://github.com/HeyPuter/puter/commit/15f9aded26eaa4c630fe948350d3a53cdb0278a3))
|
| 156 |
+
- update Urdu localization with missing translations ([0c4b994](https://github.com/HeyPuter/puter/commit/0c4b9946442ad92549522fcd91ea6aefbb9f19d6))
|
| 157 |
+
- Update ig.js ([382fb24](https://github.com/HeyPuter/puter/commit/382fb24dbb1737a8a54ed2491f80b2e2276cde61))
|
| 158 |
+
- feat: add vietnamese localization-a ([c2d3d69](https://github.com/HeyPuter/puter/commit/c2d3d69dbe33f36fcae13bcbc8e2a31a86025af9))
|
| 159 |
+
- Update zhtw.js, Complete Traditional Chinese translation based on English file #550 ([b9e73b7](https://github.com/HeyPuter/puter/commit/b9e73b7288aebb14e6bbf1915743e9157fc950b1))
|
| 160 |
+
- update zhtw.js to match en.js ([37fd666](https://github.com/HeyPuter/puter/commit/37fd666a9a6788d5f0c59311499f29896b48bc82))
|
| 161 |
+
- Add Tamil translation to translations.js ([8a3d043](https://github.com/HeyPuter/puter/commit/8a3d0430f39f872b8a460c344cce652c340b700b))
|
| 162 |
+
- Move Tamil translation to the rest of translations ([333d6e3](https://github.com/HeyPuter/puter/commit/333d6e3b651e460caca04a896cbc8c175555b79b))
|
| 163 |
+
- Translation improvements, mainly style and context-based ([8bece96](https://github.com/HeyPuter/puter/commit/8bece96f6224a060d5b408e08c58865fadb8b79c))
|
| 164 |
+
- update translation file es.js to be up to date with the file en.js ([1515278](https://github.com/HeyPuter/puter/commit/151527825f1eb4b060aaf97feb7d18af4fcddbf2))
|
| 165 |
+
- Translate en.js as of 2024-07-10 ([8e297cd](https://github.com/HeyPuter/puter/commit/8e297cd7e30757073e2f96593c363a273b639466))
|
| 166 |
+
- Create hu.js hungarian language ([69a80ab](https://github.com/HeyPuter/puter/commit/69a80ab3d2c94ee43d96021c3bcbdab04a4b5dc6))
|
| 167 |
+
- Update translations.js to Hungarian lang ([56820cf](https://github.com/HeyPuter/puter/commit/56820cf6ee56ff810a6b495a281ccbb2e7f9d8fb))
|
| 168 |
+
- Tamil translation ([81781f8](https://github.com/HeyPuter/puter/commit/81781f80afc07cd1e6278906cdc68c8092fbfedf))
|
| 169 |
+
- Update it.js ([84e31ef](https://github.com/HeyPuter/puter/commit/84e31eff2f58584d8fab7dd10606f2f6ced933a2))
|
| 170 |
+
- Update Armenian translation file ([3b8af7c](https://github.com/HeyPuter/puter/commit/3b8af7cc5c1be8ed67be827360bbfe0f0b5027e9))
|
| 171 |
+
- correct Igbo translation for "Free" in billing terms ([6f4d57a](https://github.com/HeyPuter/puter/commit/6f4d57a3c6da607038f4fbe49c691478f47933be))
|
| 172 |
+
|
| 173 |
+
#### Bug Fixes
|
| 174 |
+
|
| 175 |
+
- missing ll_copy import ([8a9164d](https://github.com/HeyPuter/puter/commit/8a9164d7c5380aafb864b56ca1a3ee59f24daf38))
|
| 176 |
+
- bad uuid reference to resourceService ([13003c4](https://github.com/HeyPuter/puter/commit/13003c486fbebad0f26dd1b569f5fd5f2cefc9e7))
|
| 177 |
+
- allow localhost for development ([ad8a397](https://github.com/HeyPuter/puter/commit/ad8a3978c07e44f7a534981ddd65bc131c9aac6b))
|
| 178 |
+
- rewrite confusing log message ([dacbbf0](https://github.com/HeyPuter/puter/commit/dacbbf033dcc0f4506198761eab3bfb6ef915336))
|
| 179 |
+
- AppInformationService initialization ([2332602](https://github.com/HeyPuter/puter/commit/233260233c4e52399541aedbf8b13800de80d3fd))
|
| 180 |
+
- dev center app icon SVG issue ([47a4313](https://github.com/HeyPuter/puter/commit/47a4313d92152b9e5b4036715ac4f19431be8940))
|
| 181 |
+
- app icon double-encode bug ([23eab63](https://github.com/HeyPuter/puter/commit/23eab63776a146a78b10e973518158fc07b13653))
|
| 182 |
+
- first read of recommended apps ([a6b9d33](https://github.com/HeyPuter/puter/commit/a6b9d33d27909ead3d14eff4446062d62aad4651))
|
| 183 |
+
- prefix peer addresses with protocol ([efd4730](https://github.com/HeyPuter/puter/commit/efd4730f757471c3eac2d5e396dd69b619ad2999))
|
| 184 |
+
- clone message object ([728ecbf](https://github.com/HeyPuter/puter/commit/728ecbfb033082186ca9480f2ab2d1607b57ca5a))
|
| 185 |
+
- timing for PrefixLogger call to /whoami ([2dc6c47](https://github.com/HeyPuter/puter/commit/2dc6c4737b9ec9db281b4b32ed4bd20ac490e47d))
|
| 186 |
+
- try catching icon read errors before stream ([e56a62c](https://github.com/HeyPuter/puter/commit/e56a62c5390958e585f299751bafd13becc1c9b6))
|
| 187 |
+
- try catching on stream_to_buffer ([ada051b](https://github.com/HeyPuter/puter/commit/ada051b9b87e945b4a80c1fae99b8c5644b82dc0))
|
| 188 |
+
- check if row.timestamp is Date ([5d049e8](https://github.com/HeyPuter/puter/commit/5d049e8f06dafe2e499ccfea66ef013a9b595396))
|
| 189 |
+
- AppES PD alert ([f14e1fe](https://github.com/HeyPuter/puter/commit/f14e1fefcf18438bd59eb86d625b8c5a6fb3ffc5))
|
| 190 |
+
- fix for previous fix ([648d6e0](https://github.com/HeyPuter/puter/commit/648d6e036d6f8040a1e440c1e76dc9dcc746156f))
|
| 191 |
+
- fix fallback icon behavior in get_icon_stream ([4f3a161](https://github.com/HeyPuter/puter/commit/4f3a1618b10dd393f5c94c0967beb228a593b214))
|
| 192 |
+
- revert test change ([9c86614](https://github.com/HeyPuter/puter/commit/9c86614df5d58ca0385450e1edb5adb5b6d72300))
|
| 193 |
+
- acl check for subdomain on access ([c69006e](https://github.com/HeyPuter/puter/commit/c69006e1852befa93f94a7c45651025214941a4e))
|
| 194 |
+
- attempt fix for prod issue with app icons ([925ebd5](https://github.com/HeyPuter/puter/commit/925ebd531013e36ee5c05d53ef229d314fb89435))
|
| 195 |
+
- remove redundant notification query ([f87769b](https://github.com/HeyPuter/puter/commit/f87769b445d53e6322a55a788e26d38629299ae9))
|
| 196 |
+
- share only emails email_confirmed recipients ([2336a62](https://github.com/HeyPuter/puter/commit/2336a62b4f635c025b02bb7efe91b5ddf58bae25))
|
| 197 |
+
- database issue with KBKV update ([7ba1b76](https://github.com/HeyPuter/puter/commit/7ba1b7656b5e24375cad639b9a8e37577b526c09))
|
| 198 |
+
- taskbar items of apps should always appear before Trash ([94e7f5d](https://github.com/HeyPuter/puter/commit/94e7f5deb4330a844a680c22f55b8753225a1a7e))
|
| 199 |
+
- fullpage mode ([65d9188](https://github.com/HeyPuter/puter/commit/65d918866ea0ee981bc26151332b730abccb7be8))
|
| 200 |
+
- bug in writeFile rename ([298609c](https://github.com/HeyPuter/puter/commit/298609c6e9080e00c90b66c673e104d90f9d3ed0))
|
| 201 |
+
- remove unnecessary `item_path` definition in `delete` fs api ([c792f4a](https://github.com/HeyPuter/puter/commit/c792f4a345b307d024f73ff2817ae473b2620913))
|
| 202 |
+
- add missing permissions ([69e9df1](https://github.com/HeyPuter/puter/commit/69e9df1ae21cf906dfcc3d9d7a23455e5274271c))
|
| 203 |
+
- logic from previous commit ([6ca7011](https://github.com/HeyPuter/puter/commit/6ca701139a07a0d20071cf1532cc6e95639a01da))
|
| 204 |
+
- add fallback moderation in case openai goes down ([c6e814d](https://github.com/HeyPuter/puter/commit/c6e814daa80eec01c10f319ebebcb84c42cd26e1))
|
| 205 |
+
- permission strings for ES services ([4d9cc9b](https://github.com/HeyPuter/puter/commit/4d9cc9bd830d0c73024f2bc5a91ab226aedefded))
|
| 206 |
+
- resolve issue #983 - Stuck on Creating new app loading screen ([c75c9d0](https://github.com/HeyPuter/puter/commit/c75c9d03833af52730cac89a8fee5f5c317f0f78))
|
| 207 |
+
- provide actor context to ws event ([1b57801](https://github.com/HeyPuter/puter/commit/1b578019f915918e51185f5705d7fa6e0328b9ae))
|
| 208 |
+
- context error in user connected event ([9600823](https://github.com/HeyPuter/puter/commit/96008233ba4935e789cd092c07aa8b351cb44d45))
|
| 209 |
+
- signup 500 for temp user ([01395f3](https://github.com/HeyPuter/puter/commit/01395f302e763cdad022c0e5a995869fcd805d86))
|
| 210 |
+
- bad import for TeePromise ([acf8ae3](https://github.com/HeyPuter/puter/commit/acf8ae302ec4ee79c11c2b0e810edd53f21446c5))
|
| 211 |
+
- sorting bug in AIChatService ([7acb096](https://github.com/HeyPuter/puter/commit/7acb096addd58113cc8d4338ba941cd14ac81f4f))
|
| 212 |
+
- test issues from contextlink removal ([545e7db](https://github.com/HeyPuter/puter/commit/545e7db5bdac6e39962390469767667bc62857fd))
|
| 213 |
+
- add missing import ([e279dc6](https://github.com/HeyPuter/puter/commit/e279dc6e5f4095550f41aadd194ea94e1e2a2271))
|
| 214 |
+
- fake_chat default model and usage errors ([13a895b](https://github.com/HeyPuter/puter/commit/13a895b76b1e5a677c2eeeb0a07be6ce9fd02a99))
|
| 215 |
+
- update test kernel ([a1c2226](https://github.com/HeyPuter/puter/commit/a1c2226561655e091cbc0d014ada62bfc7881f2a))
|
| 216 |
+
- correct AI comment faults ([b40d453](https://github.com/HeyPuter/puter/commit/b40d4534a71565a7f2d0ae278c98d7326c5aa963))
|
| 217 |
+
- update package-lock.json ([8577185](https://github.com/HeyPuter/puter/commit/857718538b8a7bf27dc036f4eeb3728cb6ea96e7))
|
| 218 |
+
- ignore two calls with undefined origin ([ab4ba76](https://github.com/HeyPuter/puter/commit/ab4ba76433ac623abaa17c0e5dd024e95b9fef3f))
|
| 219 |
+
- undefined APIOrigin ([340c7a8](https://github.com/HeyPuter/puter/commit/340c7a821fb91e2d106c2b3febf8182de7b21f7d))
|
| 220 |
+
- add id to the setting menu item in user option menu ([67ca4cc](https://github.com/HeyPuter/puter/commit/67ca4ccf20fd714848121192d5ae7c41f3763da4))
|
| 221 |
+
- add an id to `My Websites` content menu item ([e662c78](https://github.com/HeyPuter/puter/commit/e662c782b745f4f98024d1353a6a162d5fe58c44))
|
| 222 |
+
- remove unnecessary `integrity` and `crossorigin` attributes in dev center when linking to jquery ([8dec78b](https://github.com/HeyPuter/puter/commit/8dec78b090ec4434ad77003d6f3c25de98779864))
|
| 223 |
+
- remove inactive links in README ([f3d270c](https://github.com/HeyPuter/puter/commit/f3d270ccbcd8990270cf968a3638b7affa2df6ba))
|
| 224 |
+
- improve backend mod error handling ([fe1a4cf](https://github.com/HeyPuter/puter/commit/fe1a4cfd4d5dd1eddbb2d50ef3f5ebf78a81656d))
|
| 225 |
+
- app query should return app metadata ([3cedd17](https://github.com/HeyPuter/puter/commit/3cedd17b8ed4acb1099bc2e87aba0137339c8a17))
|
| 226 |
+
- safe parsing of app metadata ([a2c7b37](https://github.com/HeyPuter/puter/commit/a2c7b379f8181b373b0513d9166f75adc147aafa))
|
| 227 |
+
- configuration for browser launch ([791f774](https://github.com/HeyPuter/puter/commit/791f7748c7c1959f63327a73a7e24e41b574a910))
|
| 228 |
+
- previous fix ([ee7bedd](https://github.com/HeyPuter/puter/commit/ee7bedd5586d69ce74f32c1400f377d6a8971eaa))
|
| 229 |
+
- always adapt model for ClaudeEnough ([56710e1](https://github.com/HeyPuter/puter/commit/56710e17f3b06eef07e54c243f6b725fcc4a4583))
|
| 230 |
+
- automatically open browser when starting only if in dev env ([f500fb4](https://github.com/HeyPuter/puter/commit/f500fb47061f8f3a3dc7d871cb529f5c0b058185))
|
| 231 |
+
- image generation supports test mode ([f533dca](https://github.com/HeyPuter/puter/commit/f533dca1a6d88ca7a14bd69f15d0a151e24c58e1))
|
| 232 |
+
- share issue with prefix usernames ([d30d62f](https://github.com/HeyPuter/puter/commit/d30d62f558ca5f8c74090900aa39c13ca3ca1d2e))
|
| 233 |
+
- permission grants in open_item ([16257a7](https://github.com/HeyPuter/puter/commit/16257a7b5459550ee3782cf32c87a8241325878d))
|
| 234 |
+
- sharing notification click opening directories ([bfacfc2](https://github.com/HeyPuter/puter/commit/bfacfc2a4e4b50c9e0842f9f2d56de67a598b959))
|
| 235 |
+
- add placeholders ([2c86240](https://github.com/HeyPuter/puter/commit/2c862403994ff6385144841db07dcc94c5c2fc2e))
|
| 236 |
+
- capitalize `Hindi` in i18n ([35fd158](https://github.com/HeyPuter/puter/commit/35fd15854ad3cc92924c4ded752e337f467a7125))
|
| 237 |
+
- give camera and recorder write permission to Desktop ([65e6d6c](https://github.com/HeyPuter/puter/commit/65e6d6c09fd464b3fea979689fab5f26a2647c4a))
|
| 238 |
+
- potential null-or-undefined in DriverService ([01725ff](https://github.com/HeyPuter/puter/commit/01725ffebf86ed332087c877956e59570ea700ed))
|
| 239 |
+
- usage bug ([0fd3b1e](https://github.com/HeyPuter/puter/commit/0fd3b1e61157d989d55e6dacba2add0e03d260e7))
|
| 240 |
+
- update share email ([7e7234b](https://github.com/HeyPuter/puter/commit/7e7234b2f3fb89560108447cfd7fa87499ec6f38))
|
| 241 |
+
- allow scrolling of user list in share window ([905b5d8](https://github.com/HeyPuter/puter/commit/905b5d851ef68d923d8f7fbaddbe214cb812bae6))
|
| 242 |
+
- mobile detection ([b11016d](https://github.com/HeyPuter/puter/commit/b11016dab321717f2c367e985167a4689fc02814))
|
| 243 |
+
- mobile-friendly taskbar ([7a7c14f](https://github.com/HeyPuter/puter/commit/7a7c14fb040b28ef769abdba41b50d88c856fb20))
|
| 244 |
+
- prevent permission cycles ([e0128aa](https://github.com/HeyPuter/puter/commit/e0128aa88c54548304532282e5ed1b4a2d36ff3e))
|
| 245 |
+
- `launchApp` on explorer supports `~` now ([e482b00](https://github.com/HeyPuter/puter/commit/e482b00a303ca7ec0230be1924334d59adc00f8e))
|
| 246 |
+
- only allow UserActorType for ShareService ([69bfa60](https://github.com/HeyPuter/puter/commit/69bfa601993eb6c47c3555b92559878d76ba749e))
|
| 247 |
+
- new sessions miss notifications ([b1ffb8e](https://github.com/HeyPuter/puter/commit/b1ffb8eca13520fa41833f5361ff6a6505a80a2c))
|
| 248 |
+
- don't allow sharing with recipient just shared with ([d0f16c8](https://github.com/HeyPuter/puter/commit/d0f16c810509c7e4e8acba3408c71655664cfad2))
|
| 249 |
+
- add username to comments ([085d808](https://github.com/HeyPuter/puter/commit/085d808817e985f2bc52b7a91a31991ca3b2e89f))
|
| 250 |
+
- occasional db error from notics ([9e303a2](https://github.com/HeyPuter/puter/commit/9e303a2f7c7bf6ac9032e6c9b87bffd3126baa86))
|
| 251 |
+
- un-awked notif check in wrong place ([3f3f4e6](https://github.com/HeyPuter/puter/commit/3f3f4e6cb9fd3faad2e87fbf9ea1f09b934151ca))
|
| 252 |
+
- disabled sortable on sharing section in the sidebar ([9d7987f](https://github.com/HeyPuter/puter/commit/9d7987fae50b510f1836e306d5f6f497a560de08))
|
| 253 |
+
- add mixxing context to BroadcastService ([665471f](https://github.com/HeyPuter/puter/commit/665471f9f02b1f1163edb47932a31f52577ee7df))
|
| 254 |
+
- attempt at fixing broadcast ([22dd42e](https://github.com/HeyPuter/puter/commit/22dd42ef7f64d32ada0c776287f53a80a4470315))
|
| 255 |
+
- replace ll_readshares with better approach ([cd22425](https://github.com/HeyPuter/puter/commit/cd22425a3d363f6008b3d07f40a082769ee22a14))
|
| 256 |
+
- only add enabled_logs when not empty ([34836e3](https://github.com/HeyPuter/puter/commit/34836e374fccac297a6f0fa5f323f3609d0c9179))
|
| 257 |
+
- don't check share permission anymore ([249dc06](https://github.com/HeyPuter/puter/commit/249dc062014947c32bee8a8238b2c8acf86188bb))
|
| 258 |
+
- files shared array in notification ([27cc07e](https://github.com/HeyPuter/puter/commit/27cc07e985a799fae791d6edf61b7e656e0e182e))
|
| 259 |
+
- report path for broken files as /-void/ ([5725bd8](https://github.com/HeyPuter/puter/commit/5725bd8c66539564e7f58f96c6e81044a3751f97))
|
| 260 |
+
- issue with popover closing when clicked ([ac3317a](https://github.com/HeyPuter/puter/commit/ac3317aea918953358947638ca11822baa38e23f))
|
| 261 |
+
- groups manager location ([a08e975](https://github.com/HeyPuter/puter/commit/a08e9758fe7625d31279b8947a4e5ca6471578ff))
|
| 262 |
+
- don't show kvstore in usages ([402ffb0](https://github.com/HeyPuter/puter/commit/402ffb0fd1e812a8db8ea90ac53ed613fdd30a4b))
|
| 263 |
+
- add missing id for task_manager menu item ([4f9d9a5](https://github.com/HeyPuter/puter/commit/4f9d9a54efb3c5177125904a1c9ddec66ca089dc))
|
| 264 |
+
- Update security.txt canonical URL ([6c44032](https://github.com/HeyPuter/puter/commit/6c44032293836871a27fb3c857a0ff3b80462702))
|
| 265 |
+
- update apps cache by reading from primary db ([e8f67da](https://github.com/HeyPuter/puter/commit/e8f67da9a3d81273f59d136c8383f00d9dc8ca5a))
|
| 266 |
+
- logging in AppConnection ([5caa2c0](https://github.com/HeyPuter/puter/commit/5caa2c0e3a152d1fc947b86329778db462139db0))
|
| 267 |
+
- persist clock visibility change ([1a6d648](https://github.com/HeyPuter/puter/commit/1a6d648a6ecdda07b23da9e6f4ef49b70b54cce1))
|
| 268 |
+
- don't access `metadata.credentialless` if it doesn't exist ([9590bbd](https://github.com/HeyPuter/puter/commit/9590bbdad1099cf75d6073663a9fcec5f3136482))
|
| 269 |
+
- reinitialize settings tabs for DOM events ([16b9f09](https://github.com/HeyPuter/puter/commit/16b9f09e66ffe1584f925cb1a9f261bc159c8dda))
|
| 270 |
+
- use correct cursor when hovering over sidebar items ([c44b9ab](https://github.com/HeyPuter/puter/commit/c44b9ab8d5f575393bf864fd30235287f845a4e8))
|
| 271 |
+
- issue with context menu divider item stealing the event from previous item ([121043d](https://github.com/HeyPuter/puter/commit/121043d312577a6e048497108309cd08b73df4d0))
|
| 272 |
+
- issue with non-scrollable window body and document Context Menu ([0315cb3](https://github.com/HeyPuter/puter/commit/0315cb333719b08c6581b556c69a14cbe671b7bd))
|
| 273 |
+
- temporary fix because .on can't call ensure_service ([f836ac3](https://github.com/HeyPuter/puter/commit/f836ac30a901a7b3258399a54eab5c7c8cc47463))
|
| 274 |
+
- issues in kdmod ([0a47daa](https://github.com/HeyPuter/puter/commit/0a47daa2896d97c318aec2e2288f61ade5f4ea48))
|
| 275 |
+
- Collector bug on undefined body ([14f477a](https://github.com/HeyPuter/puter/commit/14f477a6330c9169145a7f8b2721d02e7517513b))
|
| 276 |
+
- hyphenize_confirm_code bug ([463c96c](https://github.com/HeyPuter/puter/commit/463c96c69a915ea75db66fd449e83a61ca036f6f))
|
| 277 |
+
- app close issue in phoenix ([38adb57](https://github.com/HeyPuter/puter/commit/38adb5741b241081dd3f30de2f9afdd708cc9fa5))
|
| 278 |
+
- reading JSON string from service_usage_monthly ([b30de5b](https://github.com/HeyPuter/puter/commit/b30de5bf786ae8f28f3248277c5b2df2f0e5ebf4))
|
| 279 |
+
- recently broke counting service sql ([7ba16d1](https://github.com/HeyPuter/puter/commit/7ba16d1c21d07e58cefebf967e5ca2b74502e841))
|
| 280 |
+
- ignore invalid entries from service_usage_monthly ([f108795](https://github.com/HeyPuter/puter/commit/f1087953b57297a1e066ea68563e8a273a1af4c0))
|
| 281 |
+
- service usage screen ([193da63](https://github.com/HeyPuter/puter/commit/193da633044f463ec1ed60eca4608761fc40b1d7))
|
| 282 |
+
- continue work on blocked_email_domains (2) ([4dc1e01](https://github.com/HeyPuter/puter/commit/4dc1e01682571f16a25eebb2e9c7918587ca89ae))
|
| 283 |
+
- continue work on blocked_email_domains ([515051d](https://github.com/HeyPuter/puter/commit/515051dabf9f2a145ae2d090f829df7188e9fd28))
|
| 284 |
+
- errors thrown by launch_app ([c22a69f](https://github.com/HeyPuter/puter/commit/c22a69ffb1809ad7959f8a8fe934052369b5d44f))
|
| 285 |
+
- notepad save issue ([bc51d4b](https://github.com/HeyPuter/puter/commit/bc51d4bd52b5d0a7bb4feddea7bb9d73e449f7d8))
|
| 286 |
+
- height 100% on flexer and step view ([c6bc42f](https://github.com/HeyPuter/puter/commit/c6bc42f551a46919b4b70a9ae3dfec85086b0233))
|
| 287 |
+
- wait no ([12e0cec](https://github.com/HeyPuter/puter/commit/12e0cecf02f4d906035a6f0059557416475db106))
|
| 288 |
+
- phoenix incorrect lookup order ([c8f913d](https://github.com/HeyPuter/puter/commit/c8f913d710454d0ab3da2147309b442a78965720))
|
| 289 |
+
- turns out we don't support `utm_source` I learn something new about Puter every day! ([99ce3bd](https://github.com/HeyPuter/puter/commit/99ce3bde199de729c4796a681c188c4a0da9165e))
|
| 290 |
+
- issue with service scripts that use TestView ([e0b9072](https://github.com/HeyPuter/puter/commit/e0b90721299fa3013f66c866ba637c52efe9df1d))
|
| 291 |
+
- 1954f8-related issue #2 ([143cfb5](https://github.com/HeyPuter/puter/commit/143cfb5654eca8b50fb7ff434f47db24d7bdf3aa))
|
| 292 |
+
- 1954f8-related issue ([f5865da](https://github.com/HeyPuter/puter/commit/f5865daede2b32682d0472926bc5db65c9ef37ab))
|
| 293 |
+
- small issue in Service.js ([3c5d2af](https://github.com/HeyPuter/puter/commit/3c5d2af8c8341ef78236ef38153ed0b4f20c5cac))
|
| 294 |
+
- prevent code from breaking just because it was bundled ([fb1216d](https://github.com/HeyPuter/puter/commit/fb1216d488bed8ee8d88c7c71e4a6f1054e3a01c))
|
| 295 |
+
- don't display all apps for extensionless files ([010282e](https://github.com/HeyPuter/puter/commit/010282edf299c2a39e53de7441b8850d0b8011b8))
|
| 296 |
+
- creating app shortcut in self-hosted ([38dcb60](https://github.com/HeyPuter/puter/commit/38dcb60d3f407dd185999d01d8e14355b47df0b8))
|
| 297 |
+
- disable thumbnails for AppData uploads ([37e7b6a](https://github.com/HeyPuter/puter/commit/37e7b6ad70f197db3be8712315446079caa23892))
|
| 298 |
+
- thumbnail service updates ([c2a9506](https://github.com/HeyPuter/puter/commit/c2a9506b4855f67d320eb479a67800098d73e8ec))
|
| 299 |
+
- remove redundant openai model fallback ([9db55fc](https://github.com/HeyPuter/puter/commit/9db55fc5f7a975ab301c88bbac493b7a5b1933bb))
|
| 300 |
+
- app pseudonym in wrong conditional block ([9985996](https://github.com/HeyPuter/puter/commit/99859966866ebce005f88e3a916c68dc04ba97bf))
|
| 301 |
+
- properly add owner object to fsentries ([04c05a5](https://github.com/HeyPuter/puter/commit/04c05a5bb8b73dda21093a2bf563f5cd6faaa356))
|
| 302 |
+
- add progress bar fix ([a70d0dd](https://github.com/HeyPuter/puter/commit/a70d0dd0881b0a07cea404fe13515a5e10321e3e))
|
| 303 |
+
- allow ETX to propagate to bash ([259877b](https://github.com/HeyPuter/puter/commit/259877b677a7bfc8e5b377c8852d687978c9bc24))
|
| 304 |
+
- error deleting entry from My Websites window ([fff8993](https://github.com/HeyPuter/puter/commit/fff89932002d67bf0f121532709c871263e33473))
|
| 305 |
+
- second half of connectToInstance ([4311b48](https://github.com/HeyPuter/puter/commit/4311b482fd629c6d1f65956eb711c8e890453179))
|
| 306 |
+
- error in process.handle_connection ([cb324cc](https://github.com/HeyPuter/puter/commit/cb324cc125285b5cd6a6b0cebf444a6cd873ded9))
|
| 307 |
+
- quick patch to avoid columnify error ([4396534](https://github.com/HeyPuter/puter/commit/439653458eab38e622cf215ae96b6af34d1db7d4))
|
| 308 |
+
- upsert subdomain check to insert only ([f2acd83](https://github.com/HeyPuter/puter/commit/f2acd83b72c388939233fd7145f2dcf78d8ad39e))
|
| 309 |
+
- simplify callback listener and fix async bug ([db3e0b5](https://github.com/HeyPuter/puter/commit/db3e0b5ce84e4b0b35550f380da97b5d6fcb394b))
|
| 310 |
+
- email change on account with unverified email ([33de981](https://github.com/HeyPuter/puter/commit/33de98107f6e3284acb180b1a44bb02ae082642f))
|
| 311 |
+
- html-webpack-plugin dev dep ([cc4ab1c](https://github.com/HeyPuter/puter/commit/cc4ab1cb36a002929f26a39f252a262fc1f1aab4))
|
| 312 |
+
- double-echo in phoenix ([6bdcae7](https://github.com/HeyPuter/puter/commit/6bdcae769d311b5deb82136d5e35d7ad986bca28))
|
| 313 |
+
- webpack error reporting + unintentional whitespace changes ([4910838](https://github.com/HeyPuter/puter/commit/4910838ab1a72738b44f948cbf65feea848e5271))
|
| 314 |
+
- dist ([ed7d6dc](https://github.com/HeyPuter/puter/commit/ed7d6dcbfbf432ae90d9e379dbf47de5587a57a2))
|
| 315 |
+
- use jq el for focus ([d350264](https://github.com/HeyPuter/puter/commit/d35026467eb9a5f67d6ec0c99f2a24d418b8e3a5))
|
| 316 |
+
- fix sourcemap ([cd39bb5](https://github.com/HeyPuter/puter/commit/cd39bb5aa073286baa053f8458f0af54a4b7313a))
|
| 317 |
+
- remove now-redundant loadScript call ([c9d09a7](https://github.com/HeyPuter/puter/commit/c9d09a78b6f4bc9682d13d2f982f9a2b7f77dd66))
|
| 318 |
+
- env for dev build ([46a0f71](https://github.com/HeyPuter/puter/commit/46a0f714d10c2fa99ee9436f453176d54cc161f8))
|
| 319 |
+
- mistakes ([3092300](https://github.com/HeyPuter/puter/commit/3092300a0144791b25816b39845a3d85968e9059))
|
| 320 |
+
- add env to EmitPlugin config ([4b89101](https://github.com/HeyPuter/puter/commit/4b8910169a26f85489135cd84b27fe8f91b37bc6))
|
| 321 |
+
- remove accidentally left-over code ([72946f9](https://github.com/HeyPuter/puter/commit/72946f920c9f27f4c9de3156aa9144d290699222))
|
| 322 |
+
- don't var when no var ([5f7d1f5](https://github.com/HeyPuter/puter/commit/5f7d1f589a56b3d3ea2026dcbd5f9c48b8dc9e6d))
|
| 323 |
+
- fallback to read access in /sign ([813ee95](https://github.com/HeyPuter/puter/commit/813ee95cee6f1fca79a886b12d8fe4603ca0d213))
|
| 324 |
+
- typo in a default file ([aa61c30](https://github.com/HeyPuter/puter/commit/aa61c3009c624099e7bd518870b18b02c008530c))
|
| 325 |
+
- fix 500 when check-app has bad url ([9a62200](https://github.com/HeyPuter/puter/commit/9a622004ea488783127abd83f3f4caf779a5aabb))
|
| 326 |
+
- ll_write ([a7cdb70](https://github.com/HeyPuter/puter/commit/a7cdb70251ae86f883257de3596838d20196c62d))
|
| 327 |
+
- don't try to sanitize null owners ([cb4cab5](https://github.com/HeyPuter/puter/commit/cb4cab529affa5c28ddb32b90328ad47f21de8d4))
|
| 328 |
+
- missing key for feature flag perm check ([1482048](https://github.com/HeyPuter/puter/commit/14820481b9700a5c61c6d9a156944f42f9879008))
|
| 329 |
+
- implicit app permissions bug ([6b4a19e](https://github.com/HeyPuter/puter/commit/6b4a19e12a115be2c0e323d17340ab2ce2b6b025))
|
| 330 |
+
- share services and features with apps ([48fea77](https://github.com/HeyPuter/puter/commit/48fea77a20a0938fc2272483c798b817ca1c9848))
|
| 331 |
+
- admin user public folder ([3819584](https://github.com/HeyPuter/puter/commit/3819584d119076658c9d4be2b2b941c58d122ad4))
|
| 332 |
+
- add anti-csrf token for /revoke-session ([b6b64d3](https://github.com/HeyPuter/puter/commit/b6b64d3bccb6e17240a245c956ead2ae5a87c8dd))
|
| 333 |
+
- only show 2fa when available ([9fa12d4](https://github.com/HeyPuter/puter/commit/9fa12d43fc782d7e4d2584b1cf74dca13b7ced25))
|
| 334 |
+
- requirement for email_confirmed in backend ([6e325fa](https://github.com/HeyPuter/puter/commit/6e325fa000f19b8f20d79829ab2bd78edce80425))
|
| 335 |
+
- do primary read of user after setting email_confirmed ([ef245b7](https://github.com/HeyPuter/puter/commit/ef245b70df482ff470877459fcb28e1f490fe42d))
|
| 336 |
+
- require confirmed email for public folder ([0519b4a](https://github.com/HeyPuter/puter/commit/0519b4a71b236e464c9d1136065e8f5ba15def8e))
|
| 337 |
+
- sqlite condition in MonthlyUsageService ([d4319ea](https://github.com/HeyPuter/puter/commit/d4319ea072e0793a32dbddb1d456227cf481e42c))
|
| 338 |
+
- add context to event listener aiife ([3f07ead](https://github.com/HeyPuter/puter/commit/3f07ead1b9940ee133c142f4c34d19884bbb3cd2))
|
| 339 |
+
- missing method in SLink ([5b74b4a](https://github.com/HeyPuter/puter/commit/5b74b4affae5473029e887542717c76c7b32f562))
|
| 340 |
+
- disable unconfigured ai services ([476acae](https://github.com/HeyPuter/puter/commit/476acae0e0d07c7b025cdbcfd86aacfedd7831a5))
|
| 341 |
+
- add missing driver parameter to /call endpoint ([b520783](https://github.com/HeyPuter/puter/commit/b520783bf4a543c71eaef73277f42d5918ac4469))
|
| 342 |
+
- sqlite migrations error ([d0e461e](https://github.com/HeyPuter/puter/commit/d0e461e206300e7fe3f9bc7f54eaa3a25bb762d8))
|
| 343 |
+
- prevent large logs from service events (2) ([e514dfc](https://github.com/HeyPuter/puter/commit/e514dfcf5049771af3901334e37b1a7c53e05452))
|
| 344 |
+
- prevent large logs from service events (1) ([fa9cc8e](https://github.com/HeyPuter/puter/commit/fa9cc8efcfda5e573c73841ae49c423879e5fcd8))
|
| 345 |
+
- fix templates ([5d2a6fc](https://github.com/HeyPuter/puter/commit/5d2a6fce305a3dcd4857f52ebb75f529dffe4790))
|
| 346 |
+
- popup login in co isolation mode ([8f87770](https://github.com/HeyPuter/puter/commit/8f87770cebab32c00cb10133979d426306685292))
|
| 347 |
+
- add necessary iframe attributes for co isolation ([2a5cec7](https://github.com/HeyPuter/puter/commit/2a5cec7ee914c9c97ae90b85464f9fc5332ad2fb))
|
| 348 |
+
- chore: fix confirm for type_confirm_to_delete_account ([02e1b1e](https://github.com/HeyPuter/puter/commit/02e1b1e8f5f8e22d7ab39ebff99f7dd8e08a4221))
|
| 349 |
+
- syntax error and formatting issue ([3a09e84](https://github.com/HeyPuter/puter/commit/3a09e84838fe8b74bd050641620eec87d9f59dfc))
|
| 350 |
+
- #432 ([f897e84](https://github.com/HeyPuter/puter/commit/f897e844989083b0b369ba0ce4d2c5a9f3db5ad8))
|
| 351 |
+
- `launch_app` not considering `explorer` as a special case ([98e6964](https://github.com/HeyPuter/puter/commit/98e69642d027a83975a0b2b825317213098bb689))
|
| 352 |
+
- well kinda (HOSTNAME in phoenix) ([7043b94](https://github.com/HeyPuter/puter/commit/7043b9400c63842c4c54d82724167666708d3119))
|
| 353 |
+
- it was github actions the entire time ([602a198](https://github.com/HeyPuter/puter/commit/602a19895c05b45a7d283470e7af3ae786be1bf2))
|
| 354 |
+
- run mocha within packages in monorepo ([58c199c](https://github.com/HeyPuter/puter/commit/58c199c15356ac087a04b16dd18e8fe0f1aea359))
|
| 355 |
+
- make webpack output not look like errors ([ad3d318](https://github.com/HeyPuter/puter/commit/ad3d318d07377c78c0429247225655e489b68be4))
|
| 356 |
+
- No scrollbar for session list ([45f131f](https://github.com/HeyPuter/puter/commit/45f131f8eaf94cf3951ca7ffeb6f311590233b8a))
|
| 357 |
+
- fix path issues under win32 platform ([d80f2fa](https://github.com/HeyPuter/puter/commit/d80f2fa847bfaef98dc8d482898f5c15f268e4bd))
|
| 358 |
+
- remove abnoxious debug file ([5c636d4](https://github.com/HeyPuter/puter/commit/5c636d4fd25e14ba3813f7fca3b70ff7bd6860e7))
|
| 359 |
+
- read_only fields in ES ([e8f4c32](https://github.com/HeyPuter/puter/commit/e8f4c328bff5c36b95fe460b80803e12e619f8ee))
|
| 360 |
+
### Security
|
| 361 |
+
|
| 362 |
+
|
| 363 |
+
#### Bug Fixes
|
| 364 |
+
|
| 365 |
+
- verify dest_node uid matches signature ([e208b99](https://github.com/HeyPuter/puter/commit/e208b99d211e98cd88e0a8b2917bbe6b2f2423a0))
|
| 366 |
+
- always use actor ([1954f86](https://github.com/HeyPuter/puter/commit/1954f86680be642e1af03f648d6b587fe67dfaa8))
|
| 367 |
+
- signing in public folders ([937528f](https://github.com/HeyPuter/puter/commit/937528f7676e8ace7287141e1f5057842a2b5eb7))
|
| 368 |
+
- remove unconfirmed_email from /whoami for apps ([a002ad0](https://github.com/HeyPuter/puter/commit/a002ad08e5622a349b5d24ed2c7c5f61215146b8))
|
| 369 |
+
- hoist acl check in ll_read ([6a2fbc1](https://github.com/HeyPuter/puter/commit/6a2fbc1925952ecceed741afe138270d1eeda7b7))
|
| 370 |
+
### Backend
|
| 371 |
+
|
| 372 |
+
|
| 373 |
+
#### Features
|
| 374 |
+
|
| 375 |
+
- add comments for fsentries ([db79a72](https://github.com/HeyPuter/puter/commit/db79a72daab5460bc8e24f6e16c6280291b2f6fe))
|
| 376 |
+
### AI
|
| 377 |
+
|
| 378 |
+
|
| 379 |
+
#### Features
|
| 380 |
+
|
| 381 |
+
- add xAI grok-beta ([28adcf5](https://github.com/HeyPuter/puter/commit/28adcf533fd867dfdf3bda0007753e65c91ff5e5))
|
| 382 |
+
- add groq ([53e7a91](https://github.com/HeyPuter/puter/commit/53e7a91f1800b60b48575a6e41d96d2ccbd6d362))
|
| 383 |
+
- add mistral ([055c628](https://github.com/HeyPuter/puter/commit/055c628afd2e33589d3dc66c52934505143eafd4))
|
| 384 |
+
- add togetherai ([bdfdf23](https://github.com/HeyPuter/puter/commit/bdfdf2331b37680b95ac56b31026d3bdab4c173b))
|
| 385 |
+
- add claude ([d009cd0](https://github.com/HeyPuter/puter/commit/d009cd0aaff645a24d37085ed41c55fe296a5722))
|
| 386 |
+
- add streaming ([9d5963c](https://github.com/HeyPuter/puter/commit/9d5963cdf5fe63a4f7970d2d03bc307f4d4fa3ab))
|
| 387 |
+
|
| 388 |
+
#### Bug Fixes
|
| 389 |
+
|
| 390 |
+
- close streams ([eb18550](https://github.com/HeyPuter/puter/commit/eb18550f411947a0d8ccaf283701596b1386cfe6))
|
| 391 |
+
- adapt message role for claude ([c08b897](https://github.com/HeyPuter/puter/commit/c08b897d4a6a77c54a7e8d2e705e2048ab4797ba))
|
| 392 |
+
### GUI
|
| 393 |
+
|
| 394 |
+
### Putility
|
| 395 |
+
|
| 396 |
+
|
| 397 |
+
#### Features
|
| 398 |
+
|
| 399 |
+
- trait method override support ([43c5402](https://github.com/HeyPuter/puter/commit/43c5402b7cb92e604cbe59badc8f735131d2c349))
|
| 400 |
+
### Docker
|
| 401 |
+
|
| 402 |
+
|
| 403 |
+
#### Bug Fixes
|
| 404 |
+
|
| 405 |
+
- ensure temp admin pass shows ([d2c7477](https://github.com/HeyPuter/puter/commit/d2c7477b3bf170be492a6d5387330645cdf9c33a))
|
| 406 |
+
### Puter JS
|
| 407 |
+
|
| 408 |
+
|
| 409 |
+
#### Features
|
| 410 |
+
|
| 411 |
+
- add drivers module ([439f52b](https://github.com/HeyPuter/puter/commit/439f52b5a3f1a94e6d15ddacc315ae797f4709c2))
|
| 412 |
+
|
| 413 |
+
#### Bug Fixes
|
| 414 |
+
|
| 415 |
+
- fix settings object check ([5a616f6](https://github.com/HeyPuter/puter/commit/5a616f67dd22a0dcbb8a380bbbd2347a0029ce31))
|
| 416 |
+
### API
|
| 417 |
+
|
| 418 |
+
|
| 419 |
+
#### Features
|
| 420 |
+
|
| 421 |
+
- add /lsmod ([32f0edb](https://github.com/HeyPuter/puter/commit/32f0edb93a8fb0c33b0614b99c7fc439c8f6afc9))
|
| 422 |
+
|
| 423 |
+
|
| 424 |
+
|
| 425 |
+
## v2.4.2 (2024-07-22)
|
| 426 |
+
|
| 427 |
+
### Puter
|
| 428 |
+
|
| 429 |
+
#### Features
|
| 430 |
+
|
| 431 |
+
- add new file templates ([1f7f094](https://github.com/HeyPuter/puter/commit/1f7f094282fae915a2436701cfb756444cd3f781))
|
| 432 |
+
- add cross_origin_isolation option ([e539932](https://github.com/HeyPuter/puter/commit/e53993207077aecd2c01712519251993bb2562bc))
|
| 433 |
+
- add option to disable temporary users ([f9333b3](https://github.com/HeyPuter/puter/commit/f9333b3d1e05bd0dffaecd2e29afd08ea61559fc))
|
| 434 |
+
- add some default groups ([ba50d0f](https://github.com/HeyPuter/puter/commit/ba50d0f96d58075abec067d24e6532bd874093f0))
|
| 435 |
+
- Add support for dropping multiple Puter items onto Dev Center (close #311) ([8e7306c](https://github.com/HeyPuter/puter/commit/8e7306c23be01ee6c31cdb4c99f2fb1f71a2247f))
|
| 436 |
+
|
| 437 |
+
#### Translations
|
| 438 |
+
|
| 439 |
+
- Update ig.js ([382fb24](https://github.com/HeyPuter/puter/commit/382fb24dbb1737a8a54ed2491f80b2e2276cde61))
|
| 440 |
+
- feat: add vietnamese localization-a ([c2d3d69](https://github.com/HeyPuter/puter/commit/c2d3d69dbe33f36fcae13bcbc8e2a31a86025af9))
|
| 441 |
+
- Update zhtw.js, Complete Traditional Chinese translation based on English file #550 ([b9e73b7](https://github.com/HeyPuter/puter/commit/b9e73b7288aebb14e6bbf1915743e9157fc950b1))
|
| 442 |
+
- update zhtw.js to match en.js ([37fd666](https://github.com/HeyPuter/puter/commit/37fd666a9a6788d5f0c59311499f29896b48bc82))
|
| 443 |
+
- Add Tamil translation to translations.js ([8a3d043](https://github.com/HeyPuter/puter/commit/8a3d0430f39f872b8a460c344cce652c340b700b))
|
| 444 |
+
- Move Tamil translation to the rest of translations ([333d6e3](https://github.com/HeyPuter/puter/commit/333d6e3b651e460caca04a896cbc8c175555b79b))
|
| 445 |
+
- Translation improvements, mainly style and context-based ([8bece96](https://github.com/HeyPuter/puter/commit/8bece96f6224a060d5b408e08c58865fadb8b79c))
|
| 446 |
+
- update translation file es.js to be up to date with the file en.js ([1515278](https://github.com/HeyPuter/puter/commit/151527825f1eb4b060aaf97feb7d18af4fcddbf2))
|
| 447 |
+
- Translate en.js as of 2024-07-10 ([8e297cd](https://github.com/HeyPuter/puter/commit/8e297cd7e30757073e2f96593c363a273b639466))
|
| 448 |
+
- Create hu.js hungarian language ([69a80ab](https://github.com/HeyPuter/puter/commit/69a80ab3d2c94ee43d96021c3bcbdab04a4b5dc6))
|
| 449 |
+
- Update translations.js to Hungarian lang ([56820cf](https://github.com/HeyPuter/puter/commit/56820cf6ee56ff810a6b495a281ccbb2e7f9d8fb))
|
| 450 |
+
- Tamil translation ([81781f8](https://github.com/HeyPuter/puter/commit/81781f80afc07cd1e6278906cdc68c8092fbfedf))
|
| 451 |
+
- Update it.js ([84e31ef](https://github.com/HeyPuter/puter/commit/84e31eff2f58584d8fab7dd10606f2f6ced933a2))
|
| 452 |
+
- Update Armenian translation file ([3b8af7c](https://github.com/HeyPuter/puter/commit/3b8af7cc5c1be8ed67be827360bbfe0f0b5027e9))
|
| 453 |
+
|
| 454 |
+
#### Bug Fixes
|
| 455 |
+
|
| 456 |
+
- fix templates ([5d2a6fc](https://github.com/HeyPuter/puter/commit/5d2a6fce305a3dcd4857f52ebb75f529dffe4790))
|
| 457 |
+
- popup login in co isolation mode ([8f87770](https://github.com/HeyPuter/puter/commit/8f87770cebab32c00cb10133979d426306685292))
|
| 458 |
+
- add necessary iframe attributes for co isolation ([2a5cec7](https://github.com/HeyPuter/puter/commit/2a5cec7ee914c9c97ae90b85464f9fc5332ad2fb))
|
| 459 |
+
- chore: fix confirm for type_confirm_to_delete_account ([02e1b1e](https://github.com/HeyPuter/puter/commit/02e1b1e8f5f8e22d7ab39ebff99f7dd8e08a4221))
|
| 460 |
+
- syntax error and formatting issue ([3a09e84](https://github.com/HeyPuter/puter/commit/3a09e84838fe8b74bd050641620eec87d9f59dfc))
|
| 461 |
+
- #432 ([f897e84](https://github.com/HeyPuter/puter/commit/f897e844989083b0b369ba0ce4d2c5a9f3db5ad8))
|
| 462 |
+
- `launch_app` not considering `explorer` as a special case ([98e6964](https://github.com/HeyPuter/puter/commit/98e69642d027a83975a0b2b825317213098bb689))
|
| 463 |
+
- well kinda (HOSTNAME in phoenix) ([7043b94](https://github.com/HeyPuter/puter/commit/7043b9400c63842c4c54d82724167666708d3119))
|
| 464 |
+
- it was github actions the entire time ([602a198](https://github.com/HeyPuter/puter/commit/602a19895c05b45a7d283470e7af3ae786be1bf2))
|
| 465 |
+
- fix CI attempt #7 ([614f2c5](https://github.com/HeyPuter/puter/commit/614f2c5061525f230ccd879bfb047434ac46a9ba))
|
| 466 |
+
- fix CI attempt #6 ([9d549b1](https://github.com/HeyPuter/puter/commit/9d549b192d149eac96c316ded645bf7c2e96153d))
|
| 467 |
+
- fix CI attempt #5 ([74adcdd](https://github.com/HeyPuter/puter/commit/74adcddc1d60e0a513408a0716ed2b301126225d))
|
| 468 |
+
- fix CI attempt #4 ([84b993b](https://github.com/HeyPuter/puter/commit/84b993bce913c3ad99127063bcfaae19331b199c))
|
| 469 |
+
- fix CI attempt #3 ([3bca973](https://github.com/HeyPuter/puter/commit/3bca973f5f4e65a2bd24c634c347fbd681a7458b))
|
| 470 |
+
- fix CI attempt #2 ([aebe89a](https://github.com/HeyPuter/puter/commit/aebe89a1acb070764551e8e89e325325ffbed8f9))
|
| 471 |
+
- run mocha within packages in monorepo ([58c199c](https://github.com/HeyPuter/puter/commit/58c199c15356ac087a04b16dd18e8fe0f1aea359))
|
| 472 |
+
- make webpack output not look like errors ([ad3d318](https://github.com/HeyPuter/puter/commit/ad3d318d07377c78c0429247225655e489b68be4))
|
| 473 |
+
- No scrollbar for session list ([45f131f](https://github.com/HeyPuter/puter/commit/45f131f8eaf94cf3951ca7ffeb6f311590233b8a))
|
| 474 |
+
- fix path issues under win32 platform ([d80f2fa](https://github.com/HeyPuter/puter/commit/d80f2fa847bfaef98dc8d482898f5c15f268e4bd))
|
| 475 |
+
- remove abnoxious debug file ([5c636d4](https://github.com/HeyPuter/puter/commit/5c636d4fd25e14ba3813f7fca3b70ff7bd6860e7))
|
| 476 |
+
- read_only fields in ES ([e8f4c32](https://github.com/HeyPuter/puter/commit/e8f4c328bff5c36b95fe460b80803e12e619f8ee))
|
| 477 |
+
|
| 478 |
+
### Security
|
| 479 |
+
|
| 480 |
+
#### Bug Fixes
|
| 481 |
+
|
| 482 |
+
- hoist acl check in ll_read ([6a2fbc1](https://github.com/HeyPuter/puter/commit/6a2fbc1925952ecceed741afe138270d1eeda7b7))
|
| 483 |
+
|
| 484 |
+
## v2.4.1 (2024-07-11)
|
| 485 |
+
|
| 486 |
+
### Puter
|
| 487 |
+
|
| 488 |
+
|
| 489 |
+
#### Features
|
| 490 |
+
|
| 491 |
+
- update BR translation ([42a6b39](https://github.com/HeyPuter/puter/commit/42a6b3938a588b8b4d1bd976c37e9c6e58408c75))
|
| 492 |
+
- JSON support for kv driver ([3ed7916](https://github.com/HeyPuter/puter/commit/3ed7916856f03eafbe0891f2ab39c34d20d2bd24))
|
| 493 |
+
|
| 494 |
+
#### Translations
|
| 495 |
+
|
| 496 |
+
- Update bn.js file formatting ([cff488f](https://github.com/HeyPuter/puter/commit/cff488f4f4378ca6c7568a585a665f2a3b87b89c))
|
| 497 |
+
- Issue#530 - Update bengali translations ([92abc99](https://github.com/HeyPuter/puter/commit/92abc9947f811f94f17a5ee5a4b73ee2b210900a))
|
| 498 |
+
- Added missing Romanian translations. ([8440f56](https://github.com/HeyPuter/puter/commit/8440f566b91c9eb4f01addcb850061e3fbe3afc7))
|
| 499 |
+
- Add 2FA Romanian translations ([473b651](https://github.com/HeyPuter/puter/commit/473b6512c697854e3f3badae1eb7b87742954da5))
|
| 500 |
+
- Add Japanese Translation ([47ec74f](https://github.com/HeyPuter/puter/commit/47ec74f0aa6adb3952e6460909029a4acb0c3039))
|
| 501 |
+
- Completing Italian translation based on English file ([f5a8ee1](https://github.com/HeyPuter/puter/commit/f5a8ee1c6ab950d62c90b6257791f026a508b4e4))
|
| 502 |
+
- Completing Italian translation based on English file. ([a96abb5](https://github.com/HeyPuter/puter/commit/a96abb5793528d0dc56d75f95d771e1dcf5960d1))
|
| 503 |
+
- Completing Arabic translation based on English file ([78a0ace](https://github.com/HeyPuter/puter/commit/78a0acea6980b6d491da4874edbd98e17c0d9577))
|
| 504 |
+
- Update Arabic translations in src/gui/src/i18n/translations/ar.js to match English version in src/gui/src/i18n/translations/en.js ([fe5be7f](https://github.com/HeyPuter/puter/commit/fe5be7f3cf7f336730137293ba86a637e8d8591d))
|
| 505 |
+
- Update Arabic translations in src/gui/src/i18n/translations/ar.js to match English version in src/gui/src/i18n/translations/en.js ([bffa192](https://github.com/HeyPuter/puter/commit/bffa192805216fc17045cd8d629f34784dca7f3f))
|
| 506 |
+
- Ukrainian updated ([e61039f](https://github.com/HeyPuter/puter/commit/e61039faf409b0ad85c7513b0123f3f2e92ebe32))
|
| 507 |
+
- Update ru.js issue #547 ([17145d0](https://github.com/HeyPuter/puter/commit/17145d0be6a9a1445947cc0c4bec8f16a475144c))
|
| 508 |
+
- Russian translation fixed ([8836011](https://github.com/HeyPuter/puter/commit/883601142873f10d69c84874499065a7d29af054))
|
| 509 |
+
|
| 510 |
+
#### Bug Fixes
|
| 511 |
+
|
| 512 |
+
- remove flag that breaks puter-js webpack ([7aadae5](https://github.com/HeyPuter/puter/commit/7aadae58ce1a51f925bf64c3d65ac1fa6971b164))
|
| 513 |
+
- Improve `getMimeType` to remove trailing dot in the extension if preset ([535475b](https://github.com/HeyPuter/puter/commit/535475b3c36a37e3319ed067a24fb671790dcda3))
|
| 514 |
+
|
| 515 |
+
|
| 516 |
+
## 2.4.0 (2024-07-08)
|
| 517 |
+
|
| 518 |
+
|
| 519 |
+
### Features
|
| 520 |
+
|
| 521 |
+
* add (pt-br) translation for system settings. ([77211c4](https://github.com/HeyPuter/puter/commit/77211c4f71b0285fb3060f7e5c8d493b4d7c4f0c))
|
| 522 |
+
* add /group/list endpoint ([d55f38c](https://github.com/HeyPuter/puter/commit/d55f38ca68899c3574cfe328d2b206b1143ff0d4))
|
| 523 |
+
* add /share/file-by-username endpoint ([5d214c7](https://github.com/HeyPuter/puter/commit/5d214c7b52887b594af6be497f1892baf7d77679))
|
| 524 |
+
* add /sharelink/request endpoint ([742f625](https://github.com/HeyPuter/puter/commit/742f625309f9f4cfa70cf7d2fe5b03fd164913ea))
|
| 525 |
+
* add /show urls ([079e25a](https://github.com/HeyPuter/puter/commit/079e25a9fe8e179f26d72378856058eb656e2314))
|
| 526 |
+
* add app metadata ([f7216b9](https://github.com/HeyPuter/puter/commit/f7216b95672b38802b288ef5b022e947017ff311))
|
| 527 |
+
* add appdata permission (if applicable) on app share ([9751fd9](https://github.com/HeyPuter/puter/commit/9751fd92a50e75385cffed0ca847d5076ba98c92))
|
| 528 |
+
* add cookie for site token ([a813fbb](https://github.com/HeyPuter/puter/commit/a813fbbb88bcfb8b9a61976e2a4fc4aab943fc88))
|
| 529 |
+
* add cross-server event broadcasting ([1207a15](https://github.com/HeyPuter/puter/commit/1207a158bdc88a90b14d31d03387ce353c176a9c))
|
| 530 |
+
* add debug mod ([16b1649](https://github.com/HeyPuter/puter/commit/16b1649ff62fd87a4dda5d2e1c68941c864c5da4))
|
| 531 |
+
* add endpoints for share tokens ([301ffaf](https://github.com/HeyPuter/puter/commit/301ffaf61dbb4fca1a855650ab80707ae6d9f602))
|
| 532 |
+
* Add exit status code to apps ([7674da4](https://github.com/HeyPuter/puter/commit/7674da4cd225bcad34079251c5600fc32e32248b))
|
| 533 |
+
* add external mod loading ([eb05fbd](https://github.com/HeyPuter/puter/commit/eb05fbd2dc4877553b5118a069a9afdc32bea137))
|
| 534 |
+
* add group management endpoints ([4216346](https://github.com/HeyPuter/puter/commit/4216346384d90dcba429dbcb175e6f86482d19f4))
|
| 535 |
+
* add group permission endpoints ([c374b0c](https://github.com/HeyPuter/puter/commit/c374b0cbca761e7c8a47d56a09551f2e9378066a))
|
| 536 |
+
* add mark-read endpoint ([0101f42](https://github.com/HeyPuter/puter/commit/0101f425d480705c20df4919a76f66e987f5790f))
|
| 537 |
+
* add permission rewriter for app by name ([16c4907](https://github.com/HeyPuter/puter/commit/16c4907be592dae31ed3c1aa3fac3b9655255d6f))
|
| 538 |
+
* add protected apps ([f2f3d6f](https://github.com/HeyPuter/puter/commit/f2f3d6ff460932698fb8da7309fbce3e96132950))
|
| 539 |
+
* add protected subdomains ([86fca17](https://github.com/HeyPuter/puter/commit/86fca17fb17c0c24397c29b49b133deadea1de8b))
|
| 540 |
+
* add querystring-informed errors ([e7c0b83](https://github.com/HeyPuter/puter/commit/e7c0b8320a6829315d9154d6d513bab4491c47ea))
|
| 541 |
+
* add readdir delegate for shares in a user directory ([8424d44](https://github.com/HeyPuter/puter/commit/8424d446099ac30ccf829c57d43eef1f235618e4))
|
| 542 |
+
* add readdir delegate for sharing user homedirs ([19a5eb0](https://github.com/HeyPuter/puter/commit/19a5eb00763f3ac31df8483fb59cb7a96c448745))
|
| 543 |
+
* add service for notifications ([a1e6887](https://github.com/HeyPuter/puter/commit/a1e6887bf93da21b9482040b3e30ee083fb23477))
|
| 544 |
+
* add service to test file share logic ([332371f](https://github.com/HeyPuter/puter/commit/332371fccb198462948a440419adc7a26d671a23))
|
| 545 |
+
* add share list to stat ([8c49ba2](https://github.com/HeyPuter/puter/commit/8c49ba2553ce6bee20eb5b6f2721bc80f639e98a))
|
| 546 |
+
* add share service and share-by-email to /share ([db5990a](https://github.com/HeyPuter/puter/commit/db5990a98935817c0e16d30e921bb99c57a98fc8))
|
| 547 |
+
* add subdomain permission (if applicable) on app share ([13e2f72](https://github.com/HeyPuter/puter/commit/13e2f72c9f33f485570f13f45341246b1a05879f))
|
| 548 |
+
* add user-group permission check ([0014940](https://github.com/HeyPuter/puter/commit/00149402e041443aa3ac571fbe97a9a85f95564b))
|
| 549 |
+
* **backend:** add script service ([30550fc](https://github.com/HeyPuter/puter/commit/30550fcddda18469735499546de502d29b85e2ad))
|
| 550 |
+
* **backend:** Add tab completion to server console command arguments ([fa81dca](https://github.com/HeyPuter/puter/commit/fa81dca9507b7fa0f82099b75f2ab89c865626ac))
|
| 551 |
+
* **backend:** Add tab-completion to server console command names ([e1e76c6](https://github.com/HeyPuter/puter/commit/e1e76c6be71fdeb3b6246307b626734d8dc26f86))
|
| 552 |
+
* **backend:** add tip of day ([2d8e624](https://github.com/HeyPuter/puter/commit/2d8e6240c61dc6301f49cbdcd1c3b04736f9ca93))
|
| 553 |
+
* **backend:** allow services to provide user properties ([522664d](https://github.com/HeyPuter/puter/commit/522664d415c33342500defec309c2ff15bc94804))
|
| 554 |
+
* **backend:** allow services to provide whoami values ([fccabf1](https://github.com/HeyPuter/puter/commit/fccabf1bc0c4418f3599222616dd63bf98c14fe1))
|
| 555 |
+
* **backend:** improve logger and reduce logs ([4bdad75](https://github.com/HeyPuter/puter/commit/4bdad75766d0617a164024b39b79bf5373c495a6))
|
| 556 |
+
* Display app icon and description in embeds ([ef298ce](https://github.com/HeyPuter/puter/commit/ef298ce3aa3ce90224e883fb0ba33f9cd3a3da44))
|
| 557 |
+
* get first test working on share-test service ([88d6bee](https://github.com/HeyPuter/puter/commit/88d6bee9546f36d689c53ec7fe95f01f772f5211))
|
| 558 |
+
* **git:** Add --color and --no-color options ([d6dd1a5](https://github.com/HeyPuter/puter/commit/d6dd1a5bb0a2b2bba2cfe86d2e51ff2a6e42841c))
|
| 559 |
+
* **git:** Add a --debug option, which sets the DEBUG global ([fa3df72](https://github.com/HeyPuter/puter/commit/fa3df72f6ed2d45a440ebc2aacbbae67bf042478))
|
| 560 |
+
* **git:** Add authentication to clone, fetch, and pull. ([364d580](https://github.com/HeyPuter/puter/commit/364d580ff896691ee70d3735f495c720651a9f41))
|
| 561 |
+
* **git:** Add diff display to `show` and `log` subcommands ([3cad1ec](https://github.com/HeyPuter/puter/commit/3cad1ec436f99a78f782ab9576325d4341284964))
|
| 562 |
+
* **git:** Add start-revision and file arguments to `git log` ([49c2f16](https://github.com/HeyPuter/puter/commit/49c2f163515d2130c17a6f6a6a16bc27ea69336a))
|
| 563 |
+
* **git:** Allow checking out a commit instead of a branch ([057b3ac](https://github.com/HeyPuter/puter/commit/057b3acf00af49c005b9bf7069c5d22983a32e1e))
|
| 564 |
+
* **git:** Color output for `git status` files ([bab5204](https://github.com/HeyPuter/puter/commit/bab5204209aa2efc0c053643677a78db6ede0929))
|
| 565 |
+
* **git:** Display file contents as a string for `git show FILE_OID` ([a680371](https://github.com/HeyPuter/puter/commit/a68037111a04580cfa2688694a68ef6ac7a495fa))
|
| 566 |
+
* **git:** Display ref names in `git log` and `git show` ([45cdfcb](https://github.com/HeyPuter/puter/commit/45cdfcb5bfa66937b33054a127e0b17001f3faa4))
|
| 567 |
+
* **git:** Format output closer to canonical git ([60976b1](https://github.com/HeyPuter/puter/commit/60976b1ed61984d9d290f3a0ae99dd97632e9909))
|
| 568 |
+
* **git:** Handle detached HEAD in `git status` and `git branch --list` ([2c9b1a3](https://github.com/HeyPuter/puter/commit/2c9b1a3ffc3d5e282ffe5b83a86314e99445bbc6))
|
| 569 |
+
* **git:** Implement `git branch` ([ad4f132](https://github.com/HeyPuter/puter/commit/ad4f13255d52f8226f22800c16b388cf0e6384d7))
|
| 570 |
+
* **git:** Implement `git checkout` ([35e4453](https://github.com/HeyPuter/puter/commit/35e4453930bc4e151887f83c97efec19cc15da70))
|
| 571 |
+
* **git:** Implement `git cherry-pick` ([2e4259d](https://github.com/HeyPuter/puter/commit/2e4259d267b3cfafd5cefc57a02643c6432fec4d))
|
| 572 |
+
* **git:** Implement `git clone` ([95c8235](https://github.com/HeyPuter/puter/commit/95c8235a4a1fea39a46c40df04cb1004a2fe7b23))
|
| 573 |
+
* **git:** Implement `git diff` ([622b6a9](https://github.com/HeyPuter/puter/commit/622b6a9b921c3c03efc0b519c9a26c6701d80e50))
|
| 574 |
+
* **git:** Implement `git fetch` ([98a4b9e](https://github.com/HeyPuter/puter/commit/98a4b9ede39b94c0c6b6b8345d7551359961186a))
|
| 575 |
+
* **git:** Implement `git pull` ([eb2b6a0](https://github.com/HeyPuter/puter/commit/eb2b6a08b03cee0612885412cd4b03c9564044e3))
|
| 576 |
+
* **git:** Implement `git push` ([8c70229](https://github.com/HeyPuter/puter/commit/8c70229a188b743220db076a740a992fd7971301))
|
| 577 |
+
* **git:** Implement `git remote` ([43ce0d5](https://github.com/HeyPuter/puter/commit/43ce0d5b45d4eb4f296afcaaa1ecadc125c53e89))
|
| 578 |
+
* **git:** Implement `git restore` ([4ba8a32](https://github.com/HeyPuter/puter/commit/4ba8a32b45d395f28433572db5644d630776789e))
|
| 579 |
+
* **git:** Make `git add` work for deleted files ([9551544](https://github.com/HeyPuter/puter/commit/955154468f48e45028dad2e916708d6a763affad))
|
| 580 |
+
* **git:** Make shorten_hash() guaranteed to produce a unique hash ([dd10a37](https://github.com/HeyPuter/puter/commit/dd10a377493c0d8f10a1ac8779dc27f3f3bf6c37))
|
| 581 |
+
* **git:** Resolve more forms of commit reference ([b6906bb](https://github.com/HeyPuter/puter/commit/b6906bbcaaa50fc8a8c60beb6d2d38bcb7dda758))
|
| 582 |
+
* **git:** Understand references like `HEAD^` and `main~3` ([711dbc0](https://github.com/HeyPuter/puter/commit/711dbc0d2fde9c2ddc6c86f64fb4caa7837c9dcb))
|
| 583 |
+
* implicit access from apps to shared appdata dirs ([31d4eb0](https://github.com/HeyPuter/puter/commit/31d4eb090efb340fdfb7cb6b751145e859624eeb))
|
| 584 |
+
* introduce notification selection via driver ([c5334b0](https://github.com/HeyPuter/puter/commit/c5334b0e19cf9762f536ec482c3ff872e9c12399))
|
| 585 |
+
* multi-recipient multi-file share endpoint ([846fdc2](https://github.com/HeyPuter/puter/commit/846fdc20d4a887a1f8a4f3bda4fafe41efab2733))
|
| 586 |
+
* **parsely:** Add a fail() parser ([5656d9d](https://github.com/HeyPuter/puter/commit/5656d9d42f76202a534ad640d3a4e287e0e40418))
|
| 587 |
+
* **parsely:** Add stringUntil() parser ([d46b043](https://github.com/HeyPuter/puter/commit/d46b043c5d16f1205d61de3f3ba43ed8ad7bff93))
|
| 588 |
+
* **phoenix:** Add --dump and --file options to sed ([f250f86](https://github.com/HeyPuter/puter/commit/f250f86446a506f24fa2ad396328e3a2212a68d0))
|
| 589 |
+
* **phoenix:** Add more commands to sed, including labels and branching ([306014a](https://github.com/HeyPuter/puter/commit/306014adc77a7ca155feb95d1146cb46ee075b52))
|
| 590 |
+
* **phoenix:** Expose parsed arg tokens to apps that request them ([4067c82](https://github.com/HeyPuter/puter/commit/4067c82486c99cad20f41927ad39ebea438b717f))
|
| 591 |
+
* **phoenix:** Implement an `exit` builtin ([3184d34](https://github.com/HeyPuter/puter/commit/3184d3482c7b95c0fd1fc0745555ff82fc9a8c99))
|
| 592 |
+
* **phoenix:** Implement parsing of sed scripts ([0d4f907](https://github.com/HeyPuter/puter/commit/0d4f907b6675b15bd50a55f50aa28f0803b18b7b))
|
| 593 |
+
* **phoenix:** Make `clear` clear scrollback unless `-x` is given ([75a989a](https://github.com/HeyPuter/puter/commit/75a989a7b69bfdfdf69e5f0365027c5b27d8bfc6))
|
| 594 |
+
* **Phoenix:** Pass command line arguments and ENV when launching apps ([8f1c4fc](https://github.com/HeyPuter/puter/commit/8f1c4fcda98e72a7b970e8c6fc2fe39a5e012264))
|
| 595 |
+
* **phoenix:** Respond to exit status codes ([5de3052](https://github.com/HeyPuter/puter/commit/5de305202656a172b187dac87543d6c1c69a2958))
|
| 596 |
+
* **phoenix:** Show actual host name in prompt and neofetch ([4539408](https://github.com/HeyPuter/puter/commit/4539408a218a50244dc615cf7de56c29dcac53e6))
|
| 597 |
+
* rate-limit for excessive groups ([4af279a](https://github.com/HeyPuter/puter/commit/4af279a72fc9de89ddc3ba51806ca3760a36265d))
|
| 598 |
+
* re-send unreads on login ([02fc4d8](https://github.com/HeyPuter/puter/commit/02fc4d86b7166fb4803be5d28e2a593d6b7d9785))
|
| 599 |
+
* register dev center to apps ([10f4d7d](https://github.com/HeyPuter/puter/commit/10f4d7d50ce9314f9c3888c74cb17c8ebbecee98))
|
| 600 |
+
* send notification when file gets shared ([2f6c428](https://github.com/HeyPuter/puter/commit/2f6c428a403a006f7878861d2f0356c3294519be))
|
| 601 |
+
* start directory index frame ([fb1e2f2](https://github.com/HeyPuter/puter/commit/fb1e2f21fb67aefe0602f6c978199c7cd019bbf7))
|
| 602 |
+
* support canonical puter.js url in dev ([fd41ae2](https://github.com/HeyPuter/puter/commit/fd41ae217c7a9f7229326f62a829471580a744bd))
|
| 603 |
+
* **ui:** add new components ([577bd59](https://github.com/HeyPuter/puter/commit/577bd59b6cc94810e851ad544f8234e25a4e6e27))
|
| 604 |
+
* **ui:** add new components ([38ba425](https://github.com/HeyPuter/puter/commit/38ba42575ce9f3506f8ce219b9580202b3ed9993))
|
| 605 |
+
* **ui:** allow component-based settings tabs ([1245960](https://github.com/HeyPuter/puter/commit/124596058a286241b51dd87ce2fc1a68478cb5b8))
|
| 606 |
+
* update share endpoint to support more things ([dd5fde5](https://github.com/HeyPuter/puter/commit/dd5fde5130c1840ab598e6622766ae835142e58a))
|
| 607 |
+
|
| 608 |
+
|
| 609 |
+
### Bug Fixes
|
| 610 |
+
|
| 611 |
+
* add app_uid param to kv interface ([f7a0549](https://github.com/HeyPuter/puter/commit/f7a054956b8739a3bc305a49faee929ea0da1e15))
|
| 612 |
+
* add missing columns for public directory update ([b10302a](https://github.com/HeyPuter/puter/commit/b10302ad744fd9c58f9735743e075815183c772c))
|
| 613 |
+
* Add missing file extension to 0009_app-prefix-fix.sql in DB init ([a8160a8](https://github.com/HeyPuter/puter/commit/a8160a8cdcdd6aff98728a6f1643d93386e6bb5a))
|
| 614 |
+
* add permission implicator for file modes ([e63ab3a](https://github.com/HeyPuter/puter/commit/e63ab3a67f6555eb13d6af477a8da9f1b54d6608))
|
| 615 |
+
* add stream limit ([ceba309](https://github.com/HeyPuter/puter/commit/ceba309dbd4df89f310d1a530f939a5b7991f4c7))
|
| 616 |
+
* **backend:** remove a bad thing that really doesn't work ([8d22276](https://github.com/HeyPuter/puter/commit/8d22276f13106f7642d11da30b1500817a20ad43))
|
| 617 |
+
* bug introduced when refactoring /share to Sequence ([ecb9978](https://github.com/HeyPuter/puter/commit/ecb997885c1efb766827c84d2ffb8dc6ddabe992))
|
| 618 |
+
* check subdomain earlier for /apps ([4e3a24e](https://github.com/HeyPuter/puter/commit/4e3a24e6093e279e210765e07e436f4e63b74072))
|
| 619 |
+
* column nullability blunder ([1429d6f](https://github.com/HeyPuter/puter/commit/1429d6f57c67dff51fc41ca0c2868f8d000845f1))
|
| 620 |
+
* Correct APIError imports ([062e23b](https://github.com/HeyPuter/puter/commit/062e23b5c9673db1f8b0ff0469289d52dd1e3f99))
|
| 621 |
+
* correct shown flag behavior ([632c536](https://github.com/HeyPuter/puter/commit/632c5366161ff8fbbd4d60c61dfbe52dad488a2c))
|
| 622 |
+
* database migration ([9b39309](https://github.com/HeyPuter/puter/commit/9b39309e18a2927d25fe794d91da4e4d068c4bca))
|
| 623 |
+
* do not delegate to select on read like ever that is really dumb ([a2a10b9](https://github.com/HeyPuter/puter/commit/a2a10b94be59403e03fb08bec5d7c056ce5b554f))
|
| 624 |
+
* docker runtime fail because stdout columns ([94c0449](https://github.com/HeyPuter/puter/commit/94c0449437ce4cb26d00a15a3f277bc7b09367b4))
|
| 625 |
+
* fix issues with apps in /share endpoint ([0cf90ee](https://github.com/HeyPuter/puter/commit/0cf90ee39af6548d271dec45ed8ee9e6df1cd14d))
|
| 626 |
+
* fix owner ids for default apps ([283f409](https://github.com/HeyPuter/puter/commit/283f409a662d126e7f3ce811f1467ac6fab9a522))
|
| 627 |
+
* fix permission cascade properly this time ([de58866](https://github.com/HeyPuter/puter/commit/de5886698e1eae2b250baac174b57029f3244e96))
|
| 628 |
+
* Fix phoenix app prefix and TokenService test ([afb9d86](https://github.com/HeyPuter/puter/commit/afb9d866b5091058711db931cde904947e661c15))
|
| 629 |
+
* fix that fix ([b126b67](https://github.com/HeyPuter/puter/commit/b126b670940a0e20cfe7bd0eba3db891bab5c142))
|
| 630 |
+
* fix typo ([ce328b7](https://github.com/HeyPuter/puter/commit/ce328b7245ad741b64c5885f64f806fc98a55d84))
|
| 631 |
+
* **git:** Make git commit display detached HEAD correctly ([73d0f5a](https://github.com/HeyPuter/puter/commit/73d0f5a90cb5dcbadfc6d0fd22f14e8bc0e61f86))
|
| 632 |
+
* group permission audit table ([7d2f6d2](https://github.com/HeyPuter/puter/commit/7d2f6d256f56e30d752e9999c6e8bde68f9d9637))
|
| 633 |
+
* handle subpaths under another user ([d128cee](https://github.com/HeyPuter/puter/commit/d128ceed6f4928fa0793815feb2e2715cd273ff8))
|
| 634 |
+
* handling of batch requests with zero files ([c0063a8](https://github.com/HeyPuter/puter/commit/c0063a871fd891a1774f1bee00e86170fed249fa))
|
| 635 |
+
* i forgot to test reloading ([7eabb43](https://github.com/HeyPuter/puter/commit/7eabb43bd4257b4129d67eaeda2aa27e8268dc78))
|
| 636 |
+
* improve console experience on mac ([15465bf](https://github.com/HeyPuter/puter/commit/15465bfc5035a64762f7c86a3d38af8be6be5b59))
|
| 637 |
+
* incorrect error from suggested_apps ([b648817](https://github.com/HeyPuter/puter/commit/b648817f2743c2b6214ebe4177d921c9b9027594))
|
| 638 |
+
* Make polyfilled import.meta.filename getter a valid function ([85c6798](https://github.com/HeyPuter/puter/commit/85c679844869b6b05fcbda231d8dc7026a66da97))
|
| 639 |
+
* null email in request to /share ([bf63144](https://github.com/HeyPuter/puter/commit/bf63144f7a79c48bd650ae851ddd0c8a10d748c3))
|
| 640 |
+
* Only run Component initialization functions once ([5b43358](https://github.com/HeyPuter/puter/commit/5b43358219402bee3eadf4a0f184a4b924d3293b))
|
| 641 |
+
* oops ([a136ee5](https://github.com/HeyPuter/puter/commit/a136ee5edd3149798a0d82f494f423f503b65f00))
|
| 642 |
+
* **parsely:** Make Repeat parser work when no separator is given ([9b4d16f](https://github.com/HeyPuter/puter/commit/9b4d16fbe9d5698c57f9da725a22b528a7d7cac2))
|
| 643 |
+
* peers array assumption ([10cbf08](https://github.com/HeyPuter/puter/commit/10cbf08233620440aa39f5302deaac4f59f02247))
|
| 644 |
+
* **phoenix:** Add missing newlines to sed command output ([e047b0b](https://github.com/HeyPuter/puter/commit/e047b0bf302284da61e677432e4cc25b531b24f2))
|
| 645 |
+
* **phoenix:** Gracefully handle completing a non-existent path ([d76e713](https://github.com/HeyPuter/puter/commit/d76e7130cba9f0ca05940abafe4fd1a41464aa83))
|
| 646 |
+
* property validation on some permission endpoints ([0855f2b](https://github.com/HeyPuter/puter/commit/0855f2b36eca3bbdaa8429cbde3aa1242e8e96ee))
|
| 647 |
+
* readdir on file ([a72ec97](https://github.com/HeyPuter/puter/commit/a72ec9799ac3bd76ceafa22cce149e373a13f3b9))
|
| 648 |
+
* remove last component when share URL is file ([1166e69](https://github.com/HeyPuter/puter/commit/1166e69c76688d1811701c56cd4df9d38e286793))
|
| 649 |
+
* remove legacy permission check in stat ([f2c6e01](https://github.com/HeyPuter/puter/commit/f2c6e01296e4214336e63bc2d69bcbf17f59890f))
|
| 650 |
+
* Remove null or duplicate app entries from suggest_app_for_fsentry() ([6900233](https://github.com/HeyPuter/puter/commit/6900233c5aaa2d1a49f495e9f9a060796757a91e))
|
| 651 |
+
* **security:** Move token for socket.io to request body ([49b257e](https://github.com/HeyPuter/puter/commit/49b257ecffbb1e12090b86a67528a5ad09da69db))
|
| 652 |
+
* switch share notif username to sender ([cd65217](https://github.com/HeyPuter/puter/commit/cd65217f5cda1c986ee231e2eeeef5abefa36ecb))
|
| 653 |
+
* **Terminal:** Accept input from Chrome on Android ([4ef3e53](https://github.com/HeyPuter/puter/commit/4ef3e53de34f0097950a7e707ca2483863beafb5))
|
| 654 |
+
* Throw an error when readdir is called on a non-directory ([46eb4ed](https://github.com/HeyPuter/puter/commit/46eb4ed2b96c235e10e15645a30d2f192a1af0de))
|
| 655 |
+
* type error in puter-site ([d96f924](https://github.com/HeyPuter/puter/commit/d96f924cad7a13ea6e9084bb0ebb79ecc5fcb8a3))
|
| 656 |
+
* ui color input attributes ([d9c4fbb](https://github.com/HeyPuter/puter/commit/d9c4fbbd1dcce12ee05ee33652a5fa518196463d))
|
| 657 |
+
* **ui:** improve Component base class ([f8780d0](https://github.com/HeyPuter/puter/commit/f8780d032b10138851c22af53b8610c578139acc))
|
| 658 |
+
* update email share object ([9033f6f](https://github.com/HeyPuter/puter/commit/9033f6f8c74ef8739294d640ac1c7eba95519bbd))
|
| 659 |
+
* update PD alert custom details ([2f16322](https://github.com/HeyPuter/puter/commit/2f163221bdde09425cae11ef7f8e4eb0b10c7103))
|
| 660 |
+
* update test kernel ([55c609b](https://github.com/HeyPuter/puter/commit/55c609b3fec4ef018febc6e88c44a6277960d728))
|
| 661 |
+
* validate size metadata ([2008db0](https://github.com/HeyPuter/puter/commit/2008db08524259264a0c8186a34fc75d7a133f5f))
|
| 662 |
+
|
| 663 |
+
## 2.3.0 (2024-05-22)
|
| 664 |
+
|
| 665 |
+
|
| 666 |
+
### Features
|
| 667 |
+
|
| 668 |
+
* add /healthcheck endpoint ([c166560](https://github.com/HeyPuter/puter/commit/c166560ff4ab5a453d3ec4f97326c995deb7f522))
|
| 669 |
+
* Add command names to phoenix tab-completion ([cf0eee1](https://github.com/HeyPuter/puter/commit/cf0eee1fa35328e05aefc8a425b5977efe5f4ec9))
|
| 670 |
+
* add option to change desktop background to default ([03f05f3](https://github.com/HeyPuter/puter/commit/03f05f316f11e8afe5fcee40b2b80a0de5e6826f))
|
| 671 |
+
* allow apps to add a menubar via puter.js ([331d9e7](https://github.com/HeyPuter/puter/commit/331d9e75428ec7609394f59b1755374c7340f83e))
|
| 672 |
+
* Allow querying puter-apps driver by partial app names ([dc5b010](https://github.com/HeyPuter/puter/commit/dc5b010d0913d2151b4851f8da5df72d2c8f42e7))
|
| 673 |
+
* Display upload errors in UIWindowProgress dialog ([edebbee](https://github.com/HeyPuter/puter/commit/edebbee9e7e9efbb33bf709b637c103be40d15a8))
|
| 674 |
+
* Implement 'Like' predicate in entity storage ([a854a0d](https://github.com/HeyPuter/puter/commit/a854a0dc0aa79a31695db833184c5ca3698632a9))
|
| 675 |
+
* improve password recovery experience ([04432df](https://github.com/HeyPuter/puter/commit/04432df5540811710ce1cc47ce6c136e5453bccb))
|
| 676 |
+
* **security:** add ip rate limiting ([ccf1afc](https://github.com/HeyPuter/puter/commit/ccf1afc93c24ee7f9a126216209a185d6b4d9fe4))
|
| 677 |
+
* Show "Deleting /foo" in progress window when deleting files ([f07c13a](https://github.com/HeyPuter/puter/commit/f07c13a50cee790eec44bce2f6e56fbcbf73f9b0))
|
| 678 |
+
|
| 679 |
+
|
| 680 |
+
### Bug Fixes
|
| 681 |
+
|
| 682 |
+
* Add missing file extension to 0009_app-prefix-fix.sql in DB init ([a8160a8](https://github.com/HeyPuter/puter/commit/a8160a8cdcdd6aff98728a6f1643d93386e6bb5a))
|
| 683 |
+
* Add missing TextEncoder to PTT ([8d4a1e0](https://github.com/HeyPuter/puter/commit/8d4a1e0ed3872e2c82b9e4be9b6d8b359e9cea09))
|
| 684 |
+
* Correct APIError imports ([062e23b](https://github.com/HeyPuter/puter/commit/062e23b5c9673db1f8b0ff0469289d52dd1e3f99))
|
| 685 |
+
* Correct grep output when asking for line numbers ([c8a20ca](https://github.com/HeyPuter/puter/commit/c8a20cadbfd539d185d32f4558916825fcf265ba))
|
| 686 |
+
* Correct inverted instanceof check in SignalReader.read() ([d4c2b49](https://github.com/HeyPuter/puter/commit/d4c2b492ef4864804776d3cb7d24797fdc536886))
|
| 687 |
+
* Correct variables used in errors in sign.js ([fa7c6be](https://github.com/HeyPuter/puter/commit/fa7c6bee9699527028be0ae9759155bc67c52324))
|
| 688 |
+
* Eliminates duplicate translation keys ([5800350](https://github.com/HeyPuter/puter/commit/5800350b253994dea410afff64e3df2a171e7775))
|
| 689 |
+
* fix error handling for outdated node versions ([4c1d5a4](https://github.com/HeyPuter/puter/commit/4c1d5a4b6d009ce075897d499d3517219bd745a4))
|
| 690 |
+
* Fix phoenix app prefix and TokenService test ([afb9d86](https://github.com/HeyPuter/puter/commit/afb9d866b5091058711db931cde904947e661c15))
|
| 691 |
+
* increase QR code size ([d2de46e](https://github.com/HeyPuter/puter/commit/d2de46edfbc05d132d5c929f6935b82515fbbda0))
|
| 692 |
+
* Make PathCommandProvider reject queries with path separators ([d733119](https://github.com/HeyPuter/puter/commit/d73311945610417a1ebc7bb0723ced0a599594b4))
|
| 693 |
+
* Make url variable accessible to all users of it ([2f30ae7](https://github.com/HeyPuter/puter/commit/2f30ae7a825adcd8da95888c38fe39c34acee0ff))
|
| 694 |
+
* Only run Component initialization functions once ([5b43358](https://github.com/HeyPuter/puter/commit/5b43358219402bee3eadf4a0f184a4b924d3293b))
|
| 695 |
+
* Parse octal echo escapes ([6ad8f5e](https://github.com/HeyPuter/puter/commit/6ad8f5e06abd050d319271f818d72debf5bc8e44))
|
| 696 |
+
* reduce token lengths ([5a76bad](https://github.com/HeyPuter/puter/commit/5a76bad28dfd8ec89a309941e410a54927fae22d))
|
| 697 |
+
* reliability issue :bug: ([1d546d9](https://github.com/HeyPuter/puter/commit/1d546d9ef70ef9066ad5838e9782ae330d289f29))
|
| 698 |
+
* Remove null or duplicate app entries from suggest_app_for_fsentry() ([6900233](https://github.com/HeyPuter/puter/commit/6900233c5aaa2d1a49f495e9f9a060796757a91e))
|
| 699 |
+
* **security:** always use application/octet-stream ([74e213a](https://github.com/HeyPuter/puter/commit/74e213a534dbf2844c8cebeee7eb59ec70de306e))
|
| 700 |
+
* **security:** Fix session revocation ([eb166a6](https://github.com/HeyPuter/puter/commit/eb166a67a9f0caf4fd77f9e27dc8209c2fc51f4c))
|
| 701 |
+
* **security:** Move token for socket.io to request body ([49b257e](https://github.com/HeyPuter/puter/commit/49b257ecffbb1e12090b86a67528a5ad09da69db))
|
| 702 |
+
* **security:** Prevent email enumeration ([ed70314](https://github.com/HeyPuter/puter/commit/ed703146863f896df76c98fad7127c6748c0ef9b))
|
| 703 |
+
* **security:** skip cache when checking old passwd ([7800ef6](https://github.com/HeyPuter/puter/commit/7800ef61029c8d1ba47491b4028a0cb972298725))
|
| 704 |
+
* **Terminal:** Accept input from Chrome on Android ([4ef3e53](https://github.com/HeyPuter/puter/commit/4ef3e53de34f0097950a7e707ca2483863beafb5))
|
| 705 |
+
* test release-please action [#3](https://github.com/HeyPuter/puter/issues/3) ([8fb0a66](https://github.com/HeyPuter/puter/commit/8fb0a66ef21921990e564e5f61c0e80e7f929dc7))
|
| 706 |
+
* test release-please action [#4](https://github.com/HeyPuter/puter/issues/4) ([f392de7](https://github.com/HeyPuter/puter/commit/f392de722a5232b622ed91b656a31cdc443c2e84))
|
| 707 |
+
* typographical error :bug: ([2949f71](https://github.com/HeyPuter/puter/commit/2949f71691eb0a258888c5d2a5bb496d2fe64a23))
|
| 708 |
+
* typographical errors :bug: ([4d30740](https://github.com/HeyPuter/puter/commit/4d30740198402cd1cc61b9ea4c45e006b69ec87e))
|
| 709 |
+
* Use correct variable for version number ([52d5299](https://github.com/HeyPuter/puter/commit/52d52993744dffa9f7f59a232da5df9077560731))
|
| 710 |
+
* use primary read in signup ([30f17ad](https://github.com/HeyPuter/puter/commit/30f17ade3a893d2283316e581836607e2029f9b9))
|
| 711 |
+
|
| 712 |
+
## [2.2.0](https://github.com/HeyPuter/puter/compare/v2.1.1...v2.2.0) (2024-04-23)
|
| 713 |
+
|
| 714 |
+
|
| 715 |
+
### Features
|
| 716 |
+
|
| 717 |
+
* add /healthcheck endpoint ([c166560](https://github.com/HeyPuter/puter/commit/c166560ff4ab5a453d3ec4f97326c995deb7f522))
|
| 718 |
+
* allow apps to add a menubar via puter.js ([331d9e7](https://github.com/HeyPuter/puter/commit/331d9e75428ec7609394f59b1755374c7340f83e))
|
| 719 |
+
|
| 720 |
+
## [2.1.1](https://github.com/HeyPuter/puter/compare/v2.1.0...v2.1.1) (2024-04-22)
|
| 721 |
+
|
| 722 |
+
|
| 723 |
+
### Bug Fixes
|
| 724 |
+
|
| 725 |
+
* test release-please action [#3](https://github.com/HeyPuter/puter/issues/3) ([8fb0a66](https://github.com/HeyPuter/puter/commit/8fb0a66ef21921990e564e5f61c0e80e7f929dc7))
|
| 726 |
+
* test release-please action [#4](https://github.com/HeyPuter/puter/issues/4) ([f392de7](https://github.com/HeyPuter/puter/commit/f392de722a5232b622ed91b656a31cdc443c2e84))
|
CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Contributing to Puter
|
| 2 |
+
|
| 3 |
+
Welcome to Puter, the open-source distributed internet operating system. We're excited to have you contribute to our project, whether you're reporting bugs, suggesting new features, or contributing code. This guide will help you get started with contributing to Puter in different ways.
|
| 4 |
+
|
| 5 |
+
<br>
|
| 6 |
+
|
| 7 |
+
# Report bugs
|
| 8 |
+
|
| 9 |
+
Before reporting a bug, please check [the issues on our GitHub repository](https://github.com/HeyPuter/puter/issues) to see if the bug has already been reported. If it has, you can add a comment to the existing issue with any additional information you have.
|
| 10 |
+
|
| 11 |
+
If you find a new bug in Puter, please [open an issue on our GitHub repository](https://github.com/HeyPuter/puter/issues/new). We'll do our best to address the issue as soon as possible. When reporting a bug, please include as much information as possible, including:
|
| 12 |
+
|
| 13 |
+
- A clear and descriptive title
|
| 14 |
+
- A description of the issue
|
| 15 |
+
- Steps to reproduce the bug
|
| 16 |
+
- Expected behavior
|
| 17 |
+
- Actual behavior
|
| 18 |
+
- Screenshots, if applicable
|
| 19 |
+
- Your host operating system and browser
|
| 20 |
+
- Your Puter version, location, ...
|
| 21 |
+
|
| 22 |
+
Please open a separate issue for each bug you find.
|
| 23 |
+
|
| 24 |
+
Maintainers will apply the appropriate labels to your issue.
|
| 25 |
+
|
| 26 |
+
<br>
|
| 27 |
+
|
| 28 |
+
# Suggest new features
|
| 29 |
+
|
| 30 |
+
If you have an idea for a new feature in Puter, please open a new discussion thread on our [GitHub repository](https://github.com/HeyPuter/puter/discussions) to discuss your idea with the community. We'll do our best to respond to your suggestion as soon as possible.
|
| 31 |
+
|
| 32 |
+
When suggesting a new feature, please include as much information as possible, including:
|
| 33 |
+
|
| 34 |
+
- A clear and descriptive title
|
| 35 |
+
- A description of the feature
|
| 36 |
+
- The problem the feature will solve
|
| 37 |
+
- Any relevant screenshots or mockups
|
| 38 |
+
- Any relevant links or resources
|
| 39 |
+
|
| 40 |
+
<br>
|
| 41 |
+
|
| 42 |
+
# Contribute code
|
| 43 |
+
|
| 44 |
+
If you'd like to contribute code to Puter, you need to fork the project and submit a pull request. If this is your first time contributing to an open-source project, we recommend reading this short guide by GitHub on [how to contribute to a project](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).
|
| 45 |
+
|
| 46 |
+
We'll review your pull request and work with you to get your changes merged into the project.
|
| 47 |
+
|
| 48 |
+
<br>
|
| 49 |
+
|
| 50 |
+
## PR Standards
|
| 51 |
+
|
| 52 |
+
We expect the following from pull requests (it makes things easier):
|
| 53 |
+
- If you're closing an issue, please reference that issue in the PR description
|
| 54 |
+
- Avoid whitespace changes
|
| 55 |
+
- No regressions for "appspace" (Puter apps)
|
| 56 |
+
|
| 57 |
+
<br>
|
| 58 |
+
|
| 59 |
+
## Code Review
|
| 60 |
+
|
| 61 |
+
Once you've submitted your pull request, the project maintainers will review your changes. We may suggest some changes or improvements. This is a normal part of the process, and your contributions are greatly appreciated!
|
| 62 |
+
|
| 63 |
+
<br>
|
| 64 |
+
|
| 65 |
+
## Contribution License Agreement (CLA)
|
| 66 |
+
|
| 67 |
+
Like many open source projects, we require contributors to sign a Contribution License Agreement (CLA) before we can accept your code. When you open a pull request for the first time, a bot will automatically add a comment with a link to the CLA. You can sign the CLA electronically by following the link and filling out the form.
|
| 68 |
+
|
| 69 |
+
<br>
|
| 70 |
+
|
| 71 |
+
# Getting Help
|
| 72 |
+
|
| 73 |
+
If you have any questions about Puter, please feel free to reach out to us through the following channels:
|
| 74 |
+
|
| 75 |
+
- [Discord](https://discord.com/invite/PQcx7Teh8u)
|
| 76 |
+
- [Reddit](https://www.reddit.com/r/Puter/)
|
| 77 |
+
- [Twitter](https://twitter.com/HeyPuter)
|
| 78 |
+
- [Email](mailto:support@puter.com)
|
LICENSE.txt
ADDED
|
@@ -0,0 +1,661 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
GNU AFFERO GENERAL PUBLIC LICENSE
|
| 2 |
+
Version 3, 19 November 2007
|
| 3 |
+
|
| 4 |
+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
| 5 |
+
Everyone is permitted to copy and distribute verbatim copies
|
| 6 |
+
of this license document, but changing it is not allowed.
|
| 7 |
+
|
| 8 |
+
Preamble
|
| 9 |
+
|
| 10 |
+
The GNU Affero General Public License is a free, copyleft license for
|
| 11 |
+
software and other kinds of works, specifically designed to ensure
|
| 12 |
+
cooperation with the community in the case of network server software.
|
| 13 |
+
|
| 14 |
+
The licenses for most software and other practical works are designed
|
| 15 |
+
to take away your freedom to share and change the works. By contrast,
|
| 16 |
+
our General Public Licenses are intended to guarantee your freedom to
|
| 17 |
+
share and change all versions of a program--to make sure it remains free
|
| 18 |
+
software for all its users.
|
| 19 |
+
|
| 20 |
+
When we speak of free software, we are referring to freedom, not
|
| 21 |
+
price. Our General Public Licenses are designed to make sure that you
|
| 22 |
+
have the freedom to distribute copies of free software (and charge for
|
| 23 |
+
them if you wish), that you receive source code or can get it if you
|
| 24 |
+
want it, that you can change the software or use pieces of it in new
|
| 25 |
+
free programs, and that you know you can do these things.
|
| 26 |
+
|
| 27 |
+
Developers that use our General Public Licenses protect your rights
|
| 28 |
+
with two steps: (1) assert copyright on the software, and (2) offer
|
| 29 |
+
you this License which gives you legal permission to copy, distribute
|
| 30 |
+
and/or modify the software.
|
| 31 |
+
|
| 32 |
+
A secondary benefit of defending all users' freedom is that
|
| 33 |
+
improvements made in alternate versions of the program, if they
|
| 34 |
+
receive widespread use, become available for other developers to
|
| 35 |
+
incorporate. Many developers of free software are heartened and
|
| 36 |
+
encouraged by the resulting cooperation. However, in the case of
|
| 37 |
+
software used on network servers, this result may fail to come about.
|
| 38 |
+
The GNU General Public License permits making a modified version and
|
| 39 |
+
letting the public access it on a server without ever releasing its
|
| 40 |
+
source code to the public.
|
| 41 |
+
|
| 42 |
+
The GNU Affero General Public License is designed specifically to
|
| 43 |
+
ensure that, in such cases, the modified source code becomes available
|
| 44 |
+
to the community. It requires the operator of a network server to
|
| 45 |
+
provide the source code of the modified version running there to the
|
| 46 |
+
users of that server. Therefore, public use of a modified version, on
|
| 47 |
+
a publicly accessible server, gives the public access to the source
|
| 48 |
+
code of the modified version.
|
| 49 |
+
|
| 50 |
+
An older license, called the Affero General Public License and
|
| 51 |
+
published by Affero, was designed to accomplish similar goals. This is
|
| 52 |
+
a different license, not a version of the Affero GPL, but Affero has
|
| 53 |
+
released a new version of the Affero GPL which permits relicensing under
|
| 54 |
+
this license.
|
| 55 |
+
|
| 56 |
+
The precise terms and conditions for copying, distribution and
|
| 57 |
+
modification follow.
|
| 58 |
+
|
| 59 |
+
TERMS AND CONDITIONS
|
| 60 |
+
|
| 61 |
+
0. Definitions.
|
| 62 |
+
|
| 63 |
+
"This License" refers to version 3 of the GNU Affero General Public License.
|
| 64 |
+
|
| 65 |
+
"Copyright" also means copyright-like laws that apply to other kinds of
|
| 66 |
+
works, such as semiconductor masks.
|
| 67 |
+
|
| 68 |
+
"The Program" refers to any copyrightable work licensed under this
|
| 69 |
+
License. Each licensee is addressed as "you". "Licensees" and
|
| 70 |
+
"recipients" may be individuals or organizations.
|
| 71 |
+
|
| 72 |
+
To "modify" a work means to copy from or adapt all or part of the work
|
| 73 |
+
in a fashion requiring copyright permission, other than the making of an
|
| 74 |
+
exact copy. The resulting work is called a "modified version" of the
|
| 75 |
+
earlier work or a work "based on" the earlier work.
|
| 76 |
+
|
| 77 |
+
A "covered work" means either the unmodified Program or a work based
|
| 78 |
+
on the Program.
|
| 79 |
+
|
| 80 |
+
To "propagate" a work means to do anything with it that, without
|
| 81 |
+
permission, would make you directly or secondarily liable for
|
| 82 |
+
infringement under applicable copyright law, except executing it on a
|
| 83 |
+
computer or modifying a private copy. Propagation includes copying,
|
| 84 |
+
distribution (with or without modification), making available to the
|
| 85 |
+
public, and in some countries other activities as well.
|
| 86 |
+
|
| 87 |
+
To "convey" a work means any kind of propagation that enables other
|
| 88 |
+
parties to make or receive copies. Mere interaction with a user through
|
| 89 |
+
a computer network, with no transfer of a copy, is not conveying.
|
| 90 |
+
|
| 91 |
+
An interactive user interface displays "Appropriate Legal Notices"
|
| 92 |
+
to the extent that it includes a convenient and prominently visible
|
| 93 |
+
feature that (1) displays an appropriate copyright notice, and (2)
|
| 94 |
+
tells the user that there is no warranty for the work (except to the
|
| 95 |
+
extent that warranties are provided), that licensees may convey the
|
| 96 |
+
work under this License, and how to view a copy of this License. If
|
| 97 |
+
the interface presents a list of user commands or options, such as a
|
| 98 |
+
menu, a prominent item in the list meets this criterion.
|
| 99 |
+
|
| 100 |
+
1. Source Code.
|
| 101 |
+
|
| 102 |
+
The "source code" for a work means the preferred form of the work
|
| 103 |
+
for making modifications to it. "Object code" means any non-source
|
| 104 |
+
form of a work.
|
| 105 |
+
|
| 106 |
+
A "Standard Interface" means an interface that either is an official
|
| 107 |
+
standard defined by a recognized standards body, or, in the case of
|
| 108 |
+
interfaces specified for a particular programming language, one that
|
| 109 |
+
is widely used among developers working in that language.
|
| 110 |
+
|
| 111 |
+
The "System Libraries" of an executable work include anything, other
|
| 112 |
+
than the work as a whole, that (a) is included in the normal form of
|
| 113 |
+
packaging a Major Component, but which is not part of that Major
|
| 114 |
+
Component, and (b) serves only to enable use of the work with that
|
| 115 |
+
Major Component, or to implement a Standard Interface for which an
|
| 116 |
+
implementation is available to the public in source code form. A
|
| 117 |
+
"Major Component", in this context, means a major essential component
|
| 118 |
+
(kernel, window system, and so on) of the specific operating system
|
| 119 |
+
(if any) on which the executable work runs, or a compiler used to
|
| 120 |
+
produce the work, or an object code interpreter used to run it.
|
| 121 |
+
|
| 122 |
+
The "Corresponding Source" for a work in object code form means all
|
| 123 |
+
the source code needed to generate, install, and (for an executable
|
| 124 |
+
work) run the object code and to modify the work, including scripts to
|
| 125 |
+
control those activities. However, it does not include the work's
|
| 126 |
+
System Libraries, or general-purpose tools or generally available free
|
| 127 |
+
programs which are used unmodified in performing those activities but
|
| 128 |
+
which are not part of the work. For example, Corresponding Source
|
| 129 |
+
includes interface definition files associated with source files for
|
| 130 |
+
the work, and the source code for shared libraries and dynamically
|
| 131 |
+
linked subprograms that the work is specifically designed to require,
|
| 132 |
+
such as by intimate data communication or control flow between those
|
| 133 |
+
subprograms and other parts of the work.
|
| 134 |
+
|
| 135 |
+
The Corresponding Source need not include anything that users
|
| 136 |
+
can regenerate automatically from other parts of the Corresponding
|
| 137 |
+
Source.
|
| 138 |
+
|
| 139 |
+
The Corresponding Source for a work in source code form is that
|
| 140 |
+
same work.
|
| 141 |
+
|
| 142 |
+
2. Basic Permissions.
|
| 143 |
+
|
| 144 |
+
All rights granted under this License are granted for the term of
|
| 145 |
+
copyright on the Program, and are irrevocable provided the stated
|
| 146 |
+
conditions are met. This License explicitly affirms your unlimited
|
| 147 |
+
permission to run the unmodified Program. The output from running a
|
| 148 |
+
covered work is covered by this License only if the output, given its
|
| 149 |
+
content, constitutes a covered work. This License acknowledges your
|
| 150 |
+
rights of fair use or other equivalent, as provided by copyright law.
|
| 151 |
+
|
| 152 |
+
You may make, run and propagate covered works that you do not
|
| 153 |
+
convey, without conditions so long as your license otherwise remains
|
| 154 |
+
in force. You may convey covered works to others for the sole purpose
|
| 155 |
+
of having them make modifications exclusively for you, or provide you
|
| 156 |
+
with facilities for running those works, provided that you comply with
|
| 157 |
+
the terms of this License in conveying all material for which you do
|
| 158 |
+
not control copyright. Those thus making or running the covered works
|
| 159 |
+
for you must do so exclusively on your behalf, under your direction
|
| 160 |
+
and control, on terms that prohibit them from making any copies of
|
| 161 |
+
your copyrighted material outside their relationship with you.
|
| 162 |
+
|
| 163 |
+
Conveying under any other circumstances is permitted solely under
|
| 164 |
+
the conditions stated below. Sublicensing is not allowed; section 10
|
| 165 |
+
makes it unnecessary.
|
| 166 |
+
|
| 167 |
+
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
| 168 |
+
|
| 169 |
+
No covered work shall be deemed part of an effective technological
|
| 170 |
+
measure under any applicable law fulfilling obligations under article
|
| 171 |
+
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
| 172 |
+
similar laws prohibiting or restricting circumvention of such
|
| 173 |
+
measures.
|
| 174 |
+
|
| 175 |
+
When you convey a covered work, you waive any legal power to forbid
|
| 176 |
+
circumvention of technological measures to the extent such circumvention
|
| 177 |
+
is effected by exercising rights under this License with respect to
|
| 178 |
+
the covered work, and you disclaim any intention to limit operation or
|
| 179 |
+
modification of the work as a means of enforcing, against the work's
|
| 180 |
+
users, your or third parties' legal rights to forbid circumvention of
|
| 181 |
+
technological measures.
|
| 182 |
+
|
| 183 |
+
4. Conveying Verbatim Copies.
|
| 184 |
+
|
| 185 |
+
You may convey verbatim copies of the Program's source code as you
|
| 186 |
+
receive it, in any medium, provided that you conspicuously and
|
| 187 |
+
appropriately publish on each copy an appropriate copyright notice;
|
| 188 |
+
keep intact all notices stating that this License and any
|
| 189 |
+
non-permissive terms added in accord with section 7 apply to the code;
|
| 190 |
+
keep intact all notices of the absence of any warranty; and give all
|
| 191 |
+
recipients a copy of this License along with the Program.
|
| 192 |
+
|
| 193 |
+
You may charge any price or no price for each copy that you convey,
|
| 194 |
+
and you may offer support or warranty protection for a fee.
|
| 195 |
+
|
| 196 |
+
5. Conveying Modified Source Versions.
|
| 197 |
+
|
| 198 |
+
You may convey a work based on the Program, or the modifications to
|
| 199 |
+
produce it from the Program, in the form of source code under the
|
| 200 |
+
terms of section 4, provided that you also meet all of these conditions:
|
| 201 |
+
|
| 202 |
+
a) The work must carry prominent notices stating that you modified
|
| 203 |
+
it, and giving a relevant date.
|
| 204 |
+
|
| 205 |
+
b) The work must carry prominent notices stating that it is
|
| 206 |
+
released under this License and any conditions added under section
|
| 207 |
+
7. This requirement modifies the requirement in section 4 to
|
| 208 |
+
"keep intact all notices".
|
| 209 |
+
|
| 210 |
+
c) You must license the entire work, as a whole, under this
|
| 211 |
+
License to anyone who comes into possession of a copy. This
|
| 212 |
+
License will therefore apply, along with any applicable section 7
|
| 213 |
+
additional terms, to the whole of the work, and all its parts,
|
| 214 |
+
regardless of how they are packaged. This License gives no
|
| 215 |
+
permission to license the work in any other way, but it does not
|
| 216 |
+
invalidate such permission if you have separately received it.
|
| 217 |
+
|
| 218 |
+
d) If the work has interactive user interfaces, each must display
|
| 219 |
+
Appropriate Legal Notices; however, if the Program has interactive
|
| 220 |
+
interfaces that do not display Appropriate Legal Notices, your
|
| 221 |
+
work need not make them do so.
|
| 222 |
+
|
| 223 |
+
A compilation of a covered work with other separate and independent
|
| 224 |
+
works, which are not by their nature extensions of the covered work,
|
| 225 |
+
and which are not combined with it such as to form a larger program,
|
| 226 |
+
in or on a volume of a storage or distribution medium, is called an
|
| 227 |
+
"aggregate" if the compilation and its resulting copyright are not
|
| 228 |
+
used to limit the access or legal rights of the compilation's users
|
| 229 |
+
beyond what the individual works permit. Inclusion of a covered work
|
| 230 |
+
in an aggregate does not cause this License to apply to the other
|
| 231 |
+
parts of the aggregate.
|
| 232 |
+
|
| 233 |
+
6. Conveying Non-Source Forms.
|
| 234 |
+
|
| 235 |
+
You may convey a covered work in object code form under the terms
|
| 236 |
+
of sections 4 and 5, provided that you also convey the
|
| 237 |
+
machine-readable Corresponding Source under the terms of this License,
|
| 238 |
+
in one of these ways:
|
| 239 |
+
|
| 240 |
+
a) Convey the object code in, or embodied in, a physical product
|
| 241 |
+
(including a physical distribution medium), accompanied by the
|
| 242 |
+
Corresponding Source fixed on a durable physical medium
|
| 243 |
+
customarily used for software interchange.
|
| 244 |
+
|
| 245 |
+
b) Convey the object code in, or embodied in, a physical product
|
| 246 |
+
(including a physical distribution medium), accompanied by a
|
| 247 |
+
written offer, valid for at least three years and valid for as
|
| 248 |
+
long as you offer spare parts or customer support for that product
|
| 249 |
+
model, to give anyone who possesses the object code either (1) a
|
| 250 |
+
copy of the Corresponding Source for all the software in the
|
| 251 |
+
product that is covered by this License, on a durable physical
|
| 252 |
+
medium customarily used for software interchange, for a price no
|
| 253 |
+
more than your reasonable cost of physically performing this
|
| 254 |
+
conveying of source, or (2) access to copy the
|
| 255 |
+
Corresponding Source from a network server at no charge.
|
| 256 |
+
|
| 257 |
+
c) Convey individual copies of the object code with a copy of the
|
| 258 |
+
written offer to provide the Corresponding Source. This
|
| 259 |
+
alternative is allowed only occasionally and noncommercially, and
|
| 260 |
+
only if you received the object code with such an offer, in accord
|
| 261 |
+
with subsection 6b.
|
| 262 |
+
|
| 263 |
+
d) Convey the object code by offering access from a designated
|
| 264 |
+
place (gratis or for a charge), and offer equivalent access to the
|
| 265 |
+
Corresponding Source in the same way through the same place at no
|
| 266 |
+
further charge. You need not require recipients to copy the
|
| 267 |
+
Corresponding Source along with the object code. If the place to
|
| 268 |
+
copy the object code is a network server, the Corresponding Source
|
| 269 |
+
may be on a different server (operated by you or a third party)
|
| 270 |
+
that supports equivalent copying facilities, provided you maintain
|
| 271 |
+
clear directions next to the object code saying where to find the
|
| 272 |
+
Corresponding Source. Regardless of what server hosts the
|
| 273 |
+
Corresponding Source, you remain obligated to ensure that it is
|
| 274 |
+
available for as long as needed to satisfy these requirements.
|
| 275 |
+
|
| 276 |
+
e) Convey the object code using peer-to-peer transmission, provided
|
| 277 |
+
you inform other peers where the object code and Corresponding
|
| 278 |
+
Source of the work are being offered to the general public at no
|
| 279 |
+
charge under subsection 6d.
|
| 280 |
+
|
| 281 |
+
A separable portion of the object code, whose source code is excluded
|
| 282 |
+
from the Corresponding Source as a System Library, need not be
|
| 283 |
+
included in conveying the object code work.
|
| 284 |
+
|
| 285 |
+
A "User Product" is either (1) a "consumer product", which means any
|
| 286 |
+
tangible personal property which is normally used for personal, family,
|
| 287 |
+
or household purposes, or (2) anything designed or sold for incorporation
|
| 288 |
+
into a dwelling. In determining whether a product is a consumer product,
|
| 289 |
+
doubtful cases shall be resolved in favor of coverage. For a particular
|
| 290 |
+
product received by a particular user, "normally used" refers to a
|
| 291 |
+
typical or common use of that class of product, regardless of the status
|
| 292 |
+
of the particular user or of the way in which the particular user
|
| 293 |
+
actually uses, or expects or is expected to use, the product. A product
|
| 294 |
+
is a consumer product regardless of whether the product has substantial
|
| 295 |
+
commercial, industrial or non-consumer uses, unless such uses represent
|
| 296 |
+
the only significant mode of use of the product.
|
| 297 |
+
|
| 298 |
+
"Installation Information" for a User Product means any methods,
|
| 299 |
+
procedures, authorization keys, or other information required to install
|
| 300 |
+
and execute modified versions of a covered work in that User Product from
|
| 301 |
+
a modified version of its Corresponding Source. The information must
|
| 302 |
+
suffice to ensure that the continued functioning of the modified object
|
| 303 |
+
code is in no case prevented or interfered with solely because
|
| 304 |
+
modification has been made.
|
| 305 |
+
|
| 306 |
+
If you convey an object code work under this section in, or with, or
|
| 307 |
+
specifically for use in, a User Product, and the conveying occurs as
|
| 308 |
+
part of a transaction in which the right of possession and use of the
|
| 309 |
+
User Product is transferred to the recipient in perpetuity or for a
|
| 310 |
+
fixed term (regardless of how the transaction is characterized), the
|
| 311 |
+
Corresponding Source conveyed under this section must be accompanied
|
| 312 |
+
by the Installation Information. But this requirement does not apply
|
| 313 |
+
if neither you nor any third party retains the ability to install
|
| 314 |
+
modified object code on the User Product (for example, the work has
|
| 315 |
+
been installed in ROM).
|
| 316 |
+
|
| 317 |
+
The requirement to provide Installation Information does not include a
|
| 318 |
+
requirement to continue to provide support service, warranty, or updates
|
| 319 |
+
for a work that has been modified or installed by the recipient, or for
|
| 320 |
+
the User Product in which it has been modified or installed. Access to a
|
| 321 |
+
network may be denied when the modification itself materially and
|
| 322 |
+
adversely affects the operation of the network or violates the rules and
|
| 323 |
+
protocols for communication across the network.
|
| 324 |
+
|
| 325 |
+
Corresponding Source conveyed, and Installation Information provided,
|
| 326 |
+
in accord with this section must be in a format that is publicly
|
| 327 |
+
documented (and with an implementation available to the public in
|
| 328 |
+
source code form), and must require no special password or key for
|
| 329 |
+
unpacking, reading or copying.
|
| 330 |
+
|
| 331 |
+
7. Additional Terms.
|
| 332 |
+
|
| 333 |
+
"Additional permissions" are terms that supplement the terms of this
|
| 334 |
+
License by making exceptions from one or more of its conditions.
|
| 335 |
+
Additional permissions that are applicable to the entire Program shall
|
| 336 |
+
be treated as though they were included in this License, to the extent
|
| 337 |
+
that they are valid under applicable law. If additional permissions
|
| 338 |
+
apply only to part of the Program, that part may be used separately
|
| 339 |
+
under those permissions, but the entire Program remains governed by
|
| 340 |
+
this License without regard to the additional permissions.
|
| 341 |
+
|
| 342 |
+
When you convey a copy of a covered work, you may at your option
|
| 343 |
+
remove any additional permissions from that copy, or from any part of
|
| 344 |
+
it. (Additional permissions may be written to require their own
|
| 345 |
+
removal in certain cases when you modify the work.) You may place
|
| 346 |
+
additional permissions on material, added by you to a covered work,
|
| 347 |
+
for which you have or can give appropriate copyright permission.
|
| 348 |
+
|
| 349 |
+
Notwithstanding any other provision of this License, for material you
|
| 350 |
+
add to a covered work, you may (if authorized by the copyright holders of
|
| 351 |
+
that material) supplement the terms of this License with terms:
|
| 352 |
+
|
| 353 |
+
a) Disclaiming warranty or limiting liability differently from the
|
| 354 |
+
terms of sections 15 and 16 of this License; or
|
| 355 |
+
|
| 356 |
+
b) Requiring preservation of specified reasonable legal notices or
|
| 357 |
+
author attributions in that material or in the Appropriate Legal
|
| 358 |
+
Notices displayed by works containing it; or
|
| 359 |
+
|
| 360 |
+
c) Prohibiting misrepresentation of the origin of that material, or
|
| 361 |
+
requiring that modified versions of such material be marked in
|
| 362 |
+
reasonable ways as different from the original version; or
|
| 363 |
+
|
| 364 |
+
d) Limiting the use for publicity purposes of names of licensors or
|
| 365 |
+
authors of the material; or
|
| 366 |
+
|
| 367 |
+
e) Declining to grant rights under trademark law for use of some
|
| 368 |
+
trade names, trademarks, or service marks; or
|
| 369 |
+
|
| 370 |
+
f) Requiring indemnification of licensors and authors of that
|
| 371 |
+
material by anyone who conveys the material (or modified versions of
|
| 372 |
+
it) with contractual assumptions of liability to the recipient, for
|
| 373 |
+
any liability that these contractual assumptions directly impose on
|
| 374 |
+
those licensors and authors.
|
| 375 |
+
|
| 376 |
+
All other non-permissive additional terms are considered "further
|
| 377 |
+
restrictions" within the meaning of section 10. If the Program as you
|
| 378 |
+
received it, or any part of it, contains a notice stating that it is
|
| 379 |
+
governed by this License along with a term that is a further
|
| 380 |
+
restriction, you may remove that term. If a license document contains
|
| 381 |
+
a further restriction but permits relicensing or conveying under this
|
| 382 |
+
License, you may add to a covered work material governed by the terms
|
| 383 |
+
of that license document, provided that the further restriction does
|
| 384 |
+
not survive such relicensing or conveying.
|
| 385 |
+
|
| 386 |
+
If you add terms to a covered work in accord with this section, you
|
| 387 |
+
must place, in the relevant source files, a statement of the
|
| 388 |
+
additional terms that apply to those files, or a notice indicating
|
| 389 |
+
where to find the applicable terms.
|
| 390 |
+
|
| 391 |
+
Additional terms, permissive or non-permissive, may be stated in the
|
| 392 |
+
form of a separately written license, or stated as exceptions;
|
| 393 |
+
the above requirements apply either way.
|
| 394 |
+
|
| 395 |
+
8. Termination.
|
| 396 |
+
|
| 397 |
+
You may not propagate or modify a covered work except as expressly
|
| 398 |
+
provided under this License. Any attempt otherwise to propagate or
|
| 399 |
+
modify it is void, and will automatically terminate your rights under
|
| 400 |
+
this License (including any patent licenses granted under the third
|
| 401 |
+
paragraph of section 11).
|
| 402 |
+
|
| 403 |
+
However, if you cease all violation of this License, then your
|
| 404 |
+
license from a particular copyright holder is reinstated (a)
|
| 405 |
+
provisionally, unless and until the copyright holder explicitly and
|
| 406 |
+
finally terminates your license, and (b) permanently, if the copyright
|
| 407 |
+
holder fails to notify you of the violation by some reasonable means
|
| 408 |
+
prior to 60 days after the cessation.
|
| 409 |
+
|
| 410 |
+
Moreover, your license from a particular copyright holder is
|
| 411 |
+
reinstated permanently if the copyright holder notifies you of the
|
| 412 |
+
violation by some reasonable means, this is the first time you have
|
| 413 |
+
received notice of violation of this License (for any work) from that
|
| 414 |
+
copyright holder, and you cure the violation prior to 30 days after
|
| 415 |
+
your receipt of the notice.
|
| 416 |
+
|
| 417 |
+
Termination of your rights under this section does not terminate the
|
| 418 |
+
licenses of parties who have received copies or rights from you under
|
| 419 |
+
this License. If your rights have been terminated and not permanently
|
| 420 |
+
reinstated, you do not qualify to receive new licenses for the same
|
| 421 |
+
material under section 10.
|
| 422 |
+
|
| 423 |
+
9. Acceptance Not Required for Having Copies.
|
| 424 |
+
|
| 425 |
+
You are not required to accept this License in order to receive or
|
| 426 |
+
run a copy of the Program. Ancillary propagation of a covered work
|
| 427 |
+
occurring solely as a consequence of using peer-to-peer transmission
|
| 428 |
+
to receive a copy likewise does not require acceptance. However,
|
| 429 |
+
nothing other than this License grants you permission to propagate or
|
| 430 |
+
modify any covered work. These actions infringe copyright if you do
|
| 431 |
+
not accept this License. Therefore, by modifying or propagating a
|
| 432 |
+
covered work, you indicate your acceptance of this License to do so.
|
| 433 |
+
|
| 434 |
+
10. Automatic Licensing of Downstream Recipients.
|
| 435 |
+
|
| 436 |
+
Each time you convey a covered work, the recipient automatically
|
| 437 |
+
receives a license from the original licensors, to run, modify and
|
| 438 |
+
propagate that work, subject to this License. You are not responsible
|
| 439 |
+
for enforcing compliance by third parties with this License.
|
| 440 |
+
|
| 441 |
+
An "entity transaction" is a transaction transferring control of an
|
| 442 |
+
organization, or substantially all assets of one, or subdividing an
|
| 443 |
+
organization, or merging organizations. If propagation of a covered
|
| 444 |
+
work results from an entity transaction, each party to that
|
| 445 |
+
transaction who receives a copy of the work also receives whatever
|
| 446 |
+
licenses to the work the party's predecessor in interest had or could
|
| 447 |
+
give under the previous paragraph, plus a right to possession of the
|
| 448 |
+
Corresponding Source of the work from the predecessor in interest, if
|
| 449 |
+
the predecessor has it or can get it with reasonable efforts.
|
| 450 |
+
|
| 451 |
+
You may not impose any further restrictions on the exercise of the
|
| 452 |
+
rights granted or affirmed under this License. For example, you may
|
| 453 |
+
not impose a license fee, royalty, or other charge for exercise of
|
| 454 |
+
rights granted under this License, and you may not initiate litigation
|
| 455 |
+
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
| 456 |
+
any patent claim is infringed by making, using, selling, offering for
|
| 457 |
+
sale, or importing the Program or any portion of it.
|
| 458 |
+
|
| 459 |
+
11. Patents.
|
| 460 |
+
|
| 461 |
+
A "contributor" is a copyright holder who authorizes use under this
|
| 462 |
+
License of the Program or a work on which the Program is based. The
|
| 463 |
+
work thus licensed is called the contributor's "contributor version".
|
| 464 |
+
|
| 465 |
+
A contributor's "essential patent claims" are all patent claims
|
| 466 |
+
owned or controlled by the contributor, whether already acquired or
|
| 467 |
+
hereafter acquired, that would be infringed by some manner, permitted
|
| 468 |
+
by this License, of making, using, or selling its contributor version,
|
| 469 |
+
but do not include claims that would be infringed only as a
|
| 470 |
+
consequence of further modification of the contributor version. For
|
| 471 |
+
purposes of this definition, "control" includes the right to grant
|
| 472 |
+
patent sublicenses in a manner consistent with the requirements of
|
| 473 |
+
this License.
|
| 474 |
+
|
| 475 |
+
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
| 476 |
+
patent license under the contributor's essential patent claims, to
|
| 477 |
+
make, use, sell, offer for sale, import and otherwise run, modify and
|
| 478 |
+
propagate the contents of its contributor version.
|
| 479 |
+
|
| 480 |
+
In the following three paragraphs, a "patent license" is any express
|
| 481 |
+
agreement or commitment, however denominated, not to enforce a patent
|
| 482 |
+
(such as an express permission to practice a patent or covenant not to
|
| 483 |
+
sue for patent infringement). To "grant" such a patent license to a
|
| 484 |
+
party means to make such an agreement or commitment not to enforce a
|
| 485 |
+
patent against the party.
|
| 486 |
+
|
| 487 |
+
If you convey a covered work, knowingly relying on a patent license,
|
| 488 |
+
and the Corresponding Source of the work is not available for anyone
|
| 489 |
+
to copy, free of charge and under the terms of this License, through a
|
| 490 |
+
publicly available network server or other readily accessible means,
|
| 491 |
+
then you must either (1) cause the Corresponding Source to be so
|
| 492 |
+
available, or (2) arrange to deprive yourself of the benefit of the
|
| 493 |
+
patent license for this particular work, or (3) arrange, in a manner
|
| 494 |
+
consistent with the requirements of this License, to extend the patent
|
| 495 |
+
license to downstream recipients. "Knowingly relying" means you have
|
| 496 |
+
actual knowledge that, but for the patent license, your conveying the
|
| 497 |
+
covered work in a country, or your recipient's use of the covered work
|
| 498 |
+
in a country, would infringe one or more identifiable patents in that
|
| 499 |
+
country that you have reason to believe are valid.
|
| 500 |
+
|
| 501 |
+
If, pursuant to or in connection with a single transaction or
|
| 502 |
+
arrangement, you convey, or propagate by procuring conveyance of, a
|
| 503 |
+
covered work, and grant a patent license to some of the parties
|
| 504 |
+
receiving the covered work authorizing them to use, propagate, modify
|
| 505 |
+
or convey a specific copy of the covered work, then the patent license
|
| 506 |
+
you grant is automatically extended to all recipients of the covered
|
| 507 |
+
work and works based on it.
|
| 508 |
+
|
| 509 |
+
A patent license is "discriminatory" if it does not include within
|
| 510 |
+
the scope of its coverage, prohibits the exercise of, or is
|
| 511 |
+
conditioned on the non-exercise of one or more of the rights that are
|
| 512 |
+
specifically granted under this License. You may not convey a covered
|
| 513 |
+
work if you are a party to an arrangement with a third party that is
|
| 514 |
+
in the business of distributing software, under which you make payment
|
| 515 |
+
to the third party based on the extent of your activity of conveying
|
| 516 |
+
the work, and under which the third party grants, to any of the
|
| 517 |
+
parties who would receive the covered work from you, a discriminatory
|
| 518 |
+
patent license (a) in connection with copies of the covered work
|
| 519 |
+
conveyed by you (or copies made from those copies), or (b) primarily
|
| 520 |
+
for and in connection with specific products or compilations that
|
| 521 |
+
contain the covered work, unless you entered into that arrangement,
|
| 522 |
+
or that patent license was granted, prior to 28 March 2007.
|
| 523 |
+
|
| 524 |
+
Nothing in this License shall be construed as excluding or limiting
|
| 525 |
+
any implied license or other defenses to infringement that may
|
| 526 |
+
otherwise be available to you under applicable patent law.
|
| 527 |
+
|
| 528 |
+
12. No Surrender of Others' Freedom.
|
| 529 |
+
|
| 530 |
+
If conditions are imposed on you (whether by court order, agreement or
|
| 531 |
+
otherwise) that contradict the conditions of this License, they do not
|
| 532 |
+
excuse you from the conditions of this License. If you cannot convey a
|
| 533 |
+
covered work so as to satisfy simultaneously your obligations under this
|
| 534 |
+
License and any other pertinent obligations, then as a consequence you may
|
| 535 |
+
not convey it at all. For example, if you agree to terms that obligate you
|
| 536 |
+
to collect a royalty for further conveying from those to whom you convey
|
| 537 |
+
the Program, the only way you could satisfy both those terms and this
|
| 538 |
+
License would be to refrain entirely from conveying the Program.
|
| 539 |
+
|
| 540 |
+
13. Remote Network Interaction; Use with the GNU General Public License.
|
| 541 |
+
|
| 542 |
+
Notwithstanding any other provision of this License, if you modify the
|
| 543 |
+
Program, your modified version must prominently offer all users
|
| 544 |
+
interacting with it remotely through a computer network (if your version
|
| 545 |
+
supports such interaction) an opportunity to receive the Corresponding
|
| 546 |
+
Source of your version by providing access to the Corresponding Source
|
| 547 |
+
from a network server at no charge, through some standard or customary
|
| 548 |
+
means of facilitating copying of software. This Corresponding Source
|
| 549 |
+
shall include the Corresponding Source for any work covered by version 3
|
| 550 |
+
of the GNU General Public License that is incorporated pursuant to the
|
| 551 |
+
following paragraph.
|
| 552 |
+
|
| 553 |
+
Notwithstanding any other provision of this License, you have
|
| 554 |
+
permission to link or combine any covered work with a work licensed
|
| 555 |
+
under version 3 of the GNU General Public License into a single
|
| 556 |
+
combined work, and to convey the resulting work. The terms of this
|
| 557 |
+
License will continue to apply to the part which is the covered work,
|
| 558 |
+
but the work with which it is combined will remain governed by version
|
| 559 |
+
3 of the GNU General Public License.
|
| 560 |
+
|
| 561 |
+
14. Revised Versions of this License.
|
| 562 |
+
|
| 563 |
+
The Free Software Foundation may publish revised and/or new versions of
|
| 564 |
+
the GNU Affero General Public License from time to time. Such new versions
|
| 565 |
+
will be similar in spirit to the present version, but may differ in detail to
|
| 566 |
+
address new problems or concerns.
|
| 567 |
+
|
| 568 |
+
Each version is given a distinguishing version number. If the
|
| 569 |
+
Program specifies that a certain numbered version of the GNU Affero General
|
| 570 |
+
Public License "or any later version" applies to it, you have the
|
| 571 |
+
option of following the terms and conditions either of that numbered
|
| 572 |
+
version or of any later version published by the Free Software
|
| 573 |
+
Foundation. If the Program does not specify a version number of the
|
| 574 |
+
GNU Affero General Public License, you may choose any version ever published
|
| 575 |
+
by the Free Software Foundation.
|
| 576 |
+
|
| 577 |
+
If the Program specifies that a proxy can decide which future
|
| 578 |
+
versions of the GNU Affero General Public License can be used, that proxy's
|
| 579 |
+
public statement of acceptance of a version permanently authorizes you
|
| 580 |
+
to choose that version for the Program.
|
| 581 |
+
|
| 582 |
+
Later license versions may give you additional or different
|
| 583 |
+
permissions. However, no additional obligations are imposed on any
|
| 584 |
+
author or copyright holder as a result of your choosing to follow a
|
| 585 |
+
later version.
|
| 586 |
+
|
| 587 |
+
15. Disclaimer of Warranty.
|
| 588 |
+
|
| 589 |
+
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
| 590 |
+
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
| 591 |
+
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
| 592 |
+
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
| 593 |
+
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
| 594 |
+
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
| 595 |
+
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
| 596 |
+
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
| 597 |
+
|
| 598 |
+
16. Limitation of Liability.
|
| 599 |
+
|
| 600 |
+
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
| 601 |
+
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
| 602 |
+
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
| 603 |
+
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
| 604 |
+
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
| 605 |
+
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
| 606 |
+
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
| 607 |
+
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
| 608 |
+
SUCH DAMAGES.
|
| 609 |
+
|
| 610 |
+
17. Interpretation of Sections 15 and 16.
|
| 611 |
+
|
| 612 |
+
If the disclaimer of warranty and limitation of liability provided
|
| 613 |
+
above cannot be given local legal effect according to their terms,
|
| 614 |
+
reviewing courts shall apply local law that most closely approximates
|
| 615 |
+
an absolute waiver of all civil liability in connection with the
|
| 616 |
+
Program, unless a warranty or assumption of liability accompanies a
|
| 617 |
+
copy of the Program in return for a fee.
|
| 618 |
+
|
| 619 |
+
END OF TERMS AND CONDITIONS
|
| 620 |
+
|
| 621 |
+
How to Apply These Terms to Your New Programs
|
| 622 |
+
|
| 623 |
+
If you develop a new program, and you want it to be of the greatest
|
| 624 |
+
possible use to the public, the best way to achieve this is to make it
|
| 625 |
+
free software which everyone can redistribute and change under these terms.
|
| 626 |
+
|
| 627 |
+
To do so, attach the following notices to the program. It is safest
|
| 628 |
+
to attach them to the start of each source file to most effectively
|
| 629 |
+
state the exclusion of warranty; and each file should have at least
|
| 630 |
+
the "copyright" line and a pointer to where the full notice is found.
|
| 631 |
+
|
| 632 |
+
<one line to give the program's name and a brief idea of what it does.>
|
| 633 |
+
Copyright (C) <year> <name of author>
|
| 634 |
+
|
| 635 |
+
This program is free software: you can redistribute it and/or modify
|
| 636 |
+
it under the terms of the GNU Affero General Public License as published by
|
| 637 |
+
the Free Software Foundation, either version 3 of the License, or
|
| 638 |
+
(at your option) any later version.
|
| 639 |
+
|
| 640 |
+
This program is distributed in the hope that it will be useful,
|
| 641 |
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
| 642 |
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
| 643 |
+
GNU Affero General Public License for more details.
|
| 644 |
+
|
| 645 |
+
You should have received a copy of the GNU Affero General Public License
|
| 646 |
+
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
| 647 |
+
|
| 648 |
+
Also add information on how to contact you by electronic and paper mail.
|
| 649 |
+
|
| 650 |
+
If your software can interact with users remotely through a computer
|
| 651 |
+
network, you should also make sure that it provides a way for users to
|
| 652 |
+
get its source. For example, if your program is a web application, its
|
| 653 |
+
interface could display a "Source" link that leads users to an archive
|
| 654 |
+
of the code. There are many ways you could offer source, and different
|
| 655 |
+
solutions will be better for different programs; see section 13 for the
|
| 656 |
+
specific requirements.
|
| 657 |
+
|
| 658 |
+
You should also get your employer (if you work as a programmer) or school,
|
| 659 |
+
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
| 660 |
+
For more information on this, and how to apply and follow the GNU AGPL, see
|
| 661 |
+
<https://www.gnu.org/licenses/>.
|
README.md
CHANGED
|
@@ -1,10 +1,187 @@
|
|
| 1 |
-
---
|
| 2 |
-
title: Puter
|
| 3 |
-
emoji:
|
| 4 |
-
colorFrom:
|
| 5 |
-
colorTo:
|
| 6 |
-
sdk: docker
|
| 7 |
-
pinned: false
|
| 8 |
-
---
|
| 9 |
-
|
| 10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: Puter
|
| 3 |
+
emoji: 🖥️
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: purple
|
| 6 |
+
sdk: docker
|
| 7 |
+
pinned: false
|
| 8 |
+
---
|
| 9 |
+
|
| 10 |
+
<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>
|
| 11 |
+
|
| 12 |
+
<h3 align="center">The Internet OS! Free, Open-Source, and Self-Hostable.</h3>
|
| 13 |
+
|
| 14 |
+
<p align="center">
|
| 15 |
+
<a href="https://puter.com/?ref=github.com"><strong>« LIVE DEMO »</strong></a>
|
| 16 |
+
<br />
|
| 17 |
+
<br />
|
| 18 |
+
<a href="https://puter.com/?ref=github.com">Puter.com</a>
|
| 19 |
+
·
|
| 20 |
+
<a href="https://puter.com/app/app-center">App Store</a>
|
| 21 |
+
·
|
| 22 |
+
<a href="https://developer.puter.com" target="_blank">Developers</a>
|
| 23 |
+
·
|
| 24 |
+
<a href="https://github.com/heyputer/puter-cli" target="_blank">CLI</a>
|
| 25 |
+
·
|
| 26 |
+
<a href="https://discord.com/invite/PQcx7Teh8u">Discord</a>
|
| 27 |
+
·
|
| 28 |
+
<a href="https://reddit.com/r/puter">Reddit</a>
|
| 29 |
+
·
|
| 30 |
+
<a href="https://twitter.com/HeyPuter">X</a>
|
| 31 |
+
</p>
|
| 32 |
+
|
| 33 |
+
<h3 align="center"><img width="800" style="border-radius:5px;" alt="screenshot" src="https://assets.puter.site/puter.com-screenshot-3.webp"></h3>
|
| 34 |
+
|
| 35 |
+
<br/>
|
| 36 |
+
|
| 37 |
+
## Puter
|
| 38 |
+
|
| 39 |
+
Puter is an advanced, open-source internet operating system designed to be feature-rich, fast, and highly extensible. Puter can be used as:
|
| 40 |
+
|
| 41 |
+
- A privacy-first personal cloud to keep all your files, apps, and games in one secure place, accessible from anywhere at any time.
|
| 42 |
+
- A platform for building and publishing websites, web apps, and games.
|
| 43 |
+
- An alternative to Dropbox, Google Drive, OneDrive, etc. with a fresh interface and powerful features.
|
| 44 |
+
- A remote desktop environment for servers and workstations.
|
| 45 |
+
- A friendly, open-source project and community to learn about web development, cloud computing, distributed systems, and much more!
|
| 46 |
+
|
| 47 |
+
<br/>
|
| 48 |
+
|
| 49 |
+
## Getting Started
|
| 50 |
+
|
| 51 |
+
### 💻 Local Development
|
| 52 |
+
|
| 53 |
+
```bash
|
| 54 |
+
git clone https://github.com/HeyPuter/puter
|
| 55 |
+
cd puter
|
| 56 |
+
npm install
|
| 57 |
+
npm start
|
| 58 |
+
```
|
| 59 |
+
**→** This should launch Puter at
|
| 60 |
+
<font color="red"> http://puter.localhost:4100 (or the next available port). </font>
|
| 61 |
+
|
| 62 |
+
|
| 63 |
+
|
| 64 |
+
If this does not work, see [First Run Issues](./doc/self-hosters/first-run-issues.md) for
|
| 65 |
+
troubleshooting steps.
|
| 66 |
+
|
| 67 |
+
<br/>
|
| 68 |
+
|
| 69 |
+
### 🐳 Docker
|
| 70 |
+
|
| 71 |
+
```bash
|
| 72 |
+
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
|
| 73 |
+
```
|
| 74 |
+
**→** This should launch Puter at
|
| 75 |
+
<font color="red"> http://puter.localhost:4100 (or the next available port). </font>
|
| 76 |
+
|
| 77 |
+
<br/>
|
| 78 |
+
|
| 79 |
+
### 🐙 Docker Compose
|
| 80 |
+
|
| 81 |
+
#### Linux/macOS
|
| 82 |
+
|
| 83 |
+
```bash
|
| 84 |
+
mkdir -p puter/config puter/data
|
| 85 |
+
sudo chown -R 1000:1000 puter
|
| 86 |
+
wget https://raw.githubusercontent.com/HeyPuter/puter/main/docker-compose.yml
|
| 87 |
+
docker compose up
|
| 88 |
+
```
|
| 89 |
+
**→** This should be available at
|
| 90 |
+
<font color="red"> http://puter.localhost:4100 (or the next available port). </font>
|
| 91 |
+
|
| 92 |
+
<br/>
|
| 93 |
+
|
| 94 |
+
#### Windows
|
| 95 |
+
|
| 96 |
+
```powershell
|
| 97 |
+
mkdir -p puter
|
| 98 |
+
cd puter
|
| 99 |
+
New-Item -Path "puter\config" -ItemType Directory -Force
|
| 100 |
+
New-Item -Path "puter\data" -ItemType Directory -Force
|
| 101 |
+
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/HeyPuter/puter/main/docker-compose.yml" -OutFile "docker-compose.yml"
|
| 102 |
+
docker compose up
|
| 103 |
+
```
|
| 104 |
+
**→** This should launch Puter at
|
| 105 |
+
<font color="red"> http://puter.localhost:4100 (or the next available port). </font>
|
| 106 |
+
|
| 107 |
+
<br/>
|
| 108 |
+
|
| 109 |
+
### 🚀 Self-Hosting
|
| 110 |
+
|
| 111 |
+
For detailed guides on self-hosting Puter, including configuration options and best practices, see our [Self-Hosting Documentation](https://github.com/HeyPuter/puter/blob/main/doc/self-hosters/instructions.md).
|
| 112 |
+
|
| 113 |
+
<br/>
|
| 114 |
+
|
| 115 |
+
### ☁️ Puter.com
|
| 116 |
+
|
| 117 |
+
Puter is available as a hosted service at [**puter.com**](https://puter.com).
|
| 118 |
+
|
| 119 |
+
<br/>
|
| 120 |
+
|
| 121 |
+
## System Requirements
|
| 122 |
+
|
| 123 |
+
- **Operating Systems:** Linux, macOS, Windows
|
| 124 |
+
- **RAM:** 2GB minimum (4GB recommended)
|
| 125 |
+
- **Disk Space:** 1GB free space
|
| 126 |
+
- **Node.js:** Version 20.19.5+ (Version 23+ recommended)
|
| 127 |
+
- **npm:** Latest stable version
|
| 128 |
+
|
| 129 |
+
<br/>
|
| 130 |
+
|
| 131 |
+
## Support
|
| 132 |
+
|
| 133 |
+
Connect with the maintainers and community through these channels:
|
| 134 |
+
|
| 135 |
+
- Bug report or feature request? Please [open an issue](https://github.com/HeyPuter/puter/issues/new/choose).
|
| 136 |
+
- Discord: [discord.com/invite/PQcx7Teh8u](https://discord.com/invite/PQcx7Teh8u)
|
| 137 |
+
- X (Twitter): [x.com/HeyPuter](https://x.com/HeyPuter)
|
| 138 |
+
- Reddit: [reddit.com/r/puter/](https://www.reddit.com/r/puter/)
|
| 139 |
+
- Mastodon: [mastodon.social/@puter](https://mastodon.social/@puter)
|
| 140 |
+
- Security issues? [security@puter.com](mailto:security@puter.com)
|
| 141 |
+
- Email maintainers at [hi@puter.com](mailto:hi@puter.com)
|
| 142 |
+
|
| 143 |
+
We are always happy to help you with any questions you may have. Don't hesitate to ask!
|
| 144 |
+
|
| 145 |
+
<br/>
|
| 146 |
+
|
| 147 |
+
## License
|
| 148 |
+
|
| 149 |
+
This repository, including all its contents, sub-projects, modules, and components, is licensed under [AGPL-3.0](https://github.com/HeyPuter/puter/blob/main/LICENSE.txt) unless explicitly stated otherwise. Third-party libraries included in this repository may be subject to their own licenses.
|
| 150 |
+
|
| 151 |
+
<br/>
|
| 152 |
+
|
| 153 |
+
## Translations
|
| 154 |
+
|
| 155 |
+
- [Arabic / العربية](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ar.md)
|
| 156 |
+
- [Armenian / Հայերեն](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.hy.md)
|
| 157 |
+
- [Bengali / বাংলা](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.bn.md)
|
| 158 |
+
- [Chinese / 中文](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.zh.md)
|
| 159 |
+
- [Danish / Dansk](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.da.md)
|
| 160 |
+
- [English](https://github.com/HeyPuter/puter/blob/main/README.md)
|
| 161 |
+
- [Farsi / فارسی](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.fa.md)
|
| 162 |
+
- [Finnish / Suomi](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.fi.md)
|
| 163 |
+
- [French / Français](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.fr.md)
|
| 164 |
+
- [German / Deutsch](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.de.md)
|
| 165 |
+
- [Hebrew/ עברית](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.he.md)
|
| 166 |
+
- [Hindi / हिंदी](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.hi.md)
|
| 167 |
+
- [Hungarian / Magyar](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.hu.md)
|
| 168 |
+
- [Indonesian / Bahasa Indonesia](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.id.md)
|
| 169 |
+
- [Italian / Italiano](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.it.md)
|
| 170 |
+
- [Japanese / 日本語](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.jp.md)
|
| 171 |
+
- [Korean / 한국어](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ko.md)
|
| 172 |
+
- [Malay / Bahasa Malaysia](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.my.md)
|
| 173 |
+
- [Malayalam / മലയാളം](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ml.md)
|
| 174 |
+
- [Polish / Polski](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.pl.md)
|
| 175 |
+
- [Portuguese / Português](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.pt.md)
|
| 176 |
+
- [Punjabi / ਪੰਜਾਬੀ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.pa.md)
|
| 177 |
+
- [Romanian / Română](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ro.md)
|
| 178 |
+
- [Russian / Русский](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ru.md)
|
| 179 |
+
- [Spanish / Español](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.es.md)
|
| 180 |
+
- [Swedish / Svenska](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.sv.md)
|
| 181 |
+
- [Tamil / தமிழ்](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ta.md)
|
| 182 |
+
- [Telugu / తెలుగు](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.te.md)
|
| 183 |
+
- [Thai / ไทย](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.th.md)
|
| 184 |
+
- [Turkish / Türkçe](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.tr.md)
|
| 185 |
+
- [Ukrainian / Українська](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ua.md)
|
| 186 |
+
- [Urdu / اردو](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ur.md)
|
| 187 |
+
- [Vietnamese / Tiếng Việt](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.vi.md)
|
SECURITY-ACKNOWLEDGEMENTS.md
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
We would like to thank the following security researchers for their responsible disclosures:
|
| 2 |
+
|
| 3 |
+
|
| 4 |
+
# 2024
|
| 5 |
+
|
| 6 |
+
- Ritesh Sahu [GitHub](https://github.com/riteshs4hu/) | [X](https://x.com/riteshs4hu) | [Website](https://medium.com/@riteshs4hu)
|
| 7 |
+
- Tim Suess: [GitHub](https://github.com/blackfortresslabs) | [Email](tim@blackfortresslabs.com) | [Website](https://www.blackfortresslabs.com)
|
| 8 |
+
- xyzeva: [Github](https://github.com/xyzeva) | [Email](mailto:xyzeva@riseup.net) | [Website](https://kibty.town/)
|
| 9 |
+
- Yusuf Kelany: [GitHub](https://github.com/YusufYaser) | [X](https://x.com/RealYusufYaser) | [Website](https://yusufyaser.xyz)
|
SECURITY.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Puter Security Policy
|
| 2 |
+
|
| 3 |
+
Thank you for helping make Puter safe. Keeping user information safe and secure is a top priority, and we welcome the contribution of external security researchers.
|
| 4 |
+
|
| 5 |
+
<br>
|
| 6 |
+
|
| 7 |
+
# Scope
|
| 8 |
+
|
| 9 |
+
If you believe you've found a security issue in software that is maintained in this repository, we encourage you to notify us.
|
| 10 |
+
|
| 11 |
+
<br>
|
| 12 |
+
|
| 13 |
+
# How to Submit a Report
|
| 14 |
+
|
| 15 |
+
To submit a vulnerability report, please contact us at security@puter.com. Your submission will be reviewed and validated by a member of our team.
|
| 16 |
+
|
| 17 |
+
> [!WARNING]
|
| 18 |
+
> Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.
|
| 19 |
+
|
| 20 |
+
<br>
|
| 21 |
+
|
| 22 |
+
# Safe Harbor
|
| 23 |
+
|
| 24 |
+
We support safe harbor for security researchers who:
|
| 25 |
+
|
| 26 |
+
* Make a good faith effort to avoid privacy violations, destruction of data, and interruption or degradation of our services.
|
| 27 |
+
* Only interact with accounts you own or with explicit permission of the account holder. If you do encounter Personally Identifiable Information (PII) contact us immediately, do not proceed with access, and immediately purge any local information.
|
| 28 |
+
* Provide us with a reasonable amount of time to resolve vulnerabilities prior to any disclosure to the public or a third-party.
|
| 29 |
+
|
| 30 |
+
We will consider activities conducted consistent with this policy to constitute "authorized" conduct and will not pursue civil action or initiate a complaint to law enforcement. We will help to the extent we can if legal action is initiated by a third party against you.
|
| 31 |
+
|
| 32 |
+
Please submit a report to us before engaging in conduct that may be inconsistent with or unaddressed by this policy.
|
| 33 |
+
|
| 34 |
+
<br>
|
| 35 |
+
|
| 36 |
+
# Preferences
|
| 37 |
+
|
| 38 |
+
* Please provide detailed reports with reproducible steps and a clearly defined impact.
|
| 39 |
+
* Include the version number of the vulnerable package in your report
|
| 40 |
+
* Social engineering (e.g. phishing, vishing, smishing) is prohibited.
|
TRADEMARK.md
ADDED
|
@@ -0,0 +1,214 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Trademark Guidelines
|
| 2 |
+
|
| 3 |
+
Version 1.0 dated January 1, 2025
|
| 4 |
+
|
| 5 |
+
<img src="https://puter.com/images/logo.png" alt="Puter Technologies Inc. Logo" width="150"/>
|
| 6 |
+
|
| 7 |
+
<br>
|
| 8 |
+
|
| 9 |
+
|
| 10 |
+
This trademark policy was prepared to help you understand how to use the Puter trademarks, service marks and logos with Puter Technologies Inc.'s Puter software.
|
| 11 |
+
|
| 12 |
+
While some of our software is available under a free and open source software license, that copyright license does not include a license to use our trademark, and this Policy is intended to explain how to use our marks consistent with background law and community expectation.
|
| 13 |
+
|
| 14 |
+
This Policy covers:
|
| 15 |
+
|
| 16 |
+
1. Our **word** trademarks and service marks: Puter Technologies Inc., Puter, Puter.com
|
| 17 |
+
2. Our **logos**: The Puter Technologies Inc. logo at the top of this policy
|
| 18 |
+
|
| 19 |
+
This policy encompasses all trademarks and service marks, whether they are registered or not.
|
| 20 |
+
|
| 21 |
+
<br>
|
| 22 |
+
<br>
|
| 23 |
+
|
| 24 |
+
## 1. GENERAL GUIDELINES
|
| 25 |
+
|
| 26 |
+
Whenever you use one of our marks, you must always do so in a way that does not mislead anyone about what they are getting and from whom. For example, you cannot say you are providing the Puter software when you're providing a modified version of it, because recipients may not understand the differences between your modified versions and our own.
|
| 27 |
+
|
| 28 |
+
You also cannot use our logo on your website in a way that suggests that your website is an official website or that we endorse your website.
|
| 29 |
+
|
| 30 |
+
You can, though, say you like the Puter software, that you participate in the Puter community, that you are providing an unmodified version of the Puter software.
|
| 31 |
+
|
| 32 |
+
You may not use or register our marks, or variations of them as part of your own trademark, service mark, domain name, company name, trade name, product name or service name.
|
| 33 |
+
|
| 34 |
+
Trademark law does not allow your use of names or trademarks that are too similar to ours. You therefore may not use an obvious variation of any of our marks or any phonetic equivalent, foreign language equivalent, takeoff, or abbreviation for a similar or compatible product or service. We would consider the following too similar to one of our Marks:
|
| 35 |
+
|
| 36 |
+
- MyPuter
|
| 37 |
+
- PuterFooBar
|
| 38 |
+
|
| 39 |
+
<br>
|
| 40 |
+
<br>
|
| 41 |
+
|
| 42 |
+
## 2. ACCEPTABLE USES
|
| 43 |
+
|
| 44 |
+
<br>
|
| 45 |
+
|
| 46 |
+
### Distribution of Unmodified Software
|
| 47 |
+
|
| 48 |
+
When you redistribute an unmodified copy of Puter software, you must retain all trademarks, logos, and notices we have placed on the software to identify its origin. This includes:
|
| 49 |
+
|
| 50 |
+
* Binary distributions exactly as we provide them
|
| 51 |
+
* Source code distributions exactly as we provide them
|
| 52 |
+
* Documentation and other materials directly from our official repositories
|
| 53 |
+
|
| 54 |
+
<br>
|
| 55 |
+
|
| 56 |
+
### Distribution of Modified Software
|
| 57 |
+
|
| 58 |
+
If you distribute a modified version of Puter software, you:
|
| 59 |
+
|
| 60 |
+
* Must remove all Puter logos from the modified software
|
| 61 |
+
* May use our word marks (but not logos) to accurately describe the software's origin
|
| 62 |
+
* Must clearly indicate that the software has been modified
|
| 63 |
+
* Must include a notice stating: "This software is a modified version of Puter software and is not endorsed by Puter Technologies Inc."
|
| 64 |
+
|
| 65 |
+
Example of acceptable description: "This software is derived from Puter software and includes modifications for [describe your changes]."
|
| 66 |
+
|
| 67 |
+
<br>
|
| 68 |
+
|
| 69 |
+
### Compatibility Statements
|
| 70 |
+
|
| 71 |
+
You may use our word marks (but not logos) to accurately describe your software's compatibility with Puter software under these conditions:
|
| 72 |
+
|
| 73 |
+
* Your statements about compatibility must be accurate and not misleading
|
| 74 |
+
* You must include the following notice: "Puter is a trademark of Puter Technologies Inc. This [product/service] is not affiliated with or endorsed by Puter Technologies Inc."
|
| 75 |
+
* You may not suggest that Puter Technologies Inc. has certified or approved your software
|
| 76 |
+
|
| 77 |
+
|
| 78 |
+
<br>
|
| 79 |
+
|
| 80 |
+
### Products Built for Puter
|
| 81 |
+
|
| 82 |
+
You may describe your product as working with or being built for Puter if:
|
| 83 |
+
|
| 84 |
+
* Your product is fully compatible with the documented Puter APIs
|
| 85 |
+
* Your product name follows this format: "[Your Product Name] for Puter"
|
| 86 |
+
* You include this notice in all materials: "Puter is a trademark of Puter Technologies Inc. [Your Product Name] is not affiliated with or endorsed by Puter Technologies Inc."
|
| 87 |
+
* Your branding and marketing materials do not create confusion about the source of your product
|
| 88 |
+
|
| 89 |
+
<br>
|
| 90 |
+
|
| 91 |
+
### Open Source Projects
|
| 92 |
+
|
| 93 |
+
For open source projects that interact with or extend Puter software:
|
| 94 |
+
|
| 95 |
+
* You may use "puter" as part of your project name only if:
|
| 96 |
+
* The name is in the format "[descriptor]-puter" (e.g., "auth-puter", "backup-puter")
|
| 97 |
+
* The project's README clearly states it's not officially associated with Puter
|
| 98 |
+
* The project maintains compatibility with current Puter APIs
|
| 99 |
+
* You must not use our logos without explicit permission
|
| 100 |
+
* You must include appropriate trademark attribution notices
|
| 101 |
+
|
| 102 |
+
<br>
|
| 103 |
+
|
| 104 |
+
### Community Activities
|
| 105 |
+
|
| 106 |
+
You may use our word marks (but not logos) for non-commercial community activities:
|
| 107 |
+
|
| 108 |
+
* User groups and meetups focused on Puter software
|
| 109 |
+
* Educational content about Puter software
|
| 110 |
+
* Blog posts, videos, articles, or tutorials about Puter software
|
| 111 |
+
|
| 112 |
+
Conditions for community use:
|
| 113 |
+
|
| 114 |
+
* Activities must be non-commercial
|
| 115 |
+
* Any fees charged must only cover actual costs
|
| 116 |
+
* You must include appropriate trademark attribution
|
| 117 |
+
* You must not suggest official endorsement without explicit permission
|
| 118 |
+
|
| 119 |
+
<br>
|
| 120 |
+
|
| 121 |
+
### Merchandise and Promotional Items
|
| 122 |
+
|
| 123 |
+
You may not create merchandise or promotional items bearing our marks without explicit written permission from Puter Technologies Inc.
|
| 124 |
+
|
| 125 |
+
<br>
|
| 126 |
+
|
| 127 |
+
### Academic and Research Use
|
| 128 |
+
|
| 129 |
+
You may use our word marks (but not logos) in:
|
| 130 |
+
|
| 131 |
+
* Academic papers
|
| 132 |
+
* Research publications
|
| 133 |
+
* Technical documentation
|
| 134 |
+
* Educational materials
|
| 135 |
+
|
| 136 |
+
Include appropriate citations and trademark attributions in such uses.
|
| 137 |
+
|
| 138 |
+
<br>
|
| 139 |
+
|
| 140 |
+
### Online Content and Social Media
|
| 141 |
+
|
| 142 |
+
When using our marks in online content:
|
| 143 |
+
|
| 144 |
+
* You may use our word marks in hashtags, handles, or usernames if:
|
| 145 |
+
* The content is clearly about Puter software
|
| 146 |
+
* You don't imply official status
|
| 147 |
+
* You include appropriate trademark attribution
|
| 148 |
+
* You must not register social media accounts that could be confused with official Puter accounts
|
| 149 |
+
|
| 150 |
+
<br>
|
| 151 |
+
|
| 152 |
+
### APIs and Development
|
| 153 |
+
|
| 154 |
+
When developing with Puter APIs:
|
| 155 |
+
|
| 156 |
+
* You may use our word marks to accurately describe your integration
|
| 157 |
+
* You must not use our marks in a way that suggests your API or service is endorse by
|
| 158 |
+
Puter or provided by Puter
|
| 159 |
+
* You must include appropriate trademark attribution
|
| 160 |
+
|
| 161 |
+
All uses described above must also comply with the General Guidelines section of this policy and maintain the integrity of our marks as described in the How to Display Our Marks section.
|
| 162 |
+
|
| 163 |
+
<br>
|
| 164 |
+
|
| 165 |
+
### No Domain Names
|
| 166 |
+
|
| 167 |
+
You must not register any domain that includes our word marks or any variant or combination of them.
|
| 168 |
+
|
| 169 |
+
<br>
|
| 170 |
+
<br>
|
| 171 |
+
|
| 172 |
+
## 3. HOW TO DISPLAY OUR MARKS
|
| 173 |
+
|
| 174 |
+
When you have the right to use our mark, here is how to display it.
|
| 175 |
+
|
| 176 |
+
<br>
|
| 177 |
+
|
| 178 |
+
### Trademark marking and legends
|
| 179 |
+
|
| 180 |
+
The first or most prominent mention of a mark on a webpage, document, or documentation should be accompanied by a symbol indicating whether the mark is a registered trademark ("®") or an unregistered trademark ("™"). If you don't know which applies, contact us.
|
| 181 |
+
|
| 182 |
+
Place the following notice at the foot of the page where you have used the mark: "Puter is trademark of Puter Technologies Inc."
|
| 183 |
+
|
| 184 |
+
<br>
|
| 185 |
+
|
| 186 |
+
### Use of trademarks in text
|
| 187 |
+
|
| 188 |
+
**Always use trademarks in their exact form with the correct spelling, neither abbreviated, hyphenated, or combined with any other word or words.**
|
| 189 |
+
|
| 190 |
+
Unacceptable: Puter-DB
|
| 191 |
+
|
| 192 |
+
**Don't pluralize a trademark.**
|
| 193 |
+
|
| 194 |
+
Unacceptable: I have seventeen Puters running in my lab.
|
| 195 |
+
|
| 196 |
+
**Always use a trademark as an adjective modifying a noun.**
|
| 197 |
+
|
| 198 |
+
Unacceptable: This is a Puter.
|
| 199 |
+
Acceptable: This is a Puter software application.
|
| 200 |
+
|
| 201 |
+
<br>
|
| 202 |
+
|
| 203 |
+
### Use of Logos
|
| 204 |
+
|
| 205 |
+
You may not change any logo except to scale it. This means you may not add decorative elements, change the colors, change the proportions, distort it, add elements, or combine it with other logos.
|
| 206 |
+
|
| 207 |
+
However, when the context requires the use of black-and-white graphics and the logo is color, you may reproduce the logo in a manner that produces a black-and-white image.
|
| 208 |
+
|
| 209 |
+
<br>
|
| 210 |
+
<br>
|
| 211 |
+
|
| 212 |
+
## This Document
|
| 213 |
+
|
| 214 |
+
These guidelines are based on the Model Trademark Guidelines, available at http://www.modeltrademarkguidelines.org., used under a Creative Commons Attribution 3.0 Unported license: https://creativecommons.org/licenses/by/3.0/deed.en_US.
|
doc/AI.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Documentation for Robots
|
| 2 |
+
|
| 3 |
+
Hello, if you're an AI agent then you're reading the correct documentation.
|
| 4 |
+
Here are a few important notes:
|
| 5 |
+
- Puter is probably already cloned and configured, so avoid any setup
|
| 6 |
+
or configuration steps unless explicitly asked to perform them.
|
| 7 |
+
- Anything under `/src` (relative to the root of the repo) is probably
|
| 8 |
+
a workspace module. That means different directories might have different
|
| 9 |
+
code styles or use different import mechanisms (ESM vs CJS). Try to keep
|
| 10 |
+
changes consistent in the scope of where they are.
|
| 11 |
+
|
| 12 |
+
# Backend
|
| 13 |
+
|
| 14 |
+
Any file under `src/backend` that extends **BaseService** is called a
|
| 15 |
+
"backend service". Backend services can implement "traits". That looks
|
| 16 |
+
like this:
|
| 17 |
+
|
| 18 |
+
```javascript
|
| 19 |
+
class SomeClass extends BaseService {
|
| 20 |
+
static IMPLEMENTS = {
|
| 21 |
+
['name-of-interface']: {
|
| 22 |
+
async some_method_name () {
|
| 23 |
+
const instance_of_SomeClass = this;
|
| 24 |
+
}
|
| 25 |
+
}
|
| 26 |
+
}
|
| 27 |
+
}
|
| 28 |
+
```
|
| 29 |
+
|
| 30 |
+
Methods on traits are bound to the same "this" (instance variable) as
|
| 31 |
+
methods on the class itself. Trait methods cannot be indexed from the
|
| 32 |
+
instance variable; instead common functionality is usually moved to
|
| 33 |
+
regular instance methods which typically have an underscore at the end
|
| 34 |
+
of their name.
|
| 35 |
+
|
| 36 |
+
# Furher Documentation
|
| 37 |
+
|
| 38 |
+
Proceed to read the README.md document beside this file.
|
doc/File Structure.drawio
ADDED
|
@@ -0,0 +1,214 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<mxfile host="app.diagrams.net" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36" version="25.0.1">
|
| 2 |
+
<diagram name="Page-1" id="5LlmtnmR4draSSsTtYyD">
|
| 3 |
+
<mxGraphModel grid="1" page="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" pageScale="1" pageWidth="1100" pageHeight="850" math="0" shadow="0">
|
| 4 |
+
<root>
|
| 5 |
+
<mxCell id="0" />
|
| 6 |
+
<mxCell id="1" parent="0" />
|
| 7 |
+
<mxCell id="skmebJAFKBwesmhEX21R-64" value="Legacy Notice" style="rounded=1;whiteSpace=wrap;html=1;align=left;fillColor=#fff2cc;strokeColor=#d6b656;fontSize=14;" vertex="1" parent="1">
|
| 8 |
+
<mxGeometry x="540" y="555" width="130" height="20" as="geometry" />
|
| 9 |
+
</mxCell>
|
| 10 |
+
<mxCell id="skmebJAFKBwesmhEX21R-8" value="only most important directories shown" style="rounded=1;whiteSpace=wrap;html=1;align=right;" vertex="1" parent="1">
|
| 11 |
+
<mxGeometry x="380" y="50" width="230" height="20" as="geometry" />
|
| 12 |
+
</mxCell>
|
| 13 |
+
<mxCell id="skmebJAFKBwesmhEX21R-1" value="src/" style="rounded=0;whiteSpace=wrap;html=1;fontSize=16;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
|
| 14 |
+
<mxGeometry x="360" y="110" width="80" height="30" as="geometry" />
|
| 15 |
+
</mxCell>
|
| 16 |
+
<mxCell id="skmebJAFKBwesmhEX21R-2" value="Puter Repository" style="rounded=0;whiteSpace=wrap;html=1;fontSize=18;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
|
| 17 |
+
<mxGeometry x="240" y="40" width="160" height="40" as="geometry" />
|
| 18 |
+
</mxCell>
|
| 19 |
+
<mxCell id="skmebJAFKBwesmhEX21R-4" value="Every directory under src/ is a node module." style="shape=note;whiteSpace=wrap;html=1;backgroundOutline=1;darkOpacity=0.05;size=14;align=left;" vertex="1" parent="1">
|
| 20 |
+
<mxGeometry x="470" y="110" width="260" height="30" as="geometry" />
|
| 21 |
+
</mxCell>
|
| 22 |
+
<mxCell id="skmebJAFKBwesmhEX21R-5" value="" style="endArrow=classic;html=1;rounded=0;edgeStyle=elbowEdgeStyle;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-2" target="skmebJAFKBwesmhEX21R-1">
|
| 23 |
+
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
| 24 |
+
<mxPoint x="490" y="260" as="sourcePoint" />
|
| 25 |
+
<mxPoint x="540" y="210" as="targetPoint" />
|
| 26 |
+
<Array as="points">
|
| 27 |
+
<mxPoint x="320" y="125" />
|
| 28 |
+
</Array>
|
| 29 |
+
</mxGeometry>
|
| 30 |
+
</mxCell>
|
| 31 |
+
<mxCell id="skmebJAFKBwesmhEX21R-6" value="backend/" style="rounded=0;whiteSpace=wrap;html=1;fontSize=16;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
|
| 32 |
+
<mxGeometry x="440" y="190" width="80" height="30" as="geometry" />
|
| 33 |
+
</mxCell>
|
| 34 |
+
<mxCell id="skmebJAFKBwesmhEX21R-7" value="gui/src/" style="rounded=0;whiteSpace=wrap;html=1;fontSize=16;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
|
| 35 |
+
<mxGeometry x="440" y="1000" width="80" height="30" as="geometry" />
|
| 36 |
+
</mxCell>
|
| 37 |
+
<mxCell id="skmebJAFKBwesmhEX21R-10" value="" style="endArrow=none;html=1;rounded=0;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-1" target="skmebJAFKBwesmhEX21R-4">
|
| 38 |
+
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
| 39 |
+
<mxPoint x="490" y="260" as="sourcePoint" />
|
| 40 |
+
<mxPoint x="540" y="210" as="targetPoint" />
|
| 41 |
+
</mxGeometry>
|
| 42 |
+
</mxCell>
|
| 43 |
+
<mxCell id="skmebJAFKBwesmhEX21R-12" value="" style="endArrow=classic;html=1;rounded=0;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-1" target="skmebJAFKBwesmhEX21R-6">
|
| 44 |
+
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
| 45 |
+
<mxPoint x="490" y="260" as="sourcePoint" />
|
| 46 |
+
<mxPoint x="540" y="210" as="targetPoint" />
|
| 47 |
+
<Array as="points">
|
| 48 |
+
<mxPoint x="400" y="205" />
|
| 49 |
+
</Array>
|
| 50 |
+
</mxGeometry>
|
| 51 |
+
</mxCell>
|
| 52 |
+
<mxCell id="skmebJAFKBwesmhEX21R-14" value="extensions/" style="rounded=0;whiteSpace=wrap;html=1;fontSize=16;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
|
| 53 |
+
<mxGeometry x="520" y="1080" width="140" height="30" as="geometry" />
|
| 54 |
+
</mxCell>
|
| 55 |
+
<mxCell id="skmebJAFKBwesmhEX21R-15" value="Puter GUI Extensions" style="rounded=1;whiteSpace=wrap;html=1;fontSize=16;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
|
| 56 |
+
<mxGeometry x="730" y="1080" width="180" height="30" as="geometry" />
|
| 57 |
+
</mxCell>
|
| 58 |
+
<mxCell id="skmebJAFKBwesmhEX21R-16" value="" style="endArrow=classic;html=1;rounded=0;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-14" target="skmebJAFKBwesmhEX21R-15">
|
| 59 |
+
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
| 60 |
+
<mxPoint x="530" y="980" as="sourcePoint" />
|
| 61 |
+
<mxPoint x="580" y="930" as="targetPoint" />
|
| 62 |
+
</mxGeometry>
|
| 63 |
+
</mxCell>
|
| 64 |
+
<mxCell id="skmebJAFKBwesmhEX21R-17" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-15" target="skmebJAFKBwesmhEX21R-15">
|
| 65 |
+
<mxGeometry relative="1" as="geometry" />
|
| 66 |
+
</mxCell>
|
| 67 |
+
<mxCell id="skmebJAFKBwesmhEX21R-18" value="UI/" style="rounded=0;whiteSpace=wrap;html=1;fontSize=16;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
|
| 68 |
+
<mxGeometry x="520" y="1120" width="140" height="30" as="geometry" />
|
| 69 |
+
</mxCell>
|
| 70 |
+
<mxCell id="skmebJAFKBwesmhEX21R-19" value="Puter Desktop" style="rounded=1;whiteSpace=wrap;html=1;fontSize=16;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
|
| 71 |
+
<mxGeometry x="730" y="1120" width="180" height="30" as="geometry" />
|
| 72 |
+
</mxCell>
|
| 73 |
+
<mxCell id="skmebJAFKBwesmhEX21R-20" value="" style="endArrow=classic;html=1;rounded=0;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-18" target="skmebJAFKBwesmhEX21R-19">
|
| 74 |
+
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
| 75 |
+
<mxPoint x="670" y="1098" as="sourcePoint" />
|
| 76 |
+
<mxPoint x="740" y="1098" as="targetPoint" />
|
| 77 |
+
</mxGeometry>
|
| 78 |
+
</mxCell>
|
| 79 |
+
<mxCell id="skmebJAFKBwesmhEX21R-21" value="services/" style="rounded=0;whiteSpace=wrap;html=1;fontSize=16;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
|
| 80 |
+
<mxGeometry x="520" y="1160" width="140" height="30" as="geometry" />
|
| 81 |
+
</mxCell>
|
| 82 |
+
<mxCell id="skmebJAFKBwesmhEX21R-22" value="Frontend Services" style="rounded=1;whiteSpace=wrap;html=1;fontSize=16;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
|
| 83 |
+
<mxGeometry x="730" y="1160" width="180" height="30" as="geometry" />
|
| 84 |
+
</mxCell>
|
| 85 |
+
<mxCell id="skmebJAFKBwesmhEX21R-23" value="" style="endArrow=classic;html=1;rounded=0;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-21" target="skmebJAFKBwesmhEX21R-22">
|
| 86 |
+
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
| 87 |
+
<mxPoint x="670" y="1138" as="sourcePoint" />
|
| 88 |
+
<mxPoint x="740" y="1138" as="targetPoint" />
|
| 89 |
+
</mxGeometry>
|
| 90 |
+
</mxCell>
|
| 91 |
+
<mxCell id="skmebJAFKBwesmhEX21R-24" value="initgui.js" style="rounded=0;whiteSpace=wrap;html=1;fontSize=16;fillColor=#f8cecc;strokeColor=#b85450;" vertex="1" parent="1">
|
| 92 |
+
<mxGeometry x="520" y="1200" width="140" height="30" as="geometry" />
|
| 93 |
+
</mxCell>
|
| 94 |
+
<mxCell id="skmebJAFKBwesmhEX21R-25" value="Launches services and initializes the GUI" style="rounded=1;whiteSpace=wrap;html=1;fontSize=13;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
|
| 95 |
+
<mxGeometry x="730" y="1200" width="180" height="30" as="geometry" />
|
| 96 |
+
</mxCell>
|
| 97 |
+
<mxCell id="skmebJAFKBwesmhEX21R-26" value="" style="endArrow=classic;html=1;rounded=0;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-24" target="skmebJAFKBwesmhEX21R-25">
|
| 98 |
+
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
| 99 |
+
<mxPoint x="670" y="1185" as="sourcePoint" />
|
| 100 |
+
<mxPoint x="740" y="1185" as="targetPoint" />
|
| 101 |
+
</mxGeometry>
|
| 102 |
+
</mxCell>
|
| 103 |
+
<mxCell id="skmebJAFKBwesmhEX21R-27" value="IPC.js" style="rounded=0;whiteSpace=wrap;html=1;fontSize=16;fillColor=#f8cecc;strokeColor=#b85450;" vertex="1" parent="1">
|
| 104 |
+
<mxGeometry x="520" y="1240" width="140" height="30" as="geometry" />
|
| 105 |
+
</mxCell>
|
| 106 |
+
<mxCell id="skmebJAFKBwesmhEX21R-28" value="Manages communication between Desktop and apps" style="rounded=1;whiteSpace=wrap;html=1;fontSize=13;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
|
| 107 |
+
<mxGeometry x="730" y="1240" width="180" height="30" as="geometry" />
|
| 108 |
+
</mxCell>
|
| 109 |
+
<mxCell id="skmebJAFKBwesmhEX21R-29" value="" style="endArrow=classic;html=1;rounded=0;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-27" target="skmebJAFKBwesmhEX21R-28">
|
| 110 |
+
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
| 111 |
+
<mxPoint x="670" y="1225" as="sourcePoint" />
|
| 112 |
+
<mxPoint x="740" y="1225" as="targetPoint" />
|
| 113 |
+
</mxGeometry>
|
| 114 |
+
</mxCell>
|
| 115 |
+
<mxCell id="skmebJAFKBwesmhEX21R-46" value="modules/" style="rounded=0;whiteSpace=wrap;html=1;fontSize=16;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
|
| 116 |
+
<mxGeometry x="520" y="280" width="140" height="30" as="geometry" />
|
| 117 |
+
</mxCell>
|
| 118 |
+
<mxCell id="skmebJAFKBwesmhEX21R-47" value="New Code goes Here" style="rounded=1;whiteSpace=wrap;html=1;fontSize=16;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
|
| 119 |
+
<mxGeometry x="730" y="280" width="180" height="30" as="geometry" />
|
| 120 |
+
</mxCell>
|
| 121 |
+
<mxCell id="skmebJAFKBwesmhEX21R-48" value="" style="endArrow=classic;html=1;rounded=0;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-46" target="skmebJAFKBwesmhEX21R-47">
|
| 122 |
+
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
| 123 |
+
<mxPoint x="530" y="180" as="sourcePoint" />
|
| 124 |
+
<mxPoint x="580" y="130" as="targetPoint" />
|
| 125 |
+
</mxGeometry>
|
| 126 |
+
</mxCell>
|
| 127 |
+
<mxCell id="skmebJAFKBwesmhEX21R-49" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-47" target="skmebJAFKBwesmhEX21R-47">
|
| 128 |
+
<mxGeometry relative="1" as="geometry" />
|
| 129 |
+
</mxCell>
|
| 130 |
+
<mxCell id="skmebJAFKBwesmhEX21R-50" value="services/" style="rounded=0;whiteSpace=wrap;html=1;fontSize=16;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
|
| 131 |
+
<mxGeometry x="520" y="320" width="140" height="30" as="geometry" />
|
| 132 |
+
</mxCell>
|
| 133 |
+
<mxCell id="skmebJAFKBwesmhEX21R-51" value="Core Module services" style="rounded=1;whiteSpace=wrap;html=1;fontSize=16;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
|
| 134 |
+
<mxGeometry x="730" y="320" width="180" height="30" as="geometry" />
|
| 135 |
+
</mxCell>
|
| 136 |
+
<mxCell id="skmebJAFKBwesmhEX21R-52" value="" style="endArrow=classic;html=1;rounded=0;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-50" target="skmebJAFKBwesmhEX21R-51">
|
| 137 |
+
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
| 138 |
+
<mxPoint x="670" y="298" as="sourcePoint" />
|
| 139 |
+
<mxPoint x="740" y="298" as="targetPoint" />
|
| 140 |
+
</mxGeometry>
|
| 141 |
+
</mxCell>
|
| 142 |
+
<mxCell id="skmebJAFKBwesmhEX21R-53" value="routers/" style="rounded=0;whiteSpace=wrap;html=1;fontSize=16;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
|
| 143 |
+
<mxGeometry x="520" y="480" width="140" height="30" as="geometry" />
|
| 144 |
+
</mxCell>
|
| 145 |
+
<mxCell id="skmebJAFKBwesmhEX21R-54" value="HTTP endpoints" style="rounded=1;whiteSpace=wrap;html=1;fontSize=16;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
|
| 146 |
+
<mxGeometry x="730" y="480" width="180" height="30" as="geometry" />
|
| 147 |
+
</mxCell>
|
| 148 |
+
<mxCell id="skmebJAFKBwesmhEX21R-55" value="" style="endArrow=classic;html=1;rounded=0;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-53" target="skmebJAFKBwesmhEX21R-54">
|
| 149 |
+
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
| 150 |
+
<mxPoint x="670" y="458" as="sourcePoint" />
|
| 151 |
+
<mxPoint x="740" y="458" as="targetPoint" />
|
| 152 |
+
</mxGeometry>
|
| 153 |
+
</mxCell>
|
| 154 |
+
<mxCell id="skmebJAFKBwesmhEX21R-62" value="<div><span style="background-color: initial;">This is the original directory where routes</span></div><div><span style="background-color: initial;">were placed. New services should use the</span></div><div><span style="background-color: initial;">"Endpoint" class to define routes.</span></div><div><span style="background-color: initial;"><br></span></div><div><span style="background-color: initial;">Examples:</span></div><div><span style="background-color: initial;">- PermissionAPIService.js</span></div><div><span style="background-color: initial;">- NotificationService.js</span><br></div><div>- KernelInfoService.js</div><div><span style="color: rgba(0, 0, 0, 0); font-family: monospace; font-size: 0px; text-wrap: nowrap;">%3CmxGraphModel%3E%3Croot%3E%3CmxCell%20id%3D%220%22%2F%3E%3CmxCell%20id%3D%221%22%20parent%3D%220%22%2F%3E%3CmxCell%20id%3D%222%22%20value%3D%22extensions%2F%22%20style%3D%22rounded%3D0%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BfontSize%3D16%3BfillColor%3D%23e1d5e7%3BstrokeColor%3D%239673a6%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22520%22%20y%3D%22400%22%20width%3D%22140%22%20height%3D%2230%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%223%22%20value%3D%22Puter%20GUI%20Extensions%22%20style%3D%22rounded%3D1%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BfontSize%3D16%3BfillColor%3D%23d5e8d4%3BstrokeColor%3D%2382b366%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22730%22%20y%3D%22400%22%20width%3D%22180%22%20height%3D%2230%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%224%22%20value%3D%22%22%20style%3D%22endArrow%3Dclassic%3Bhtml%3D1%3Brounded%3D0%3B%22%20edge%3D%221%22%20source%3D%222%22%20target%3D%223%22%20parent%3D%221%22%3E%3CmxGeometry%20width%3D%2250%22%20height%3D%2250%22%20relative%3D%221%22%20as%3D%22geometry%22%3E%3CmxPoint%20x%3D%22530%22%20y%3D%22300%22%20as%3D%22sourcePoint%22%2F%3E%3CmxPoint%20x%3D%22580%22%20y%3D%22250%22%20as%3D%22targetPoint%22%2F%3E%3C%2FmxGeometry%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%225%22%20style%3D%22edgeStyle%3DorthogonalEdgeStyle%3Brounded%3D0%3BorthogonalLoop%3D1%3BjettySize%3Dauto%3Bhtml%3D1%3BexitX%3D0.5%3BexitY%3D1%3BexitDx%3D0%3BexitDy%3D0%3B%22%20edge%3D%221%22%20source%3D%223%22%20target%3D%223%22%20parent%3D%221%22%3E%3CmxGeometry%20relative%3D%221%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%226%22%20value%3D%22UI%2F%22%20style%3D%22rounded%3D0%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BfontSize%3D16%3BfillColor%3D%23e1d5e7%3BstrokeColor%3D%239673a6%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22520%22%20y%3D%22440%22%20width%3D%22140%22%20height%3D%2230%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%227%22%20value%3D%22Puter%20Desktop%22%20style%3D%22rounded%3D1%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BfontSize%3D16%3BfillColor%3D%23d5e8d4%3BstrokeColor%3D%2382b366%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22730%22%20y%3D%22440%22%20width%3D%22180%22%20height%3D%2230%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%228%22%20value%3D%22%22%20style%3D%22endArrow%3Dclassic%3Bhtml%3D1%3Brounded%3D0%3B%22%20edge%3D%221%22%20source%3D%226%22%20target%3D%227%22%20parent%3D%221%22%3E%3CmxGeometry%20width%3D%2250%22%20height%3D%2250%22%20relative%3D%221%22%20as%3D%22geometry%22%3E%3CmxPoint%20x%3D%22670%22%20y%3D%22418%22%20as%3D%22sourcePoint%22%2F%3E%3CmxPoint%20x%3D%22740%22%20y%3D%22418%22%20as%3D%22targetPoint%22%2F%3E%3C%2FmxGeometry%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%229%22%20value%3D%22services%2F%22%20style%3D%22rounded%3D0%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BfontSize%3D16%3BfillColor%3D%23e1d5e7%3BstrokeColor%3D%239673a6%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22520%22%20y%3D%22480%22%20width%3D%22140%22%20height%3D%2230%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2210%22%20value%3D%22Frontend%20Services%22%20style%3D%22rounded%3D1%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BfontSize%3D16%3BfillColor%3D%23d5e8d4%3BstrokeColor%3D%2382b366%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22730%22%20y%3D%22480%22%20width%3D%22180%22%20height%3D%2230%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2211%22%20value%3D%22%22%20style%3D%22endArrow%3Dclassic%3Bhtml%3D1%3Brounded%3D0%3B%22%20edge%3D%221%22%20source%3D%229%22%20target%3D%2210%22%20parent%3D%221%22%3E%3CmxGeometry%20width%3D%2250%22%20height%3D%2250%22%20relative%3D%221%22%20as%3D%22geometry%22%3E%3CmxPoint%20x%3D%22670%22%20y%3D%22458%22%20as%3D%22sourcePoint%22%2F%3E%3CmxPoint%20x%3D%22740%22%20y%3D%22458%22%20as%3D%22targetPoint%22%2F%3E%3C%2FmxGeometry%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2212%22%20value%3D%22initgui.js%22%20style%3D%22rounded%3D0%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BfontSize%3D16%3BfillColor%3D%23f8cecc%3BstrokeColor%3D%23b85450%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22520%22%20y%3D%22520%22%20width%3D%22140%22%20height%3D%2230%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2213%22%20value%3D%22Launches%20services%20and%20initializes%20the%20GUI%22%20style%3D%22rounded%3D1%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BfontSize%3D13%3BfillColor%3D%23d5e8d4%3BstrokeColor%3D%2382b366%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22730%22%20y%3D%22520%22%20width%3D%22180%22%20height%3D%2230%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2214%22%20value%3D%22%22%20style%3D%22endArrow%3Dclassic%3Bhtml%3D1%3Brounded%3D0%3B%22%20edge%3D%221%22%20source%3D%2212%22%20target%3D%2213%22%20parent%3D%221%22%3E%3CmxGeometry%20width%3D%2250%22%20height%3D%2250%22%20relative%3D%221%22%20as%3D%22geometry%22%3E%3CmxPoint%20x%3D%22670%22%20y%3D%22505%22%20as%3D%22sourcePoint%22%2F%3E%3CmxPoint%20x%3D%22740%22%20y%3D%22505%22%20as%3D%22targetPoint%22%2F%3E%3C%2FmxGeometry%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2215%22%20value%3D%22IPC.js%22%20style%3D%22rounded%3D0%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BfontSize%3D16%3BfillColor%3D%23f8cecc%3BstrokeColor%3D%23b85450%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22520%22%20y%3D%22560%22%20width%3D%22140%22%20height%3D%2230%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2216%22%20value%3D%22Manages%20communication%20between%20Desktop%20and%20apps%22%20style%3D%22rounded%3D1%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BfontSize%3D13%3BfillColor%3D%23d5e8d4%3BstrokeColor%3D%2382b366%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22730%22%20y%3D%22560%22%20width%3D%22180%22%20height%3D%2230%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3CmxCell%20id%3D%2217%22%20value%3D%22%22%20style%3D%22endArrow%3Dclassic%3Bhtml%3D1%3Brounded%3D0%3B%22%20edge%3D%221%22%20source%3D%2215%22%20target%3D%2216%22%20parent%3D%221%22%3E%3CmxGeometry%20width%3D%2250%22%20height%3D%2250%22%20relative%3D%221%22%20as%3D%22geometry%22%3E%3CmxPoint%20x%3D%22670%22%20y%3D%22545%22%20as%3D%22sourcePoint%22%2F%3E%3CmxPoint%20x%3D%22740%22%20y%3D%22545%22%20as%3D%22targetPoint%22%2F%3E%3C%2FmxGeometry%3E%3C%2FmxCell%3E%3C%2Froot%3E%3C%2FmxGraphMode</span><br></div>" style="shape=note;whiteSpace=wrap;html=1;backgroundOutline=1;darkOpacity=0.05;size=18;fillColor=#fff2cc;strokeColor=#d6b656;align=left;verticalAlign=top;fontSize=13;" vertex="1" parent="1">
|
| 155 |
+
<mxGeometry x="645" y="545" width="270" height="135" as="geometry" />
|
| 156 |
+
</mxCell>
|
| 157 |
+
<mxCell id="skmebJAFKBwesmhEX21R-63" value="" style="endArrow=classic;html=1;rounded=0;edgeStyle=elbowEdgeStyle;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-62" target="skmebJAFKBwesmhEX21R-54">
|
| 158 |
+
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
| 159 |
+
<mxPoint x="730" y="560" as="sourcePoint" />
|
| 160 |
+
<mxPoint x="780" y="510" as="targetPoint" />
|
| 161 |
+
</mxGeometry>
|
| 162 |
+
</mxCell>
|
| 163 |
+
<mxCell id="skmebJAFKBwesmhEX21R-65" value="structured/" style="rounded=0;whiteSpace=wrap;html=1;fontSize=16;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
|
| 164 |
+
<mxGeometry x="520" y="700" width="140" height="20" as="geometry" />
|
| 165 |
+
</mxCell>
|
| 166 |
+
<mxCell id="skmebJAFKBwesmhEX21R-66" value="unstructured/" style="rounded=0;whiteSpace=wrap;html=1;fontSize=16;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
|
| 167 |
+
<mxGeometry x="520" y="720" width="140" height="20" as="geometry" />
|
| 168 |
+
</mxCell>
|
| 169 |
+
<mxCell id="skmebJAFKBwesmhEX21R-68" value="<div>These directories mostly contain code for</div><div>the permission system to make it easier to maintain.</div><div><br></div><div>structured/&lt;pattern&gt;/ contains code that is formatted according to "&lt;pattern&gt;"</div><div><br></div><div>unstructured/ contains miscellaneous code used by the permission system.</div>" style="shape=note;whiteSpace=wrap;html=1;backgroundOutline=1;darkOpacity=0.05;size=18;fillColor=#f5f5f5;strokeColor=#666666;align=left;verticalAlign=top;fontSize=13;fontColor=#333333;" vertex="1" parent="1">
|
| 170 |
+
<mxGeometry x="730" y="700" width="270" height="150" as="geometry" />
|
| 171 |
+
</mxCell>
|
| 172 |
+
<mxCell id="skmebJAFKBwesmhEX21R-69" value="" style="endArrow=classic;html=1;rounded=0;edgeStyle=elbowEdgeStyle;elbow=vertical;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-68" target="skmebJAFKBwesmhEX21R-65">
|
| 173 |
+
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
| 174 |
+
<mxPoint x="730" y="680" as="sourcePoint" />
|
| 175 |
+
<mxPoint x="780" y="630" as="targetPoint" />
|
| 176 |
+
</mxGeometry>
|
| 177 |
+
</mxCell>
|
| 178 |
+
<mxCell id="skmebJAFKBwesmhEX21R-70" value="" style="endArrow=classic;html=1;rounded=0;edgeStyle=elbowEdgeStyle;elbow=vertical;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-68" target="skmebJAFKBwesmhEX21R-66">
|
| 179 |
+
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
| 180 |
+
<mxPoint x="740" y="720" as="sourcePoint" />
|
| 181 |
+
<mxPoint x="670" y="720" as="targetPoint" />
|
| 182 |
+
</mxGeometry>
|
| 183 |
+
</mxCell>
|
| 184 |
+
<mxCell id="skmebJAFKBwesmhEX21R-71" value="these should go to:<div>modules/auth/</div><div>in the future</div>" style="rounded=1;whiteSpace=wrap;html=1;glass=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
|
| 185 |
+
<mxGeometry x="520" y="760" width="140" height="50" as="geometry" />
|
| 186 |
+
</mxCell>
|
| 187 |
+
<mxCell id="skmebJAFKBwesmhEX21R-72" value="" style="endArrow=classic;html=1;rounded=0;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-71" target="skmebJAFKBwesmhEX21R-66">
|
| 188 |
+
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
| 189 |
+
<mxPoint x="730" y="680" as="sourcePoint" />
|
| 190 |
+
<mxPoint x="780" y="630" as="targetPoint" />
|
| 191 |
+
</mxGeometry>
|
| 192 |
+
</mxCell>
|
| 193 |
+
<mxCell id="skmebJAFKBwesmhEX21R-73" value="util/" style="rounded=0;whiteSpace=wrap;html=1;fontSize=16;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
|
| 194 |
+
<mxGeometry x="520" y="880" width="140" height="30" as="geometry" />
|
| 195 |
+
</mxCell>
|
| 196 |
+
<mxCell id="skmebJAFKBwesmhEX21R-74" value="<div>Utilities used by various services in Puter's backend.</div><div><br></div><div>These should be incrementally moved to individual `lib` directories in modules/</div>" style="shape=note;whiteSpace=wrap;html=1;backgroundOutline=1;darkOpacity=0.05;size=18;fillColor=#f5f5f5;strokeColor=#666666;align=left;verticalAlign=top;fontSize=13;fontColor=#333333;" vertex="1" parent="1">
|
| 197 |
+
<mxGeometry x="730" y="880" width="270" height="90" as="geometry" />
|
| 198 |
+
</mxCell>
|
| 199 |
+
<mxCell id="skmebJAFKBwesmhEX21R-75" value="" style="endArrow=classic;html=1;rounded=0;edgeStyle=elbowEdgeStyle;elbow=vertical;" edge="1" parent="1" source="skmebJAFKBwesmhEX21R-74" target="skmebJAFKBwesmhEX21R-73">
|
| 200 |
+
<mxGeometry width="50" height="50" relative="1" as="geometry">
|
| 201 |
+
<mxPoint x="740" y="740" as="sourcePoint" />
|
| 202 |
+
<mxPoint x="670" y="740" as="targetPoint" />
|
| 203 |
+
</mxGeometry>
|
| 204 |
+
</mxCell>
|
| 205 |
+
<mxCell id="skmebJAFKBwesmhEX21R-76" value="Migration Notice" style="rounded=1;whiteSpace=wrap;html=1;align=left;fillColor=#fff2cc;strokeColor=#d6b656;fontSize=14;" vertex="1" parent="1">
|
| 206 |
+
<mxGeometry x="540" y="400" width="130" height="20" as="geometry" />
|
| 207 |
+
</mxCell>
|
| 208 |
+
<mxCell id="skmebJAFKBwesmhEX21R-77" value="<div>Services here should be incrementally</div><div>migrated into the modules/ directory.</div>" style="shape=note;whiteSpace=wrap;html=1;backgroundOutline=1;darkOpacity=0.05;size=18;fillColor=#fff2cc;strokeColor=#d6b656;align=left;verticalAlign=top;fontSize=13;" vertex="1" parent="1">
|
| 209 |
+
<mxGeometry x="650" y="390" width="270" height="50" as="geometry" />
|
| 210 |
+
</mxCell>
|
| 211 |
+
</root>
|
| 212 |
+
</mxGraphModel>
|
| 213 |
+
</diagram>
|
| 214 |
+
</mxfile>
|
doc/File Structure.drawio.png
ADDED
|
Git LFS Details
|
doc/README.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Puter Documentation
|
| 2 |
+
|
| 3 |
+
Hi, you've found Puter's wiki page on GitHub! If you were looking for
|
| 4 |
+
something else, you might find it in the links below.
|
| 5 |
+
All of the wiki docs are generated from `doc/` directories in the main
|
| 6 |
+
repository, so it's best to edit docs there rather than here.
|
| 7 |
+
|
| 8 |
+
## Users
|
| 9 |
+
|
| 10 |
+
If you have general questions about using [Puter](https://puter.com),
|
| 11 |
+
our [community Discord](https://discord.gg/PQcx7Teh8u) and
|
| 12 |
+
[subreddit](https://www.reddit.com/r/puter/) are good places
|
| 13 |
+
to ask questions.
|
| 14 |
+
|
| 15 |
+
## Deployers
|
| 16 |
+
|
| 17 |
+
- [Hosting Instructions](./self-hosters/instructions.md)
|
| 18 |
+
- [Configuration](./self-hosters/config.md)
|
| 19 |
+
- [Domain Setup](./self-hosters/domains.md)
|
| 20 |
+
- [Support Levels](./self-hosters/support.md)
|
| 21 |
+
|
| 22 |
+
## App Developer Links
|
| 23 |
+
- [developer.puter.com](https://developer.puter.com)
|
| 24 |
+
- [docs.puter.com](https://docs.puter.com)
|
| 25 |
+
- share your apps on [Reddit](https://www.reddit.com/r/puter/) or
|
| 26 |
+
[Discord](https://discord.gg/PQcx7Teh8u)
|
| 27 |
+
|
| 28 |
+
## Contributor Documentation
|
| 29 |
+
|
| 30 |
+
### Where to Start
|
| 31 |
+
|
| 32 |
+
Start with [Repo Structure and Tooling](./contributors/structure.md).
|
| 33 |
+
|
| 34 |
+
### Index
|
| 35 |
+
|
| 36 |
+
- **Conventions**
|
| 37 |
+
- [Repo Structure and Tooling](./contributors/structure.md)
|
| 38 |
+
- How directories and files are organized in our GitHub repo
|
| 39 |
+
- What tools are used to build parts of Puter
|
| 40 |
+
- [Comment Prefixes](./contributors/comment_prefixes.md)
|
| 41 |
+
- A convention we use for line comments in code
|
| 42 |
+
|
| 43 |
+
- [Frontend Documentation](/src/gui/doc)
|
| 44 |
+
- [Backend Documentation](/src/backend/doc)
|
| 45 |
+
- [Extensions](./contributors/extensions/)
|
doc/RFCS/20250826_captcha_cloudflare_turnstile.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
- Feature Name: Cloudflare Turnstile CAPTCHA
|
| 2 |
+
- Status: Completed
|
| 3 |
+
- Created: 2025-08-26
|
| 4 |
+
|
| 5 |
+
## Summary
|
| 6 |
+
|
| 7 |
+
We propose integrating **Cloudflare Turnstile** to protect our signup flow against automated bot activity, while maintaining a seamless experience for legitimate users.
|
| 8 |
+
|
| 9 |
+
## Motivation
|
| 10 |
+
|
| 11 |
+
Puter allocates resources to **free** user account — including storage, compute, and AI credits. To prevent these from being exploited by bots, we need a more robust verification mechanism. Although Puter currently includes a [custom CAPTCHA service](https://github.com/HeyPuter/puter/blob/4c3a68ee51a1b255edbe6b3c7e4c4e3b0394dae3/src/backend/src/modules/captcha/services/CaptchaService.js), it has several shortcomings:
|
| 12 |
+
|
| 13 |
+
* The text-recognition CAPTCHA creates friction and disrupts the user experience.
|
| 14 |
+
* Maintaining a token pool is resource-intensive and doesn’t scale well. The validation logic also requires ongoing maintenance within the codebase.
|
| 15 |
+
|
| 16 |
+
## Choose of Service Provider
|
| 17 |
+
|
| 18 |
+
We choose Cloudflare Turnstile since:
|
| 19 |
+
|
| 20 |
+
* It's free for unlimited use.
|
| 21 |
+
* It's easy to integrate.
|
| 22 |
+
* It's relative secure.
|
| 23 |
+
|
| 24 |
+
Here's a comparison of major CAPTCHA providers:
|
| 25 |
+
|
| 26 |
+
|
| 27 |
+
| Provider | Security (typical) | User experience (typical) | Price (publicly listed) |
|
| 28 |
+
| ----------------------------------------------------------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| 29 |
+
| **Cloudflare Turnstile** | **High** for most sites; adaptive challenges; works without image puzzles. | **Excellent** (can be fully invisible or auto-verify; checkbox only for risky traffic). | **Free for everyone (unlimited use)**. ([The Cloudflare Blog](https://blog.cloudflare.com/turnstile-ga/?utm_source=chatgpt.com), [cloudflare.com](https://www.cloudflare.com/application-services/products/turnstile/?utm_source=chatgpt.com)) |
|
| 30 |
+
| **Google reCAPTCHA (Essentials / Standard / Enterprise)** | **Medium–High** (v3 score + server rules; Enterprise adds features & support). | **Good–OK** (v3 is invisible; v2 can show puzzles). | **Free up to 10k assessments/mo; \$8 for up to 100k/mo; then \$1 per 1k** (Enterprise tiers). ([Google Cloud](https://cloud.google.com/recaptcha/docs/compare-tiers?utm_source=chatgpt.com)) |
|
| 31 |
+
| **hCaptcha (Basic / Pro / Enterprise)** | **High** (ML signals; enterprise options). | **Good** on Basic; **Very good** on Pro with “low-friction 99.9% passive mode.” | **Basic: Free. Pro: \$99/mo annual (\$139 month-to-month) incl. 100k evals, then \$0.99/1k**; Enterprise custom. ([hcaptcha.com](https://www.hcaptcha.com/pricing?utm_source=chatgpt.com)) |
|
| 32 |
+
| **Friendly Captcha** | **Medium–High** (proof-of-work + risk signals). | **Excellent** (invisible/automatic challenge; no image tasks). | **Starter €9/mo (1k req/mo); Growth €39/mo (5k/mo); Advanced €200/mo (50k/mo); Free non-commercial 1k/mo**; Enterprise custom. ([Friendly Captcha](https://friendlycaptcha.com/)) |
|
| 33 |
+
| **Arkose Labs (FunCaptcha / MatchKey)** | **Very High** (step-up, anti-farm, enterprise focus). | **Good–OK** (challenge can be more involved when risk is high). | **Enterprise pricing (contact sales)**; publicly not listed. (Product overview only.) ([Arkose Labs](https://www.arkoselabs.com/arkose-matchkey/?utm_source=chatgpt.com)) |
|
| 34 |
+
|
| 35 |
+
## Implementation
|
| 36 |
+
|
| 37 |
+
### Signup Flow
|
| 38 |
+
|
| 39 |
+
When a user submits the signup form, the client will include a **Turnstile token** alongside the other form data.
|
| 40 |
+
On the backend, Puter will call the **Cloudflare Turnstile verification API** to validate this token before provisioning a new account.
|
| 41 |
+
|
| 42 |
+
Only if the token is verified as valid will the signup request be processed. Invalid or missing tokens will result in a rejected signup attempt.
|
| 43 |
+
|
| 44 |
+
## Setup
|
| 45 |
+
|
| 46 |
+
1. Create a new *Widget* on the Cloudflare Turnstile dashboard.
|
| 47 |
+
2. Configure *Widget name* and *Hostnames*.
|
| 48 |
+
3. Set *Widget Mode* to **Managed** and *pre-clearance* to **Yes - Interactive**. These settings minimize friction for legitimate users while also giving suspicious users one more chance to clear the CAPTCHA. (See [Turnstile widgets · Cloudflare Turnstile docs](https://developers.cloudflare.com/turnstile/concepts/widget/) for details)
|
| 49 |
+
4. Add Site Key and Secret Key to the config file (default location: `volatile/config/config.json`):
|
| 50 |
+
|
| 51 |
+
```
|
| 52 |
+
"cloudflare-turnstile": {
|
| 53 |
+
"enabled": true,
|
| 54 |
+
"site_key": "<your-site-key>",
|
| 55 |
+
"secret_key": "<your-secret-key>"
|
| 56 |
+
}
|
| 57 |
+
```
|
doc/api/README.md
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# API Documentation
|
| 2 |
+
|
| 3 |
+
Note that this documentation is different from the [puter.js docs](https://docs.puter.com).
|
| 4 |
+
The scope of the documentation in this directory includes both stable API endpoints that
|
| 5 |
+
are used by **puter.js**, as well as API endpoints that may be subject to future changes.
|
doc/api/concepts/share-link.md
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Share Links
|
| 2 |
+
|
| 3 |
+
A **share link** is a link to Puter's origin which contains a token
|
| 4 |
+
in the query string (the key is `share_token`; ex:
|
| 5 |
+
`http://puter.localhost:4100?share_token=...`).
|
| 6 |
+
|
| 7 |
+
This token can be used to apply permissions to the user of the
|
| 8 |
+
current session **if and only if** this user's email is confirmed
|
| 9 |
+
and matches the share link's associated email.
|
doc/api/drivers.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
## Puter Drivers
|
| 2 |
+
|
| 3 |
+
### **POST** `/drivers/call`
|
| 4 |
+
|
| 5 |
+
#### Notes
|
| 6 |
+
|
| 7 |
+
- **HTTP response status** -
|
| 8 |
+
A successful driver response, even if the response is an error message, will always have HTTP status `200`. Note that sometimes this will include rate limit and usage limit errors as well.
|
| 9 |
+
|
| 10 |
+
This endpoint allows you to call a Puter driver. Whether or not the
|
| 11 |
+
driver call fails, this endpoint will respond with HTTP 200 OK.
|
| 12 |
+
When a driver call fails, you will get a JSON response from the driver
|
| 13 |
+
with
|
| 14 |
+
|
| 15 |
+
#### Parameters
|
| 16 |
+
|
| 17 |
+
Parameters are provided in the request body. The content type of the
|
| 18 |
+
request should be `application/json`.
|
| 19 |
+
|
| 20 |
+
- **interface:** `string`
|
| 21 |
+
- **description:** The type of driver to call. For example,
|
| 22 |
+
LLMs use the interface called `puter-chat-completion`.
|
| 23 |
+
- **service:** `string`
|
| 24 |
+
- **description:** The name of the service to use. For example, the `claude` service might be used for `puter-chat-completion`.
|
| 25 |
+
- **method:** `string`
|
| 26 |
+
- **description:** The name of the method to call. For example, LLMs implement `complete` which does a chat completion, and `list` which lists models.
|
| 27 |
+
- **args:** `object`
|
| 28 |
+
- **description:** Parametized arguments for the driver call. For example, `puter-chat-completion`'s `complete` method supports the arguments `messages` and `temperature` (and others), so you might set this to `{ "messages": [...], "temperature": 1.2 }`
|
| 29 |
+
|
| 30 |
+
#### Example
|
| 31 |
+
```json
|
| 32 |
+
{
|
| 33 |
+
"interface": "<name of interface>",
|
| 34 |
+
"service": "<name of service>",
|
| 35 |
+
"method": "<name of method>",
|
| 36 |
+
"args": { "parametized": "arguments" }
|
| 37 |
+
}
|
| 38 |
+
```
|
| 39 |
+
|
| 40 |
+
#### Response
|
| 41 |
+
|
| 42 |
+
- **Error Response** - Driver error responses will always have **status 200**, content type `application/json`, and a response body in this format:
|
| 43 |
+
```json
|
| 44 |
+
{
|
| 45 |
+
"success": false,
|
| 46 |
+
"error": {
|
| 47 |
+
"code": "string identifier for the error",
|
| 48 |
+
"message": "some message about the error",
|
| 49 |
+
}
|
| 50 |
+
}
|
| 51 |
+
```
|
| 52 |
+
- **Success Response** - The success response is either a JSON response
|
| 53 |
+
wrapped in `{ "success": true, "result": ___ }`, or a response with a
|
| 54 |
+
`Content-Type` that is **not** `application/json`.
|
| 55 |
+
```json
|
| 56 |
+
{
|
| 57 |
+
"success": true,
|
| 58 |
+
"result": {}
|
| 59 |
+
}
|
| 60 |
+
```
|
doc/api/group.md
ADDED
|
@@ -0,0 +1,219 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Group Endpoints
|
| 2 |
+
|
| 3 |
+
## POST `/group/create` (auth required)
|
| 4 |
+
|
| 5 |
+
### Description
|
| 6 |
+
|
| 7 |
+
Creates a group and returns a UID (UUID formatted).
|
| 8 |
+
Groups do not have names, or any other descriptive attributes.
|
| 9 |
+
Instead they are always identified with a UUID, and they have
|
| 10 |
+
a `metadata` property.
|
| 11 |
+
|
| 12 |
+
The `metadata` property will always be given back to the client
|
| 13 |
+
in the same way it was provided. The `extra` property, also an
|
| 14 |
+
object, may be changed by the backend. The behavior of setting
|
| 15 |
+
any property on `extra` is currently undefined as all properties
|
| 16 |
+
are reserved for future use.
|
| 17 |
+
|
| 18 |
+
### Parameters
|
| 19 |
+
|
| 20 |
+
- **metadata:** _- optional_
|
| 21 |
+
- **accepts:** `object`
|
| 22 |
+
- **description:** arbitrary metadata to describe the group
|
| 23 |
+
- **extra:** _- optional_
|
| 24 |
+
- **accepts:** `object`
|
| 25 |
+
- **description:** extra parameters (server may change these)
|
| 26 |
+
|
| 27 |
+
### Request Example
|
| 28 |
+
|
| 29 |
+
```javascript
|
| 30 |
+
await fetch(`${window.api_origin}/group/create`, {
|
| 31 |
+
"headers": {
|
| 32 |
+
"Content-Type": "application/json",
|
| 33 |
+
"Authorization": `Bearer ${puter.authToken}`,
|
| 34 |
+
},
|
| 35 |
+
"body": JSON.stringify({
|
| 36 |
+
metadata: { title: 'Some Title' }
|
| 37 |
+
}),
|
| 38 |
+
"method": "POST",
|
| 39 |
+
});
|
| 40 |
+
|
| 41 |
+
// { uid: '9c644a1c-3e43-4df4-ab67-de5b68b235b6' }
|
| 42 |
+
```
|
| 43 |
+
|
| 44 |
+
### Response Example
|
| 45 |
+
|
| 46 |
+
```json
|
| 47 |
+
{
|
| 48 |
+
"uid": "9c644a1c-3e43-4df4-ab67-de5b68b235b6"
|
| 49 |
+
}
|
| 50 |
+
```
|
| 51 |
+
|
| 52 |
+
## POST `/group/add-users`
|
| 53 |
+
|
| 54 |
+
### Description
|
| 55 |
+
|
| 56 |
+
Adds one or more users to a group
|
| 57 |
+
|
| 58 |
+
### Parameters
|
| 59 |
+
|
| 60 |
+
- **uid:** _- required_
|
| 61 |
+
- **accepts:** `string`
|
| 62 |
+
UUID of an existing group
|
| 63 |
+
- **users:** `Array<string>`
|
| 64 |
+
usernames of users to add to the group
|
| 65 |
+
|
| 66 |
+
### Request Example
|
| 67 |
+
|
| 68 |
+
```javascript
|
| 69 |
+
await fetch(`${window.api_origin}/group/add-users`, {
|
| 70 |
+
"headers": {
|
| 71 |
+
"Content-Type": "application/json",
|
| 72 |
+
"Authorization": `Bearer ${puter.authToken}`,
|
| 73 |
+
},
|
| 74 |
+
"body": JSON.stringify({
|
| 75 |
+
uid: '9c644a1c-3e43-4df4-ab67-de5b68b235b6',
|
| 76 |
+
users: ['first_user', 'second_user'],
|
| 77 |
+
}),
|
| 78 |
+
"method": "POST",
|
| 79 |
+
});
|
| 80 |
+
```
|
| 81 |
+
|
| 82 |
+
## POST `/group/remove-users`
|
| 83 |
+
|
| 84 |
+
### Description
|
| 85 |
+
|
| 86 |
+
Remove one or more users from a group
|
| 87 |
+
|
| 88 |
+
### Parameters
|
| 89 |
+
|
| 90 |
+
- **uid:** _- required_
|
| 91 |
+
- **accepts:** `string`
|
| 92 |
+
UUID of an existing group
|
| 93 |
+
- **users:** `Array<string>`
|
| 94 |
+
usernames of users to remove from the group
|
| 95 |
+
|
| 96 |
+
### Request Example
|
| 97 |
+
|
| 98 |
+
```javascript
|
| 99 |
+
await fetch(`${window.api_origin}/group/add-users`, {
|
| 100 |
+
"headers": {
|
| 101 |
+
"Content-Type": "application/json",
|
| 102 |
+
"Authorization": `Bearer ${puter.authToken}`,
|
| 103 |
+
},
|
| 104 |
+
"body": JSON.stringify({
|
| 105 |
+
uid: '9c644a1c-3e43-4df4-ab67-de5b68b235b6',
|
| 106 |
+
users: ['first_user', 'second_user'],
|
| 107 |
+
}),
|
| 108 |
+
"method": "POST",
|
| 109 |
+
});
|
| 110 |
+
```
|
| 111 |
+
|
| 112 |
+
## GET `/group/list`
|
| 113 |
+
|
| 114 |
+
### Description
|
| 115 |
+
|
| 116 |
+
List groups associated with the current user
|
| 117 |
+
|
| 118 |
+
### Parameters
|
| 119 |
+
|
| 120 |
+
_none_
|
| 121 |
+
|
| 122 |
+
### Response Example
|
| 123 |
+
|
| 124 |
+
```json
|
| 125 |
+
{
|
| 126 |
+
"owned_groups": [
|
| 127 |
+
{
|
| 128 |
+
"uid": "c3bd4047-fc65-4da8-9363-e52195890de4",
|
| 129 |
+
"metadata": {},
|
| 130 |
+
"members": [
|
| 131 |
+
"default_user"
|
| 132 |
+
]
|
| 133 |
+
}
|
| 134 |
+
],
|
| 135 |
+
"in_groups": [
|
| 136 |
+
{
|
| 137 |
+
"uid": "c3bd4047-fc65-4da8-9363-e52195890de4",
|
| 138 |
+
"metadata": {},
|
| 139 |
+
"members": [
|
| 140 |
+
"default_user"
|
| 141 |
+
]
|
| 142 |
+
}
|
| 143 |
+
]
|
| 144 |
+
}
|
| 145 |
+
```
|
| 146 |
+
|
| 147 |
+
# Group Permission Endpoints
|
| 148 |
+
|
| 149 |
+
## POST `/grant-user-group`
|
| 150 |
+
|
| 151 |
+
Grant permission from the current user to a group.
|
| 152 |
+
This creates an association between the user and the
|
| 153 |
+
group for this permission; the group will only have
|
| 154 |
+
the permission effectively while the user who granted
|
| 155 |
+
permission has the permission.
|
| 156 |
+
|
| 157 |
+
### Parameters
|
| 158 |
+
|
| 159 |
+
- **group_uid:** _- required_
|
| 160 |
+
- **accepts:** `string`
|
| 161 |
+
UUID of an existing group
|
| 162 |
+
- **permission:** _- required_
|
| 163 |
+
- **accepts:** `string`
|
| 164 |
+
A permission string
|
| 165 |
+
|
| 166 |
+
### Request Example
|
| 167 |
+
|
| 168 |
+
```javascript
|
| 169 |
+
await fetch("http://puter.localhost:4100/auth/grant-user-group", {
|
| 170 |
+
"headers": {
|
| 171 |
+
"Content-Type": "application/json",
|
| 172 |
+
"Authorization": `Bearer ${puter.authToken}`,
|
| 173 |
+
},
|
| 174 |
+
"body": JSON.stringify({
|
| 175 |
+
group_uid: '9c644a1c-3e43-4df4-ab67-de5b68b235b6',
|
| 176 |
+
permission: 'fs:/someuser/somedir/somefile:read'
|
| 177 |
+
}),
|
| 178 |
+
"method": "POST",
|
| 179 |
+
});
|
| 180 |
+
```
|
| 181 |
+
|
| 182 |
+
## POST `/revoke-user-group`
|
| 183 |
+
|
| 184 |
+
Revoke permission granted from the current user
|
| 185 |
+
to a group.
|
| 186 |
+
|
| 187 |
+
### Parameters
|
| 188 |
+
|
| 189 |
+
- **group_uid:** _- required_
|
| 190 |
+
- **accepts:** `string`
|
| 191 |
+
UUID of an existing group
|
| 192 |
+
- **permission:** _- required_
|
| 193 |
+
- **accepts:** `string`
|
| 194 |
+
A permission string
|
| 195 |
+
|
| 196 |
+
### Request Example
|
| 197 |
+
|
| 198 |
+
```javascript
|
| 199 |
+
await fetch("http://puter.localhost:4100/auth/grant-user-group", {
|
| 200 |
+
"headers": {
|
| 201 |
+
"Content-Type": "application/json",
|
| 202 |
+
"Authorization": `Bearer ${puter.authToken}`,
|
| 203 |
+
},
|
| 204 |
+
"body": JSON.stringify({
|
| 205 |
+
group_uid: '9c644a1c-3e43-4df4-ab67-de5b68b235b6',
|
| 206 |
+
permission: 'fs:/someuser/somedir/somefile:read'
|
| 207 |
+
}),
|
| 208 |
+
"method": "POST",
|
| 209 |
+
});
|
| 210 |
+
```
|
| 211 |
+
|
| 212 |
+
- > **TODO** figure out how to manage documentation that could
|
| 213 |
+
reasonably show up in two files. For example: this is a group
|
| 214 |
+
endpoint as well as a permission system endpoint.
|
| 215 |
+
(architecturally it's a permission system endpoint, and
|
| 216 |
+
the permissions feature depends on the groups feature;
|
| 217 |
+
at least until a time when PermissionService is refactored
|
| 218 |
+
so a service like GroupService can mutate the permission
|
| 219 |
+
check sequences)
|
doc/api/notifications.md
ADDED
|
@@ -0,0 +1,112 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Notification Endpoints
|
| 2 |
+
|
| 3 |
+
Endpoints for managing notifications.
|
| 4 |
+
|
| 5 |
+
## POST `/notif/mark-ack` (auth required)
|
| 6 |
+
|
| 7 |
+
### Description
|
| 8 |
+
|
| 9 |
+
The `/notif/mark-ack` endpoint marks the specified notification
|
| 10 |
+
as "acknowledged". This indicates that the user has chosen to either
|
| 11 |
+
dismiss or act on this notification.
|
| 12 |
+
|
| 13 |
+
### Parameters
|
| 14 |
+
|
| 15 |
+
| Name | Description | Default Value |
|
| 16 |
+
| ---- | ----------- | -------- |
|
| 17 |
+
| uid | UUID associated with the notification | **required** |
|
| 18 |
+
|
| 19 |
+
### Response
|
| 20 |
+
|
| 21 |
+
This endpoint responds with an empty object (`{}`).
|
| 22 |
+
|
| 23 |
+
|
| 24 |
+
## POST `/notif/mark-read` (auth required)
|
| 25 |
+
|
| 26 |
+
### Description
|
| 27 |
+
|
| 28 |
+
The `/notif/mark-read` endpoint marks that the specified notification
|
| 29 |
+
has been shown to the user. It will not "pop up" as a new notification
|
| 30 |
+
if they load the gui again.
|
| 31 |
+
|
| 32 |
+
### Parameters
|
| 33 |
+
|
| 34 |
+
| Name | Description | Default Value |
|
| 35 |
+
| ---- | ----------- | -------- |
|
| 36 |
+
| uid | UUID associated with the notification | **required** |
|
| 37 |
+
|
| 38 |
+
### Response
|
| 39 |
+
|
| 40 |
+
This endpoint responds with an empty object (`{}`).
|
| 41 |
+
|
| 42 |
+
### Request Example
|
| 43 |
+
|
| 44 |
+
```javascript
|
| 45 |
+
await fetch("https://api.puter.local/notif/mark-read", {
|
| 46 |
+
headers: {
|
| 47 |
+
"Content-Type": "application/json",
|
| 48 |
+
"Authorization": `Bearer ${puter.authToken}`,
|
| 49 |
+
},
|
| 50 |
+
body: JSON.stringify({
|
| 51 |
+
uid: 'a14ea3d5-828b-42f9-9613-35f43b0a3cb8',
|
| 52 |
+
}),
|
| 53 |
+
method: "POST",
|
| 54 |
+
});
|
| 55 |
+
```
|
| 56 |
+
## ENTITY STORAGE `puter-notifications`
|
| 57 |
+
|
| 58 |
+
The `puter-notifications` driver is an Entity Storage driver.
|
| 59 |
+
It is read-only.
|
| 60 |
+
|
| 61 |
+
### Request Examples
|
| 62 |
+
|
| 63 |
+
#### Select Unread Notifications
|
| 64 |
+
|
| 65 |
+
```javascript
|
| 66 |
+
await fetch("http://api.puter.localhost:4100/drivers/call", {
|
| 67 |
+
"headers": {
|
| 68 |
+
"Content-Type": "application/json",
|
| 69 |
+
"Authorization": `Bearer ${puter.authToken}`,
|
| 70 |
+
},
|
| 71 |
+
"body": JSON.stringify({
|
| 72 |
+
interface: 'puter-notifications',
|
| 73 |
+
method: 'select',
|
| 74 |
+
args: { predicate: ['unread'] }
|
| 75 |
+
}),
|
| 76 |
+
"method": "POST",
|
| 77 |
+
});
|
| 78 |
+
```
|
| 79 |
+
|
| 80 |
+
#### Select First 200 Notifications
|
| 81 |
+
|
| 82 |
+
```javascript
|
| 83 |
+
await fetch("http://api.puter.localhost:4100/drivers/call", {
|
| 84 |
+
"headers": {
|
| 85 |
+
"Content-Type": "application/json",
|
| 86 |
+
"Authorization": `Bearer ${puter.authToken}`,
|
| 87 |
+
},
|
| 88 |
+
"body": JSON.stringify({
|
| 89 |
+
interface: 'puter-notifications',
|
| 90 |
+
method: 'select',
|
| 91 |
+
args: {}
|
| 92 |
+
}),
|
| 93 |
+
"method": "POST",
|
| 94 |
+
});
|
| 95 |
+
```
|
| 96 |
+
|
| 97 |
+
#### Select Next 200 Notifications
|
| 98 |
+
|
| 99 |
+
```javascript
|
| 100 |
+
await fetch("http://api.puter.localhost:4100/drivers/call", {
|
| 101 |
+
"headers": {
|
| 102 |
+
"Content-Type": "application/json",
|
| 103 |
+
"Authorization": `Bearer ${puter.authToken}`,
|
| 104 |
+
},
|
| 105 |
+
"body": JSON.stringify({
|
| 106 |
+
interface: 'puter-notifications',
|
| 107 |
+
method: 'select',
|
| 108 |
+
args: { offset: 200 }
|
| 109 |
+
}),
|
| 110 |
+
"method": "POST",
|
| 111 |
+
});
|
| 112 |
+
```
|
doc/api/share.md
ADDED
|
@@ -0,0 +1,367 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Share Endpoints
|
| 2 |
+
|
| 3 |
+
Share endpoints allow sharing files with other users.
|
| 4 |
+
|
| 5 |
+
## POST `/share` (auth required)
|
| 6 |
+
|
| 7 |
+
### Description
|
| 8 |
+
|
| 9 |
+
The `/share` endpoint shares 1 or more filesystem items
|
| 10 |
+
with one or more recipients. The recipients will receive
|
| 11 |
+
some notification about the shared item, making this
|
| 12 |
+
different from calling `/grant-user-user` with a permission.
|
| 13 |
+
|
| 14 |
+
When users are **specified by email** they will receive
|
| 15 |
+
a [share link](./concepts/share-link.md).
|
| 16 |
+
|
| 17 |
+
Each item specified in the `shares` property is a tag-typed
|
| 18 |
+
object of type `fs-share` or `app-share`.
|
| 19 |
+
|
| 20 |
+
#### File Shares (`fs-share`)
|
| 21 |
+
|
| 22 |
+
File shares grant permission to a file or directory. By default
|
| 23 |
+
this is read permission. If `access` is specified as `"write"`,
|
| 24 |
+
then write permission will be granted.
|
| 25 |
+
|
| 26 |
+
#### App Shares (`app-share`)
|
| 27 |
+
|
| 28 |
+
App shares grant permission to read a protected app.
|
| 29 |
+
|
| 30 |
+
##### subdomain permission
|
| 31 |
+
If there is a subdomain associated with the app, and the owner
|
| 32 |
+
of the subdomain is the same as the owner of the app, then
|
| 33 |
+
permission to access the subdomain will be granted.
|
| 34 |
+
Note that the subdomain is only associated if the subdomain
|
| 35 |
+
entry has `associated_app_id` set according to the app's id,
|
| 36 |
+
and will not be considered "associated" if only the index_url
|
| 37 |
+
happens to match the subdomain url.
|
| 38 |
+
|
| 39 |
+
##### appdata permission
|
| 40 |
+
If the app has `shared_appdata` set to `true` in its metadata
|
| 41 |
+
object, the recipient of the share will also get write permission
|
| 42 |
+
to the app owner's corresponding appdata directory. The appdata
|
| 43 |
+
directory must exist for this to work as expected
|
| 44 |
+
(otherwise the permission rewrite rule fails since the uuid
|
| 45 |
+
can't be determined).
|
| 46 |
+
|
| 47 |
+
### Example
|
| 48 |
+
|
| 49 |
+
```json
|
| 50 |
+
{
|
| 51 |
+
"recipients": [
|
| 52 |
+
"user_that_gets_shared_to",
|
| 53 |
+
"another@example.com"
|
| 54 |
+
],
|
| 55 |
+
"shares": [
|
| 56 |
+
{
|
| 57 |
+
"$": "app-share",
|
| 58 |
+
"name": "some-app-name"
|
| 59 |
+
},
|
| 60 |
+
{
|
| 61 |
+
"$": "app-share",
|
| 62 |
+
"uid": "app-SOME-APP-UID"
|
| 63 |
+
},
|
| 64 |
+
{
|
| 65 |
+
"$": "fs-share",
|
| 66 |
+
"path": "/some/file/or/directory"
|
| 67 |
+
},
|
| 68 |
+
{
|
| 69 |
+
"$": "fs-share",
|
| 70 |
+
"path": "SOME-FILE-UUID"
|
| 71 |
+
}
|
| 72 |
+
]
|
| 73 |
+
}
|
| 74 |
+
```
|
| 75 |
+
|
| 76 |
+
### Parameters
|
| 77 |
+
|
| 78 |
+
- **recipients** _- required_
|
| 79 |
+
- **accepts:** `string | Array<string>`
|
| 80 |
+
- **description:**
|
| 81 |
+
recipients for the filesystem entries being shared.
|
| 82 |
+
- **notes:**
|
| 83 |
+
- validation on `string`: email or username
|
| 84 |
+
- requirement of at least one value
|
| 85 |
+
- **shares:** _- required_
|
| 86 |
+
- **accepts:** `object | Array<object>`
|
| 87 |
+
- object is [type-tagged](./type-tagged.md)
|
| 88 |
+
- type is either [file-share](./types/file-share.md)
|
| 89 |
+
or [app-share](./types/app-share.md)
|
| 90 |
+
- **notes:**
|
| 91 |
+
- requirement that file/directory or app exists
|
| 92 |
+
- requirement of at least one entry
|
| 93 |
+
- **dry_run:** _- optional_
|
| 94 |
+
- **accepts:** `bool`
|
| 95 |
+
- **description:**
|
| 96 |
+
when true, only validation will occur
|
| 97 |
+
|
| 98 |
+
### Response
|
| 99 |
+
|
| 100 |
+
- **$:** `api:share`
|
| 101 |
+
- **$version:** `v0.0.0`
|
| 102 |
+
- **status:** one of: `"success"`, `"mixed"`, `"aborted"`
|
| 103 |
+
- **recipients:** array of: `api:status-report` or
|
| 104 |
+
`heyputer:api/APIError`
|
| 105 |
+
- **paths:** array of: `api:status-report` or
|
| 106 |
+
`heyputer:api/APIError`
|
| 107 |
+
- **dry_run:** `true` if present
|
| 108 |
+
|
| 109 |
+
### Request Example
|
| 110 |
+
|
| 111 |
+
```javascript
|
| 112 |
+
await fetch("http://puter.localhost:4100/share", {
|
| 113 |
+
headers: {
|
| 114 |
+
"Content-Type": "application/json",
|
| 115 |
+
"Authorization": `Bearer ${puter.authToken}`,
|
| 116 |
+
},
|
| 117 |
+
body: JSON.stringify({
|
| 118 |
+
recipients: [
|
| 119 |
+
"user_that_gets_shared_to",
|
| 120 |
+
"another@example.com"
|
| 121 |
+
],
|
| 122 |
+
shares: [
|
| 123 |
+
{
|
| 124 |
+
$: "app-share",
|
| 125 |
+
name: "some-app-name"
|
| 126 |
+
},
|
| 127 |
+
{
|
| 128 |
+
$: "app-share",
|
| 129 |
+
uid: "app-SOME-APP-UID"
|
| 130 |
+
},
|
| 131 |
+
{
|
| 132 |
+
$: "fs-share",
|
| 133 |
+
path: "/some/file/or/directory"
|
| 134 |
+
},
|
| 135 |
+
{
|
| 136 |
+
$: "fs-share",
|
| 137 |
+
path: "SOME-FILE-UUID"
|
| 138 |
+
}
|
| 139 |
+
]
|
| 140 |
+
}),
|
| 141 |
+
method: "POST",
|
| 142 |
+
});
|
| 143 |
+
```
|
| 144 |
+
|
| 145 |
+
### Success Response
|
| 146 |
+
|
| 147 |
+
```json
|
| 148 |
+
{
|
| 149 |
+
"$": "api:share",
|
| 150 |
+
"$version": "v0.0.0",
|
| 151 |
+
"status": "success",
|
| 152 |
+
"recipients": [
|
| 153 |
+
{
|
| 154 |
+
"$": "api:status-report",
|
| 155 |
+
"status": "success"
|
| 156 |
+
}
|
| 157 |
+
],
|
| 158 |
+
"paths": [
|
| 159 |
+
{
|
| 160 |
+
"$": "api:status-report",
|
| 161 |
+
"status": "success"
|
| 162 |
+
}
|
| 163 |
+
],
|
| 164 |
+
"dry_run": true
|
| 165 |
+
}
|
| 166 |
+
```
|
| 167 |
+
|
| 168 |
+
### Error response (missing file)
|
| 169 |
+
|
| 170 |
+
```json
|
| 171 |
+
{
|
| 172 |
+
"$": "api:share",
|
| 173 |
+
"$version": "v0.0.0",
|
| 174 |
+
"status": "mixed",
|
| 175 |
+
"recipients": [
|
| 176 |
+
{
|
| 177 |
+
"$": "api:status-report",
|
| 178 |
+
"status": "success"
|
| 179 |
+
}
|
| 180 |
+
],
|
| 181 |
+
"paths": [
|
| 182 |
+
{
|
| 183 |
+
"$": "heyputer:api/APIError",
|
| 184 |
+
"code": "subject_does_not_exist",
|
| 185 |
+
"message": "File or directory not found.",
|
| 186 |
+
"status": 404
|
| 187 |
+
}
|
| 188 |
+
],
|
| 189 |
+
"dry_run": true
|
| 190 |
+
}
|
| 191 |
+
```
|
| 192 |
+
|
| 193 |
+
### Error response (missing user)
|
| 194 |
+
|
| 195 |
+
```json
|
| 196 |
+
{
|
| 197 |
+
"$": "api:share",
|
| 198 |
+
"$version": "v0.0.0",
|
| 199 |
+
"status": "mixed",
|
| 200 |
+
"recipients": [
|
| 201 |
+
{
|
| 202 |
+
"$": "heyputer:api/APIError",
|
| 203 |
+
"code": "user_does_not_exist",
|
| 204 |
+
"message": "The user `non_existing_user` does not exist.",
|
| 205 |
+
"username": "non_existing_user",
|
| 206 |
+
"status": 422
|
| 207 |
+
}
|
| 208 |
+
],
|
| 209 |
+
"paths": [
|
| 210 |
+
{
|
| 211 |
+
"$": "api:status-report",
|
| 212 |
+
"status": "success"
|
| 213 |
+
}
|
| 214 |
+
],
|
| 215 |
+
"dry_run": true
|
| 216 |
+
}
|
| 217 |
+
```
|
| 218 |
+
|
| 219 |
+
## POST `/sharelink/check` (no auth)
|
| 220 |
+
|
| 221 |
+
### Description
|
| 222 |
+
|
| 223 |
+
The `/sharelink/check` endpoint verifies that a token provided
|
| 224 |
+
by a share link is valid.
|
| 225 |
+
|
| 226 |
+
### Example
|
| 227 |
+
|
| 228 |
+
```javascript
|
| 229 |
+
await fetch(`${config.api_origin}/sharelink/check`, {
|
| 230 |
+
"headers": {
|
| 231 |
+
"Content-Type": "application/json",
|
| 232 |
+
"Authorization": `Bearer ${puter.authToken}`,
|
| 233 |
+
},
|
| 234 |
+
"body": JSON.stringify({
|
| 235 |
+
token: '...',
|
| 236 |
+
}),
|
| 237 |
+
"method": "POST",
|
| 238 |
+
});
|
| 239 |
+
```
|
| 240 |
+
|
| 241 |
+
### Parameters
|
| 242 |
+
|
| 243 |
+
- **token:** _- required_
|
| 244 |
+
- **accepts:** `string`
|
| 245 |
+
The token from the querystring parameter
|
| 246 |
+
|
| 247 |
+
### Response
|
| 248 |
+
|
| 249 |
+
A type-tagged object, either of type `api:share` or `api:error`
|
| 250 |
+
|
| 251 |
+
### Success Response
|
| 252 |
+
|
| 253 |
+
```json
|
| 254 |
+
{
|
| 255 |
+
"$": "api:share",
|
| 256 |
+
"uid": "836671d4-ac5d-4bd3-bc0a-ec357e0d8f02",
|
| 257 |
+
"email": "asdf@example.com"
|
| 258 |
+
}
|
| 259 |
+
```
|
| 260 |
+
|
| 261 |
+
### Error Response
|
| 262 |
+
|
| 263 |
+
```json
|
| 264 |
+
{
|
| 265 |
+
"$": "api:error",
|
| 266 |
+
"message":"Field `token` is required.",
|
| 267 |
+
"key":"token",
|
| 268 |
+
"code":"field_missing"
|
| 269 |
+
}
|
| 270 |
+
```
|
| 271 |
+
|
| 272 |
+
## POST `/sharelink/apply` (no auth)
|
| 273 |
+
|
| 274 |
+
### Description
|
| 275 |
+
|
| 276 |
+
The `/sharelink/apply` endpoint applies a share to the current
|
| 277 |
+
user **if and only if** that user's email is confirmed and matches
|
| 278 |
+
the email associated with the share.
|
| 279 |
+
|
| 280 |
+
### Example
|
| 281 |
+
|
| 282 |
+
```javascript
|
| 283 |
+
await fetch(`${config.api_origin}/sharelink/apply`, {
|
| 284 |
+
"headers": {
|
| 285 |
+
"Content-Type": "application/json",
|
| 286 |
+
"Authorization": `Bearer ${puter.authToken}`,
|
| 287 |
+
},
|
| 288 |
+
"body": JSON.stringify({
|
| 289 |
+
uid: '836671d4-ac5d-4bd3-bc0a-ec357e0d8f02',
|
| 290 |
+
}),
|
| 291 |
+
"method": "POST",
|
| 292 |
+
});
|
| 293 |
+
```
|
| 294 |
+
|
| 295 |
+
### Parameters
|
| 296 |
+
|
| 297 |
+
- **uid:** _- required_
|
| 298 |
+
- **accepts:** `string`
|
| 299 |
+
The uid of an existing share, received using `/sharelink/check`
|
| 300 |
+
|
| 301 |
+
### Response
|
| 302 |
+
|
| 303 |
+
A type-tagged object, either of type `api:status-report` or `api:error`
|
| 304 |
+
|
| 305 |
+
### Success Response
|
| 306 |
+
|
| 307 |
+
```json
|
| 308 |
+
{"$":"api:status-report","status":"success"}
|
| 309 |
+
```
|
| 310 |
+
|
| 311 |
+
### Error Response
|
| 312 |
+
|
| 313 |
+
```json
|
| 314 |
+
{
|
| 315 |
+
"message": "This share can not be applied to this user.",
|
| 316 |
+
"code": "can_not_apply_to_this_user"
|
| 317 |
+
}
|
| 318 |
+
```
|
| 319 |
+
|
| 320 |
+
## POST `/sharelink/request` (no auth)
|
| 321 |
+
|
| 322 |
+
### Description
|
| 323 |
+
|
| 324 |
+
The `/sharelink/request` endpoint requests the permissions associated
|
| 325 |
+
with a share link to the issuer of the share (user that sent the share).
|
| 326 |
+
This can be used when a user is logged in, but that user's email does
|
| 327 |
+
not match the email associated with the share.
|
| 328 |
+
|
| 329 |
+
### Example
|
| 330 |
+
|
| 331 |
+
```javascript
|
| 332 |
+
await fetch(`${config.api_origin}/sharelink/request`, {
|
| 333 |
+
"headers": {
|
| 334 |
+
"Content-Type": "application/json",
|
| 335 |
+
"Authorization": `Bearer ${puter.authToken}`,
|
| 336 |
+
},
|
| 337 |
+
"body": JSON.stringify({
|
| 338 |
+
uid: '836671d4-ac5d-4bd3-bc0a-ec357e0d8f02',
|
| 339 |
+
}),
|
| 340 |
+
"method": "POST",
|
| 341 |
+
});
|
| 342 |
+
```
|
| 343 |
+
|
| 344 |
+
### Parameters
|
| 345 |
+
|
| 346 |
+
- **uid:** _- required_
|
| 347 |
+
- **accepts:** `string`
|
| 348 |
+
The uid of an existing share, received using `/sharelink/check`
|
| 349 |
+
|
| 350 |
+
### Response
|
| 351 |
+
|
| 352 |
+
A type-tagged object, either of type `api:status-report` or `api:error`
|
| 353 |
+
|
| 354 |
+
### Success Response
|
| 355 |
+
|
| 356 |
+
```json
|
| 357 |
+
{"$":"api:status-report","status":"success"}
|
| 358 |
+
```
|
| 359 |
+
|
| 360 |
+
### Error Response
|
| 361 |
+
|
| 362 |
+
```json
|
| 363 |
+
{
|
| 364 |
+
"message": "This share is already valid for this user; POST to /apply for access",
|
| 365 |
+
"code": "no_need_to_request"
|
| 366 |
+
}
|
| 367 |
+
```
|
doc/api/type-tagged.md
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Type-Tagged Objects
|
| 2 |
+
|
| 3 |
+
```js
|
| 4 |
+
{
|
| 5 |
+
"$": "some-type",
|
| 6 |
+
"$version": "0.0.0",
|
| 7 |
+
|
| 8 |
+
"some_property": "some value",
|
| 9 |
+
}
|
| 10 |
+
```
|
| 11 |
+
|
| 12 |
+
## What's a Type-Tagged Object?
|
| 13 |
+
|
| 14 |
+
Type-Tagged objects are a convention understood by Puter's backend
|
| 15 |
+
to communicate meta information along with a JSON object.
|
| 16 |
+
The key feature of Type-Tagged Objects is the type key: `"$"`.
|
| 17 |
+
|
| 18 |
+
## Why Type-Tagged Objects?
|
| 19 |
+
|
| 20 |
+
The primary reason: to have a consistent convention we can use
|
| 21 |
+
anywhere.
|
| 22 |
+
|
| 23 |
+
- Since other services rarely use `$` in their property names,
|
| 24 |
+
we can safely use this without introducing reserved words and
|
| 25 |
+
re-mapping property names.
|
| 26 |
+
- Some places we use this convention might not need it, but
|
| 27 |
+
staying consistent means API end-users can
|
| 28 |
+
[do more with less code](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself).
|
| 29 |
+
|
| 30 |
+
## Specification
|
| 31 |
+
|
| 32 |
+
- The `"$"` key indicates a type (or class) of object
|
| 33 |
+
- Any other key beginning with `$` is a **meta-key**
|
| 34 |
+
- Other keys are not allowed to contain `$`
|
| 35 |
+
- `"$version"` must follow [semver](https://semver.org/)
|
| 36 |
+
- Keys with multiple `"$"` symbols are reserved for future use
|
| 37 |
+
|
| 38 |
+
## Alternative Representations
|
| 39 |
+
|
| 40 |
+
Puter's API will always send results in the format described
|
| 41 |
+
above, which is called the "Standard Representation"
|
| 42 |
+
|
| 43 |
+
Any endpoint which accepts a Type-Tagged Object will also
|
| 44 |
+
accept these alternative representations:
|
| 45 |
+
|
| 46 |
+
### Structured Representation
|
| 47 |
+
|
| 48 |
+
Depending on the architecture of your client, this format
|
| 49 |
+
may be more convenient to work with:
|
| 50 |
+
```json
|
| 51 |
+
{
|
| 52 |
+
"$": "$meta-body",
|
| 53 |
+
"type": "some-type",
|
| 54 |
+
"meta": { "version": "0.0.0" },
|
| 55 |
+
"body": { "some_property": "some value" }
|
| 56 |
+
}
|
| 57 |
+
```
|
| 58 |
+
|
| 59 |
+
### Array Representation
|
| 60 |
+
|
| 61 |
+
In the array representation, meta values go at the end.
|
| 62 |
+
```json
|
| 63 |
+
["some-type",
|
| 64 |
+
{ "some_property": "some value" },
|
| 65 |
+
{ "version": "0.0.0" }
|
| 66 |
+
]
|
| 67 |
+
```
|
| 68 |
+
|
| 69 |
+
If the second element of the list is not an object, it
|
| 70 |
+
will implicitly be placed in a property called value.
|
| 71 |
+
The following are equivalent:
|
| 72 |
+
|
| 73 |
+
```json
|
| 74 |
+
["some-type", "hello"]
|
| 75 |
+
```
|
| 76 |
+
|
| 77 |
+
```json
|
| 78 |
+
["some-type", { "value": "hello" }]
|
| 79 |
+
```
|
doc/api/types/app-share.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# `{"$": "app-share"}` - File Share
|
| 2 |
+
|
| 3 |
+
## Structure
|
| 4 |
+
- **name:** name of the app
|
| 5 |
+
- **uid:** name of the app
|
| 6 |
+
|
| 7 |
+
## Notes
|
| 8 |
+
- One of `name` or `uid` **must** be specified
|
| 9 |
+
|
| 10 |
+
## Examples
|
| 11 |
+
|
| 12 |
+
Share app by name
|
| 13 |
+
```json
|
| 14 |
+
{
|
| 15 |
+
"$": "app-share",
|
| 16 |
+
"name": "some-app-name"
|
| 17 |
+
}
|
| 18 |
+
```
|
| 19 |
+
|
| 20 |
+
Share app by uid
|
| 21 |
+
```json
|
| 22 |
+
{
|
| 23 |
+
"$": "app-share",
|
| 24 |
+
"uid": "app-0a7337f7-0f8a-49ca-b71a-38d39304fe04"
|
| 25 |
+
}
|
| 26 |
+
```
|
doc/api/types/file-share.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# `{"$": "file-share"}` - File Share
|
| 2 |
+
|
| 3 |
+
## Structure
|
| 4 |
+
- **path:** file or directory's path or uuid
|
| 5 |
+
- **access:** one of: `"read"`, `"write"` (default: `"read"`)
|
| 6 |
+
|
| 7 |
+
## Examples
|
| 8 |
+
|
| 9 |
+
Share with read access
|
| 10 |
+
```json
|
| 11 |
+
{
|
| 12 |
+
"$": "file-share",
|
| 13 |
+
"path": "/some/path"
|
| 14 |
+
}
|
| 15 |
+
```
|
| 16 |
+
|
| 17 |
+
Share with write access
|
| 18 |
+
```json
|
| 19 |
+
{
|
| 20 |
+
"$": "file-share",
|
| 21 |
+
"path": "/some/path",
|
| 22 |
+
"access": "write"
|
| 23 |
+
}
|
| 24 |
+
```
|
| 25 |
+
|
| 26 |
+
Using a UUID
|
| 27 |
+
```json
|
| 28 |
+
{
|
| 29 |
+
"$": "file-share",
|
| 30 |
+
"path": "b912c381-0c0b-466c-95a6-f9a4fc680a7d"
|
| 31 |
+
}
|
| 32 |
+
```
|
doc/contributors/comment_prefixes.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Comment Prefixes
|
| 2 |
+
|
| 3 |
+
Comments have prefixes using
|
| 4 |
+
[Conventional: Comments](https://conventionalcomments.org/)
|
| 5 |
+
as a **loose** guideline, and using this markdown file as a
|
| 6 |
+
the actual guideline.
|
| 7 |
+
|
| 8 |
+
This document will be updated on an _as-needed_ basis.
|
| 9 |
+
|
| 10 |
+
## The rules
|
| 11 |
+
|
| 12 |
+
- A comment line always looks like this:
|
| 13 |
+
- A whitespace character
|
| 14 |
+
- Optional prefix matching `/[a-z-]+\([a-z-]a+\):/`
|
| 15 |
+
- A whitespace character
|
| 16 |
+
- The comment
|
| 17 |
+
- Formalized prefixes must follow the rules below
|
| 18 |
+
- Any other prefix can be used. After some uses it
|
| 19 |
+
might be good to formalize it, but that's not a hard rule.
|
| 20 |
+
|
| 21 |
+
## Formalized prefixes
|
| 22 |
+
|
| 23 |
+
- `todo:` is interchangable with the famous `TODO:`, **except:**
|
| 24 |
+
when lowercase (`todo:`) it can include a scope: `todo(security):`.
|
| 25 |
+
- `track:` is used to track common patterns.
|
| 26 |
+
- Anything written after `track:` must be registered in
|
| 27 |
+
[track-comments.md](../devmeta/track-comments.md)
|
| 28 |
+
- `wet:` is usesd to track anything that doesn't adhere
|
| 29 |
+
to the DRY principle; the following message should describe
|
| 30 |
+
where similar code is
|
| 31 |
+
- `compare(<identifier>):` is used to note differences between other
|
| 32 |
+
implementations of a similar idea
|
| 33 |
+
- `name:` pedantic commentary on the name of something
|
doc/contributors/email_testing.md
ADDED
|
@@ -0,0 +1,105 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Local Email Testing
|
| 2 |
+
|
| 3 |
+
This guide describes how to set up and use [MailHog](https://github.com/mailhog/MailHog) for local email testing in Puter development. MailHog provides a local email server that captures outgoing emails for testing purposes without actually sending them to real recipients.
|
| 4 |
+
|
| 5 |
+
## Setup
|
| 6 |
+
|
| 7 |
+
### 1. Configure Puter
|
| 8 |
+
|
| 9 |
+
Add the following configuration to your `volatile/config/config.json` file:
|
| 10 |
+
|
| 11 |
+
```json
|
| 12 |
+
"email": {
|
| 13 |
+
"host": "localhost",
|
| 14 |
+
"port": 1025
|
| 15 |
+
}
|
| 16 |
+
```
|
| 17 |
+
|
| 18 |
+
### 2. Install MailHog
|
| 19 |
+
|
| 20 |
+
Download and run MailHog on your local machine:
|
| 21 |
+
|
| 22 |
+
```bash
|
| 23 |
+
# Install MailHog
|
| 24 |
+
wget https://github.com/mailhog/MailHog/releases/download/v1.0.1/MailHog_linux_amd64
|
| 25 |
+
chmod +x MailHog_linux_amd64
|
| 26 |
+
./MailHog_linux_amd64
|
| 27 |
+
```
|
| 28 |
+
|
| 29 |
+
### 3. Install Nodemailer
|
| 30 |
+
|
| 31 |
+
Install Nodemailer to send test emails to the SMTP server:
|
| 32 |
+
|
| 33 |
+
```bash
|
| 34 |
+
npm install nodemailer
|
| 35 |
+
```
|
| 36 |
+
|
| 37 |
+
## Using MailHog
|
| 38 |
+
|
| 39 |
+
### Access Web Interface
|
| 40 |
+
|
| 41 |
+
Once MailHog is running, access the web interface at:
|
| 42 |
+
[http://127.0.0.1:8025/](http://127.0.0.1:8025/)
|
| 43 |
+
|
| 44 |
+
All captured emails and their recipients will be displayed in this interface.
|
| 45 |
+
|
| 46 |
+
### Testing Your MailHog Setup with Nodemailer
|
| 47 |
+
|
| 48 |
+
You can verify that your MailHog instance is working correctly by creating a simple test script using Nodemailer. This allows you to send test emails that will be captured by MailHog without actually delivering them to real recipients.
|
| 49 |
+
|
| 50 |
+
Here's a sample script you can use to test your MailHog setup:
|
| 51 |
+
|
| 52 |
+
```javascript
|
| 53 |
+
import nodemailer from "nodemailer";
|
| 54 |
+
|
| 55 |
+
// Configure transporter to use MailHog
|
| 56 |
+
const transporter = nodemailer.createTransport({
|
| 57 |
+
host: "localhost", // MailHog SMTP server address
|
| 58 |
+
port: 1025, // Default MailHog SMTP port
|
| 59 |
+
secure: false // No SSL/TLS required for MailHog
|
| 60 |
+
});
|
| 61 |
+
|
| 62 |
+
// Define a test email
|
| 63 |
+
const mailOptions = {
|
| 64 |
+
from: "no-reply@example.com",
|
| 65 |
+
to: "test@example.com",
|
| 66 |
+
subject: "Hello from Nodemailer!",
|
| 67 |
+
text: "This is a test email sent using Nodemailer."
|
| 68 |
+
};
|
| 69 |
+
|
| 70 |
+
// Send the test email
|
| 71 |
+
transporter.sendMail(mailOptions)
|
| 72 |
+
.then(info => console.log("Email sent:", info.response))
|
| 73 |
+
.catch(error => console.error("Error:", error));
|
| 74 |
+
```
|
| 75 |
+
|
| 76 |
+
After sending an email with this script, you can view it in the MailHog web interface:
|
| 77 |
+
|
| 78 |
+
### How Puter Uses Nodemailer
|
| 79 |
+
|
| 80 |
+
Puter itself uses Nodemailer for sending emails through its `EmailService` class located in `/src/backend/src/services/EmailService.js`. This service handles various email templates for:
|
| 81 |
+
|
| 82 |
+
- Account verification
|
| 83 |
+
- Password recovery
|
| 84 |
+
- Two-factor authentication notifications
|
| 85 |
+
- File sharing notifications
|
| 86 |
+
- App approval notifications
|
| 87 |
+
- And more
|
| 88 |
+
|
| 89 |
+
The service creates a Nodemailer transport using the configuration from your `config.json` file, which is why setting up MailHog correctly is important for testing Puter's email functionality during development.
|
| 90 |
+
|
| 91 |
+
<img src="image.png" alt="Email in MailHog interface" width="300" height="200">
|
| 92 |
+
|
| 93 |
+
## Troubleshooting
|
| 94 |
+
|
| 95 |
+
If you encounter issues with MailHog:
|
| 96 |
+
|
| 97 |
+
1. Check if MailHog is running:
|
| 98 |
+
```bash
|
| 99 |
+
ps aux | grep MailHog
|
| 100 |
+
```
|
| 101 |
+
|
| 102 |
+
2. Ensure the correct port configurations in both MailHog and your application.
|
| 103 |
+
|
| 104 |
+
3. Check for any error messages in the MailHog console output.
|
| 105 |
+
|
doc/contributors/extensions.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Puter Extensions
|
| 2 |
+
|
| 3 |
+
## Quickstart
|
| 4 |
+
|
| 5 |
+
Create and edit this file: `mods/mods_enabled/hello-puter.js`
|
| 6 |
+
|
| 7 |
+
```javascript
|
| 8 |
+
const { UserActorType, AppUnderUserActorType } = use.core;
|
| 9 |
+
|
| 10 |
+
extension.get('/hello-puter', (req, res) => {
|
| 11 |
+
const actor = req.actor;
|
| 12 |
+
let who = 'unknown';
|
| 13 |
+
if ( actor.type instanceof UserActorType ) {
|
| 14 |
+
who = actor.type.user.username;
|
| 15 |
+
}
|
| 16 |
+
if ( actor.type instanceof AppUnderUserActorType ) {
|
| 17 |
+
who = actor.type.app.name + ' on behalf of ' + actor.type.user.username;
|
| 18 |
+
}
|
| 19 |
+
res.send(`Hello, ${who}!`);
|
| 20 |
+
});
|
| 21 |
+
```
|
| 22 |
+
|
| 23 |
+
## Events
|
| 24 |
+
|
| 25 |
+
//
|
| 26 |
+
|
| 27 |
+
This is subject to change as we make efforts to simplify the process.
|
| 28 |
+
|
| 29 |
+
### Step 1: Configure a Mod Directory
|
| 30 |
+
|
| 31 |
+
Add this to your config:
|
| 32 |
+
```json
|
| 33 |
+
"mod_directories": [
|
| 34 |
+
"{source}/../mods/mods_available"
|
| 35 |
+
]
|
| 36 |
+
```
|
| 37 |
+
|
| 38 |
+
This adds the `mods/mods_available` directory to this
|
doc/contributors/extensions/README.md
ADDED
|
@@ -0,0 +1,89 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Puter Extensions
|
| 2 |
+
|
| 3 |
+
## Quickstart
|
| 4 |
+
|
| 5 |
+
Create and edit this file: `mods/mods_enabled/hello-puter.js`
|
| 6 |
+
|
| 7 |
+
```javascript
|
| 8 |
+
// You can get definitions exposed by Puter via `use`
|
| 9 |
+
const { UserActorType, AppUnderUserActorType } = use.core;
|
| 10 |
+
|
| 11 |
+
// Endpoints can be registered directly on an extension
|
| 12 |
+
extension.get('/hello-puter', (req, res) => {
|
| 13 |
+
const actor = req.actor;
|
| 14 |
+
|
| 15 |
+
|
| 16 |
+
// Make a string "who" which says:
|
| 17 |
+
// "<username>", or:
|
| 18 |
+
// "<app> acting on behalf of <username>"
|
| 19 |
+
let who = 'unknown';
|
| 20 |
+
if ( actor.type instanceof UserActorType ) {
|
| 21 |
+
who = actor.type.user.username;
|
| 22 |
+
}
|
| 23 |
+
if ( actor.type instanceof AppUnderUserActorType ) {
|
| 24 |
+
who = actor.type.app.name
|
| 25 |
+
+ ' on behalf of '
|
| 26 |
+
+ actor.type.user.username;
|
| 27 |
+
}
|
| 28 |
+
|
| 29 |
+
res.send(`Hello, ${who}!`);
|
| 30 |
+
});
|
| 31 |
+
|
| 32 |
+
// Extensions can listen to events and manipulate Puter's behavior
|
| 33 |
+
extension.on('core.email.validate', event => {
|
| 34 |
+
if ( event.email.includes('evil') ) {
|
| 35 |
+
event.allow = false;
|
| 36 |
+
}
|
| 37 |
+
});
|
| 38 |
+
```
|
| 39 |
+
|
| 40 |
+
### Scope of `extension` and `use`
|
| 41 |
+
|
| 42 |
+
It is important to know that the `extension` global is temporary and does not
|
| 43 |
+
exist after your extension is loaded. If you wish to access the extension
|
| 44 |
+
object within a callback you will need to first bind it to a variable in
|
| 45 |
+
your extension's scope.
|
| 46 |
+
|
| 47 |
+
```javascript
|
| 48 |
+
const ext = extension;
|
| 49 |
+
extension.on('some-event', () => {
|
| 50 |
+
// This would throw an error
|
| 51 |
+
// extension.something();
|
| 52 |
+
|
| 53 |
+
// This works
|
| 54 |
+
ext.example();
|
| 55 |
+
})
|
| 56 |
+
```
|
| 57 |
+
|
| 58 |
+
The same is true for `use`. Calls to `use` should happen at the top of
|
| 59 |
+
the file, just like imports in ES6.
|
| 60 |
+
|
| 61 |
+
## Database Access
|
| 62 |
+
|
| 63 |
+
A database access object is provided to the extension via `extension.db`.
|
| 64 |
+
You **must** scope `extension` to another variable (`ext` in this example)
|
| 65 |
+
in order to access `db` from callbacks.
|
| 66 |
+
|
| 67 |
+
```javascript
|
| 68 |
+
const ext = extension;
|
| 69 |
+
|
| 70 |
+
extension.get('/user-count', { noauth: true, mw: [] }, (req, res) => {
|
| 71 |
+
const [count] = await ext.db.read(
|
| 72 |
+
'SELECT COUNT(*) as c FROM `user`'
|
| 73 |
+
);
|
| 74 |
+
});
|
| 75 |
+
```
|
| 76 |
+
|
| 77 |
+
The database access object has the following methods:
|
| 78 |
+
- `read(query, params)` - read from the database using a prepared statement. If read-replicas are enabled, this will use a replica.
|
| 79 |
+
- `write(query, params)` - write to the database using a prepared statement. If read-replicas are enabled, this will write to the primary.
|
| 80 |
+
- `pread(query, params)` - read from the database using a prepared statement. If read-replicas are enabled, this will read from the primary.
|
| 81 |
+
- `requireRead(query, params)` - read from the database using a prepared statement. If read-replicas are enabled, this will try reading from the replica first. If there are no results, a second attempt will be made on the primary.
|
| 82 |
+
|
| 83 |
+
## Events
|
| 84 |
+
|
| 85 |
+
See [events.md](./events.md)
|
| 86 |
+
|
| 87 |
+
## Definitions
|
| 88 |
+
|
| 89 |
+
See [definitions.md](./definitions.md)
|
doc/contributors/extensions/definitions.md
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
## Definitions
|
| 2 |
+
|
| 3 |
+
### `core.config` - Configuration
|
| 4 |
+
|
| 5 |
+
Puter's configuration object. This includes values from `config.json` or their
|
| 6 |
+
defaults, and computed values like `origin` and `api_origin`.
|
| 7 |
+
|
| 8 |
+
```javascript
|
| 9 |
+
const config = use('core.config');
|
| 10 |
+
|
| 11 |
+
extension.get('/get-origin', { noauth: true }, (req, res) => {
|
| 12 |
+
res.send(config.origin);
|
| 13 |
+
})
|
| 14 |
+
```
|
doc/contributors/extensions/events.json.js
ADDED
|
@@ -0,0 +1,830 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
export default [
|
| 2 |
+
{
|
| 3 |
+
properties: {
|
| 4 |
+
completionId: {
|
| 5 |
+
type: 'any',
|
| 6 |
+
mutability: 'mutable',
|
| 7 |
+
summary: 'completionId',
|
| 8 |
+
notes: [],
|
| 9 |
+
},
|
| 10 |
+
allow: {
|
| 11 |
+
type: 'boolean',
|
| 12 |
+
mutability: 'mutable',
|
| 13 |
+
summary: 'whether the operation is allowed',
|
| 14 |
+
notes: [],
|
| 15 |
+
},
|
| 16 |
+
intended_service: {
|
| 17 |
+
type: 'any',
|
| 18 |
+
mutability: 'mutable',
|
| 19 |
+
summary: 'intended service',
|
| 20 |
+
notes: [],
|
| 21 |
+
},
|
| 22 |
+
parameters: {
|
| 23 |
+
type: 'any',
|
| 24 |
+
mutability: 'mutable',
|
| 25 |
+
summary: 'parameters',
|
| 26 |
+
notes: [],
|
| 27 |
+
},
|
| 28 |
+
},
|
| 29 |
+
},
|
| 30 |
+
{
|
| 31 |
+
id: 'ai.prompt.complete',
|
| 32 |
+
description: `
|
| 33 |
+
This event is emitted for ai prompt complete operations.
|
| 34 |
+
`,
|
| 35 |
+
properties: {
|
| 36 |
+
intended_service: {
|
| 37 |
+
type: 'any',
|
| 38 |
+
mutability: 'mutable',
|
| 39 |
+
summary: 'intended service',
|
| 40 |
+
notes: [],
|
| 41 |
+
},
|
| 42 |
+
parameters: {
|
| 43 |
+
type: 'any',
|
| 44 |
+
mutability: 'mutable',
|
| 45 |
+
summary: 'parameters',
|
| 46 |
+
notes: [],
|
| 47 |
+
},
|
| 48 |
+
result: {
|
| 49 |
+
type: 'any',
|
| 50 |
+
mutability: 'mutable',
|
| 51 |
+
summary: 'result',
|
| 52 |
+
notes: [],
|
| 53 |
+
},
|
| 54 |
+
model_used: {
|
| 55 |
+
type: 'any',
|
| 56 |
+
mutability: 'mutable',
|
| 57 |
+
summary: 'model used',
|
| 58 |
+
notes: [],
|
| 59 |
+
},
|
| 60 |
+
service_used: {
|
| 61 |
+
type: 'any',
|
| 62 |
+
mutability: 'mutable',
|
| 63 |
+
summary: 'service used',
|
| 64 |
+
notes: [],
|
| 65 |
+
},
|
| 66 |
+
},
|
| 67 |
+
},
|
| 68 |
+
{
|
| 69 |
+
id: 'ai.prompt.cost-calculated',
|
| 70 |
+
description: `
|
| 71 |
+
This event is emitted for ai prompt cost calculated operations.
|
| 72 |
+
`,
|
| 73 |
+
},
|
| 74 |
+
{
|
| 75 |
+
id: 'ai.prompt.validate',
|
| 76 |
+
description: `
|
| 77 |
+
This event is emitted when a validate is being validated.
|
| 78 |
+
The event can be used to block certain validates from being validated.
|
| 79 |
+
`,
|
| 80 |
+
properties: {
|
| 81 |
+
completionId: {
|
| 82 |
+
type: 'any',
|
| 83 |
+
mutability: 'mutable',
|
| 84 |
+
summary: 'completionId',
|
| 85 |
+
notes: [],
|
| 86 |
+
},
|
| 87 |
+
allow: {
|
| 88 |
+
type: 'boolean',
|
| 89 |
+
mutability: 'mutable',
|
| 90 |
+
summary: 'whether the operation is allowed',
|
| 91 |
+
notes: [
|
| 92 |
+
'If set to false, the ai will be considered invalid.',
|
| 93 |
+
],
|
| 94 |
+
},
|
| 95 |
+
intended_service: {
|
| 96 |
+
type: 'any',
|
| 97 |
+
mutability: 'mutable',
|
| 98 |
+
summary: 'intended service',
|
| 99 |
+
notes: [],
|
| 100 |
+
},
|
| 101 |
+
parameters: {
|
| 102 |
+
type: 'any',
|
| 103 |
+
mutability: 'mutable',
|
| 104 |
+
summary: 'parameters',
|
| 105 |
+
notes: [],
|
| 106 |
+
},
|
| 107 |
+
},
|
| 108 |
+
},
|
| 109 |
+
{
|
| 110 |
+
id: 'app.new-icon',
|
| 111 |
+
description: `
|
| 112 |
+
This event is emitted for app new icon operations.
|
| 113 |
+
`,
|
| 114 |
+
properties: {
|
| 115 |
+
data_url: {
|
| 116 |
+
type: 'any',
|
| 117 |
+
mutability: 'no-effect',
|
| 118 |
+
summary: 'data url',
|
| 119 |
+
notes: [],
|
| 120 |
+
},
|
| 121 |
+
},
|
| 122 |
+
},
|
| 123 |
+
{
|
| 124 |
+
id: 'app.rename',
|
| 125 |
+
description: `
|
| 126 |
+
This event is emitted for app rename operations.
|
| 127 |
+
`,
|
| 128 |
+
properties: {
|
| 129 |
+
data_url: {
|
| 130 |
+
type: 'any',
|
| 131 |
+
mutability: 'no-effect',
|
| 132 |
+
summary: 'data url',
|
| 133 |
+
notes: [],
|
| 134 |
+
},
|
| 135 |
+
},
|
| 136 |
+
},
|
| 137 |
+
{
|
| 138 |
+
id: 'apps.invalidate',
|
| 139 |
+
description: `
|
| 140 |
+
This event is emitted when a invalidate is being validated.
|
| 141 |
+
The event can be used to block certain invalidates from being validated.
|
| 142 |
+
`,
|
| 143 |
+
properties: {
|
| 144 |
+
apps: {
|
| 145 |
+
type: 'any',
|
| 146 |
+
mutability: 'no-effect',
|
| 147 |
+
summary: 'apps',
|
| 148 |
+
notes: [],
|
| 149 |
+
},
|
| 150 |
+
},
|
| 151 |
+
},
|
| 152 |
+
{
|
| 153 |
+
id: 'captcha.check',
|
| 154 |
+
description: `
|
| 155 |
+
This event is emitted for captcha check operations.
|
| 156 |
+
`,
|
| 157 |
+
properties: {
|
| 158 |
+
required: {
|
| 159 |
+
type: 'any',
|
| 160 |
+
mutability: 'no-effect',
|
| 161 |
+
summary: 'required',
|
| 162 |
+
notes: [],
|
| 163 |
+
},
|
| 164 |
+
},
|
| 165 |
+
},
|
| 166 |
+
{
|
| 167 |
+
id: 'core.email.validate',
|
| 168 |
+
description: `
|
| 169 |
+
This event is emitted when an email is being validated.
|
| 170 |
+
The event can be used to block certain emails from being validated.
|
| 171 |
+
`,
|
| 172 |
+
properties: {
|
| 173 |
+
email: {
|
| 174 |
+
type: 'string',
|
| 175 |
+
mutability: 'no-effect',
|
| 176 |
+
summary: 'the email being validated',
|
| 177 |
+
notes: [
|
| 178 |
+
'The email may have already been cleaned.',
|
| 179 |
+
],
|
| 180 |
+
},
|
| 181 |
+
allow: {
|
| 182 |
+
type: 'boolean',
|
| 183 |
+
mutability: 'mutable',
|
| 184 |
+
summary: 'whether the email is allowed',
|
| 185 |
+
notes: [
|
| 186 |
+
'If set to false, the email will be considered invalid.',
|
| 187 |
+
],
|
| 188 |
+
},
|
| 189 |
+
},
|
| 190 |
+
},
|
| 191 |
+
{
|
| 192 |
+
id: 'core.fs.create.directory',
|
| 193 |
+
description: `
|
| 194 |
+
This event is emitted when a directory is created.
|
| 195 |
+
`,
|
| 196 |
+
properties: {
|
| 197 |
+
node: {
|
| 198 |
+
type: 'FSNodeContext',
|
| 199 |
+
mutability: 'no-effect',
|
| 200 |
+
summary: 'the directory that was created',
|
| 201 |
+
},
|
| 202 |
+
context: {
|
| 203 |
+
type: 'Context',
|
| 204 |
+
mutability: 'no-effect',
|
| 205 |
+
summary: 'current context',
|
| 206 |
+
},
|
| 207 |
+
},
|
| 208 |
+
},
|
| 209 |
+
{
|
| 210 |
+
id: 'core.request.measured',
|
| 211 |
+
description: `
|
| 212 |
+
This event is emitted when a requests incoming and outgoing bytes
|
| 213 |
+
have been measured.
|
| 214 |
+
`,
|
| 215 |
+
example: {
|
| 216 |
+
language: 'javascript',
|
| 217 |
+
code: /*javascript*/`
|
| 218 |
+
extension.on('core.request.measured', data => {
|
| 219 |
+
const measurements = data.measurements;
|
| 220 |
+
// measurements = { sz_incoming: integer, sz_outgoing: integer }
|
| 221 |
+
|
| 222 |
+
const actor = data.actor; // instance of Actor
|
| 223 |
+
|
| 224 |
+
console.log('\x1B[36;1m === MEASUREMENT ===\x1B[0m\n', {
|
| 225 |
+
actor: data.actor.uid,
|
| 226 |
+
measurements: data.measurements
|
| 227 |
+
});
|
| 228 |
+
});
|
| 229 |
+
`,
|
| 230 |
+
},
|
| 231 |
+
},
|
| 232 |
+
{
|
| 233 |
+
id: 'credit.check-available',
|
| 234 |
+
description: `
|
| 235 |
+
This event is emitted for credit check available operations.
|
| 236 |
+
`,
|
| 237 |
+
properties: {
|
| 238 |
+
available: {
|
| 239 |
+
type: 'any',
|
| 240 |
+
mutability: 'no-effect',
|
| 241 |
+
summary: 'available',
|
| 242 |
+
notes: [],
|
| 243 |
+
},
|
| 244 |
+
cost_uuid: {
|
| 245 |
+
type: 'string',
|
| 246 |
+
mutability: 'no-effect',
|
| 247 |
+
summary: 'cost uuid',
|
| 248 |
+
notes: [],
|
| 249 |
+
},
|
| 250 |
+
},
|
| 251 |
+
},
|
| 252 |
+
{
|
| 253 |
+
id: 'credit.funding-update',
|
| 254 |
+
description: `
|
| 255 |
+
This event is emitted when a funding-update is updated.
|
| 256 |
+
`,
|
| 257 |
+
properties: {
|
| 258 |
+
available: {
|
| 259 |
+
type: 'any',
|
| 260 |
+
mutability: 'no-effect',
|
| 261 |
+
summary: 'available',
|
| 262 |
+
notes: [],
|
| 263 |
+
},
|
| 264 |
+
cost_uuid: {
|
| 265 |
+
type: 'string',
|
| 266 |
+
mutability: 'no-effect',
|
| 267 |
+
summary: 'cost uuid',
|
| 268 |
+
notes: [],
|
| 269 |
+
},
|
| 270 |
+
},
|
| 271 |
+
},
|
| 272 |
+
{
|
| 273 |
+
id: 'credit.record-cost',
|
| 274 |
+
description: `
|
| 275 |
+
This event is emitted for credit record cost operations.
|
| 276 |
+
`,
|
| 277 |
+
properties: {
|
| 278 |
+
available: {
|
| 279 |
+
type: 'any',
|
| 280 |
+
mutability: 'no-effect',
|
| 281 |
+
summary: 'available',
|
| 282 |
+
notes: [],
|
| 283 |
+
},
|
| 284 |
+
cost_uuid: {
|
| 285 |
+
type: 'string',
|
| 286 |
+
mutability: 'no-effect',
|
| 287 |
+
summary: 'cost uuid',
|
| 288 |
+
notes: [],
|
| 289 |
+
},
|
| 290 |
+
},
|
| 291 |
+
},
|
| 292 |
+
{
|
| 293 |
+
id: 'driver.create-call-context',
|
| 294 |
+
description: `
|
| 295 |
+
This event is emitted when a create-call-context is created.
|
| 296 |
+
`,
|
| 297 |
+
properties: {
|
| 298 |
+
usages: {
|
| 299 |
+
type: 'any',
|
| 300 |
+
mutability: 'no-effect',
|
| 301 |
+
summary: 'usages',
|
| 302 |
+
notes: [],
|
| 303 |
+
},
|
| 304 |
+
},
|
| 305 |
+
},
|
| 306 |
+
{
|
| 307 |
+
id: 'email.validate',
|
| 308 |
+
description: `
|
| 309 |
+
This event is emitted when a validate is being validated.
|
| 310 |
+
The event can be used to block certain validates from being validated.
|
| 311 |
+
`,
|
| 312 |
+
properties: {
|
| 313 |
+
allow: {
|
| 314 |
+
type: 'boolean',
|
| 315 |
+
mutability: 'mutable',
|
| 316 |
+
summary: 'whether the operation is allowed',
|
| 317 |
+
notes: [
|
| 318 |
+
'If set to false, the email will be considered invalid.',
|
| 319 |
+
],
|
| 320 |
+
},
|
| 321 |
+
email: {
|
| 322 |
+
type: 'any',
|
| 323 |
+
mutability: 'mutable',
|
| 324 |
+
summary: 'email',
|
| 325 |
+
notes: [
|
| 326 |
+
'The email may have already been cleaned.',
|
| 327 |
+
],
|
| 328 |
+
},
|
| 329 |
+
},
|
| 330 |
+
},
|
| 331 |
+
{
|
| 332 |
+
id: 'fs.create.directory',
|
| 333 |
+
description: `
|
| 334 |
+
This event is emitted when a directory is created.
|
| 335 |
+
`,
|
| 336 |
+
},
|
| 337 |
+
{
|
| 338 |
+
id: 'fs.create.file',
|
| 339 |
+
description: `
|
| 340 |
+
This event is emitted when a file is created.
|
| 341 |
+
`,
|
| 342 |
+
properties: {
|
| 343 |
+
context: {
|
| 344 |
+
type: 'Context',
|
| 345 |
+
mutability: 'no-effect',
|
| 346 |
+
summary: 'current context',
|
| 347 |
+
notes: [],
|
| 348 |
+
},
|
| 349 |
+
},
|
| 350 |
+
},
|
| 351 |
+
{
|
| 352 |
+
id: 'fs.create.shortcut',
|
| 353 |
+
description: `
|
| 354 |
+
This event is emitted when a shortcut is created.
|
| 355 |
+
`,
|
| 356 |
+
},
|
| 357 |
+
{
|
| 358 |
+
id: 'fs.create.symlink',
|
| 359 |
+
description: `
|
| 360 |
+
This event is emitted when a symlink is created.
|
| 361 |
+
`,
|
| 362 |
+
},
|
| 363 |
+
{
|
| 364 |
+
id: 'fs.move.file',
|
| 365 |
+
description: `
|
| 366 |
+
This event is emitted for fs move file operations.
|
| 367 |
+
`,
|
| 368 |
+
properties: {
|
| 369 |
+
moved: {
|
| 370 |
+
type: 'any',
|
| 371 |
+
mutability: 'no-effect',
|
| 372 |
+
summary: 'moved',
|
| 373 |
+
notes: [],
|
| 374 |
+
},
|
| 375 |
+
old_path: {
|
| 376 |
+
type: 'string',
|
| 377 |
+
mutability: 'no-effect',
|
| 378 |
+
summary: 'path to the affected resource',
|
| 379 |
+
notes: [],
|
| 380 |
+
},
|
| 381 |
+
},
|
| 382 |
+
},
|
| 383 |
+
{
|
| 384 |
+
id: 'fs.pending.file',
|
| 385 |
+
description: `
|
| 386 |
+
This event is emitted for fs pending file operations.
|
| 387 |
+
`,
|
| 388 |
+
},
|
| 389 |
+
{
|
| 390 |
+
id: 'fs.storage.progress.copy',
|
| 391 |
+
description: `
|
| 392 |
+
This event reports progress of a copy operation.
|
| 393 |
+
`,
|
| 394 |
+
properties: {
|
| 395 |
+
context: {
|
| 396 |
+
type: 'Context',
|
| 397 |
+
mutability: 'no-effect',
|
| 398 |
+
summary: 'current context',
|
| 399 |
+
notes: [],
|
| 400 |
+
},
|
| 401 |
+
meta: {
|
| 402 |
+
type: 'object',
|
| 403 |
+
mutability: 'no-effect',
|
| 404 |
+
summary: 'additional metadata for the operation',
|
| 405 |
+
notes: [],
|
| 406 |
+
},
|
| 407 |
+
item_path: {
|
| 408 |
+
type: 'string',
|
| 409 |
+
mutability: 'no-effect',
|
| 410 |
+
summary: 'path to the affected resource',
|
| 411 |
+
notes: [],
|
| 412 |
+
},
|
| 413 |
+
},
|
| 414 |
+
},
|
| 415 |
+
{
|
| 416 |
+
id: 'fs.storage.upload-progress',
|
| 417 |
+
description: `
|
| 418 |
+
This event reports progress of a upload-progress operation.
|
| 419 |
+
`,
|
| 420 |
+
},
|
| 421 |
+
{
|
| 422 |
+
id: 'fs.write.file',
|
| 423 |
+
description: `
|
| 424 |
+
This event is emitted when a file is updated.
|
| 425 |
+
`,
|
| 426 |
+
properties: {
|
| 427 |
+
context: {
|
| 428 |
+
type: 'Context',
|
| 429 |
+
mutability: 'no-effect',
|
| 430 |
+
summary: 'current context',
|
| 431 |
+
notes: [],
|
| 432 |
+
},
|
| 433 |
+
},
|
| 434 |
+
},
|
| 435 |
+
{
|
| 436 |
+
id: 'ip.validate',
|
| 437 |
+
description: `
|
| 438 |
+
This event is emitted when a validate is being validated.
|
| 439 |
+
The event can be used to block certain validates from being validated.
|
| 440 |
+
`,
|
| 441 |
+
properties: {
|
| 442 |
+
res: {
|
| 443 |
+
type: 'any',
|
| 444 |
+
mutability: 'mutable',
|
| 445 |
+
summary: 'res',
|
| 446 |
+
notes: [],
|
| 447 |
+
},
|
| 448 |
+
end_: {
|
| 449 |
+
type: 'any',
|
| 450 |
+
mutability: 'mutable',
|
| 451 |
+
summary: 'end ',
|
| 452 |
+
notes: [],
|
| 453 |
+
},
|
| 454 |
+
end: {
|
| 455 |
+
type: 'any',
|
| 456 |
+
mutability: 'mutable',
|
| 457 |
+
summary: 'end',
|
| 458 |
+
notes: [],
|
| 459 |
+
},
|
| 460 |
+
},
|
| 461 |
+
},
|
| 462 |
+
{
|
| 463 |
+
id: 'outer.fs.write-hash',
|
| 464 |
+
description: `
|
| 465 |
+
This event is emitted when a write-hash is updated.
|
| 466 |
+
`,
|
| 467 |
+
properties: {
|
| 468 |
+
uuid: {
|
| 469 |
+
type: 'string',
|
| 470 |
+
mutability: 'no-effect',
|
| 471 |
+
summary: 'uuid',
|
| 472 |
+
notes: [],
|
| 473 |
+
},
|
| 474 |
+
},
|
| 475 |
+
},
|
| 476 |
+
{
|
| 477 |
+
id: 'outer.gui.item.added',
|
| 478 |
+
description: `
|
| 479 |
+
This event is emitted for outer gui item added operations.
|
| 480 |
+
`,
|
| 481 |
+
properties: {
|
| 482 |
+
response: {
|
| 483 |
+
type: 'any',
|
| 484 |
+
mutability: 'no-effect',
|
| 485 |
+
summary: 'response',
|
| 486 |
+
notes: [],
|
| 487 |
+
},
|
| 488 |
+
},
|
| 489 |
+
},
|
| 490 |
+
{
|
| 491 |
+
id: 'outer.gui.item.moved',
|
| 492 |
+
description: `
|
| 493 |
+
This event is emitted for outer gui item moved operations.
|
| 494 |
+
`,
|
| 495 |
+
properties: {
|
| 496 |
+
response: {
|
| 497 |
+
type: 'any',
|
| 498 |
+
mutability: 'no-effect',
|
| 499 |
+
summary: 'response',
|
| 500 |
+
notes: [],
|
| 501 |
+
},
|
| 502 |
+
},
|
| 503 |
+
},
|
| 504 |
+
{
|
| 505 |
+
id: 'outer.gui.item.pending',
|
| 506 |
+
description: `
|
| 507 |
+
This event is emitted for outer gui item pending operations.
|
| 508 |
+
`,
|
| 509 |
+
properties: {
|
| 510 |
+
response: {
|
| 511 |
+
type: 'any',
|
| 512 |
+
mutability: 'no-effect',
|
| 513 |
+
summary: 'response',
|
| 514 |
+
notes: [],
|
| 515 |
+
},
|
| 516 |
+
},
|
| 517 |
+
},
|
| 518 |
+
{
|
| 519 |
+
id: 'outer.gui.item.updated',
|
| 520 |
+
description: `
|
| 521 |
+
This event is emitted when a updated is updated.
|
| 522 |
+
`,
|
| 523 |
+
properties: {
|
| 524 |
+
response: {
|
| 525 |
+
type: 'any',
|
| 526 |
+
mutability: 'no-effect',
|
| 527 |
+
summary: 'response',
|
| 528 |
+
notes: [],
|
| 529 |
+
},
|
| 530 |
+
},
|
| 531 |
+
},
|
| 532 |
+
{
|
| 533 |
+
id: 'outer.gui.notif.ack',
|
| 534 |
+
description: `
|
| 535 |
+
This event is emitted for outer gui notif ack operations.
|
| 536 |
+
`,
|
| 537 |
+
properties: {
|
| 538 |
+
response: {
|
| 539 |
+
type: 'any',
|
| 540 |
+
mutability: 'no-effect',
|
| 541 |
+
summary: 'response',
|
| 542 |
+
notes: [],
|
| 543 |
+
},
|
| 544 |
+
},
|
| 545 |
+
},
|
| 546 |
+
{
|
| 547 |
+
id: 'outer.gui.notif.message',
|
| 548 |
+
description: `
|
| 549 |
+
This event is emitted for outer gui notif message operations.
|
| 550 |
+
`,
|
| 551 |
+
properties: {
|
| 552 |
+
response: {
|
| 553 |
+
type: 'any',
|
| 554 |
+
mutability: 'no-effect',
|
| 555 |
+
summary: 'response',
|
| 556 |
+
notes: [],
|
| 557 |
+
},
|
| 558 |
+
notification: {
|
| 559 |
+
type: 'any',
|
| 560 |
+
mutability: 'no-effect',
|
| 561 |
+
summary: 'notification',
|
| 562 |
+
notes: [],
|
| 563 |
+
},
|
| 564 |
+
},
|
| 565 |
+
},
|
| 566 |
+
{
|
| 567 |
+
id: 'outer.gui.notif.persisted',
|
| 568 |
+
description: `
|
| 569 |
+
This event is emitted for outer gui notif persisted operations.
|
| 570 |
+
`,
|
| 571 |
+
properties: {
|
| 572 |
+
response: {
|
| 573 |
+
type: 'any',
|
| 574 |
+
mutability: 'no-effect',
|
| 575 |
+
summary: 'response',
|
| 576 |
+
notes: [],
|
| 577 |
+
},
|
| 578 |
+
},
|
| 579 |
+
},
|
| 580 |
+
{
|
| 581 |
+
id: 'outer.gui.notif.unreads',
|
| 582 |
+
description: `
|
| 583 |
+
This event is emitted for outer gui notif unreads operations.
|
| 584 |
+
`,
|
| 585 |
+
properties: {
|
| 586 |
+
response: {
|
| 587 |
+
type: 'any',
|
| 588 |
+
mutability: 'no-effect',
|
| 589 |
+
summary: 'response',
|
| 590 |
+
notes: [],
|
| 591 |
+
},
|
| 592 |
+
},
|
| 593 |
+
},
|
| 594 |
+
{
|
| 595 |
+
id: 'outer.gui.submission.done',
|
| 596 |
+
description: `
|
| 597 |
+
This event is emitted for outer gui submission done operations.
|
| 598 |
+
`,
|
| 599 |
+
properties: {
|
| 600 |
+
response: {
|
| 601 |
+
type: 'any',
|
| 602 |
+
mutability: 'no-effect',
|
| 603 |
+
summary: 'response',
|
| 604 |
+
notes: [],
|
| 605 |
+
},
|
| 606 |
+
},
|
| 607 |
+
},
|
| 608 |
+
{
|
| 609 |
+
id: 'outer.gui.usage.update',
|
| 610 |
+
description: `
|
| 611 |
+
This event is emitted when a update is updated.
|
| 612 |
+
`,
|
| 613 |
+
},
|
| 614 |
+
{
|
| 615 |
+
id: 'outer.thread.notify-subscribers',
|
| 616 |
+
description: `
|
| 617 |
+
This event is emitted for outer thread notify subscribers operations.
|
| 618 |
+
`,
|
| 619 |
+
properties: {
|
| 620 |
+
uid: {
|
| 621 |
+
type: 'string',
|
| 622 |
+
mutability: 'no-effect',
|
| 623 |
+
summary: 'uid',
|
| 624 |
+
notes: [],
|
| 625 |
+
},
|
| 626 |
+
action: {
|
| 627 |
+
type: 'any',
|
| 628 |
+
mutability: 'no-effect',
|
| 629 |
+
summary: 'action',
|
| 630 |
+
notes: [],
|
| 631 |
+
},
|
| 632 |
+
data: {
|
| 633 |
+
type: 'any',
|
| 634 |
+
mutability: 'no-effect',
|
| 635 |
+
summary: 'data',
|
| 636 |
+
notes: [],
|
| 637 |
+
},
|
| 638 |
+
},
|
| 639 |
+
},
|
| 640 |
+
{
|
| 641 |
+
id: 'puter.signup',
|
| 642 |
+
description: `
|
| 643 |
+
This event is emitted for puter signup operations.
|
| 644 |
+
`,
|
| 645 |
+
properties: {
|
| 646 |
+
ip: {
|
| 647 |
+
type: 'any',
|
| 648 |
+
mutability: 'mutable',
|
| 649 |
+
summary: 'ip',
|
| 650 |
+
notes: [],
|
| 651 |
+
},
|
| 652 |
+
user_agent: {
|
| 653 |
+
type: 'any',
|
| 654 |
+
mutability: 'mutable',
|
| 655 |
+
summary: 'user agent',
|
| 656 |
+
notes: [],
|
| 657 |
+
},
|
| 658 |
+
body: {
|
| 659 |
+
type: 'any',
|
| 660 |
+
mutability: 'mutable',
|
| 661 |
+
summary: 'body',
|
| 662 |
+
notes: [],
|
| 663 |
+
},
|
| 664 |
+
},
|
| 665 |
+
},
|
| 666 |
+
{
|
| 667 |
+
id: 'request.measured',
|
| 668 |
+
description: `
|
| 669 |
+
This event is emitted for request measured operations.
|
| 670 |
+
`,
|
| 671 |
+
properties: {
|
| 672 |
+
req: {
|
| 673 |
+
type: 'any',
|
| 674 |
+
mutability: 'no-effect',
|
| 675 |
+
summary: 'req',
|
| 676 |
+
notes: [],
|
| 677 |
+
},
|
| 678 |
+
res: {
|
| 679 |
+
type: 'any',
|
| 680 |
+
mutability: 'no-effect',
|
| 681 |
+
summary: 'res',
|
| 682 |
+
notes: [],
|
| 683 |
+
},
|
| 684 |
+
},
|
| 685 |
+
},
|
| 686 |
+
{
|
| 687 |
+
id: 'request.will-be-handled',
|
| 688 |
+
description: `
|
| 689 |
+
This event is emitted for request will be handled operations.
|
| 690 |
+
`,
|
| 691 |
+
properties: {
|
| 692 |
+
res: {
|
| 693 |
+
type: 'any',
|
| 694 |
+
mutability: 'mutable',
|
| 695 |
+
summary: 'res',
|
| 696 |
+
notes: [],
|
| 697 |
+
},
|
| 698 |
+
end_: {
|
| 699 |
+
type: 'any',
|
| 700 |
+
mutability: 'mutable',
|
| 701 |
+
summary: 'end ',
|
| 702 |
+
notes: [],
|
| 703 |
+
},
|
| 704 |
+
end: {
|
| 705 |
+
type: 'any',
|
| 706 |
+
mutability: 'mutable',
|
| 707 |
+
summary: 'end',
|
| 708 |
+
notes: [],
|
| 709 |
+
},
|
| 710 |
+
},
|
| 711 |
+
},
|
| 712 |
+
{
|
| 713 |
+
id: 'sns',
|
| 714 |
+
description: `
|
| 715 |
+
This event is emitted for sns operations.
|
| 716 |
+
`,
|
| 717 |
+
properties: {
|
| 718 |
+
message: {
|
| 719 |
+
type: 'any',
|
| 720 |
+
mutability: 'no-effect',
|
| 721 |
+
summary: 'message',
|
| 722 |
+
notes: [],
|
| 723 |
+
},
|
| 724 |
+
},
|
| 725 |
+
},
|
| 726 |
+
{
|
| 727 |
+
id: 'template-service.hello',
|
| 728 |
+
description: `
|
| 729 |
+
This event is emitted for template-service hello operations.
|
| 730 |
+
`,
|
| 731 |
+
},
|
| 732 |
+
{
|
| 733 |
+
id: 'usages.query',
|
| 734 |
+
description: `
|
| 735 |
+
This event is emitted for usages query operations.
|
| 736 |
+
`,
|
| 737 |
+
properties: {
|
| 738 |
+
usages: {
|
| 739 |
+
type: 'any',
|
| 740 |
+
mutability: 'no-effect',
|
| 741 |
+
summary: 'usages',
|
| 742 |
+
notes: [],
|
| 743 |
+
},
|
| 744 |
+
},
|
| 745 |
+
},
|
| 746 |
+
{
|
| 747 |
+
id: 'user.email-changed',
|
| 748 |
+
description: `
|
| 749 |
+
This event is emitted for user email changed operations.
|
| 750 |
+
`,
|
| 751 |
+
properties: {
|
| 752 |
+
new_email: {
|
| 753 |
+
type: 'any',
|
| 754 |
+
mutability: 'no-effect',
|
| 755 |
+
summary: 'new email',
|
| 756 |
+
notes: [],
|
| 757 |
+
},
|
| 758 |
+
},
|
| 759 |
+
},
|
| 760 |
+
{
|
| 761 |
+
id: 'user.email-confirmed',
|
| 762 |
+
description: `
|
| 763 |
+
This event is emitted for user email confirmed operations.
|
| 764 |
+
`,
|
| 765 |
+
properties: {
|
| 766 |
+
email: {
|
| 767 |
+
type: 'any',
|
| 768 |
+
mutability: 'no-effect',
|
| 769 |
+
summary: 'email',
|
| 770 |
+
notes: [],
|
| 771 |
+
},
|
| 772 |
+
},
|
| 773 |
+
},
|
| 774 |
+
{
|
| 775 |
+
id: 'user.save_account',
|
| 776 |
+
description: `
|
| 777 |
+
This event is emitted for user save_account operations.
|
| 778 |
+
`,
|
| 779 |
+
properties: {
|
| 780 |
+
user: {
|
| 781 |
+
type: 'User',
|
| 782 |
+
mutability: 'no-effect',
|
| 783 |
+
summary: 'user associated with the operation',
|
| 784 |
+
notes: [],
|
| 785 |
+
},
|
| 786 |
+
},
|
| 787 |
+
},
|
| 788 |
+
{
|
| 789 |
+
id: 'web.socket.connected',
|
| 790 |
+
description: `
|
| 791 |
+
This event is emitted for web socket connected operations.
|
| 792 |
+
`,
|
| 793 |
+
properties: {
|
| 794 |
+
user: {
|
| 795 |
+
type: 'User',
|
| 796 |
+
mutability: 'mutable',
|
| 797 |
+
summary: 'user associated with the operation',
|
| 798 |
+
notes: [],
|
| 799 |
+
},
|
| 800 |
+
},
|
| 801 |
+
},
|
| 802 |
+
{
|
| 803 |
+
id: 'web.socket.user-connected',
|
| 804 |
+
description: `
|
| 805 |
+
This event is emitted for web socket user connected operations.
|
| 806 |
+
`,
|
| 807 |
+
properties: {
|
| 808 |
+
user: {
|
| 809 |
+
type: 'User',
|
| 810 |
+
mutability: 'mutable',
|
| 811 |
+
summary: 'user associated with the operation',
|
| 812 |
+
notes: [],
|
| 813 |
+
},
|
| 814 |
+
},
|
| 815 |
+
},
|
| 816 |
+
{
|
| 817 |
+
id: 'wisp.get-policy',
|
| 818 |
+
description: `
|
| 819 |
+
This event is emitted for wisp get policy operations.
|
| 820 |
+
`,
|
| 821 |
+
properties: {
|
| 822 |
+
policy: {
|
| 823 |
+
type: 'Policy',
|
| 824 |
+
mutability: 'mutable',
|
| 825 |
+
summary: 'policy information for the operation',
|
| 826 |
+
notes: [],
|
| 827 |
+
},
|
| 828 |
+
},
|
| 829 |
+
},
|
| 830 |
+
];
|
doc/contributors/extensions/events.md
ADDED
|
@@ -0,0 +1,761 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#### Property `completionId`
|
| 2 |
+
|
| 3 |
+
completionId
|
| 4 |
+
- **Type**: any
|
| 5 |
+
- **Mutability**: mutable
|
| 6 |
+
- **Notes**:
|
| 7 |
+
|
| 8 |
+
#### Property `allow`
|
| 9 |
+
|
| 10 |
+
whether the operation is allowed
|
| 11 |
+
- **Type**: boolean
|
| 12 |
+
- **Mutability**: mutable
|
| 13 |
+
- **Notes**:
|
| 14 |
+
|
| 15 |
+
#### Property `intended_service`
|
| 16 |
+
|
| 17 |
+
intended service
|
| 18 |
+
- **Type**: any
|
| 19 |
+
- **Mutability**: mutable
|
| 20 |
+
- **Notes**:
|
| 21 |
+
|
| 22 |
+
#### Property `parameters`
|
| 23 |
+
|
| 24 |
+
parameters
|
| 25 |
+
- **Type**: any
|
| 26 |
+
- **Mutability**: mutable
|
| 27 |
+
- **Notes**:
|
| 28 |
+
|
| 29 |
+
|
| 30 |
+
### `ai.prompt.complete`
|
| 31 |
+
|
| 32 |
+
This event is emitted for ai prompt complete operations.
|
| 33 |
+
|
| 34 |
+
#### Property `intended_service`
|
| 35 |
+
|
| 36 |
+
intended service
|
| 37 |
+
- **Type**: any
|
| 38 |
+
- **Mutability**: mutable
|
| 39 |
+
- **Notes**:
|
| 40 |
+
|
| 41 |
+
#### Property `parameters`
|
| 42 |
+
|
| 43 |
+
parameters
|
| 44 |
+
- **Type**: any
|
| 45 |
+
- **Mutability**: mutable
|
| 46 |
+
- **Notes**:
|
| 47 |
+
|
| 48 |
+
#### Property `result`
|
| 49 |
+
|
| 50 |
+
result
|
| 51 |
+
- **Type**: any
|
| 52 |
+
- **Mutability**: mutable
|
| 53 |
+
- **Notes**:
|
| 54 |
+
|
| 55 |
+
#### Property `model_used`
|
| 56 |
+
|
| 57 |
+
model used
|
| 58 |
+
- **Type**: any
|
| 59 |
+
- **Mutability**: mutable
|
| 60 |
+
- **Notes**:
|
| 61 |
+
|
| 62 |
+
#### Property `service_used`
|
| 63 |
+
|
| 64 |
+
service used
|
| 65 |
+
- **Type**: any
|
| 66 |
+
- **Mutability**: mutable
|
| 67 |
+
- **Notes**:
|
| 68 |
+
|
| 69 |
+
|
| 70 |
+
### `ai.prompt.cost-calculated`
|
| 71 |
+
|
| 72 |
+
This event is emitted for ai prompt cost calculated operations.
|
| 73 |
+
|
| 74 |
+
|
| 75 |
+
### `ai.prompt.validate`
|
| 76 |
+
|
| 77 |
+
This event is emitted when a validate is being validated.
|
| 78 |
+
The event can be used to block certain validates from being validated.
|
| 79 |
+
|
| 80 |
+
#### Property `completionId`
|
| 81 |
+
|
| 82 |
+
completionId
|
| 83 |
+
- **Type**: any
|
| 84 |
+
- **Mutability**: mutable
|
| 85 |
+
- **Notes**:
|
| 86 |
+
|
| 87 |
+
#### Property `allow`
|
| 88 |
+
|
| 89 |
+
whether the operation is allowed
|
| 90 |
+
- **Type**: boolean
|
| 91 |
+
- **Mutability**: mutable
|
| 92 |
+
- **Notes**:
|
| 93 |
+
- If set to false, the ai will be considered invalid.
|
| 94 |
+
|
| 95 |
+
#### Property `intended_service`
|
| 96 |
+
|
| 97 |
+
intended service
|
| 98 |
+
- **Type**: any
|
| 99 |
+
- **Mutability**: mutable
|
| 100 |
+
- **Notes**:
|
| 101 |
+
|
| 102 |
+
#### Property `parameters`
|
| 103 |
+
|
| 104 |
+
parameters
|
| 105 |
+
- **Type**: any
|
| 106 |
+
- **Mutability**: mutable
|
| 107 |
+
- **Notes**:
|
| 108 |
+
|
| 109 |
+
|
| 110 |
+
### `app.new-icon`
|
| 111 |
+
|
| 112 |
+
This event is emitted for app new icon operations.
|
| 113 |
+
|
| 114 |
+
#### Property `data_url`
|
| 115 |
+
|
| 116 |
+
data url
|
| 117 |
+
- **Type**: any
|
| 118 |
+
- **Mutability**: no-effect
|
| 119 |
+
- **Notes**:
|
| 120 |
+
|
| 121 |
+
|
| 122 |
+
### `app.rename`
|
| 123 |
+
|
| 124 |
+
This event is emitted for app rename operations.
|
| 125 |
+
|
| 126 |
+
#### Property `data_url`
|
| 127 |
+
|
| 128 |
+
data url
|
| 129 |
+
- **Type**: any
|
| 130 |
+
- **Mutability**: no-effect
|
| 131 |
+
- **Notes**:
|
| 132 |
+
|
| 133 |
+
|
| 134 |
+
### `apps.invalidate`
|
| 135 |
+
|
| 136 |
+
This event is emitted when a invalidate is being validated.
|
| 137 |
+
The event can be used to block certain invalidates from being validated.
|
| 138 |
+
|
| 139 |
+
#### Property `apps`
|
| 140 |
+
|
| 141 |
+
apps
|
| 142 |
+
- **Type**: any
|
| 143 |
+
- **Mutability**: no-effect
|
| 144 |
+
- **Notes**:
|
| 145 |
+
|
| 146 |
+
|
| 147 |
+
### `captcha.check`
|
| 148 |
+
|
| 149 |
+
This event is emitted for captcha check operations.
|
| 150 |
+
|
| 151 |
+
#### Property `required`
|
| 152 |
+
|
| 153 |
+
required
|
| 154 |
+
- **Type**: any
|
| 155 |
+
- **Mutability**: no-effect
|
| 156 |
+
- **Notes**:
|
| 157 |
+
|
| 158 |
+
|
| 159 |
+
### `core.email.validate`
|
| 160 |
+
|
| 161 |
+
This event is emitted when an email is being validated.
|
| 162 |
+
The event can be used to block certain emails from being validated.
|
| 163 |
+
|
| 164 |
+
#### Property `email`
|
| 165 |
+
|
| 166 |
+
the email being validated
|
| 167 |
+
- **Type**: string
|
| 168 |
+
- **Mutability**: no-effect
|
| 169 |
+
- **Notes**:
|
| 170 |
+
- The email may have already been cleaned.
|
| 171 |
+
|
| 172 |
+
#### Property `allow`
|
| 173 |
+
|
| 174 |
+
whether the email is allowed
|
| 175 |
+
- **Type**: boolean
|
| 176 |
+
- **Mutability**: mutable
|
| 177 |
+
- **Notes**:
|
| 178 |
+
- If set to false, the email will be considered invalid.
|
| 179 |
+
|
| 180 |
+
|
| 181 |
+
### `core.fs.create.directory`
|
| 182 |
+
|
| 183 |
+
This event is emitted when a directory is created.
|
| 184 |
+
|
| 185 |
+
#### Property `node`
|
| 186 |
+
|
| 187 |
+
the directory that was created
|
| 188 |
+
- **Type**: FSNodeContext
|
| 189 |
+
- **Mutability**: no-effect
|
| 190 |
+
|
| 191 |
+
#### Property `context`
|
| 192 |
+
|
| 193 |
+
current context
|
| 194 |
+
- **Type**: Context
|
| 195 |
+
- **Mutability**: no-effect
|
| 196 |
+
|
| 197 |
+
|
| 198 |
+
### `core.request.measured`
|
| 199 |
+
|
| 200 |
+
This event is emitted when a requests incoming and outgoing bytes
|
| 201 |
+
have been measured.
|
| 202 |
+
|
| 203 |
+
#### Example
|
| 204 |
+
|
| 205 |
+
```javascript
|
| 206 |
+
extension.on('core.request.measured', data => {
|
| 207 |
+
const measurements = data.measurements;
|
| 208 |
+
// measurements = { sz_incoming: integer, sz_outgoing: integer }
|
| 209 |
+
|
| 210 |
+
const actor = data.actor; // instance of Actor
|
| 211 |
+
|
| 212 |
+
console.log('[36;1m === MEASUREMENT ===[0m
|
| 213 |
+
', {
|
| 214 |
+
actor: data.actor.uid,
|
| 215 |
+
measurements: data.measurements
|
| 216 |
+
});
|
| 217 |
+
});
|
| 218 |
+
```
|
| 219 |
+
|
| 220 |
+
### `credit.check-available`
|
| 221 |
+
|
| 222 |
+
This event is emitted for credit check available operations.
|
| 223 |
+
|
| 224 |
+
#### Property `available`
|
| 225 |
+
|
| 226 |
+
available
|
| 227 |
+
- **Type**: any
|
| 228 |
+
- **Mutability**: no-effect
|
| 229 |
+
- **Notes**:
|
| 230 |
+
|
| 231 |
+
#### Property `cost_uuid`
|
| 232 |
+
|
| 233 |
+
cost uuid
|
| 234 |
+
- **Type**: string
|
| 235 |
+
- **Mutability**: no-effect
|
| 236 |
+
- **Notes**:
|
| 237 |
+
|
| 238 |
+
|
| 239 |
+
### `credit.funding-update`
|
| 240 |
+
|
| 241 |
+
This event is emitted when a funding-update is updated.
|
| 242 |
+
|
| 243 |
+
#### Property `available`
|
| 244 |
+
|
| 245 |
+
available
|
| 246 |
+
- **Type**: any
|
| 247 |
+
- **Mutability**: no-effect
|
| 248 |
+
- **Notes**:
|
| 249 |
+
|
| 250 |
+
#### Property `cost_uuid`
|
| 251 |
+
|
| 252 |
+
cost uuid
|
| 253 |
+
- **Type**: string
|
| 254 |
+
- **Mutability**: no-effect
|
| 255 |
+
- **Notes**:
|
| 256 |
+
|
| 257 |
+
|
| 258 |
+
### `credit.record-cost`
|
| 259 |
+
|
| 260 |
+
This event is emitted for credit record cost operations.
|
| 261 |
+
|
| 262 |
+
#### Property `available`
|
| 263 |
+
|
| 264 |
+
available
|
| 265 |
+
- **Type**: any
|
| 266 |
+
- **Mutability**: no-effect
|
| 267 |
+
- **Notes**:
|
| 268 |
+
|
| 269 |
+
#### Property `cost_uuid`
|
| 270 |
+
|
| 271 |
+
cost uuid
|
| 272 |
+
- **Type**: string
|
| 273 |
+
- **Mutability**: no-effect
|
| 274 |
+
- **Notes**:
|
| 275 |
+
|
| 276 |
+
|
| 277 |
+
### `driver.create-call-context`
|
| 278 |
+
|
| 279 |
+
This event is emitted when a create-call-context is created.
|
| 280 |
+
|
| 281 |
+
#### Property `usages`
|
| 282 |
+
|
| 283 |
+
usages
|
| 284 |
+
- **Type**: any
|
| 285 |
+
- **Mutability**: no-effect
|
| 286 |
+
- **Notes**:
|
| 287 |
+
|
| 288 |
+
|
| 289 |
+
### `email.validate`
|
| 290 |
+
|
| 291 |
+
This event is emitted when a validate is being validated.
|
| 292 |
+
The event can be used to block certain validates from being validated.
|
| 293 |
+
|
| 294 |
+
#### Property `allow`
|
| 295 |
+
|
| 296 |
+
whether the operation is allowed
|
| 297 |
+
- **Type**: boolean
|
| 298 |
+
- **Mutability**: mutable
|
| 299 |
+
- **Notes**:
|
| 300 |
+
- If set to false, the email will be considered invalid.
|
| 301 |
+
|
| 302 |
+
#### Property `email`
|
| 303 |
+
|
| 304 |
+
email
|
| 305 |
+
- **Type**: any
|
| 306 |
+
- **Mutability**: mutable
|
| 307 |
+
- **Notes**:
|
| 308 |
+
- The email may have already been cleaned.
|
| 309 |
+
|
| 310 |
+
|
| 311 |
+
### `fs.create.directory`
|
| 312 |
+
|
| 313 |
+
This event is emitted when a directory is created.
|
| 314 |
+
|
| 315 |
+
|
| 316 |
+
### `fs.create.file`
|
| 317 |
+
|
| 318 |
+
This event is emitted when a file is created.
|
| 319 |
+
|
| 320 |
+
#### Property `context`
|
| 321 |
+
|
| 322 |
+
current context
|
| 323 |
+
- **Type**: Context
|
| 324 |
+
- **Mutability**: no-effect
|
| 325 |
+
- **Notes**:
|
| 326 |
+
|
| 327 |
+
|
| 328 |
+
### `fs.create.shortcut`
|
| 329 |
+
|
| 330 |
+
This event is emitted when a shortcut is created.
|
| 331 |
+
|
| 332 |
+
|
| 333 |
+
### `fs.create.symlink`
|
| 334 |
+
|
| 335 |
+
This event is emitted when a symlink is created.
|
| 336 |
+
|
| 337 |
+
|
| 338 |
+
### `fs.move.file`
|
| 339 |
+
|
| 340 |
+
This event is emitted for fs move file operations.
|
| 341 |
+
|
| 342 |
+
#### Property `moved`
|
| 343 |
+
|
| 344 |
+
moved
|
| 345 |
+
- **Type**: any
|
| 346 |
+
- **Mutability**: no-effect
|
| 347 |
+
- **Notes**:
|
| 348 |
+
|
| 349 |
+
#### Property `old_path`
|
| 350 |
+
|
| 351 |
+
path to the affected resource
|
| 352 |
+
- **Type**: string
|
| 353 |
+
- **Mutability**: no-effect
|
| 354 |
+
- **Notes**:
|
| 355 |
+
|
| 356 |
+
|
| 357 |
+
### `fs.pending.file`
|
| 358 |
+
|
| 359 |
+
This event is emitted for fs pending file operations.
|
| 360 |
+
|
| 361 |
+
|
| 362 |
+
### `fs.storage.progress.copy`
|
| 363 |
+
|
| 364 |
+
This event reports progress of a copy operation.
|
| 365 |
+
|
| 366 |
+
#### Property `context`
|
| 367 |
+
|
| 368 |
+
current context
|
| 369 |
+
- **Type**: Context
|
| 370 |
+
- **Mutability**: no-effect
|
| 371 |
+
- **Notes**:
|
| 372 |
+
|
| 373 |
+
#### Property `meta`
|
| 374 |
+
|
| 375 |
+
additional metadata for the operation
|
| 376 |
+
- **Type**: object
|
| 377 |
+
- **Mutability**: no-effect
|
| 378 |
+
- **Notes**:
|
| 379 |
+
|
| 380 |
+
#### Property `item_path`
|
| 381 |
+
|
| 382 |
+
path to the affected resource
|
| 383 |
+
- **Type**: string
|
| 384 |
+
- **Mutability**: no-effect
|
| 385 |
+
- **Notes**:
|
| 386 |
+
|
| 387 |
+
|
| 388 |
+
### `fs.storage.upload-progress`
|
| 389 |
+
|
| 390 |
+
This event reports progress of a upload-progress operation.
|
| 391 |
+
|
| 392 |
+
|
| 393 |
+
### `fs.write.file`
|
| 394 |
+
|
| 395 |
+
This event is emitted when a file is updated.
|
| 396 |
+
|
| 397 |
+
#### Property `context`
|
| 398 |
+
|
| 399 |
+
current context
|
| 400 |
+
- **Type**: Context
|
| 401 |
+
- **Mutability**: no-effect
|
| 402 |
+
- **Notes**:
|
| 403 |
+
|
| 404 |
+
|
| 405 |
+
### `ip.validate`
|
| 406 |
+
|
| 407 |
+
This event is emitted when a validate is being validated.
|
| 408 |
+
The event can be used to block certain validates from being validated.
|
| 409 |
+
|
| 410 |
+
#### Property `res`
|
| 411 |
+
|
| 412 |
+
res
|
| 413 |
+
- **Type**: any
|
| 414 |
+
- **Mutability**: mutable
|
| 415 |
+
- **Notes**:
|
| 416 |
+
|
| 417 |
+
#### Property `end_`
|
| 418 |
+
|
| 419 |
+
end
|
| 420 |
+
- **Type**: any
|
| 421 |
+
- **Mutability**: mutable
|
| 422 |
+
- **Notes**:
|
| 423 |
+
|
| 424 |
+
#### Property `end`
|
| 425 |
+
|
| 426 |
+
end
|
| 427 |
+
- **Type**: any
|
| 428 |
+
- **Mutability**: mutable
|
| 429 |
+
- **Notes**:
|
| 430 |
+
|
| 431 |
+
|
| 432 |
+
### `outer.fs.write-hash`
|
| 433 |
+
|
| 434 |
+
This event is emitted when a write-hash is updated.
|
| 435 |
+
|
| 436 |
+
#### Property `uuid`
|
| 437 |
+
|
| 438 |
+
uuid
|
| 439 |
+
- **Type**: string
|
| 440 |
+
- **Mutability**: no-effect
|
| 441 |
+
- **Notes**:
|
| 442 |
+
|
| 443 |
+
|
| 444 |
+
### `outer.gui.item.added`
|
| 445 |
+
|
| 446 |
+
This event is emitted for outer gui item added operations.
|
| 447 |
+
|
| 448 |
+
#### Property `response`
|
| 449 |
+
|
| 450 |
+
response
|
| 451 |
+
- **Type**: any
|
| 452 |
+
- **Mutability**: no-effect
|
| 453 |
+
- **Notes**:
|
| 454 |
+
|
| 455 |
+
|
| 456 |
+
### `outer.gui.item.moved`
|
| 457 |
+
|
| 458 |
+
This event is emitted for outer gui item moved operations.
|
| 459 |
+
|
| 460 |
+
#### Property `response`
|
| 461 |
+
|
| 462 |
+
response
|
| 463 |
+
- **Type**: any
|
| 464 |
+
- **Mutability**: no-effect
|
| 465 |
+
- **Notes**:
|
| 466 |
+
|
| 467 |
+
|
| 468 |
+
### `outer.gui.item.pending`
|
| 469 |
+
|
| 470 |
+
This event is emitted for outer gui item pending operations.
|
| 471 |
+
|
| 472 |
+
#### Property `response`
|
| 473 |
+
|
| 474 |
+
response
|
| 475 |
+
- **Type**: any
|
| 476 |
+
- **Mutability**: no-effect
|
| 477 |
+
- **Notes**:
|
| 478 |
+
|
| 479 |
+
|
| 480 |
+
### `outer.gui.item.updated`
|
| 481 |
+
|
| 482 |
+
This event is emitted when a updated is updated.
|
| 483 |
+
|
| 484 |
+
#### Property `response`
|
| 485 |
+
|
| 486 |
+
response
|
| 487 |
+
- **Type**: any
|
| 488 |
+
- **Mutability**: no-effect
|
| 489 |
+
- **Notes**:
|
| 490 |
+
|
| 491 |
+
|
| 492 |
+
### `outer.gui.notif.ack`
|
| 493 |
+
|
| 494 |
+
This event is emitted for outer gui notif ack operations.
|
| 495 |
+
|
| 496 |
+
#### Property `response`
|
| 497 |
+
|
| 498 |
+
response
|
| 499 |
+
- **Type**: any
|
| 500 |
+
- **Mutability**: no-effect
|
| 501 |
+
- **Notes**:
|
| 502 |
+
|
| 503 |
+
|
| 504 |
+
### `outer.gui.notif.message`
|
| 505 |
+
|
| 506 |
+
This event is emitted for outer gui notif message operations.
|
| 507 |
+
|
| 508 |
+
#### Property `response`
|
| 509 |
+
|
| 510 |
+
response
|
| 511 |
+
- **Type**: any
|
| 512 |
+
- **Mutability**: no-effect
|
| 513 |
+
- **Notes**:
|
| 514 |
+
|
| 515 |
+
#### Property `notification`
|
| 516 |
+
|
| 517 |
+
notification
|
| 518 |
+
- **Type**: any
|
| 519 |
+
- **Mutability**: no-effect
|
| 520 |
+
- **Notes**:
|
| 521 |
+
|
| 522 |
+
|
| 523 |
+
### `outer.gui.notif.persisted`
|
| 524 |
+
|
| 525 |
+
This event is emitted for outer gui notif persisted operations.
|
| 526 |
+
|
| 527 |
+
#### Property `response`
|
| 528 |
+
|
| 529 |
+
response
|
| 530 |
+
- **Type**: any
|
| 531 |
+
- **Mutability**: no-effect
|
| 532 |
+
- **Notes**:
|
| 533 |
+
|
| 534 |
+
|
| 535 |
+
### `outer.gui.notif.unreads`
|
| 536 |
+
|
| 537 |
+
This event is emitted for outer gui notif unreads operations.
|
| 538 |
+
|
| 539 |
+
#### Property `response`
|
| 540 |
+
|
| 541 |
+
response
|
| 542 |
+
- **Type**: any
|
| 543 |
+
- **Mutability**: no-effect
|
| 544 |
+
- **Notes**:
|
| 545 |
+
|
| 546 |
+
|
| 547 |
+
### `outer.gui.submission.done`
|
| 548 |
+
|
| 549 |
+
This event is emitted for outer gui submission done operations.
|
| 550 |
+
|
| 551 |
+
#### Property `response`
|
| 552 |
+
|
| 553 |
+
response
|
| 554 |
+
- **Type**: any
|
| 555 |
+
- **Mutability**: no-effect
|
| 556 |
+
- **Notes**:
|
| 557 |
+
|
| 558 |
+
|
| 559 |
+
### `outer.gui.usage.update`
|
| 560 |
+
|
| 561 |
+
This event is emitted when a update is updated.
|
| 562 |
+
|
| 563 |
+
|
| 564 |
+
### `outer.thread.notify-subscribers`
|
| 565 |
+
|
| 566 |
+
This event is emitted for outer thread notify subscribers operations.
|
| 567 |
+
|
| 568 |
+
#### Property `uid`
|
| 569 |
+
|
| 570 |
+
uid
|
| 571 |
+
- **Type**: string
|
| 572 |
+
- **Mutability**: no-effect
|
| 573 |
+
- **Notes**:
|
| 574 |
+
|
| 575 |
+
#### Property `action`
|
| 576 |
+
|
| 577 |
+
action
|
| 578 |
+
- **Type**: any
|
| 579 |
+
- **Mutability**: no-effect
|
| 580 |
+
- **Notes**:
|
| 581 |
+
|
| 582 |
+
#### Property `data`
|
| 583 |
+
|
| 584 |
+
data
|
| 585 |
+
- **Type**: any
|
| 586 |
+
- **Mutability**: no-effect
|
| 587 |
+
- **Notes**:
|
| 588 |
+
|
| 589 |
+
|
| 590 |
+
### `puter.signup`
|
| 591 |
+
|
| 592 |
+
This event is emitted for puter signup operations.
|
| 593 |
+
|
| 594 |
+
#### Property `ip`
|
| 595 |
+
|
| 596 |
+
ip
|
| 597 |
+
- **Type**: any
|
| 598 |
+
- **Mutability**: mutable
|
| 599 |
+
- **Notes**:
|
| 600 |
+
|
| 601 |
+
#### Property `user_agent`
|
| 602 |
+
|
| 603 |
+
user agent
|
| 604 |
+
- **Type**: any
|
| 605 |
+
- **Mutability**: mutable
|
| 606 |
+
- **Notes**:
|
| 607 |
+
|
| 608 |
+
#### Property `body`
|
| 609 |
+
|
| 610 |
+
body
|
| 611 |
+
- **Type**: any
|
| 612 |
+
- **Mutability**: mutable
|
| 613 |
+
- **Notes**:
|
| 614 |
+
|
| 615 |
+
|
| 616 |
+
### `request.measured`
|
| 617 |
+
|
| 618 |
+
This event is emitted for request measured operations.
|
| 619 |
+
|
| 620 |
+
#### Property `req`
|
| 621 |
+
|
| 622 |
+
req
|
| 623 |
+
- **Type**: any
|
| 624 |
+
- **Mutability**: no-effect
|
| 625 |
+
- **Notes**:
|
| 626 |
+
|
| 627 |
+
#### Property `res`
|
| 628 |
+
|
| 629 |
+
res
|
| 630 |
+
- **Type**: any
|
| 631 |
+
- **Mutability**: no-effect
|
| 632 |
+
- **Notes**:
|
| 633 |
+
|
| 634 |
+
|
| 635 |
+
### `request.will-be-handled`
|
| 636 |
+
|
| 637 |
+
This event is emitted for request will be handled operations.
|
| 638 |
+
|
| 639 |
+
#### Property `res`
|
| 640 |
+
|
| 641 |
+
res
|
| 642 |
+
- **Type**: any
|
| 643 |
+
- **Mutability**: mutable
|
| 644 |
+
- **Notes**:
|
| 645 |
+
|
| 646 |
+
#### Property `end_`
|
| 647 |
+
|
| 648 |
+
end
|
| 649 |
+
- **Type**: any
|
| 650 |
+
- **Mutability**: mutable
|
| 651 |
+
- **Notes**:
|
| 652 |
+
|
| 653 |
+
#### Property `end`
|
| 654 |
+
|
| 655 |
+
end
|
| 656 |
+
- **Type**: any
|
| 657 |
+
- **Mutability**: mutable
|
| 658 |
+
- **Notes**:
|
| 659 |
+
|
| 660 |
+
|
| 661 |
+
### `sns`
|
| 662 |
+
|
| 663 |
+
This event is emitted for sns operations.
|
| 664 |
+
|
| 665 |
+
#### Property `message`
|
| 666 |
+
|
| 667 |
+
message
|
| 668 |
+
- **Type**: any
|
| 669 |
+
- **Mutability**: no-effect
|
| 670 |
+
- **Notes**:
|
| 671 |
+
|
| 672 |
+
|
| 673 |
+
### `template-service.hello`
|
| 674 |
+
|
| 675 |
+
This event is emitted for template-service hello operations.
|
| 676 |
+
|
| 677 |
+
|
| 678 |
+
### `usages.query`
|
| 679 |
+
|
| 680 |
+
This event is emitted for usages query operations.
|
| 681 |
+
|
| 682 |
+
#### Property `usages`
|
| 683 |
+
|
| 684 |
+
usages
|
| 685 |
+
- **Type**: any
|
| 686 |
+
- **Mutability**: no-effect
|
| 687 |
+
- **Notes**:
|
| 688 |
+
|
| 689 |
+
|
| 690 |
+
### `user.email-changed`
|
| 691 |
+
|
| 692 |
+
This event is emitted for user email changed operations.
|
| 693 |
+
|
| 694 |
+
#### Property `new_email`
|
| 695 |
+
|
| 696 |
+
new email
|
| 697 |
+
- **Type**: any
|
| 698 |
+
- **Mutability**: no-effect
|
| 699 |
+
- **Notes**:
|
| 700 |
+
|
| 701 |
+
|
| 702 |
+
### `user.email-confirmed`
|
| 703 |
+
|
| 704 |
+
This event is emitted for user email confirmed operations.
|
| 705 |
+
|
| 706 |
+
#### Property `email`
|
| 707 |
+
|
| 708 |
+
email
|
| 709 |
+
- **Type**: any
|
| 710 |
+
- **Mutability**: no-effect
|
| 711 |
+
- **Notes**:
|
| 712 |
+
|
| 713 |
+
|
| 714 |
+
### `user.save_account`
|
| 715 |
+
|
| 716 |
+
This event is emitted for user save_account operations.
|
| 717 |
+
|
| 718 |
+
#### Property `user`
|
| 719 |
+
|
| 720 |
+
user associated with the operation
|
| 721 |
+
- **Type**: User
|
| 722 |
+
- **Mutability**: no-effect
|
| 723 |
+
- **Notes**:
|
| 724 |
+
|
| 725 |
+
|
| 726 |
+
### `web.socket.connected`
|
| 727 |
+
|
| 728 |
+
This event is emitted for web socket connected operations.
|
| 729 |
+
|
| 730 |
+
#### Property `user`
|
| 731 |
+
|
| 732 |
+
user associated with the operation
|
| 733 |
+
- **Type**: User
|
| 734 |
+
- **Mutability**: mutable
|
| 735 |
+
- **Notes**:
|
| 736 |
+
|
| 737 |
+
|
| 738 |
+
### `web.socket.user-connected`
|
| 739 |
+
|
| 740 |
+
This event is emitted for web socket user connected operations.
|
| 741 |
+
|
| 742 |
+
#### Property `user`
|
| 743 |
+
|
| 744 |
+
user associated with the operation
|
| 745 |
+
- **Type**: User
|
| 746 |
+
- **Mutability**: mutable
|
| 747 |
+
- **Notes**:
|
| 748 |
+
|
| 749 |
+
|
| 750 |
+
### `wisp.get-policy`
|
| 751 |
+
|
| 752 |
+
This event is emitted for wisp get policy operations.
|
| 753 |
+
|
| 754 |
+
#### Property `policy`
|
| 755 |
+
|
| 756 |
+
policy information for the operation
|
| 757 |
+
- **Type**: Policy
|
| 758 |
+
- **Mutability**: mutable
|
| 759 |
+
- **Notes**:
|
| 760 |
+
|
| 761 |
+
|
doc/contributors/extensions/gen.js
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
import dedent from 'dedent';
|
| 2 |
+
import events from './events.json.js';
|
| 3 |
+
|
| 4 |
+
const mdlib = {};
|
| 5 |
+
mdlib.h = (out, n, str) => {
|
| 6 |
+
out(`${'#'.repeat(n)} ${str}\n\n`);
|
| 7 |
+
};
|
| 8 |
+
|
| 9 |
+
const N_START = 3;
|
| 10 |
+
|
| 11 |
+
const out = str => process.stdout.write(str);
|
| 12 |
+
for ( const event of events ) {
|
| 13 |
+
mdlib.h(out, N_START, `\`${event.id}\``);
|
| 14 |
+
out(`${dedent(event.description) }\n\n`);
|
| 15 |
+
|
| 16 |
+
for ( const k in event.properties ) {
|
| 17 |
+
const prop = event.properties[k];
|
| 18 |
+
mdlib.h(out, N_START + 1, `Property \`${k}\``);
|
| 19 |
+
out(`${prop.summary }\n`);
|
| 20 |
+
out(`- **Type**: ${prop.type}\n`);
|
| 21 |
+
out(`- **Mutability**: ${prop.mutability}\n`);
|
| 22 |
+
if ( prop.notes ) {
|
| 23 |
+
out('- **Notes**:\n');
|
| 24 |
+
for ( const note of prop.notes ) {
|
| 25 |
+
out(` - ${note}\n`);
|
| 26 |
+
}
|
| 27 |
+
}
|
| 28 |
+
out('\n');
|
| 29 |
+
}
|
| 30 |
+
|
| 31 |
+
if ( event.example ) {
|
| 32 |
+
mdlib.h(out, N_START + 1, 'Example');
|
| 33 |
+
out(`\`\`\`${event.example.language}\n${dedent(event.example.code)}\n\`\`\`\n`);
|
| 34 |
+
}
|
| 35 |
+
|
| 36 |
+
out('\n');
|
| 37 |
+
|
| 38 |
+
}
|
doc/contributors/extensions/manual_overrides.json.js
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
export default [
|
| 2 |
+
{
|
| 3 |
+
id: 'core.email.validate',
|
| 4 |
+
description: `
|
| 5 |
+
This event is emitted when an email is being validated.
|
| 6 |
+
The event can be used to block certain emails from being validated.
|
| 7 |
+
`,
|
| 8 |
+
properties: {
|
| 9 |
+
email: {
|
| 10 |
+
type: 'string',
|
| 11 |
+
mutability: 'no-effect',
|
| 12 |
+
summary: 'the email being validated',
|
| 13 |
+
notes: [
|
| 14 |
+
'The email may have already been cleaned.',
|
| 15 |
+
],
|
| 16 |
+
},
|
| 17 |
+
allow: {
|
| 18 |
+
type: 'boolean',
|
| 19 |
+
mutability: 'mutable',
|
| 20 |
+
summary: 'whether the email is allowed',
|
| 21 |
+
notes: [
|
| 22 |
+
'If set to false, the email will be considered invalid.',
|
| 23 |
+
],
|
| 24 |
+
},
|
| 25 |
+
},
|
| 26 |
+
},
|
| 27 |
+
{
|
| 28 |
+
id: 'core.request.measured',
|
| 29 |
+
description: `
|
| 30 |
+
This event is emitted when a requests incoming and outgoing bytes
|
| 31 |
+
have been measured.
|
| 32 |
+
`,
|
| 33 |
+
example: {
|
| 34 |
+
language: 'javascript',
|
| 35 |
+
code: /*javascript*/`
|
| 36 |
+
extension.on('core.request.measured', data => {
|
| 37 |
+
const measurements = data.measurements;
|
| 38 |
+
// measurements = { sz_incoming: integer, sz_outgoing: integer }
|
| 39 |
+
|
| 40 |
+
const actor = data.actor; // instance of Actor
|
| 41 |
+
|
| 42 |
+
console.log('\\x1B[36;1m === MEASUREMENT ===\\x1B[0m\\n', {
|
| 43 |
+
actor: data.actor.uid,
|
| 44 |
+
measurements: data.measurements
|
| 45 |
+
});
|
| 46 |
+
});
|
| 47 |
+
`,
|
| 48 |
+
},
|
| 49 |
+
},
|
| 50 |
+
{
|
| 51 |
+
id: 'core.fs.create.directory',
|
| 52 |
+
description: `
|
| 53 |
+
This event is emitted when a directory is created.
|
| 54 |
+
`,
|
| 55 |
+
properties: {
|
| 56 |
+
node: {
|
| 57 |
+
type: 'FSNodeContext',
|
| 58 |
+
mutability: 'no-effect',
|
| 59 |
+
summary: 'the directory that was created',
|
| 60 |
+
},
|
| 61 |
+
context: {
|
| 62 |
+
type: 'Context',
|
| 63 |
+
mutability: 'no-effect',
|
| 64 |
+
summary: 'current context',
|
| 65 |
+
},
|
| 66 |
+
},
|
| 67 |
+
},
|
| 68 |
+
];
|
doc/contributors/image.png
ADDED
|
Git LFS Details
|
doc/contributors/structure.md
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Repository Structure and Tooling
|
| 2 |
+
|
| 3 |
+
Puter has many of its parts in a single [monorepo](https://en.wikipedia.org/wiki/Monorepo),
|
| 4 |
+
rather than a single repository for each cohesive part.
|
| 5 |
+
We feel this makes it easier for new contributors to develop Puter since you don't
|
| 6 |
+
need to figure out how to tie the parts together or how to work with Git submodules.
|
| 7 |
+
It also makes it easier for us to maintain project-wide conventions and tooling.
|
| 8 |
+
|
| 9 |
+
Some tools, like [puter-cli](https://github.com/HeyPuter/puter-cli), exist in separate
|
| 10 |
+
repositories. The `puter-cli` tool is used externally and can communicate with Puter's
|
| 11 |
+
API on our production (puter.com) instance or your own instance of Puter, so there's
|
| 12 |
+
not really any advantage to putting it in the monorepo.
|
| 13 |
+
|
| 14 |
+
## Top-Level directories
|
| 15 |
+
|
| 16 |
+
### The `doc` directory
|
| 17 |
+
|
| 18 |
+
The top-level `doc` directory contains the file you're reading right now.
|
| 19 |
+
Its scope is documentation for using and contributing to Puter in general,
|
| 20 |
+
and linking to more specific documentation in other places.
|
| 21 |
+
|
| 22 |
+
All `doc` directories will have a `README.md` which should be considered as
|
| 23 |
+
the index file for the documentation. All documentation under a `doc`
|
| 24 |
+
directory should be accessible via a path of links starting from `README.md`.
|
| 25 |
+
|
| 26 |
+
### The `src` directory
|
| 27 |
+
|
| 28 |
+
Every directory under `/tools` is [an npm "workspaces" module](https://docs.npmjs.com/cli/v8/using-npm/workspaces). Every direct child of this directory (generally) has a `package.json` and a `src` directory.
|
| 29 |
+
|
| 30 |
+
Some of these modules are core pieces of Puter:
|
| 31 |
+
- **Puter's backend** is [`/src/backend`](/src/backend)
|
| 32 |
+
- See [key locations in backend documentation](/src/backend/doc/contributors/structure.md)
|
| 33 |
+
- **Puter's GUI** is [`/src/gui`](/src/gui)
|
| 34 |
+
|
| 35 |
+
Some of these modules are apps:
|
| 36 |
+
- **Puter's Terminal**: [`/src/terminal`](/src/terminal)
|
| 37 |
+
- **Puter's Shell**: [`/src/phoenix`](/src/phoenix)
|
| 38 |
+
|
| 39 |
+
Some of these modules are libraries:
|
| 40 |
+
- **common javascript**: [`/src/putility`](/src/putility)
|
| 41 |
+
- **runtime import mechanism**: [`/src/useapi`](/src/useapi)
|
| 42 |
+
- **Puter's "puter.js" browser SDK**: [`/src/puter-js`](/src/puter-js)
|
| 43 |
+
|
| 44 |
+
### The `volatile` directory
|
| 45 |
+
|
| 46 |
+
When you're running Puter with development instructions (i.e. `npm start`),
|
| 47 |
+
Puter's configuration directory will be `volatile/config` and Puter's
|
| 48 |
+
runtime directory will be `volatile/runtime`, instead of the standard
|
| 49 |
+
`/etc/puter` and `/var/puter` directories in production installations.
|
| 50 |
+
|
| 51 |
+
We should probably rename this directory, actually, but it would inconvenience
|
| 52 |
+
a lot of people right now if we did.
|
| 53 |
+
|
| 54 |
+
### The `tools` directory
|
| 55 |
+
|
| 56 |
+
Every directory under `/tools` is [an npm "workspaces" module](https://docs.npmjs.com/cli/v8/using-npm/workspaces).
|
| 57 |
+
|
| 58 |
+
This is where `run-selfhosted.js` is. That's the entrypoint for `npm start`.
|
| 59 |
+
|
| 60 |
+
These tools are underdocumented and may not behave well if they're not executed
|
| 61 |
+
from the correct working directory (which is different for different tools).
|
| 62 |
+
Consider this a work-in-progress. If you want to use or contribute to anything
|
| 63 |
+
under this directory, for now you should
|
| 64 |
+
[tag @KernelDeimos on the community Discord](https://discord.gg/PQcx7Teh8u).
|
doc/contributors/vscode.md
ADDED
|
@@ -0,0 +1,2 @@
|
|
|
|
|
|
|
|
|
|
| 1 |
+
### `vscode`
|
| 2 |
+
- `es6-string-html`
|
doc/devlog.md
ADDED
|
@@ -0,0 +1,103 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
## 2024-10-16
|
| 2 |
+
|
| 3 |
+
### Considerations for Mountpoints Feature
|
| 4 |
+
|
| 5 |
+
- `_storage_upload` takes paramter `uuid` instead of `path`
|
| 6 |
+
- S3 bucket strategy needs the UUID
|
| 7 |
+
- If we do hashes, 10MB chunks should be fine
|
| 8 |
+
- we're already able to smooth out bursty traffic using the
|
| 9 |
+
EWA algorithm
|
| 10 |
+
- Use of `systemFSEntryService`
|
| 11 |
+
- Is that normalized? Does everything go through this interface?
|
| 12 |
+
- Storage interface has methods like `post_insert`
|
| 13 |
+
- as far as I can tell this doesn't pose any issue
|
| 14 |
+
-
|
| 15 |
+
|
| 16 |
+
### Brainstorming Migration Strategies
|
| 17 |
+
|
| 18 |
+
#### Interface boundary at HL<->LL filesystem methods
|
| 19 |
+
|
| 20 |
+
-- **tags:** brainstorming
|
| 21 |
+
|
| 22 |
+
From the perspectice of a trait-oriented implementation,
|
| 23 |
+
which is not how LL/HL filesystem operations are currently implemented,
|
| 24 |
+
the LL-class operations are implemented in separate traits.
|
| 25 |
+
|
| 26 |
+
The composite trait containing all of these traits would be the trait
|
| 27 |
+
that represents a filesystem implementation itself.
|
| 28 |
+
|
| 29 |
+
Other filesystem interfaces that I've seen, such as FUSE and 9p,
|
| 30 |
+
all usually have a monolithic interface - that is to say, an interface
|
| 31 |
+
which includes all of the filesystem operations, rather than several
|
| 32 |
+
interfaces each implementing a single filesystem operaiton.
|
| 33 |
+
|
| 34 |
+
Something about the fact that the LL-class operations are in separate
|
| 35 |
+
classes makes it difficult to reason about how to move.
|
| 36 |
+
Is it simply that multiple files in a directory is just more
|
| 37 |
+
annoying to think about? Maybe, but there must be something more.
|
| 38 |
+
|
| 39 |
+
Perhaps it's that there are several references. Each implementation
|
| 40 |
+
(that is, implemenation of a single filesystem operation) could have
|
| 41 |
+
any number of different references across any number of different files.
|
| 42 |
+
This would not be the case with a monolithic interface.
|
| 43 |
+
|
| 44 |
+
I think the best of both worlds would be to have an interface representing
|
| 45 |
+
the entire filesystem and, in one place, link of of the individual
|
| 46 |
+
operation implementations to compose a filesystem implementation
|
| 47 |
+
|
| 48 |
+
### Filesystem Brainstorming
|
| 49 |
+
|
| 50 |
+
Puter's backend uses a service architecture. Each service is an instance
|
| 51 |
+
of a class extending "Service". A service can listen to events of the
|
| 52 |
+
backend's lifecycle, interact with other services, and interact with
|
| 53 |
+
external interfaces such as APIs and databases.
|
| 54 |
+
|
| 55 |
+
Puter's current filesystem, let's call it PuterFSv1, exists as the result
|
| 56 |
+
of multiple services working together. We have LocalDiskStorageService
|
| 57 |
+
which mimics an S3 bucket on a local system, and we have
|
| 58 |
+
DatabaseFSEntryService which manages information about files, directories,
|
| 59 |
+
and their relationships within the database, and therefore depends on
|
| 60 |
+
DatabaseAccessService.
|
| 61 |
+
|
| 62 |
+
It is now time to introduce a MountpointService. This will allow another
|
| 63 |
+
service or a user's configuration to assign an instance of a filesystem
|
| 64 |
+
implementation (such as PuterFSv1) to a specific path.
|
| 65 |
+
|
| 66 |
+
The trouble here is that PuterFSv1 is composed of services, and the nature
|
| 67 |
+
of a service is such that it exists for the lifecycle of the application.
|
| 68 |
+
The class for a particular service can be re-used and registered with
|
| 69 |
+
multiple names (creating multiple services with the same implementation
|
| 70 |
+
but perhaps different configuration), but that's only a clean scenario when
|
| 71 |
+
there is just one service. PuterFSv1, on the other hand, is like an
|
| 72 |
+
imaginary service composed of other services.
|
| 73 |
+
|
| 74 |
+
The following possibilities then should be discussed:
|
| 75 |
+
- CompositeService base class for a service that is composed of
|
| 76 |
+
more than one service.
|
| 77 |
+
- Refactor filesystem to not use service architecture.
|
| 78 |
+
- Each filesystem service can manage state and configuration
|
| 79 |
+
for multiple mountpoints
|
| 80 |
+
(I don't like this idea; it feels messy. I wonder what software
|
| 81 |
+
principles this violates)
|
| 82 |
+
|
| 83 |
+
We can take advantage of traits/interfaces here.
|
| 84 |
+
PuterFSv1 depends on two interfaces:
|
| 85 |
+
- An S3-like data storage implementation
|
| 86 |
+
- An fsentry storage implementation
|
| 87 |
+
|
| 88 |
+
Counterintuitively from what I first thought, "Refactor the filesystem"
|
| 89 |
+
actually looks like the best solution, and it doens't even look like it
|
| 90 |
+
will be that difficult. In fact, it'll likely make the filesystem easier
|
| 91 |
+
to maintain and more robust as a result.
|
| 92 |
+
|
| 93 |
+
Additionally, we can introduce PuterFSv2, which will introduce storing
|
| 94 |
+
data in chunks identified by their hashes, and associated hashes with
|
| 95 |
+
fsentries.
|
| 96 |
+
|
| 97 |
+
PuterFSService will be a new service which registers 'PuterFSv1' with
|
| 98 |
+
FilesystemService.
|
| 99 |
+
|
| 100 |
+
An instance of a filesystem needs to be separate from a mountpoint.
|
| 101 |
+
For example, PuterFSv1 will usually have only one instance but it may
|
| 102 |
+
be mounted several different times. `/some-user` on Puter's VFS could
|
| 103 |
+
be a mountpoint for `/some-user` in the instance of PuterFSv1.
|