@lark-apaas/coding-template-nestjs-react-fullstack 0.1.60-alpha.20261105142153 → 0.1.60-beta.0

package/template/client/src/components/business-ui/comments/contracts.ts

@@ -1,256 +0,0 @@
-import type { ComponentPropsWithoutRef, ReactNode } from 'react';
-export type EntityRef = {
-  kind: 'user' | 'document';
-  namespace: string;
-  id: string;
-};
-export type UserRef = EntityRef & { kind: 'user' };
-export interface CommentAuthor {
-  ref: UserRef;
-  name?: string;
-  avatarUrl?: string;
-}
-export type CommentNode =
-  | { type: 'text'; text: string }
-  | { type: 'break' }
-  | { type: 'link'; url: string; label?: string }
-  | { type: 'mention'; ref: EntityRef; label?: string; href?: string }
-  | { type: 'unresolved-mention' }
-  | { type: 'unsupported'; label: string };
-export interface CommentContent {
-  version: 1;
-  nodes: CommentNode[];
-}
-export interface CommentAttachment {
-  id: string;
-  kind: 'image' | 'file';
-  name: string;
-  url?: string;
-  mimeType?: string;
-  width?: number;
-  height?: number;
-}
-export type CommentAttachmentInput =
-  | { kind: 'existing'; attachment: CommentAttachment }
-  | { kind: 'local'; localId: string; file: File };
-export interface CommentReaction {
-  key: string;
-  count: number;
-  mine?: boolean;
-  previewUsers?: CommentAuthor[];
-}
-export interface CommentMessage {
-  /** Optional server-echoed idempotency correlation; never synthesize from matching text. */
-  clientOperationId?: string;
-  id: string;
-  author: CommentAuthor | null;
-  content: CommentContent;
-  createdAt: number;
-  updatedAt?: number;
-  edited?: boolean;
-  attachments?: CommentAttachment[];
-  reactions?: CommentReaction[];
-  permissions?: { edit: boolean; delete: boolean; react?: boolean };
-}
-export interface CommentPagination {
-  hasMore: boolean;
-  loading?: boolean;
-  error?: string;
-  onLoadMore(): Promise<void>;
-}
-export interface CommentThread {
-  id: string;
-  messages: CommentMessage[];
-  resolved?: boolean;
-  canReply?: boolean;
-  repliesPagination?: CommentPagination;
-}
-export interface CommentTarget {
-  threadId: string;
-  messageId: string;
-}
-export interface CommentDraft {
-  content: CommentContent;
-  attachments: CommentAttachmentInput[];
-}
-export interface CommentMutationContext {
-  operationId: string;
-  signal: AbortSignal;
-}
-export interface CommentWriteResult extends CommentTarget {
-  message?: CommentMessage;
-}
-export interface CommentActions {
-  create?(
-    input: CommentDraft & { threadId?: string; replyToMessageId?: string },
-    context: CommentMutationContext,
-  ): Promise<CommentWriteResult>;
-  update?(
-    input: CommentDraft & CommentTarget,
-    context: CommentMutationContext,
-  ): Promise<CommentWriteResult>;
-  remove?(
-    target: CommentTarget,
-    context: CommentMutationContext,
-  ): Promise<{ threadId: string; threadDeleted?: boolean }>;
-}
-export interface CommentEntityOption {
-  ref: EntityRef;
-  label: string;
-  avatarUrl?: string;
-  description?: string;
-  href?: string;
-  readable?: boolean;
-}
-export type CommentEntityResult =
-  | (CommentEntityOption & { status: 'resolved' })
-  | { ref: EntityRef; status: 'forbidden' | 'not-found' | 'error' };
-export interface CommentEntitySource {
-  search?(args: {
-    query: string;
-    cursor?: string;
-    signal: AbortSignal;
-  }): Promise<{ items: CommentEntityOption[]; nextCursor?: string }>;
-  recommend?(args: {
-    cursor?: string;
-    signal: AbortSignal;
-  }): Promise<{ items: CommentEntityOption[]; nextCursor?: string }>;
-  resolve(
-    refs: EntityRef[],
-    signal: AbortSignal,
-  ): Promise<CommentEntityResult[]>;
-  parseUrl?(url: string): EntityRef | undefined;
-}
-export interface CommentEmoji {
-  key: string;
-  label: string;
-  text?: string;
-  url?: string;
-  group?: string;
-}
-export interface CommentReactionFeature {
-  catalog?: readonly CommentEmoji[];
-  allowedKeys?: readonly string[];
-  onChange?(
-    input: CommentTarget & { key: string; action: 'add' | 'remove' },
-    context: CommentMutationContext,
-  ): Promise<{ reactions?: CommentReaction[] }>;
-}
-export type CommentExtension =
-  | { type: 'reactions'; options: CommentReactionFeature }
-  | { type: 'documents'; source: CommentEntitySource; canInsert: boolean }
-  | { type: 'images' };
-export interface CommentsProviderProps {
-  scopeKey: string;
-  subjectKey: string;
-  threads: readonly CommentThread[];
-  currentUser?: CommentAuthor;
-  actions?: CommentActions;
-  loading?: boolean;
-  error?: string;
-  onRetry?: () => Promise<void>;
-  pagination?: CommentPagination;
-  actors?: CommentEntitySource;
-  input?: { userMentions?: (ref: UserRef) => boolean; links?: boolean };
-  extensions?: readonly CommentExtension[];
-  onActorClick?: (ref: UserRef, anchor: HTMLElement) => void;
-  getMessageLink?: (target: CommentTarget) => string | undefined;
-  validateDraft?: (
-    draft: CommentDraft,
-    target: {
-      mode: 'create' | 'update';
-      threadId?: string;
-      messageId?: string;
-    },
-  ) => string | undefined;
-  children: ReactNode;
-}
-export type CommentListProps = Omit<
-  ComponentPropsWithoutRef<'div'>,
-  'children' | 'dangerouslySetInnerHTML'
->;
-export type CommentComposerProps = CommentListProps & {
-  placeholder?: string;
-  disabled?: boolean;
-};
-
-/** Adapter reads return data and cursors, never React callbacks or loading state. */
-export type CommentPageThread = Omit<CommentThread, 'repliesPagination'> & {
-  nextReplyCursor?: string;
-};
-export interface CommentPage {
-  threads: CommentPageThread[];
-  nextCursor?: string;
-}
-export interface CommentRepliesPage {
-  messages: CommentMessage[];
-  nextCursor?: string;
-}
-export interface CommentResource {
-  resourceKey: string;
-}
-export interface CommentListRequest extends CommentResource {
-  cursor?: string;
-  signal: AbortSignal;
-}
-export interface CommentAdapter {
-  /** Stable backend/tenant/auth scope. Current-user identity is additionally isolated by the hook. */
-  scopeKey: string;
-  list(input: CommentListRequest): Promise<CommentPage>;
-  listReplies?(
-    input: CommentListRequest & { threadId: string },
-  ): Promise<CommentRepliesPage>;
-  create?(
-    input: CommentDraft &
-      CommentResource & { threadId?: string; replyToMessageId?: string },
-    context: CommentMutationContext,
-  ): Promise<CommentWriteResult>;
-  update?(
-    input: CommentDraft & CommentTarget & CommentResource,
-    context: CommentMutationContext,
-  ): Promise<CommentWriteResult>;
-  remove?(
-    input: CommentTarget & CommentResource,
-    context: CommentMutationContext,
-  ): Promise<{ threadId: string; threadDeleted?: boolean }>;
-  people?: {
-    source: CommentEntitySource;
-    canMention?: (ref: UserRef) => boolean;
-    onClick?: CommentsProviderProps['onActorClick'];
-  };
-  documents?: { source: CommentEntitySource; canInsert?: boolean };
-  reactions?: Omit<CommentReactionFeature, 'onChange'> & {
-    onChange?(
-      input: CommentTarget &
-        CommentResource & { key: string; action: 'add' | 'remove' },
-      context: CommentMutationContext,
-    ): Promise<{ reactions?: CommentReaction[] }>;
-  };
-  /** Enable only when create/update can persist the complete image-bearing message. */
-  images?: boolean;
-  links?: boolean;
-  getMessageLink?(target: CommentTarget & CommentResource): string | undefined;
-  validateDraft?: CommentsProviderProps['validateDraft'];
-}
-export interface UseCommentsOptions {
-  resourceKey: string;
-  currentUser?: CommentAuthor;
-  adapter: CommentAdapter;
-}
-export interface CommentsController {
-  readonly props: Omit<CommentsProviderProps, 'children'>;
-  readonly refreshing: boolean;
-  refresh(): Promise<void>;
-  loadMore(): Promise<void>;
-}
-type ManagedInput<Controlled> = { value: CommentsController } & {
-  [K in keyof Controlled]?: never;
-};
-export type CommentsProviderInput =
-  | (CommentsProviderProps & { value?: never })
-  | (ManagedInput<Omit<CommentsProviderProps, 'children'>> & {
-      children: ReactNode;
-    });
-export type CommentPanelInput =
-  | (Omit<CommentsProviderProps, 'children'> & { value?: never })
-  | ManagedInput<Omit<CommentsProviderProps, 'children'>>;

package/template/client/src/components/business-ui/comments/index.ts

@@ -1,20 +0,0 @@
-export { useComments } from './use-comments';
-export { CommentsProvider, CommentPanel } from './comments';
-export { CommentList, CommentComposer } from '../record-comments/comment-panel';
-export type * from './contracts';
-import type {
-  CommentEntitySource,
-  CommentExtension,
-  CommentReactionFeature,
-} from './contracts';
-export const commentReactions = (
-  options: CommentReactionFeature = {},
-): CommentExtension => ({ type: 'reactions', options });
-export const commentDocuments = ({
-  source,
-  canInsert = false,
-}: {
-  source: CommentEntitySource;
-  canInsert?: boolean;
-}): CommentExtension => ({ type: 'documents', source, canInsert });
-export const commentImages = (): CommentExtension => ({ type: 'images' });