npm - @heyputer/puter.js - Versions diffs - 1.0.1 → 2.0.1 - Mend

@heyputer/puter.js 1.0.1 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (74) hide show

package/README.md +14 -43
package/index.d.ts +479 -0
package/package.json +13 -3
package/APACHE_LICENSE.txt +0 -201
package/doc/devlog.md +0 -49
package/src/bg.png +0 -0
package/src/bg.webp +0 -0
package/src/lib/APICallLogger.js +0 -110
package/src/lib/EventListener.js +0 -51
package/src/lib/RequestError.js +0 -6
package/src/lib/filesystem/APIFS.js +0 -73
package/src/lib/filesystem/CacheFS.js +0 -243
package/src/lib/filesystem/PostMessageFS.js +0 -40
package/src/lib/filesystem/definitions.js +0 -39
package/src/lib/path.js +0 -509
package/src/lib/polyfills/localStorage.js +0 -92
package/src/lib/polyfills/xhrshim.js +0 -233
package/src/lib/socket.io/socket.io.esm.min.js +0 -7
package/src/lib/socket.io/socket.io.esm.min.js.map +0 -1
package/src/lib/socket.io/socket.io.js +0 -4385
package/src/lib/socket.io/socket.io.js.map +0 -1
package/src/lib/socket.io/socket.io.min.js +0 -7
package/src/lib/socket.io/socket.io.min.js.map +0 -1
package/src/lib/socket.io/socket.io.msgpack.min.js +0 -7
package/src/lib/socket.io/socket.io.msgpack.min.js.map +0 -1
package/src/lib/utils.js +0 -620
package/src/lib/xdrpc.js +0 -104
package/src/modules/AI.js +0 -680
package/src/modules/Apps.js +0 -215
package/src/modules/Auth.js +0 -171
package/src/modules/Debug.js +0 -39
package/src/modules/Drivers.js +0 -278
package/src/modules/FSItem.js +0 -139
package/src/modules/FileSystem/index.js +0 -187
package/src/modules/FileSystem/operations/copy.js +0 -64
package/src/modules/FileSystem/operations/deleteFSEntry.js +0 -59
package/src/modules/FileSystem/operations/getReadUrl.js +0 -42
package/src/modules/FileSystem/operations/mkdir.js +0 -62
package/src/modules/FileSystem/operations/move.js +0 -75
package/src/modules/FileSystem/operations/read.js +0 -46
package/src/modules/FileSystem/operations/readdir.js +0 -102
package/src/modules/FileSystem/operations/rename.js +0 -58
package/src/modules/FileSystem/operations/sign.js +0 -103
package/src/modules/FileSystem/operations/space.js +0 -40
package/src/modules/FileSystem/operations/stat.js +0 -95
package/src/modules/FileSystem/operations/symlink.js +0 -55
package/src/modules/FileSystem/operations/upload.js +0 -440
package/src/modules/FileSystem/operations/write.js +0 -65
package/src/modules/FileSystem/utils/getAbsolutePathForApp.js +0 -21
package/src/modules/Hosting.js +0 -138
package/src/modules/KV.js +0 -301
package/src/modules/OS.js +0 -95
package/src/modules/Perms.js +0 -109
package/src/modules/PuterDialog.js +0 -481
package/src/modules/Threads.js +0 -75
package/src/modules/UI.js +0 -1555
package/src/modules/Util.js +0 -38
package/src/modules/Workers.js +0 -120
package/src/modules/networking/PSocket.js +0 -87
package/src/modules/networking/PTLS.js +0 -100
package/src/modules/networking/PWispHandler.js +0 -89
package/src/modules/networking/parsers.js +0 -157
package/src/modules/networking/requests.js +0 -282
package/src/services/APIAccess.js +0 -46
package/src/services/FSRelay.js +0 -20
package/src/services/Filesystem.js +0 -122
package/src/services/NoPuterYet.js +0 -20
package/src/services/XDIncoming.js +0 -44
package/test/ai.test.js +0 -214
package/test/fs.test.js +0 -798
package/test/index.html +0 -1183
package/test/kv.test.js +0 -548
package/test/txt2speech.test.js +0 -178
package/webpack.config.js +0 -25

package/README.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # Puter.js
-The official JavaScript SDK for [Puter.com](https://puter.com) — access cloud and AI features directly from your frontend code.
+The official JavaScript SDK for [Puter.com](https://puter.com) — Free, Serverless, Cloud and AI from the frontend code.
 ---
@@ -21,7 +21,15 @@ import '@heyputer/puter.js';
 #### CommonJS
 ```js
-require('@heyputer/puter.js');
+const puter = require('@heyputer/puter.js');
+```
+#### CDN
+Include Puter.js directly in your HTML via CDN in the `<head>` section:
+```html
+<script src="https://js.puter.com/v2/"></script>
 ```
 ## Usage Example
@@ -32,7 +40,7 @@ After importing, you can use the global `puter` object:
 // Print a message
 puter.print('Hello from Puter.js!');
-// Chat with GPT-3.5 Turbo
+// Chat with GPT-5 nano
 puter.ai.chat('What color was Napoleon\'s white horse?').then(response => {
   puter.print(response);
 });
@@ -40,49 +48,12 @@ puter.ai.chat('What color was Napoleon\'s white horse?').then(response => {
 ---
-## CDN Usage
-Include Puter.js directly in your HTML via CDN:
-```html
-<script src="https://js.puter.com/v2/"></script>
-<script>
-  puter.print('Hello from Puter.js via CDN!');
-  puter.ai.chat('What color was Napoleon\'s white horse?').then(response => {
-    puter.print(response);
-  });
-</script>
-```
----
 ## Documentation & Community
-- [Docs](https://docs.puter.com)
+- [Developer Site](https://developer.puter.com)
+- [API Docs](https://docs.puter.com)
 - [Live Demo](https://docs.puter.com/playground/)
 - [Puter.com](https://puter.com)
 - [Discord](https://discord.com/invite/PQcx7Teh8u)
 - [Reddit](https://reddit.com/r/puter)
-- [X (Twitter)](https://twitter.com/HeyPuter)
----
-## Local Development Example
-Make sure the development server is running.
-```html
-<html>
-<body>
-    <script src="http://puter.localhost:4100/sdk/puter.dev.js"></script>
-    <script>
-        // Loading ...
-        puter.print(`Loading...`);
-        // Chat with GPT-3.5 Turbo
-        puter.ai.chat(`What color was Napoleon's white horse?`).then((response) => {
-            puter.print(response);
-        });
-    </script>
-</body>
-</html>
+- [X (Twitter)](https://twitter.com/HeyPuter)

package/index.d.ts ADDED Viewed

@@ -0,0 +1,479 @@
+declare global {
+    interface Window {
+        puter: Puter;
+    }
+}
+declare namespace Puter {
+    // Main Puter interface
+    interface Puter {
+        // Properties
+        appID: string;
+        env: 'app' | 'web' | 'gui';
+        // Utility methods
+        print(text: string, options?: { code?: boolean }): void;
+        randName(separator?: string): string;
+        exit(statusCode?: number): void;
+        // Sub-modules
+        ai: AI;
+        apps: Apps;
+        auth: Auth;
+        drivers: Drivers;
+        fs: FileSystem;
+        hosting: Hosting;
+        kv: KeyValue;
+        net: Networking;
+        perms: Permissions;
+        ui: UI;
+        workers: Workers;
+    }
+    // AI Module
+    interface AI {
+        chat(prompt: string, options?: ChatOptions): Promise<ChatResponse>;
+        chat(prompt: string, testMode?: boolean, options?: ChatOptions): Promise<ChatResponse>;
+        chat(prompt: string, imageURL?: string, testMode?: boolean, options?: ChatOptions): Promise<ChatResponse>;
+        chat(prompt: string, imageURLArray?: string[], testMode?: boolean, options?: ChatOptions): Promise<ChatResponse>;
+        chat(messages: ChatMessage[], testMode?: boolean, options?: ChatOptions): Promise<ChatResponse>;
+        img2txt(image: string | File | Blob, testMode?: boolean): Promise<string>;
+        txt2img(prompt: string, testMode?: boolean): Promise<HTMLImageElement>;
+        txt2img(prompt: string, options?: Txt2ImgOptions): Promise<HTMLImageElement>;
+        txt2speech(text: string): Promise<HTMLAudioElement>;
+        txt2speech(text: string, options?: Txt2SpeechOptions): Promise<HTMLAudioElement>;
+        txt2speech(text: string, language?: string): Promise<HTMLAudioElement>;
+        txt2speech(text: string, language?: string, voice?: string): Promise<HTMLAudioElement>;
+        txt2speech(text: string, language?: string, voice?: string, engine?: string): Promise<HTMLAudioElement>;
+    }
+    interface ChatOptions {
+        model?: string;
+        stream?: boolean;
+        max_tokens?: number;
+        temperature?: number;
+        tools?: ToolDefinition[];
+    }
+    interface ToolDefinition {
+        type: 'function';
+        function: {
+            name: string;
+            description: string;
+            parameters: object;
+            strict?: boolean;
+        };
+    }
+    interface ChatMessage {
+        role: 'system' | 'assistant' | 'user' | 'function' | 'tool';
+        content: string | ContentObject[];
+        tool_call_id?: string;
+    }
+    interface ContentObject {
+        type: 'text' | 'file';
+        text?: string;
+        puter_path?: string;
+    }
+    interface ChatResponse {
+        message: {
+            role: string;
+            content: string;
+            tool_calls?: ToolCall[];
+        };
+    }
+    interface ToolCall {
+        id: string;
+        function: {
+            name: string;
+            arguments: string;
+        };
+    }
+    interface Txt2ImgOptions {
+        model?: 'gpt-image-1' | 'gemini-2.5-flash-image-preview' | 'dall-e-3';
+        quality?: 'high' | 'medium' | 'low' | 'hd' | 'standard';
+        input_image?: string;
+        input_image_mime_type?: string;
+    }
+    interface Txt2SpeechOptions {
+        language?: string;
+        voice?: string;
+        engine?: 'standard' | 'neural' | 'generative';
+    }
+    // Apps Module
+    interface Apps {
+        create(name: string, indexURL: string): Promise<App>;
+        create(name: string, indexURL: string, title?: string): Promise<App>;
+        create(name: string, indexURL: string, title?: string, description?: string): Promise<App>;
+        create(options: CreateAppOptions): Promise<App>;
+        delete(name: string): Promise<App>;
+        get(name: string, options?: GetAppOptions): Promise<App>;
+        list(options?: ListAppOptions): Promise<App[]>;
+        update(name: string, attributes: UpdateAppAttributes): Promise<App>;
+    }
+    interface CreateAppOptions {
+        name: string;
+        indexURL: string;
+        title?: string;
+        description?: string;
+        icon?: string;
+        maximizeOnStart?: boolean;
+        filetypeAssociations?: string[];
+    }
+    interface GetAppOptions {
+        stats_period?: StatsPeriod;
+        icon_size?: null | 16 | 32 | 64 | 128 | 256 | 512;
+    }
+    interface ListAppOptions extends GetAppOptions { }
+    interface UpdateAppAttributes {
+        name?: string;
+        indexURL?: string;
+        title?: string;
+        description?: string;
+        icon?: string;
+        maximizeOnStart?: boolean;
+        filetypeAssociations?: string[];
+    }
+    type StatsPeriod = 'all' | 'today' | 'yesterday' | '7d' | '30d' | 'this_month' | 'last_month' | 'this_year' | 'last_year' | 'month_to_date' | 'year_to_date' | 'last_12_months';
+    interface App {
+        uid: string;
+        name: string;
+        icon: string;
+        description: string;
+        title: string;
+        maximize_on_start: boolean;
+        index_url: string;
+        created_at: string;
+        background: boolean;
+        filetype_associations: string[];
+        open_count: number;
+        user_count: number;
+    }
+    // Auth Module
+    interface Auth {
+        signIn(options?: { attempt_temp_user_creation?: boolean }): Promise<boolean>;
+        signOut(): void;
+        isSignedIn(): boolean;
+        getUser(): Promise<User>;
+    }
+    interface User {
+        uuid: string;
+        username: string;
+        email_confirmed: boolean;
+    }
+    // Drivers Module
+    interface Drivers {
+        call(interface: string, driver: string, method: string, args?: object): Promise<any>;
+    }
+    // FileSystem Module
+    interface FileSystem {
+        copy(source: string, destination: string, options?: CopyOptions): Promise<FSItem>;
+        delete(path: string, options?: DeleteOptions): Promise<void>;
+        getReadURL(path: string, expiresIn?: number): Promise<string>;
+        mkdir(path: string, options?: MkdirOptions): Promise<FSItem>;
+        move(source: string, destination: string, options?: MoveOptions): Promise<FSItem>;
+        read(path: string, options?: ReadOptions): Promise<Blob>;
+        readdir(path: string, options?: ReaddirOptions): Promise<FSItem[]>;
+        readdir(options?: ReaddirOptions): Promise<FSItem[]>;
+        rename(path: string, newName: string): Promise<FSItem>;
+        space(): Promise<SpaceInfo>;
+        stat(path: string): Promise<FSItem>;
+        upload(items: FileList | File[] | Blob[], dirPath?: string, options?: object): Promise<FSItem[]>;
+        write(path: string, data?: string | File | Blob, options?: WriteOptions): Promise<FSItem>;
+    }
+    interface CopyOptions {
+        overwrite?: boolean;
+        dedupeName?: boolean;
+        newName?: string;
+    }
+    interface DeleteOptions {
+        recursive?: boolean;
+        descendantsOnly?: boolean;
+    }
+    interface MkdirOptions {
+        overwrite?: boolean;
+        dedupeName?: boolean;
+        createMissingParents?: boolean;
+    }
+    interface MoveOptions extends CopyOptions {
+        createMissingParents?: boolean;
+    }
+    interface ReadOptions {
+        offset?: number;
+        byte_count?: number;
+    }
+    interface ReaddirOptions {
+        path?: string;
+        uid?: string;
+    }
+    interface WriteOptions {
+        overwrite?: boolean;
+        dedupeName?: boolean;
+        createMissingParents?: boolean;
+    }
+    interface SpaceInfo {
+        capacity: number;
+        used: number;
+    }
+    interface FSItem {
+        id: string;
+        uid: string;
+        name: string;
+        path: string;
+        is_dir: boolean;
+        parent_id: string;
+        parent_uid: string;
+        created: number;
+        modified: number;
+        accessed: number;
+        size: number | null;
+        writable: boolean;
+        read(): Promise<Blob>;
+        readdir(): Promise<FSItem[]>;
+    }
+    // Hosting Module
+    interface Hosting {
+        create(subdomain: string, dirPath?: string): Promise<Subdomain>;
+        delete(subdomain: string): Promise<boolean>;
+        get(subdomain: string): Promise<Subdomain>;
+        list(): Promise<Subdomain[]>;
+        update(subdomain: string, dirPath?: string): Promise<Subdomain>;
+    }
+    interface Subdomain {
+        uid: string;
+        subdomain: string;
+        root_dir: FSItem;
+    }
+    // KeyValue Module
+    interface KeyValue {
+        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[]>;
+        flush(): Promise<boolean>;
+    }
+    interface KeyValuePair {
+        key: string;
+        value: any;
+    }
+    // Networking Module
+    interface Networking {
+        fetch(url: string, options?: RequestInit): Promise<Response>;
+        Socket: typeof Socket;
+        tls: {
+            TLSSocket: typeof TLSSocket;
+        };
+    }
+    class Socket {
+        constructor(hostname: string, port: number);
+        write(data: ArrayBuffer | Uint8Array | string): void;
+        close(): void;
+        on(event: 'open', callback: () => void): void;
+        on(event: 'data', callback: (buffer: Uint8Array) => void): void;
+        on(event: 'error', callback: (reason: string) => void): void;
+        on(event: 'close', callback: (hadError: boolean) => void): void;
+    }
+    class TLSSocket extends Socket {
+        constructor(hostname: string, port: number);
+    }
+    // Permissions Module
+    interface Permissions {
+        grantApp(app_uid: string, permissionString: string): Promise<object>;
+        grantAppAnyUser(app_uid: string, permissionString: string): Promise<object>;
+        grantGroup(group_uid: string, permissionString: string): Promise<object>;
+        grantOrigin(origin: string, permissionString: string): Promise<object>;
+        grantUser(username: string, permissionString: string): Promise<object>;
+        revokeApp(app_uid: string, permissionString: string): Promise<object>;
+        revokeAppAnyUser(app_uid: string, permissionString: string): Promise<object>;
+        revokeGroup(group_uid: string, permissionString: string): Promise<object>;
+        revokeOrigin(origin: string, permissionString: string): Promise<object>;
+        revokeUser(username: string, permissionString: string): Promise<object>;
+    }
+    // UI Module
+    interface UI {
+        alert(message?: string, buttons?: AlertButton[]): Promise<string>;
+        prompt(message?: string, defaultValue?: string): Promise<string | null>;
+        authenticateWithPuter(): Promise<boolean>;
+        contextMenu(options: ContextMenuOptions): void;
+        createWindow(options?: WindowOptions): void;
+        exit(statusCode?: number): void;
+        getLanguage(): Promise<string>;
+        hideSpinner(): void;
+        launchApp(appName?: string, args?: object): Promise<AppConnection>;
+        launchApp(options: LaunchAppOptions): Promise<AppConnection>;
+        on(eventName: 'localeChanged', handler: (data: { language: string }) => void): void;
+        on(eventName: 'themeChanged', handler: (data: ThemeData) => void): void;
+        onItemsOpened(handler: (items: FSItem[]) => void): void;
+        onLaunchedWithItems(handler: (items: FSItem[]) => void): void;
+        onWindowClose(handler: () => void): void;
+        parentApp(): AppConnection | null;
+        setMenubar(options: MenubarOptions): void;
+        setWindowHeight(height: number): void;
+        setWindowPosition(x: number, y: number): void;
+        setWindowSize(width: number, height: number): void;
+        setWindowTitle(title: string): void;
+        setWindowWidth(width: number): void;
+        setWindowX(x: number): void;
+        setWindowY(y: number): void;
+        showColorPicker(defaultColor?: string): Promise<string>;
+        showColorPicker(options?: object): Promise<string>;
+        showDirectoryPicker(options?: { multiple?: boolean }): Promise<FSItem | FSItem[]>;
+        showFontPicker(defaultFont?: string): Promise<{ fontFamily: string }>;
+        showFontPicker(options?: object): Promise<{ fontFamily: string }>;
+        showOpenFilePicker(options?: FilePickerOptions): Promise<FSItem | FSItem[]>;
+        showSaveFilePicker(data?: any, defaultFileName?: string): Promise<FSItem>;
+        showSpinner(): void;
+        socialShare(url: string, message?: string, options?: { left?: number; top?: number }): void;
+        wasLaunchedWithItems(): boolean;
+    }
+    interface AlertButton {
+        label: string;
+        value?: string;
+        type?: 'primary' | 'success' | 'info' | 'warning' | 'danger';
+    }
+    interface ContextMenuOptions {
+        items: (ContextMenuItem | '-')[];
+    }
+    interface ContextMenuItem {
+        label: string;
+        action?: () => void;
+        icon?: string;
+        icon_active?: string;
+        disabled?: boolean;
+        items?: (ContextMenuItem | '-')[];
+    }
+    interface WindowOptions {
+        center?: boolean;
+        content?: string;
+        disable_parent_window?: boolean;
+        has_head?: boolean;
+        height?: number;
+        is_resizable?: boolean;
+        show_in_taskbar?: boolean;
+        title?: string;
+        width?: number;
+    }
+    interface LaunchAppOptions {
+        name?: string;
+        args?: object;
+    }
+    interface ThemeData {
+        palette: {
+            primaryHue: number;
+            primarySaturation: string;
+            primaryLightness: string;
+            primaryAlpha: number;
+            primaryColor: string;
+        };
+    }
+    interface MenubarOptions {
+        items: MenuItem[];
+    }
+    interface MenuItem {
+        label: string;
+        action?: () => void;
+        items?: MenuItem[];
+    }
+    interface FilePickerOptions {
+        multiple?: boolean;
+        accept?: string | string[];
+    }
+    interface AppConnection {
+        usesSDK: boolean;
+        on(eventName: 'message', handler: (message: any) => void): void;
+        on(eventName: 'close', handler: (data: { appInstanceID: string }) => void): void;
+        off(eventName: string, handler: Function): void;
+        postMessage(message: any): void;
+        close(): void;
+    }
+    // Workers Module
+    interface Workers {
+        create(workerName: string, filePath: string): Promise<WorkerDeployment>;
+        delete(workerName: string): Promise<boolean>;
+        exec(workerURL: string, options?: WorkerExecOptions): Promise<Response>;
+        get(workerName: string): Promise<WorkerInfo>;
+        list(): Promise<WorkerInfo[]>;
+    }
+    interface WorkerDeployment {
+        success: boolean;
+        url: string;
+        errors: any[];
+    }
+    interface WorkerExecOptions extends RequestInit {
+        method?: string;
+        headers?: object;
+        body?: string | object;
+        cache?: RequestCache;
+        credentials?: RequestCredentials;
+        mode?: RequestMode;
+        redirect?: RequestRedirect;
+        referrer?: string;
+        signal?: AbortSignal;
+    }
+    interface WorkerInfo {
+        name: string;
+        url: string;
+        file_path: string;
+        file_uid: string;
+        created_at: string;
+    }
+}
+declare const puter: Puter.Puter;
+export = Puter;

package/package.json CHANGED Viewed

@@ -1,8 +1,14 @@
 {
     "name": "@heyputer/puter.js",
-    "version": "1.0.1",
+    "version": "2.0.1",
     "description": "Puter.js - A JavaScript library for interacting with Puter services.",
-    "main": "./src/index.js",
+    "main": "src/index.js",
+    "types": "index.d.ts",
+    "typings": "index.d.ts",
+    "files": [
+        "src/index.js",
+        "index.d.ts"
+    ],
     "type": "module",
     "publishConfig": {
         "registry": "https://registry.npmjs.org/"
@@ -11,13 +17,17 @@
         "type": "git",
         "url": "git+https://github.com/HeyPuter/puter.git"
     },
+    "keywords": [
+        "puter",
+        "puter.js",
+        "puterjs"
+    ],
     "scripts": {
         "start-server": "npx http-server --cors -c-1",
         "start-webpack": "webpack && webpack --output-filename puter.dev.js --watch --devtool source-map",
         "start": "concurrently \"npm run start-server\" \"npm run start-webpack\"",
         "build": "webpack && { echo \"// Copyright 2024-present Puter Technologies Inc. All rights reserved.\"; echo \"// Generated on $(date '+%Y-%m-%d %H:%M')\n\"; cat ./dist/puter.js; } > temp && mv temp ./dist/puter.js"
     },
-    "keywords": [],
     "author": "Puter Technologies Inc.",
     "license": "Apache-2.0",
     "devDependencies": {