@appbase-pfe/sdk

JavaScript/TypeScript SDK for AppBase.

Install (npm)

Use the public npm registry. The scope @appbase must exist on npm for your organization (see ADR-007); if you publish under a different scope, replace it in install commands and imports.

npm install @appbase-pfe/sdk

@appbase-pfe/sdk depends on @appbase-pfe/types at a compatible semver range; npm installs both.

HTTP contract: docs/API-SPEC.md.

Quick start

import { AppBase } from "@appbase-pfe/sdk";

const appbase = AppBase.init({
  endpoint: "http://localhost:3000",
  apiKey: "hs_live_your_key",
  sessionStorageKey: "my_app_session",
});

const { signIn, signOut, signUp, getAuthState } = appbase.auth;
const { authenticated, user } = getAuthState();

const todos = appbase.db.collection("todos");
const { items } = await todos.list();

React (optional)

react is an optional peer dependency. Use the subpath when you need hooks / provider:

import { AppBaseProvider, useAppBase, useAuth } from "@appbase-pfe/sdk/react";

Install react in your app (>=18).

Services

| Service | Status | |---------|--------| | appbase.auth | Auth docs | | appbase.db | Database docs | | appbase.storage | Storage docs |

Publishing / monorepo

Maintainers: see docs/PUBLISHING-SDK.md.