KVS metadata extended model

Author: vdusek

src/apify/storage_clients/_apify/_key_value_store_client.py

@@ -9,9 +9,9 @@
 
 from apify_client import ApifyClientAsync
 from crawlee.storage_clients._base import KeyValueStoreClient
-from crawlee.storage_clients.models import KeyValueStoreMetadata, KeyValueStoreRecord, KeyValueStoreRecordMetadata
+from crawlee.storage_clients.models import KeyValueStoreRecord, KeyValueStoreRecordMetadata
 
-from ._models import KeyValueStoreListKeysPage
+from ._models import ApifyKeyValueStoreMetadata, KeyValueStoreListKeysPage
 from apify._crypto import create_hmac_signature
 
 if TYPE_CHECKING:
@@ -48,9 +48,9 @@ def __init__(
         """A lock to ensure that only one operation is performed at a time."""
 
     @override
-    async def get_metadata(self) -> KeyValueStoreMetadata:
+    async def get_metadata(self) -> ApifyKeyValueStoreMetadata:
         metadata = await self._api_client.get()
-        return KeyValueStoreMetadata.model_validate(metadata)
+        return ApifyKeyValueStoreMetadata.model_validate(metadata)
 
     @classmethod
     async def open(
@@ -112,7 +112,7 @@ async def open(
 
         # If name is provided, get or create the storage by name.
         if name is not None and id is None:
-            id = KeyValueStoreMetadata.model_validate(
+            id = ApifyKeyValueStoreMetadata.model_validate(
                 await apify_kvss_client.get_or_create(name=name),
             ).id
 
@@ -219,9 +219,7 @@ async def get_public_url(self, key: str) -> str:
         )
         metadata = await self.get_metadata()
 
-        if metadata.model_extra is not None:
-            url_signing_secret_key = metadata.model_extra.get('urlSigningSecretKey')
-            if url_signing_secret_key is not None:
-                public_url = public_url.with_query(signature=create_hmac_signature(url_signing_secret_key, key))
+        if metadata.url_signing_secret_key is not None:
+            public_url = public_url.with_query(signature=create_hmac_signature(metadata.url_signing_secret_key, key))
 
         return str(public_url)

src/apify/storage_clients/_apify/_models.py

@@ -6,10 +6,22 @@
 from pydantic import BaseModel, ConfigDict, Field
 
 from crawlee._utils.docs import docs_group
+from crawlee.storage_clients.models import KeyValueStoreMetadata
 
 from apify import Request
 
 
+@docs_group('Data structures')
+class ApifyKeyValueStoreMetadata(KeyValueStoreMetadata):
+    """Extended key-value store metadata model for Apify platform.
+
+    Includes additional Apify-specific fields.
+    """
+
+    url_signing_secret_key: Annotated[str | None, Field(alias='urlSigningSecretKey', default=None)]
+    """The secret key used for signing URLs for secure access to key-value store records."""
+
+
 @docs_group('Data structures')
 class ProlongRequestLockResponse(BaseModel):
     """Response to prolong request lock calls."""