@codingfactory/socialkit-vue 0.4.0 → 0.5.0

package/src/types/discussion.ts

@@ -0,0 +1,274 @@
+/**
+ * Discussion-domain types and store contracts shared across SocialKit frontends.
+ */
+
+import type { AxiosInstance } from 'axios'
+
+export type AvatarLike =
+  | string
+  | {
+      url?: string | null
+      thumb_url?: string | null
+      preview_url?: string | null
+      urls?: Record<string, string | null | undefined>
+    }
+  | null
+  | undefined
+
+export interface SpaceBreadcrumb {
+  id: string
+  slug: string
+  name: string
+}
+
+export interface SpaceMembership {
+  space_id: string
+  is_member: boolean
+  member_count: number
+}
+
+export interface SpaceModerationPolicyObject {
+  summary?: string
+  rules?: string[]
+  notes?: string[]
+}
+
+export interface SpaceMeta {
+  icon?: string
+  color?: string
+  category?: string
+  is_category?: boolean
+  member_count?: number
+  online_count?: number
+  is_featured?: boolean
+  rules?: string[]
+  moderation_policy?: string | string[] | SpaceModerationPolicyObject
+}
+
+export interface Space {
+  id: string
+  slug: string
+  name: string
+  description?: string
+  kind: 'forum' | 'context'
+  visibility?: string
+  meta?: SpaceMeta
+  parent_id?: string | null
+  depth?: number
+  children_count?: number
+  children?: Space[]
+  breadcrumb?: SpaceBreadcrumb[]
+  is_leaf?: boolean
+  thread_count?: number
+  post_count?: number
+  last_activity_at?: string
+  created_at: string
+}
+
+export interface DiscussionAttachment {
+  id: string
+  uuid: string
+  mime_type: string
+  size: number
+  name: string
+  type: 'image' | 'video'
+  is_image: boolean
+  url?: string
+  thumb_url?: string | null
+  preview_url?: string | null
+  urls?: Record<string, string>
+  responsive?: unknown
+  playback_url?: string | null
+  provider?: string | null
+  playback_id?: string | null
+  provider_asset_id?: string | null
+  processing_status?: string | null
+  duration?: number | null
+  width?: number | null
+  height?: number | null
+  aspect_ratio?: string | null
+  thumbnail_url?: string | null
+}
+
+export interface DiscussionTag {
+  id: string
+  slug: string
+  label: string
+  thread_count?: number
+}
+
+export type SpaceThreadSort = 'most_active' | 'newest' | 'oldest'
+export type ReplyReactionKind = 'like' | 'dislike'
+
+export interface DiscussionAuthor {
+  id: string
+  name: string
+  handle?: string | null
+  avatar?: AvatarLike
+  avatar_url?: string | null
+}
+
+export interface ThreadMeta {
+  views?: number
+  upvotes?: number
+  tags?: string[]
+}
+
+export interface Thread {
+  id: string
+  space_id: string
+  author_id: string
+  author?: DiscussionAuthor
+  title: string
+  body?: string
+  slug?: string
+  audience: 'public' | 'authenticated' | 'private'
+  status: 'open' | 'locked' | 'archived'
+  is_pinned: boolean
+  reply_count: number
+  last_activity_at: string
+  created_at: string
+  meta?: ThreadMeta
+  tags?: DiscussionTag[]
+  is_subscribed?: boolean
+  media?: DiscussionAttachment[]
+  deleted_at?: string | null
+}
+
+export interface ReplyReactionObject {
+  kind: string
+}
+
+export interface QuotedReplyAuthor {
+  id: string
+  name: string
+  handle?: string | null
+}
+
+export interface QuotedReply {
+  id: string
+  author_id: string
+  author?: QuotedReplyAuthor | null
+  body: string
+}
+
+export interface ReplyMeta {
+  upvotes?: number
+  is_solution?: boolean
+}
+
+export interface Reply {
+  id: string
+  thread_id: string
+  author_id: string
+  author?: DiscussionAuthor
+  body: string
+  parent_id?: string | null
+  parent_reply_id?: string | null
+  depth?: number
+  display_depth?: number
+  reply_count?: number
+  children_count?: number
+  created_at: string
+  updated_at: string
+  likes_count?: number
+  dislikes_count?: number
+  user_reaction?: ReplyReactionObject | string | null
+  quoted_reply_id?: string | null
+  quoted_reply?: QuotedReply | null
+  quote_data?: Record<string, unknown> | null
+  is_initial_reply?: boolean
+  meta?: ReplyMeta
+  media?: DiscussionAttachment[]
+}
+
+export interface CreateThreadInput {
+  title: string
+  body: string
+  audience?: 'public' | 'authenticated' | 'private'
+  media_ids?: string[]
+  tags?: string[]
+}
+
+export interface UpdateThreadInput {
+  title?: string
+  body?: string
+  media_ids?: string[]
+}
+
+export interface CreateReplyInput {
+  body: string
+  parent_id?: string
+  media_ids?: string[]
+  quoted_reply_id?: string
+}
+
+export interface SaveDraftOptions {
+  title?: string
+  metadata?: Record<string, unknown>
+  format?: 'markdown' | 'html'
+}
+
+export interface QuoteResponseMetadata {
+  author: {
+    id: string
+    name: string
+    handle: string
+  }
+  reply_id: string
+  thread_id: string
+  created_at: string
+}
+
+export interface QuoteResponse {
+  quote_text: string
+  quote_data: Record<string, unknown>
+  metadata?: QuoteResponseMetadata
+}
+
+export interface DiscussionCategorySummary {
+  name: string
+  count: number
+  icon?: string
+  color?: string
+}
+
+interface DiscussionReadableValue<TValue> {
+  readonly value: TValue
+}
+
+export interface DiscussionLoadingState {
+  isLoading?: DiscussionReadableValue<boolean>
+  error?: DiscussionReadableValue<Error | null>
+  isEmpty?: DiscussionReadableValue<boolean>
+  isRetrying?: DiscussionReadableValue<boolean>
+  retryCount?: DiscussionReadableValue<number>
+  canRetry?: DiscussionReadableValue<boolean>
+  shouldShowSkeleton?: DiscussionReadableValue<boolean>
+  shouldShowError?: DiscussionReadableValue<boolean>
+  shouldShowEmpty?: DiscussionReadableValue<boolean>
+  setLoading(loading: boolean): void
+  setError(error: Error | null): void
+  setEmpty(empty: boolean): void
+  setRetrying?(retrying: boolean): void
+  reset?(): void
+}
+
+export interface DiscussionRealtimeChannelLike {
+  listen(event: string, callback: (payload: unknown) => void): DiscussionRealtimeChannelLike
+}
+
+export interface DiscussionRealtimeClientLike {
+  private(channel: string): DiscussionRealtimeChannelLike
+  leave(channel: string): void
+}
+
+export interface DiscussionStoreConfig {
+  client: AxiosInstance
+  getCurrentUserId: () => string | null
+  getEcho: () => DiscussionRealtimeClientLike | null
+  onEchoReconnected: (callback: () => void) => (() => void) | void
+  createLoadingState: () => DiscussionLoadingState
+  logger?: Pick<Console, 'error'>
+  storeId?: string
+}