@heyputer/puter.js 1.0.1 → 2.0.1

package/src/modules/FSItem.js

@@ -1,139 +0,0 @@
-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.
-        const internalProperties = {};
-        Object.defineProperty(this, '_internalProperties', {
-            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 ?? (() => {
-            const url = new URL(this.writeURL ?? this.readURL);
-            return url.searchParams.get('signature');
-        })();
-        internalProperties.expires = options.expires ?? (() => {
-            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.
-        Object.defineProperty(internalProperties, 'file_signature', {
-            get: () => ({
-                read_url: this.readURL,
-                write_url: this.writeURL,
-                metadata_url: this.metadataURL,
-                fsentry_accessed: this.accessed,
-                fsentry_modified: this.modified,
-                fsentry_created: this.created,
-                fsentry_is_dir: this.isDirectory,
-                fsentry_size: this.size,
-                fsentry_name: this.name,
-                path: this.path,
-                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,
-            },
-        );
-    }
-
-    // Watches for changes to the item, and calls the callback function
-    // with the new data when a change is detected.
-    watch = function(callback){
-        // todo - implement
-    }
-
-    open = function(callback){
-        // todo - implement
-    }
-
-    // Set wallpaper
-    setAsWallpaper = function(options, callback){
-        // todo - implement
-    }
-
-    rename = function(new_name){
-        return puter.fs.rename(this.uid, 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){
-        return puter.fs.copy(this.path, destination_directory, auto_rename, overwrite);
-    }
-
-    delete = function(){
-        return puter.fs.delete(this.path);
-    }
-
-    versions = async function(){
-        // todo - implement
-    }
-
-    trash = function(){
-        // todo make sure puter allows for moving to trash by default
-        // todo implement trashing
-    }
-
-    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');    
-        
-        // mkdir
-        return puter.fs.mkdir(path.join(this.path, name));
-    }
-
-    metadata = async function(){
-        // todo - implement
-    }
-
-    readdir = async function(){
-        // Don't proceed if this is not a directory, throw error
-        if(!this.isDirectory)
-            throw new Error('readdir() can only be called on a directory');
-
-        // readdir
-        return puter.fs.readdir(this.path);
-    }
-
-    read = async function(){
-        return puter.fs.read(this.path);
-    }
-}
-
-export default FSItem;

package/src/modules/FileSystem/index.js

@@ -1,187 +0,0 @@
-import io from '../../lib/socket.io/socket.io.esm.min.js';
-
-// Operations
-import space from "./operations/space.js";
-import mkdir from "./operations/mkdir.js";
-import copy from "./operations/copy.js";
-import rename from "./operations/rename.js";
-import upload from "./operations/upload.js";
-import read from "./operations/read.js";
-import move from "./operations/move.js";
-import write from "./operations/write.js";
-import sign from "./operations/sign.js";
-import symlink from './operations/symlink.js';
-import readdir from './operations/readdir.js';
-import stat from './operations/stat.js';
-// Why is this called deleteFSEntry instead of just delete? because delete is 
-// a reserved keyword in javascript
-import deleteFSEntry from "./operations/deleteFSEntry.js";
-import { AdvancedBase } from '../../../../putility/index.js';
-import FSItem from '../FSItem.js';
-import getReadURL from './operations/getReadUrl.js';
-
-export class PuterJSFileSystemModule extends AdvancedBase {
-
-    space = space;
-    mkdir = mkdir;
-    copy = copy;
-    rename = rename;
-    upload = upload;
-    read = read;
-    // Why is this called deleteFSEntry instead of just delete? because delete is
-    // a reserved keyword in javascript.
-    delete = deleteFSEntry;
-    move = move;
-    write = write;
-    sign = sign;
-    symlink = symlink;
-    getReadURL = getReadURL;
-    readdir = readdir;
-    stat = stat;
-
-    FSItem = FSItem
-
-    static NARI_METHODS = {
-        // stat: {
-        //     positional: ['path'],
-        //     firstarg_options: true,
-        //     async fn (parameters) {
-        //         const svc_fs = await this.context.services.aget('filesystem');
-        //         return svc_fs.filesystem.stat(parameters);
-        //     }
-        // },
-    }
-
-    /**
-     * Creates a new instance with the given authentication token, API origin, and app ID,
-     * and connects to the socket.
-     *
-     * @class
-     * @param {string} authToken - Token used to authenticate the user.
-     * @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) {
-        super();
-        this.authToken = context.authToken;
-        this.APIOrigin = context.APIOrigin;
-        this.appID = context.appID;
-        this.context = context;
-        // Connect socket.
-        this.initializeSocket();
-
-        // We need to use `Object.defineProperty` instead of passing
-        // `authToken` and `APIOrigin` because they will change.
-        const api_info = {};
-        Object.defineProperty(api_info, 'authToken', {
-            get: () => this.authToken,
-        });
-        Object.defineProperty(api_info, 'APIOrigin', {
-            get: () => this.APIOrigin,
-        });
-    }
-
-
-    /**
-     * Initializes the socket connection to the server using the current API origin.
-     * If a socket connection already exists, it disconnects it before creating a new one.
-     * Sets up various event listeners on the socket to handle different socket events like
-     * connect, disconnect, reconnect, reconnect_attempt, reconnect_error, reconnect_failed, and error.
-     *
-     * @memberof FileSystem
-     * @returns {void}
-     */
-    initializeSocket() {
-        if (this.socket) {
-            this.socket.disconnect();
-        }
-
-        this.socket = io(this.APIOrigin, {
-            auth: {
-                auth_token: this.authToken,
-            }
-        });
-
-        this.bindSocketEvents();
-    }
-
-    bindSocketEvents() {
-        this.socket.on('item.added', (item) => {
-            // todo: NAIVE PURGE
-            puter._cache.flushall();
-        });
-        this.socket.on('item.renamed', (item) => {
-            // todo: NAIVE PURGE
-            puter._cache.flushall();
-        });
-        this.socket.on('item.moved', (item) => {
-            // todo: NAIVE PURGE
-            puter._cache.flushall();
-        }); 
-
-        this.socket.on('connect', () => {
-            if(puter.debugMode)
-                console.log('FileSystem Socket: Connected', this.socket.id);
-        });
-
-        this.socket.on('disconnect', () => {
-            if(puter.debugMode)
-                console.log('FileSystem Socket: Disconnected');
-
-            // todo: NAIVE PURGE
-            // purge cache on disconnect since we may have become out of sync
-            puter._cache.flushall();
-        });
-
-        this.socket.on('reconnect', (attempt) => {
-            if(puter.debugMode)
-                console.log('FileSystem Socket: Reconnected', this.socket.id);
-        });
-
-        this.socket.on('reconnect_attempt', (attempt) => {
-            if(puter.debugMode)
-                console.log('FileSystem Socket: Reconnection Attemps', attempt);
-        });
-
-        this.socket.on('reconnect_error', (error) => {
-            if(puter.debugMode)
-                console.log('FileSystem Socket: Reconnection Error', error);
-        });
-
-        this.socket.on('reconnect_failed', () => {
-            if(puter.debugMode)
-                console.log('FileSystem Socket: Reconnection Failed');
-        });
-
-        this.socket.on('error', (error) => {
-            if(puter.debugMode)
-                console.error('FileSystem Socket Error:', error);
-        });
-    }
-
-    /**
-     * Sets a new authentication token and resets the socket connection with the updated token.
-     *
-     * @param {string} authToken - The new authentication token.
-     * @memberof [FileSystem]
-     * @returns {void}
-     */
-    setAuthToken (authToken) {
-        this.authToken = authToken;
-        // reset socket
-        this.initializeSocket();
-    }
-
-    /**
-     * Sets the API origin and resets the socket connection with the updated API origin.
-     * 
-     * @param {string} APIOrigin - The new API origin.
-     * @memberof [Apps]
-     * @returns {void}
-     */
-    setAPIOrigin (APIOrigin) {
-        this.APIOrigin = APIOrigin;
-        // reset socket
-        this.initializeSocket();
-    }
-}

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

@@ -1,64 +0,0 @@
-import * as utils from '../../../lib/utils.js';
-import getAbsolutePathForApp from '../utils/getAbsolutePathForApp.js';
-
-const copy = function (...args) {
-    let options;
-
-    // If first argument is an object, it's the options
-    if (typeof args[0] === 'object' && args[0] !== null) {
-        options = args[0];
-    } else {
-        // Otherwise, we assume separate arguments are provided
-        options = {
-            source: args[0],
-            destination: args[1],
-            overwrite: args[2]?.overwrite,
-            new_name: args[2]?.newName || args[2]?.new_name,
-            create_missing_parents: args[2]?.createMissingParents || args[2]?.create_missing_parents,
-            new_metadata: args[2]?.newMetadata || args[2]?.new_metadata,
-            original_client_socket_id: args[2]?.excludeSocketID || args[2]?.original_client_socket_id,
-            success: args[3],
-            error: args[4],
-            // Add more if needed...
-        };
-    }
-
-    return new Promise(async (resolve, reject) => {
-        // 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{
-                await puter.ui.authenticateWithPuter();
-            }catch(e){
-                // if authentication fails, throw an error
-                reject('Authentication failed.');
-            }
-        }
-
-        // convert paths to absolute path
-        options.source = getAbsolutePathForApp(options.source);
-        options.destination = getAbsolutePathForApp(options.destination);
-
-        // create xhr object
-        const xhr = utils.initXhr('/copy', this.APIOrigin, this.authToken);
-
-        // set up event handlers for load and error events
-        utils.setupXhrEventHandlers(xhr, options.success, options.error, resolve, reject);
-
-        xhr.send(JSON.stringify({
-            original_client_socket_id: this.socket.id,
-            socket_id: this.socket.id,
-            source: options.source,
-            destination: options.destination,
-            overwrite: options.overwrite,
-            new_name: (options.new_name || options.newName),
-            // 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),
-        }));
-
-        // todo: EXTREMELY NAIVE CACHE PURGE
-        puter._cache.flushall();
-    })
-}
-
-export default copy;

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

@@ -1,59 +0,0 @@
-import * as utils from '../../../lib/utils.js';
-import getAbsolutePathForApp from '../utils/getAbsolutePathForApp.js';
-
-// why is this called deleteFSEntry instead of just delete? 
-// because delete is a reserved keyword in javascript
-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) {
-        options = args[0];
-    } 
-    // Otherwise, we assume separate arguments are provided
-    else {
-        options = {
-            paths: args[0],
-            recursive: args[1]?.recursive ?? true,
-            descendantsOnly: args[1]?.descendantsOnly ?? false,
-        };
-    }
-
-    // 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')
-        paths = [paths];
-
-    return new Promise(async (resolve, reject) => {
-        // 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{
-                await puter.ui.authenticateWithPuter();
-            }catch(e){
-                // if authentication fails, throw an error
-                reject('Authentication failed.');
-            }
-        }
-
-        // create xhr object
-        const xhr = utils.initXhr('/delete', this.APIOrigin, this.authToken);
-
-        // set up event handlers for load and error events
-        utils.setupXhrEventHandlers(xhr, options.success, options.error, resolve, reject);
-
-        // 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,42 +0,0 @@
-import * as utils from '../../../lib/utils.js';
-import stat from "./stat.js";
-
-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, 
-        // try to authenticate with Puter
-        if (!puter.authToken && puter.env === 'web') {
-            try {
-                await puter.ui.authenticateWithPuter();
-            } catch (e) {
-                // if authentication fails, throw an error
-                reject('Authentication failed.');
-            }
-        }
-        try {
-            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)}`)
-            }, reject);
-
-            xhr.send(JSON.stringify({
-                expiresIn,
-                permissions: [
-                    `fs:${uid}:read`,
-                ]
-            }))
-
-        } catch (e) {
-            reject(e)
-        }
-    });
-}
-
-export default getReadURL;

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

@@ -1,62 +0,0 @@
-import * as utils from '../../../lib/utils.js';
-import getAbsolutePathForApp from '../utils/getAbsolutePathForApp.js';
-import path from "../../../lib/path.js"
-
-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 it's a string followed by an object, it means path then options
-        if (typeof args[0] === 'string') {
-            options.path = args[0];
-            // Merge the options
-            Object.assign(options, args[1]);
-            options.success = args[2];
-            options.error = args[3];
-        } else {
-            options = args[0];
-        }
-    } 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];
-        options.error = args[2];
-    }
-
-    return new Promise(async (resolve, reject) => {
-        // 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{
-                await puter.ui.authenticateWithPuter();
-            }catch(e){
-                // if authentication fails, throw an error
-                reject('Authentication failed.');
-            }
-        }
-
-        // create xhr object
-        const xhr = utils.initXhr('/mkdir', this.APIOrigin, this.authToken);
-
-        // set up event handlers for load and error events
-        utils.setupXhrEventHandlers(xhr, options.success, options.error, resolve, reject);
-
-        options.path = getAbsolutePathForApp(options.path);
-
-        xhr.send(JSON.stringify({
-            parent: path.dirname(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,
-        }));
-
-        // todo: EXTREMELY NAIVE CACHE PURGE
-        puter._cache.flushall();
-    })
-}
-
-export default mkdir;

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

@@ -1,75 +0,0 @@
-import * as utils from '../../../lib/utils.js';
-import getAbsolutePathForApp from '../utils/getAbsolutePathForApp.js';
-import stat from "./stat.js"
-import path from "../../../lib/path.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) {
-        options = args[0];
-    } else {
-        // Otherwise, we assume separate arguments are provided
-        options = {
-            source: args[0],
-            destination: args[1],
-            overwrite: args[2]?.overwrite,
-            new_name: args[2]?.newName || args[2]?.new_name,
-            create_missing_parents: args[2]?.createMissingParents || args[2]?.create_missing_parents,
-            new_metadata: args[2]?.newMetadata || args[2]?.new_metadata,
-            original_client_socket_id: args[2]?.excludeSocketID || args[2]?.original_client_socket_id,
-        };
-    }
-
-    return new Promise(async (resolve, reject) => {
-        // 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{
-                await puter.ui.authenticateWithPuter();
-            }catch(e){
-                // if authentication fails, throw an error
-                reject('Authentication failed.');
-            }
-        }
-
-        // convert source and destination to absolute path
-        options.source = getAbsolutePathForApp(options.source);
-        options.destination = getAbsolutePathForApp(options.destination);
-
-        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
-                }
-            } catch (e) {
-                options.new_name = path.basename(options.destination);
-                options.destination = path.dirname(options.destination);
-            }
-        }
-
-        // create xhr object
-        const xhr = utils.initXhr('/move', this.APIOrigin, this.authToken);
-
-        // set up event handlers for load and error events
-        utils.setupXhrEventHandlers(xhr, options.success, options.error, resolve, reject);
-
-        xhr.send(JSON.stringify({
-            source: options.source,
-            destination: options.destination,
-            overwrite: options.overwrite,
-            new_name: (options.new_name || options.newName),
-            create_missing_parents: (options.create_missing_parents || options.createMissingParents),
-            new_metadata: (options.new_metadata || options.newMetadata),
-            original_client_socket_id: options.excludeSocketID,
-        }));
-
-        // todo: EXTREMELY NAIVE CACHE PURGE
-        puter._cache.flushall();
-
-    })
-}
-
-export default move;

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

@@ -1,46 +0,0 @@
-import * as utils from '../../../lib/utils.js';
-import getAbsolutePathForApp from '../utils/getAbsolutePathForApp.js';
-
-const read = function (...args) {
-    let options;
-
-    // If first argument is an object, it's the options
-    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]: {
-                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, 
-        // try to authenticate with Puter
-        if(!puter.authToken && puter.env === 'web'){
-            try{
-                await puter.ui.authenticateWithPuter();
-            }catch(e){
-                // if authentication fails, throw an error
-                reject('Authentication failed.');
-            }
-        }
-
-        // convert path to absolute path
-        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');
-
-        // set up event handlers for load and error events
-        utils.setupXhrEventHandlers(xhr, options.success, options.error, resolve, reject);
-
-        xhr.send();
-    })
-}
-
-export default read;