Add group graphql interfaces (#5017)

* Deprecate movie and add group interfaces * UI changes
2025-12-17 04:14:39 +03:00 · 2024-07-03 13:59:40 +10:00
parent f477b996b5
commit 2739696813
108 changed files with 1437 additions and 567 deletions
--- a/graphql/schema/schema.graphql
+++ b/graphql/schema/schema.graphql
@@ -77,13 +77,22 @@ type Query {
  ): FindStudiosResultType!

  "Find a movie by ID"
-  findMovie(id: ID!): Movie
+  findMovie(id: ID!): Movie @deprecated(reason: "Use findGroup instead")
  "A function which queries Movie objects"
  findMovies(
    movie_filter: MovieFilterType
    filter: FindFilterType
    ids: [ID!]
-  ): FindMoviesResultType!
+  ): FindMoviesResultType! @deprecated(reason: "Use findGroups instead")
+
+  "Find a group by ID"
+  findGroup(id: ID!): Group
+  "A function which queries Group objects"
+  findGroups(
+    group_filter: GroupFilterType
+    filter: FindFilterType
+    ids: [ID!]
+  ): FindGroupsResultType!

  findGallery(id: ID!): Gallery
  findGalleries(
@@ -156,7 +165,13 @@ type Query {
  scrapeSingleMovie(
    source: ScraperSourceInput!
    input: ScrapeSingleMovieInput!
-  ): [ScrapedMovie!]!
+  ): [ScrapedMovie!]! @deprecated(reason: "Use scrapeSingleGroup instead")
+
+  "Scrape for a single group"
+  scrapeSingleGroup(
+    source: ScraperSourceInput!
+    input: ScrapeSingleGroupInput!
+  ): [ScrapedGroup!]!

  "Scrapes content based on a URL"
  scrapeURL(url: String!, ty: ScrapeContentType!): ScrapedContent
@@ -169,6 +184,9 @@ type Query {
  scrapeGalleryURL(url: String!): ScrapedGallery
  "Scrapes a complete movie record based on a URL"
  scrapeMovieURL(url: String!): ScrapedMovie
+    @deprecated(reason: "Use scrapeGroupURL instead")
+  "Scrapes a complete group record based on a URL"
+  scrapeGroupURL(url: String!): ScrapedGroup

  # Plugins
  "List loaded plugins"
@@ -214,7 +232,7 @@ type Query {
  allPerformers: [Performer!]!
  allTags: [Tag!]! @deprecated(reason: "Use findTags instead")
  allStudios: [Studio!]! @deprecated(reason: "Use findStudios instead")
-  allMovies: [Movie!]! @deprecated(reason: "Use findMovies instead")
+  allMovies: [Movie!]! @deprecated(reason: "Use findGroups instead")

  # Get everything with minimal metadata

@@ -316,10 +334,21 @@ type Mutation {
  studiosDestroy(ids: [ID!]!): Boolean!

  movieCreate(input: MovieCreateInput!): Movie
+    @deprecated(reason: "Use groupCreate instead")
  movieUpdate(input: MovieUpdateInput!): Movie
+    @deprecated(reason: "Use groupUpdate instead")
  movieDestroy(input: MovieDestroyInput!): Boolean!
+    @deprecated(reason: "Use groupDestroy instead")
  moviesDestroy(ids: [ID!]!): Boolean!
+    @deprecated(reason: "Use groupsDestroy instead")
  bulkMovieUpdate(input: BulkMovieUpdateInput!): [Movie!]
+    @deprecated(reason: "Use bulkGroupUpdate instead")
+
+  groupCreate(input: GroupCreateInput!): Group
+  groupUpdate(input: GroupUpdateInput!): Group
+  groupDestroy(input: GroupDestroyInput!): Boolean!
+  groupsDestroy(ids: [ID!]!): Boolean!
+  bulkGroupUpdate(input: BulkGroupUpdateInput!): [Group!]

  tagCreate(input: TagCreateInput!): Tag
  tagUpdate(input: TagUpdateInput!): Tag
--- a/graphql/schema/types/filters.graphql
+++ b/graphql/schema/types/filters.graphql
@@ -257,7 +257,9 @@ input SceneFilterType {
  "Filter to only include scenes with this studio"
  studios: HierarchicalMultiCriterionInput
  "Filter to only include scenes with this movie"
-  movies: MultiCriterionInput
+  movies: MultiCriterionInput @deprecated(reason: "use groups instead")
+  "Filter to only include scenes with this group"
+  groups: MultiCriterionInput
  "Filter to only include scenes with this gallery"
  galleries: MultiCriterionInput
  "Filter to only include scenes with these tags"
@@ -309,6 +311,9 @@ input SceneFilterType {
  tags_filter: TagFilterType
  "Filter by related movies that meet this criteria"
  movies_filter: MovieFilterType
+    @deprecated(reason: "use groups_filter instead")
+  "Filter by related groups that meet this criteria"
+  groups_filter: GroupFilterType
  "Filter by related markers that meet this criteria"
  markers_filter: SceneMarkerFilterType
 }
@@ -351,6 +356,44 @@ input MovieFilterType {
  studios_filter: StudioFilterType
 }

+input GroupFilterType {
+  AND: GroupFilterType
+  OR: GroupFilterType
+  NOT: GroupFilterType
+
+  name: StringCriterionInput
+  director: StringCriterionInput
+  synopsis: StringCriterionInput
+
+  "Filter by duration (in seconds)"
+  duration: IntCriterionInput
+  # rating expressed as 1-100
+  rating100: IntCriterionInput
+  "Filter to only include groups with this studio"
+  studios: HierarchicalMultiCriterionInput
+  "Filter to only include groups missing this property"
+  is_missing: String
+  "Filter by url"
+  url: StringCriterionInput
+  "Filter to only include groups where performer appears in a scene"
+  performers: MultiCriterionInput
+  "Filter to only include groups with these tags"
+  tags: HierarchicalMultiCriterionInput
+  "Filter by tag count"
+  tag_count: IntCriterionInput
+  "Filter by date"
+  date: DateCriterionInput
+  "Filter by creation time"
+  created_at: TimestampCriterionInput
+  "Filter by last update time"
+  updated_at: TimestampCriterionInput
+
+  "Filter by related scenes that meet this criteria"
+  scenes_filter: SceneFilterType
+  "Filter by related studios that meet this criteria"
+  studios_filter: StudioFilterType
+}
+
 input StudioFilterType {
  AND: StudioFilterType
  OR: StudioFilterType
@@ -508,6 +551,9 @@ input TagFilterType {
  "Filter by number of movies with this tag"
  movie_count: IntCriterionInput

+  "Filter by number of group with this tag"
+  group_count: IntCriterionInput
+
  "Filter by number of markers with this tag"
  marker_count: IntCriterionInput

@@ -702,6 +748,7 @@ enum FilterMode {
  GALLERIES
  SCENE_MARKERS
  MOVIES
+  GROUPS
  TAGS
  IMAGES
 }
--- a/graphql/schema/types/group.graphql
+++ b/graphql/schema/types/group.graphql
@@ -0,0 +1,80 @@
+type Group {
+  id: ID!
+  name: String!
+  aliases: String
+  "Duration in seconds"
+  duration: Int
+  date: String
+  # rating expressed as 1-100
+  rating100: Int
+  studio: Studio
+  director: String
+  synopsis: String
+  urls: [String!]!
+  tags: [Tag!]!
+  created_at: Time!
+  updated_at: Time!
+
+  front_image_path: String # Resolver
+  back_image_path: String # Resolver
+  scene_count: Int! # Resolver
+  scenes: [Scene!]!
+}
+
+input GroupCreateInput {
+  name: String!
+  aliases: String
+  "Duration in seconds"
+  duration: Int
+  date: String
+  # rating expressed as 1-100
+  rating100: Int
+  studio_id: ID
+  director: String
+  synopsis: String
+  urls: [String!]
+  tag_ids: [ID!]
+  "This should be a URL or a base64 encoded data URL"
+  front_image: String
+  "This should be a URL or a base64 encoded data URL"
+  back_image: String
+}
+
+input GroupUpdateInput {
+  id: ID!
+  name: String
+  aliases: String
+  duration: Int
+  date: String
+  # rating expressed as 1-100
+  rating100: Int
+  studio_id: ID
+  director: String
+  synopsis: String
+  urls: [String!]
+  tag_ids: [ID!]
+  "This should be a URL or a base64 encoded data URL"
+  front_image: String
+  "This should be a URL or a base64 encoded data URL"
+  back_image: String
+}
+
+input BulkGroupUpdateInput {
+  clientMutationId: String
+  ids: [ID!]
+  # rating expressed as 1-100
+  rating100: Int
+  studio_id: ID
+  director: String
+  urls: BulkUpdateStrings
+  tag_ids: BulkUpdateIds
+}
+
+input GroupDestroyInput {
+  id: ID!
+}
+
+type FindGroupsResultType {
+  count: Int!
+  groups: [Group!]!
+}
--- a/graphql/schema/types/metadata.graphql
+++ b/graphql/schema/types/metadata.graphql
@@ -284,7 +284,8 @@ input ExportObjectsInput {
  studios: ExportObjectTypeInput
  performers: ExportObjectTypeInput
  tags: ExportObjectTypeInput
-  movies: ExportObjectTypeInput
+  groups: ExportObjectTypeInput
+  movies: ExportObjectTypeInput @deprecated(reason: "Use groups instead")
  galleries: ExportObjectTypeInput
  includeDependencies: Boolean
 }
--- a/graphql/schema/types/performer.graphql
+++ b/graphql/schema/types/performer.graphql
@@ -42,7 +42,8 @@ type Performer {
  scene_count: Int! # Resolver
  image_count: Int! # Resolver
  gallery_count: Int! # Resolver
-  movie_count: Int! # Resolver
+  group_count: Int! # Resolver
+  movie_count: Int! @deprecated(reason: "use group_count instead") # Resolver
  performer_count: Int! # Resolver
  o_counter: Int # Resolver
  scenes: [Scene!]!
@@ -55,7 +56,8 @@ type Performer {
  weight: Int
  created_at: Time!
  updated_at: Time!
-  movies: [Movie!]!
+  groups: [Group!]! @deprecated(reason: "use groups instead")
+  movies: [Movie!]! @deprecated(reason: "use groups instead")
 }

 input PerformerCreateInput {
--- a/graphql/schema/types/scene.graphql
+++ b/graphql/schema/types/scene.graphql
@@ -26,6 +26,11 @@ type SceneMovie {
  scene_index: Int
 }

+type SceneGroup {
+  group: Group!
+  scene_index: Int
+}
+
 type VideoCaption {
  language_code: String!
  caption_type: String!
@@ -68,7 +73,8 @@ type Scene {
  scene_markers: [SceneMarker!]!
  galleries: [Gallery!]!
  studio: Studio
-  movies: [SceneMovie!]!
+  groups: [SceneGroup!]!
+  movies: [SceneMovie!]! @deprecated(reason: "Use groups")
  tags: [Tag!]!
  performers: [Performer!]!
  stash_ids: [StashID!]!
@@ -82,6 +88,11 @@ input SceneMovieInput {
  scene_index: Int
 }

+input SceneGroupInput {
+  group_id: ID!
+  scene_index: Int
+}
+
 input SceneCreateInput {
  title: String
  code: String
@@ -96,7 +107,8 @@ input SceneCreateInput {
  studio_id: ID
  gallery_ids: [ID!]
  performer_ids: [ID!]
-  movies: [SceneMovieInput!]
+  groups: [SceneGroupInput!]
+  movies: [SceneMovieInput!] @deprecated(reason: "Use groups")
  tag_ids: [ID!]
  "This should be a URL or a base64 encoded data URL"
  cover_image: String
@@ -128,7 +140,8 @@ input SceneUpdateInput {
  studio_id: ID
  gallery_ids: [ID!]
  performer_ids: [ID!]
-  movies: [SceneMovieInput!]
+  groups: [SceneGroupInput!]
+  movies: [SceneMovieInput!] @deprecated(reason: "Use groups")
  tag_ids: [ID!]
  "This should be a URL or a base64 encoded data URL"
  cover_image: String
@@ -175,7 +188,8 @@ input BulkSceneUpdateInput {
  gallery_ids: BulkUpdateIds
  performer_ids: BulkUpdateIds
  tag_ids: BulkUpdateIds
-  movie_ids: BulkUpdateIds
+  group_ids: BulkUpdateIds
+  movie_ids: BulkUpdateIds @deprecated(reason: "Use group_ids")
 }

 input SceneDestroyInput {
--- a/graphql/schema/types/scraped-group.graphql
+++ b/graphql/schema/types/scraped-group.graphql
@@ -31,3 +31,35 @@ input ScrapedMovieInput {
  synopsis: String
  # not including tags for the input
 }
+
+"A group from a scraping operation..."
+type ScrapedGroup {
+  stored_id: ID
+  name: String
+  aliases: String
+  duration: String
+  date: String
+  rating: String
+  director: String
+  urls: [String!]
+  synopsis: String
+  studio: ScrapedStudio
+  tags: [ScrapedTag!]
+
+  "This should be a base64 encoded data URL"
+  front_image: String
+  "This should be a base64 encoded data URL"
+  back_image: String
+}
+
+input ScrapedGroupInput {
+  name: String
+  aliases: String
+  duration: String
+  date: String
+  rating: String
+  director: String
+  urls: [String!]
+  synopsis: String
+  # not including tags for the input
+}
--- a/graphql/schema/types/scraper.graphql
+++ b/graphql/schema/types/scraper.graphql
@@ -11,6 +11,7 @@ enum ScrapeType {
 enum ScrapeContentType {
  GALLERY
  MOVIE
+  GROUP
  PERFORMER
  SCENE
 }
@@ -22,6 +23,7 @@ union ScrapedContent =
  | ScrapedScene
  | ScrapedGallery
  | ScrapedMovie
+  | ScrapedGroup
  | ScrapedPerformer

 type ScraperSpec {
@@ -40,7 +42,9 @@ type Scraper {
  "Details for gallery scraper"
  gallery: ScraperSpec
  "Details for movie scraper"
-  movie: ScraperSpec
+  movie: ScraperSpec @deprecated(reason: "use group")
+  "Details for group scraper"
+  group: ScraperSpec
 }

 type ScrapedStudio {
@@ -76,7 +80,8 @@ type ScrapedScene {
  studio: ScrapedStudio
  tags: [ScrapedTag!]
  performers: [ScrapedPerformer!]
-  movies: [ScrapedMovie!]
+  movies: [ScrapedMovie!] @deprecated(reason: "use groups")
+  groups: [ScrapedGroup!]

  remote_site_id: String
  duration: Int
@@ -190,10 +195,19 @@ input ScrapeSingleMovieInput {
  query: String
  "Instructs to query by movie id"
  movie_id: ID
-  "Instructs to query by gallery fragment"
+  "Instructs to query by movie fragment"
  movie_input: ScrapedMovieInput
 }

+input ScrapeSingleGroupInput {
+  "Instructs to query by string"
+  query: String
+  "Instructs to query by group id"
+  group_id: ID
+  "Instructs to query by group fragment"
+  group_input: ScrapedGroupInput
+}
+
 input StashBoxSceneQueryInput {
  "Index of the configured stash-box instance to use"
  stash_box_index: Int @deprecated(reason: "use stash_box_endpoint")
--- a/graphql/schema/types/stats.graphql
+++ b/graphql/schema/types/stats.graphql
@@ -7,7 +7,8 @@ type StatsResultType {
  gallery_count: Int!
  performer_count: Int!
  studio_count: Int!
-  movie_count: Int!
+  group_count: Int!
+  movie_count: Int! @deprecated(reason: "use group_count instead")
  tag_count: Int!
  total_o_count: Int!
  total_play_duration: Float!
--- a/graphql/schema/types/studio.graphql
+++ b/graphql/schema/types/studio.graphql
@@ -13,7 +13,8 @@ type Studio {
  image_count(depth: Int): Int! # Resolver
  gallery_count(depth: Int): Int! # Resolver
  performer_count(depth: Int): Int! # Resolver
-  movie_count(depth: Int): Int! # Resolver
+  group_count(depth: Int): Int! # Resolver
+  movie_count(depth: Int): Int! @deprecated(reason: "use group_count instead") # Resolver
  stash_ids: [StashID!]!
  # rating expressed as 1-100
  rating100: Int
@@ -21,7 +22,8 @@ type Studio {
  details: String
  created_at: Time!
  updated_at: Time!
-  movies: [Movie!]!
+  groups: [Group!]!
+  movies: [Movie!]! @deprecated(reason: "use groups instead")
 }

 input StudioCreateInput {
--- a/graphql/schema/types/tag.graphql
+++ b/graphql/schema/types/tag.graphql
@@ -14,7 +14,8 @@ type Tag {
  gallery_count(depth: Int): Int! # Resolver
  performer_count(depth: Int): Int! # Resolver
  studio_count(depth: Int): Int! # Resolver
-  movie_count(depth: Int): Int! # Resolver
+  group_count(depth: Int): Int! # Resolver
+  movie_count(depth: Int): Int! @deprecated(reason: "use group_count instead") # Resolver
  parents: [Tag!]!
  children: [Tag!]!