@abraca/dabra 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -227,6 +227,8 @@ declare class AbracadabraClient {
   createChild(docId: string, opts?: {
     child_id?: string;
   }): Promise<DocumentMeta>;
+  /** List all permissions for a document (requires read access). */
+  listPermissions(docId: string): Promise<PermissionEntry[]>;
   /** Grant or change a user's role on a document (requires Owner). */
   setPermission(docId: string, opts: {
     user_id: string;
@@ -648,6 +650,12 @@ interface PublicKeyInfo {
   deviceName: string | null;
   revoked: boolean;
 }
+interface PermissionEntry {
+  user_id: string;
+  role: "owner" | "editor" | "viewer" | "observer";
+  username: string;
+  display_name: string | null;
+}
 interface HealthStatus {
   status: string;
   version: string;
@@ -1020,4 +1028,4 @@ declare class CryptoIdentityKeystore {
   clear(): Promise<void>;
 }
 //#endregion
-export { AbracadabraClient, AbracadabraClientConfig, AbracadabraOutgoingMessageArguments, AbracadabraProvider, AbracadabraProviderConfiguration, AuthorizedScope, AwarenessError, CompleteHocuspocusProviderConfiguration, CompleteHocuspocusProviderWebsocketConfiguration, Constructable, ConstructableOutgoingMessage, CryptoIdentity, CryptoIdentityKeystore, DocumentMeta, EffectiveRole, HealthStatus, HocusPocusWebSocket, HocuspocusProvider, HocuspocusProviderConfiguration, HocuspocusProviderWebsocket, HocuspocusProviderWebsocketConfiguration, HocuspocusWebSocket, MessageType, OfflineStore, OutgoingMessageArguments, OutgoingMessageInterface, PendingSubdoc, PublicKeyInfo, StatesArray, SubdocMessage, SubdocRegisteredEvent, UploadInfo, UploadMeta, UserProfile, WebSocketStatus, onAuthenticatedParameters, onAuthenticationFailedParameters, onAwarenessChangeParameters, onAwarenessUpdateParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onStatusParameters, onSubdocLoadedParameters, onSubdocRegisteredParameters, onSyncedParameters, onUnsyncedChangesParameters };
+export { AbracadabraClient, AbracadabraClientConfig, AbracadabraOutgoingMessageArguments, AbracadabraProvider, AbracadabraProviderConfiguration, AuthorizedScope, AwarenessError, CompleteHocuspocusProviderConfiguration, CompleteHocuspocusProviderWebsocketConfiguration, Constructable, ConstructableOutgoingMessage, CryptoIdentity, CryptoIdentityKeystore, DocumentMeta, EffectiveRole, HealthStatus, HocusPocusWebSocket, HocuspocusProvider, HocuspocusProviderConfiguration, HocuspocusProviderWebsocket, HocuspocusProviderWebsocketConfiguration, HocuspocusWebSocket, MessageType, OfflineStore, OutgoingMessageArguments, OutgoingMessageInterface, PendingSubdoc, PermissionEntry, PublicKeyInfo, StatesArray, SubdocMessage, SubdocRegisteredEvent, UploadInfo, UploadMeta, UserProfile, WebSocketStatus, onAuthenticatedParameters, onAuthenticationFailedParameters, onAwarenessChangeParameters, onAwarenessUpdateParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onStatusParameters, onSubdocLoadedParameters, onSubdocRegisteredParameters, onSyncedParameters, onUnsyncedChangesParameters };

package/package.json

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

package/src/AbracadabraClient.ts

@@ -4,6 +4,7 @@ import type {
 	UploadMeta,
 	UploadInfo,
 	PublicKeyInfo,
+	PermissionEntry,
 	HealthStatus,
 } from "./types.ts";
 
@@ -219,6 +220,15 @@ export class AbracadabraClient {
 
 	// ── Permissions ──────────────────────────────────────────────────────────
 
+	/** List all permissions for a document (requires read access). */
+	async listPermissions(docId: string): Promise<PermissionEntry[]> {
+		const res = await this.request<{ permissions: PermissionEntry[] }>(
+			"GET",
+			`/docs/${encodeURIComponent(docId)}/permissions`,
+		);
+		return res.permissions;
+	}
+
 	/** Grant or change a user's role on a document (requires Owner). */
 	async setPermission(
 		docId: string,

package/src/types.ts

@@ -181,6 +181,13 @@ export interface PublicKeyInfo {
   revoked: boolean;
 }
 
+export interface PermissionEntry {
+  user_id: string;
+  role: "owner" | "editor" | "viewer" | "observer";
+  username: string;
+  display_name: string | null;
+}
+
 export interface HealthStatus {
   status: string;
   version: string;