@towns-labs/react-sdk 2.0.1

package/dist/esm/useUserDms.js

@@ -0,0 +1,36 @@
+import { useTowns } from './useTowns';
+/**
+ * Hook to get the direct messages of the current user.
+ * @param config - Configuration options for the observable.
+ * @returns The list of all direct messages stream ids of the current user.
+ * @example
+ *
+ * You can combine this hook with the `useDm`, `useMemberList` and `useMember` hooks to get all direct messages of the current user and render them, showing the name of the other user in the dm:
+ *
+ * ```tsx
+ * import { useDm, useMyMember, useMemberList, useMember } from '@towns-labs/react-sdk'
+ *
+ * const AllDms = () => {
+ *     const { streamIds } = useUserDms()
+ *     return <>{streamIds.map((streamId) => <Dm key={streamId} streamId={streamId} />)}</>
+ * }
+ *
+ * const Dm = ({ streamId }: { streamId: string }) => {
+ *     const { data: dm } = useDm(streamId)
+ *     const { userId: myUserId } = useMyMember(streamId)
+ *     const { data: members } = useMemberList(streamId)
+ *     const { userId, username, displayName } = useMember({
+ *        streamId,
+ *        // We find the other user in the dm by checking the userIds in the member list
+ *        // and defaulting to the current user if we don't find one, since a user is able to send a dm to themselves
+ *        userId: members.userIds.find((userId) => userId !== sync.userId) || sync.userId,
+ *     })
+ *     return <span>{userId === myUserId ? 'You' : displayName || username || userId}</span>
+ * }
+ * ```
+ */
+export const useUserDms = (config) => {
+    const { data, ...rest } = useTowns((s) => s.dms, config);
+    return { streamIds: data.streamIds, ...rest };
+};
+//# sourceMappingURL=useUserDms.js.map

package/dist/esm/useUserDms.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useUserDms.js","sourceRoot":"","sources":["../../src/useUserDms.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,MAA6C,EAAE,EAAE;IACxE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;IACxD,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,EAAE,CAAA;AACjD,CAAC,CAAA"}

package/dist/esm/useUserGdms.js

@@ -0,0 +1,27 @@
+import { useTowns } from './useTowns';
+/**
+ * Hook to get the group dm streams of the current user.
+ * @param config - Configuration options for the observable.
+ * @returns The list of all group dm stream ids of the current user.
+ * @example
+ * You can combine this hook with the `useGdm` hook to get all group dm streams of the current user and render them:
+ *
+ * ```tsx
+ * import { useUserGdms, useGdm } from '@towns-labs/react-sdk'
+ *
+ * const AllGdms = () => {
+ *     const { streamIds } = useUserGdms()
+ *     return <>{streamIds.map((streamId) => <Gdm key={streamId} streamId={streamId} />)}</>
+ * }
+ *
+ * const Gdm = ({ streamId }: { streamId: string }) => {
+ *     const { data: gdm } = useGdm(streamId)
+ *     return <div>{gdm.metadata?.name || 'Unnamed Gdm'}</div>
+ * }
+ * ```
+ */
+export const useUserGdms = (config) => {
+    const { data, ...rest } = useTowns((s) => s.gdms, config);
+    return { streamIds: data.streamIds, ...rest };
+};
+//# sourceMappingURL=useUserGdms.js.map

package/dist/esm/useUserGdms.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useUserGdms.js","sourceRoot":"","sources":["../../src/useUserGdms.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAErC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,MAA8C,EAAE,EAAE;IAC1E,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IACzD,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,EAAE,CAAA;AACjD,CAAC,CAAA"}

package/dist/esm/useUserSpaces.js

@@ -0,0 +1,27 @@
+import { useTowns } from './useTowns';
+/**
+ * Hook to get the spaces of the current user.
+ * @param config - Configuration options for the observable.
+ * @returns The list of all space ids of the current user.
+ * @example
+ * You can combine this hook with the `useSpace` hook to get all spaces of the current user and render them:
+ *
+ * ```tsx
+ * import { useUserSpaces, useSpace } from '@towns-labs/react-sdk'
+ *
+ * const AllSpaces = () => {
+ *     const { spaceIds } = useUserSpaces()
+ *     return <>{spaceIds.map((spaceId) => <Space key={spaceId} spaceId={spaceId} />)}</>
+ * }
+ *
+ * const Space = ({ spaceId }: { spaceId: string }) => {
+ *     const { data: space } = useSpace(spaceId)
+ *     return <div>{space.metadata?.name || 'Unnamed Space'}</div>
+ * }
+ * ```
+ */
+export const useUserSpaces = (config) => {
+    const { data, ...rest } = useTowns((s) => s.spaces, config);
+    return { spaceIds: data.spaceIds, ...rest };
+};
+//# sourceMappingURL=useUserSpaces.js.map

package/dist/esm/useUserSpaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useUserSpaces.js","sourceRoot":"","sources":["../../src/useUserSpaces.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAErC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAgD,EAAE,EAAE;IAC9E,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC3D,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,GAAG,IAAI,EAAE,CAAA;AAC/C,CAAC,CAAA"}

package/dist/esm/utils.js

@@ -0,0 +1,17 @@
+import { isChannelStreamId, isDMChannelStreamId, isGDMChannelStreamId, isSpaceStreamId, spaceIdFromChannelId, } from '@towns-labs/sdk';
+export const getRoom = (sync, streamId) => {
+    if (isChannelStreamId(streamId)) {
+        return sync.spaces.getSpace(spaceIdFromChannelId(streamId)).getChannel(streamId);
+    }
+    if (isGDMChannelStreamId(streamId)) {
+        return sync.gdms.getGdm(streamId);
+    }
+    if (isDMChannelStreamId(streamId)) {
+        return sync.dms.getDm(streamId);
+    }
+    if (isSpaceStreamId(streamId)) {
+        return sync.spaces.getSpace(streamId);
+    }
+    throw new Error('Invalid room type');
+};
+//# sourceMappingURL=utils.js.map

package/dist/esm/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAMH,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,eAAe,EACf,oBAAoB,GACvB,MAAM,iBAAiB,CAAA;AAExB,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,IAAe,EAAE,QAAgB,EAA8B,EAAE;IACrF,IAAI,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;IACpF,CAAC;IACD,IAAI,oBAAoB,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IACrC,CAAC;IACD,IAAI,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;IACnC,CAAC;IACD,IAAI,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IACzC,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;AACxC,CAAC,CAAA"}

package/dist/types/TownsSyncProvider.d.ts

@@ -0,0 +1,23 @@
+import type { SyncAgent } from '@towns-labs/sdk';
+/**
+ * Provides the sync agent to all hooks usage that interacts with the Towns Protocol.
+ *
+ * - If you want to interact with the sync agent directly, you can use the `useSyncAgent` hook.
+ * - If you want to interact with the Towns Protocol using hooks provided by this SDK, you should wrap your App with this provider.
+ *
+ * You can pass an initial sync agent instance to the provider.
+ * This can be useful for persisting authentication.
+ *
+ * @param props - The props for the provider
+ * @returns The provider
+ */
+export declare const TownsSyncProvider: (props: {
+    /** A initial sync agent instance. Useful for persisting authentication. */
+    syncAgent?: SyncAgent;
+    config?: {
+        /** A callback function that is called when the bearer token expires. */
+        onTokenExpired?: () => void;
+    };
+    children?: React.ReactNode;
+}) => import("react").JSX.Element;
+//# sourceMappingURL=TownsSyncProvider.d.ts.map

package/dist/types/TownsSyncProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TownsSyncProvider.d.ts","sourceRoot":"","sources":["../../src/TownsSyncProvider.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAIhD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,iBAAiB,GAAI,OAAO;IACrC,2EAA2E;IAC3E,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,MAAM,CAAC,EAAE;QACL,wEAAwE;QACxE,cAAc,CAAC,EAAE,MAAM,IAAI,CAAA;KAC9B,CAAA;IACD,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC7B,gCA6BA,CAAA"}

package/dist/types/connectTowns.d.ts

@@ -0,0 +1,29 @@
+import { type SignerContext, SyncAgent, type SyncAgentConfig } from '@towns-labs/sdk';
+import { ethers } from 'ethers';
+/**
+ * Sign and connect to Towns using a Signer and a random delegate wallet every time
+ * @param signer - The signer to use
+ * @param config - The configuration for the sync agent
+ * @returns The sync agent
+ */
+export declare const signAndConnect: (signer: ethers.Signer, config: Omit<SyncAgentConfig, "context">) => Promise<SyncAgent>;
+/**
+ * Connect to Towns using a SignerContext
+ *
+ * Useful for server side code, allowing you to persist the signer context and use it to auth with Towns later
+ * @param signerContext - The signer context to use
+ * @param config - The configuration for the sync agent
+ * @returns The sync agent
+ */
+export declare const connectTowns: (signerContext: SignerContext, config: Omit<SyncAgentConfig, "context">) => Promise<SyncAgent>;
+/**
+ * Connect to Towns using a Bearer Token
+ * Towns clients can use this to connect to Towns Protocol on behalf of a user
+ *
+ * Useful for server side code, allowing you to persist the signer context and use it to auth with Towns later
+ * @param token - The bearer token to use
+ * @param config - The configuration for the sync agent
+ * @returns The sync agent
+ */
+export declare const connectTownsWithBearerToken: (token: string, config: Omit<SyncAgentConfig, "context">) => Promise<SyncAgent>;
+//# sourceMappingURL=connectTowns.d.ts.map

package/dist/types/connectTowns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connectTowns.d.ts","sourceRoot":"","sources":["../../src/connectTowns.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,KAAK,aAAa,EAClB,SAAS,EACT,KAAK,eAAe,EAGvB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAQ/B;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GACvB,QAAQ,MAAM,CAAC,MAAM,EACrB,QAAQ,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,KACzC,OAAO,CAAC,SAAS,CAInB,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,GACrB,eAAe,aAAa,EAC5B,QAAQ,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,KACzC,OAAO,CAAC,SAAS,CAEnB,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,2BAA2B,GACpC,OAAO,MAAM,EACb,QAAQ,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,KACzC,OAAO,CAAC,SAAS,CAGnB,CAAA"}

package/dist/types/index.d.ts

@@ -0,0 +1,35 @@
+/**************************************************************************
+ * This file is generated by running 🏕️ scripts/generate_sdk_index.sh 🏕️ *
+ **************************************************************************/
+export * from './TownsSyncProvider';
+export * from './connectTowns';
+export * from './useAdminRedact';
+export * from './useAgentConnection';
+export * from './useChannel';
+export * from './useCreateChannel';
+export * from './useCreateDm';
+export * from './useCreateGdm';
+export * from './useCreateSpace';
+export * from './useDm';
+export * from './useGdm';
+export * from './useJoinSpace';
+export * from './useMember';
+export * from './useMemberList';
+export * from './useMyMember';
+export * from './useObservable';
+export * from './useReactions';
+export * from './useRedact';
+export * from './useScrollback';
+export * from './useSendMessage';
+export * from './useSendReaction';
+export * from './useSpace';
+export * from './useSyncAgent';
+export * from './useThreads';
+export * from './useTimeline';
+export * from './useTowns';
+export * from './useTownsAuthStatus';
+export * from './useUserDms';
+export * from './useUserGdms';
+export * from './useUserSpaces';
+export * from './utils';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;4EAE4E;AAC5E,cAAc,qBAAqB,CAAA;AACnC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA;AACpC,cAAc,cAAc,CAAA;AAC5B,cAAc,oBAAoB,CAAA;AAClC,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,kBAAkB,CAAA;AAChC,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA;AACxB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,kBAAkB,CAAA;AAChC,cAAc,mBAAmB,CAAA;AACjC,cAAc,YAAY,CAAA;AAC1B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,YAAY,CAAA;AAC1B,cAAc,sBAAsB,CAAA;AACpC,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,SAAS,CAAA"}

package/dist/types/internals/TownsSyncContext.d.ts

@@ -0,0 +1,11 @@
+import { SyncAgent } from '@towns-labs/sdk';
+type TownsSyncContextProps = {
+    syncAgent: SyncAgent | undefined;
+    setSyncAgent: (syncAgent: SyncAgent | undefined) => void;
+    config?: {
+        onTokenExpired?: () => void;
+    };
+};
+export declare const TownsSyncContext: import("react").Context<TownsSyncContextProps | undefined>;
+export {};
+//# sourceMappingURL=TownsSyncContext.d.ts.map

package/dist/types/internals/TownsSyncContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TownsSyncContext.d.ts","sourceRoot":"","sources":["../../../src/internals/TownsSyncContext.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAG3C,KAAK,qBAAqB,GAAG;IACzB,SAAS,EAAE,SAAS,GAAG,SAAS,CAAA;IAChC,YAAY,EAAE,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,KAAK,IAAI,CAAA;IACxD,MAAM,CAAC,EAAE;QACL,cAAc,CAAC,EAAE,MAAM,IAAI,CAAA;KAC9B,CAAA;CACJ,CAAA;AACD,eAAO,MAAM,gBAAgB,4DAA8D,CAAA"}

package/dist/types/internals/useAction.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Configuration options for an action.
+ * It can be used to configure the behavior of the useAction hook.
+ */
+export type ActionConfig<Action> = {
+    /** Callback function to be called when an error occurs while executing the action. */
+    onError?: (err: Error) => void;
+    /** Callback function to be called when the action is successful. */
+    onSuccess?: (data: ReturnOf<Action>) => void;
+};
+type MultipleParams<T> = T extends unknown[] ? T : [T];
+type ActionFn<T> = T extends (...args: infer Args) => Promise<infer Return> ? (...args: Args) => Promise<Return> : never;
+type ParamsOf<T> = Parameters<ActionFn<T>>;
+type ReturnOf<T> = Awaited<ReturnType<ActionFn<T>>>;
+/**
+ * Hook to create an action from a namespace.
+ * @internal
+ * @param namespace - The namespace to create the action from.
+ * @param fnName - The name of the action to create. Example: `Namespace.fnName`
+ * @param config - Configuration options for the action.
+ * @returns The action and its loading state.
+ */
+export declare const useAction: <Namespace, Key extends keyof Namespace, Fn extends Namespace[Key]>(namespace: Namespace | undefined, fnName: Key & string, config?: ActionConfig<Fn>) => {
+    /** The action to execute. */
+    action: (...args: MultipleParams<ParamsOf<Fn>>) => Promise<ReturnOf<Fn>>;
+    /** The data returned by the action. */
+    data: Awaited<ReturnType<ActionFn<Fn>>> | undefined;
+    /** The error that occurred while executing the action. */
+    error: Error | undefined;
+    /** Whether the action is pending. */
+    isPending: boolean;
+    /** Whether the action is successful. */
+    isSuccess: boolean;
+    /** Whether the action is in error. */
+    isError: boolean;
+};
+export {};
+//# sourceMappingURL=useAction.d.ts.map

package/dist/types/internals/useAction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAction.d.ts","sourceRoot":"","sources":["../../../src/internals/useAction.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,MAAM,IAAI;IAC/B,sFAAsF;IACtF,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAI,CAAA;IAC9B,oEAAoE;IACpE,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,KAAK,IAAI,CAAA;CAC/C,CAAA;AAED,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;AAEtD,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,IAAI,KAAK,OAAO,CAAC,MAAM,MAAM,CAAC,GACrE,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,GAClC,KAAK,CAAA;AAEX,KAAK,QAAQ,CAAC,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;AAC1C,KAAK,QAAQ,CAAC,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAEnD;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,GAAI,SAAS,EAAE,GAAG,SAAS,MAAM,SAAS,EAAE,EAAE,SAAS,SAAS,CAAC,GAAG,CAAC,EACvF,WAAW,SAAS,GAAG,SAAS,EAChC,QAAQ,GAAG,GAAG,MAAM,EACpB,SAAS,YAAY,CAAC,EAAE,CAAC;IAqCrB,6BAA6B;sBA9Bb,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAG,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAgCpE,uCAAuC;;IAEvC,0DAA0D;;IAE1D,qCAAqC;;IAErC,wCAAwC;;IAExC,sCAAsC;;CAG7C,CAAA"}

package/dist/types/internals/useTownsSync.d.ts

@@ -0,0 +1,8 @@
+export declare const useTownsSync: () => {
+    syncAgent: import("@towns-labs/sdk").SyncAgent | undefined;
+    setSyncAgent: (syncAgent: import("@towns-labs/sdk").SyncAgent | undefined) => void;
+    config?: {
+        onTokenExpired?: () => void;
+    };
+} | undefined;
+//# sourceMappingURL=useTownsSync.d.ts.map

package/dist/types/internals/useTownsSync.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTownsSync.d.ts","sourceRoot":"","sources":["../../../src/internals/useTownsSync.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,YAAY;;;;sBACwE,CAAC;;aADpC,CAAA"}

package/dist/types/internals/utils.d.ts

@@ -0,0 +1,3 @@
+import type { PersistedModel } from '@towns-labs/sdk';
+export declare const isPersistedModel: <T>(value: T | PersistedModel<T>) => value is PersistedModel<T>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/types/internals/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/internals/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAErD,eAAO,MAAM,gBAAgB,GAAI,CAAC,EAAE,OAAO,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,KAAG,KAAK,IAAI,cAAc,CAAC,CAAC,CAQ3F,CAAA"}

package/dist/types/useAdminRedact.d.ts

@@ -0,0 +1,42 @@
+import { Channel } from '@towns-labs/sdk';
+import { type ActionConfig } from './internals/useAction';
+/**
+ * Hook to redact any message in a channel if you're an admin.
+ * @example
+ *
+ * ### Redact a message
+ *
+ * You can use `adminRedact` to redact a message in a stream.
+ * ```ts
+ * import { useAdminRedact } from '@towns-labs/react-sdk'
+ *
+ * const { adminRedact } = useAdminRedact(streamId)
+ * adminRedact({ eventId: messageEventId })
+ * ```
+ *
+ * ### Redact a message reaction
+ *
+ * You can also use `redact` to redact a message reaction in a stream.
+ * ```ts
+ * import { useRedact } from '@towns-labs/react-sdk'
+ *
+ * const { redact } = useRedact(streamId)
+ * redact({ eventId: reactionEventId })
+ * ```
+ * @param streamId - The id of the stream to redact the message in.
+ * @param config - Configuration options for the action.
+ * @returns The `redact` action and its loading state.
+ */
+export declare const useAdminRedact: (streamId: string, config?: ActionConfig<Channel["adminRedact"]>) => {
+    data: {
+        eventId: string;
+    } | undefined;
+    error: Error | undefined;
+    isPending: boolean;
+    isSuccess: boolean;
+    isError: boolean;
+    adminRedact: (eventId: string) => Promise<{
+        eventId: string;
+    }>;
+};
+//# sourceMappingURL=useAdminRedact.d.ts.map

package/dist/types/useAdminRedact.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAdminRedact.d.ts","sourceRoot":"","sources":["../../src/useAdminRedact.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAiB,MAAM,iBAAiB,CAAA;AACxD,OAAO,EAAE,KAAK,YAAY,EAAa,MAAM,uBAAuB,CAAA;AAIpE;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,cAAc,GAAI,UAAU,MAAM,EAAE,SAAS,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;;;;;;;;;;;CAU7F,CAAA"}

package/dist/types/useAgentConnection.d.ts

@@ -0,0 +1,83 @@
+import type { SyncAgentConfig } from '@towns-labs/sdk';
+import type { ethers } from 'ethers';
+type AgentConnectConfig = Omit<SyncAgentConfig, 'context' | 'onTokenExpired'>;
+/**
+ * Hook for managing the connection to the sync agent
+ *
+ * @example You can connect the Sync Agent to Towns Protocol using a Bearer Token or using a Signer.
+ *
+ * ### Bearer Token
+ * ```tsx
+ * import { useAgentConnection } from '@towns-labs/react-sdk'
+ * import { townsEnv } from '@towns-labs/sdk'
+ * import { useState } from 'react'
+ *
+ * const townsConfig = townsEnv().makeTownsConfig('beta')
+ *
+ * const Login = () => {
+ *   const { connectUsingBearerToken, isAgentConnecting, isAgentConnected } = useAgentConnection()
+ *   const [bearerToken, setBearerToken] = useState('')
+ *
+ *   return (
+ *     <>
+ *       <input value={bearerToken} onChange={(e) => setBearerToken(e.target.value)} />
+ *       <button onClick={() => connectUsingBearerToken(bearerToken, { townsConfig })}>
+ *         Login
+ *       </button>
+ *       {isAgentConnecting && <span>Connecting... ⏳</span>}
+ *       {isAgentConnected && <span>Connected ✅</span>}
+ *     </>
+ *   )
+ * }
+ * ```
+ *
+ * ### Signer
+ *
+ * If you're using Wagmi and Viem, you can use the [`useEthersSigner`](https://wagmi.sh/react/guides/ethers#usage-1) hook to get an ethers.js v5 Signer from a Viem Wallet Client.
+ *
+ * ```tsx
+ * import { useAgentConnection } from '@towns-labs/react-sdk'
+ * import { townsEnv } from '@towns-labs/sdk'
+ * import { useEthersSigner } from './utils/viem-to-ethers'
+ *
+ * const townsConfig = townsEnv().makeTownsConfig('beta')
+ *
+ * const Login = () => {
+ *   const { connect, isAgentConnecting, isAgentConnected } = useAgentConnection()
+ *   const signer = useEthersSigner()
+ *
+ *   return (
+ *     <>
+ *       <button onClick={async () => {
+ *         if (!signer) {
+ *           return
+ *         }
+ *         connect(signer, { townsConfig })
+ *       }}>
+ *         Login
+ *       </button>
+ *       {isAgentConnecting && <span>Connecting... ⏳</span>}
+ *       {isAgentConnected && <span>Connected ✅</span>}
+ *     </>
+ *   )
+ * }
+ * ```
+ *
+ * @returns The connection state and methods (connect, connectUsingBearerToken, disconnect)
+ */
+export declare const useAgentConnection: () => {
+    /** Connect to Towns Protocol using a Signer */
+    connect: (signer: ethers.Signer, config: AgentConnectConfig) => Promise<import("@towns-labs/sdk").SyncAgent | undefined>;
+    /** Connect to Towns Protocol using a Bearer Token */
+    connectUsingBearerToken: (bearerToken: string, config: AgentConnectConfig) => Promise<import("@towns-labs/sdk").SyncAgent | undefined>;
+    /** Disconnect from Towns Protocol */
+    disconnect: () => void | undefined;
+    /** Whether the agent is currently connecting */
+    isAgentConnecting: boolean;
+    /** Whether the agent is connected */
+    isAgentConnected: boolean;
+    /** The environment of the current connection (beta, omega, alpha, local_dev, etc.) */
+    env: string | undefined;
+};
+export {};
+//# sourceMappingURL=useAgentConnection.d.ts.map

package/dist/types/useAgentConnection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAgentConnection.d.ts","sourceRoot":"","sources":["../../src/useAgentConnection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAIpC,KAAK,kBAAkB,GAAG,IAAI,CAAC,eAAe,EAAE,SAAS,GAAG,gBAAgB,CAAC,CAAA;AAE7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG;AACH,eAAO,MAAM,kBAAkB;IAyDvB,+CAA+C;sBApDhC,MAAM,CAAC,MAAM,UAAU,kBAAkB;IAsDxD,qDAAqD;2CA9BjC,MAAM,UAAU,kBAAkB;IAgCtD,qCAAqC;;IAErC,gDAAgD;;IAEhD,qCAAqC;;IAErC,sFAAsF;;CAG7F,CAAA"}

package/dist/types/useChannel.d.ts

@@ -0,0 +1,12 @@
+import type { Channel } from '@towns-labs/sdk';
+import { type ObservableConfig } from './useObservable';
+/**
+ * Hook to get data about a channel.
+ * You can use this hook to get channel metadata and if the user has joined the channel.
+ * @param spaceId - The id of the space the channel belongs to.
+ * @param channelId - The id of the channel to get data about.
+ * @param config - Configuration options for the observable.
+ * @returns The ChannelModel data.
+ */
+export declare const useChannel: (spaceId: string, channelId: string, config?: ObservableConfig.FromObservable<Channel>) => import("./useObservable").ObservableValue<import("@towns-labs/sdk").ChannelModel>;
+//# sourceMappingURL=useChannel.d.ts.map

package/dist/types/useChannel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useChannel.d.ts","sourceRoot":"","sources":["../../src/useChannel.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE9C,OAAO,EAAE,KAAK,gBAAgB,EAAiB,MAAM,iBAAiB,CAAA;AAEtE;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,GACnB,SAAS,MAAM,EACf,WAAW,MAAM,EACjB,SAAS,gBAAgB,CAAC,cAAc,CAAC,OAAO,CAAC,sFAQpD,CAAA"}

package/dist/types/useCreateChannel.d.ts

@@ -0,0 +1,23 @@
+import type { Space } from '@towns-labs/sdk';
+import { type ActionConfig } from './internals/useAction';
+/**
+ * Hook to create a channel.
+ * @param config - Configuration options for the action.
+ * @returns The `createChannel` action and its loading state.
+ */
+export declare const useCreateChannel: (spaceId: string, config?: ActionConfig<Space["createChannel"]>) => {
+    data: string | undefined;
+    error: Error | undefined;
+    isPending: boolean;
+    isSuccess: boolean;
+    isError: boolean;
+    /**
+     * Action to create a channel.
+     * @param name - The name of the channel to create.
+     * @param signer - The signer to use to create the channel.
+     */
+    createChannel: (channelName: string, signer: import("ethers").Signer, opts?: {
+        topic?: string;
+    } | undefined) => Promise<string>;
+};
+//# sourceMappingURL=useCreateChannel.d.ts.map

package/dist/types/useCreateChannel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCreateChannel.d.ts","sourceRoot":"","sources":["../../src/useCreateChannel.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AAE5C,OAAO,EAAE,KAAK,YAAY,EAAa,MAAM,uBAAuB,CAAA;AAGpE;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GACzB,SAAS,MAAM,EACf,SAAS,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;;;;;;IAOzC;;;;OAIG;;;;CAIV,CAAA"}

package/dist/types/useCreateDm.d.ts

@@ -0,0 +1,28 @@
+import type { Dms } from '@towns-labs/sdk';
+import { type ActionConfig } from './internals/useAction';
+/**
+ * A hook that allows you to create a new direct message (DM).
+ * @param config - The action config.
+ * @returns An object containing the `createDM` action and the rest of the action result.
+ */
+export declare const useCreateDm: (config?: ActionConfig<Dms["createDM"]>) => {
+    data: {
+        streamId: string;
+    } | undefined;
+    error: Error | undefined;
+    isPending: boolean;
+    isSuccess: boolean;
+    isError: boolean;
+    /**
+     * Creates a new DM.
+     * @param userId - The `userId` of the user to create a DM with.
+     * @returns A promise that resolves to the result of the create operation.
+     */
+    createDM: (userId: string, appAddress?: string | undefined, streamSettings?: {
+        disableMiniblockCreation: boolean;
+        lightStream: boolean;
+    } | undefined) => Promise<{
+        streamId: string;
+    }>;
+};
+//# sourceMappingURL=useCreateDm.d.ts.map

package/dist/types/useCreateDm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCreateDm.d.ts","sourceRoot":"","sources":["../../src/useCreateDm.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAC1C,OAAO,EAAE,KAAK,YAAY,EAAa,MAAM,uBAAuB,CAAA;AAGpE;;;;GAIG;AACH,eAAO,MAAM,WAAW,GAAI,SAAS,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;;;;;;;;IAK1D;;;;OAIG;;;;;;;CAIV,CAAA"}

package/dist/types/useCreateGdm.d.ts

@@ -0,0 +1,31 @@
+import type { Gdms } from '@towns-labs/sdk';
+import { type ActionConfig } from './internals/useAction';
+/**
+ * A hook that allows you to create a new group direct message (GDM).
+ * @param config - The action config.
+ * @returns An object containing the `createGDM` action and the rest of the action result.
+ */
+export declare const useCreateGdm: (config?: ActionConfig<Gdms["createGDM"]>) => {
+    data: {
+        streamId: string;
+    } | undefined;
+    error: Error | undefined;
+    isPending: boolean;
+    isSuccess: boolean;
+    isError: boolean;
+    /**
+     * Creates a new GDM.
+     * @param userIds - The `userIds` of the users to invite to the GDM.
+     * @returns A promise that resolves to the result of the create operation.
+     */
+    createGDM: (users: {
+        userId: string;
+        appAddress?: string;
+    }[], channelProperties?: import("@towns-labs/proto").EncryptedData | undefined, streamSettings?: {
+        disableMiniblockCreation: boolean;
+        lightStream: boolean;
+    } | undefined) => Promise<{
+        streamId: string;
+    }>;
+};
+//# sourceMappingURL=useCreateGdm.d.ts.map

package/dist/types/useCreateGdm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCreateGdm.d.ts","sourceRoot":"","sources":["../../src/useCreateGdm.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,KAAK,YAAY,EAAa,MAAM,uBAAuB,CAAA;AAGpE;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,SAAS,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;;;;;;;;IAK7D;;;;OAIG;;;;;;;;;;CAIV,CAAA"}

package/dist/types/useCreateSpace.d.ts

@@ -0,0 +1,29 @@
+import type { Spaces } from '@towns-labs/sdk';
+import { type ActionConfig } from './internals/useAction';
+/**
+ * Hook to create a space.
+ * @param config - Configuration options for the action.
+ * @returns The `createSpace` action and its loading state.
+ */
+export declare const useCreateSpace: (config?: ActionConfig<Spaces["createSpace"]>) => {
+    data: {
+        spaceId: string;
+        defaultChannelId: string;
+    } | undefined;
+    error: Error | undefined;
+    isPending: boolean;
+    isSuccess: boolean;
+    isError: boolean;
+    /**
+     * Action to create a space.
+     * @param opts - Options for the create space action.
+     * @param signer - The signer used to create the space.
+     */
+    createSpace: (params: Partial<Omit<import("@towns-labs/web3").CreateSpaceParams, "spaceName">> & {
+        spaceName: string;
+    }, signer: import("ethers").Signer) => Promise<{
+        spaceId: string;
+        defaultChannelId: string;
+    }>;
+};
+//# sourceMappingURL=useCreateSpace.d.ts.map

package/dist/types/useCreateSpace.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCreateSpace.d.ts","sourceRoot":"","sources":["../../src/useCreateSpace.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAC7C,OAAO,EAAE,KAAK,YAAY,EAAa,MAAM,uBAAuB,CAAA;AAGpE;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,SAAQ,YAAY,CAAC,MAAM,CAAC,aAAa,CAAC,CAAM;;;;;;;;;IAKvE;;;;OAIG;;;;;;;CAIV,CAAA"}

package/dist/types/useDm.d.ts

@@ -0,0 +1,11 @@
+import type { DmModel } from '@towns-labs/sdk';
+import { type ObservableConfig } from './useObservable';
+/**
+ * Hook to get the data of a DM.
+ * You can use this hook to get DM metadata and if the user has joined the DM.
+ * @param streamId - The id of the DM to get the data of.
+ * @param config - Configuration options for the observable.
+ * @returns The DmModel of the DM.
+ */
+export declare const useDm: (streamId: string, config?: ObservableConfig.FromData<DmModel>) => import("./useObservable").ObservableValue<DmModel>;
+//# sourceMappingURL=useDm.d.ts.map

package/dist/types/useDm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDm.d.ts","sourceRoot":"","sources":["../../src/useDm.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAE9C,OAAO,EAAE,KAAK,gBAAgB,EAAiB,MAAM,iBAAiB,CAAA;AAEtE;;;;;;GAMG;AACH,eAAO,MAAM,KAAK,GAAI,UAAU,MAAM,EAAE,SAAS,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,uDAIlF,CAAA"}

package/dist/types/useGdm.d.ts

@@ -0,0 +1,11 @@
+import type { GdmModel } from '@towns-labs/sdk';
+import { type ObservableConfig } from './useObservable';
+/**
+ * Hook to get the data of a Group DM.
+ * You can use this hook to get Group DM metadata and if the user has joined the Group DM.
+ * @param streamId - The id of the Group DM to get the data of.
+ * @param config - Configuration options for the observable.
+ * @returns The GdmModel of the Group DM.
+ */
+export declare const useGdm: (streamId: string, config?: ObservableConfig.FromData<GdmModel>) => import("./useObservable").ObservableValue<GdmModel>;
+//# sourceMappingURL=useGdm.d.ts.map

package/dist/types/useGdm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useGdm.d.ts","sourceRoot":"","sources":["../../src/useGdm.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAE/C,OAAO,EAAE,KAAK,gBAAgB,EAAiB,MAAM,iBAAiB,CAAA;AAEtE;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,GAAI,UAAU,MAAM,EAAE,SAAS,gBAAgB,CAAC,QAAQ,CAAC,QAAQ,CAAC,wDAIpF,CAAA"}