@heyputer/puter.js 2.1.4 → 2.1.7

package/src/modules/FSItem.js

@@ -1,21 +1,21 @@
-import path from "../lib/path.js"
-
-class FSItem{
-    constructor(options){
-        this.readURL        = options.readURL ?? options.read_url;
-        this.writeURL       = options.writeURL ?? options.write_url;
-        this.metadataURL    = options.metadataURL ?? options.metadata_url;
-        this.name           = options.name ?? options.fsentry_name;
-        this.uid            = options.uid ?? options.uuid ?? options.fsentry_uid ?? options.fsentry_id ?? options.fsentry_uuid ?? options.id;
-        this.id             = this.uid;
-        this.uuid           = this.uid;
-        this.path           = options.path ?? options.fsentry_path;
-        this.size           = options.size ?? options.fsentry_size;
-        this.accessed       = options.accessed ?? options.fsentry_accessed;
-        this.modified       = options.modified ?? options.fsentry_modified;
-        this.created        = options.created ?? options.fsentry_created;
-        this.isDirectory    = (options.isDirectory || options.is_dir || options.fsentry_is_dir) ? true : false;
-        
+import path from '../lib/path.js';
+
+class FSItem {
+    constructor (options) {
+        this.readURL = options.readURL ?? options.read_url;
+        this.writeURL = options.writeURL ?? options.write_url;
+        this.metadataURL = options.metadataURL ?? options.metadata_url;
+        this.name = options.name ?? options.fsentry_name;
+        this.uid = options.uid ?? options.uuid ?? options.fsentry_uid ?? options.fsentry_id ?? options.fsentry_uuid ?? options.id;
+        this.id = this.uid;
+        this.uuid = this.uid;
+        this.path = options.path ?? options.fsentry_path;
+        this.size = options.size ?? options.fsentry_size;
+        this.accessed = options.accessed ?? options.fsentry_accessed;
+        this.modified = options.modified ?? options.fsentry_modified;
+        this.created = options.created ?? options.fsentry_created;
+        this.isDirectory = (options.isDirectory || options.is_dir || options.fsentry_is_dir) ? true : false;
+
         // We add some properties to '_internalProperties' to make it clear
         // that they are not meant to be accessed outside of puter.js;
         // this permits us to change or remove these properties in the future.
@@ -24,7 +24,7 @@ class FSItem{
             enumerable: false,
             value: internalProperties,
         });
-        
+
         // Currently 'signature' and 'expires' are not provided in 'options',
         // but they can be inferred by writeURL or readURL.
         internalProperties.signature = options.signature ?? (() => {
@@ -35,7 +35,7 @@ class FSItem{
             const url = new URL(this.writeURL ?? this.readURL);
             return url.searchParams.get('expires');
         })();
-        
+
         // This computed property gives us an object in the format output by
         // the `/sign` endpoint, which can be passed to `launch_app` to
         // allow apps to open a file in another app or another instance.
@@ -54,86 +54,88 @@ class FSItem{
                 uid: this.uid,
                 // /sign outputs another property called "type", but we don't
                 // have that information here, so it's omitted.
-            })
+            }),
         });
     }
-    
-    write = async function(data){
-        return puter.fs.write( 
-            this.path,
-            new File([data], this.name), 
-            {
-                overwrite: true,
-                dedupeName: false,
-            },
-        );
-    }
+
+    write = async function (data) {
+        return puter.fs.write(this.path,
+                        new File([data], this.name),
+                        {
+                            overwrite: true,
+                            dedupeName: false,
+                        });
+    };
 
     // Watches for changes to the item, and calls the callback function
     // with the new data when a change is detected.
-    watch = function(callback){
+    watch = function (callback) {
         // todo - implement
-    }
+    };
 
-    open = function(callback){
+    open = function (callback) {
         // todo - implement
-    }
+    };
 
     // Set wallpaper
-    setAsWallpaper = function(options, callback){
+    setAsWallpaper = function (options, callback) {
         // todo - implement
-    }
+    };
 
-    rename = function(new_name){
+    rename = function (new_name) {
         return puter.fs.rename(this.uid, new_name);
-    }
+    };
 
-    move = function(dest_path, overwrite=false, new_name){
+    move = function (dest_path, overwrite = false, new_name) {
         return puter.fs.move(this.path, dest_path, overwrite, new_name);
-    }
+    };
 
-    copy = function(destination_directory, auto_rename=false, overwrite=false){
+    copy = function (destination_directory, auto_rename = false, overwrite = false) {
         return puter.fs.copy(this.path, destination_directory, auto_rename, overwrite);
-    }
+    };
 
-    delete = function(){
+    delete = function () {
         return puter.fs.delete(this.path);
-    }
+    };
 
-    versions = async function(){
+    versions = async function () {
         // todo - implement
-    }
+    };
 
-    trash = function(){
+    trash = function () {
         // todo make sure puter allows for moving to trash by default
         // todo implement trashing
-    }
+    };
 
-    mkdir = async function(name, auto_rename = false){
+    mkdir = async function (name, auto_rename = false) {
         // Don't proceed if this is not a directory, throw error
-        if(!this.isDirectory)
-            throw new Error('mkdir() can only be called on a directory');    
-        
+        if ( ! this.isDirectory )
+        {
+            throw new Error('mkdir() can only be called on a directory');
+        }
+
         // mkdir
         return puter.fs.mkdir(path.join(this.path, name));
-    }
+    };
 
-    metadata = async function(){
+    metadata = async function () {
         // todo - implement
-    }
+    };
 
-    readdir = async function(){
+    readdir = async function () {
         // Don't proceed if this is not a directory, throw error
-        if(!this.isDirectory)
+        if ( ! this.isDirectory )
+        {
             throw new Error('readdir() can only be called on a directory');
+        }
 
         // readdir
         return puter.fs.readdir(this.path);
-    }
+    };
 
-    read = async function(){
+    read = async function () {
         return puter.fs.read(this.path);
-    }
+    };
 }
 
 export default FSItem;

package/src/modules/FileSystem/index.js

@@ -3,7 +3,7 @@ import * as utils from '../../lib/utils.js';
 import path from '../../lib/path.js';
 
 // Constants
-// 
+//
 // The last valid time of the local cache.
 const LAST_VALID_TS = 'last_valid_ts';
 
@@ -27,7 +27,6 @@ import FSItem from '../FSItem.js';
 import deleteFSEntry from './operations/deleteFSEntry.js';
 import getReadURL from './operations/getReadUrl.js';
 
-
 export class PuterJSFileSystemModule extends AdvancedBase {
 
     space = space;
@@ -69,7 +68,7 @@ export class PuterJSFileSystemModule extends AdvancedBase {
      * @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) {
         super();
         this.authToken = context.authToken;
         this.APIOrigin = context.APIOrigin;
@@ -99,7 +98,7 @@ export class PuterJSFileSystemModule extends AdvancedBase {
      * @memberof FileSystem
      * @returns {void}
      */
-    initializeSocket() {
+    initializeSocket () {
         if ( this.socket ) {
             this.socket.disconnect();
         }
@@ -114,7 +113,7 @@ export class PuterJSFileSystemModule extends AdvancedBase {
         this.bindSocketEvents();
     }
 
-    bindSocketEvents() {
+    bindSocketEvents () {
         // this.socket.on('cache.updated', (msg) => {
         //     // check original_client_socket_id and if it matches this.socket.id, don't post update
         //     if (msg.original_client_socket_id !== this.socket.id) {
@@ -135,11 +134,11 @@ export class PuterJSFileSystemModule extends AdvancedBase {
 
         this.socket.on('item.added', (item) => {
             // remove readdir cache for parent
-            puter._cache.del('readdir:' + path.dirname(item.path));
-            console.log('deleted cache for readdir:' + path.dirname(item.path));
+            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));
+            puter._cache.del(`item:${ path.dirname(item.path)}`);
+            console.log(`deleted cache for item:${ path.dirname(item.path)}`);
         });
 
         this.socket.on('item.updated', (item) => {
@@ -209,11 +208,11 @@ export class PuterJSFileSystemModule extends AdvancedBase {
      * @memberof [FileSystem]
      * @returns {void}
      */
-    setAuthToken(authToken) {
+    setAuthToken (authToken) {
         this.authToken = authToken;
 
         // Check cache timestamp and purge if needed (only in GUI environment)
-        if (this.context.env === 'gui') {
+        if ( this.context.env === 'gui' ) {
             this.checkCacheAndPurge();
             // Start background task to update LAST_VALID_TS every 1 second
             this.startCacheUpdateTimer();
@@ -230,7 +229,7 @@ export class PuterJSFileSystemModule extends AdvancedBase {
      * @memberof [Apps]
      * @returns {void}
      */
-    setAPIOrigin(APIOrigin) {
+    setAPIOrigin (APIOrigin) {
         this.APIOrigin = APIOrigin;
         // reset socket
         this.initializeSocket();
@@ -242,7 +241,7 @@ export class PuterJSFileSystemModule extends AdvancedBase {
      * @memberof PuterJSFileSystemModule
      * @returns {void}
      */
-    invalidateCache() {
+    invalidateCache () {
         // Action: Update last valid time
         // Set to 0, which means the cache is not up to date.
         localStorage.setItem(LAST_VALID_TS, '0');
@@ -255,10 +254,10 @@ export class PuterJSFileSystemModule extends AdvancedBase {
      * @memberof PuterJSFileSystemModule
      * @returns {Promise<number>} The timestamp from the server
      */
-    async getCacheTimestamp() {
+    async getCacheTimestamp () {
         return new Promise((resolve, reject) => {
             const xhr = utils.initXhr('/cache/last-change-timestamp', this.APIOrigin, this.authToken, 'get', 'application/json');
-            
+
             // set up event handlers for load and error events
             utils.setupXhrEventHandlers(xhr, undefined, undefined, async (result) => {
                 try {
@@ -280,18 +279,18 @@ export class PuterJSFileSystemModule extends AdvancedBase {
      * @memberof PuterJSFileSystemModule
      * @returns {void}
      */
-    async checkCacheAndPurge() {
+    async checkCacheAndPurge () {
         try {
             const serverTimestamp = await this.getCacheTimestamp();
             const localValidTs = parseInt(localStorage.getItem(LAST_VALID_TS)) || 0;
-            
-            if (serverTimestamp - localValidTs > 2000) {
+
+            if ( serverTimestamp - localValidTs > 2000 ) {
                 console.log('Cache is not up to date, purging cache');
                 // Server has newer data, purge local cache
                 puter._cache.flushall();
                 localStorage.setItem(LAST_VALID_TS, '0');
             }
-        } catch (error) {
+        } catch ( error ) {
             // If we can't get the server timestamp, silently fail
             // This ensures the socket initialization doesn't break
             console.error('Error checking cache timestamp:', error);
@@ -305,8 +304,8 @@ export class PuterJSFileSystemModule extends AdvancedBase {
      * @memberof PuterJSFileSystemModule
      * @returns {void}
      */
-    startCacheUpdateTimer() {
-        if (this.context.env !== 'gui') {
+    startCacheUpdateTimer () {
+        if ( this.context.env !== 'gui' ) {
             return;
         }
 
@@ -325,8 +324,8 @@ export class PuterJSFileSystemModule extends AdvancedBase {
      * @memberof PuterJSFileSystemModule
      * @returns {void}
      */
-    stopCacheUpdateTimer() {
-        if (this.cacheUpdateTimer) {
+    stopCacheUpdateTimer () {
+        if ( this.cacheUpdateTimer ) {
             clearInterval(this.cacheUpdateTimer);
             this.cacheUpdateTimer = null;
         }

package/src/modules/FileSystem/operations/copy.js

@@ -5,7 +5,7 @@ const copy = 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
@@ -24,12 +24,12 @@ const copy = function (...args) {
     }
 
     return new Promise(async (resolve, reject) => {
-        // If auth token is not provided and we are in the web environment, 
+        // If auth token is not provided and we are in the web environment,
         // try to authenticate with Puter
-        if(!puter.authToken && puter.env === 'web'){
-            try{
+        if ( !puter.authToken && puter.env === 'web' ) {
+            try {
                 await puter.ui.authenticateWithPuter();
-            }catch(e){
+            } catch (e) {
                 // if authentication fails, throw an error
                 reject('Authentication failed.');
             }
@@ -55,7 +55,7 @@ const copy = function (...args) {
             // if user is copying an item to where its source is, change the name so there is no conflict
             dedupe_name: (options.dedupe_name || options.dedupeName),
         }));
-    })
-}
+    });
+};
 
 export default copy;

package/src/modules/FileSystem/operations/deleteFSEntry.js

@@ -1,15 +1,15 @@
 import * as utils from '../../../lib/utils.js';
 import getAbsolutePathForApp from '../utils/getAbsolutePathForApp.js';
 
-// why is this called deleteFSEntry instead of just delete? 
+// why is this called deleteFSEntry instead of just delete?
 // because delete is a reserved keyword in javascript
-const deleteFSEntry = async function(...args) {
+const deleteFSEntry = async 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];
-    } 
+    }
     // Otherwise, we assume separate arguments are provided
     else {
         options = {
@@ -22,16 +22,18 @@ const deleteFSEntry = async function(...args) {
     // If paths is a string, convert to array
     // this is to make it easier for the user to provide a single path without having to wrap it in an array
     let paths = options.paths;
-    if(typeof paths === 'string')
+    if ( typeof paths === 'string' )
+    {
         paths = [paths];
+    }
 
     return new Promise(async (resolve, reject) => {
-        // If auth token is not provided and we are in the web environment, 
+        // If auth token is not provided and we are in the web environment,
         // try to authenticate with Puter
-        if(!puter.authToken && puter.env === 'web'){
-            try{
+        if ( !puter.authToken && puter.env === 'web' ) {
+            try {
                 await puter.ui.authenticateWithPuter();
-            }catch(e){
+            } catch (e) {
                 // if authentication fails, throw an error
                 reject('Authentication failed.');
             }
@@ -46,14 +48,14 @@ const deleteFSEntry = async function(...args) {
         // convert paths to absolute paths
         paths = paths.map((path) => {
             return getAbsolutePathForApp(path);
-        })
+        });
 
         xhr.send(JSON.stringify({
             paths: paths,
             descendants_only: (options.descendants_only || options.descendantsOnly) ?? false,
             recursive: options.recursive ?? true,
         }));
-    })
-}
+    });
+};
 
 export default deleteFSEntry;

package/src/modules/FileSystem/operations/getReadUrl.js

@@ -1,11 +1,11 @@
 import * as utils from '../../../lib/utils.js';
-import stat from "./stat.js";
+import stat from './stat.js';
 
-const getReadURL = async function (path, expiresIn = "24h") {
+const getReadURL = async function (path, expiresIn = '24h') {
     return new Promise(async (resolve, reject) => {
-        // If auth token is not provided and we are in the web environment, 
+        // If auth token is not provided and we are in the web environment,
         // try to authenticate with Puter
-        if (!puter.authToken && puter.env === 'web') {
+        if ( !puter.authToken && puter.env === 'web' ) {
             try {
                 await puter.ui.authenticateWithPuter();
             } catch (e) {
@@ -14,29 +14,31 @@ const getReadURL = async function (path, expiresIn = "24h") {
             }
         }
         try {
-            const { uid, is_dir } = (await stat.call(this, path))
-            if (is_dir) {
-                reject("Cannot create readUrl for directory");
+            const { uid, is_dir } = (await stat.call(this, path));
+            if ( is_dir ) {
+                reject('Cannot create readUrl for directory');
                 return;
             }
 
             const xhr = utils.initXhr('/auth/create-access-token', this.APIOrigin, this.authToken);
-            
-            utils.setupXhrEventHandlers(xhr, () => {}, () => {}, ({token})=> {
-                resolve(`${this.APIOrigin}/token-read?uid=${encodeURIComponent(uid)}&token=${encodeURIComponent(token)}`)
+
+            utils.setupXhrEventHandlers(xhr, () => {
+            }, () => {
+            }, ({ token }) => {
+                resolve(`${this.APIOrigin}/token-read?uid=${encodeURIComponent(uid)}&token=${encodeURIComponent(token)}`);
             }, reject);
 
             xhr.send(JSON.stringify({
                 expiresIn,
                 permissions: [
                     `fs:${uid}:read`,
-                ]
-            }))
+                ],
+            }));
 
         } catch (e) {
-            reject(e)
+            reject(e);
         }
     });
-}
+};
 
 export default getReadURL;

package/src/modules/FileSystem/operations/mkdir.js

@@ -1,4 +1,4 @@
-import path from "../../../lib/path.js";
+import path from '../../../lib/path.js';
 import * as utils from '../../../lib/utils.js';
 import getAbsolutePathForApp from '../utils/getAbsolutePathForApp.js';
 
@@ -6,9 +6,9 @@ const mkdir = function (...args) {
     let options = {};
 
     // If first argument is a string and the second is an object, or if the first is an object
-    if ((typeof args[0] === 'string' && typeof args[1] === 'object' && !(args[1] instanceof Function)) || (typeof args[0] === 'object' && args[0] !== null)) {
+    if ( (typeof args[0] === 'string' && typeof args[1] === 'object' && !(args[1] instanceof Function)) || (typeof args[0] === 'object' && args[0] !== null) ) {
         // If it's a string followed by an object, it means path then options
-        if (typeof args[0] === 'string') {
+        if ( typeof args[0] === 'string' ) {
             options.path = args[0];
             // Merge the options
             Object.assign(options, args[1]);
@@ -17,7 +17,7 @@ const mkdir = function (...args) {
         } else {
             options = args[0];
         }
-    } else if (typeof args[0] === 'string') {
+    } else if ( typeof args[0] === 'string' ) {
         // it means it's a path then functions (success and optionally error)
         options.path = args[0];
         options.success = args[1];
@@ -25,12 +25,12 @@ const mkdir = function (...args) {
     }
 
     return new Promise(async (resolve, reject) => {
-        // If auth token is not provided and we are in the web environment, 
+        // If auth token is not provided and we are in the web environment,
         // try to authenticate with Puter
-        if(!puter.authToken && puter.env === 'web'){
-            try{
+        if ( !puter.authToken && puter.env === 'web' ) {
+            try {
                 await puter.ui.authenticateWithPuter();
-            }catch(e){
+            } catch (e) {
                 // if authentication fails, throw an error
                 reject('Authentication failed.');
             }
@@ -46,14 +46,14 @@ const mkdir = function (...args) {
 
         xhr.send(JSON.stringify({
             parent: path.dirname(options.path),
-            path:	path.basename(options.path), 
+            path:	path.basename(options.path),
             overwrite: options.overwrite ?? false,
             dedupe_name: (options.rename || options.dedupeName) ?? false,
             shortcut_to: options.shortcutTo,
             original_client_socket_id: this.socket.id,
             create_missing_parents: (options.recursive || options.createMissingParents) ?? false,
         }));
-    })
-}
+    });
+};
 
 export default mkdir;

package/src/modules/FileSystem/operations/move.js

@@ -1,12 +1,12 @@
-import path from "../../../lib/path.js";
+import path from '../../../lib/path.js';
 import * as utils from '../../../lib/utils.js';
 import getAbsolutePathForApp from '../utils/getAbsolutePathForApp.js';
-import stat from "./stat.js";
+import stat from './stat.js';
 
 const move = 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
@@ -22,12 +22,12 @@ const move = function (...args) {
     }
 
     return new Promise(async (resolve, reject) => {
-        // If auth token is not provided and we are in the web environment, 
+        // If auth token is not provided and we are in the web environment,
         // try to authenticate with Puter
-        if(!puter.authToken && puter.env === 'web'){
-            try{
+        if ( !puter.authToken && puter.env === 'web' ) {
+            try {
                 await puter.ui.authenticateWithPuter();
-            }catch(e){
+            } catch (e) {
                 // if authentication fails, throw an error
                 reject('Authentication failed.');
             }
@@ -37,12 +37,12 @@ const move = function (...args) {
         options.source = getAbsolutePathForApp(options.source);
         options.destination = getAbsolutePathForApp(options.destination);
 
-        if (!options.new_name) {
+        if ( ! options.new_name ) {
             // Handler to check if dest is supposed to be a file or a folder
             try {
                 const destStats = await stat.bind(this)(options.destination); // this is meant to error if it doesn't exist
-                if (!destStats.is_dir) {
-                    throw "is not directory" // just a wuick way to just to the catch
+                if ( ! destStats.is_dir ) {
+                    throw 'is not directory'; // just a wuick way to just to the catch
                 }
             } catch (e) {
                 options.new_name = path.basename(options.destination);
@@ -65,7 +65,7 @@ const move = function (...args) {
             new_metadata: (options.new_metadata || options.newMetadata),
             original_client_socket_id: options.excludeSocketID,
         }));
-    })
-}
+    });
+};
 
 export default move;

package/src/modules/FileSystem/operations/read.js

@@ -5,26 +5,26 @@ const read = 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
         options = {
             path: typeof args[0] === 'string' ? args[0] : (typeof args[0] === 'object' && args[0] !== null ? args[0].path : args[0]),
-            ...(typeof(args[1]) === "object" ? args[1]: {
+            ...(typeof (args[1]) === 'object' ? args[1] : {
                 success: args[1],
                 error: args[2],
-            })
+            }),
         };
     }
 
     return new Promise(async (resolve, reject) => {
-        // If auth token is not provided and we are in the web environment, 
+        // If auth token is not provided and we are in the web environment,
         // try to authenticate with Puter
-        if(!puter.authToken && puter.env === 'web'){
-            try{
+        if ( !puter.authToken && puter.env === 'web' ) {
+            try {
                 await puter.ui.authenticateWithPuter();
-            }catch(e){
+            } catch (e) {
                 // if authentication fails, throw an error
                 reject('Authentication failed.');
             }
@@ -34,13 +34,13 @@ const read = function (...args) {
         options.path = getAbsolutePathForApp(options.path);
 
         // create xhr object
-        const xhr = utils.initXhr('/read?' + new URLSearchParams({ file: options.path, ...(options.offset ? { offset: options.offset } : {}), ...(options.byte_count ? { byte_count: options.byte_count } : {}) }).toString(), this.APIOrigin, this.authToken, 'get', "application/json;charset=UTF-8", 'blob');
+        const xhr = utils.initXhr(`/read?${ new URLSearchParams({ file: options.path, ...(options.offset ? { offset: options.offset } : {}), ...(options.byte_count ? { byte_count: options.byte_count } : {}) }).toString()}`, this.APIOrigin, this.authToken, 'get', 'application/json;charset=UTF-8', 'blob');
 
         // set up event handlers for load and error events
         utils.setupXhrEventHandlers(xhr, options.success, options.error, resolve, reject);
 
         xhr.send();
-    })
-}
+    });
+};
 
 export default read;