@heyputer/puter.js 2.0.14 → 2.0.16

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@heyputer/puter.js",
-    "version": "2.0.14",
+    "version": "2.0.16",
     "description": "Puter.js - A JavaScript library for interacting with Puter services.",
     "main": "src/index.js",
     "types": "index.d.ts",
@@ -25,15 +25,17 @@
     ],
     "scripts": {
         "start-server": "npx http-server --cors -c-1",
-        "start-webpack": "webpack && webpack --output-filename puter.dev.js --watch --devtool source-map",
+        "start-webpack": "webpack --stats=errors-only && webpack --output-filename puter.dev.js --watch --devtool source-map --stats=errors-only",
         "start": "concurrently \"npm run start-server\" \"npm run start-webpack\"",
+        "test": "npx http-server --cors -c-1 -o /test",
         "build": "webpack && { echo \"// Copyright 2024-present Puter Technologies Inc. All rights reserved.\"; echo \"// Generated on $(date '+%Y-%m-%d %H:%M')\n\"; cat ./dist/puter.js; } > temp && mv temp ./dist/puter.js",
-        "prepublishOnly": "npm run build && mv dist/puter.js dist/puter.cjs && npm version patch && git add package.json && git commit -m \"chore: bump puter-js version and publish \" && git push"
+        "prepublishOnly": "npm run build && mv dist/puter.js dist/puter.cjs && npm version patch"
     },
     "author": "Puter Technologies Inc.",
     "license": "Apache-2.0",
     "devDependencies": {
         "concurrently": "^8.2.2",
+        "http-server": "^14.1.1",
         "webpack-cli": "^5.1.4"
     },
     "dependencies": {

package/src/index.js

@@ -131,6 +131,7 @@ const puterInit = (function() {
 
             // Initialize the cache using kv.js
             this._cache = new kvjs({dbName: 'puter_cache'});
+            this._opscache = new kvjs();
 
             // "modules" in puter.js are external interfaces for the developer
             this.modules_ = [];
@@ -493,10 +494,21 @@ const puterInit = (function() {
                     console.error('Error accessing localStorage:', error);
                 }
             }
+            // initialize loop for updating caches for major directories
+            if(this.env === 'gui'){
+                // check and update gui fs cache regularly
+                setInterval(puter.checkAndUpdateGUIFScache, 10000);
+            }
             // reinitialize submodules
             this.updateSubmodules();
+
             // rao
             this.request_rao_();
+
+            // perform whoami and cache results
+            this.getUser().then((user) => {
+                this.whoami = user;
+            });
         };
 
         setAPIOrigin = function(APIOrigin) {
@@ -666,7 +678,12 @@ const puterInit = (function() {
                 // If we went from online to offline, purge the cache
                 if ( wasOnline && !isOnline ) {
                     console.log('Network connection lost - purging cache');
-                    this.purgeCache();
+                    try {
+                        this._cache.flushall();
+                        console.log('Cache purged successfully');
+                    } catch( error ) {
+                        console.error('Error purging cache:', error);
+                    }
                 }
 
                 // Update the previous state
@@ -688,18 +705,73 @@ const puterInit = (function() {
         };
 
         /**
-         * Purges all cached data
-         * @public
+         * Checks and updates the GUI FS cache for most-commonly used paths
+         * @private
          */
-        purgeCache = function() {
-            try {
-                this._cache.flushall();
-                console.log('Cache purged successfully');
-            } catch( error ) {
-                console.error('Error purging cache:', error);
+        checkAndUpdateGUIFScache = function(){
+            // only run in gui environment
+            if(puter.env !== 'gui') return;
+            // only run if user is authenticated
+            if(!puter.whoami) return;
+
+            let username = puter.whoami.username;
+
+            // common paths
+            let home_path = `/${username}`;
+            let desktop_path = `/${username}/Desktop`;
+            let documents_path = `/${username}/Documents`;
+            let public_path = `/${username}/Public`;
+
+            // item:Home
+            if(!puter._cache.get('item:' + home_path)){
+                console.log(`/${username} item is not cached, refetching cache`);
+                // fetch home
+                puter.fs.stat(home_path);
+            }
+            // item:Desktop
+            if(!puter._cache.get('item:' + desktop_path)){
+                console.log(`/${username}/Desktop item is not cached, refetching cache`);
+                // fetch desktop
+                puter.fs.stat(desktop_path);
+            }
+            // item:Documents
+            if(!puter._cache.get('item:' + documents_path)){
+                console.log(`/${username}/Documents item is not cached, refetching cache`);
+                // fetch documents
+                puter.fs.stat(documents_path);
+            }
+            // item:Public
+            if(!puter._cache.get('item:' + public_path)){
+                console.log(`/${username}/Public item is not cached, refetching cache`);
+                // fetch public
+                puter.fs.stat(public_path);
+            }
+
+            // readdir:Home
+            if(!puter._cache.get('readdir:' + home_path)){
+                console.log(`/${username} is not cached, refetching cache`);
+                // fetch home
+                puter.fs.readdir(home_path);
+            }
+            // readdir:Desktop
+            if(!puter._cache.get('readdir:' + desktop_path)){
+                console.log(`/${username}/Desktop is not cached, refetching cache`);
+                // fetch desktop
+                puter.fs.readdir(desktop_path);
+            }
+            // readdir:Documents
+            if(!puter._cache.get('readdir:' + documents_path)){
+                console.log(`/${username}/Documents is not cached, refetching cache`);
+                // fetch documents
+                puter.fs.readdir(documents_path);
+            }
+            // readdir:Public
+            if(!puter._cache.get('readdir:' + public_path)){
+                console.log(`/${username}/Public is not cached, refetching cache`);
+                // fetch public
+                puter.fs.readdir(public_path);
             }
-        };
-
+        }
     }
 
     // Create a new Puter object and return it

package/src/init.cjs

@@ -19,7 +19,7 @@ const init = (authToken) => {
         }
     });
     goodContext.globalThis = goodContext;
-    const code = readFileSync(`${resolve(__filename, '..')}/../dist/puter.js`, 'utf8');
+    const code = readFileSync(`${resolve(__filename, '..')}/../dist/puter.cjs`, 'utf8');
     const context = vm.createContext(goodContext);
     vm.runInNewContext(code, context);
     if ( authToken ) {

package/src/modules/Auth.js

@@ -1,11 +1,10 @@
-import * as utils from '../lib/utils.js'
+import * as utils from '../lib/utils.js';
 
 class Auth{
     // Used to generate a unique message id for each message sent to the host environment
     // we start from 1 because 0 is falsy and we want to avoid that for the message id
     #messageID = 1;
 
-
     /**
      * Creates a new instance with the given authentication token, API origin, and app ID,
      *
@@ -14,7 +13,7 @@ class Auth{
      * @param {string} APIOrigin - Origin of the API server. Used to build the API endpoint URLs.
      * @param {string} appID - ID of the app to use.
      */
-    constructor (context) {
+    constructor(context) {
         this.authToken = context.authToken;
         this.APIOrigin = context.APIOrigin;
         this.appID = context.appID;
@@ -27,22 +26,22 @@ class Auth{
      * @memberof [Auth]
      * @returns {void}
      */
-    setAuthToken (authToken) {
+    setAuthToken(authToken) {
         this.authToken = authToken;
     }
 
     /**
      * Sets the API origin.
-     * 
+     *
      * @param {string} APIOrigin - The new API origin.
      * @memberof [Auth]
      * @returns {void}
      */
-    setAPIOrigin (APIOrigin) {
+    setAPIOrigin(APIOrigin) {
         this.APIOrigin = APIOrigin;
     }
-    
-    signIn = (options) =>{
+
+    signIn = (options) => {
         options = options || {};
 
         return new Promise((resolve, reject) => {
@@ -50,17 +49,17 @@ class Auth{
             let w = 600;
             let h = 600;
             let title = 'Puter';
-            var left = (screen.width/2)-(w/2);
-            var top = (screen.height/2)-(h/2);
-            
+            var left = (screen.width / 2) - (w / 2);
+            var top = (screen.height / 2) - (h / 2);
+
             // Store reference to the popup window
-            const popup = window.open(puter.defaultGUIOrigin + '/action/sign-in?embedded_in_popup=true&msg_id=' + msg_id + (window.crossOriginIsolated ? '&cross_origin_isolated=true' : '') +(options.attempt_temp_user_creation ? '&attempt_temp_user_creation=true' : ''), 
-            title, 
-            'toolbar=no, location=no, directories=no, status=no, menubar=no, scrollbars=no, resizable=no, copyhistory=no, width='+w+', height='+h+', top='+top+', left='+left);
+            const popup = window.open(`${puter.defaultGUIOrigin}/action/sign-in?embedded_in_popup=true&msg_id=${msg_id}${window.crossOriginIsolated ? '&cross_origin_isolated=true' : ''}${options.attempt_temp_user_creation ? '&attempt_temp_user_creation=true' : ''}`,
+                            title,
+                            `toolbar=no, location=no, directories=no, status=no, menubar=no, scrollbars=no, resizable=no, copyhistory=no, width=${w}, height=${h}, top=${top}, left=${left}`);
 
             // Set up interval to check if popup was closed
             const checkClosed = setInterval(() => {
-                if (popup.closed) {
+                if ( popup.closed ) {
                     clearInterval(checkClosed);
                     // Remove the message listener
                     window.removeEventListener('message', messageHandler);
@@ -69,21 +68,23 @@ class Auth{
             }, 100);
 
             function messageHandler(e) {
-                if(e.data.msg_id == msg_id){
+                if ( e.data.msg_id == msg_id ){
                     // Clear the interval since we got a response
                     clearInterval(checkClosed);
-                    
+
                     // remove redundant attributes
                     delete e.data.msg_id;
                     delete e.data.msg;
 
-                    if(e.data.success){
+                    if ( e.data.success ){
                         // set the auth token
                         puter.setAuthToken(e.data.token);
 
                         resolve(e.data);
-                    }else
+                    } else
+                    {
                         reject(e.data);
+                    }
 
                     // delete the listener
                     window.removeEventListener('message', messageHandler);
@@ -92,20 +93,24 @@ class Auth{
 
             window.addEventListener('message', messageHandler);
         });
-    }
+    };
 
-    isSignedIn = () =>{
-        if(puter.authToken)
+    isSignedIn = () => {
+        if ( puter.authToken )
+        {
             return true;
+        }
         else
+        {
             return false;
-    }
+        }
+    };
 
     getUser = function(...args){
         let options;
 
         // If first argument is an object, it's the options
-        if (typeof args[0] === 'object' && args[0] !== null) {
+        if ( typeof args[0] === 'object' && args[0] !== null ) {
             options = args[0];
         } else {
             // Otherwise, we assume separate arguments are provided
@@ -122,45 +127,125 @@ class Auth{
             utils.setupXhrEventHandlers(xhr, options.success, options.error, resolve, reject);
 
             xhr.send();
-        })
-    }
+        });
+    };
 
-    signOut = () =>{
+    signOut = () => {
         puter.resetAuthToken();
-    }
+    };
 
-    async whoami () {
+    async whoami() {
         try {
-            const resp = await fetch(this.APIOrigin + '/whoami', {
+            const resp = await fetch(`${this.APIOrigin}/whoami`, {
                 headers: {
-                    Authorization: `Bearer ${this.authToken}`
-                }
+                    Authorization: `Bearer ${this.authToken}`,
+                },
             });
-            
+
             const result = await resp.json();
-            
+
             // Log the response
-            if (globalThis.puter?.apiCallLogger?.isEnabled()) {
+            if ( globalThis.puter?.apiCallLogger?.isEnabled() ) {
                 globalThis.puter.apiCallLogger.logRequest({
                     service: 'auth',
                     operation: 'whoami',
                     params: {},
-                    result: result
+                    result: result,
                 });
             }
-            
+
             return result;
-        } catch (error) {
+        } catch( error ) {
             // Log the error
-            if (globalThis.puter?.apiCallLogger?.isEnabled()) {
+            if ( globalThis.puter?.apiCallLogger?.isEnabled() ) {
                 globalThis.puter.apiCallLogger.logRequest({
                     service: 'auth',
                     operation: 'whoami',
                     params: {},
                     error: {
                         message: error.message || error.toString(),
-                        stack: error.stack
-                    }
+                        stack: error.stack,
+                    },
+                });
+            }
+            throw error;
+        }
+    }
+
+    async getMonthlyUsage() {
+        try {
+            const resp = await fetch(`${this.APIOrigin}/metering/usage`, {
+                headers: {
+                    Authorization: `Bearer ${this.authToken}`,
+                },
+            });
+
+            const result = await resp.json();
+
+            // Log the response
+            if ( globalThis.puter?.apiCallLogger?.isEnabled() ) {
+                globalThis.puter.apiCallLogger.logRequest({
+                    service: 'auth',
+                    operation: 'usage',
+                    params: {},
+                    result: result,
+                });
+            }
+
+            return result;
+        } catch( error ) {
+            // Log the error
+            if ( globalThis.puter?.apiCallLogger?.isEnabled() ) {
+                globalThis.puter.apiCallLogger.logRequest({
+                    service: 'auth',
+                    operation: 'usage',
+                    params: {},
+                    error: {
+                        message: error.message || error.toString(),
+                        stack: error.stack,
+                    },
+                });
+            }
+            throw error;
+        }
+    }
+
+    async getDetailedAppUsage(appId) {
+        if ( !appId ) {
+            throw new Error('appId is required');
+        }
+
+        try {
+            const resp = await fetch(`${this.APIOrigin}/metering/usage/${appId}`, {
+                headers: {
+                    Authorization: `Bearer ${this.authToken}`,
+                },
+            });
+
+            const result = await resp.json();
+
+            // Log the response
+            if ( globalThis.puter?.apiCallLogger?.isEnabled() ) {
+                globalThis.puter.apiCallLogger.logRequest({
+                    service: 'auth',
+                    operation: 'detailed_app_usage',
+                    params: { appId },
+                    result: result,
+                });
+            }
+
+            return result;
+        } catch( error ) {
+            // Log the error
+            if ( globalThis.puter?.apiCallLogger?.isEnabled() ) {
+                globalThis.puter.apiCallLogger.logRequest({
+                    service: 'auth',
+                    operation: 'detailed_app_usage',
+                    params: { appId },
+                    error: {
+                        message: error.message || error.toString(),
+                        stack: error.stack,
+                    },
                 });
             }
             throw error;
@@ -168,4 +253,4 @@ class Auth{
     }
 }
 
-export default Auth
+export default Auth;

package/src/modules/FileSystem/index.js

@@ -123,62 +123,31 @@ export class PuterJSFileSystemModule extends AdvancedBase {
         // });
 
         this.socket.on('item.renamed', (item) => {
-            // delete old item from cache
-            puter._cache.del('item:' + item.old_path);
-            // if a directory
-            if(item.is_dir){
-                // delete readdir
-                puter._cache.del('readdir:' + item.old_path);
-                // descendants items
-                const descendants = puter._cache.keys('item:' + item.old_path + '/*');
-                for(const descendant of descendants){
-                    console.log('Deleting cache for:', descendant);
-                    puter._cache.del(descendant);
-                }
-                // descendants readdirs
-                const descendants_readdir = puter._cache.keys('readdir:' + item.old_path + '/*');
-                for(const descendant of descendants_readdir){
-                    console.log('Deleting cache for:', descendant);
-                    puter._cache.del(descendant);
-                }
-            }
-            // parent readdir
-            puter._cache.del('readdir:' + path.dirname(item.old_path));
+            puter._cache.flushall();
+            console.log('Flushed cache for item.renamed');
         });
 
         this.socket.on('item.removed', (item) => {
             // check original_client_socket_id and if it matches this.socket.id, don't invalidate cache
             puter._cache.flushall();
-            console.log('Flushed cache for item.deleted');
+            console.log('Flushed cache for item.removed');
         });
 
         this.socket.on('item.added', (item) => {
-            // delete item from cache
-            puter._cache.del('item:' + item.path);
-            // delete readdir from cache
-            puter._cache.del('readdir:' + item.path);
-            // delete descendant items from cache
-            const descendant_items = puter._cache.keys('item:' + item.path + '/*');
-            for(const descendant of descendant_items){
-                puter._cache.del(descendant);
-            }
-            // delete descendant readdirs from cache
-            const descendant_readdirs = puter._cache.keys('readdir:' + item.path + '/*');
-            for(const descendant of descendant_readdirs){
-                puter._cache.del(descendant);
-            }
-            // delete parent readdir from cache
+            // remove readdir cache for parent
             puter._cache.del('readdir:' + path.dirname(item.path));
+            console.log('deleted cache for readdir:' + path.dirname(item.path));
+            // remove item cache for parent directory
+            puter._cache.del('item:' + path.dirname(item.path));
+            console.log('deleted cache for item:' + path.dirname(item.path));
         });
 
         this.socket.on('item.updated', (item) => {
-            // check original_client_socket_id and if it matches this.socket.id, don't invalidate cache
             puter._cache.flushall();
             console.log('Flushed cache for item.updated');
         });
 
         this.socket.on('item.moved', (item) => {
-            // check original_client_socket_id and if it matches this.socket.id, don't invalidate cache
             puter._cache.flushall();
             console.log('Flushed cache for item.moved');
         });