own-auth 0.1.4 → 0.1.6

package/README.md

@@ -33,7 +33,6 @@ export const auth = createOwnAuth({
 
 ```bash
 psql "$DATABASE_URL" -f node_modules/own-auth/migrations/001_initial.sql
-psql "$DATABASE_URL" -f node_modules/own-auth/migrations/002_hosted_projects.sql
 ```
 
 ## Basic Usage
@@ -51,11 +50,157 @@ const session = await auth.getCurrentSession(sessionToken);
 await auth.signOut(sessionToken);
 ```
 
+## Common Methods
+
+Sign in:
+
+```ts
+const login = await auth.signInEmailPassword({
+  email: "founder@example.com",
+  password: "correct-horse"
+});
+```
+
+Create a user directly:
+
+```ts
+const user = await auth.createUser({
+  email: "teammate@example.com",
+  name: "Teammate"
+});
+```
+
+Sessions:
+
+```ts
+const current = await auth.requireCurrentSession(sessionToken);
+
+await auth.revokeAllSessions(current.user.id);
+```
+
+Magic links:
+
+```ts
+await auth.requestMagicLink({ email: "founder@example.com" });
+
+const magicLogin = await auth.verifyMagicLink({ token });
+```
+
+Email verification:
+
+```ts
+await auth.requestEmailVerification({ email: "founder@example.com" });
+
+const verifiedUser = await auth.verifyEmail({ token });
+```
+
+Password reset:
+
+```ts
+await auth.requestPasswordReset({ email: "founder@example.com" });
+
+await auth.resetPassword({
+  token,
+  newPassword: "new-correct-horse"
+});
+```
+
+SMS OTP:
+
+```ts
+await auth.requestSmsOtp({ phone: "+15551234567" });
+
+const phoneLogin = await auth.verifySmsOtp({
+  phone: "+15551234567",
+  code: "123456"
+});
+```
+
+Organisations and invites:
+
+```ts
+const { organisation } = await auth.createOrganisation({
+  name: "Acme",
+  ownerUserId: user.id
+});
+
+await auth.updateOrganisation(organisation.id, {
+  actorUserId: user.id,
+  name: "Acme Inc"
+});
+
+await auth.inviteMember({
+  organisationId: organisation.id,
+  email: "teammate@example.com",
+  invitedByUserId: user.id,
+  role: "member"
+});
+
+await auth.acceptInvitation({ token: invitationToken });
+
+await auth.changeMemberRole({
+  organisationId: organisation.id,
+  memberId,
+  actorUserId: user.id,
+  role: "admin"
+});
+
+await auth.removeMember({
+  organisationId: organisation.id,
+  memberId,
+  actorUserId: user.id
+});
+```
+
+API keys and permissions:
+
+```ts
+const createdKey = await auth.createApiKey({
+  name: "Production key",
+  organisationId: organisation.id,
+  actorUserId: user.id,
+  scopes: ["users:read"]
+});
+
+const verifiedKey = await auth.verifyApiKey(createdKey.rawKey, ["users:read"]);
+
+await auth.revokeApiKey(createdKey.apiKey.keyPrefix, user.id);
+
+const canManageKeys = await auth.checkPermission(
+  organisation.id,
+  user.id,
+  "manage_api_keys"
+);
+
+await auth.requirePermission(organisation.id, user.id, "manage_api_keys");
+```
+
+Audit events:
+
+```ts
+const events = await auth.listAuditEvents({
+  organisationId: organisation.id
+});
+```
+
+## Method Index
+
+- Users: `createUser`, `signUpEmailPassword`, `signInEmailPassword`
+- Sessions: `getCurrentSession`, `requireCurrentSession`, `signOut`, `revokeAllSessions`
+- Magic links: `requestMagicLink`, `verifyMagicLink`
+- Email verification: `requestEmailVerification`, `verifyEmail`
+- Password reset: `requestPasswordReset`, `resetPassword`
+- SMS OTP: `requestSmsOtp`, `verifySmsOtp`
+- API keys: `createApiKey`, `verifyApiKey`, `revokeApiKey`
+- Organisations: `createOrganisation`, `updateOrganisation`
+- Members and invites: `inviteMember`, `acceptInvitation`, `changeMemberRole`, `removeMember`
+- Permissions: `checkPermission`, `requirePermission`
+- Audit logs: `listAuditEvents`
+
 ## Exports
 
 - `own-auth`: auth engine, providers, types, test storage
 - `own-auth/migrations/001_initial.sql`: core auth tables
-- `own-auth/migrations/002_hosted_projects.sql`: hosted project tables
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "own-auth",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "type": "module",
   "description": "Framework-independent TypeScript auth engine with Postgres storage.",
   "license": "MIT",