@heyputer/puter.js 2.1.15 → 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.1.15",
+    "version": "2.2.4",
     "description": "Puter.js - A JavaScript library for interacting with Puter services.",
     "homepage": "https://developer.puter.com",
     "main": "src/index.js",
@@ -42,7 +42,6 @@
         "webpack-cli": "^5.1.4"
     },
     "dependencies": {
-        "@heyputer/kv.js": "^0.2.1",
-        "@heyputer/putility": "^1.1.1"
+        "@heyputer/kv.js": "^0.2.1"
     }
 }

package/src/index.js

@@ -1,5 +1,3 @@
-import putility from '@heyputer/putility';
-
 import kvjs from '@heyputer/kv.js';
 import APICallLogger from './lib/APICallLogger.js';
 import path from './lib/path.js';
@@ -20,16 +18,72 @@ 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';
-import { APIAccessService } from './services/APIAccess.js';
-import { FilesystemService } from './services/Filesystem.js';
-import { FSRelayService } from './services/FSRelay.js';
-import { NoPuterYetService } from './services/NoPuterYet.js';
-import { XDIncomingService } from './services/XDIncoming.js';
 
+class SimpleLogger {
+    constructor (fields = {}) {
+        this.fieldsObj = fields;
+        this.enabled = new Set();
+    }
+
+    on (category) {
+        this.enabled.add(category);
+    }
+
+    fields (extra = {}) {
+        return new SimpleLogger({ ...this.fieldsObj, ...extra });
+    }
+
+    info (...args) {
+        console.log(...this._prefix(), ...args);
+    }
+
+    warn (...args) {
+        console.warn(...this._prefix(), ...args);
+    }
+
+    error (...args) {
+        console.error(...this._prefix(), ...args);
+    }
+
+    debug (...args) {
+        console.debug(...this._prefix(), ...args);
+    }
+
+    _prefix () {
+        const entries = Object.entries(this.fieldsObj);
+        if ( !entries.length ) return [];
+        return [`[${ entries.map(([k, v]) => `${k}=${v}`).join(' ')}]`];
+    }
+}
+
+class Lock {
+    constructor () {
+        this.locked = false;
+        this.queue = [];
+    }
+
+    async acquire () {
+        if ( !this.locked ) {
+            this.locked = true;
+            return;
+        }
+
+        await new Promise(resolve => this.queue.push(resolve));
+        this.locked = true;
+    }
+
+    release () {
+        const next = this.queue.shift();
+        if ( next ) {
+            next();
+            return;
+        }
+        this.locked = false;
+    }
+}
 // TODO: This is for a safe-guard below; we should check if we can
 //       generalize this behavior rather than hard-coding it.
 //       (using defaultGUIOrigin breaks locally-hosted apps)
@@ -115,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);
@@ -135,15 +188,6 @@ const puterInit = (function () {
 
             // "modules" in puter.js are external interfaces for the developer
             this.modules_ = [];
-            // "services" in puter.js are used by modules and may interact with each other
-            const context = new putility.libs.context.Context()
-                .follow(this, ['env', 'util', 'authToken', 'APIOrigin', 'appID']);
-
-            context.puter = this;
-
-            this.services = new putility.system.ServiceManager({ context });
-            this.context = context;
-            context.services = this.services;
 
             // Holds the query parameters found in the current URL
             let URLParams = new URLSearchParams(globalThis.location?.search);
@@ -261,57 +305,15 @@ const puterInit = (function () {
 
             // === START :: Logger ===
 
-            // logger will log to console
-            let logger = new putility.libs.log.ConsoleLogger();
-
-            // logs can be toggled based on categories
-            logger = new putility.libs.log.CategorizedToggleLogger({ delegate: logger });
-            const cat_logger = logger;
-
-            // create facade for easy logging
-            this.logger = new putility.libs.log.LoggerFacade({
-                impl: logger,
-                cat: cat_logger,
-            });
+            // Basic logger replacement (console-based)
+            let logger = new SimpleLogger();
+            this.logger = logger;
 
             // Initialize API call logger
             this.apiCallLogger = new APICallLogger({
                 enabled: false, // Disabled by default
             });
 
-            // === START :: Services === //
-
-            this.services.register('no-puter-yet', NoPuterYetService);
-            this.services.register('filesystem', FilesystemService);
-            this.services.register('api-access', APIAccessService);
-            this.services.register('xd-incoming', XDIncomingService);
-            if ( this.env !== 'app' ) {
-                this.services.register('fs-relay', FSRelayService);
-            }
-
-            // When api-access is initialized, bind `.authToken` and
-            // `.APIOrigin` as a 1-1 mapping with the `puter` global
-            (async () => {
-                await this.services.wait_for_init(['api-access']);
-                const svc_apiAccess = this.services.get('api-access');
-
-                svc_apiAccess.auth_token = this.authToken;
-                svc_apiAccess.api_origin = this.APIOrigin;
-                [
-                    ['authToken', 'auth_token'],
-                    ['APIOrigin', 'api_origin'],
-                ].forEach(([k1, k2]) => {
-                    Object.defineProperty(this, k1, {
-                        get () {
-                            return svc_apiAccess[k2];
-                        },
-                        set (v) {
-                            svc_apiAccess[k2] = v;
-                        },
-                    });
-                });
-            })();
-
             // === Start :: Modules === //
 
             // The SDK is running in the Puter GUI (i.e. 'gui')
@@ -365,31 +367,27 @@ const puterInit = (function () {
 
             // Add prefix logger (needed to happen after modules are initialized)
             (async () => {
-                await this.services.wait_for_init(['api-access']);
-                const whoami = await this.auth.whoami();
-                logger = new putility.libs.log.PrefixLogger({
-                    delegate: logger,
-                    prefix: `[${
+                try {
+                    const whoami = await this.auth.whoami();
+                    const prefix = `[${
                         whoami?.app_name ?? this.appInstanceID ?? 'HOST'
-                    }] `,
-                });
-
-                this.logger.impl = logger;
+                    }]`;
+                    logger = logger.fields({ prefix });
+                    this.logger = logger;
+                } catch (error) {
+                    if ( this.debugMode ) {
+                        console.error('Failed to initialize prefix logger', error);
+                    }
+                }
             })();
 
             // Lock to prevent multiple requests to `/rao`
-            this.lock_rao_ = new putility.libs.promise.Lock();
+            this.lock_rao_ = new Lock();
             // Promise that resolves when it's okay to request `/rao`
-            this.p_can_request_rao_ = new putility.libs.promise.TeePromise();
+            this.p_can_request_rao_ = Promise.resolve();
             // Flag that indicates if a request to `/rao` has been made
             this.rao_requested_ = false;
 
-            // In case we're already auth'd, request `/rao`
-            (async () => {
-                await this.services.wait_for_init(['api-access']);
-                this.p_can_request_rao_.resolve();
-            })();
-
             this.net = {
                 generateWispV1URL: async () => {
                     const { token: wispToken, server: wispServer } = (await (await fetch(`${this.APIOrigin }/wisp/relay-token/create`, {
@@ -457,7 +455,7 @@ const puterInit = (function () {
         }
 
         registerModule (name, cls, parameters = {}) {
-            const instance = new cls(this.context, parameters);
+            const instance = new cls(this, parameters);
             instance.puter = this;
             this.modules_.push(name);
             this[name] = instance;
@@ -518,6 +516,25 @@ const puterInit = (function () {
             this.updateSubmodules();
         };
 
+        runWhenPuterHappensCallbacks = function () {
+            if ( this.env !== 'gui' ) return;
+            if ( ! globalThis.when_puter_happens ) return;
+
+            const callbacks = Array.isArray(globalThis.when_puter_happens)
+                ? globalThis.when_puter_happens
+                : [globalThis.when_puter_happens];
+
+            for ( const fn of callbacks ) {
+                try {
+                    fn({ puter: this });
+                } catch ( error ) {
+                    if ( this.debugMode ) {
+                        console.error('when_puter_happens callback failed', error);
+                    }
+                }
+            }
+        };
+
         resetAuthToken = function () {
             this.authToken = null;
             // If the SDK is running on a 3rd-party site or an app, then save the authToken in localStorage
@@ -785,6 +802,7 @@ const puterInit = (function () {
 export const puter =  puterInit();
 export default puter;
 globalThis.puter = puter;
+puter.runWhenPuterHappensCallbacks();
 
 puter.tools = [];
 /**
@@ -863,4 +881,4 @@ globalThis.addEventListener && globalThis.addEventListener('message', async (eve
             puter.puterAuthState.resolver = null;
         };
     }
-});
+});

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,
@@ -65,6 +66,16 @@ function uuidv4 () {
         (c ^ crypto.getRandomValues(new Uint8Array(1))[0] & 15 >> c / 4).toString(16));
 }
 
+const createDeferred = () => {
+    let resolve;
+    let reject;
+    const promise = new Promise((res, rej) => {
+        resolve = res;
+        reject = rej;
+    });
+    return { promise, resolve, reject };
+};
+
 /**
  * Initializes and returns an XMLHttpRequest object configured for a specific API endpoint, method, and headers.
  *
@@ -266,11 +277,11 @@ function make_driver_method (arg_defs, driverInterface, driverName, driverMethod
 }
 
 async function driverCall (options, driverInterface, driverName, driverMethod, driverArgs, settings) {
-    const tp = new TeePromise();
+    const deferred = createDeferred();
 
     driverCall_(options,
-                    tp.resolve.bind(tp),
-                    tp.reject.bind(tp),
+                    deferred.resolve,
+                    deferred.reject,
                     driverInterface,
                     driverName,
                     driverMethod,
@@ -279,7 +290,7 @@ async function driverCall (options, driverInterface, driverName, driverMethod, d
                     undefined,
                     settings);
 
-    return await tp;
+    return await deferred.promise;
 }
 
 // This function encapsulates the logic for sending a driver call request
@@ -368,14 +379,22 @@ async function driverCall_ (
             is_stream = true;
             const Stream = async function* Stream () {
                 while ( !response_complete ) {
-                    const tp = new TeePromise();
-                    signal_stream_update = tp.resolve.bind(tp);
-                    await tp;
+                    const signal = createDeferred();
+                    signal_stream_update = signal.resolve;
+                    await signal.promise;
                     if ( response_complete ) break;
                     while ( lines_received.length > 0 ) {
                         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,
@@ -452,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' ) {
@@ -543,58 +572,16 @@ async function driverCall_ (
         args: driverArgs,
         auth_token: puter.authToken,
     }));
-}
 
-class TeePromise {
-    static STATUS_PENDING = {};
-    static STATUS_RUNNING = {};
-    static STATUS_DONE = {};
-    constructor () {
-        this.status_ = this.constructor.STATUS_PENDING;
-        this.donePromise = new Promise((resolve, reject) => {
-            this.doneResolve = resolve;
-            this.doneReject = reject;
-        });
-    }
-    get status () {
-        return this.status_;
-    }
-    set status (status) {
-        this.status_ = status;
-        if ( status === this.constructor.STATUS_DONE ) {
-            this.doneResolve();
-        }
-    }
-    resolve (value) {
-        this.status_ = this.constructor.STATUS_DONE;
-        this.doneResolve(value);
-    }
-    awaitDone () {
-        return this.donePromise;
-    }
-    then (fn, rfn) {
-        return this.donePromise.then(fn, rfn);
-    }
-
-    reject (err) {
-        this.status_ = this.constructor.STATUS_DONE;
-        this.doneReject(err);
-    }
-
-    /**
-     * @deprecated use then() instead
-     */
-    onComplete (fn) {
-        return this.then(fn);
-    }
 }
 
 async function blob_to_url (blob) {
-    const tp = new TeePromise();
     const reader = new (globalThis.FileReader || FileReaderPoly)();
-    reader.onloadend = () => tp.resolve(reader.result);
-    reader.readAsDataURL(blob);
-    return await tp;
+    return await new Promise((resolve, reject) => {
+        reader.onloadend = () => resolve(reader.result);
+        reader.onerror = reject;
+        reader.readAsDataURL(blob);
+    });
 }
 
 function blobToDataUri (blob) {
@@ -625,5 +612,5 @@ function arrayBufferToDataUri (arrayBuffer) {
 }
 
 export {
-    arrayBufferToDataUri, blob_to_url, blobToDataUri, driverCall, handle_error, handle_resp, initXhr, make_driver_method, parseResponse, setupXhrEventHandlers, TeePromise, uuidv4
+    arrayBufferToDataUri, blob_to_url, blobToDataUri, driverCall, handle_error, handle_resp, initXhr, make_driver_method, parseResponse, setupXhrEventHandlers, uuidv4
 };