@heyputer/puter.js 2.2.2 → 2.2.4

package/index.d.ts

@@ -11,7 +11,6 @@ import type { KV, KVIncrementPath, KVPair } from './types/modules/kv.d.ts';
 import type { Networking, PSocket, PTLSSocket } from './types/modules/networking.d.ts';
 import type { OS } from './types/modules/os.d.ts';
 import type { Perms } from './types/modules/perms.d.ts';
-import type Threads from './types/modules/threads.d.ts';
 import type { AlertButton, AppConnection, AppConnectionCloseEvent, CancelAwarePromise, ContextMenuItem, ContextMenuOptions, DirectoryPickerOptions, FilePickerOptions, LaunchAppOptions, MenuItem, MenubarOptions, ThemeData, UI, WindowOptions } from './types/modules/ui.d.ts';
 import type Util, { UtilRPC } from './types/modules/util.d.ts';
 import type { WorkerDeployment, WorkerInfo, WorkersHandler } from './types/modules/workers.d.ts';
@@ -93,7 +92,6 @@ export type {
     Speech2TxtOptions,
     Subdomain,
     ThemeData,
-    Threads,
     ToolSchema,
     Txt2ImgOptions,
     Txt2SpeechCallable,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@heyputer/puter.js",
-    "version": "2.2.2",
+    "version": "2.2.4",
     "description": "Puter.js - A JavaScript library for interacting with Puter services.",
     "homepage": "https://developer.puter.com",
     "main": "src/index.js",

package/src/index.js

@@ -18,7 +18,6 @@ import { PTLSSocket } from './modules/networking/PTLS.js';
 import { pFetch } from './modules/networking/requests.js';
 import OS from './modules/OS.js';
 import Perms from './modules/Perms.js';
-import Threads from './modules/Threads.js';
 import UI from './modules/UI.js';
 import Util from './modules/Util.js';
 import { WorkersHandler } from './modules/Workers.js';
@@ -170,7 +169,6 @@ const puterInit = (function () {
             this.registerModule('apps', Apps);
             this.registerModule('ai', AI);
             this.registerModule('kv', KV);
-            this.registerModule('threads', Threads);
             this.registerModule('perms', Perms);
             this.registerModule('drivers', Drivers);
             this.registerModule('debug', Debug);

package/src/lib/utils.js

@@ -1,4 +1,5 @@
 import { FileReaderPoly } from "./polyfills/fileReaderPoly.js";
+import { showUsageLimitDialog } from "../modules/UsageLimitDialog.js";
 
 /**
  * Parses a given response text into a JSON object. If the parsing fails due to invalid JSON format,
@@ -386,6 +387,14 @@ async function driverCall_ (
                         const line = lines_received.shift();
                         if ( line.trim() === '' ) continue;
                         const lineObject = (JSON.parse(line));
+
+                        // Check for usage limit errors in streaming responses
+                        if ( lineObject?.error?.code === 'insufficient_funds' || lineObject?.metadata?.usage_limited === true ) {
+                            if ( puter.env === 'web' ) {
+                                showUsageLimitDialog('You have reached your usage limit for this account.<br>Please upgrade to continue.');
+                            }
+                        }
+
                         if ( typeof (lineObject.text) === 'string' ) {
                             Object.defineProperty(lineObject, 'toString', {
                                 enumerable: false,
@@ -462,6 +471,16 @@ async function driverCall_ (
             });
         }
 
+        // Check for usage limit errors and show upgrade dialog
+        const isInsufficientFunds = (response.target?.status === 402) ||
+            (resp?.error?.code === 'insufficient_funds') ||
+            (resp?.error?.status === 402);
+        const isUsageLimited = resp?.metadata?.usage_limited === true;
+
+        if ( (isInsufficientFunds || isUsageLimited) && puter.env === 'web' ) {
+            showUsageLimitDialog('Your account has not enough funding to complete this request.<br>Please upgrade to continue.');
+        }
+
         // HTTP Error - unauthorized
         if ( response.status === 401 || resp?.code === 'token_auth_failed' ) {
             if ( resp?.code === 'token_auth_failed' && puter.env === 'web' ) {

package/src/modules/Apps.js

@@ -16,6 +16,37 @@ class Apps {
         this.appID = puter.appID;
     }
 
+    #addUserIterationToApp (app) {
+        app.getUsers = async (params) => {
+            params = params ?? {};
+            return (await puter.drivers.call('app-telemetry', 'app-telemetry', 'get_users', { app_uuid: app.uid, limit: params.limit, offset: params.offset })).result;
+        };
+        app.users = async function* (pageSize = 100) {
+            let offset = 0;
+
+            while ( true ) {
+                const users = await app.getUsers({ limit: pageSize, offset });
+
+                if ( !users || users.length === 0 ) return;
+
+                for ( const user of users ) {
+                    yield user;
+                }
+
+                offset += users.length;
+                if ( users.length < pageSize ) return;
+            }
+        };
+        return app;
+    }
+
+    #addUserIterationToApps (apps) {
+        apps.forEach(app => {
+            this.#addUserIterationToApp(app);
+        });
+        return apps;
+    }
+
     /**
      * Sets a new authentication token.
      *
@@ -48,7 +79,7 @@ class Apps {
 
         options.predicate = ['user-can-edit'];
 
-        return utils.make_driver_method(['uid'], 'puter-apps', undefined, 'select').call(this, options);
+        return this.#addUserIterationToApps(await utils.make_driver_method(['uid'], 'puter-apps', 'es:app', 'select').call(this, options));
     };
 
     create = async (...args) => {
@@ -112,7 +143,7 @@ class Apps {
         }
 
         // Call the original chat.complete method
-        return await utils.make_driver_method(['object'], 'puter-apps', undefined, 'create').call(this, options);
+        return this.#addUserIterationToApp(await utils.make_driver_method(['object'], 'puter-apps', 'es:app', 'create').call(this, options));
     };
 
     update = async (...args) => {
@@ -138,7 +169,7 @@ class Apps {
         }
 
         // Call the original chat.complete method
-        return await utils.make_driver_method(['object'], 'puter-apps', undefined, 'update').call(this, options);
+        return this.#addUserIterationToApp(await utils.make_driver_method(['object'], 'puter-apps', 'es:app', 'update').call(this, options));
     };
 
     get = async (...args) => {
@@ -159,8 +190,7 @@ class Apps {
         if ( typeof args[0] === 'object' && args[0] !== null ) {
             options.params = args[0];
         }
-
-        return utils.make_driver_method(['uid'], 'puter-apps', undefined, 'read').call(this, options);
+        return this.#addUserIterationToApp(await utils.make_driver_method(['uid'], 'puter-apps', 'es:app', 'read').call(this, options));
     };
 
     delete = async (...args) => {
@@ -170,7 +200,7 @@ class Apps {
         if ( Array.isArray(args) && typeof args[0] === 'string' ) {
             options = { id: { name: args[0] } };
         }
-        return utils.make_driver_method(['uid'], 'puter-apps', undefined, 'delete').call(this, options);
+        return utils.make_driver_method(['uid'], 'puter-apps', 'es:app', 'delete').call(this, options);
     };
 
     getDeveloperProfile = function (...args) {

package/src/modules/FileSystem/index.js

@@ -45,8 +45,6 @@ export class PuterJSFileSystemModule {
 
     FSItem = FSItem;
 
-    static NARI_METHODS = {};
-
     /**
      * Creates a new instance with the given authentication token, API origin, and app ID,
      * and connects to the socket.

package/src/modules/KV.js

@@ -212,6 +212,52 @@ class KV {
         return utils.make_driver_method(['key'], 'puter-kvstore', undefined, 'decr').call(this, options);
     };
 
+    add = async (...args) => {
+        let options = {};
+
+        // arguments are required
+        if ( !args || args.length === 0 ) {
+            throw ({ message: 'Arguments are required', code: 'arguments_required' });
+        }
+
+        options.key = args[0];
+        const provided = args[1];
+        const isPathMap = provided && typeof provided === 'object' && !Array.isArray(provided);
+        options.pathAndValueMap = provided === undefined ? { '': 1 } : isPathMap ? provided : { '': provided };
+
+        // key size cannot be larger than MAX_KEY_SIZE
+        if ( options.key.length > this.MAX_KEY_SIZE ) {
+            throw ({ message: `Key size cannot be larger than ${this.MAX_KEY_SIZE}`, code: 'key_too_large' });
+        }
+
+        return utils.make_driver_method(['key'], 'puter-kvstore', undefined, 'add').call(this, options);
+    };
+
+    update = utils.make_driver_method(['key', 'pathAndValueMap', 'ttl'], 'puter-kvstore', undefined, 'update', {
+        preprocess: (args) => {
+            if ( args.key === undefined || args.key === null ) {
+                throw { message: 'Key cannot be undefined', code: 'key_undefined' };
+            }
+            if ( args.key.length > this.MAX_KEY_SIZE ) {
+                throw { message: `Key size cannot be larger than ${this.MAX_KEY_SIZE}`, code: 'key_too_large' };
+            }
+            if ( args.pathAndValueMap === undefined || args.pathAndValueMap === null || Array.isArray(args.pathAndValueMap) || typeof args.pathAndValueMap !== 'object' ) {
+                throw { message: 'pathAndValueMap must be an object', code: 'path_map_invalid' };
+            }
+            if ( Object.keys(args.pathAndValueMap).length === 0 ) {
+                throw { message: 'pathAndValueMap cannot be empty', code: 'path_map_invalid' };
+            }
+            if ( args.ttl !== undefined && args.ttl !== null ) {
+                const ttl = Number(args.ttl);
+                if ( Number.isNaN(ttl) ) {
+                    throw { message: 'ttl must be a number', code: 'ttl_invalid' };
+                }
+                args.ttl = ttl;
+            }
+            return args;
+        },
+    });
+
     /**
      * Set a time to live (in seconds) on a key. After the time to live has expired, the key will be deleted.
      * Prefer this over expireAt if you want timestamp to be set by the server, to avoid issues with clock drift.

package/src/modules/PuterDialog.js

@@ -434,7 +434,7 @@ class PuterDialog extends (globalThis.HTMLElement || Object) { // It will fall b
         // Add event listener to the button
         this.shadowRoot.querySelector('#launch-auth-popup')?.addEventListener('click', () => {
             let w = 600;
-            let h = 400;
+            let h = 600;
             let title = 'Puter';
             var left = (screen.width / 2) - (w / 2);
             var top = (screen.height / 2) - (h / 2);
@@ -454,7 +454,7 @@ class PuterDialog extends (globalThis.HTMLElement || Object) { // It will fall b
     open () {
         if ( this.hasUserActivation() ) {
             let w = 600;
-            let h = 400;
+            let h = 600;
             let title = 'Puter';
             var left = (screen.width / 2) - (w / 2);
             var top = (screen.height / 2) - (h / 2);

package/src/modules/UsageLimitDialog.js

@@ -0,0 +1,208 @@
+class UsageLimitDialog extends (globalThis.HTMLElement || Object) {
+    constructor (message) {
+        super();
+        this.message = message || 'You have reached your usage limit for this account.';
+        
+        this.attachShadow({ mode: 'open' });
+        
+        this.shadowRoot.innerHTML = `
+        <style>
+            dialog {
+                background: transparent;
+                border: none;
+                box-shadow: none;
+                outline: none;
+                padding: 0;
+                max-width: 90vw;
+            }
+            
+            dialog::backdrop {
+                background: rgba(0, 0, 0, 0.5);
+            }
+            
+            .dialog-content {
+                border: 1px solid #e8e8e8;
+                border-radius: 12px;
+                padding: 32px;
+                background: white;
+                box-shadow: 0 8px 32px rgba(0, 0, 0, 0.15);
+                -webkit-font-smoothing: antialiased;
+                color: #333;
+                position: relative;
+                max-width: 420px;
+                font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
+            }
+            
+            .close-btn {
+                position: absolute;
+                right: 16px;
+                top: 12px;
+                font-size: 20px;
+                color: #999;
+                cursor: pointer;
+                width: 28px;
+                height: 28px;
+                display: flex;
+                align-items: center;
+                justify-content: center;
+                border-radius: 50%;
+                transition: background 0.2s, color 0.2s;
+            }
+            
+            .close-btn:hover {
+                background: #f0f0f0;
+                color: #333;
+            }
+            
+            .icon-container {
+                width: 64px;
+                height: 64px;
+                margin: 0 auto 20px;
+                background: linear-gradient(135deg, #fff3e0 0%, #ffe0b2 100%);
+                border-radius: 50%;
+                display: flex;
+                align-items: center;
+                justify-content: center;
+            }
+            
+            .icon-container svg {
+                width: 32px;
+                height: 32px;
+                color: #f57c00;
+            }
+            
+            h2 {
+                margin: 0 0 12px;
+                font-size: 20px;
+                font-weight: 600;
+                text-align: center;
+                color: #1a1a1a;
+            }
+            
+            .message {
+                text-align: center;
+                font-size: 14px;
+                line-height: 1.5;
+                color: #666;
+                margin-bottom: 24px;
+            }
+            
+            .buttons {
+                display: flex;
+                gap: 12px;
+                justify-content: center;
+            }
+            
+            .button {
+                padding: 10px 24px;
+                border-radius: 8px;
+                font-size: 14px;
+                font-weight: 500;
+                cursor: pointer;
+                transition: all 0.2s;
+                border: none;
+                font-family: inherit;
+            }
+            
+            .button-secondary {
+                background: #f5f5f5;
+                color: #666;
+            }
+            
+            .button-secondary:hover {
+                background: #e8e8e8;
+            }
+            
+            .button-primary {
+                background: linear-gradient(135deg, #3b82f6 0%, #2563eb 100%);
+                color: white;
+            }
+            
+            .button-primary:hover {
+                background: linear-gradient(135deg, #2563eb 0%, #1d4ed8 100%);
+                box-shadow: 0 4px 12px rgba(37, 99, 235, 0.3);
+            }
+        </style>
+        <dialog>
+            <div class="dialog-content">
+                <span class="close-btn">&#x2715;</span>
+                <div class="icon-container">
+                    <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor">
+                        <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z" />
+                    </svg>
+                </div>
+                <h2>Low Balance</h2>
+                <p class="message">${this.message}</p>
+                <div class="buttons">
+                    <button class="button button-secondary" id="close-btn">Close</button>
+                    <button class="button button-primary" id="upgrade-btn">Upgrade Now</button>
+                </div>
+            </div>
+        </dialog>
+        `;
+    }
+    
+    connectedCallback () {
+        const dialog = this.shadowRoot.querySelector('dialog');
+        
+        this.shadowRoot.querySelector('.close-btn').addEventListener('click', () => {
+            this.close();
+        });
+        
+        this.shadowRoot.querySelector('#close-btn').addEventListener('click', () => {
+            this.close();
+        });
+        
+        this.shadowRoot.querySelector('#upgrade-btn').addEventListener('click', () => {
+            window.open('https://puter.com/dashboard', '_blank');
+            this.close();
+        });
+        
+        // Close on backdrop click
+        dialog.addEventListener('click', (e) => {
+            if ( e.target === dialog ) {
+                this.close();
+            }
+        });
+    }
+    
+    open () {
+        this.shadowRoot.querySelector('dialog').showModal();
+    }
+    
+    close () {
+        this.shadowRoot.querySelector('dialog').close();
+        this.remove();
+    }
+}
+
+// Only define custom element in environments with DOM support
+if ( typeof globalThis.HTMLElement !== 'undefined' && globalThis.customElements ) {
+    if ( ! customElements.get('usage-limit-dialog') ) {
+        customElements.define('usage-limit-dialog', UsageLimitDialog);
+    }
+}
+
+/**
+ * Shows a usage limit dialog to the user
+ * @param {string} message - The message to display
+ */
+export function showUsageLimitDialog (message) {
+    // Only log in non-browser environments
+    if ( typeof globalThis.document === 'undefined' ) {
+        console.warn('[Puter]', message);
+        return;
+    }
+    
+    // Check if dialog is already shown to prevent duplicates
+    if ( document.querySelector('usage-limit-dialog') ) {
+        return;
+    }
+    
+    const dialog = new UsageLimitDialog(message);
+    document.body.appendChild(dialog);
+    dialog.open();
+}
+
+export default UsageLimitDialog;
+

package/types/modules/ai.d.ts

@@ -158,24 +158,14 @@ export interface Speech2SpeechOptions {
     file?: string | File | Blob;
     provider?: string;
     model?: string;
-    modelId?: string;
-    model_id?: string;
     voice?: string;
-    voiceId?: string;
-    voice_id?: string;
     output_format?: string;
-    outputFormat?: string;
     voice_settings?: Record<string, unknown>;
-    voiceSettings?: Record<string, unknown>;
     seed?: number;
     file_format?: string;
-    fileFormat?: string;
     remove_background_noise?: boolean;
-    removeBackgroundNoise?: boolean;
     optimize_streaming_latency?: number;
-    optimizeStreamingLatency?: number;
     enable_logging?: boolean;
-    enableLogging?: boolean;
     test_mode?: boolean;
 }
 

package/types/modules/apps.d.ts

@@ -1,6 +1,6 @@
-import type { PaginationOptions, RequestCallbacks } from '../shared.d.ts';
+import type { RequestCallbacks } from '../shared.d.ts';
 
-export interface AppRecord {
+export interface App {
     uid: string;
     name: string;
     index_url: string;
@@ -16,12 +16,25 @@ export interface AppRecord {
     user_count?: number;
 }
 
-export interface AppListOptions extends PaginationOptions {
+export interface CreateAppResult {
+    uid: string;
+    name: string;
+    title: string;
+    index_url: string;
+    subdomain: string;
+    owner: {
+        username: string;
+        uuid: string;
+    };
+    app_owner?: Record<string, unknown>;
+}
+
+export interface AppListOptions {
     stats_period?: string;
     icon_size?: null | 16 | 32 | 64 | 128 | 256 | 512;
 }
 
-export interface CreateAppOptions extends RequestCallbacks<AppRecord> {
+export interface CreateAppOptions {
     name: string;
     indexURL: string;
     title?: string;
@@ -34,7 +47,7 @@ export interface CreateAppOptions extends RequestCallbacks<AppRecord> {
     dedupeName?: boolean;
 }
 
-export interface UpdateAppAttributes extends RequestCallbacks<AppRecord> {
+export interface UpdateAppAttributes {
     name?: string;
     indexURL?: string;
     title?: string;
@@ -47,16 +60,12 @@ export interface UpdateAppAttributes extends RequestCallbacks<AppRecord> {
 }
 
 export class Apps {
-    constructor (context: { authToken?: string; APIOrigin: string; appID?: string });
-
-    setAuthToken (authToken: string): void;
-    setAPIOrigin (APIOrigin: string): void;
-
-    list (options?: AppListOptions): Promise<AppRecord[]>;
-    create (name: string, indexURL: string, title?: string): Promise<AppRecord>;
-    create (options: CreateAppOptions): Promise<AppRecord>;
-    update (name: string, attributes: UpdateAppAttributes): Promise<AppRecord>;
-    get (name: string, options?: AppListOptions): Promise<AppRecord>;
+    list (options?: AppListOptions): Promise<App[]>;
+    create (name: string, indexURL: string, title?: string): Promise<CreateAppResult>;
+    create (options: CreateAppOptions): Promise<CreateAppResult>;
+    update (name: string, attributes: UpdateAppAttributes): Promise<App>;
+    get (name: string, options?: AppListOptions): Promise<App>;
     delete (name: string): Promise<{ success?: boolean }>;
     getDeveloperProfile (options?: RequestCallbacks<Record<string, unknown>>): Promise<Record<string, unknown>>;
+    getDeveloperProfile (success: (value: Record<string, unknown>) => void, error?: (reason: unknown) => void): Promise<Record<string, unknown>>;
 }

package/types/modules/auth.d.ts

@@ -1,3 +1,5 @@
+import { RequestCallbacks } from "../shared";
+
 export interface User {
     uuid: string;
     username: string;
@@ -55,7 +57,7 @@ export class Auth {
     signIn (options?: { attempt_temp_user_creation?: boolean }): Promise<SignInResult>;
     signOut (): void;
     isSignedIn (): boolean;
-    getUser (): Promise<User>;
+    getUser (options:? RequestCallbacks<User>): Promise<User>;
     whoami (): Promise<User>;
     getMonthlyUsage (): Promise<MonthlyUsage>;
     getDetailedAppUsage (appId: string): Promise<DetailedAppUsage>;

package/types/modules/filesystem.d.ts

@@ -43,7 +43,6 @@ export interface DeleteOptions extends RequestCallbacks<void> {
     paths?: string | string[];
     recursive?: boolean;
     descendantsOnly?: boolean;
-    descendants_only?: boolean;
 }
 
 export interface ReadOptions extends RequestCallbacks<Blob> {
@@ -100,7 +99,6 @@ export interface WriteOptions extends RequestCallbacks<FSItem> {
     dedupeName?: boolean;
     createMissingParents?: boolean;
     createMissingAncestors?: boolean;
-    name?: string;
     init?: (operationId: string, xhr: XMLHttpRequest) => void;
     start?: () => void;
     progress?: (operationId: string, progress: number) => void;

package/types/modules/kv.d.ts

@@ -10,6 +10,14 @@ export interface KVIncrementPath {
     [path: string]: number;
 }
 
+export interface KVUpdatePath {
+    [path: string]: KVValue;
+}
+
+export interface KVAddPath {
+    [path: string]: KVValue | KVValue[];
+}
+
 export class KV {
     readonly MAX_KEY_SIZE: number;
     readonly MAX_VALUE_SIZE: number;
@@ -19,6 +27,8 @@ export class KV {
     del (key: string): Promise<boolean>;
     incr (key: string, amount?: number | KVIncrementPath): Promise<number>;
     decr (key: string, amount?: number | KVIncrementPath): Promise<number>;
+    add (key: string, value?: KVValue | KVAddPath): Promise<KVValue>;
+    update (key: string, pathAndValueMap: KVUpdatePath, ttlSeconds?: number): Promise<KVValue>;
     expire (key: string, ttlSeconds: number): Promise<boolean>;
     expireAt (key: string, timestampSeconds: number): Promise<boolean>;
     list (pattern?: string, returnValues?: false): Promise<string[]>;

package/types/modules/networking.d.ts

@@ -14,7 +14,7 @@ export class PSocket {
     close (): void;
     on (event: 'open', handler: () => void): void;
     on (event: 'data', handler: (buffer: Uint8Array) => void): void;
-    on (event: 'error', handler: (reason: unknown) => void): void;
+    on (event: 'error', handler: (reason: string) => void): void;
     on (event: 'close', handler: (hadError: boolean) => void): void;
     addListener (event: SocketEvent, handler: (...args: unknown[]) => void): void;
 }

package/types/modules/os.d.ts

@@ -1,12 +1,7 @@
 import type { RequestCallbacks } from '../shared.d.ts';
-import type { AuthUser } from './auth.d.ts';
+import type { User } from './auth.d.ts';
 
 export class OS {
-    constructor (context: { authToken?: string; APIOrigin: string; appID?: string });
-
-    setAuthToken (authToken: string): void;
-    setAPIOrigin (APIOrigin: string): void;
-
-    user (options?: RequestCallbacks<AuthUser> & { query?: Record<string, string> }): Promise<AuthUser>;
+    user (options?: RequestCallbacks<User> & { query?: Record<string, string> }): Promise<User>;
     version (options?: RequestCallbacks<Record<string, unknown>>): Promise<Record<string, unknown>>;
 }