authzed - pypi Package Compare versions

Comparing version 1.22.2rc2 to 1.23.0

PKG-INFO

 Metadata-Version: 2.3
 Name: authzed
-Version: 1.22.2rc2
+Version: 1.23.0
 Summary: Client library for SpiceDB.
@@ -8,3 +8,3 @@ Author: Authzed
 Requires-Dist: grpcio~=1.63
-Requires-Dist: protobuf>=5.26,<6
+Requires-Dist: protobuf>=5.26,<7
 Requires-Dist: grpc-interceptor>=0.15.4,<0.16
@@ -11,0 +11,0 @@ Requires-Dist: googleapis-common-protos>=1.65.0,<2

pyproject.toml

 [project]
 name = "authzed"
-version = "1.22.2rc2"
+version = "1.23.0"
 description = "Client library for SpiceDB."
@@ -10,3 +10,3 @@ authors = [{ name = "Authzed", email = "[e-mail]" }]
   "grpcio~=1.63",
-  "protobuf>=5.26,<6",
+  "protobuf>=5.26,<7",
   "grpc-interceptor>=0.15.4,<0.16",
@@ -20,4 +20,4 @@ "googleapis-common-protos>=1.65.0,<2",
   "grpc-stubs~=1.53",
-  "grpcio-tools>=1.63,<1.72",
-  "mypy==1.18.1",
+  "grpcio-tools>=1.63,<1.76",
+  "mypy==1.18.2",
   "mypy-protobuf==3.6.0",
@@ -24,0 +24,0 @@ "mock>=5.1.0,<6",

src/authzed/api/v1/core_pb2.pyi

@@ -145,4 +145,5 @@ """
 class ZedToken(google.protobuf.message.Message):
-    """ZedToken is used to provide causality metadata between Write and Check
-    requests.
+    """ZedToken represents a point in time, or a "revision" in SpiceDB.
+    It is used to provide causality metadata between Write and read requests (Check, ReadRelationships, LookupResources, LookupSubjects)
+    and can also be used to start watching for changes from a specific point in time.
 
@@ -149,0 +150,0 @@ See the authzed.api.v1.Consistency message for more information.

src/authzed/api/v1/permission_service_pb2.pyi

@@ -365,3 +365,5 @@ """
     @property
-    def written_at(self) -> authzed.api.v1.core_pb2.ZedToken: ...
+    def written_at(self) -> authzed.api.v1.core_pb2.ZedToken:
+        """written_at is the revision at which the relationships were written or deleted."""
+
     def __init__(
@@ -368,0 +370,0 @@ self,

src/authzed/api/v1/watch_service_pb2.py

@@ -34,3 +34,3 @@ # -*- coding: utf-8 -*-
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\"authzed/api/v1/watch_service.proto\x12\x0e\x61uthzed.api.v1\x1a\x19\x61uthzed/api/v1/core.proto\x1a\'authzed/api/v1/permission_service.proto\x1a\x1b\x62uf/validate/validate.proto\x1a\x1cgoogle/api/annotations.proto\x1a\x1cgoogle/protobuf/struct.proto\x1a.protoc-gen-openapiv2/options/annotations.proto\x1a\x17validate/validate.proto\"\xe9\x03\n\x0cWatchRequest\x12\xd3\x01\n\x15optional_object_types\x18\x01 \x03(\tB\x9e\x01\xfa\x42L\x92\x01I\x08\x00\"ErC(\x80\x01\x32>^([a-z][a-z0-9_]{1,62}[a-z0-9]/)*[a-z][a-z0-9_]{1,62}[a-z0-9]$\xbaHL\x92\x01I\x08\x00\"ErC(\x80\x01\x32>^([a-z][a-z0-9_]{1,62}[a-z0-9]/)*[a-z][a-z0-9_]{1,62}[a-z0-9]$R\x13optionalObjectTypes\x12L\n\x15optional_start_cursor\x18\x02 \x01(\x0b\x32\x18.authzed.api.v1.ZedTokenR\x13optionalStartCursor\x12\x66\n\x1doptional_relationship_filters\x18\x03 \x03(\x0b\x32\".authzed.api.v1.RelationshipFilterR\x1boptionalRelationshipFilters\x12M\n\x15optional_update_kinds\x18\x04 \x03(\x0e\x32\x19.authzed.api.v1.WatchKindR\x13optionalUpdateKinds\"\xb9\x02\n\rWatchResponse\x12<\n\x07updates\x18\x01 \x03(\x0b\x32\".authzed.api.v1.RelationshipUpdateR\x07updates\x12\x41\n\x0f\x63hanges_through\x18\x02 \x01(\x0b\x32\x18.authzed.api.v1.ZedTokenR\x0e\x63hangesThrough\x12[\n\x1doptional_transaction_metadata\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructR\x1boptionalTransactionMetadata\x12%\n\x0eschema_updated\x18\x04 \x01(\x08R\rschemaUpdated\x12#\n\ris_checkpoint\x18\x05 \x01(\x08R\x0cisCheckpoint*\x9f\x01\n\tWatchKind\x12\x1a\n\x16WATCH_KIND_UNSPECIFIED\x10\x00\x12+\n\'WATCH_KIND_INCLUDE_RELATIONSHIP_UPDATES\x10\x01\x12%\n!WATCH_KIND_INCLUDE_SCHEMA_UPDATES\x10\x02\x12\"\n\x1eWATCH_KIND_INCLUDE_CHECKPOINTS\x10\x03\x32v\n\x0cWatchService\x12\x66\n\x05Watch\x12\x1c.authzed.api.v1.WatchRequest\x1a\x1d.authzed.api.v1.WatchResponse\"\x1e\x92\x41\x07\n\x05Watch\x82\xd3\xe4\x93\x02\x0e\"\t/v1/watch:\x01*0\x01\x42J\n\x12\x63om.authzed.api.v1P\x01Z2github.com/authzed/authzed-go/proto/authzed/api/v1b\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\"authzed/api/v1/watch_service.proto\x12\x0e\x61uthzed.api.v1\x1a\x19\x61uthzed/api/v1/core.proto\x1a\'authzed/api/v1/permission_service.proto\x1a\x1b\x62uf/validate/validate.proto\x1a\x1cgoogle/api/annotations.proto\x1a\x1cgoogle/protobuf/struct.proto\x1a.protoc-gen-openapiv2/options/annotations.proto\x1a\x17validate/validate.proto\"\xe9\x03\n\x0cWatchRequest\x12\xd3\x01\n\x15optional_object_types\x18\x01 \x03(\tB\x9e\x01\xfa\x42L\x92\x01I\x08\x00\"ErC(\x80\x01\x32>^([a-z][a-z0-9_]{1,62}[a-z0-9]/)*[a-z][a-z0-9_]{1,62}[a-z0-9]$\xbaHL\x92\x01I\x08\x00\"ErC(\x80\x01\x32>^([a-z][a-z0-9_]{1,62}[a-z0-9]/)*[a-z][a-z0-9_]{1,62}[a-z0-9]$R\x13optionalObjectTypes\x12L\n\x15optional_start_cursor\x18\x02 \x01(\x0b\x32\x18.authzed.api.v1.ZedTokenR\x13optionalStartCursor\x12\x66\n\x1doptional_relationship_filters\x18\x03 \x03(\x0b\x32\".authzed.api.v1.RelationshipFilterR\x1boptionalRelationshipFilters\x12M\n\x15optional_update_kinds\x18\x04 \x03(\x0e\x32\x19.authzed.api.v1.WatchKindR\x13optionalUpdateKinds\"\x88\x03\n\rWatchResponse\x12<\n\x07updates\x18\x01 \x03(\x0b\x32\".authzed.api.v1.RelationshipUpdateR\x07updates\x12\x41\n\x0f\x63hanges_through\x18\x02 \x01(\x0b\x32\x18.authzed.api.v1.ZedTokenR\x0e\x63hangesThrough\x12[\n\x1doptional_transaction_metadata\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructR\x1boptionalTransactionMetadata\x12%\n\x0eschema_updated\x18\x04 \x01(\x08R\rschemaUpdated\x12#\n\ris_checkpoint\x18\x05 \x01(\x08R\x0cisCheckpoint\x12M\n\x16\x66ull_revision_metadata\x18\x06 \x03(\x0b\x32\x17.google.protobuf.StructR\x14\x66ullRevisionMetadata*\x9f\x01\n\tWatchKind\x12\x1a\n\x16WATCH_KIND_UNSPECIFIED\x10\x00\x12+\n\'WATCH_KIND_INCLUDE_RELATIONSHIP_UPDATES\x10\x01\x12%\n!WATCH_KIND_INCLUDE_SCHEMA_UPDATES\x10\x02\x12\"\n\x1eWATCH_KIND_INCLUDE_CHECKPOINTS\x10\x03\x32v\n\x0cWatchService\x12\x66\n\x05Watch\x12\x1c.authzed.api.v1.WatchRequest\x1a\x1d.authzed.api.v1.WatchResponse\"\x1e\x92\x41\x07\n\x05Watch\x82\xd3\xe4\x93\x02\x0e\"\t/v1/watch:\x01*0\x01\x42J\n\x12\x63om.authzed.api.v1P\x01Z2github.com/authzed/authzed-go/proto/authzed/api/v1b\x06proto3')
 
@@ -47,10 +47,10 @@ _globals = globals()
   _globals['_WATCHSERVICE'].methods_by_name['Watch']._serialized_options = b'\222A\007\n\005Watch\202\323\344\223\002\016\"\t/v1/watch:\001*'
-  _globals['_WATCHKIND']._serialized_start=1093
-  _globals['_WATCHKIND']._serialized_end=1252
+  _globals['_WATCHKIND']._serialized_start=1172
+  _globals['_WATCHKIND']._serialized_end=1331
   _globals['_WATCHREQUEST']._serialized_start=285
   _globals['_WATCHREQUEST']._serialized_end=774
   _globals['_WATCHRESPONSE']._serialized_start=777
-  _globals['_WATCHRESPONSE']._serialized_end=1090
-  _globals['_WATCHSERVICE']._serialized_start=1254
-  _globals['_WATCHSERVICE']._serialized_end=1372
+  _globals['_WATCHRESPONSE']._serialized_end=1169
+  _globals['_WATCHSERVICE']._serialized_start=1333
+  _globals['_WATCHSERVICE']._serialized_end=1451
 # @@protoc_insertion_point(module_scope)

src/authzed/api/v1/watch_service_pb2.pyi

@@ -48,3 +48,3 @@ """
 class WatchRequest(google.protobuf.message.Message):
-    """WatchRequest specifies what mutations to watch for, and an optional start snapshot for when to start
+    """WatchRequest specifies what mutations to watch for, and an optional start point for when to start
     watching.
@@ -70,5 +70,3 @@ """
         which to start watching for changes.
-        If not specified, the watch will begin at the current head revision
-        of the datastore, returning any updates that occur after the caller
-        makes the request.
+        If not specified, the watch will start from the current SpiceDB revision time of the request ("head revision").
         Note that if this cursor references a point-in-time containing data
@@ -89,3 +87,6 @@ that has been garbage collected, an error will be returned.
     def optional_update_kinds(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[global___WatchKind.ValueType]:
-        """optional_update_kinds, if specified, indicates what kinds of mutations to include."""
+        """optional_update_kinds, if specified, indicates what kinds of mutations to include.
+        If your SpiceDB instance is running behind a proxy that aborts idle connections,
+        we recommend including Checkpoints to keep the stream alive even when there are no changes.
+        """
 
@@ -107,6 +108,6 @@ def __init__(
 class WatchResponse(google.protobuf.message.Message):
-    """WatchResponse contains all mutation events in ascending timestamp order,
-    from the requested start snapshot to a snapshot
-    encoded in the watch response. The client can use the snapshot to resume
-    watching where the previous watch response left off.
+    """WatchResponse contains all mutation events in ascending timestamp order.
+    This excludes relationships that were deleted because they expired.
+    The response includes a field that can be used to resume
+    watching from that point.
     """
@@ -121,2 +122,3 @@
     IS_CHECKPOINT_FIELD_NUMBER: builtins.int
+    FULL_REVISION_METADATA_FIELD_NUMBER: builtins.int
     schema_updated: builtins.bool
@@ -132,3 +134,3 @@ """schema_updated, if true, indicates that the schema was changed in this revision."""
         """updates are the RelationshipUpdate events that have occurred since the
-        last watch response.
+        call was made, or since the point in time specified by changes_through.
         """
@@ -147,5 +149,14 @@
         given to SpiceDB during the transaction that produced the changes in this response.
-        This field may not exist if no transaction metadata was provided.
+        This field may not exist if no transaction metadata was provided, or if multiple pieces
+        of metadata were found during the transaction (in which case it is ambiguous which to return).
         """
 
+    @property
+    def full_revision_metadata(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[google.protobuf.struct_pb2.Struct]:
+        """full_revision_metadata contains all transaction metadata given to SpiceDB during the
+        revision that produced the changes in this response. Some datastores (such as CockroachDB)
+        can "merge" multiple transactions into a single revision (if the changes occurred concurrently),
+        so this field is a list of all transaction metadata seen during the revision.
+        """
+
     def __init__(
@@ -159,6 +170,7 @@ self,
         is_checkpoint: builtins.bool = ...,
+        full_revision_metadata: collections.abc.Iterable[google.protobuf.struct_pb2.Struct] | None = ...,
     ) -> None: ...
     def HasField(self, field_name: typing.Literal["changes_through", b"changes_through", "optional_transaction_metadata", b"optional_transaction_metadata"]) -> builtins.bool: ...
-    def ClearField(self, field_name: typing.Literal["changes_through", b"changes_through", "is_checkpoint", b"is_checkpoint", "optional_transaction_metadata", b"optional_transaction_metadata", "schema_updated", b"schema_updated", "updates", b"updates"]) -> None: ...
+    def ClearField(self, field_name: typing.Literal["changes_through", b"changes_through", "full_revision_metadata", b"full_revision_metadata", "is_checkpoint", b"is_checkpoint", "optional_transaction_metadata", b"optional_transaction_metadata", "schema_updated", b"schema_updated", "updates", b"updates"]) -> None: ...
 
 global___WatchResponse = WatchResponse

Alert delta unavailable

Currently unable to show alert delta for PyPI packages.

Improved metrics

Total package byte prevSize

1133133

0.16%

Lines of code

18134

0.13%