Update dn models

.changeset/eight-crabs-kneel.md

@@ -0,0 +1,5 @@
+---
+'@audius/sdk': minor
+---
+
+fixes a number of model definitions used in /reposts

packages/discovery-provider/src/api/v1/models/access_gate.py

@@ -25,6 +25,7 @@
     "nft_collection",
     {
         "chain": fields.String(enum=["eth", "sol"], required=True),
+        "standard": fields.String(enum=["ERC721", "ERC1155"]),
         "address": fields.String(required=True),
         "name": fields.String(required=True),
         "imageUrl": fields.String(),

packages/discovery-provider/src/api/v1/models/activities.py

@@ -1,6 +1,5 @@
 from flask_restx import fields
-from flask_restx.fields import MarshallingError
-from flask_restx.marshalling import marshal
+from flask_restx.fields import MarshallingError, marshal
 
 from .common import ns
 from .playlists import (
@@ -11,15 +10,6 @@
 from .tracks import track, track_full
 
 
-class ItemType(fields.Raw):
-    def format(self, value):
-        if value == "track":
-            return "track"
-        if value == "playlist":
-            return "playlist"
-        raise MarshallingError("Unable to marshal as activity type")
-
-
 class ActivityItem(fields.Raw):
     def format(self, value):
         try:
@@ -31,7 +21,7 @@ def format(self, value):
             raise MarshallingError("Unable to marshal as activity item") from e
 
 
-class FullActivityItem(fields.Raw):
+class ActivityItemFull(fields.Raw):
     def format(self, value):
         try:
             if value.get("track_id"):
@@ -45,44 +35,99 @@ def format(self, value):
 activity_model = ns.model(
     "activity",
     {
-        "timestamp": fields.String(allow_null=True),
-        "item_type": ItemType,
-        "item": ActivityItem,
+        "timestamp": fields.String(required=True),
+        "item_type": fields.String(enum=["track", "playlist"], required=True),
+        "item": ActivityItem(required=True),
+        "class": fields.String(required=True, discriminator=True),
     },
 )
 
-activity_model_full = ns.model(
-    "activity_full",
+track_activity_model = ns.inherit(
+    "track_activity",
+    activity_model,
     {
-        "timestamp": fields.String(allow_null=True),
-        "item_type": ItemType,
-        "item": FullActivityItem,
+        "item_type": fields.String(enum=["track"], required=True),
+        "item": fields.Nested(track, required=True),
     },
 )
 
-track_activity_model = ns.model(
-    "track_activity",
+collection_activity_model = ns.inherit(
+    "collection_activity",
+    activity_model,
     {
         "timestamp": fields.String(allow_null=True),
-        "item_type": fields.FormattedString("track"),
-        "item": fields.Nested(track),
+        "item_type": fields.String(enum=["playlist"], required=True),
+        "item": fields.Nested(playlist_model, required=True),
     },
 )
 
-track_activity_model_full = ns.model(
+activity_full_model = ns.model(
+    "activity_full",
+    {
+        "timestamp": fields.String(required=True),
+        "item_type": fields.String(enum=["track", "playlist"], required=True),
+        "item": ActivityItemFull(required=True),
+        "class": fields.String(required=True, discriminator=True),
+    },
+)
+
+track_activity_full_model = ns.inherit(
     "track_activity_full",
+    activity_full_model,
     {
-        "timestamp": fields.String(allow_null=True),
-        "item_type": fields.FormattedString("track"),
-        "item": fields.Nested(track_full),
+        "item_type": fields.String(enum=["track"], required=True),
+        "item": fields.Nested(track_full, required=True),
     },
 )
 
-collection_activity_model_full = ns.model(
+collection_activity_full_model = ns.inherit(
     "collection_activity_full",
+    activity_full_model,
     {
-        "timestamp": fields.String(allow_null=True),
-        "item_type": fields.FormattedString("playlist"),
-        "item": fields.Nested(full_playlist_without_tracks_model),
+        "item_type": fields.String(enum=["playlist"], required=True),
+        "item": fields.Nested(full_playlist_model, required=True),
+    },
+)
+
+collection_activity_full_without_tracks_model = ns.inherit(
+    "collection_activity_full_without_tracks",
+    activity_full_model,
+    {
+        "item_type": fields.String(enum=["playlist"], required=True),
+        "item": fields.Nested(full_playlist_without_tracks_model, required=True),
     },
 )
+
+
+class TrackActivity(dict):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+
+class CollectionActivity(dict):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+
+activity_model = fields.Polymorph(
+    {
+        TrackActivity: track_activity_model,
+        CollectionActivity: collection_activity_model,
+    },
+)
+
+activity_full_model = fields.Polymorph(
+    {
+        TrackActivity: track_activity_full_model,
+        CollectionActivity: collection_activity_full_model,
+    },
+)
+
+
+# Only to be used with `Polymorph` to map the returned classes to marshalling models
+def make_polymorph_activity(activity: dict):
+    if activity.get("item_type") == "track":
+        return TrackActivity(activity)
+    if activity.get("item_type") == "playlist":
+        return CollectionActivity(activity)
+    return None

packages/discovery-provider/src/api/v1/models/playlists.py

@@ -18,7 +18,10 @@
 
 access = ns.model(
     "access",
-    {"stream": fields.Boolean, "download": fields.Boolean},
+    {
+        "stream": fields.Boolean(required=True),
+        "download": fields.Boolean(required=True),
+    },
 )
 
 playlist_added_timestamp = ns.model(
@@ -34,7 +37,7 @@
     {
         "artwork": fields.Nested(playlist_artwork, allow_null=True),
         "description": fields.String,
-        "permalink": fields.String,
+        "permalink": fields.String(required=True),
         "id": fields.String(required=True),
         "is_album": fields.Boolean(required=True),
         "is_image_autogenerated": fields.Boolean(required=True),
@@ -47,7 +50,7 @@
         "total_play_count": fields.Integer(required=True),
         "user": fields.Nested(user_model, required=True),
         "ddex_app": fields.String(allow_null=True),
-        "access": fields.Nested(access),
+        "access": fields.Nested(access, required=True),
         "upc": fields.String(allow_null=True),
         "track_count": fields.Integer(required=True),
     },
@@ -58,14 +61,14 @@
     playlist_model,
     {
         "blocknumber": fields.Integer(required=True),
-        "created_at": fields.String,
+        "created_at": fields.String(required=True),
         "followee_reposts": fields.List(fields.Nested(repost), required=True),
         "followee_favorites": fields.List(fields.Nested(favorite), required=True),
         "has_current_user_reposted": fields.Boolean(required=True),
         "has_current_user_saved": fields.Boolean(required=True),
         "is_delete": fields.Boolean(required=True),
         "is_private": fields.Boolean(required=True),
-        "updated_at": fields.String,
+        "updated_at": fields.String(required=True),
         "added_timestamps": fields.List(
             fields.Nested(playlist_added_timestamp), required=True
         ),
@@ -82,8 +85,14 @@
             allow_null=True,
             description="How to unlock stream access to the track",
         ),
-        "is_scheduled_release": fields.Boolean,
+        "is_scheduled_release": fields.Boolean(required=True),
         "release_date": fields.String,
+        # DDEX fields
+        "ddex_release_ids": fields.Raw(allow_null=True),
+        "artists": fields.List(fields.Raw, allow_null=True),
+        "copyright_line": fields.Raw(allow_null=True),
+        "producer_copyright_line": fields.Raw(allow_null=True),
+        "parental_warning_type": fields.String,
     },
 )
 

packages/discovery-provider/src/api/v1/models/tracks.py

@@ -55,26 +55,29 @@
 field_visibility = ns.model(
     "field_visibility",
     {
-        "mood": fields.Boolean,
-        "tags": fields.Boolean,
-        "genre": fields.Boolean,
-        "share": fields.Boolean,
-        "play_count": fields.Boolean,
-        "remixes": fields.Boolean,
+        "mood": fields.Boolean(required=True),
+        "tags": fields.Boolean(required=True),
+        "genre": fields.Boolean(required=True),
+        "share": fields.Boolean(required=True),
+        "play_count": fields.Boolean(required=True),
+        "remixes": fields.Boolean(required=True),
     },
 )
 
 access = ns.model(
     "access",
-    {"stream": fields.Boolean, "download": fields.Boolean},
+    {
+        "stream": fields.Boolean(required=True),
+        "download": fields.Boolean(required=True),
+    },
 )
 
 track = ns.model(
     "Track",
     {
-        "artwork": fields.Nested(track_artwork, allow_null=True),
+        "artwork": fields.Nested(track_artwork, allow_null=True, required=True),
         "description": fields.String,
-        "genre": fields.String,
+        "genre": fields.String(required=True),
         "id": fields.String(required=True),
         "track_cid": fields.String(
             allow_null=True
@@ -86,7 +89,7 @@
         "orig_filename": fields.String(
             allow_null=True
         ),  # remove nullability after backfill
-        "is_original_available": fields.Boolean(),
+        "is_original_available": fields.Boolean(required=True),
         "mood": fields.String,
         "release_date": fields.String,
         "remix_of": fields.Nested(remix_parent),
@@ -97,9 +100,9 @@
         "user": fields.Nested(user_model, required=True),
         # Total track duration, rounded to the nearest second
         "duration": fields.Integer(required=True),
-        "is_downloadable": fields.Boolean,
+        "is_downloadable": fields.Boolean(required=True),
         "play_count": fields.Integer(required=True),
-        "permalink": fields.String,
+        "permalink": fields.String(required=True),
         "is_streamable": fields.Boolean,
         "ddex_app": fields.String(allow_null=True),
         "playlists_containing_track": fields.List(fields.Integer),
@@ -134,36 +137,38 @@
     track,
     {
         "access": fields.Nested(
-            access, description="Describes what access the given user has"
+            access,
+            required=True,
+            description="Describes what access the given user has",
         ),
         "blocknumber": fields.Integer(
             required=True, description="The blocknumber this track was last updated"
         ),
         "create_date": fields.String,
-        "cover_art_sizes": fields.String,
+        "cover_art_sizes": fields.String(required=True),
         "cover_art_cids": fields.Nested(cover_art, allow_null=True),
-        "created_at": fields.String,
+        "created_at": fields.String(required=True),
         "credits_splits": fields.String,
         "isrc": fields.String,
         "license": fields.String,
         "iswc": fields.String,
-        "field_visibility": fields.Nested(field_visibility),
+        "field_visibility": fields.Nested(field_visibility, required=True),
         "followee_reposts": fields.List(fields.Nested(repost), required=True),
         "has_current_user_reposted": fields.Boolean(required=True),
-        "is_scheduled_release": fields.Boolean,
+        "is_scheduled_release": fields.Boolean(required=True),
         "is_unlisted": fields.Boolean(required=True),
         "has_current_user_saved": fields.Boolean(required=True),
         "followee_favorites": fields.List(fields.Nested(favorite), required=True),
         "route_id": fields.String(required=True),
         "stem_of": fields.Nested(stem_parent),
-        "track_segments": fields.List(fields.Nested(track_segment)),
-        "updated_at": fields.String,
+        "track_segments": fields.List(fields.Nested(track_segment), required=True),
+        "updated_at": fields.String(required=True),
         "user_id": fields.String(required=True),
         "user": fields.Nested(user_model_full, required=True),
-        "is_delete": fields.Boolean,
+        "is_delete": fields.Boolean(required=True),
         "cover_art": fields.String,
-        "remix_of": fields.Nested(full_remix_parent),
-        "is_available": fields.Boolean,
+        "remix_of": fields.Nested(full_remix_parent, required=True),
+        "is_available": fields.Boolean(required=True),
         "ai_attribution_user_id": fields.Integer(allow_null=True),
         "allowed_api_keys": fields.List(fields.String, allow_null=True),
         "audio_upload_id": fields.String,
@@ -173,22 +178,25 @@
         "audio_analysis_error_count": fields.Integer,
         # DDEX fields
         "ddex_release_ids": fields.Raw(allow_null=True),
-        "artists": fields.Raw(allow_null=True),
-        "resource_contributors": fields.Raw(allow_null=True),
-        "indirect_resource_contributors": fields.Raw(allow_null=True),
+        "artists": fields.List(fields.Raw, allow_null=True),
+        "resource_contributors": fields.List(fields.Raw, allow_null=True),
+        "indirect_resource_contributors": fields.List(fields.Raw, allow_null=True),
+        "rights_controller": fields.Raw(allow_null=True),
         "copyright_line": fields.Raw(allow_null=True),
         "producer_copyright_line": fields.Raw(allow_null=True),
         "parental_warning_type": fields.String,
         "is_stream_gated": fields.Boolean(
-            description="Whether or not the owner has restricted streaming behind an access gate"
+            required=True,
+            description="Whether or not the owner has restricted streaming behind an access gate",
         ),
         "stream_conditions": NestedOneOf(
             access_gate,
             allow_null=True,
             description="How to unlock stream access to the track",
         ),
         "is_download_gated": fields.Boolean(
-            description="Whether or not the owner has restricted downloading behind an access gate"
+            required=True,
+            description="Whether or not the owner has restricted downloading behind an access gate",
         ),
         "download_conditions": NestedOneOf(
             access_gate, allow_null=True, description="How to unlock the track download"