{"_id":"@appbase-pfe/sdk","name":"@appbase-pfe/sdk","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@appbase-pfe/sdk","version":"0.1.0","description":"JavaScript/TypeScript client for AppBase — auth, database, and storage APIs.","type":"module","main":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","default":"./dist/index.js"},"./react":{"types":"./dist/react.d.ts","import":"./dist/react.js","default":"./dist/react.js"}},"sideEffects":false,"engines":{"node":">=18"},"license":"MIT","author":{"name":"Nabil Mouzouna"},"repository":{"type":"git","url":"git+https://github.com/NabilMouzouna/NubleCloud-PFE.git","directory":"packages/sdk"},"bugs":{"url":"https://github.com/NabilMouzouna/NubleCloud-PFE/issues"},"homepage":"https://github.com/NabilMouzouna/NubleCloud-PFE/tree/main/packages/sdk#readme","keywords":["appbase","baas","sdk","client","auth"],"publishConfig":{"access":"public"},"dependencies":{"@appbase-pfe/types":"^0.1.0","zod":"^3.24.0"},"peerDependencies":{"react":">=18.0.0"},"peerDependenciesMeta":{"react":{"optional":true}},"devDependencies":{"@types/node":"^22.13.14","@types/react":"^19.0.0","react":"^19.0.0","rimraf":"^6.0.1","typescript":"5.9.2","vitest":"^3.0.9","@appbase/config":"0.0.1"},"scripts":{"build":"rimraf dist && tsc -p tsconfig.build.json","check-types":"tsc --noEmit -p tsconfig.json","dev":"tsc -p tsconfig.build.json --watch","test":"vitest run"},"_id":"@appbase-pfe/sdk@0.1.0","_integrity":"sha512-Xp1HTpGmalvx0vnF2sx+UTyp7WOAl1Ok7vaBhzvyhYeqt92w10Cr+5KSDq6SLKqMjbDYwM0e8eB//swuv9pzcw==","_resolved":"/private/var/folders/pd/1htj78052hg_vq9c0g8j456r0000gn/T/8b1eac0bbb11d2473797bf1b55e8ccf6/appbase-pfe-sdk-0.1.0.tgz","_from":"file:appbase-pfe-sdk-0.1.0.tgz","_nodeVersion":"20.20.0","_npmVersion":"10.8.2","dist":{"integrity":"sha512-Xp1HTpGmalvx0vnF2sx+UTyp7WOAl1Ok7vaBhzvyhYeqt92w10Cr+5KSDq6SLKqMjbDYwM0e8eB//swuv9pzcw==","shasum":"08475144600ddec6b906800f5a5972a7c270bb87","tarball":"https://registry.npmjs.org/@appbase-pfe/sdk/-/sdk-0.1.0.tgz","fileCount":28,"unpackedSize":76172,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIHDtdq/onZmVL5UnXKlDyKB10lpG5QR7k0OUa6XSFZxqAiAetWfhlo/cgEwmoKQzJoxV2HNsgPtcBgw6YJENgxogjA=="}]},"_npmUser":{"name":"nabil_mouzouna","email":"nabilmouzouna2001@gmail.com"},"directories":{},"maintainers":[{"name":"nabil_mouzouna","email":"nabilmouzouna2001@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/sdk_0.1.0_1774798516703_0.7692363025556479"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-29T15:35:16.639Z","0.1.0":"2026-03-29T15:35:16.855Z","modified":"2026-03-29T15:35:17.109Z"},"maintainers":[{"name":"nabil_mouzouna","email":"nabilmouzouna2001@gmail.com"}],"description":"JavaScript/TypeScript client for AppBase — auth, database, and storage APIs.","homepage":"https://github.com/NabilMouzouna/NubleCloud-PFE/tree/main/packages/sdk#readme","keywords":["appbase","baas","sdk","client","auth"],"repository":{"type":"git","url":"git+https://github.com/NabilMouzouna/NubleCloud-PFE.git","directory":"packages/sdk"},"author":{"name":"Nabil Mouzouna"},"bugs":{"url":"https://github.com/NabilMouzouna/NubleCloud-PFE/issues"},"license":"MIT","readme":"# @appbase-pfe/sdk\n\nJavaScript/TypeScript SDK for [AppBase](https://github.com/NabilMouzouna/NubleCloud-PFE).\n\n## Install (npm)\n\nUse the public npm registry. The scope **`@appbase`** must exist on npm for your organization (see [ADR-007](../../docs/adr/ADR-007-sdk-package-distribution.md)); if you publish under a different scope, replace it in install commands and imports.\n\n```bash\nnpm install @appbase-pfe/sdk\n```\n\n`@appbase-pfe/sdk` depends on **`@appbase-pfe/types`** at a compatible semver range; npm installs both.\n\n**HTTP contract:** [`docs/API-SPEC.md`](../../docs/API-SPEC.md).\n\n## Quick start\n\n```ts\nimport { AppBase } from \"@appbase-pfe/sdk\";\n\nconst appbase = AppBase.init({\n  endpoint: \"http://localhost:3000\",\n  apiKey: \"hs_live_your_key\",\n  sessionStorageKey: \"my_app_session\",\n});\n\nconst { signIn, signOut, signUp, getAuthState } = appbase.auth;\nconst { authenticated, user } = getAuthState();\n\nconst todos = appbase.db.collection(\"todos\");\nconst { items } = await todos.list();\n```\n\n## React (optional)\n\n`react` is an **optional** peer dependency. Use the subpath when you need hooks / provider:\n\n```tsx\nimport { AppBaseProvider, useAppBase, useAuth } from \"@appbase-pfe/sdk/react\";\n```\n\nInstall `react` in your app (`>=18`).\n\n## Services\n\n| Service | Status |\n|---------|--------|\n| **`appbase.auth`** | [Auth docs](./docs/auth-service.md) |\n| **`appbase.db`** | [Database docs](./docs/db-service.md) |\n| **`appbase.storage`** | [Storage docs](./docs/storage-service.md) |\n\n## Publishing / monorepo\n\nMaintainers: see [`docs/PUBLISHING-SDK.md`](../../docs/PUBLISHING-SDK.md).\n","readmeFilename":"README.md","_rev":"1-cc5b16340aecaa73bb08a1b47ae1ecd2"}