@audius/sdk 15.1.0 → 15.3.0

package/src/sdk/api/comments/types.ts

@@ -3,17 +3,41 @@ import { z } from 'zod'
 import type { EntityManagerService } from '../../services'
 import { HashId } from '../../types/HashId'
 import type { CommentEntityType } from '../generated/default'
+import type { Comment } from '../generated/default/models/Comment'
+import type { Track } from '../generated/default/models/Track'
+import type { User } from '../generated/default/models/User'
 
 export type CommentsApiServicesConfig = {
   entityManager?: EntityManagerService
 }
 
+/** Fan-club feed item: root coin-thread comment (text post) or artist track. */
+export type FanClubFeedTextPostItem = {
+  item_type: 'text_post'
+  comment: Comment
+}
+
+export type FanClubFeedTrackItem = {
+  item_type: 'track'
+  track: Track
+}
+
+export type FanClubFeedItem = FanClubFeedTextPostItem | FanClubFeedTrackItem
+
+export type FanClubFeedResponse = {
+  data: FanClubFeedItem[]
+  related: {
+    users: User[]
+    tracks: Track[]
+  }
+}
+
 export type CommentMetadata = {
   body?: string
   commentId?: number
   userId: number
-  entityId: number
-  entityType?: CommentEntityType // For now just tracks are supported, but we left the door open for more
+  entityId?: number
+  entityType?: CommentEntityType
   parentCommentId?: number
   trackTimestampS?: number
   mentions?: number[]
@@ -23,15 +47,25 @@ export type CommentMetadata = {
 export const CreateCommentSchema = z
   .object({
     userId: HashId,
-    entityId: HashId,
-    entityType: z.optional(z.string()),
+    entityId: z.optional(HashId),
+    entityType: z.optional(z.enum(['Track', 'FanClub', 'Event'])),
     body: z.optional(z.string()),
     commentId: z.optional(z.number()),
     parentCommentId: z.optional(z.number()),
     trackTimestampS: z.optional(z.number()),
-    mentions: z.optional(z.array(z.number()))
+    mentions: z.optional(z.array(z.number())),
+    isMembersOnly: z.optional(z.boolean()),
+    videoUrl: z.optional(z.string())
   })
   .strict()
+  .refine(
+    (data) => {
+      return data.entityId !== undefined
+    },
+    {
+      message: 'Comments require entityId'
+    }
+  )
 
 export type EntityManagerCreateCommentRequest = z.input<
   typeof CreateCommentSchema
@@ -41,10 +75,20 @@ export const UpdateCommentSchema = z
   .object({
     userId: HashId,
     entityId: HashId,
-    trackId: HashId,
-    body: z.string()
+    trackId: z.optional(HashId),
+    entityType: z.optional(z.enum(['Track', 'FanClub', 'Event'])),
+    body: z.string(),
+    mentions: z.optional(z.array(z.number()))
   })
   .strict()
+  .refine(
+    (data) => {
+      return data.trackId !== undefined
+    },
+    {
+      message: 'Comment updates require trackId'
+    }
+  )
 
 export type EntityManagerUpdateCommentRequest = z.input<
   typeof UpdateCommentSchema
@@ -77,9 +121,18 @@ export const ReactCommentSchema = z
     userId: HashId,
     commentId: HashId,
     isLiked: z.boolean(),
-    trackId: HashId
+    trackId: z.optional(HashId),
+    entityType: z.optional(z.enum(['Track', 'FanClub', 'Event']))
   })
   .strict()
+  .refine(
+    (data) => {
+      return data.trackId !== undefined
+    },
+    {
+      message: 'Reactions require trackId'
+    }
+  )
 
 export type EntityManagerReactCommentRequest = z.input<
   typeof ReactCommentSchema

package/src/sdk/api/events/EventsApi.ts

@@ -10,7 +10,9 @@ import { decodeHashId } from '../../utils/hashId'
 import { parseParams } from '../../utils/parseParams'
 import {
   Configuration,
-  EventsApi as GeneratedEventsApi
+  EventsApi as GeneratedEventsApi,
+  type FollowEventRequest,
+  type UnfollowEventRequest
 } from '../generated/default'
 
 import {
@@ -20,6 +22,10 @@ import {
   UpdateEventSchema,
   DeleteEventRequest,
   DeleteEventSchema,
+  EntityManagerFollowEventRequest,
+  EntityManagerFollowEventSchema,
+  EntityManagerUnfollowEventRequest,
+  EntityManagerUnfollowEventSchema,
   type EventsApiServicesConfig
 } from './types'
 
@@ -44,7 +50,6 @@ export class EventsApi extends GeneratedEventsApi {
    * Create an event
    */
   async createEvent(params: CreateEventRequest) {
-    // Parse inputs
     const parsedParameters = await parseParams(
       'createEvent',
       CreateEventSchema
@@ -87,7 +92,6 @@ export class EventsApi extends GeneratedEventsApi {
    * Update an event
    */
   async updateEvent(params: UpdateEventRequest) {
-    // Parse inputs
     const parsedParameters = await parseParams(
       'updateEvent',
       UpdateEventSchema
@@ -110,11 +114,99 @@ export class EventsApi extends GeneratedEventsApi {
     return response
   }
 
+  /**
+   * @hidden
+   * Follow (subscribe to) a remix-contest event via the entity manager —
+   * submits a Subscribe/Event ManageEntity transaction directly from the
+   * client. The indexer writes a row into `subscriptions` tagged with
+   * entity_type='Event'; next time the event owner posts an update, the
+   * follower receives a notification.
+   */
+  async followEventWithEntityManager(params: EntityManagerFollowEventRequest) {
+    const { userId, eventId } = await parseParams(
+      'followEvent',
+      EntityManagerFollowEventSchema
+    )(params)
+
+    if (!this.entityManager) {
+      throw new UninitializedEntityManagerError()
+    }
+    return this.entityManager.manageEntity({
+      entityId: eventId,
+      userId,
+      entityType: EntityType.EVENT,
+      action: Action.SUBSCRIBE,
+      metadata: ''
+    })
+  }
+
+  /**
+   * Follow a remix-contest event. When called with the entity-manager
+   * shape (numeric `userId`) the client submits the tx directly; otherwise
+   * we fall through to the generated HTTP path which routes through the
+   * api's `POST /v1/events/{eventId}/follow` endpoint. Mirrors the
+   * followUser dual-path pattern.
+   */
+  override async followEvent(
+    params: EntityManagerFollowEventRequest | FollowEventRequest,
+    requestInit?: RequestInit
+  ) {
+    if (
+      this.entityManager &&
+      'userId' in params &&
+      typeof (params as EntityManagerFollowEventRequest).userId === 'number'
+    ) {
+      return await this.followEventWithEntityManager(
+        params as EntityManagerFollowEventRequest
+      )
+    }
+    return super.followEvent(params as FollowEventRequest, requestInit)
+  }
+
+  /**
+   * @hidden
+   * Unfollow a remix-contest event via the entity manager.
+   */
+  async unfollowEventWithEntityManager(
+    params: EntityManagerUnfollowEventRequest
+  ) {
+    const { userId, eventId } = await parseParams(
+      'unfollowEvent',
+      EntityManagerUnfollowEventSchema
+    )(params)
+
+    if (!this.entityManager) {
+      throw new UninitializedEntityManagerError()
+    }
+    return this.entityManager.manageEntity({
+      entityId: eventId,
+      userId,
+      entityType: EntityType.EVENT,
+      action: Action.UNSUBSCRIBE,
+      metadata: ''
+    })
+  }
+
+  override async unfollowEvent(
+    params: EntityManagerUnfollowEventRequest | UnfollowEventRequest,
+    requestInit?: RequestInit
+  ) {
+    if (
+      this.entityManager &&
+      'userId' in params &&
+      typeof (params as EntityManagerUnfollowEventRequest).userId === 'number'
+    ) {
+      return await this.unfollowEventWithEntityManager(
+        params as EntityManagerUnfollowEventRequest
+      )
+    }
+    return super.unfollowEvent(params as UnfollowEventRequest, requestInit)
+  }
+
   /**
    * Delete an event
    */
   async deleteEvent(params: DeleteEventRequest) {
-    // Parse inputs
     const parsedParameters = await parseParams(
       'deleteEvent',
       DeleteEventSchema

package/src/sdk/api/events/types.ts

@@ -37,7 +37,24 @@ export const DeleteEventSchema = EventMetadataSchema.pick({
   eventId: true
 })
 
+// Entity-manager-shaped follow/unfollow: numeric IDs, submitted client-side
+// through the entity manager. Distinct from the generated HTTP-shaped
+// FollowEventRequest (which uses string hashids and hits /events/{id}/follow
+// via OAuth auth). Mirrors the user-follow pattern in UsersApi.
+export const EntityManagerFollowEventSchema = z.object({
+  userId: z.number(),
+  eventId: z.number()
+})
+
+export const EntityManagerUnfollowEventSchema = EntityManagerFollowEventSchema
+
 // Request types
 export type CreateEventRequest = z.infer<typeof CreateEventSchema>
 export type UpdateEventRequest = z.infer<typeof UpdateEventSchema>
 export type DeleteEventRequest = z.infer<typeof DeleteEventSchema>
+export type EntityManagerFollowEventRequest = z.infer<
+  typeof EntityManagerFollowEventSchema
+>
+export type EntityManagerUnfollowEventRequest = z.infer<
+  typeof EntityManagerUnfollowEventSchema
+>

package/src/sdk/api/generated/default/.openapi-generator/FILES

@@ -7,6 +7,7 @@ apis/DashboardWalletUsersApi.ts
 apis/DeveloperAppsApi.ts
 apis/EventsApi.ts
 apis/ExploreApi.ts
+apis/FanClubApi.ts
 apis/NotificationsApi.ts
 apis/PlaylistsApi.ts
 apis/PrizesApi.ts
@@ -154,12 +155,17 @@ models/DynamicBondingCurveInsights.ts
 models/EmailAccess.ts
 models/EmailAccessResponse.ts
 models/Event.ts
+models/EventFollowState.ts
+models/EventFollowStateResponse.ts
 models/EventsResponse.ts
 models/ExtendedAccessGate.ts
 models/ExtendedPaymentSplit.ts
 models/ExtendedPurchaseGate.ts
 models/ExtendedTokenGate.ts
 models/ExtendedUsdcGate.ts
+models/FanClubTextPostNotification.ts
+models/FanClubTextPostNotificationAction.ts
+models/FanClubTextPostNotificationActionData.ts
 models/FanRemixContestEndedNotification.ts
 models/FanRemixContestEndedNotificationAction.ts
 models/FanRemixContestEndedNotificationActionData.ts
@@ -169,6 +175,9 @@ models/FanRemixContestEndingSoonNotificationActionData.ts
 models/FanRemixContestStartedNotification.ts
 models/FanRemixContestStartedNotificationAction.ts
 models/FanRemixContestStartedNotificationActionData.ts
+models/FanRemixContestSubmissionNotification.ts
+models/FanRemixContestSubmissionNotificationAction.ts
+models/FanRemixContestSubmissionNotificationActionData.ts
 models/FanRemixContestWinnersSelectedNotification.ts
 models/FanRemixContestWinnersSelectedNotificationAction.ts
 models/FanRemixContestWinnersSelectedNotificationActionData.ts
@@ -255,6 +264,11 @@ models/RegisterApiKeyResponse.ts
 models/Related.ts
 models/RelatedArtistResponse.ts
 models/Remix.ts
+models/RemixContestUpdateNotification.ts
+models/RemixContestUpdateNotificationAction.ts
+models/RemixContestUpdateNotificationActionData.ts
+models/RemixContestsRelated.ts
+models/RemixContestsResponse.ts
 models/RemixNotification.ts
 models/RemixNotificationAction.ts
 models/RemixNotificationActionData.ts