stream-chat-react 14.12.0 → 15.0.0-rc.1

package/dist/types/context/WorkspaceNavigationContext.d.ts

@@ -0,0 +1,128 @@
+import React from 'react';
+import type { PropsWithChildren } from 'react';
+import type { LocalMessage, Channel as StreamChannel, Thread as StreamThread } from 'stream-chat';
+/**
+ * Target for {@link WorkspaceNavigation.openThread}: an existing thread instance, or the channel +
+ * parent message from which one is derived.
+ */
+export type OpenThreadTarget = StreamThread | {
+    channel: StreamChannel;
+    message: LocalMessage;
+};
+/**
+ * A DOM event that may have triggered a workspace navigation. Restricted to the React event types
+ * that expose modifier keys (`metaKey`/`ctrlKey`/…) — the reason the event is forwarded at all — so
+ * overrides can read them without narrowing. `PointerEvent`, `DragEvent`, and `WheelEvent` extend
+ * `MouseEvent` and are accepted through it; `TouchEvent` and `KeyboardEvent` are the other carriers.
+ */
+export type WorkspaceNavigationTriggerEvent = React.MouseEvent | React.KeyboardEvent | React.TouchEvent;
+/** Identifies a panel of the workspace layout (for the slot layout, a slot name). */
+export type WorkspacePanelId = string;
+/**
+ * Declares the panel its subtree renders in. The layout provides it around each panel's content,
+ * so controls inside (e.g. a header's back and close buttons) act on their own panel even when the
+ * same channel or thread is open in more than one.
+ */
+export declare const WorkspacePanelProvider: ({ children, panel, }: PropsWithChildren<{
+    panel?: WorkspacePanelId;
+}>) => import("react/jsx-runtime").JSX.Element;
+/** The panel the calling component renders in, or `undefined` outside one. */
+export declare const useWorkspacePanel: () => WorkspacePanelId | undefined;
+/** Options shared by the workspace navigation operations. */
+export type WorkspaceNavigationOptions = {
+    /**
+     * Open *beside* the current content (e.g. ctrl/⌘-click) instead of replacing it, when the active
+     * workspace layout has room for a secondary panel. Ignored in single-panel layouts.
+     */
+    additive?: boolean;
+    /**
+     * The DOM event that triggered the navigation, when there is one. Forwarded by the SDK components
+     * that initiate navigation from a user gesture (channel-list / search-result selection, …) so a
+     * consumer overriding these operations (e.g. via `ChatView`'s `deriveWorkspaceNavigation`) can read
+     * modifier keys — deciding `additive` from ⌘/ctrl-click — without tracking key state globally.
+     */
+    event?: WorkspaceNavigationTriggerEvent;
+    /**
+     * Open *over* the current content as a transient layer instead of replacing it; dismissing the
+     * entity restores what was beneath. Ignored by layouts that do not support layering.
+     */
+    layer?: boolean;
+    /**
+     * The panel the operation is triggered from (see {@link WorkspacePanelProvider}). Resolves which
+     * panel an entity is in when the same channel or thread is open in more than one; without it, the
+     * first panel showing the entity is used.
+     */
+    panel?: WorkspacePanelId;
+};
+/**
+ * Slot-agnostic, intent-level navigation abstraction that core components depend on instead of the
+ * ChatView slot system (D1). The `slot-layout` plugin implements it over its layout controller; with
+ * no plugin installed the default is an inert no-op (D2) — core renders, navigation does nothing.
+ */
+export type WorkspaceNavigation = {
+    /**
+     * Whether the panel showing the channel or thread with `key` (a channel's `cid`, a thread's id)
+     * is stacked over other content that {@link WorkspaceNavigation.goBack} would reveal.
+     */
+    canGoBack: (key?: string, panel?: WorkspacePanelId) => boolean;
+    /**
+     * Dismiss the channel with `cid` from the workspace: close the panel showing it, together with
+     * anything stacked beneath it. Accepts the triggering event (see
+     * {@link WorkspaceNavigationOptions.event}).
+     */
+    closeChannel: (cid?: string, options?: WorkspaceNavigationOptions) => void;
+    /**
+     * Dismiss a thread from the workspace. With `threadId`, dismiss that thread's panel — together
+     * with anything stacked beneath it — otherwise the active thread panel. Does not deactivate the
+     * thread instance — the caller owns that. Accepts the triggering event (see
+     * {@link WorkspaceNavigationOptions.event}).
+     */
+    closeThread: (threadId?: string, options?: WorkspaceNavigationOptions) => void;
+    /**
+     * Step back from the channel or thread with `key`: remove it from the panel, revealing what it is
+     * stacked over. No-op when {@link WorkspaceNavigation.canGoBack} is false. Accepts the triggering
+     * event (see {@link WorkspaceNavigationOptions.event}).
+     */
+    goBack: (key?: string, options?: WorkspaceNavigationOptions) => void;
+    /**
+     * Whether the channel with `cid` is shown in the workspace: open in a panel and not covered by
+     * something stacked over it there.
+     */
+    isChannelActive: (cid?: string) => boolean;
+    /**
+     * Whether the channel panel for `cid` can be dismissed by the user — i.e. it is a secondary
+     * panel opened beside another channel, rather than the primary channel surface.
+     */
+    isChannelDismissable: (cid?: string, panel?: WorkspacePanelId) => boolean;
+    /**
+     * Whether the thread with `threadId` is shown in the workspace: open in a panel and not covered by
+     * something stacked over it there.
+     */
+    isThreadActive: (threadId?: string) => boolean;
+    /**
+     * Whether the thread panel for `threadId` (or the active thread) can be dismissed by the user —
+     * i.e. it is a closable side/secondary panel rather than the primary thread surface.
+     */
+    isThreadDismissable: (threadId?: string, panel?: WorkspacePanelId) => boolean;
+    /** Whether the thread-list ("threads") workspace view is the active one. */
+    isThreadsView: boolean;
+    /** Open `channel` in the workspace. */
+    openChannel: (channel: StreamChannel, options?: WorkspaceNavigationOptions) => void;
+    /** Channels currently open in the workspace (empty when none / no plugin). */
+    openChannels: StreamChannel[];
+    /** Open a thread — by instance, or derived from `{ channel, message }`. */
+    openThread: (target: OpenThreadTarget, options?: WorkspaceNavigationOptions) => void;
+    /** Threads currently open in the workspace (empty when none / no plugin). */
+    openThreads: StreamThread[];
+};
+/** Inert no-op default (D2): used when no `slot-layout` plugin provides an implementation. */
+export declare const defaultWorkspaceNavigation: WorkspaceNavigation;
+export declare const WorkspaceNavigationProvider: ({ children, value, }: PropsWithChildren<{
+    value: WorkspaceNavigation;
+}>) => import("react/jsx-runtime").JSX.Element;
+/**
+ * Access the workspace navigation abstraction. Returns the inert no-op default outside a
+ * `slot-layout` provider, so callers can navigate unconditionally without guarding for a provider.
+ */
+export declare const useWorkspaceNavigation: () => WorkspaceNavigation;
+//# sourceMappingURL=WorkspaceNavigationContext.d.ts.map

package/dist/types/context/WorkspaceNavigationContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WorkspaceNavigationContext.d.ts","sourceRoot":"","sources":["../../../src/context/WorkspaceNavigationContext.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAoC,MAAM,OAAO,CAAC;AAEzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAC/C,OAAO,KAAK,EACV,YAAY,EACZ,OAAO,IAAI,aAAa,EACxB,MAAM,IAAI,YAAY,EACvB,MAAM,aAAa,CAAC;AAErB;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GACxB,YAAY,GACZ;IAAE,OAAO,EAAE,aAAa,CAAC;IAAC,OAAO,EAAE,YAAY,CAAA;CAAE,CAAC;AAEtD;;;;;GAKG;AACH,MAAM,MAAM,+BAA+B,GACvC,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,aAAa,GACnB,KAAK,CAAC,UAAU,CAAC;AAErB,qFAAqF;AACrF,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAItC;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GAAI,sBAGpC,iBAAiB,CAAC;IAAE,KAAK,CAAC,EAAE,gBAAgB,CAAA;CAAE,CAAC,4CAIjD,CAAC;AAEF,8EAA8E;AAC9E,eAAO,MAAM,iBAAiB,QAAO,gBAAgB,GAAG,SACrB,CAAC;AAEpC,6DAA6D;AAC7D,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,+BAA+B,CAAC;IACxC;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;;OAIG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC;CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;OAGG;IACH,SAAS,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,gBAAgB,KAAK,OAAO,CAAC;IAC/D;;;;OAIG;IACH,YAAY,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,0BAA0B,KAAK,IAAI,CAAC;IAC3E;;;;;OAKG;IACH,WAAW,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,0BAA0B,KAAK,IAAI,CAAC;IAC/E;;;;OAIG;IACH,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,0BAA0B,KAAK,IAAI,CAAC;IACrE;;;OAGG;IACH,eAAe,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC;IAC3C;;;OAGG;IACH,oBAAoB,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,gBAAgB,KAAK,OAAO,CAAC;IAC1E;;;OAGG;IACH,cAAc,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC;IAC/C;;;OAGG;IACH,mBAAmB,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,gBAAgB,KAAK,OAAO,CAAC;IAC9E,4EAA4E;IAC5E,aAAa,EAAE,OAAO,CAAC;IACvB,uCAAuC;IACvC,WAAW,EAAE,CAAC,OAAO,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,0BAA0B,KAAK,IAAI,CAAC;IACpF,8EAA8E;IAC9E,YAAY,EAAE,aAAa,EAAE,CAAC;IAC9B,2EAA2E;IAC3E,UAAU,EAAE,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,0BAA0B,KAAK,IAAI,CAAC;IACrF,6EAA6E;IAC7E,WAAW,EAAE,YAAY,EAAE,CAAC;CAC7B,CAAC;AAKF,8FAA8F;AAC9F,eAAO,MAAM,0BAA0B,EAAE,mBAcxC,CAAC;AAMF,eAAO,MAAM,2BAA2B,GAAI,sBAGzC,iBAAiB,CAAC;IAAE,KAAK,EAAE,mBAAmB,CAAA;CAAE,CAAC,4CAInD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,sBAAsB,QAAO,mBACF,CAAC"}

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

@@ -1,20 +1,22 @@
+export * from './AttachmentContext';
 export * from './AttachmentSelectorContext';
-export * from './ChannelActionContext';
 export * from './ChannelListContext';
-export * from './ChannelStateContext';
+export * from './ChannelInstanceContext';
 export * from './ChatContext';
 export * from './ComponentContext';
-export * from './useComponentContextIcons';
 export * from './DialogManagerContext';
 export * from './MessageContext';
 export * from './MessageBounceContext';
 export * from './MessageComposerContext';
+export * from './MessageComposerControllerContext';
 export * from './MessageListContext';
 export * from './MessageTranslationViewContext';
 export * from './ModalContext';
 export * from './PollContext';
 export * from './TranslationContext';
-export * from './TypingContext';
+export * from './useChannel';
+export * from './useComponentContextIcons';
 export * from './VirtualizedMessageListContext';
 export * from './WithComponents';
+export * from './WorkspaceNavigationContext';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/context/index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iCAAiC,CAAC;AAChD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iCAAiC,CAAC;AAChD,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/context/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oCAAoC,CAAC;AACnD,cAAc,sBAAsB,CAAC;AACrC,cAAc,iCAAiC,CAAC;AAChD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,kBAAkB,CAAC;AACjC,cAAc,8BAA8B,CAAC"}

package/dist/types/context/requireContext.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Guard for context hooks whose provider is mandatory: returns the value, or throws an error naming
+ * the hook and the missing provider. Contexts with a meaningful default return that default
+ * instead, so their components keep rendering outside a provider.
+ *
+ * Compares against `undefined` so a context legitimately holding `null`, `0` or `''` still counts
+ * as present.
+ */
+export declare const requireContext: <T>(value: T | undefined, hookName: string, providerName: string) => T;
+//# sourceMappingURL=requireContext.d.ts.map

package/dist/types/context/requireContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requireContext.d.ts","sourceRoot":"","sources":["../../../src/context/requireContext.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,GAAI,CAAC,EAC9B,OAAO,CAAC,GAAG,SAAS,EACpB,UAAU,MAAM,EAChB,cAAc,MAAM,KACnB,CASF,CAAC"}

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

@@ -0,0 +1,3 @@
+import type { Channel } from 'stream-chat';
+export declare const useChannel: () => Channel;
+//# sourceMappingURL=useChannel.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useChannel.d.ts","sourceRoot":"","sources":["../../../src/context/useChannel.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAE3C,eAAO,MAAM,UAAU,QAAO,OAa7B,CAAC"}

package/dist/types/context/useComponentContextIcons.d.ts

@@ -1,16 +1,14 @@
 import type { IconSlots } from '../components/Icons/slots';
 /**
- * Reads the `icons` override from `ComponentContext` and merges it on top of
- * `DEFAULT_ICONS`. Every returned icon is guaranteed defined, so callers can
- * destructure without fallbacks:
+ * Reads the `icons` override from `ComponentContext` and merges it over the SDK's own icons. Every
+ * slot is guaranteed defined, so callers destructure without fallbacks:
  *
  * ```tsx
  * const { IconFlag } = useComponentContextIcons();
  * ```
  *
- * Overrides supplied via `<WithComponents overrides={{ icons: { … } }} />` win
- * over defaults on a per-slot basis; slots the consumer didn't provide fall
- * back to the SDK's own icon.
+ * Overrides supplied via `<WithComponents overrides={{ icons: { … } }} />` win per slot; slots the
+ * consumer did not provide fall back to the SDK icon.
  */
 export declare const useComponentContextIcons: () => Required<IconSlots>;
 //# sourceMappingURL=useComponentContextIcons.d.ts.map

package/dist/types/context/useComponentContextIcons.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useComponentContextIcons.d.ts","sourceRoot":"","sources":["../../../src/context/useComponentContextIcons.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAE3D;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,wBAAwB,QAAO,QAAQ,CAAC,SAAS,CAa7D,CAAC"}
+{"version":3,"file":"useComponentContextIcons.d.ts","sourceRoot":"","sources":["../../../src/context/useComponentContextIcons.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAE3D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,wBAAwB,QAAO,QAAQ,CAAC,SAAS,CAc7D,CAAC"}

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

@@ -0,0 +1,3 @@
+export * from './useIsDmChannel';
+export * from './useMessagePaginator';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC"}

package/dist/types/hooks/useIsDmChannel.d.ts

@@ -0,0 +1,13 @@
+import type { Channel } from 'stream-chat';
+export type UseIsDmChannelParams = {
+    channel?: Channel;
+};
+/**
+ * Reactively determines whether a channel is a direct-messaging channel.
+ *
+ * Subscribes to the channel's members state so the result recomputes when membership
+ * changes, then delegates the actual check to the `isDmChannel` util. Defaults to the
+ * channel from context; pass `channel` to check a specific one.
+ */
+export declare const useIsDmChannel: ({ channel: channelOverride, }?: UseIsDmChannelParams) => boolean;
+//# sourceMappingURL=useIsDmChannel.d.ts.map

package/dist/types/hooks/useIsDmChannel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useIsDmChannel.d.ts","sourceRoot":"","sources":["../../../src/hooks/useIsDmChannel.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAgB,MAAM,aAAa,CAAC;AAMzD,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAOF;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,gCAE5B,oBAAyB,YAQ3B,CAAC"}

package/dist/types/hooks/useMessagePaginator.d.ts

@@ -0,0 +1,6 @@
+import type { MessagePaginator } from 'stream-chat';
+/**
+ * Hook can be used only in children of <Channel/> and <Thread/> components.
+ */
+export declare const useMessagePaginator: () => MessagePaginator;
+//# sourceMappingURL=useMessagePaginator.d.ts.map

package/dist/types/hooks/useMessagePaginator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useMessagePaginator.d.ts","sourceRoot":"","sources":["../../../src/hooks/useMessagePaginator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAIpD;;GAEG;AACH,eAAO,MAAM,mBAAmB,QAAO,gBAKtC,CAAC"}