{"_id":"@dartroom/fileroom-sdk","_rev":"7-e5d36449ca5167c73caae127522ba5d9","name":"@dartroom/fileroom-sdk","dist-tags":{"latest":"0.1.3-alpha"},"versions":{"0.1.0-alpha":{"name":"@dartroom/fileroom-sdk","version":"0.1.0-alpha","keywords":[],"author":{"name":"Spencer","email":"spencer@dartroom.xyz"},"license":"MIT","_id":"@dartroom/fileroom-sdk@0.1.0-alpha","maintainers":[{"name":"spencer98","email":"spencernajib2@gmail.com"},{"name":"stefdegroot","email":"stefdegrootsdg@gmail.com"}],"homepage":"https://github.com/dartroom/fileroom-sdk#readme","bugs":{"url":"https://github.com/dartroom/fileroom-sdk/issues"},"dist":{"shasum":"51cf098daf04f635d0f7afe9a2c9e29d68910224","tarball":"https://registry.npmjs.org/@dartroom/fileroom-sdk/-/fileroom-sdk-0.1.0-alpha.tgz","fileCount":12,"integrity":"sha512-Nu6L9bjUP7x5fwncZ7dUrHpTAETR3pX2yawkGbdyKHeUekYWlEmPzYW3NPSK/EECFapUZY/I1cguaUavoAeE+A==","signatures":[{"sig":"MEUCIDn10OS4fQ4Lgxkq+SSg2Ar55XqYYogx8XCnnRnY5nV+AiEA8EqOPlwQ3DhjKUD7P0/S/gPvED78SvYEWEpoMfsH7Ik=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":5096507},"main":"dist/index.js","types":"dist/index.d.ts","module":"dist/esm/index.js","browser":"dist/browser/index.js","engines":{"node":">=16.0.0"},"gitHead":"23b8499a548fb87fccbbe81653eec5eedae9f0df","scripts":{"lint":"tsc","test":" jest --verbose ","build":"npm run build:node && npm run build:browser","decrypt":"node ansible-cli.js decrypt .env","encrypt":"node ansible-cli.js encrypt .env","build:dev":"concurrently \"npm run build:node:watch\" \"npm run build:browser:dev\" ","build:node":"tsup src/index.ts --format cjs,esm --dts --clean --sourcemap --treeshake --legacy-output --out-dir dist","test:watch":"jest --watch --verbose","build:browser":"webpack --config webpack.config.js --mode production","build:node:watch":"tsup src/index.ts --format cjs,esm --dts --clean --sourcemap --treeshake --legacy-output --out-dir dist --watch","build:browser:dev":"nodemon -e ts -w src --exec \"webpack --config webpack.config.js --mode development\""},"_npmUser":{"name":"stefdegroot","email":"stefdegrootsdg@gmail.com"},"repository":{"url":"git+https://github.com/dartroom/fileroom-sdk.git","type":"git"},"_npmVersion":"8.19.4","description":"A package to interact with the fileroom-api for both the browser and nodejs.","directories":{"test":"tests"},"_nodeVersion":"16.20.1","dependencies":{"-":"^0.0.1","D":"^1.0.0","url":"^0.11.1","util":"^0.12.5","ee-ts":"^1.0.2","file-type":"^18.5.0","mime-types":"^2.1.35","cross-fetch":"^3.1.6","isomorphic-ws":"^5.0.0","tus-js-client":"^3.1.0","browser-or-node":"^2.1.1","path-browserify":"^1.0.1","crypto-browserify":"^3.12.0","stream-browserify":"^3.0.0","@types/browser-or-node":"^1.3.0"},"_hasShrinkwrap":false,"devDependencies":{"npm":"^9.7.1","jest":"^29.6.2","tsup":"^6.7.0","dotenv":"^16.3.1","install":"^0.13.0","nodemon":"^3.0.1","ts-jest":"^29.1.1","ts-node":"^10.9.1","webpack":"^5.86.0","prettier":"2.8.8","@swc/core":"^1.3.62","cross-env":"^7.0.3","puppeteer":"^20.5.0","swc-loader":"^0.2.3","typescript":"^5.1.6","@types/jest":"^29.5.2","webpack-cli":"^5.1.3","concurrently":"^8.2.0","ansible-vault":"^1.1.0","jest-extended":"^4.0.0","@types/mime-types":"^2.1.1","web-file-polyfill":"^1.0.4"},"_npmOperationalInternal":{"tmp":"tmp/fileroom-sdk_0.1.0-alpha_1692092488367_0.8336808784841485","host":"s3://npm-registry-packages"}},"0.1.1-alpha":{"name":"@dartroom/fileroom-sdk","version":"0.1.1-alpha","keywords":[],"author":{"name":"Spencer","email":"spencer@dartroom.xyz"},"license":"MIT","_id":"@dartroom/fileroom-sdk@0.1.1-alpha","maintainers":[{"name":"spencer98","email":"spencernajib2@gmail.com"},{"name":"stefdegroot","email":"stefdegrootsdg@gmail.com"}],"homepage":"https://github.com/dartroom/fileroom-sdk#readme","bugs":{"url":"https://github.com/dartroom/fileroom-sdk/issues"},"dist":{"shasum":"f8d7f31cde29ef7e1183d5677e0066794ba310b8","tarball":"https://registry.npmjs.org/@dartroom/fileroom-sdk/-/fileroom-sdk-0.1.1-alpha.tgz","fileCount":12,"integrity":"sha512-7VWE8LLAyB45d/vUpqqIxS1ZnJTlDj9WcYwh1lCudIT+eusK1vA3kJezh58IYKXS41eg7IGpnSgs8Zo+2lW0hg==","signatures":[{"sig":"MEUCIH/YCRic/iguDtbcE+r6u/4xB7oNWl2jmt2Zm4Dugvt7AiEAxdf4x4AJbTRWAWh5f4LkCC0dfi6je9ilRERhkFQtYwQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":5096629},"main":"dist/index.js","types":"dist/index.d.ts","module":"dist/esm/index.js","browser":"dist/browser/index.js","engines":{"node":">=16.0.0"},"gitHead":"b1b1789e35605b226f72f0c85b0ff992e82daf0a","scripts":{"lint":"tsc","test":" jest --verbose ","build":"npm run build:node && npm run build:browser","decrypt":"node ansible-cli.js decrypt .env","encrypt":"node ansible-cli.js encrypt .env","build:dev":"concurrently \"npm run build:node:watch\" \"npm run build:browser:dev\" ","build:node":"tsup src/index.ts --format cjs,esm --dts --clean --sourcemap --treeshake --legacy-output --out-dir dist","test:watch":"jest --watch --verbose","build:browser":"webpack --config webpack.config.js --mode production","build:node:watch":"tsup src/index.ts --format cjs,esm --dts --clean --sourcemap --treeshake --legacy-output --out-dir dist --watch","build:browser:dev":"nodemon -e ts -w src --exec \"webpack --config webpack.config.js --mode development\""},"_npmUser":{"name":"spencer98","email":"spencernajib2@gmail.com"},"repository":{"url":"git+https://github.com/dartroom/fileroom-sdk.git","type":"git"},"_npmVersion":"8.19.4","description":"A package to interact with the fileroom-api for both the browser and nodejs.","directories":{"test":"tests"},"_nodeVersion":"16.20.1","dependencies":{"-":"^0.0.1","D":"^1.0.0","url":"^0.11.1","util":"^0.12.5","ee-ts":"^1.0.2","file-type":"^18.5.0","mime-types":"^2.1.35","cross-fetch":"^3.1.6","isomorphic-ws":"^5.0.0","tus-js-client":"^3.1.0","browser-or-node":"^2.1.1","path-browserify":"^1.0.1","crypto-browserify":"^3.12.0","stream-browserify":"^3.0.0","@types/browser-or-node":"^1.3.0"},"_hasShrinkwrap":false,"devDependencies":{"npm":"^9.7.1","jest":"^29.6.2","tsup":"^6.7.0","dotenv":"^16.3.1","install":"^0.13.0","nodemon":"^3.0.1","ts-jest":"^29.1.1","ts-node":"^10.9.1","webpack":"^5.86.0","prettier":"2.8.8","@swc/core":"^1.3.62","cross-env":"^7.0.3","puppeteer":"^20.5.0","swc-loader":"^0.2.3","typescript":"^5.1.6","@types/jest":"^29.5.2","webpack-cli":"^5.1.3","concurrently":"^8.2.0","ansible-vault":"^1.1.0","jest-extended":"^4.0.0","@types/mime-types":"^2.1.1","web-file-polyfill":"^1.0.4"},"_npmOperationalInternal":{"tmp":"tmp/fileroom-sdk_0.1.1-alpha_1692105191543_0.2620608541249376","host":"s3://npm-registry-packages"}},"0.1.2-alpha":{"name":"@dartroom/fileroom-sdk","version":"0.1.2-alpha","keywords":[],"author":{"name":"Spencer","email":"spencer@dartroom.xyz"},"license":"MIT","_id":"@dartroom/fileroom-sdk@0.1.2-alpha","maintainers":[{"name":"spencer98","email":"spencernajib2@gmail.com"},{"name":"stefdegroot","email":"stefdegrootsdg@gmail.com"}],"homepage":"https://github.com/dartroom/fileroom-sdk#readme","bugs":{"url":"https://github.com/dartroom/fileroom-sdk/issues"},"dist":{"shasum":"1a89256a494baf9fc203b0e9580c821a6683b58a","tarball":"https://registry.npmjs.org/@dartroom/fileroom-sdk/-/fileroom-sdk-0.1.2-alpha.tgz","fileCount":12,"integrity":"sha512-CeFvSGJXUB2YrFDhJzCB0wSMBTDxinXhNSO6D/mLWuyyw0Ki4+/cPQ+DHCG7YtjvMKXXEoKtxVSMhBDB6uO0GA==","signatures":[{"sig":"MEQCIF01p3LIlP65G2IE8xZRCuLy9UGbpHfGnMqgHIpkDcWiAiAnDqGs17a9IkHV7PmbPDGlXLcAbN8+ECIsk8QcxT+z7A==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":5888805},"main":"dist/index.js","types":"dist/index.d.ts","module":"dist/esm/index.js","browser":"dist/browser/index.js","engines":{"node":">=16.0.0"},"gitHead":"4a5dc27a6022b02c0ec90ceeab197b984ad6265c","scripts":{"lint":"tsc","test":" jest --verbose ","build":"npm run build:node && npm run build:browser","decrypt":"node ansible-cli.js decrypt .env","encrypt":"node ansible-cli.js encrypt .env","build:dev":"concurrently \"npm run build:node:watch\" \"npm run build:browser:dev\" ","build:node":"tsup src/index.ts --format cjs,esm --dts --clean --sourcemap --treeshake --legacy-output --out-dir dist","test:watch":"jest --watch --verbose","build:browser":"webpack --config webpack.config.js --mode production","build:node:watch":"tsup src/index.ts --format cjs,esm --dts --clean --sourcemap --treeshake --legacy-output --out-dir dist --watch","build:browser:dev":"nodemon -e ts -w src --exec \"webpack --config webpack.config.js --mode development\""},"_npmUser":{"name":"spencer98","email":"spencernajib2@gmail.com"},"repository":{"url":"git+https://github.com/dartroom/fileroom-sdk.git","type":"git"},"_npmVersion":"8.19.4","description":"A package to interact with the fileroom-api for both the browser and nodejs.","directories":{"test":"tests"},"_nodeVersion":"16.20.1","dependencies":{"-":"^0.0.1","D":"^1.0.0","url":"^0.11.1","util":"^0.12.5","ee-ts":"^1.0.2","file-type":"^18.5.0","mime-types":"^2.1.35","cross-fetch":"^3.1.6","isomorphic-ws":"^5.0.0","tus-js-client":"^3.1.0","browser-or-node":"^2.1.1","path-browserify":"^1.0.1","crypto-browserify":"^3.12.0","stream-browserify":"^3.0.0","@types/browser-or-node":"^1.3.0"},"_hasShrinkwrap":false,"devDependencies":{"npm":"^9.7.1","jest":"^29.6.2","tsup":"^6.7.0","dotenv":"^16.3.1","install":"^0.13.0","nodemon":"^3.0.1","ts-jest":"^29.1.1","ts-node":"^10.9.1","webpack":"^5.86.0","prettier":"2.8.8","@swc/core":"^1.3.62","cross-env":"^7.0.3","puppeteer":"^20.5.0","swc-loader":"^0.2.3","typescript":"^5.1.6","@types/jest":"^29.5.2","webpack-cli":"^5.1.3","concurrently":"^8.2.0","ansible-vault":"^1.1.0","jest-extended":"^4.0.0","@types/mime-types":"^2.1.1","web-file-polyfill":"^1.0.4"},"_npmOperationalInternal":{"tmp":"tmp/fileroom-sdk_0.1.2-alpha_1692225747364_0.5597389088836802","host":"s3://npm-registry-packages"}},"0.1.3-alpha":{"name":"@dartroom/fileroom-sdk","version":"0.1.3-alpha","keywords":[],"author":{"name":"Spencer","email":"spencer@dartroom.xyz"},"license":"MIT","_id":"@dartroom/fileroom-sdk@0.1.3-alpha","maintainers":[{"name":"spencer98","email":"spencernajib2@gmail.com"},{"name":"stefdegroot","email":"stefdegrootsdg@gmail.com"}],"homepage":"https://github.com/dartroom/fileroom-sdk#readme","bugs":{"url":"https://github.com/dartroom/fileroom-sdk/issues"},"dist":{"shasum":"4dd610bac31bb640c4d9fc625bd3d3b8ba1063b1","tarball":"https://registry.npmjs.org/@dartroom/fileroom-sdk/-/fileroom-sdk-0.1.3-alpha.tgz","fileCount":12,"integrity":"sha512-VUc0mWuWv94hoRnokmIKYj5HrpmTszPGQYJTFedtsPElEUiYfyfnDiRKjGsflU8+B0atuKeEOauHDGWvbgizNQ==","signatures":[{"sig":"MEYCIQDapnFkkXgEjnoU8nTpjY1niYvRvlTKE4ivAusHICdU/gIhAJlugoWYSEhYc7rEJzo+lV/kXKW7My79IB5Olj5ZzHtg","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":5123539},"main":"dist/index.js","types":"dist/index.d.ts","module":"dist/esm/index.js","browser":"dist/browser/index.js","engines":{"node":">=16.0.0"},"gitHead":"1becc8f660d8fd4414f9248bd3613d08fb56b833","scripts":{"lint":"tsc","test":" jest --verbose ","build":"npm run build:node && npm run build:browser","decrypt":"node ansible-cli.js decrypt .env","encrypt":"node ansible-cli.js encrypt .env","build:dev":"concurrently \"npm run build:node:watch\" \"npm run build:browser:dev\" ","build:node":"tsup src/index.ts --format cjs,esm --dts --clean --sourcemap --treeshake --legacy-output --out-dir dist","test:watch":"jest --watch --verbose","build:browser":"webpack --config webpack.config.js --mode production","build:node:watch":"tsup src/index.ts --format cjs,esm --dts --clean --sourcemap --treeshake --legacy-output --out-dir dist --watch","build:browser:dev":"nodemon -e ts -w src --exec \"webpack --config webpack.config.js --mode development\""},"_npmUser":{"name":"spencer98","email":"spencernajib2@gmail.com"},"repository":{"url":"git+https://github.com/dartroom/fileroom-sdk.git","type":"git"},"_npmVersion":"8.19.4","description":"A package to interact with the fileroom-api for both the browser and nodejs.","directories":{"test":"tests"},"_nodeVersion":"16.20.2","dependencies":{"-":"^0.0.1","D":"^1.0.0","url":"^0.11.1","util":"^0.12.5","ee-ts":"^1.0.2","file-type":"^18.5.0","mime-types":"^2.1.35","cross-fetch":"^3.1.6","isomorphic-ws":"^5.0.0","tus-js-client":"^3.1.0","browser-or-node":"^2.1.1","path-browserify":"^1.0.1","crypto-browserify":"^3.12.0","stream-browserify":"^3.0.0","@types/browser-or-node":"^1.3.0"},"_hasShrinkwrap":false,"devDependencies":{"npm":"^9.7.1","jest":"^29.6.2","tsup":"^6.7.0","dotenv":"^16.3.1","install":"^0.13.0","nodemon":"^3.0.1","ts-jest":"^29.1.1","ts-node":"^10.9.1","webpack":"^5.86.0","prettier":"2.8.8","@swc/core":"^1.3.62","cross-env":"^7.0.3","puppeteer":"^20.5.0","swc-loader":"^0.2.3","typescript":"^5.1.6","@types/jest":"^29.5.2","webpack-cli":"^5.1.3","concurrently":"^8.2.0","ansible-vault":"^1.1.0","jest-extended":"^4.0.0","@types/mime-types":"^2.1.1","web-file-polyfill":"^1.0.4"},"_npmOperationalInternal":{"tmp":"tmp/fileroom-sdk_0.1.3-alpha_1693914230111_0.23114850119403885","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-08-15T09:41:28.268Z","modified":"2025-03-28T19:43:39.713Z","0.1.0-alpha":"2023-08-15T09:41:28.642Z","0.1.1-alpha":"2023-08-15T13:13:11.916Z","0.1.2-alpha":"2023-08-16T22:42:27.588Z","0.1.3-alpha":"2023-09-05T11:43:50.433Z"},"bugs":{"url":"https://github.com/dartroom/fileroom-sdk/issues"},"author":{"name":"Spencer","email":"spencer@dartroom.xyz"},"license":"MIT","homepage":"https://github.com/dartroom/fileroom-sdk#readme","keywords":[],"repository":{"url":"git+https://github.com/dartroom/fileroom-sdk.git","type":"git"},"description":"A package to interact with the fileroom-api for both the browser and nodejs.","maintainers":[{"email":"allandiamantedesouza@gmail.com","name":"allandiamante"}],"readme":"# fileroom-sdk\n[](https://badge.fury.io/js/@dartroom%2Ffileroom-sdk)\n[](https://github.com/Dartroom/fileroom-sdk/actions/workflows/main.yml)\n[](https://github.com/Dartroom/fileroom-sdk/actions/workflows/publish.yml)\n[](https://codecov.io/gh/Dartroom/fileroom-sdk)\n[](https://opensource.org/licenses/MIT)\n\nA package to interact with the fileroom-api for both the browser and nodejs.\n\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [ Basic Usage](#usage)\n- [SDK Reference](#sdk-reference)\n- [Tests](#tests)\n- [License](#license)\n\n## Requirements\n\nUse of this SDK requires the following:\n\n- Node.js 16 or higher\n- Chrome 89 or higher, firefox 87 or higher, or safari 14 or higher\n\n## Installation\n\n### nodejs\n\n```sh\n npm install @dartroom/fileroom-sdk\n#or\n yarn add @dartroom/fileroom-sdk\n#or\n pnpm add @dartroom/fileroom-sdk\n```\n\n### browser\n\n```html\n\n```\n\n```javascript\n// with a CDN, the SDK is available on the window object\nconst { Client } = Fileroom; // window.Fileroom\nlet client = new Client({\n accessToken: '',\n});\n```\n\n### Usage\n\n**Commonjs with promises**\n\n```js\nconst { Client } = require('@dartroom/fileroom-sdk');\n\nconst client = new Client({\n accessToken: 'your token', // optional\n});\n// import the ipfs and user api\nlet { ipfs, user } = client;\n\nuser\n .login({ username: 'username', password: 'password' })\n .then(res => {\n // do something with the response\n console.log(res);\n })\n .catch(err => {\n console.log(err);\n });\n```\n\n**ES modules or Typescript with async/await**\n\n```typescript\nimport { Client } from '@dartroom/fileroom-sdk';\n\nconst client = new Client({\n accessToken: 'your token', // optional\n});\n\n// import the ipfs and user api\nlet { ipfs, user } = client;\n\ntry {\n let res = await user.login({ username: 'username', password: 'password' });\n // do something with the response\n console.log(res);\n} catch (err) {\n console.log(err);\n}\n```\n\n## SDK Reference\n\n- [Client]\n- [UserAPI]\n- [IpfsAPI]\n- [FilesAPI]\n\n## Tests\n\nFirst, clone the repo locally and cd into the directory\n\n```sh\ngit clone https//github.com/dartroom/fileroom-sdk.git\ncd fileroom-sdk\n```\n\nNext, create a .env file, and add the following environment variables\n\n```sh\n#credentials for test Fileroom Dev User\nTEST_DEV_USERNAME='your test fileroom dev username' ## this can be a random username\nTEST_DEV_PASSWORD= 'your test fileroom dev password' ## this can be a random password\nTEST_DEV_API_KEY='any active api key for the test fileroom dev user'\n\n# fileroom Environment\nFILEROOM_ENV='test | production| beta'\nTEST_FILECID= \"your test file cid\"\n\n```\n\n**Note:** Setting the FIREROOM_ENV to 'test' will run the tests against the a locally run fileroom instance, If this variable is not set, the tests will default to the fileroom production environment.\n\nFinally, run the tests.\n\n```sh\n npm test\n # run tests in watch mode\n npm run test:watch\n```\n\n## License\n\nMIT License (MIT), see [LICENSE](LICENSE).\n\n[client]: docs/client.md\n[userapi]: docs/user.md\n[ipfsapi]: docs/ipfs.md\n[filesapi]: docs/files.md\n","readmeFilename":"README.md"}