@heyputer/puter.js 2.1.15 → 2.2.4

package/types/modules/workers.d.ts

@@ -1,26 +1,25 @@
 export interface WorkerInfo {
     name: string;
     url: string;
-    file_path?: string;
-    file_uid?: string;
-    created_at?: string;
-    [key: string]: unknown;
+    file_path: string;
+    file_uid: string;
+    created_at: string;
 }
 
 export interface WorkerDeployment {
     success: boolean;
     url: string;
-    errors?: unknown[];
-    [key: string]: unknown;
+    errors?: string[];
 }
 
 export class WorkersHandler {
-    constructor (authToken?: string);
-
     create (workerName: string, filePath: string, appName?: string): Promise<WorkerDeployment>;
     delete (workerName: string): Promise<boolean>;
     exec (request: RequestInfo | URL, init?: RequestInit): Promise<Response>;
-    get (workerName: string): Promise<WorkerInfo>;
+    get (workerName: string): Promise<WorkerInfo | undefined>;
     list (): Promise<WorkerInfo[]>;
-    getLoggingHandle (workerName: string): Promise<EventTarget & { close: () => void }>;
+    getLoggingHandle (workerName: string): Promise<EventTarget & {
+        close: () => void;
+        onLog: (event: MessageEvent) => void;
+    }>;
 }

package/types/puter.d.ts

@@ -10,14 +10,11 @@ import type { KV } from './modules/kv.d.ts';
 import type { Networking } from './modules/networking.d.ts';
 import type { OS } from './modules/os.d.ts';
 import type { Perms } from './modules/perms.d.ts';
-import type Threads from './modules/threads.d.ts';
 import type { UI } from './modules/ui.d.ts';
 import type Util from './modules/util.d.ts';
 import type { WorkersHandler } from './modules/workers.d.ts';
 import type { APICallLogger, APILoggingConfig, PuterEnvironment, ToolSchema } from './shared.d.ts';
 
-export interface NetAPI extends Networking {}
-
 export interface PuterArgs {
     [key: string]: unknown;
 }
@@ -55,7 +52,6 @@ export class Puter {
     ui: UI;
     hosting: Hosting;
     kv: KV;
-    threads: Threads;
     perms: Perms;
     drivers: Drivers;
     debug: Debug;
@@ -67,13 +63,11 @@ export class Puter {
         [key: string]: unknown;
     };
 
-    net: NetAPI;
+    net: Networking;
     workers: WorkersHandler;
 
     static FSItem: typeof FSItem;
 
-    constructor();
-
     setAuthToken(authToken: string): void;
     resetAuthToken(): void;
     setAPIOrigin(APIOrigin: string): void;

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.');
-            }
-        }
-    }
-}

package/src/lib/filesystem/CacheFS.js

@@ -1,243 +0,0 @@
-import putility from '@heyputer/putility';
-import { RWLock } from '@heyputer/putility/src/libs/promise.js';
-import { ProxyFilesystem, TFilesystem } from './definitions.js';
-import { uuidv4 } from '../utils.js';
-
-export const ROOT_UUID = '00000000-0000-0000-0000-000000000000';
-const TTL = 5 * 1000;
-
-export class CacheFS extends putility.AdvancedBase {
-    static PROPERTIES = {
-        assocs_path_: () => ({}),
-        assocs_uuid_: () => ({}),
-        entries: () => ({}),
-    };
-
-    get_entry_ei (external_identifier) {
-        if ( Array.isArray(external_identifier) ) {
-            for ( const ei of external_identifier ) {
-                const entry = this.get_entry_ei(ei);
-                if ( entry ) return entry;
-            }
-            return;
-        }
-
-        console.log('GET ENTRY EI', external_identifier);
-
-        const internal_identifier =
-            this.assocs_path_[external_identifier] ||
-            this.assocs_uuid_[external_identifier] ||
-            external_identifier;
-
-        if ( ! internal_identifier ) {
-            return;
-        }
-        return this.entries[internal_identifier];
-    }
-
-    add_entry ({ id } = {}) {
-        const internal_identifier = id ?? uuidv4();
-        const entry = {
-            id: internal_identifier,
-            stat_has: {},
-            stat_exp: 0,
-            locks: {
-                stat: new RWLock(),
-                members: new RWLock(),
-            },
-        };
-        this.entries[internal_identifier] = entry;
-        return entry;
-    }
-
-    assoc_path (path, internal_identifier) {
-        console.log('ASSOC PATH', path, internal_identifier);
-        this.assocs_path_[path] = internal_identifier;
-    }
-
-    assoc_uuid (uuid, internal_identifier) {
-        if ( uuid === internal_identifier ) return;
-        this.assocs_uuid_[uuid] = internal_identifier;
-    }
-
-}
-
-export class CachedFilesystem extends ProxyFilesystem {
-    constructor (o) {
-        super(o);
-        // this.cacheFS = cacheFS;
-        this.cacheFS = new CacheFS();
-    }
-    static IMPLEMENTS = {
-        [TFilesystem]: {
-            stat: async function (o) {
-                let cent = this.cacheFS.get_entry_ei(o.path ?? o.uid);
-
-                const modifiers = [
-                    'subdomains',
-                    'permissions',
-                    'versions',
-                    'size',
-                ];
-
-                let values_requested = {};
-                for ( const mod of modifiers ) {
-                    const optionsKey = `return${
-                        mod.charAt(0).toUpperCase()
-                    }${mod.slice(1)}`;
-                    if ( ! o[optionsKey] ) continue;
-                    values_requested[mod] = true;
-                }
-
-                const satisfactory_cache = cent => {
-                    for ( const mod of modifiers ) {
-                        if ( ! values_requested[mod] ) continue;
-                        if ( ! cent.stat_has[mod] ) {
-                            return false;
-                        }
-                    }
-                    return true;
-                };
-
-                let cached_stat;
-                if ( cent && cent.stat && cent.stat_exp > Date.now() ) {
-                    const l = await cent.locks.stat.rlock();
-                    if ( satisfactory_cache(cent) ) {
-                        cached_stat = cent.stat;
-                    }
-                    l.unlock();
-                }
-
-                if ( cached_stat ) {
-                    console.log('CACHE HIT');
-                    return cached_stat;
-                }
-                console.log('CACHE MISS');
-
-                let l;
-                if ( cent ) {
-                    l = await cent.locks.stat.wlock();
-                }
-
-                console.log('DOING THE STAT', o);
-                const entry = await this.delegate.stat(o);
-
-                // We might have new information to identify a relevant cache entry
-                let cent_replaced = !!cent;
-                cent = this.cacheFS.get_entry_ei([entry.uid, entry.path]);
-                if ( cent ) {
-                    if ( cent_replaced ) l.unlock();
-                    l = await cent.locks.stat.wlock();
-                }
-
-                if ( ! cent ) {
-                    cent = this.cacheFS.add_entry({ id: entry.uid });
-                    this.cacheFS.assoc_path(entry.path, cent.id);
-                    this.cacheFS.assoc_uuid(entry.uid, cent.id);
-
-                    l = await cent.locks.stat.wlock();
-                }
-
-                cent.stat = entry;
-                cent.stat_has = { ...values_requested };
-                // TODO: increase cache TTL once invalidation works
-                cent.stat_exp = Date.now() + TTL;
-
-                l.unlock();
-
-                console.log('RETRUNING THE ENTRY', entry);
-                return entry;
-            },
-            readdir: async function (o) {
-                let cent = this.cacheFS.get_entry_ei([o.path, o.uid]);
-
-                console.log('CENT', cent, o);
-                let stats = null;
-                if ( cent && cent.members && cent.members_exp > Date.now() ) {
-                    console.log('MEMBERS', cent.members);
-                    stats = [];
-                    const l = await cent.locks.stat.rlock();
-
-                    for ( const id of cent.members ) {
-                        const member = this.cacheFS.get_entry_ei(id);
-                        if ( !member || !member.stat || member.stat_exp <= Date.now() ) {
-                            console.log('NO MEMBER OR STAT', member);
-                            stats = null;
-                            break;
-                        }
-                        console.log('member', member);
-                        if ( !o.no_assocs && !member.stat_has.subdomains ) {
-                            stats = null;
-                            break;
-                        }
-                        if ( !o.no_assocs && !member.stat_has.apps ) {
-                            stats = null;
-                            break;
-                        }
-                        if ( !o.no_thumbs && !member.stat_has.thumbnail ) {
-                            stats = null;
-                            break;
-                        }
-                        console.log('PUSHING', member.stat);
-
-                        stats.push(member.stat);
-                    }
-
-                    l.unlock();
-                }
-
-                console.log('STATS????', stats);
-                if ( stats ) {
-                    return stats;
-                }
-
-                let l;
-                if ( cent ) {
-                    l = await cent.locks.members.wlock();
-                }
-
-                const entries = await this.delegate.readdir(o);
-                if ( ! cent ) {
-                    cent = this.cacheFS.add_entry(o.uid ? { id: o.uid } : {});
-                    if ( o.path ) this.cacheFS.assoc_path(o.path, cent.id);
-                    l = await cent.locks.members.wlock();
-                }
-
-                let cent_ids = [];
-                for ( const entry of entries ) {
-                    let entry_cent = this.cacheFS.get_entry_ei([entry.path, entry.uid]);
-                    if ( ! entry_cent ) {
-                        entry_cent = this.cacheFS.add_entry({ id: entry.uid });
-                        this.cacheFS.assoc_path(entry.path, entry.uid);
-                    }
-                    cent_ids.push(entry_cent.id);
-                    // TODO: update_stat_ is not implemented
-                    // this.cacheFS.update_stat_(entry_cent, entry, {
-                    //     subdomains: ! o.no_assocs,
-                    //     apps: ! o.no_assocs,
-                    //     thumbnail: ! o.no_thumbs,
-                    // });
-                    entry_cent.stat = entry;
-                    entry_cent.stat_has = {
-                        subdomains: !o.no_assocs,
-                        apps: !o.no_assocs,
-                        thumbnail: !o.no_thumbs,
-                    };
-                    entry_cent.stat_exp = Date.now() + 1000 * 3;
-                }
-
-                cent.members = [];
-                for ( const id of cent_ids ) {
-                    cent.members.push(id);
-                }
-                cent.members_exp = Date.now() + TTL;
-
-                l.unlock();
-
-                console.log('CACHE ENTRY?', cent);
-
-                return entries;
-            },
-        },
-    };
-}

package/src/lib/filesystem/PostMessageFS.js

@@ -1,40 +0,0 @@
-import putility from '@heyputer/putility';
-import { TFilesystem } from './definitions.js';
-
-const example =     {
-    'id': 'f485f1ba-de07-422c-8c4b-c2da057d4a44',
-    'uid': 'f485f1ba-de07-422c-8c4b-c2da057d4a44',
-    'is_dir': true,
-    'immutable': true,
-    'name': 'Test',
-};
-
-export class PostMessageFilesystem extends putility.AdvancedBase {
-    constructor ({ rpc, messageTarget }) {
-        super();
-        this.rpc = rpc;
-        this.messageTarget = messageTarget;
-    }
-    static IMPLEMENTS = {
-        [TFilesystem]: {
-            stat: async function (o) {
-                return example;
-            },
-            readdir: async function (o) {
-                const tp = new putility.libs.promise.TeePromise();
-                const $callback = this.rpc.registerCallback((result) => {
-                    tp.resolve(result);
-                });
-                // return [example];
-                this.messageTarget.postMessage({
-                    $: 'puter-fs',
-                    $callback,
-                    op: 'readdir',
-                    args: o,
-                }, '*');
-
-                return await tp;
-            },
-        },
-    };
-}

package/src/lib/filesystem/definitions.js

@@ -1,40 +0,0 @@
-import putility from '@heyputer/putility';
-
-export const TFilesystem = 'TFilesystem';
-
-// TODO: UNUSED (eventually putility will support these definitions)
-//       This is here so that the idea is not forgotten.
-export const IFilesystem = {
-    methods: {
-        stat: {
-            parameters: {
-                path: {
-                    alias: 'uid',
-                },
-            },
-        },
-    },
-
-};
-
-export class ProxyFilesystem extends putility.AdvancedBase {
-    static PROPERTIES = {
-        delegate: () => {
-        },
-    };
-    // TODO: constructor implied by properties
-    constructor ({ delegate }) {
-        super();
-        this.delegate = delegate;
-    }
-    static IMPLEMENTS = {
-        [TFilesystem]: {
-            stat: async function (o) {
-                return this.delegate.stat(o);
-            },
-            readdir: async function (o) {
-                return this.delegate.readdir(o);
-            },
-        },
-    };
-}

package/src/modules/Threads.js

@@ -1,72 +0,0 @@
-import { RequestError } from '../lib/RequestError.js';
-
-export default class Threads {
-    constructor (context) {
-        this.authToken = context.authToken;
-        this.APIOrigin = context.APIOrigin;
-    }
-    setAuthToken (authToken) {
-        this.authToken = authToken;
-    }
-    setAPIOrigin (APIOrigin) {
-        this.APIOrigin = APIOrigin;
-    }
-    async req_ (method, route, body) {
-        const resp = await fetch(this.APIOrigin + route, {
-            method,
-            headers: {
-                Authorization: `Bearer ${this.authToken}`,
-                ...(body ? { 'Content-Type': 'application/json' } : {}),
-            },
-            ...(body ? { body: JSON.stringify(body) } : {}),
-        });
-        if ( ! resp.ok ) {
-            const resp_data = await resp.json();
-            const err = new RequestError(resp_data.message);
-            err.response = resp_data;
-            throw err;
-        }
-        return await resp.json();
-    }
-
-    async create (spec, parent) {
-        if ( typeof spec === 'string' ) spec = { text: spec };
-        return await this.req_('POST', '/threads/create', {
-            ...spec,
-            ...(parent ? { parent } : {}),
-        });
-    }
-
-    async edit (uid, spec = {}) {
-        if ( typeof spec === 'string' ) spec = { text: spec };
-        await this.req_('PUT', `/threads/edit/${ encodeURIComponent(uid)}`, {
-            ...spec,
-        });
-    }
-
-    async delete (uid) {
-        await this.req_('DELETE', `/threads/${ encodeURIComponent(uid)}`);
-    }
-
-    async list (uid, page, options) {
-        return await this.req_('POST',
-                        `/threads/list/${ encodeURIComponent(uid) }/${ page}`,
-                        options ?? {});
-    }
-
-    async subscribe (uid, callback) {
-        puter.fs.socket.emit('thread.sub-request', { uid });
-
-        // socket.io, which we use unfortunatelly, doesn't handle
-        // wildcard events, so we have to just put them all here.
-        const events = [
-            'post', 'edit', 'delete', 'child-edit', 'child-delete',
-        ];
-
-        for ( const event of events ) {
-            puter.fs.socket.on(`thread.${event}`, (data) => {
-                if ( data.subscription === uid ) callback(event, data);
-            });
-        }
-    }
-}

package/src/services/APIAccess.js

@@ -1,46 +0,0 @@
-import putility from '@heyputer/putility';
-
-const { TTopics } = putility.traits;
-
-/**
- * Manages the auth token and origin used to communicate with
- * Puter's API
- */
-export class APIAccessService extends putility.concepts.Service {
-    static TOPICS = ['update'];
-
-    static PROPERTIES = {
-        auth_token: {
-            post_set (v) {
-                this.as(TTopics).pub('update');
-            },
-        },
-        api_origin: {
-            post_set () {
-                this.as(TTopics).pub('update');
-            },
-        },
-    };
-
-    // TODO: inconsistent! Update all dependents.
-    get_api_info () {
-        const self = this;
-        const o = {};
-        [
-            ['auth_token', 'auth_token'],
-            ['authToken', 'auth_token'],
-            ['APIOrigin', 'api_origin'],
-            ['api_origin', 'api_origin'],
-        ].forEach(([k1, k2]) => {
-            Object.defineProperty(o, k1, {
-                get () {
-                    return self[k2];
-                },
-                set (v) {
-                    return self;
-                },
-            });
-        });
-        return o;
-    }
-}

package/src/services/FSRelay.js

@@ -1,20 +0,0 @@
-import putility from '@heyputer/putility';
-
-const example =     {
-    'id': 'f485f1ba-de07-422c-8c4b-c2da057d4a44',
-    'uid': 'f485f1ba-de07-422c-8c4b-c2da057d4a44',
-    'is_dir': true,
-    'immutable': true,
-    'name': 'FromParentWindow',
-};
-
-export class FSRelayService extends putility.concepts.Service {
-    async _init () {
-        const services = this._.context.services;
-        const util = this._.context.util;
-        const svc_xdIncoming = services.get('xd-incoming');
-        svc_xdIncoming.register_tagged_listener('puter-fs', event => {
-            util.rpc.send(event.source, event.data.$callback, [example]);
-        });
-    }
-}