@abraca/dabra 0.7.0 → 0.9.0

package/dist/index.d.ts

@@ -206,6 +206,7 @@ declare class AbracadabraClient {
     password: string;
     email?: string;
     displayName?: string;
+    inviteCode?: string;
   }): Promise<UserProfile>;
   /**
    * Register a new user with an Ed25519 public key (crypto auth).
@@ -217,6 +218,7 @@ declare class AbracadabraClient {
     deviceName?: string;
     displayName?: string;
     email?: string;
+    inviteCode?: string;
   }): Promise<UserProfile>;
   /** Login with username + password. Auto-persists returned token. */
   login(opts: {
@@ -289,6 +291,18 @@ declare class AbracadabraClient {
   getUpload(docId: string, uploadId: string): Promise<Blob>;
   /** Delete an upload (requires uploader or document Owner). */
   deleteUpload(docId: string, uploadId: string): Promise<void>;
+  /** Create an invite code (requires permission per server config). */
+  createInvite(opts?: {
+    role?: string;
+    maxUses?: number;
+    expiresIn?: number;
+  }): Promise<InviteRow>;
+  /** List invite codes visible to the current user. */
+  listInvites(): Promise<InviteRow[]>;
+  /** Revoke an invite by its code. */
+  revokeInvite(code: string): Promise<void>;
+  /** Redeem an invite code for the currently authenticated user. */
+  redeemInvite(code: string): Promise<void>;
   /** Health check — no auth required. */
   health(): Promise<HealthStatus>;
   /**
@@ -622,7 +636,7 @@ declare enum WebSocketStatus {
   Connected = "connected",
   Disconnected = "disconnected"
 }
-type AuthorizedScope = "read-write" | "readonly";
+type AuthorizedScope = "service" | "admin" | "owner" | "editor" | "viewer" | "read-write" | "readonly";
 interface OutgoingMessageInterface {
   encoder: Encoder;
   type?: MessageType;
@@ -688,7 +702,7 @@ type StatesArray = {
   clientId: number;
   [key: string | number]: any;
 }[];
-type EffectiveRole = "owner" | "editor" | "viewer" | null;
+type EffectiveRole = "service" | "admin" | "owner" | "editor" | "viewer" | null;
 /**
  * Ed25519 identity for passwordless crypto auth.
  *
@@ -717,6 +731,7 @@ interface UserProfile {
   username: string;
   email: string | null;
   displayName: string | null;
+  role: string;
 }
 interface DocumentMeta {
   id: string;
@@ -763,6 +778,16 @@ interface SearchResult {
   /** Number of matching trigrams — higher is better. */
   score: number;
 }
+interface InviteRow {
+  code: string;
+  createdBy: string | null;
+  role: string;
+  maxUses: number;
+  useCount: number;
+  expiresAt: number | null;
+  revoked: boolean;
+  createdAt: number;
+}
 type UploadQueueStatus = "pending" | "uploading" | "done" | "error";
 interface UploadQueueEntry {
   /** Client-generated UUID. */
@@ -1243,4 +1268,4 @@ declare class FileBlobStore extends EventEmitter {
   destroy(): void;
 }
 //#endregion
-export { AbracadabraBaseProvider, AbracadabraBaseProviderConfiguration, AbracadabraClient, AbracadabraClientConfig, AbracadabraOutgoingMessageArguments, AbracadabraProvider, AbracadabraProviderConfiguration, AbracadabraWS, AbracadabraWSConfiguration, AbracadabraWebSocketConn, AuthMessageType, AuthorizedScope, AwarenessError, CloseEvent, CompleteAbracadabraBaseProviderConfiguration, CompleteAbracadabraWSConfiguration, CompleteHocuspocusProviderConfiguration, CompleteHocuspocusProviderWebsocketConfiguration, ConnectionTimeout, Constructable, ConstructableOutgoingMessage, CryptoIdentity, CryptoIdentityKeystore, DocumentCache, type DocumentCacheOptions, DocumentMeta, EffectiveRole, FileBlobStore, Forbidden, HealthStatus, HocusPocusWebSocket, HocuspocusProvider, HocuspocusProviderConfiguration, HocuspocusProviderWebsocket, HocuspocusProviderWebsocketConfiguration, HocuspocusWebSocket, MessageTooBig, MessageType, OfflineStore, OutgoingMessageArguments, OutgoingMessageInterface, PendingSubdoc, PermissionEntry, PublicKeyInfo, ResetConnection, SearchIndex, SearchResult, ServerInfo, StatesArray, SubdocMessage, SubdocRegisteredEvent, Unauthorized, UploadInfo, UploadMeta, UploadQueueEntry, UploadQueueStatus, UserProfile, WebSocketStatus, WsReadyStates, awarenessStatesToArray, onAuthenticatedParameters, onAuthenticationFailedParameters, onAwarenessChangeParameters, onAwarenessUpdateParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onStatusParameters, onSubdocLoadedParameters, onSubdocRegisteredParameters, onSyncedParameters, onUnsyncedChangesParameters, readAuthMessage, writeAuthenticated, writeAuthentication, writePermissionDenied, writeTokenSyncRequest };
+export { AbracadabraBaseProvider, AbracadabraBaseProviderConfiguration, AbracadabraClient, AbracadabraClientConfig, AbracadabraOutgoingMessageArguments, AbracadabraProvider, AbracadabraProviderConfiguration, AbracadabraWS, AbracadabraWSConfiguration, AbracadabraWebSocketConn, AuthMessageType, AuthorizedScope, AwarenessError, CloseEvent, CompleteAbracadabraBaseProviderConfiguration, CompleteAbracadabraWSConfiguration, CompleteHocuspocusProviderConfiguration, CompleteHocuspocusProviderWebsocketConfiguration, ConnectionTimeout, Constructable, ConstructableOutgoingMessage, CryptoIdentity, CryptoIdentityKeystore, DocumentCache, type DocumentCacheOptions, DocumentMeta, EffectiveRole, FileBlobStore, Forbidden, HealthStatus, HocusPocusWebSocket, HocuspocusProvider, HocuspocusProviderConfiguration, HocuspocusProviderWebsocket, HocuspocusProviderWebsocketConfiguration, HocuspocusWebSocket, InviteRow, MessageTooBig, MessageType, OfflineStore, OutgoingMessageArguments, OutgoingMessageInterface, PendingSubdoc, PermissionEntry, PublicKeyInfo, ResetConnection, SearchIndex, SearchResult, ServerInfo, StatesArray, SubdocMessage, SubdocRegisteredEvent, Unauthorized, UploadInfo, UploadMeta, UploadQueueEntry, UploadQueueStatus, UserProfile, WebSocketStatus, WsReadyStates, awarenessStatesToArray, onAuthenticatedParameters, onAuthenticationFailedParameters, onAwarenessChangeParameters, onAwarenessUpdateParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onStatusParameters, onSubdocLoadedParameters, onSubdocRegisteredParameters, onSyncedParameters, onUnsyncedChangesParameters, readAuthMessage, writeAuthenticated, writeAuthentication, writePermissionDenied, writeTokenSyncRequest };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abraca/dabra",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "abracadabra provider",
   "keywords": [
     "abracadabra",

package/src/AbracadabraClient.ts

@@ -7,6 +7,7 @@ import type {
 	PermissionEntry,
 	HealthStatus,
 	ServerInfo,
+	InviteRow,
 } from "./types.ts";
 import type { DocumentCache } from "./DocumentCache.ts";
 
@@ -85,6 +86,7 @@ export class AbracadabraClient {
 		password: string;
 		email?: string;
 		displayName?: string;
+		inviteCode?: string;
 	}): Promise<UserProfile> {
 		return this.request<UserProfile>("POST", "/auth/register", {
 			body: opts,
@@ -102,6 +104,7 @@ export class AbracadabraClient {
 		deviceName?: string;
 		displayName?: string;
 		email?: string;
+		inviteCode?: string;
 	}): Promise<UserProfile> {
 		const username = opts.username ?? `user-${opts.publicKey.slice(0, 8)}`;
 		return this.request<UserProfile>("POST", "/auth/register", {
@@ -111,6 +114,7 @@ export class AbracadabraClient {
 				deviceName: opts.deviceName,
 				displayName: opts.displayName,
 				email: opts.email,
+				inviteCode: opts.inviteCode,
 			},
 			auth: false,
 		});
@@ -368,6 +372,29 @@ export class AbracadabraClient {
 		}
 	}
 
+	// ── Invites ──────────────────────────────────────────────────────────────
+
+	/** Create an invite code (requires permission per server config). */
+	async createInvite(opts?: { role?: string; maxUses?: number; expiresIn?: number }): Promise<InviteRow> {
+		return this.request<InviteRow>("POST", "/invites", { body: opts ?? {} });
+	}
+
+	/** List invite codes visible to the current user. */
+	async listInvites(): Promise<InviteRow[]> {
+		const res = await this.request<{ invites: InviteRow[] }>("GET", "/invites");
+		return res.invites;
+	}
+
+	/** Revoke an invite by its code. */
+	async revokeInvite(code: string): Promise<void> {
+		await this.request("DELETE", `/invites/${encodeURIComponent(code)}`);
+	}
+
+	/** Redeem an invite code for the currently authenticated user. */
+	async redeemInvite(code: string): Promise<void> {
+		await this.request("POST", "/invites/redeem", { body: { code } });
+	}
+
 	// ── System ───────────────────────────────────────────────────────────────
 
 	/** Health check — no auth required. */

package/src/AbracadabraProvider.ts

@@ -208,8 +208,16 @@ export class AbracadabraProvider extends AbracadabraBaseProvider {
 	override authenticatedHandler(scope: string) {
 		super.authenticatedHandler(scope);
 
-		this.effectiveRole =
-			scope === "read-write" ? "editor" : "viewer";
+		const roleMap: Record<string, import("./types.ts").EffectiveRole> = {
+			service: "service",
+			admin: "admin",
+			owner: "owner",
+			editor: "editor",
+			viewer: "viewer",
+			"read-write": "editor",
+			readonly: "viewer",
+		};
+		this.effectiveRole = roleMap[scope] ?? "viewer";
 
 		this.offlineStore?.savePermissionSnapshot(this.effectiveRole);
 	}
@@ -283,7 +291,7 @@ export class AbracadabraProvider extends AbracadabraBaseProvider {
 	}
 
 	get canWrite(): boolean {
-		return this.effectiveRole === "owner" || this.effectiveRole === "editor";
+		return this.effectiveRole != null && this.effectiveRole !== "viewer";
 	}
 
 	/** The AbracadabraClient instance for REST API access, if configured. */

package/src/types.ts

@@ -40,7 +40,7 @@ export enum WebSocketStatus {
   Disconnected = "disconnected",
 }
 
-export type AuthorizedScope = "read-write" | "readonly";
+export type AuthorizedScope = "service" | "admin" | "owner" | "editor" | "viewer" | "read-write" | "readonly";
 
 export interface OutgoingMessageInterface {
   encoder: Encoder;
@@ -128,7 +128,7 @@ export type StatesArray = { clientId: number; [key: string | number]: any }[];
 
 // ── Abracadabra extensions ────────────────────────────────────────────────────
 
-export type EffectiveRole = "owner" | "editor" | "viewer" | null;
+export type EffectiveRole = "service" | "admin" | "owner" | "editor" | "viewer" | null;
 
 /**
  * Ed25519 identity for passwordless crypto auth.
@@ -165,6 +165,7 @@ export interface UserProfile {
   username: string;
   email: string | null;
   displayName: string | null;
+  role: string;
 }
 
 export interface DocumentMeta {
@@ -222,6 +223,19 @@ export interface SearchResult {
   score: number;
 }
 
+// ── Invites ──────────────────────────────────────────────────────────────────
+
+export interface InviteRow {
+  code: string;
+  createdBy: string | null;
+  role: string;
+  maxUses: number;
+  useCount: number;
+  expiresAt: number | null;
+  revoked: boolean;
+  createdAt: number;
+}
+
 // ── Upload queue ─────────────────────────────────────────────────────────────
 
 export type UploadQueueStatus = "pending" | "uploading" | "done" | "error";