feat: prepare server 1.6.0

gradle.properties

@@ -1,5 +1,5 @@
 org.gradle.jvmargs=-Xmx2g -XX:+UseG1GC
 kotlin.code.style=official
-appVersion=1.5.1
+appVersion=1.6.0
 systemProp.sun.net.client.defaultReadTimeout=180000
 systemProp.sun.net.client.defaultConnectTimeout=60000

openapi.yaml

@@ -43,6 +43,10 @@ paths:
   /playlist: { $ref: ./openapi/paths/playlists.yaml#/Playlist }
   /saved-playlists: { $ref: ./openapi/paths/saved-playlists.yaml#/SavedPlaylists }
   /saved-playlists/{id}: { $ref: ./openapi/paths/saved-playlists.yaml#/SavedPlaylist }
+  /subscriptions: { $ref: ./openapi/paths/subscriptions.yaml#/Subscriptions }
+  /subscriptions/groups: { $ref: ./openapi/paths/subscriptions.yaml#/SubscriptionGroups }
+  /subscriptions/groups/{groupId}: { $ref: ./openapi/paths/subscriptions.yaml#/SubscriptionGroup }
+  /subscriptions/groups/{groupId}/channels: { $ref: ./openapi/paths/subscriptions.yaml#/SubscriptionGroupChannels }
   /subscriptions/feed: { $ref: ./openapi/paths/subscriptions.yaml#/SubscriptionFeed }
   /rss/feeds: { $ref: ./openapi/paths/rss.yaml#/RssFeeds }
   /rss/feeds/{id}: { $ref: ./openapi/paths/rss.yaml#/RssFeed }
@@ -146,6 +150,10 @@ components:
       $ref: ./openapi/components/media.yaml#/PublicPlaylistItem
     SavedPlaylistItem: { $ref: ./openapi/components/media.yaml#/SavedPlaylistItem }
     SavedPlaylistRequest: { $ref: ./openapi/components/media.yaml#/SavedPlaylistRequest }
+    SubscriptionItem: { $ref: ./openapi/components/subscriptions.yaml#/SubscriptionItem }
+    SubscriptionGroupItem: { $ref: ./openapi/components/subscriptions.yaml#/SubscriptionGroupItem }
+    SubscriptionGroupRequest: { $ref: ./openapi/components/subscriptions.yaml#/SubscriptionGroupRequest }
+    SubscriptionGroupMembershipRequest: { $ref: ./openapi/components/subscriptions.yaml#/SubscriptionGroupMembershipRequest }
     SubscriptionFeedResponse: { $ref: ./openapi/components/subscriptions.yaml#/SubscriptionFeedResponse }
     SubscriptionFeedPreparingResponse: { $ref: ./openapi/components/subscriptions.yaml#/SubscriptionFeedPreparingResponse }
     RssFeedRequest: { $ref: ./openapi/components/rss.yaml#/RssFeedRequest }

openapi/components/access-control.yaml

@@ -13,6 +13,7 @@ SettingsItem:
     autoplay: { type: boolean, default: true }
     volume: { type: number, format: double, default: 1.0 }
     muted: { type: boolean, default: false }
+    notificationPopupsEnabled: { type: boolean, default: true }
     subtitlesEnabled: { type: boolean, default: false }
     defaultSubtitleLanguage: { type: string, default: "" }
     defaultAudioLanguage: { type: string, default: "" }
@@ -34,6 +35,7 @@ SettingsItem:
     hideComments: { type: boolean, default: false }
     hideShorts: { type: boolean, default: false }
     hideSubscriptionLiveStreams: { type: boolean, default: false }
+    hideMembersOnlyContent: { type: boolean, default: false }
     accessMode:
       type: string
       enum: [unrestricted, allow_list]

openapi/components/subscriptions.yaml

@@ -1,3 +1,37 @@
+SubscriptionItem:
+  type: object
+  required: [channelUrl, name, avatarUrl, subscribedAt]
+  properties:
+    channelUrl: { type: string, minLength: 1 }
+    name: { type: string }
+    avatarUrl: { type: string }
+    subscribedAt: { type: integer, format: int64 }
+SubscriptionCreateRequest:
+  type: object
+  required: [channelUrl, name, avatarUrl]
+  properties:
+    channelUrl: { type: string, minLength: 1 }
+    name: { type: string }
+    avatarUrl: { type: string }
+SubscriptionGroupItem:
+  type: object
+  required: [id, name, channelCount, createdAt, updatedAt]
+  properties:
+    id: { type: string, format: uuid }
+    name: { type: string, minLength: 1, maxLength: 100 }
+    channelCount: { type: integer, minimum: 0 }
+    createdAt: { type: integer, format: int64 }
+    updatedAt: { type: integer, format: int64 }
+SubscriptionGroupRequest:
+  type: object
+  required: [name]
+  properties:
+    name: { type: string, minLength: 1, maxLength: 100 }
+SubscriptionGroupMembershipRequest:
+  type: object
+  required: [channelUrl]
+  properties:
+    channelUrl: { type: string, minLength: 1 }
 SubscriptionFeedResponse:
   type: object
   required: [videos, nextpage, generation, generatedAt, refreshing]

openapi/components/user-backup.yaml

@@ -23,6 +23,17 @@ TypeTypeContentFiltersBackup:
     allowedPlaylists:
       type: array
       items: { $ref: ./access-control.yaml#/AllowedPlaylistItem }
+SubscriptionGroupBackupItem:
+  type: object
+  required: [name, channelUrls, createdAt, updatedAt]
+  properties:
+    name: { type: string, minLength: 1, maxLength: 100 }
+    channelUrls:
+      type: array
+      uniqueItems: true
+      items: { type: string, minLength: 1 }
+    createdAt: { type: integer, format: int64 }
+    updatedAt: { type: integer, format: int64 }
 TypeTypeBackupItem:
   type: object
   required: [format, version, exportedAt, categories]
@@ -47,6 +58,7 @@ TypeTypeBackupItem:
           - settings
           - contentFilters
     subscriptions: { type: array, nullable: true, items: { type: object, additionalProperties: true } }
+    subscriptionGroups: { type: array, nullable: true, items: { $ref: '#/SubscriptionGroupBackupItem' } }
     history: { type: array, nullable: true, items: { type: object, additionalProperties: true } }
     playlists: { type: array, nullable: true, items: { type: object, additionalProperties: true } }
     watchLater: { type: array, nullable: true, items: { type: object, additionalProperties: true } }

openapi/components/youtube-session.yaml

@@ -14,7 +14,7 @@ YoutubeRemoteBrowserStartResponse:
     expiresAt: { type: integer, format: int64 }
 YoutubeRemoteBrowserCompleteRequest:
   type: object
-  required: [sessionId, tokenSessionId, status, cookies, poToken, capturedAt]
+  required: [sessionId, tokenSessionId, status, cookies, poToken, authUser, capturedAt]
   properties:
     sessionId: { type: string }
     tokenSessionId: { type: string }
@@ -23,4 +23,5 @@ YoutubeRemoteBrowserCompleteRequest:
       enum: [completed]
     cookies: { type: string }
     poToken: { type: string }
+    authUser: { type: integer, minimum: 0, maximum: 99 }
     capturedAt: { type: integer, format: int64 }

openapi/paths/streams.yaml

@@ -18,7 +18,11 @@ YoutubeSabrStreams:
             schema:
               $ref: ../components/streams.yaml#/StreamResponse
       '400':
-        $ref: ../components/common.yaml#/JsonError
+        description: Invalid request or YouTube account connection required (`youtube_session_required`).
+        content:
+          application/json:
+            schema:
+              $ref: ../components/common.yaml#/ErrorResponse
       '401':
         $ref: ../components/common.yaml#/JsonError
       '403':
@@ -45,7 +49,11 @@ YoutubeSabrBootstrap:
             schema:
               $ref: ../components/streams.yaml#/StreamResponse
       '400':
-        $ref: ../components/common.yaml#/JsonError
+        description: Invalid request or YouTube account connection required (`youtube_session_required`).
+        content:
+          application/json:
+            schema:
+              $ref: ../components/common.yaml#/ErrorResponse
       '401':
         $ref: ../components/common.yaml#/JsonError
       '403':

openapi/paths/subscriptions.yaml

@@ -1,8 +1,161 @@
+Subscriptions:
+  get:
+    tags: [user-data]
+    summary: List the current user's subscriptions
+    description: Omit both filters for the global list. Use groupId for one named group or ungrouped=true for subscriptions in no groups.
+    parameters:
+      - name: groupId
+        in: query
+        required: false
+        schema: { type: string, format: uuid }
+      - name: ungrouped
+        in: query
+        required: false
+        schema: { type: boolean, default: false }
+    responses:
+      '200':
+        description: The selected subscription projection.
+        content:
+          application/json:
+            schema:
+              type: array
+              items: { $ref: ../components/subscriptions.yaml#/SubscriptionItem }
+      '400': { $ref: ../components/common.yaml#/JsonError }
+      '401': { $ref: ../components/common.yaml#/JsonError }
+      '404': { $ref: ../components/common.yaml#/JsonError }
+  post:
+    tags: [user-data]
+    summary: Subscribe to a channel
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema: { $ref: ../components/subscriptions.yaml#/SubscriptionCreateRequest }
+    responses:
+      '201':
+        description: Subscription created.
+        content:
+          application/json:
+            schema: { $ref: ../components/subscriptions.yaml#/SubscriptionItem }
+      '400': { $ref: ../components/common.yaml#/JsonError }
+      '401': { $ref: ../components/common.yaml#/JsonError }
+  delete:
+    tags: [user-data]
+    summary: Unsubscribe from a channel
+    parameters:
+      - name: url
+        in: query
+        required: true
+        schema: { type: string, minLength: 1 }
+    responses:
+      '204': { description: Subscription deleted. }
+      '400': { $ref: ../components/common.yaml#/JsonError }
+      '401': { $ref: ../components/common.yaml#/JsonError }
+      '404': { $ref: ../components/common.yaml#/JsonError }
+SubscriptionGroups:
+  get:
+    tags: [user-data]
+    summary: List the current user's subscription groups
+    responses:
+      '200':
+        description: Account-scoped named groups.
+        content:
+          application/json:
+            schema:
+              type: array
+              items: { $ref: ../components/subscriptions.yaml#/SubscriptionGroupItem }
+      '401': { $ref: ../components/common.yaml#/JsonError }
+  post:
+    tags: [user-data]
+    summary: Create a subscription group
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema: { $ref: ../components/subscriptions.yaml#/SubscriptionGroupRequest }
+    responses:
+      '201':
+        description: Group created.
+        content:
+          application/json:
+            schema: { $ref: ../components/subscriptions.yaml#/SubscriptionGroupItem }
+      '400': { $ref: ../components/common.yaml#/JsonError }
+      '401': { $ref: ../components/common.yaml#/JsonError }
+      '409': { $ref: ../components/common.yaml#/JsonError }
+SubscriptionGroup:
+  parameters:
+    - name: groupId
+      in: path
+      required: true
+      schema: { type: string, format: uuid }
+  put:
+    tags: [user-data]
+    summary: Rename a subscription group
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema: { $ref: ../components/subscriptions.yaml#/SubscriptionGroupRequest }
+    responses:
+      '204': { description: Group renamed. }
+      '400': { $ref: ../components/common.yaml#/JsonError }
+      '401': { $ref: ../components/common.yaml#/JsonError }
+      '404': { $ref: ../components/common.yaml#/JsonError }
+      '409': { $ref: ../components/common.yaml#/JsonError }
+  delete:
+    tags: [user-data]
+    summary: Delete a subscription group
+    responses:
+      '204': { description: Group and its memberships deleted. }
+      '401': { $ref: ../components/common.yaml#/JsonError }
+      '404': { $ref: ../components/common.yaml#/JsonError }
+SubscriptionGroupChannels:
+  parameters:
+    - name: groupId
+      in: path
+      required: true
+      schema: { type: string, format: uuid }
+  put:
+    tags: [user-data]
+    summary: Add a subscribed channel to a group
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema: { $ref: ../components/subscriptions.yaml#/SubscriptionGroupMembershipRequest }
+    responses:
+      '204': { description: Membership exists. }
+      '400': { $ref: ../components/common.yaml#/JsonError }
+      '401': { $ref: ../components/common.yaml#/JsonError }
+      '404': { $ref: ../components/common.yaml#/JsonError }
+  delete:
+    tags: [user-data]
+    summary: Remove a subscribed channel from a group
+    parameters:
+      - name: url
+        in: query
+        required: true
+        schema: { type: string, minLength: 1 }
+    responses:
+      '204': { description: Membership deleted. }
+      '400': { $ref: ../components/common.yaml#/JsonError }
+      '401': { $ref: ../components/common.yaml#/JsonError }
+      '404': { $ref: ../components/common.yaml#/JsonError }
 SubscriptionFeed:
   get:
     tags: [user-data]
     summary: Read a stable page from the current user's subscription feed snapshot
     parameters:
+      - name: groupId
+        in: query
+        required: false
+        description: Restrict the snapshot projection to subscriptions in one account-owned group.
+        schema: { type: string, format: uuid }
+      - name: ungrouped
+        in: query
+        required: false
+        description: Restrict the snapshot projection to subscriptions in no groups.
+        schema: { type: boolean, default: false }
       - name: page
         in: query
         required: false
@@ -16,7 +169,7 @@ SubscriptionFeed:
       - name: cursor
         in: query
         required: false
-        description: Opaque continuation returned in nextpage.
+        description: Opaque continuation returned in nextpage and bound to the selected membership snapshot.
         schema: { type: string }
     responses:
       '200':
@@ -45,6 +198,8 @@ SubscriptionFeed:
         $ref: ../components/common.yaml#/JsonError
       '401':
         $ref: ../components/common.yaml#/JsonError
+      '404':
+        $ref: ../components/common.yaml#/JsonError
       '409':
         description: The cursor references a snapshot generation that is no longer retained.
         headers:
@@ -54,3 +209,12 @@ SubscriptionFeed:
           application/json:
             schema:
               $ref: ../components/common.yaml#/ErrorResponse
+      '429':
+        description: The account already has the maximum number of active filtered cursor sessions.
+        headers:
+          X-Request-ID:
+            $ref: ../components/common.yaml#/RequestIdHeader
+        content:
+          application/json:
+            schema:
+              $ref: ../components/common.yaml#/ErrorResponse

openapi/paths/youtube-session.yaml

@@ -69,7 +69,7 @@ InternalBrowserComplete:
         application/json:
           schema:
             type: object
-            required: [sessionId, tokenSessionId, status, cookies, poToken, capturedAt]
+            required: [sessionId, tokenSessionId, status, cookies, poToken, authUser, capturedAt]
             properties:
               sessionId: { type: string }
               tokenSessionId: { type: string }
@@ -78,6 +78,7 @@ InternalBrowserComplete:
                 enum: [completed]
               cookies: { type: string }
               poToken: { type: string }
+              authUser: { type: integer, minimum: 0, maximum: 99 }
               capturedAt: { type: integer, format: int64 }
     responses:
       '204': { description: YouTube credentials stored. }

src/main/kotlin/dev/typetype/server/ApplicationRoutes.kt

@@ -92,6 +92,10 @@ internal fun Application.installApplicationRoutes(
                 svc.accessControlService,
                 adminSettingsService,
                 svc.audioOnlyMediaTokenService,
+                svc.authenticatedSabrInfoService,
+                svc.youtubeSessionSabrStreamService?.let { service ->
+                    { userId, url -> service.getStreamInfo(userId, url) }
+                },
             )
         }
         downloaderGatewayRoutes(downloaderGatewayService)

src/main/kotlin/dev/typetype/server/ApplicationStreamRoutes.kt

@@ -31,6 +31,9 @@ internal fun Route.installStreamRoutes(
             blockedService = svc.blockedService,
             publicHlsManifestTokenService = svc.publicHlsManifestTokenService,
             sabrStreamContractFilter = { url, data -> data.withPlayableSabrStreams(url, svc.sabrSessionStore) },
+            youtubeSessionSabrStreamInfo = svc.youtubeSessionSabrStreamService?.let { service ->
+                { userId, url -> service.getStreamInfo(userId, url) }
+            },
         )
         audioOnlyContractRoutes(
             streamService = svc.streamService,