@xhub-short/contracts 0.1.0-beta.11 → 0.1.0-beta.13

package/dist/index.d.ts

@@ -111,6 +111,8 @@ interface BaseContentItem {
  * This is the core data model for a video in the feed
  */
 interface VideoItem extends BaseContentItem {
+    /** Content type discriminator */
+    type: 'video';
     /** Video source configuration */
     source: VideoSource;
     /** Poster/thumbnail image URL */
@@ -1589,7 +1591,7 @@ type MessageValues = Record<string, MessageValue>;
  * - number.* : Number formatting suffixes
  * - error.* : Generic errors
  */
-type MessageKey = 'feed.loading' | 'feed.empty' | 'feed.endReached' | 'feed.error' | 'feed.retry' | 'player.loading' | 'player.error' | 'player.error.network' | 'player.error.decode' | 'player.error.notSupported' | 'player.error.aborted' | 'player.tapToRetry' | 'comment.title' | 'comment.placeholder' | 'comment.empty' | 'comment.loading' | 'comment.error' | 'comment.retry' | 'comment.post' | 'comment.reply' | 'comment.replyTo' | 'comment.viewReplies' | 'comment.hideReplies' | 'comment.loadReplies' | 'comment.viewMoreReplies' | 'comment.delete' | 'comment.edit' | 'comment.report' | 'comment.deleteConfirmTitle' | 'comment.deleteConfirmMessage' | 'comment.deleteConfirmButton' | 'comment.count' | 'comment.replyCount' | 'comment.expand' | 'comment.collapse' | 'action.like' | 'action.liked' | 'action.comment' | 'action.share' | 'action.bookmark' | 'action.bookmarked' | 'action.follow' | 'action.following' | 'time.now' | 'time.seconds' | 'time.minutes' | 'time.hours' | 'time.days' | 'time.weeks' | 'time.months' | 'time.years' | 'number.thousand' | 'number.million' | 'number.billion' | 'error.generic' | 'error.network' | 'error.timeout' | 'common.cancel' | 'cancel' | 'close' | 'ok' | 'done' | 'aria.loading' | 'aria.videoPlayer' | 'aria.retry' | 'aria.sortComments' | 'aria.closeComments' | 'aria.addMedia' | 'aria.submitComment' | 'aria.openEmoji' | 'aria.cancelReply' | 'guest.loginToComment';
+type MessageKey = 'feed.loading' | 'feed.empty' | 'feed.endReached' | 'feed.error' | 'feed.retry' | 'player.loading' | 'player.error' | 'player.error.network' | 'player.error.decode' | 'player.error.notSupported' | 'player.error.aborted' | 'player.tapToRetry' | 'comment.title' | 'comment.placeholder' | 'comment.empty' | 'comment.loading' | 'comment.error' | 'comment.retry' | 'comment.post' | 'comment.reply' | 'comment.replyTo' | 'comment.viewReplies' | 'comment.hideReplies' | 'comment.loadReplies' | 'comment.viewMoreReplies' | 'comment.delete' | 'comment.edit' | 'comment.report' | 'comment.deleteConfirmTitle' | 'comment.deleteConfirmMessage' | 'comment.deleteConfirmButton' | 'comment.count' | 'comment.replyCount' | 'comment.expand' | 'comment.collapse' | 'action.like' | 'action.liked' | 'action.comment' | 'action.share' | 'action.bookmark' | 'action.bookmarked' | 'action.follow' | 'action.following' | 'time.now' | 'time.seconds' | 'time.minutes' | 'time.hours' | 'time.days' | 'time.weeks' | 'time.months' | 'time.years' | 'number.thousand' | 'number.million' | 'number.billion' | 'error.generic' | 'error.network' | 'error.timeout' | 'common.cancel' | 'cancel' | 'close' | 'ok' | 'done' | 'aria.loading' | 'aria.videoPlayer' | 'aria.retry' | 'aria.sortComments' | 'aria.closeComments' | 'aria.addMedia' | 'aria.submitComment' | 'aria.openEmoji' | 'aria.cancelReply' | 'guest.loginToComment' | 'playlist.collection.title' | 'playlist.collection.items_count' | 'playlist.collection.empty_title' | 'playlist.collection.empty_desc' | 'playlist.collection.error_title' | 'playlist.collection.retry' | 'playlist.collection.return_home';
 /**
  * Complete message catalog type
  * All keys must be present
@@ -1675,6 +1677,85 @@ interface LocalizationConfig {
     adapter?: ILocalization;
 }
 
+/**
+ * Playlist data structure
+ */
+interface PlaylistData {
+    /** Unique playlist ID */
+    id: string;
+    /** Playlist title */
+    title: string;
+    /** Playlist description */
+    description?: string;
+    /** Playlist cover image URL */
+    cover?: string;
+    /** List of content items in this playlist */
+    items: ContentItem[];
+    /** Total number of items in playlist */
+    totalItems: number;
+}
+/**
+ * Playlist item metadata (within a playlist)
+ */
+type PlaylistItem = ContentItem & {
+    /** Position in the playlist (0-indexed) */
+    position: number;
+    /** ID of the playlist this item belongs to */
+    playlistId: string;
+};
+/**
+ * Summary of a playlist for collection views
+ */
+interface PlaylistSummary {
+    /** Unique playlist ID */
+    id: string;
+    /** Playlist title */
+    title: string;
+    /** Playlist description */
+    description?: string;
+    /** Playlist cover image URL */
+    cover?: string;
+    /** Total number of items in playlist */
+    totalItems: number;
+    /** Author/Creator information */
+    author?: {
+        id: string;
+        name: string;
+    };
+    /** Last update timestamp */
+    updatedAt?: string;
+}
+/**
+ * Response structure for playlist collection
+ */
+interface PlaylistCollectionResponse {
+    /** List of playlist summaries */
+    playlists: PlaylistSummary[];
+    /** Cursor for next page (null if no more data) */
+    nextCursor: string | null;
+    /** Whether there are more items to load */
+    hasMore: boolean;
+}
+/**
+ * Port for fetching playlist data
+ */
+interface IPlaylistDataSource {
+    /**
+     * Fetch a complete playlist by ID
+     *
+     * @param id - The playlist ID
+     * @returns Promise resolving to PlaylistData
+     */
+    fetchPlaylist(id: string): Promise<PlaylistData>;
+    /**
+     * Fetch a collection of playlists
+     *
+     * @param cursor - Pagination cursor
+     * @returns Promise resolving to PlaylistCollectionResponse
+     */
+    fetchPlaylistCollection(cursor?: string): Promise<PlaylistCollectionResponse>;
+}
+
 /**
  * UI Component Types for XHub-short SDK
  *
@@ -2384,4 +2465,4 @@ type IconComponent = UIComponent<{
  */
 type FormatCountFn = (count: number) => string;
 
-export { type ActionBarHeadlessProps, type ActionBarProps, type ActionButtonHeadlessProps, type AnalyticsConfig, type AnalyticsEvent, type AnalyticsEventType, type Author, type AuthorInfoHeadlessProps, type AuthorInfoProps, type BaseContentItem, type Comment, type CommentAdapterConfig, type CommentAuthor, type CommentConfig, type CommentEndpoints, type CommentInputHeadlessProps, type CommentItem, type CommentItemHeadlessProps, type CommentListResponse, type CommentManagerState, type CommentReportReason, type CommentSheetHeadlessProps, type CommentSheetProps, type CommentState, type CommentTransformers, type ContentItem, type ContentStats, DEFAULT_COMMENT_CONFIG, DEFAULT_COMMENT_ENDPOINTS, type DeleteCommentPayload, type EditCommentPayload, type ErrorBoundaryProps, type FeedResponse, type FeedState, type FormatCountFn, type IAnalytics, type ICommentAdapter, type IDataSource, type IInteraction, type ILocalization, type ILogger, type INetworkAdapter, type IPosterLoader, type ISessionStorage, type IStorage, type IVideoLoader, type IconComponent, type ImagePost, type ImagePostStats, type InternalLogger, type LocalizationConfig, type LogEntry, type LogLevel, type LoggerConfig, type MessageCatalog, type MessageKey, type MessageValue, type MessageValues, type MockCommentAdapterConfig, type MusicInfo, type NetworkQuality, type NetworkType, type OptimisticAction, type PartialMessageCatalog, type PlaybackState, type PlayerError, type PlayerState, type PostCommentPayload, type PostReplyPayload, type PrefetchCacheData, type PreloadConfig, type PreloadResult, type PreloadStatus, type ProgressBarHeadlessProps, type ReplyItem, type ReplyItemHeadlessProps, type ReplyListResponse, type ReportCommentPayload, type ReportReason, type SDKConfig, type SessionSnapshot, type SkeletonProps, type UIAuthorActions, type UIAuthorState, type UICommentActions, type UICommentState, type UIComponent, type UIFeedState, type UIInteractionActions, type UIInteractionState, type UINode, type UIPlayerControls, type UIPlayerState, type UIRef, type UIResourceState, type UISwipeState, type UIVideoInfoActions, type UIVideoInfoState, type VideoFeedHeadlessProps, type VideoFeedProps, type VideoInfoHeadlessProps, type VideoInfoProps, type VideoItem, type VideoPlayerHeadlessProps, type VideoPlayerWiredProps, type VideoQuality, type VideoSlotHeadlessProps, type VideoSlotProps, type VideoSource, type VideoStats, type WiredComponent, type WiredComponentConfig, isImagePost, isVideoItem };
+export { type ActionBarHeadlessProps, type ActionBarProps, type ActionButtonHeadlessProps, type AnalyticsConfig, type AnalyticsEvent, type AnalyticsEventType, type Author, type AuthorInfoHeadlessProps, type AuthorInfoProps, type BaseContentItem, type Comment, type CommentAdapterConfig, type CommentAuthor, type CommentConfig, type CommentEndpoints, type CommentInputHeadlessProps, type CommentItem, type CommentItemHeadlessProps, type CommentListResponse, type CommentManagerState, type CommentReportReason, type CommentSheetHeadlessProps, type CommentSheetProps, type CommentState, type CommentTransformers, type ContentItem, type ContentStats, DEFAULT_COMMENT_CONFIG, DEFAULT_COMMENT_ENDPOINTS, type DeleteCommentPayload, type EditCommentPayload, type ErrorBoundaryProps, type FeedResponse, type FeedState, type FormatCountFn, type IAnalytics, type ICommentAdapter, type IDataSource, type IInteraction, type ILocalization, type ILogger, type INetworkAdapter, type IPlaylistDataSource, type IPosterLoader, type ISessionStorage, type IStorage, type IVideoLoader, type IconComponent, type ImagePost, type ImagePostStats, type InternalLogger, type LocalizationConfig, type LogEntry, type LogLevel, type LoggerConfig, type MessageCatalog, type MessageKey, type MessageKey as MessageKeyType, type MessageValue, type MessageValues, type MockCommentAdapterConfig, type MusicInfo, type NetworkQuality, type NetworkType, type OptimisticAction, type PartialMessageCatalog, type PlaybackState, type PlayerError, type PlayerState, type PlaylistCollectionResponse, type PlaylistData, type PlaylistItem, type PlaylistSummary, type PostCommentPayload, type PostReplyPayload, type PrefetchCacheData, type PreloadConfig, type PreloadResult, type PreloadStatus, type ProgressBarHeadlessProps, type ReplyItem, type ReplyItemHeadlessProps, type ReplyListResponse, type ReportCommentPayload, type ReportReason, type SDKConfig, type SessionSnapshot, type SkeletonProps, type UIAuthorActions, type UIAuthorState, type UICommentActions, type UICommentState, type UIComponent, type UIFeedState, type UIInteractionActions, type UIInteractionState, type UINode, type UIPlayerControls, type UIPlayerState, type UIRef, type UIResourceState, type UISwipeState, type UIVideoInfoActions, type UIVideoInfoState, type VideoFeedHeadlessProps, type VideoFeedProps, type VideoInfoHeadlessProps, type VideoInfoProps, type VideoItem, type VideoPlayerHeadlessProps, type VideoPlayerWiredProps, type VideoQuality, type VideoSlotHeadlessProps, type VideoSlotProps, type VideoSource, type VideoStats, type WiredComponent, type WiredComponentConfig, isImagePost, isVideoItem };

package/dist/index.js

@@ -1,9 +1,9 @@
 // src/types.ts
 function isVideoItem(item) {
-  return "source" in item && "duration" in item;
+  return item.type === "video";
 }
 function isImagePost(item) {
-  return "type" in item && item.type === "image" && "images" in item;
+  return item.type === "image";
 }
 
 // src/comment-types.ts

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xhub-short/contracts",
   "sideEffects": false,
-  "version": "0.1.0-beta.11",
+  "version": "0.1.0-beta.13",
   "type": "module",
   "publishConfig": {
     "access": "public"
@@ -22,7 +22,7 @@
   "devDependencies": {
     "tsup": "^8.3.0",
     "typescript": "^5.7.0",
-    "@xhub-short/tsconfig": "0.0.0"
+    "@xhub-short/tsconfig": "0.0.1-beta.1"
   },
   "scripts": {
     "build": "tsup",