@heyputer/puter.js 2.1.4 → 2.1.7

package/src/modules/Hosting.js

@@ -1,7 +1,7 @@
 import * as utils from '../lib/utils.js';
 import getAbsolutePathForApp from './FileSystem/utils/getAbsolutePathForApp.js';
 
-class Hosting{
+class Hosting {
     /**
      * Creates a new instance with the given authentication token, API origin, and app ID,
      *
@@ -29,7 +29,7 @@ class Hosting{
 
     /**
      * Sets the API origin.
-     * 
+     *
      * @param {string} APIOrigin - The new API origin.
      * @memberof [Apps]
      * @returns {void}
@@ -40,99 +40,99 @@ class Hosting{
 
     // todo document the `Subdomain` object.
     list = async (...args) => {
-        return (await utils.make_driver_method([], 'puter-subdomains', undefined, 'select')(...args)).filter(e => !e.subdomain.startsWith("workers.puter."));
-    }
+        return (await utils.make_driver_method([], 'puter-subdomains', undefined, 'select')(...args)).filter(e => !e.subdomain.startsWith('workers.puter.'));
+    };
 
     create = async (...args) => {
         let options = {};
         // * allows for: puter.hosting.new('example-subdomain') *
-        if (typeof args[0] === 'string' && args.length === 1) {
+        if ( typeof args[0] === 'string' && args.length === 1 ) {
             // if subdomain is in the format of a `subdomain.puter.site` or `subdomain.puter.com`, extract the subdomain
             // and use it as the subdomain. This is to make development easier.
-            if (args[0].match(/^[a-z0-9]+\.puter\.(site|com)$/)) {
+            if ( args[0].match(/^[a-z0-9]+\.puter\.(site|com)$/) ) {
                 args[0] = args[0].split('.')[0];
             }
 
-            options = { object: { subdomain: args[0] }};
+            options = { object: { subdomain: args[0] } };
         }
         // if there are two string arguments, assume they are the subdomain and the target directory
         // * allows for: puter.hosting.new('example-subdomain', '/path/to/target') *
-        else if (Array.isArray(args) && args.length === 2 && typeof args[0] === 'string') {
+        else if ( Array.isArray(args) && args.length === 2 && typeof args[0] === 'string' ) {
             // if subdomain is in the format of a `subdomain.puter.site` or `subdomain.puter.com`, extract the subdomain
             // and use it as the subdomain. This is to make development easier.
-            if (args[0].match(/^[a-z0-9]+\.puter\.(site|com)$/)) {
+            if ( args[0].match(/^[a-z0-9]+\.puter\.(site|com)$/) ) {
                 args[0] = args[0].split('.')[0];
             }
 
             // if the target directory is not an absolute path, make it an absolute path relative to the app's root directory
-            if(args[1]){
+            if ( args[1] ) {
                 args[1] = getAbsolutePathForApp(args[1]);
             }
 
-            options = { object: { subdomain: args[0], root_dir: args[1] }};
+            options = { object: { subdomain: args[0], root_dir: args[1] } };
         }
         // allows for: puter.hosting.new({ subdomain: 'subdomain' })
-        else if (typeof args[0] === 'object') {
+        else if ( typeof args[0] === 'object' ) {
             options = { object: args[0] };
         }
         // Call the original chat.complete method
         return await utils.make_driver_method(['object'], 'puter-subdomains', undefined, 'create').call(this, options);
-    }
+    };
 
-    update = async(...args) => {
+    update = async (...args) => {
         let options = {};
         // If there are two string arguments, assume they are the subdomain and the target directory
         // * allows for: puter.hosting.update('example-subdomain', '/path/to/target') *
-        if (Array.isArray(args) && typeof args[0] === 'string') {
+        if ( Array.isArray(args) && typeof args[0] === 'string' ) {
             // if subdomain is in the format of a `subdomain.puter.site` or `subdomain.puter.com`, extract the subdomain
             // and use it as the subdomain. This is to make development easier.
-            if (args[0].match(/^[a-z0-9]+\.puter\.(site|com)$/)) {
+            if ( args[0].match(/^[a-z0-9]+\.puter\.(site|com)$/) ) {
                 args[0] = args[0].split('.')[0];
             }
 
             // if the target directory is not an absolute path, make it an absolute path relative to the app's root directory
-            if(args[1]){
+            if ( args[1] ) {
                 args[1] = getAbsolutePathForApp(args[1]);
             }
 
-            options = { id: {subdomain: args[0]}, object: { root_dir: args[1] ?? null }};
+            options = { id: { subdomain: args[0] }, object: { root_dir: args[1] ?? null } };
         }
 
         // Call the original chat.complete method
         return await utils.make_driver_method(['object'], 'puter-subdomains', undefined, 'update').call(this, options);
-    }
+    };
 
-    get = async(...args) => {
+    get = async (...args) => {
         let options = {};
         // if there is one string argument, assume it is the subdomain
         // * allows for: puter.hosting.get('example-subdomain') *
-        if (Array.isArray(args) && typeof args[0] === 'string') {
+        if ( Array.isArray(args) && typeof args[0] === 'string' ) {
             // if subdomain is in the format of a `subdomain.puter.site` or `subdomain.puter.com`, extract the subdomain
             // and use it as the subdomain. This is to make development easier.
-            if (args[0].match(/^[a-z0-9]+\.puter\.(site|com)$/)) {
+            if ( args[0].match(/^[a-z0-9]+\.puter\.(site|com)$/) ) {
                 args[0] = args[0].split('.')[0];
             }
 
-            options = { id: {subdomain: args[0]}};
+            options = { id: { subdomain: args[0] } };
         }
         return utils.make_driver_method(['uid'], 'puter-subdomains', undefined, 'read').call(this, options);
-    }
+    };
 
-    delete = async(...args) => {
+    delete = async (...args) => {
         let options = {};
         // if there is one string argument, assume it is the subdomain
         // * allows for: puter.hosting.get('example-subdomain') *
-        if (Array.isArray(args) && typeof args[0] === 'string') {
+        if ( Array.isArray(args) && typeof args[0] === 'string' ) {
             // if subdomain is in the format of a `subdomain.puter.site` or `subdomain.puter.com`, extract the subdomain
             // and use it as the subdomain. This is to make development easier.
-            if (args[0].match(/^[a-z0-9]+\.puter\.(site|com)$/)) {
+            if ( args[0].match(/^[a-z0-9]+\.puter\.(site|com)$/) ) {
                 args[0] = args[0].split('.')[0];
             }
 
-            options = { id: {subdomain: args[0]}};
+            options = { id: { subdomain: args[0] } };
         }
         return utils.make_driver_method(['uid'], 'puter-subdomains', undefined, 'delete').call(this, options);
-    }
+    };
 }
 
 export default Hosting;

package/src/modules/KV.js

@@ -17,7 +17,7 @@ const gui_cache_keys = [
     'taskbar_position',
     'has_seen_toolbar_animation',
 ];
-class KV{
+class KV {
     MAX_KEY_SIZE = 1024;
     MAX_VALUE_SIZE = 399 * 1024;
 
@@ -29,7 +29,7 @@ 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) {
+    constructor (context) {
         this.authToken = context.authToken;
         this.APIOrigin = context.APIOrigin;
         this.appID = context.appID;
@@ -79,7 +79,7 @@ class KV{
      * @memberof [KV]
      * @returns {void}
      */
-    setAuthToken(authToken) {
+    setAuthToken (authToken) {
         this.authToken = authToken;
     }
 
@@ -90,7 +90,7 @@ class KV{
      * @memberof [KV]
      * @returns {void}
      */
-    setAPIOrigin(APIOrigin) {
+    setAPIOrigin (APIOrigin) {
         this.APIOrigin = APIOrigin;
     }
 
@@ -116,15 +116,15 @@ class KV{
          */
         preprocess: (args) => {
             // key cannot be undefined or null
-            if ( args.key === undefined || args.key === null ){
+            if ( args.key === undefined || args.key === null ) {
                 throw { message: 'Key cannot be undefined', code: 'key_undefined' };
             }
             // key size cannot be larger than MAX_KEY_SIZE
-            if ( args.key.length > this.MAX_KEY_SIZE ){
+            if ( args.key.length > this.MAX_KEY_SIZE ) {
                 throw { message: `Key size cannot be larger than ${this.MAX_KEY_SIZE}`, code: 'key_too_large' };
             }
             // value size cannot be larger than MAX_VALUE_SIZE
-            if ( args.value && args.value.length > this.MAX_VALUE_SIZE ){
+            if ( args.value && args.value.length > this.MAX_VALUE_SIZE ) {
                 throw { message: `Value size cannot be larger than ${this.MAX_VALUE_SIZE}`, code: 'value_too_large' };
             }
             return args;
@@ -134,7 +134,7 @@ class KV{
     /**
      * Resolves to the value if the key exists, or `undefined` if the key does not exist. Rejects with an error on failure.
      */
-    async get(...args) {
+    async get (...args) {
         // Condition for gui boot cache
         if (
             typeof args[0] === 'string' &&
@@ -153,7 +153,7 @@ class KV{
     get_ = utils.make_driver_method(['key'], 'puter-kvstore', undefined, 'get', {
         preprocess: (args) => {
             // key size cannot be larger than MAX_KEY_SIZE
-            if ( args.key.length > this.MAX_KEY_SIZE ){
+            if ( args.key.length > this.MAX_KEY_SIZE ) {
                 throw ({ message: `Key size cannot be larger than ${this.MAX_KEY_SIZE}`, code: 'key_too_large' });
             }
 
@@ -168,15 +168,15 @@ class KV{
         let options = {};
 
         // arguments are required
-        if ( !args || args.length === 0 ){
+        if ( !args || args.length === 0 ) {
             throw ({ message: 'Arguments are required', code: 'arguments_required' });
         }
 
         options.key = args[0];
-        options.pathAndAmountMap = !args[1] ?  { '': 1 } : typeof args[1] === 'number' ? { '': args[1] } : args[1];
+        options.pathAndAmountMap = !args[1] ? { '': 1 } : typeof args[1] === 'number' ? { '': args[1] } : args[1];
 
         // key size cannot be larger than MAX_KEY_SIZE
-        if ( options.key.length > this.MAX_KEY_SIZE ){
+        if ( options.key.length > this.MAX_KEY_SIZE ) {
             throw ({ message: `Key size cannot be larger than ${this.MAX_KEY_SIZE}`, code: 'key_too_large' });
         }
 
@@ -187,15 +187,15 @@ class KV{
         let options = {};
 
         // arguments are required
-        if ( !args || args.length === 0 ){
+        if ( !args || args.length === 0 ) {
             throw ({ message: 'Arguments are required', code: 'arguments_required' });
         }
 
         options.key = args[0];
-        options.pathAndAmountMap = !args[1] ?  { '': 1 } : typeof args[1] === 'number' ? { '': args[1] } : args[1];
+        options.pathAndAmountMap = !args[1] ? { '': 1 } : typeof args[1] === 'number' ? { '': args[1] } : args[1];
 
         // key size cannot be larger than MAX_KEY_SIZE
-        if ( options.key.length > this.MAX_KEY_SIZE ){
+        if ( options.key.length > this.MAX_KEY_SIZE ) {
             throw ({ message: `Key size cannot be larger than ${this.MAX_KEY_SIZE}`, code: 'key_too_large' });
         }
 
@@ -216,7 +216,7 @@ class KV{
         options.ttl = ttl;
 
         // key size cannot be larger than MAX_KEY_SIZE
-        if ( options.key.length > this.MAX_KEY_SIZE ){
+        if ( options.key.length > this.MAX_KEY_SIZE ) {
             throw ({ message: `Key size cannot be larger than ${this.MAX_KEY_SIZE}`, code: 'key_too_large' });
         }
 
@@ -237,7 +237,7 @@ class KV{
         options.key = key;
         options.timestamp = timestamp;
         // key size cannot be larger than MAX_KEY_SIZE
-        if ( options.key.length > this.MAX_KEY_SIZE ){
+        if ( options.key.length > this.MAX_KEY_SIZE ) {
             throw ({ message: `Key size cannot be larger than ${this.MAX_KEY_SIZE}`, code: 'key_too_large' });
         }
 
@@ -249,7 +249,7 @@ class KV{
     del = utils.make_driver_method(['key'], 'puter-kvstore', undefined, 'del', {
         preprocess: (args) => {
             // key size cannot be larger than this.MAX_KEY_SIZE
-            if ( args.key.length > this.MAX_KEY_SIZE ){
+            if ( args.key.length > this.MAX_KEY_SIZE ) {
                 throw ({ message: `Key size cannot be larger than ${this.MAX_KEY_SIZE}`, code: 'key_too_large' });
             }
 
@@ -263,7 +263,7 @@ class KV{
         let returnValues = false;
 
         // list(true) or list(pattern, true) will return the key-value pairs
-        if ( (args && args.length === 1 && args[0] === true) || (args && args.length === 2 && args[1] === true) ){
+        if ( (args && args.length === 1 && args[0] === true) || (args && args.length === 2 && args[1] === true) ) {
             options = {};
             returnValues = true;
         }
@@ -274,16 +274,16 @@ class KV{
 
         // list(pattern)
         // list(pattern, true)
-        if ( (args && args.length === 1 && typeof args[0] === 'string') || (args && args.length === 2 && typeof args[0] === 'string' && args[1] === true) ){
+        if ( (args && args.length === 1 && typeof args[0] === 'string') || (args && args.length === 2 && typeof args[0] === 'string' && args[1] === true) ) {
             pattern = args[0];
         }
 
         return utils.make_driver_method([], 'puter-kvstore', undefined, 'list', {
             transform: (res) => {
                 // glob pattern was provided
-                if ( pattern ){
+                if ( pattern ) {
                     // consider both the key and the value
-                    if ( !returnValues ) {
+                    if ( ! returnValues ) {
                         let keys = res.filter((key) => {
                             return globMatch(pattern, key);
                         });
@@ -309,7 +309,7 @@ class KV{
     clear = this.flush;
 }
 
-function globMatch(pattern, str) {
+function globMatch (pattern, str) {
     const escapeRegExp = (string) => string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
 
     let regexPattern = escapeRegExp(pattern)

package/src/modules/OS.js

@@ -1,6 +1,6 @@
-import * as utils from '../lib/utils.js'
+import * as utils from '../lib/utils.js';
 
-class OS{
+class OS {
     /**
      * Creates a new instance with the given authentication token, API origin, and app ID,
      *
@@ -28,7 +28,7 @@ class OS{
 
     /**
      * Sets the API origin.
-     * 
+     *
      * @param {string} APIOrigin - The new API origin.
      * @memberof [Apps]
      * @returns {void}
@@ -37,11 +37,11 @@ class OS{
         this.APIOrigin = APIOrigin;
     }
 
-    user = function(...args){
+    user = 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
@@ -52,25 +52,25 @@ class OS{
         }
 
         let query = '';
-        if(options?.query){
-            query = '?' + new URLSearchParams(options.query).toString();
+        if ( options?.query ) {
+            query = `?${ new URLSearchParams(options.query).toString()}`;
         }
 
         return new Promise((resolve, reject) => {
-            const xhr = utils.initXhr('/whoami' + query, this.APIOrigin, this.authToken, 'get');
+            const xhr = utils.initXhr(`/whoami${ query}`, this.APIOrigin, this.authToken, 'get');
 
             // set up event handlers for load and error events
             utils.setupXhrEventHandlers(xhr, options.success, options.error, resolve, reject);
 
             xhr.send();
-        })
-    }
+        });
+    };
 
-    version = function(...args){
+    version = 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
@@ -88,8 +88,8 @@ class OS{
             utils.setupXhrEventHandlers(xhr, options.success, options.error, resolve, reject);
 
             xhr.send();
-        })
-    }
+        });
+    };
 }
 
-export default OS
+export default OS;

package/src/modules/Perms.js

@@ -10,16 +10,14 @@ export default class Perms {
         this.APIOrigin = APIOrigin;
     }
     async req_ (route, body) {
-        const resp = await fetch(
-            this.APIOrigin + route, {
-                method: body ? 'POST' : 'GET',
-                headers: {
-                    Authorization: `Bearer ${this.authToken}`,
-                    'Content-Type': 'application/json',
-                },
-                ...(body ? { body: JSON.stringify(body) } : {}),
-            }
-        );
+        const resp = await fetch(this.APIOrigin + route, {
+            method: body ? 'POST' : 'GET',
+            headers: {
+                Authorization: `Bearer ${this.authToken}`,
+                'Content-Type': 'application/json',
+            },
+            ...(body ? { body: JSON.stringify(body) } : {}),
+        });
         return await resp.json();
     }
 
@@ -27,62 +25,62 @@ export default class Perms {
     async grantUser (target_username, permission) {
         return await this.req_('/auth/grant-user-user', {
             target_username, permission,
-        })
+        });
     }
 
     async grantGroup (group_uid, permission) {
         return await this.req_('/auth/grant-user-group', {
             group_uid, permission,
-        })
+        });
     }
 
     async grantApp (app_uid, permission) {
         return await this.req_('/auth/grant-user-app', {
             app_uid, permission,
-        })
+        });
     }
 
     async grantAppAnyUser (app_uid, permission) {
         return await this.req_('/auth/grant-dev-app', {
             app_uid, permission,
-        })
+        });
     }
 
     async grantOrigin (origin, permission) {
         return await this.req_('/auth/grant-user-app', {
             origin, permission,
-        })
+        });
     }
-    
+
     // Revoke Permissions
     async revokeUser (target_username, permission) {
         return await this.req_('/auth/revoke-user-user', {
             target_username, permission,
-        })
+        });
     }
 
     async revokeGroup (group_uid, permission) {
         return await this.req_('/auth/revoke-user-group', {
             group_uid, permission,
-        })
+        });
     }
 
     async revokeApp (app_uid, permission) {
         return await this.req_('/auth/revoke-user-app', {
             app_uid, permission,
-        })
+        });
     }
 
     async revokeAppAnyUser (app_uid, permission) {
         return await this.req_('/auth/revoke-dev-app', {
             app_uid, permission,
-        })
+        });
     }
 
     async revokeOrigin (origin, permission) {
         return await this.req_('/auth/revoke-user-app', {
             origin, permission,
-        })
+        });
     }
 
     // Group Management