@heyputer/puter.js 2.1.15 → 2.2.2

package/src/modules/Debug.js

@@ -1,6 +1,6 @@
 export class Debug {
-    constructor (context, parameters) {
-        this.context = context;
+    constructor (puter, parameters) {
+        this.puter = puter;
         this.parameters = parameters;
 
         this._init();
@@ -14,7 +14,7 @@ export class Debug {
         enabled_logs = enabled_logs.split(';');
         for ( const category of enabled_logs ) {
             if ( category === '' ) continue;
-            this.context.puter.logger.on(category);
+            this.puter.logger.on(category);
         }
 
         globalThis.addEventListener('message', async e => {
@@ -32,7 +32,7 @@ export class Debug {
 
             if ( e.data.cmd === 'log.on' ) {
                 console.log('Got instruction to turn logs on!');
-                this.context.puter.logger.on(e.data.category);
+                this.puter.logger.on(e.data.category);
             }
         });
     }

package/src/modules/Drivers.js

@@ -1,6 +1,7 @@
 class FetchDriverCallBackend {
-    constructor ({ context }) {
-        this.context = context;
+    constructor ({ getAPIOrigin, getAuthToken }) {
+        this.getAPIOrigin = getAPIOrigin;
+        this.getAuthToken = getAuthToken;
         this.response_handlers = this.constructor.response_handlers;
     }
 
@@ -32,7 +33,7 @@ class FetchDriverCallBackend {
 
     async call ({ driver, method_name, parameters }) {
         try {
-            const resp = await fetch(`${this.context.APIOrigin}/drivers/call`, {
+            const resp = await fetch(`${this.getAPIOrigin()}/drivers/call`, {
                 headers: {
                     'Content-Type': 'text/plain;actually=json',
                 },
@@ -44,7 +45,7 @@ class FetchDriverCallBackend {
                         : {}),
                     method: method_name,
                     args: parameters,
-                    auth_token: this.context.authToken,
+                    auth_token: this.getAuthToken(),
                 }),
             });
 
@@ -131,22 +132,15 @@ class Drivers {
      * @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) {
-        this.authToken = context.authToken;
-        this.APIOrigin = context.APIOrigin;
-        this.appID = context.appID;
+    constructor (puter) {
+        this.puter = puter;
+        this.authToken = puter.authToken;
+        this.APIOrigin = puter.APIOrigin;
+        this.appID = puter.appID;
 
         // Driver-specific
         this.drivers_ = {};
 
-        // TODO: replace with `context` from constructor and test site login
-        this.context = {};
-        Object.defineProperty(this.context, 'authToken', {
-            get: () => this.authToken,
-        });
-        Object.defineProperty(this.context, 'APIOrigin', {
-            get: () => this.APIOrigin,
-        });
     }
 
     _init ({ puter }) {
@@ -226,7 +220,8 @@ class Drivers {
 
         return this.drivers_[key] = new Driver ({
             call_backend: new FetchDriverCallBackend({
-                context: this.context,
+                getAPIOrigin: () => this.APIOrigin,
+                getAuthToken: () => this.authToken,
             }),
             // iface: interfaces[iface_name],
             iface_name,

package/src/modules/FileSystem/index.js

@@ -20,14 +20,11 @@ import stat from './operations/stat.js';
 import symlink from './operations/symlink.js';
 import upload from './operations/upload.js';
 import write from './operations/write.js';
-// Why is this called deleteFSEntry instead of just delete? because delete is
-// a reserved keyword in javascript
-import { AdvancedBase } from '../../../../putility/index.js';
 import FSItem from '../FSItem.js';
 import deleteFSEntry from './operations/deleteFSEntry.js';
 import getReadURL from './operations/getReadUrl.js';
 
-export class PuterJSFileSystemModule extends AdvancedBase {
+export class PuterJSFileSystemModule {
 
     space = space;
     mkdir = mkdir;
@@ -48,16 +45,7 @@ export class PuterJSFileSystemModule extends AdvancedBase {
 
     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);
-        //     }
-        // },
-    };
+    static NARI_METHODS = {};
 
     /**
      * Creates a new instance with the given authentication token, API origin, and app ID,
@@ -68,12 +56,11 @@ 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) {
-        super();
-        this.authToken = context.authToken;
-        this.APIOrigin = context.APIOrigin;
-        this.appID = context.appID;
-        this.context = context;
+    constructor (puter) {
+        this.puter = puter;
+        this.authToken = puter.authToken;
+        this.APIOrigin = puter.APIOrigin;
+        this.appID = puter.appID;
         this.cacheUpdateTimer = null;
         // Connect socket.
         this.initializeSocket();
@@ -107,7 +94,7 @@ export class PuterJSFileSystemModule extends AdvancedBase {
             auth: {
                 auth_token: this.authToken,
             },
-            autoUnref: this.context.env === 'nodejs',
+            autoUnref: this.puter.env === 'nodejs',
         });
 
         this.bindSocketEvents();
@@ -212,7 +199,7 @@ export class PuterJSFileSystemModule extends AdvancedBase {
         this.authToken = authToken;
 
         // Check cache timestamp and purge if needed (only in GUI environment)
-        if ( this.context.env === 'gui' ) {
+        if ( this.puter.env === 'gui' ) {
             this.checkCacheAndPurge();
             // Start background task to update LAST_VALID_TS every 1 second
             this.startCacheUpdateTimer();
@@ -305,7 +292,7 @@ export class PuterJSFileSystemModule extends AdvancedBase {
      * @returns {void}
      */
     startCacheUpdateTimer () {
-        if ( this.context.env !== 'gui' ) {
+        if ( this.puter.env !== 'gui' ) {
             return;
         }
 

package/src/modules/Hosting.js

@@ -10,10 +10,11 @@ class Hosting {
      * @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) {
-        this.authToken = context.authToken;
-        this.APIOrigin = context.APIOrigin;
-        this.appID = context.appID;
+    constructor (puter) {
+        this.puter = puter;
+        this.authToken = puter.authToken;
+        this.APIOrigin = puter.APIOrigin;
+        this.appID = puter.appID;
     }
 
     /**

package/src/modules/KV.js

@@ -1,6 +1,15 @@
-import { TeePromise } from '@heyputer/putility/src/libs/promise.js';
 import * as utils from '../lib/utils.js';
 
+const createDeferred = () => {
+    let resolve;
+    let reject;
+    const promise = new Promise((res, rej) => {
+        resolve = res;
+        reject = rej;
+    });
+    return { promise, resolve, reject };
+};
+
 const gui_cache_keys = [
     'has_set_default_app_user_permissions',
     'window_sidebar_width',
@@ -29,15 +38,16 @@ class KV {
      * @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) {
-        this.authToken = context.authToken;
-        this.APIOrigin = context.APIOrigin;
-        this.appID = context.appID;
-
-        this.gui_cached = new TeePromise();
-        this.gui_cache_init = new TeePromise();
+    constructor (puter) {
+        this.puter = puter;
+        this.authToken = puter.authToken;
+        this.APIOrigin = puter.APIOrigin;
+        this.appID = puter.appID;
+
+        this.gui_cached = createDeferred();
+        this.gui_cache_init = createDeferred();
         (async () => {
-            await this.gui_cache_init;
+            await this.gui_cache_init.promise;
             this.gui_cache_init = null;
             const resp = await fetch(`${this.APIOrigin}/drivers/call`, {
                 method: 'POST',
@@ -142,7 +152,7 @@ class KV {
             this.gui_cached !== null
         ) {
             this.gui_cache_init && this.gui_cache_init.resolve();
-            const cache = await this.gui_cached;
+            const cache = await this.gui_cached.promise;
             return cache[args[0]];
         }
 
@@ -323,4 +333,4 @@ function globMatch (pattern, str) {
     return re.test(str);
 }
 
-export default KV;
+export default KV;

package/src/modules/OS.js

@@ -9,10 +9,11 @@ class OS {
      * @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) {
-        this.authToken = context.authToken;
-        this.APIOrigin = context.APIOrigin;
-        this.appID = context.appID;
+    constructor (puter) {
+        this.puter = puter;
+        this.authToken = puter.authToken;
+        this.APIOrigin = puter.APIOrigin;
+        this.appID = puter.appID;
     }
 
     /**
@@ -92,4 +93,4 @@ class OS {
     };
 }
 
-export default OS;
+export default OS;

package/src/modules/Perms.js

@@ -1,7 +1,8 @@
 export default class Perms {
-    constructor (context) {
-        this.authToken = context.authToken;
-        this.APIOrigin = context.APIOrigin;
+    constructor (puter) {
+        this.puter = puter;
+        this.authToken = puter.authToken;
+        this.APIOrigin = puter.APIOrigin;
     }
     setAuthToken (authToken) {
         this.authToken = authToken;

package/src/modules/Threads.js

@@ -1,9 +1,10 @@
 import { RequestError } from '../lib/RequestError.js';
 
 export default class Threads {
-    constructor (context) {
-        this.authToken = context.authToken;
-        this.APIOrigin = context.APIOrigin;
+    constructor (puter) {
+        this.puter = puter;
+        this.authToken = puter.authToken;
+        this.APIOrigin = puter.APIOrigin;
     }
     setAuthToken (authToken) {
         this.authToken = authToken;

package/src/modules/UI.js

@@ -1,8 +1,17 @@
-import putility from '@heyputer/putility';
 import EventListener from '../lib/EventListener.js';
 import FSItem from './FSItem.js';
 import PuterDialog from './PuterDialog.js';
 
+const createDeferred = () => {
+    let resolve;
+    let reject;
+    const promise = new Promise((res, rej) => {
+        resolve = res;
+        reject = rej;
+    });
+    return { promise, resolve, reject };
+};
+
 const FILE_SAVE_CANCELLED = Symbol('FILE_SAVE_CANCELLED');
 const FILE_OPEN_CANCELLED = Symbol('FILE_OPEN_CANCELLED');
 
@@ -22,10 +31,12 @@ class AppConnection extends EventListener {
     // (Closing and close events will still function.)
     #usesSDK;
 
-    static from (values, context) {
-        const connection = new AppConnection(context, {
+    static from (values, puter, { messageTarget, appInstanceID }) {
+        const connection = new AppConnection(puter, {
             target: values.appInstanceID,
             usesSDK: values.usesSDK,
+            messageTarget,
+            appInstanceID,
         });
 
         // When a connection is established the app is able to
@@ -35,23 +46,23 @@ class AppConnection extends EventListener {
         return connection;
     }
 
-    constructor (context, { target, usesSDK }) {
+    constructor (puter, { target, usesSDK, messageTarget, appInstanceID }) {
         super([
             'message', // The target sent us something with postMessage()
             'close', // The target app was closed
         ]);
-        this.messageTarget = context.messageTarget;
-        this.appInstanceID = context.appInstanceID;
+        this.messageTarget = messageTarget;
+        this.appInstanceID = appInstanceID;
         this.targetAppInstanceID = target;
         this.#isOpen = true;
         this.#usesSDK = usesSDK;
 
-        this.log = context.puter.logger.fields({
+        this.log = puter.logger.fields({
             category: 'ipc',
         });
         this.log.fields({
-            cons_source: context.appInstanceID,
-            source: context.puter.appInstanceID,
+            cons_source: appInstanceID,
+            source: puter.appInstanceID,
             target,
         }).info(`AppConnection created to ${target}`, this);
 
@@ -232,7 +243,7 @@ class UI extends EventListener {
         return ret;
     };
 
-    constructor (context, { appInstanceID, parentInstanceID }) {
+    constructor (puter, { appInstanceID, parentInstanceID }) {
         const eventNames = [
             'localeChanged',
             'themeChanged',
@@ -240,12 +251,12 @@ class UI extends EventListener {
         ];
         super(eventNames);
         this.#eventNames = eventNames;
-        this.context = context;
+        this.puter = puter;
         this.appInstanceID = appInstanceID;
         this.parentInstanceID = parentInstanceID;
-        this.appID = context.appID;
-        this.env = context.env;
-        this.util = context.util;
+        this.appID = puter.appID;
+        this.env = puter.env;
+        this.util = puter.util;
 
         if ( this.env === 'app' ) {
             this.messageTarget = window.parent;
@@ -254,16 +265,12 @@ class UI extends EventListener {
             return;
         }
 
-        // Context to pass to AppConnection instances
-        this.context = this.context.sub({
-            appInstanceID: this.appInstanceID,
-            messageTarget: this.messageTarget,
-        });
-
         if ( this.parentInstanceID ) {
-            this.#parentAppConnection = new AppConnection(this.context, {
+            this.#parentAppConnection = new AppConnection(this.puter, {
                 target: this.parentInstanceID,
                 usesSDK: true,
+                messageTarget: this.messageTarget,
+                appInstanceID: this.appInstanceID,
             });
         }
 
@@ -535,7 +542,10 @@ class UI extends EventListener {
             }
             else if ( e.data.msg === 'connection' ) {
                 e.data.usesSDK = true; // we can safely assume this
-                const conn = AppConnection.from(e.data, this.context);
+                const conn = AppConnection.from(e.data, this.puter, {
+                    messageTarget: this.messageTarget,
+                    appInstanceID: this.appInstanceID,
+                });
                 const accept = value => {
                     this.messageTarget?.postMessage({
                         $: 'connection-resp',
@@ -743,7 +753,7 @@ class UI extends EventListener {
     };
 
     showOpenFilePicker (options, callback) {
-        const undefinedOnCancel = new putility.libs.promise.TeePromise();
+        const undefinedOnCancel = createDeferred();
         const resolveOnlyPromise = new Promise((resolve, reject) => {
             if ( ! globalThis.open ) {
                 return reject('This API is not compatible in Web Workers.');
@@ -779,7 +789,7 @@ class UI extends EventListener {
                 resolve(maybe_result);
             };
         });
-        resolveOnlyPromise.undefinedOnCancel = undefinedOnCancel;
+        resolveOnlyPromise.undefinedOnCancel = undefinedOnCancel.promise;
         return resolveOnlyPromise;
     };
 
@@ -802,7 +812,7 @@ class UI extends EventListener {
     };
 
     showSaveFilePicker (content, suggestedName, type) {
-        const undefinedOnCancel = new putility.libs.promise.TeePromise();
+        const undefinedOnCancel = createDeferred();
         const resolveOnlyPromise = new Promise((resolve, reject) => {
             if ( ! globalThis.open ) {
                 return reject('This API is not compatible in Web Workers.');
@@ -870,7 +880,7 @@ class UI extends EventListener {
             };
         });
 
-        resolveOnlyPromise.undefinedOnCancel = undefinedOnCancel;
+        resolveOnlyPromise.undefinedOnCancel = undefinedOnCancel.promise;
 
         return resolveOnlyPromise;
     };
@@ -1203,7 +1213,10 @@ class UI extends EventListener {
             },
         });
 
-        return AppConnection.from(app_info, this.context);
+        return AppConnection.from(app_info, this.puter, {
+            messageTarget: this.messageTarget,
+            appInstanceID: this.appInstanceID,
+        });
     };
 
     connectToInstance = async function connectToInstance (app_name) {
@@ -1214,7 +1227,10 @@ class UI extends EventListener {
             },
         });
 
-        return AppConnection.from(app_info, this.context);
+        return AppConnection.from(app_info, this.puter, {
+            messageTarget: this.messageTarget,
+            appInstanceID: this.appInstanceID,
+        });
     };
 
     parentApp () {

package/src/lib/filesystem/APIFS.js

@@ -1,65 +0,0 @@
-import * as utils from '../utils.js';
-import putility from '@heyputer/putility';
-import { TeePromise } from '@heyputer/putility/src/libs/promise.js';
-import getAbsolutePathForApp from '../../modules/FileSystem/utils/getAbsolutePathForApp.js';
-import { TFilesystem } from './definitions.js';
-
-export class PuterAPIFilesystem extends putility.AdvancedBase {
-    constructor ({ api_info }) {
-        super();
-        this.api_info = api_info;
-    }
-
-    static IMPLEMENTS = {
-        [TFilesystem]: {
-            stat: async function (options) {
-                this.ensure_auth_();
-                const tp = new TeePromise();
-
-                const xhr = new utils.initXhr('/stat', this.api_info.APIOrigin, undefined, 'post', 'text/plain;actually=json');
-                utils.setupXhrEventHandlers(xhr, undefined, undefined, tp.resolve.bind(tp), tp.reject.bind(tp));
-
-                let dataToSend = {};
-                if ( options.uid !== undefined ) {
-                    dataToSend.uid = options.uid;
-                } else if ( options.path !== undefined ) {
-                    // If dirPath is not provided or it's not starting with a slash, it means it's a relative path
-                    // in that case, we need to prepend the app's root directory to it
-                    dataToSend.path = getAbsolutePathForApp(options.path);
-                }
-
-                dataToSend.return_subdomains = options.returnSubdomains;
-                dataToSend.return_permissions = options.returnPermissions;
-                dataToSend.return_versions = options.returnVersions;
-                dataToSend.return_size = options.returnSize;
-                dataToSend.auth_token = this.api_info.authToken;
-
-                xhr.send(JSON.stringify(dataToSend));
-
-                return await tp;
-            },
-            readdir: async function (options) {
-                this.ensure_auth_();
-                const tp = new TeePromise();
-
-                const xhr = new utils.initXhr('/readdir', this.api_info.APIOrigin, undefined, 'post', 'text/plain;actually=json');
-                utils.setupXhrEventHandlers(xhr, undefined, undefined, tp.resolve.bind(tp), tp.reject.bind(tp));
-
-                xhr.send(JSON.stringify({ path: getAbsolutePathForApp(options.path), auth_token: this.api_info.authToken }));
-
-                return await tp;
-            },
-        },
-    };
-
-    ensure_auth_ () {
-        // TODO: remove reference to global 'puter'; get 'env' via context
-        if ( !this.api_info.authToken && puter.env === 'web' ) {
-            try {
-                this.ui.authenticateWithPuter();
-            } catch (e) {
-                throw new Error('Authentication failed.');
-            }
-        }
-    }
-}