diff --git a/src/puter-js/README.md b/src/puter-js/README.md index 8167449c..8d018d57 100644 --- a/src/puter-js/README.md +++ b/src/puter-js/README.md @@ -12,16 +12,37 @@ npm install @heyputer/puter.js ### Importing +### Node.js (with Auth Token) + +```js +const {init} = require("@heyputer/puter.js/src/init.cjs"); // NODE JS ONLY +// or +import {init} from "@heyputer/puter.js/src/init.cjs"; + +const puter = init(process.env.puterAuthToken); // uses your auth token +const puter2 = init(process.env.puterAuthToken2); // use some other auth token +``` + +### Browser (without Auth Token) + #### ES Modules ```js -import '@heyputer/puter.js'; +import {puter} from '@heyputer/puter.js'; +// or +import puter from '@heyputer/puter.js'; +// or +import '@heyputer/puter.js'; // puter will be available globally ``` #### CommonJS ```js +const {puter} = require('@heyputer/puter.js'); +// or const puter = require('@heyputer/puter.js'); +// or +require('@heyputer/puter.js'); // puter will be available globally ``` #### CDN diff --git a/src/puter-js/package.json b/src/puter-js/package.json index 61d07107..1893c1e9 100644 --- a/src/puter-js/package.json +++ b/src/puter-js/package.json @@ -1,6 +1,6 @@ { "name": "@heyputer/puter.js", - "version": "2.0.9", + "version": "2.0.11", "description": "Puter.js - A JavaScript library for interacting with Puter services.", "main": "src/index.js", "types": "index.d.ts", diff --git a/src/puter-js/src/safeLoadPuter.cjs b/src/puter-js/src/init.cjs similarity index 77% rename from src/puter-js/src/safeLoadPuter.cjs rename to src/puter-js/src/init.cjs index 5065c8ee..fa081263 100644 --- a/src/puter-js/src/safeLoadPuter.cjs +++ b/src/puter-js/src/init.cjs @@ -2,11 +2,11 @@ const { readFileSync } = require('node:fs'); const vm = require('node:vm'); const { resolve } = require('node:path'); /** - * Method for loading puter.js in Node.js environment + * Method for loading puter.js in Node.js environment with auth token * @param {string} authToken - Optional auth token to initialize puter with - * @returns {Promise} The `puter` object from puter.js + * @returns {import('../index').puter} The `puter` object from puter.js */ -const safeLoadPuterJs = (authToken) => { +const init = (authToken) => { const goodContext = {}; Object.getOwnPropertyNames(globalThis).forEach(name => { try { @@ -25,4 +25,4 @@ const safeLoadPuterJs = (authToken) => { return goodContext.puter; }; -module.exports = { safeLoadPuterJs }; \ No newline at end of file +module.exports = { init }; \ No newline at end of file