@heyputer/puter.js 2.0.1 → 2.0.2

package/APACHE_LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024-present Puter Technologies Inc. All Rights Reserved.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/doc/devlog.md

@@ -0,0 +1,49 @@
+## 2024-10-14
+
+### Letting Puter Desktop Control Client FS Cache
+
+#### Move Context to `putility`
+
+The Filesystem module for puter.js will need to check `puter.env` to determine
+whether it's delegating client FS calls to Puter's API or Puter's Desktop via
+postMessage. `env` was already being passed to the Filesystem module via its
+constructor but the constructor had no reference to it; having only looked at
+the constructor itself and not where its initialized, I didn't realize this
+and started working on another way to pass it.
+
+I decided to add Context which will allow us to incrementally migrate all the
+modules to a situation where the things available to modules generally is one
+piece of information in the code, and doesn't need to be repeated for each
+constructor call manually.
+
+### What happens when apps make FS calls to Puter's desktop?
+
+I'm going to describe a problem that I overlooked before I started working on
+this. If `env` is `"app"`, then we delegate filesystem calls to Puter's desktop
+so that caching is centralized and all apps can benefit from the cache. Okay,
+that's great, but... **Puter Desktop has user privileges, not app privileges.**
+
+With this, I see a couple of options:
+- Puter desktop makes the call to check ACL
+  - we don't expose this yet
+    we need to ensure it doesn't expose the existence of files for which the
+    actor does not have "see" permission.
+- Apps maintain their own cache
+
+In either case, apps need to be able to subscribe to filesystem events for
+cache invalidation. This means the file/location relevant to the event needs
+an ACL check either way. It seems there is no choice but to allow Puter Desktop
+to expose ACL.
+
+I thought about adding this to `/stat` - i.e. Desktop can pass an app ID and
+get information about what kind of access the app has - but that would incur
+additional database calls for no reason, especially if Desktop really does
+have that entry cached already.
+
+This will require a new endpoint then: `/auth/check-app-acl`. I'll put it in
+PermissionAPIService for now. It seems a little out of place there but it
+also doesn't seem to make sense to create a new service for it.
+This method may eventually be deprecated if we find out apps need to be
+able to perform ACL checks on behalf of delegate apps, in which case we might
+create a more general-purpose `/auth/check-acl` endpoint that can cover
+both cases.

package/index.d.ts

@@ -23,7 +23,7 @@ declare namespace Puter {
         drivers: Drivers;
         fs: FileSystem;
         hosting: Hosting;
-        kv: KeyValue;
+        kv: KV;
         net: Networking;
         perms: Permissions;
         ui: UI;
@@ -276,19 +276,19 @@ declare namespace Puter {
         root_dir: FSItem;
     }
 
-    // KeyValue Module
-    interface KeyValue {
+    // KV Module
+    interface KV {
         set(key: string, value: string | number | boolean | object | any[]): Promise<boolean>;
         get(key: string): Promise<any>;
         del(key: string): Promise<boolean>;
         incr(key: string, amount?: number): Promise<number>;
         decr(key: string, amount?: number): Promise<number>;
-        list(pattern?: string, returnValues?: boolean): Promise<string[] | KeyValuePair[]>;
-        list(returnValues?: boolean): Promise<string[] | KeyValuePair[]>;
+        list(pattern?: string, returnValues?: boolean): Promise<string[] | KVPair[]>;
+        list(returnValues?: boolean): Promise<string[] | KVPair[]>;
         flush(): Promise<boolean>;
     }
 
-    interface KeyValuePair {
+    interface KVPair {
         key: string;
         value: any;
     }

package/package.json

@@ -1,14 +1,10 @@
 {
     "name": "@heyputer/puter.js",
-    "version": "2.0.1",
+    "version": "2.0.2",
     "description": "Puter.js - A JavaScript library for interacting with Puter services.",
-    "main": "src/index.js",
+    "main": "src/entry.js",
     "types": "index.d.ts",
     "typings": "index.d.ts",
-    "files": [
-        "src/index.js",
-        "index.d.ts"
-    ],
     "type": "module",
     "publishConfig": {
         "registry": "https://registry.npmjs.org/"

package/src/entry.js

@@ -0,0 +1,9 @@
+const goodContext = {}
+
+let puter;
+with (goodContext) {
+    puter = await import('./src/index.js');
+}
+
+
+module.exports = { puter };

package/src/lib/APICallLogger.js

@@ -0,0 +1,110 @@
+/*
+ * Copyright (C) 2024-present Puter Technologies Inc.
+ * 
+ * This file is part of Puter.
+ * 
+ * Puter is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+
+/**
+ * APICallLogger provides centralized logging for all API calls made by the puter-js SDK.
+ * It logs API calls in a simple format: service - operation - params - result
+ */
+class APICallLogger {
+    constructor(config = {}) {
+        this.config = {
+            enabled: config.enabled ?? false,
+            ...config
+        };
+    }
+
+    /**
+     * Updates the logger configuration
+     * @param {Object} newConfig - New configuration options
+     */
+    updateConfig(newConfig) {
+        this.config = { ...this.config, ...newConfig };
+    }
+
+    /**
+     * Enables API call logging
+     */
+    enable() {
+        this.config.enabled = true;
+    }
+
+    /**
+     * Disables API call logging
+     */
+    disable() {
+        this.config.enabled = false;
+    }
+
+    /**
+     * Checks if logging is enabled for the current configuration
+     * @returns {boolean}
+     */
+    isEnabled() {
+        return this.config.enabled;
+    }
+
+    /**
+     * Logs the completion of an API request in a simple format
+     * @param {Object} options - Request completion options
+     */
+    logRequest(options = {}) {
+        if (!this.isEnabled()) return;
+
+        const { 
+            service = 'unknown', 
+            operation = 'unknown',
+            params = {},
+            result = null,
+            error = null
+        } = options;
+
+        // Format params as a readable string
+        let paramsStr = '{}';
+        if (params && Object.keys(params).length > 0) {
+            try {
+                paramsStr = JSON.stringify(params);
+            } catch (e) {
+                paramsStr = '[Unable to serialize params]';
+            }
+        }
+
+        // Format the log message with bold params
+        const logMessage = `${service} - ${operation} - \x1b[1m${paramsStr}\x1b[22m`;
+        
+        if (error) {
+            console.error(logMessage, { error: error.message || error, result });
+        } else {
+            console.log(logMessage, result);
+        }
+    }
+
+    /**
+     * Gets current logging statistics
+     * @returns {Object}
+     */
+    getStats() {
+        return {
+            enabled: this.config.enabled,
+            config: { ...this.config }
+        };
+    }
+}
+
+export default APICallLogger;

package/src/lib/EventListener.js

@@ -0,0 +1,51 @@
+export default class EventListener {
+    // Array of all supported event names.
+    #eventNames;
+
+    // Map of eventName -> array of listeners
+    #eventListeners;
+
+    constructor(eventNames) {
+        this.#eventNames = eventNames;
+
+        this.#eventListeners = (() => {
+            const map = new Map();
+            for (let eventName of this.#eventNames) {
+                map[eventName] = [];
+            }
+            return map;
+        })();
+    }
+
+    emit(eventName, data) {
+        if (!this.#eventNames.includes(eventName)) {
+            console.error(`Event name '${eventName}' not supported`);
+            return;
+        }
+        this.#eventListeners[eventName].forEach((listener) => {
+            listener(data);
+        });
+    }
+
+    on(eventName, callback) {
+        if (!this.#eventNames.includes(eventName)) {
+            console.error(`Event name '${eventName}' not supported`);
+            return;
+        }
+        this.#eventListeners[eventName].push(callback);
+        return this;
+    }
+
+    off(eventName, callback) {
+        if (!this.#eventNames.includes(eventName)) {
+            console.error(`Event name '${eventName}' not supported`);
+            return;
+        }
+        const listeners = this.#eventListeners[eventName];
+        const index = listeners.indexOf(callback)
+        if (index !== -1) {
+            listeners.splice(index, 1);
+        }
+        return this;
+    }
+}

package/src/lib/RequestError.js

@@ -0,0 +1,6 @@
+export class RequestError extends Error {
+    constructor (message) {
+        super(message);
+        this.name = 'RequestError'; // thanks minifier
+    }
+}

package/src/lib/filesystem/APIFS.js

@@ -0,0 +1,73 @@
+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.');
+            }
+        }
+    }
+}