@rgby/collab-vue 1.0.1

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useCollab.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './useCollab.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA"}

package/dist/useCollab.d.ts

@@ -0,0 +1,216 @@
+import { type InjectionKey, type Ref, type ShallowRef, type ComputedRef } from 'vue';
+import * as Y from 'yjs';
+import { CollabClient, CollabProvider, type CollabClientOptions, type SessionData } from '@rgby/collab-core';
+import type { Editor, EditorOptions } from '@tiptap/core';
+export declare const CollabClientKey: InjectionKey<CollabClient>;
+export declare function provideCollabClient(optionsOrInstance: CollabClientOptions | CollabClient): CollabClient;
+export declare function useCollabClient(): CollabClient;
+export interface UseDocumentReturn {
+    doc: ShallowRef<Y.Doc>;
+    provider: ShallowRef<CollabProvider | null>;
+    status: Ref<'disconnected' | 'connecting' | 'connected'>;
+    synced: Ref<boolean>;
+    persistenceReady: Ref<boolean>;
+    undoManager: ShallowRef<Y.UndoManager | null>;
+    connect: () => void;
+    disconnect: () => void;
+    transact: (callback: (txn: Y.Transaction) => void) => void;
+    undo: () => void;
+    redo: () => void;
+    clearLocalData: () => Promise<void>;
+}
+export declare function useDocument(spaceId: string, documentId: string): UseDocumentReturn;
+export declare function useSyncedMap<T = any>(doc: ShallowRef<Y.Doc>, mapName: string): {
+    data: Record<string, T>;
+    set: (key: string, value: T) => T | undefined;
+    remove: (key: string) => void | undefined;
+    clear: () => void | undefined;
+    get: (key: string) => T | undefined;
+    yMap: ComputedRef<Y.Map<T> | null>;
+};
+export declare function useSyncedArray<T = any>(doc: ShallowRef<Y.Doc>, arrayName: string): {
+    list: Ref<T[], T[]>;
+    push: (item: T) => void | undefined;
+    unshift: (item: T) => void | undefined;
+    insert: (index: number, items: T[]) => void | undefined;
+    deleteAt: (index: number, length?: number) => void | undefined;
+    replace: (index: number, item: T) => void;
+    yArray: ComputedRef<Y.Array<T> | null>;
+};
+export declare function useSyncedText(doc: ShallowRef<Y.Doc>, textName: string): {
+    text: Ref<string, string>;
+    insert: (index: number, content: string, attributes?: Record<string, any>) => void | undefined;
+    delete: (index: number, length: number) => void | undefined;
+    format: (index: number, length: number, attributes: Record<string, any>) => void | undefined;
+    yText: ComputedRef<Y.Text | null>;
+};
+export declare function useSyncedXml(doc: ShallowRef<Y.Doc>, xmlName: string): {
+    yXml: ShallowRef<Y.XmlFragment | null, Y.XmlFragment | null>;
+};
+export interface AwarenessUser {
+    clientId: number;
+    user: {
+        name: string;
+        color: string;
+        avatar?: string;
+    };
+    [key: string]: any;
+}
+export declare function useAwareness(provider: ShallowRef<CollabProvider | null>): {
+    states: Ref<{
+        [x: string]: any;
+        clientId: number;
+        user: {
+            name: string;
+            color: string;
+            avatar?: string | undefined;
+        };
+    }[], AwarenessUser[] | {
+        [x: string]: any;
+        clientId: number;
+        user: {
+            name: string;
+            color: string;
+            avatar?: string | undefined;
+        };
+    }[]>;
+    currentUser: Ref<{
+        [x: string]: any;
+        clientId: number;
+        user: {
+            name: string;
+            color: string;
+            avatar?: string | undefined;
+        };
+    } | null, AwarenessUser | {
+        [x: string]: any;
+        clientId: number;
+        user: {
+            name: string;
+            color: string;
+            avatar?: string | undefined;
+        };
+    } | null>;
+    setLocalState: (state: Partial<AwarenessUser["user"] | any>) => void;
+};
+export declare function useLiveComments(provider: ShallowRef<CollabProvider | null>, spaceId: string, documentId: string): {
+    threads: Ref<any[], any[]>;
+    loading: Ref<boolean, boolean>;
+    createComment: (content: string, anchor?: any, parentId?: string) => Promise<void>;
+    refresh: () => Promise<void>;
+};
+export interface UseAuthReturn {
+    session: ComputedRef<SessionData | null>;
+    user: ComputedRef<SessionData['user'] | null>;
+    isAuthenticated: ComputedRef<boolean>;
+    login: (email: string, password: string) => Promise<SessionData>;
+    signup: (email: string, password: string, name: string) => Promise<SessionData>;
+    logout: () => Promise<void>;
+}
+export declare function useAuth(providedClient?: CollabClient): UseAuthReturn;
+export interface UseTiptapEditorOptions {
+    spaceId: ComputedRef<string> | Ref<string> | string;
+    documentId: ComputedRef<string> | Ref<string> | string;
+    extensions?: any[];
+    editorOptions?: Partial<EditorOptions>;
+    user?: {
+        name?: string;
+        color?: string;
+    };
+    onReady?: (editor: Editor) => void;
+    autoConnect?: boolean;
+}
+export interface UseTiptapEditorReturn {
+    editor: ShallowRef<Editor | null>;
+    doc: ShallowRef<Y.Doc>;
+    provider: ShallowRef<CollabProvider | null>;
+    status: Ref<'disconnected' | 'connecting' | 'connected'>;
+    synced: Ref<boolean>;
+    persistenceReady: Ref<boolean>;
+    loading: Ref<boolean>;
+    error: Ref<string>;
+    connect: () => Promise<void>;
+    disconnect: () => void;
+    destroy: () => void;
+    clearLocalData: () => Promise<void>;
+}
+export declare function useTiptapEditor(options: UseTiptapEditorOptions): UseTiptapEditorReturn;
+export declare function useCollaborativeDocument(spaceId: string, documentId: string): {
+    doc: ShallowRef<Y.Doc>;
+    provider: ShallowRef<CollabProvider | null>;
+    status: Ref<"disconnected" | "connecting" | "connected", "disconnected" | "connecting" | "connected">;
+    synced: Ref<boolean, boolean>;
+    connect: () => void;
+    disconnect: () => void;
+    undo: () => void;
+    redo: () => void;
+    transact: (callback: (txn: Y.Transaction) => void) => void;
+    canUndo: ComputedRef<number | boolean>;
+    canRedo: ComputedRef<number | boolean>;
+    users: Ref<{
+        [x: string]: any;
+        clientId: number;
+        user: {
+            name: string;
+            color: string;
+            avatar?: string | undefined;
+        };
+    }[], AwarenessUser[] | {
+        [x: string]: any;
+        clientId: number;
+        user: {
+            name: string;
+            color: string;
+            avatar?: string | undefined;
+        };
+    }[]>;
+    me: Ref<{
+        [x: string]: any;
+        clientId: number;
+        user: {
+            name: string;
+            color: string;
+            avatar?: string | undefined;
+        };
+    } | null, AwarenessUser | {
+        [x: string]: any;
+        clientId: number;
+        user: {
+            name: string;
+            color: string;
+            avatar?: string | undefined;
+        };
+    } | null>;
+    updatePresence: (state: Partial<AwarenessUser["user"] | any>) => void;
+    comments: Ref<any[], any[]>;
+    loadingComments: Ref<boolean, boolean>;
+    createComment: (content: string, anchor?: any, parentId?: string) => Promise<void>;
+    useMap: <T>(name: string) => {
+        data: Record<string, T>;
+        set: (key: string, value: T) => T | undefined;
+        remove: (key: string) => void | undefined;
+        clear: () => void | undefined;
+        get: (key: string) => T | undefined;
+        yMap: ComputedRef<Y.Map<T> | null>;
+    };
+    useArray: <T>(name: string) => {
+        list: Ref<T[], T[]>;
+        push: (item: T) => void | undefined;
+        unshift: (item: T) => void | undefined;
+        insert: (index: number, items: T[]) => void | undefined;
+        deleteAt: (index: number, length?: number) => void | undefined;
+        replace: (index: number, item: T) => void;
+        yArray: ComputedRef<Y.Array<T> | null>;
+    };
+    useText: (name: string) => {
+        text: Ref<string, string>;
+        insert: (index: number, content: string, attributes?: Record<string, any>) => void | undefined;
+        delete: (index: number, length: number) => void | undefined;
+        format: (index: number, length: number, attributes: Record<string, any>) => void | undefined;
+        yText: ComputedRef<Y.Text | null>;
+    };
+    useXml: (name: string) => {
+        yXml: ShallowRef<Y.XmlFragment | null, Y.XmlFragment | null>;
+    };
+};
+//# sourceMappingURL=useCollab.d.ts.map

package/dist/useCollab.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCollab.d.ts","sourceRoot":"","sources":["../src/useCollab.ts"],"names":[],"mappings":"AACA,OAAO,EAYH,KAAK,YAAY,EACjB,KAAK,GAAG,EACR,KAAK,UAAU,EACf,KAAK,WAAW,EACnB,MAAM,KAAK,CAAC;AACb,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EACH,YAAY,EACZ,cAAc,EACd,KAAK,mBAAmB,EAExB,KAAK,WAAW,EACnB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAM1D,eAAO,MAAM,eAAe,EAAE,YAAY,CAAC,YAAY,CAA8B,CAAC;AAEtF,wBAAgB,mBAAmB,CAAC,iBAAiB,EAAE,mBAAmB,GAAG,YAAY,gBAOxF;AAED,wBAAgB,eAAe,iBAI9B;AAOD,MAAM,WAAW,iBAAiB;IAC9B,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACvB,QAAQ,EAAE,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IAC5C,MAAM,EAAE,GAAG,CAAC,cAAc,GAAG,YAAY,GAAG,WAAW,CAAC,CAAC;IACzD,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACrB,gBAAgB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IAC/B,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;IAC9C,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,WAAW,KAAK,IAAI,KAAK,IAAI,CAAC;IAC3D,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,cAAc,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CACvC;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,iBAAiB,CA2FlF;AAOD,wBAAgB,YAAY,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,MAAM;;eAqCvD,MAAM,SAAS,CAAC;kBACb,MAAM;;eAET,MAAM;;EAU3B;AAOD,wBAAgB,cAAc,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,MAAM;;iBAmCzD,CAAC;oBACE,CAAC;oBACD,MAAM,SAAS,CAAC,EAAE;sBAChB,MAAM;qBAMP,MAAM,QAAQ,CAAC;;EAiB1C;AAOD,wBAAgB,aAAa,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,MAAM;;oBAuB3C,MAAM,WAAW,MAAM,eAAe,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;oBAGrD,MAAM,UAAU,MAAM;oBAG1B,MAAM,UAAU,MAAM,cAAc,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;;EAUjF;AAOD,wBAAgB,YAAY,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,MAAM;;EAYnE;AAMD,MAAM,WAAW,aAAa;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE;QACF,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED,wBAAgB,YAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC;;;kBAT1D,MAAM;;kBAEN,MAAM;mBACL,MAAM;qBACJ,MAAM;;;;kBAJT,MAAM;;kBAEN,MAAM;mBACL,MAAM;qBACJ,MAAM;;;;;kBAJT,MAAM;;kBAEN,MAAM;mBACL,MAAM;qBACJ,MAAM;;;;kBAJT,MAAM;;kBAEN,MAAM;mBACL,MAAM;qBACJ,MAAM;;;2BAgCW,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC;EAWrE;AAOD,wBAAgB,eAAe,CAC3B,QAAQ,EAAE,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,EAC3C,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM;;;6BA6BoB,MAAM,WAAW,GAAG,aAAa,MAAM;;EAahF;AAOD,MAAM,WAAW,aAAa;IAC1B,OAAO,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;IACzC,IAAI,EAAE,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAC9C,eAAe,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;IACtC,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IACjE,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IAChF,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/B;AAED,wBAAgB,OAAO,CAAC,cAAc,CAAC,EAAE,YAAY,GAAG,aAAa,CA8BpE;AAOD,MAAM,WAAW,sBAAsB;IACnC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IACpD,UAAU,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IACvD,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACvC,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACzC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,qBAAqB;IAClC,MAAM,EAAE,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAClC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACvB,QAAQ,EAAE,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IAC5C,MAAM,EAAE,GAAG,CAAC,cAAc,GAAG,YAAY,GAAG,WAAW,CAAC,CAAC;IACzD,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACrB,gBAAgB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IAC/B,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACtB,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACnB,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,cAAc,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CACvC;AAED,wBAAgB,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,qBAAqB,CAiMtF;AAMD,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;;;;;mBAhqBzD,IAAI;sBACD,IAAI;gBAEV,IAAI;gBACJ,IAAI;yBAFK,CAAC,GAAG,EAAE,CAAC,CAAC,WAAW,KAAK,IAAI,KAAK,IAAI;;;;;kBAsShD,MAAM;;kBAEN,MAAM;mBACL,MAAM;qBACJ,MAAM;;;;kBAJT,MAAM;;kBAEN,MAAM;mBACL,MAAM;qBACJ,MAAM;;;;;kBAJT,MAAM;;kBAEN,MAAM;mBACL,MAAM;qBACJ,MAAM;;;;kBAJT,MAAM;;kBAEN,MAAM;mBACL,MAAM;qBACJ,MAAM;;;4BAgCW,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC;;;6BAkD5B,MAAM,WAAW,GAAG,aAAa,MAAM;aA+S7D,CAAC,QAAQ,MAAM;;mBA9hBb,MAAM;sBACH,MAAM;;mBAET,MAAM;;;eA4hBN,CAAC,QAAQ,MAAM;;;;wBAteV,MAAM;0BACJ,MAAM;yBAMP,MAAM;;;oBAgeP,MAAM;;wBAjbN,MAAM,WAAW,MAAM,eAAe,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;wBAGrD,MAAM,UAAU,MAAM;wBAG1B,MAAM,UAAU,MAAM,cAAc,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;;;mBA4axD,MAAM;;;EAkC/B"}