cayu.browser_profiles

Public Cayu API. Definitions are grouped by their public source module, and definitions from private implementation modules appear on their package’s page; adding a symbol does not move existing links. The import shown at each entry is a supported public namespace. Read the Python API overview and install the required extra.

AESGCMBrowserProfileKeyAuthority

from cayu import AESGCMBrowserProfileKeyAuthority

Local AES-256-GCM key authority for application-managed key bytes.

Bases: BrowserProfileKeyAuthority.

authority_id (property)

AESGCMBrowserProfileKeyAuthority.authority_id() -> str

encrypt (method)

async AESGCMBrowserProfileKeyAuthority.encrypt(*, nonce: bytes, plaintext: bytes, aad: bytes) -> bytes

decrypt (method)

async AESGCMBrowserProfileKeyAuthority.decrypt(*, nonce: bytes, ciphertext: bytes, aad: bytes) -> bytes

init (method)

AESGCMBrowserProfileKeyAuthority.__init__(*, authority_id: str, key: bytes) -> None

Release source · Runtime guarantees · Capability guides

BROWSER_PROFILE_ENCRYPTION_ALGORITHM

from cayu import BROWSER_PROFILE_ENCRYPTION_ALGORITHM

BROWSER_PROFILE_ENCRYPTION_ALGORITHM = 'AES-256-GCM'

Release source · Runtime guarantees · Capability guides

BROWSER_PROFILE_SCHEMA_VERSION

from cayu import BROWSER_PROFILE_SCHEMA_VERSION

BROWSER_PROFILE_SCHEMA_VERSION = 1

Release source · Runtime guarantees · Capability guides

BROWSER_PROFILE_STATE_SCHEMA_VERSION

from cayu import BROWSER_PROFILE_STATE_SCHEMA_VERSION

BROWSER_PROFILE_STATE_SCHEMA_VERSION = 1

Release source · Runtime guarantees · Capability guides

BrowserProfileAccess

from cayu import BrowserProfileAccess

Bases: _ProfileModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
profile_id	StrictStr	required
authority_fingerprint	StrictStr	required
owner_fingerprint	StrictStr	required
sharing_fingerprint	StrictStr	required
store_id	StrictStr	required

validate_identifier (method)

BrowserProfileAccess.validate_identifier(value: str, info) -> str

validate_digest (method)

BrowserProfileAccess.validate_digest(value: str, info) -> str

from_authority (method)

BrowserProfileAccess.from_authority(authority: BrowserProfileAuthority) -> BrowserProfileAccess

Release source · Runtime guarantees · Capability guides

BrowserProfileAuthority

from cayu import BrowserProfileAuthority

Bases: _ProfileModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
schema_version	Literal[1]	1
profile_id	StrictStr	required
scope	BrowserProfileScope	required
destination_policy	BrowserProfileDestinationPolicy	required
browser_protocol	StrictStr	required
browser_worker_version	StrictStr	required
state_schema_version	Literal[1]	1
key_authority_id	StrictStr	required
store_id	StrictStr	required
created_at	datetime	required
expires_at	datetime | None	None
fingerprint	StrictStr	required

validate_profile_id (method)

BrowserProfileAuthority.validate_profile_id(value: str) -> str

validate_identity (method)

BrowserProfileAuthority.validate_identity(value: str, info) -> str

validate_time (method)

BrowserProfileAuthority.validate_time(value: datetime | None, info) -> datetime | None

validate_fingerprint (method)

BrowserProfileAuthority.validate_fingerprint(value: str) -> str

identity_material (method)

BrowserProfileAuthority.identity_material() -> dict[str, object]

validate_authority (method)

BrowserProfileAuthority.validate_authority() -> Self

build (method)

BrowserProfileAuthority.build(*, scope: BrowserProfileScope, destination_policy: BrowserProfileDestinationPolicy, browser_protocol: str, browser_worker_version: str, key_authority_id: str, store_id: str, profile_id: str | None=None, created_at: datetime | None=None, expires_at: datetime | None=None) -> BrowserProfileAuthority

Release source · Runtime guarantees · Capability guides

BrowserProfileBinding

from cayu import BrowserProfileBinding

Application-selected profile authority bound to one interactive browser tool.

init (method)

BrowserProfileBinding.__init__(*, authority: BrowserProfileAuthority, store: BrowserProfileStore, key_authority: BrowserProfileKeyAuthority, current_policy: BrowserProfileDestinationPolicy | None=None, limits: BrowserProfileLimits | None=None, checkpoint_policy: BrowserProfileCheckpointPolicy=BrowserProfileCheckpointPolicy.ON_CLOSE, expected_ref: BrowserProfileRef | None=None, lease_seconds: int=1200) -> None

authority (property)

BrowserProfileBinding.authority() -> BrowserProfileAuthority

access (property)

BrowserProfileBinding.access() -> BrowserProfileAccess

current_policy (property)

BrowserProfileBinding.current_policy() -> BrowserProfileDestinationPolicy

limits (property)

BrowserProfileBinding.limits() -> BrowserProfileLimits

checkpoint_policy (property)

BrowserProfileBinding.checkpoint_policy() -> BrowserProfileCheckpointPolicy

expected_ref (property)

BrowserProfileBinding.expected_ref() -> BrowserProfileRef | None

lease_seconds (property)

BrowserProfileBinding.lease_seconds() -> int

build (method)

BrowserProfileBinding.build(*, scope: BrowserProfileScope, destination_policy: BrowserProfileDestinationPolicy, browser_protocol: str, browser_worker_version: str, store: BrowserProfileStore, key_authority: BrowserProfileKeyAuthority, profile_id: str | None=None, created_at: datetime | None=None, expires_at: datetime | None=None, **options: Any) -> BrowserProfileBinding

initialize (method)

async BrowserProfileBinding.initialize() -> BrowserProfileRef

execution_profile_material (method)

BrowserProfileBinding.execution_profile_material() -> dict[str, object]

prepare_restore (method)

async BrowserProfileBinding.prepare_restore(*, operation_id: str, execution_profile_fingerprint: str, allocation_fingerprint: str, browser_session_id: str) -> BrowserProfileRestoreMaterial

complete_restore (method)

async BrowserProfileBinding.complete_restore(material: BrowserProfileRestoreMaterial, *, outcome: BrowserProfileTerminalOutcome, error_code: str | None=None) -> BrowserProfileRestoreReceipt

resume_writer (method)

async BrowserProfileBinding.resume_writer(*, execution_profile_fingerprint: str, allocation_fingerprint: str, browser_session_id: str) -> BrowserProfileRestoreMaterial

renew_writer (method)

async BrowserProfileBinding.renew_writer(material: BrowserProfileRestoreMaterial) -> BrowserProfileWriterClaim

reserve_checkpoint (method)

async BrowserProfileBinding.reserve_checkpoint(*, material: BrowserProfileRestoreMaterial, operation_id: str, source_revision: str, source_operation_receipt_id: str, source_operation_fingerprint: str, ambiguous_lineage: bool) -> BrowserProfileCheckpointPlan

fail_checkpoint (method)

async BrowserProfileBinding.fail_checkpoint(plan: BrowserProfileCheckpointPlan, *, outcome: BrowserProfileTerminalOutcome, error_code: str) -> BrowserProfileCheckpointReceipt

reconcile_checkpoint (method)

async BrowserProfileBinding.reconcile_checkpoint(operation_id: str, *, material: BrowserProfileRestoreMaterial | None=None) -> BrowserProfileCheckpointReceipt | None

Reconcile publication and optionally settle the live material’s adoption.

When supplied, material adopts the matching writer, encrypted envelope, and decrypted state before caller cancellation is propagated.

publish_checkpoint (method)

async BrowserProfileBinding.publish_checkpoint(plan: BrowserProfileCheckpointPlan, state: BrowserProfileStateV1) -> BrowserProfileCheckpointReceipt

release_writer (method)

async BrowserProfileBinding.release_writer(material: BrowserProfileRestoreMaterial) -> None

revoke (method)

async BrowserProfileBinding.revoke(*, revoked_at: datetime | None=None) -> BrowserProfileInspection

Revoke future profile use without claiming to erase loaded cookies.

Release source · Runtime guarantees · Capability guides

BrowserProfileCheckpointPolicy

from cayu import BrowserProfileCheckpointPolicy

Bases: StrEnum.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
DISABLED	class attribute	'disabled'
AFTER_TERMINAL_OPERATION	class attribute	'after_terminal_operation'
ON_CLOSE	class attribute	'on_close'

Release source · Runtime guarantees · Capability guides

BrowserProfileCheckpointReceipt

from cayu import BrowserProfileCheckpointReceipt

Bases: _ProfileModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
receipt_id	StrictStr	required
operation_id	StrictStr	required
request_fingerprint	StrictStr	required
previous_ref	BrowserProfileRef	required
published_ref	BrowserProfileRef	required
current_policy_fingerprint	StrictStr	required
execution_profile_fingerprint	StrictStr	required
allocation_fingerprint	StrictStr	required
browser_session_id	StrictStr	required
writer_fence	StrictInt	Field(ge=1, le=MAX_DURABLE_JSON_INTEGER)
source_revision	StrictStr	required
source_operation_receipt_id	StrictStr	required
source_operation_fingerprint	StrictStr	required
ambiguous_lineage	StrictBool	required
origin_count	StrictInt	Field(ge=0, le=BROWSER_PROFILE_MAX_ORIGINS)
cookie_count	StrictInt	Field(ge=0, le=BROWSER_PROFILE_MAX_COOKIES)
storage_entry_count	StrictInt	Field(ge=0, le=BROWSER_PROFILE_MAX_STORAGE_ENTRIES)
outcome	BrowserProfileTerminalOutcome	required
error_code	StrictStr | None	None
settled_at	datetime	required

validate_identifier (method)

BrowserProfileCheckpointReceipt.validate_identifier(value: str, info) -> str

validate_digest (method)

BrowserProfileCheckpointReceipt.validate_digest(value: str, info) -> str

validate_error_code (method)

BrowserProfileCheckpointReceipt.validate_error_code(value: str | None) -> str | None

validate_settled_at (method)

BrowserProfileCheckpointReceipt.validate_settled_at(value: datetime) -> datetime

validate_transition (method)

BrowserProfileCheckpointReceipt.validate_transition() -> Self

Release source · Runtime guarantees · Capability guides

BrowserProfileCheckpointRequest

from cayu import BrowserProfileCheckpointRequest

Bases: _ProfileModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
operation_id	StrictStr	required
access	BrowserProfileAccess	required
writer_claim	BrowserProfileWriterClaim	required
source_revision	StrictStr	required
source_operation_receipt_id	StrictStr	required
source_operation_fingerprint	StrictStr	required
current_policy_fingerprint	StrictStr	required
ambiguous_lineage	StrictBool	False

validate_identifier (method)

BrowserProfileCheckpointRequest.validate_identifier(value: str, info) -> str

validate_fingerprint (method)

BrowserProfileCheckpointRequest.validate_fingerprint(value: str, info) -> str

fingerprint (method)

BrowserProfileCheckpointRequest.fingerprint() -> str

validate_authority (method)

BrowserProfileCheckpointRequest.validate_authority() -> Self

Release source · Runtime guarantees · Capability guides

BrowserProfileCheckpointReservation

from cayu import BrowserProfileCheckpointReservation

Bases: _ProfileModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
reservation_id	StrictStr	required
request	BrowserProfileCheckpointRequest	required
request_fingerprint	StrictStr	required
reserved_ciphertext_bytes	StrictInt	Field(ge=17, le=BROWSER_PROFILE_MAX_CIPHERTEXT_BYTES)
previous_origin_count	StrictInt	Field(ge=0, le=BROWSER_PROFILE_MAX_ORIGINS)
previous_cookie_count	StrictInt	Field(ge=0, le=BROWSER_PROFILE_MAX_COOKIES)
previous_storage_entry_count	StrictInt	Field(ge=0, le=BROWSER_PROFILE_MAX_STORAGE_ENTRIES)
reserved_at	datetime	required

validate_reservation_id (method)

BrowserProfileCheckpointReservation.validate_reservation_id(value: str) -> str

validate_fingerprint (method)

BrowserProfileCheckpointReservation.validate_fingerprint(value: str) -> str

validate_reserved_at (method)

BrowserProfileCheckpointReservation.validate_reserved_at(value: datetime) -> datetime

validate_request (method)

BrowserProfileCheckpointReservation.validate_request() -> Self

Release source · Runtime guarantees · Capability guides

BrowserProfileCookie

from cayu import BrowserProfileCookie

Bases: _PrivateProfileStateModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
name	StrictStr	required
value	StrictStr	required
domain	StrictStr	required
path	StrictStr	'/'
expires	StrictFloat	-1.0
http_only	StrictBool	False
secure	StrictBool	True
same_site	Literal['Strict', 'Lax', 'None']	'Lax'

validate_name (method)

BrowserProfileCookie.validate_name(value: str) -> str

validate_value (method)

BrowserProfileCookie.validate_value(value: str) -> str

validate_domain (method)

BrowserProfileCookie.validate_domain(value: str) -> str

validate_path (method)

BrowserProfileCookie.validate_path(value: str) -> str

validate_expires (method)

BrowserProfileCookie.validate_expires(value: float) -> float

validate_security (method)

BrowserProfileCookie.validate_security() -> Self

Release source · Runtime guarantees · Capability guides

BrowserProfileDestinationPolicy

from cayu import BrowserProfileDestinationPolicy

Bases: _ProfileModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
schema_version	Literal[1]	1
origins	tuple[StrictStr, ...]	required
fingerprint	StrictStr	required

normalize_origins (method)

BrowserProfileDestinationPolicy.normalize_origins(value: object) -> tuple[str, ...]

validate_fingerprint (method)

BrowserProfileDestinationPolicy.validate_fingerprint(value: str) -> str

validate_content (method)

BrowserProfileDestinationPolicy.validate_content() -> Self

build (method)

BrowserProfileDestinationPolicy.build(origins: Iterable[str]) -> BrowserProfileDestinationPolicy

is_narrower_than (method)

BrowserProfileDestinationPolicy.is_narrower_than(recorded: BrowserProfileDestinationPolicy) -> bool

admits_url (method)

BrowserProfileDestinationPolicy.admits_url(value: str) -> bool

Return whether one HTTPS URL is within this exact origin policy.

Release source · Runtime guarantees · Capability guides

BrowserProfileEncryptedEnvelope

from cayu import BrowserProfileEncryptedEnvelope

Bases: _ProfileModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
schema_version	Literal[1]	1
authority_fingerprint	StrictStr	required
generation	StrictInt	Field(ge=1, le=MAX_DURABLE_JSON_INTEGER)
encryption_algorithm	Literal['AES-256-GCM']	BROWSER_PROFILE_ENCRYPTION_ALGORITHM
key_authority_id	StrictStr	required
store_id	StrictStr	required
plaintext_bytes	StrictInt	Field(ge=1, le=BROWSER_PROFILE_MAX_PLAINTEXT_BYTES)
ciphertext_bytes	StrictInt	Field(ge=17, le=BROWSER_PROFILE_MAX_CIPHERTEXT_BYTES)
content_fingerprint	StrictStr	required
nonce_base64	StrictStr	Field(repr=False)
ciphertext_base64	StrictStr	Field(repr=False)

validate_digest (method)

BrowserProfileEncryptedEnvelope.validate_digest(value: str, info) -> str

validate_identifier (method)

BrowserProfileEncryptedEnvelope.validate_identifier(value: str, info) -> str

validate_encoded_payload (method)

BrowserProfileEncryptedEnvelope.validate_encoded_payload() -> Self

nonce (method)

BrowserProfileEncryptedEnvelope.nonce() -> bytes

ciphertext (method)

BrowserProfileEncryptedEnvelope.ciphertext() -> bytes

aad_material (method)

BrowserProfileEncryptedEnvelope.aad_material(authority: BrowserProfileAuthority) -> dict[str, object]

Release source · Runtime guarantees · Capability guides

BrowserProfileInspection

from cayu import BrowserProfileInspection

Bases: _ProfileModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
profile_id	StrictStr	required
authority_fingerprint	StrictStr	required
owner_fingerprint	StrictStr	required
sharing_fingerprint	StrictStr	required
destination_policy_fingerprint	StrictStr	required
state_schema_version	StrictInt	required
browser_protocol	StrictStr	required
browser_worker_version	StrictStr	required
key_authority_id	StrictStr	required
store_id	StrictStr	required
generation	StrictInt	required
content_fingerprint	StrictStr	required
origin_count	StrictInt	required
cookie_count	StrictInt	required
storage_entry_count	StrictInt	required
plaintext_bytes	StrictInt	required
ciphertext_bytes	StrictInt	required
created_at	datetime	required
checkpointed_at	datetime | None	required
expires_at	datetime | None	required
revoked_at	datetime | None	required
active_writer	StrictBool	required
active_allocation_fingerprint	StrictStr | None	required
active_writer_expires_at	datetime | None	required
status	BrowserProfileStatus	required
last_restore_receipt_id	StrictStr | None	required
last_checkpoint_receipt_id	StrictStr | None	required
safe_error_code	StrictStr | None	required

validate_safe_error_code (method)

BrowserProfileInspection.validate_safe_error_code(value: str | None) -> str | None

Release source · Runtime guarantees · Capability guides

BrowserProfileKeyAuthority

from cayu import BrowserProfileKeyAuthority

Application-owned encryption boundary; stores never receive key material.

Bases: ABC.

authority_id (property)

BrowserProfileKeyAuthority.authority_id() -> str

encrypt (method)

async BrowserProfileKeyAuthority.encrypt(*, nonce: bytes, plaintext: bytes, aad: bytes) -> bytes

decrypt (method)

async BrowserProfileKeyAuthority.decrypt(*, nonce: bytes, ciphertext: bytes, aad: bytes) -> bytes

Release source · Runtime guarantees · Capability guides

BrowserProfileLimits

from cayu import BrowserProfileLimits

Bases: _ProfileModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
max_origins	StrictInt	Field(default=32, ge=1, le=BROWSER_PROFILE_MAX_ORIGINS)
max_cookies	StrictInt	Field(default=1024, ge=1, le=BROWSER_PROFILE_MAX_COOKIES)
max_storage_entries	StrictInt	Field(default=2048, ge=1, le=BROWSER_PROFILE_MAX_STORAGE_ENTRIES)
max_name_bytes	StrictInt	Field(default=1024, ge=1, le=BROWSER_PROFILE_MAX_NAME_BYTES)
max_value_bytes	StrictInt	Field(default=64 * 1024, ge=1, le=BROWSER_PROFILE_MAX_VALUE_BYTES)
max_plaintext_bytes	StrictInt	Field(default=2 * 1024 * 1024, ge=1, le=BROWSER_PROFILE_MAX_PLAINTEXT_BYTES)
max_ciphertext_bytes	StrictInt	Field(default=2 * 1024 * 1024 + 16, ge=17, le=BROWSER_PROFILE_MAX_CIPHERTEXT_BYTES)
import_timeout_seconds	StrictFloat	Field(default=10.0, gt=0, le=BROWSER_PROFILE_MAX_IMPORT_EXPORT_SECONDS)
export_timeout_seconds	StrictFloat	Field(default=10.0, gt=0, le=BROWSER_PROFILE_MAX_IMPORT_EXPORT_SECONDS)

validate_ciphertext_capacity (method)

BrowserProfileLimits.validate_ciphertext_capacity() -> Self

Release source · Runtime guarantees · Capability guides

BrowserProfileOriginStorage

from cayu import BrowserProfileOriginStorage

Bases: _PrivateProfileStateModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
origin	StrictStr	required
local_storage	tuple[BrowserProfileStorageEntry, ...]	required

validate_origin (method)

BrowserProfileOriginStorage.validate_origin(value: str) -> str

copy_entries (method)

BrowserProfileOriginStorage.copy_entries(value: object) -> object

validate_entry_order (method)

BrowserProfileOriginStorage.validate_entry_order() -> Self

Release source · Runtime guarantees · Capability guides

BrowserProfileRef

from cayu import BrowserProfileRef

Bases: _ProfileModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
profile_id	StrictStr	required
authority_fingerprint	StrictStr	required
generation	StrictInt	Field(ge=0, le=MAX_DURABLE_JSON_INTEGER)
content_fingerprint	StrictStr	required

validate_profile_id (method)

BrowserProfileRef.validate_profile_id(value: str) -> str

validate_digest (method)

BrowserProfileRef.validate_digest(value: str, info) -> str

Release source · Runtime guarantees · Capability guides

BrowserProfileRestorePreparation

from cayu import BrowserProfileRestorePreparation

Bases: _ProfileModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
request	BrowserProfileRestoreRequest	required
request_fingerprint	StrictStr	required
profile_ref	BrowserProfileRef	required
writer_claim	BrowserProfileWriterClaim	required
envelope	BrowserProfileEncryptedEnvelope | None	Field(default=None, repr=False)
existing_receipt	BrowserProfileRestoreReceipt | None	None

validate_fingerprint (method)

BrowserProfileRestorePreparation.validate_fingerprint(value: str) -> str

validate_preparation (method)

BrowserProfileRestorePreparation.validate_preparation() -> Self

Release source · Runtime guarantees · Capability guides

BrowserProfileRestoreReceipt

from cayu import BrowserProfileRestoreReceipt

Bases: _ProfileModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
receipt_id	StrictStr	required
operation_id	StrictStr	required
request_fingerprint	StrictStr	required
profile_ref	BrowserProfileRef	required
current_policy_fingerprint	StrictStr	required
execution_profile_fingerprint	StrictStr	required
allocation_fingerprint	StrictStr	required
browser_session_id	StrictStr	required
writer_fence	StrictInt	Field(ge=1, le=MAX_DURABLE_JSON_INTEGER)
outcome	BrowserProfileTerminalOutcome	required
error_code	StrictStr | None	None
settled_at	datetime	required

validate_identifier (method)

BrowserProfileRestoreReceipt.validate_identifier(value: str, info) -> str

validate_digest (method)

BrowserProfileRestoreReceipt.validate_digest(value: str, info) -> str

validate_error_code (method)

BrowserProfileRestoreReceipt.validate_error_code(value: str | None) -> str | None

validate_settled_at (method)

BrowserProfileRestoreReceipt.validate_settled_at(value: datetime) -> datetime

validate_outcome (method)

BrowserProfileRestoreReceipt.validate_outcome() -> Self

Release source · Runtime guarantees · Capability guides

BrowserProfileRestoreRequest

from cayu import BrowserProfileRestoreRequest

Bases: _ProfileModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
operation_id	StrictStr	required
access	BrowserProfileAccess	required
expected_ref	BrowserProfileRef | None	None
current_policy_fingerprint	StrictStr	required
execution_profile_fingerprint	StrictStr	required
allocation_fingerprint	StrictStr	required
browser_session_id	StrictStr	required
writer_id	StrictStr	required

validate_identifier (method)

BrowserProfileRestoreRequest.validate_identifier(value: str, info) -> str

validate_digest (method)

BrowserProfileRestoreRequest.validate_digest(value: str, info) -> str

fingerprint (method)

BrowserProfileRestoreRequest.fingerprint() -> str

validate_authority (method)

BrowserProfileRestoreRequest.validate_authority() -> Self

Release source · Runtime guarantees · Capability guides

BrowserProfileScope

from cayu import BrowserProfileScope

Bases: _ProfileModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
owner_fingerprint	StrictStr	required
sharing_fingerprint	StrictStr	required

validate_fingerprint (method)

BrowserProfileScope.validate_fingerprint(value: str, info) -> str

build (method)

BrowserProfileScope.build(*, application_id: str, tenant_id: str, sharing_scope: str) -> BrowserProfileScope

Release source · Runtime guarantees · Capability guides

BrowserProfileStateV1

from cayu import BrowserProfileStateV1

Bases: _PrivateProfileStateModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
schema_version	Literal[1]	1
included_categories	tuple[StrictStr, ...]	_INCLUDED_CATEGORIES
omitted_categories	tuple[StrictStr, ...]	_OMITTED_CATEGORIES
cookies	tuple[BrowserProfileCookie, ...]	()
origins	tuple[BrowserProfileOriginStorage, ...]	()

validate_included (method)

BrowserProfileStateV1.validate_included(value: object) -> tuple[str, ...]

validate_omitted (method)

BrowserProfileStateV1.validate_omitted(value: object) -> tuple[str, ...]

copy_cookies (method)

BrowserProfileStateV1.copy_cookies(value: object) -> object

copy_origins (method)

BrowserProfileStateV1.copy_origins(value: object) -> object

validate_order (method)

BrowserProfileStateV1.validate_order() -> Self

canonical_bytes (method)

BrowserProfileStateV1.canonical_bytes() -> bytes

Release source · Runtime guarantees · Capability guides

BrowserProfileStatus

from cayu import BrowserProfileStatus

Bases: StrEnum.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
AVAILABLE	class attribute	'available'
EMPTY	class attribute	'empty'
ACTIVE	class attribute	'active'
EXPIRED	class attribute	'expired'
REVOKED	class attribute	'revoked'
INCOMPATIBLE	class attribute	'incompatible'
CORRUPT	class attribute	'corrupt'
OUTCOME_UNKNOWN	class attribute	'outcome_unknown'

Release source · Runtime guarantees · Capability guides

BrowserProfileStorageEntry

from cayu import BrowserProfileStorageEntry

Bases: _PrivateProfileStateModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
name	StrictStr	required
value	StrictStr	required

validate_name (method)

BrowserProfileStorageEntry.validate_name(value: str) -> str

validate_value (method)

BrowserProfileStorageEntry.validate_value(value: str) -> str

Release source · Runtime guarantees · Capability guides

BrowserProfileStore

from cayu import BrowserProfileStore

Dedicated encrypted profile store with atomic store-timed mutation.

Bases: ABC.

init (method)

BrowserProfileStore.__init__(*, store_id: str, clock: Callable[[], datetime]=_now, max_ciphertext_bytes: int=BROWSER_PROFILE_MAX_CIPHERTEXT_BYTES) -> None

id (property)

BrowserProfileStore.id() -> str

create_profile (method)

async BrowserProfileStore.create_profile(authority: BrowserProfileAuthority) -> BrowserProfileRef

current_ref (method)

async BrowserProfileStore.current_ref(access: BrowserProfileAccess) -> BrowserProfileRef

resume_writer (method)

async BrowserProfileStore.resume_writer(access: BrowserProfileAccess, *, browser_session_id: str, execution_profile_fingerprint: str, allocation_fingerprint: str, lease_seconds: int) -> BrowserProfileRestorePreparation

Atomically renew and reconstruct one exact live writer.

prepare_restore (method)

async BrowserProfileStore.prepare_restore(request: BrowserProfileRestoreRequest, *, lease_seconds: int) -> BrowserProfileRestorePreparation

complete_restore (method)

async BrowserProfileStore.complete_restore(request: BrowserProfileRestoreRequest, *, outcome: BrowserProfileTerminalOutcome, error_code: str | None=None) -> BrowserProfileRestoreReceipt

load_restore_receipt (method)

async BrowserProfileStore.load_restore_receipt(access: BrowserProfileAccess, operation_id: str) -> BrowserProfileRestoreReceipt | None

renew_writer (method)

async BrowserProfileStore.renew_writer(access: BrowserProfileAccess, claim: BrowserProfileWriterClaim, *, lease_seconds: int) -> BrowserProfileWriterClaim

reserve_checkpoint (method)

async BrowserProfileStore.reserve_checkpoint(request: BrowserProfileCheckpointRequest, *, reserved_ciphertext_bytes: int) -> BrowserProfileCheckpointReservation

stage_checkpoint (method)

async BrowserProfileStore.stage_checkpoint(reservation: BrowserProfileCheckpointReservation, envelope: BrowserProfileEncryptedEnvelope, *, origin_count: int, cookie_count: int, storage_entry_count: int) -> BrowserProfileCheckpointReceipt

fail_checkpoint (method)

async BrowserProfileStore.fail_checkpoint(reservation: BrowserProfileCheckpointReservation, *, outcome: BrowserProfileTerminalOutcome, error_code: str) -> BrowserProfileCheckpointReceipt

publish_checkpoint (method)

async BrowserProfileStore.publish_checkpoint(access: BrowserProfileAccess, operation_id: str) -> BrowserProfileCheckpointReceipt

load_checkpoint_receipt (method)

async BrowserProfileStore.load_checkpoint_receipt(access: BrowserProfileAccess, operation_id: str) -> BrowserProfileCheckpointReceipt | None

reconcile_checkpoint (method)

async BrowserProfileStore.reconcile_checkpoint(access: BrowserProfileAccess, operation_id: str) -> BrowserProfileCheckpointReceipt | None

Adopt an already staged generation without recapturing plaintext.

release_writer (method)

async BrowserProfileStore.release_writer(access: BrowserProfileAccess, claim: BrowserProfileWriterClaim) -> None

revoke_profile (method)

async BrowserProfileStore.revoke_profile(access: BrowserProfileAccess, *, revoked_at: datetime | None=None) -> BrowserProfileInspection

inspect_profile (method)

async BrowserProfileStore.inspect_profile(access: BrowserProfileAccess) -> BrowserProfileInspection

list_profiles (method)

async BrowserProfileStore.list_profiles(*, owner_fingerprint: str, sharing_fingerprint: str) -> tuple[BrowserProfileInspection, ...]

Release source · Runtime guarantees · Capability guides

BrowserProfileStoreConflict

from cayu import BrowserProfileStoreConflict

The requested profile mutation conflicts with durable authority.

Bases: RuntimeError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

BrowserProfileTerminalOutcome

from cayu import BrowserProfileTerminalOutcome

Bases: StrEnum.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
SUCCEEDED	class attribute	'succeeded'
FAILED	class attribute	'failed'
OUTCOME_UNKNOWN	class attribute	'outcome_unknown'

Release source · Runtime guarantees · Capability guides

BrowserProfileUnavailable

from cayu import BrowserProfileUnavailable

The profile cannot be safely restored or checkpointed.

Bases: RuntimeError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

BrowserProfileWriterClaim

from cayu import BrowserProfileWriterClaim

Bases: _ProfileModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
profile_id	StrictStr	required
authority_fingerprint	StrictStr	required
generation	StrictInt	Field(ge=0, le=MAX_DURABLE_JSON_INTEGER)
content_fingerprint	StrictStr	required
writer_id	StrictStr	required
fence	StrictInt	Field(ge=1, le=MAX_DURABLE_JSON_INTEGER)
allocation_fingerprint	StrictStr	required
execution_profile_fingerprint	StrictStr	required
browser_session_id	StrictStr	required
acquired_at	datetime	required
expires_at	datetime	required

validate_identifier (method)

BrowserProfileWriterClaim.validate_identifier(value: str, info) -> str

validate_digest (method)

BrowserProfileWriterClaim.validate_digest(value: str, info) -> str

validate_time (method)

BrowserProfileWriterClaim.validate_time(value: datetime, info) -> datetime

validate_expiry (method)

BrowserProfileWriterClaim.validate_expiry() -> Self

Release source · Runtime guarantees · Capability guides

InMemoryBrowserProfileStore

from cayu import InMemoryBrowserProfileStore

Process-local store used for deterministic composition and conformance.

Bases: BrowserProfileStore.

init (method)

InMemoryBrowserProfileStore.__init__(*, store_id: str='browser-profiles-memory', clock: Callable[[], datetime]=_now, max_ciphertext_bytes: int=BROWSER_PROFILE_MAX_CIPHERTEXT_BYTES) -> None

id (property)

InMemoryBrowserProfileStore.id() -> str

create_profile (method)

async InMemoryBrowserProfileStore.create_profile(authority: BrowserProfileAuthority) -> BrowserProfileRef

current_ref (method)

async InMemoryBrowserProfileStore.current_ref(access: BrowserProfileAccess) -> BrowserProfileRef

resume_writer (method)

async InMemoryBrowserProfileStore.resume_writer(access: BrowserProfileAccess, *, browser_session_id: str, execution_profile_fingerprint: str, allocation_fingerprint: str, lease_seconds: int) -> BrowserProfileRestorePreparation

Atomically renew and reconstruct one exact live writer.

prepare_restore (method)

async InMemoryBrowserProfileStore.prepare_restore(request: BrowserProfileRestoreRequest, *, lease_seconds: int) -> BrowserProfileRestorePreparation

complete_restore (method)

async InMemoryBrowserProfileStore.complete_restore(request: BrowserProfileRestoreRequest, *, outcome: BrowserProfileTerminalOutcome, error_code: str | None=None) -> BrowserProfileRestoreReceipt

load_restore_receipt (method)

async InMemoryBrowserProfileStore.load_restore_receipt(access: BrowserProfileAccess, operation_id: str) -> BrowserProfileRestoreReceipt | None

renew_writer (method)

async InMemoryBrowserProfileStore.renew_writer(access: BrowserProfileAccess, claim: BrowserProfileWriterClaim, *, lease_seconds: int) -> BrowserProfileWriterClaim

reserve_checkpoint (method)

async InMemoryBrowserProfileStore.reserve_checkpoint(request: BrowserProfileCheckpointRequest, *, reserved_ciphertext_bytes: int) -> BrowserProfileCheckpointReservation

stage_checkpoint (method)

async InMemoryBrowserProfileStore.stage_checkpoint(reservation: BrowserProfileCheckpointReservation, envelope: BrowserProfileEncryptedEnvelope, *, origin_count: int, cookie_count: int, storage_entry_count: int) -> BrowserProfileCheckpointReceipt

fail_checkpoint (method)

async InMemoryBrowserProfileStore.fail_checkpoint(reservation: BrowserProfileCheckpointReservation, *, outcome: BrowserProfileTerminalOutcome, error_code: str) -> BrowserProfileCheckpointReceipt

publish_checkpoint (method)

async InMemoryBrowserProfileStore.publish_checkpoint(access: BrowserProfileAccess, operation_id: str) -> BrowserProfileCheckpointReceipt

load_checkpoint_receipt (method)

async InMemoryBrowserProfileStore.load_checkpoint_receipt(access: BrowserProfileAccess, operation_id: str) -> BrowserProfileCheckpointReceipt | None

reconcile_checkpoint (method)

async InMemoryBrowserProfileStore.reconcile_checkpoint(access: BrowserProfileAccess, operation_id: str) -> BrowserProfileCheckpointReceipt | None

Adopt an already staged generation without recapturing plaintext.

release_writer (method)

async InMemoryBrowserProfileStore.release_writer(access: BrowserProfileAccess, claim: BrowserProfileWriterClaim) -> None

revoke_profile (method)

async InMemoryBrowserProfileStore.revoke_profile(access: BrowserProfileAccess, *, revoked_at: datetime | None=None) -> BrowserProfileInspection

inspect_profile (method)

async InMemoryBrowserProfileStore.inspect_profile(access: BrowserProfileAccess) -> BrowserProfileInspection

list_profiles (method)

async InMemoryBrowserProfileStore.list_profiles(*, owner_fingerprint: str, sharing_fingerprint: str) -> tuple[BrowserProfileInspection, ...]

Release source · Runtime guarantees · Capability guides

SQLiteBrowserProfileStore

from cayu import SQLiteBrowserProfileStore

SQLite-backed encrypted profile store with transactional row CAS.

Bases: BrowserProfileStore.

init (method)

SQLiteBrowserProfileStore.__init__(path: str | Path, *, store_id: str='browser-profiles-sqlite', clock: Callable[[], datetime]=_now, max_ciphertext_bytes: int=BROWSER_PROFILE_MAX_CIPHERTEXT_BYTES) -> None

id (property)

SQLiteBrowserProfileStore.id() -> str

create_profile (method)

async SQLiteBrowserProfileStore.create_profile(authority: BrowserProfileAuthority) -> BrowserProfileRef

current_ref (method)

async SQLiteBrowserProfileStore.current_ref(access: BrowserProfileAccess) -> BrowserProfileRef

resume_writer (method)

async SQLiteBrowserProfileStore.resume_writer(access: BrowserProfileAccess, *, browser_session_id: str, execution_profile_fingerprint: str, allocation_fingerprint: str, lease_seconds: int) -> BrowserProfileRestorePreparation

Atomically renew and reconstruct one exact live writer.

prepare_restore (method)

async SQLiteBrowserProfileStore.prepare_restore(request: BrowserProfileRestoreRequest, *, lease_seconds: int) -> BrowserProfileRestorePreparation

complete_restore (method)

async SQLiteBrowserProfileStore.complete_restore(request: BrowserProfileRestoreRequest, *, outcome: BrowserProfileTerminalOutcome, error_code: str | None=None) -> BrowserProfileRestoreReceipt

load_restore_receipt (method)

async SQLiteBrowserProfileStore.load_restore_receipt(access: BrowserProfileAccess, operation_id: str) -> BrowserProfileRestoreReceipt | None

renew_writer (method)

async SQLiteBrowserProfileStore.renew_writer(access: BrowserProfileAccess, claim: BrowserProfileWriterClaim, *, lease_seconds: int) -> BrowserProfileWriterClaim

reserve_checkpoint (method)

async SQLiteBrowserProfileStore.reserve_checkpoint(request: BrowserProfileCheckpointRequest, *, reserved_ciphertext_bytes: int) -> BrowserProfileCheckpointReservation

stage_checkpoint (method)

async SQLiteBrowserProfileStore.stage_checkpoint(reservation: BrowserProfileCheckpointReservation, envelope: BrowserProfileEncryptedEnvelope, *, origin_count: int, cookie_count: int, storage_entry_count: int) -> BrowserProfileCheckpointReceipt

fail_checkpoint (method)

async SQLiteBrowserProfileStore.fail_checkpoint(reservation: BrowserProfileCheckpointReservation, *, outcome: BrowserProfileTerminalOutcome, error_code: str) -> BrowserProfileCheckpointReceipt

publish_checkpoint (method)

async SQLiteBrowserProfileStore.publish_checkpoint(access: BrowserProfileAccess, operation_id: str) -> BrowserProfileCheckpointReceipt

load_checkpoint_receipt (method)

async SQLiteBrowserProfileStore.load_checkpoint_receipt(access: BrowserProfileAccess, operation_id: str) -> BrowserProfileCheckpointReceipt | None

reconcile_checkpoint (method)

async SQLiteBrowserProfileStore.reconcile_checkpoint(access: BrowserProfileAccess, operation_id: str) -> BrowserProfileCheckpointReceipt | None

Adopt an already staged generation without recapturing plaintext.

release_writer (method)

async SQLiteBrowserProfileStore.release_writer(access: BrowserProfileAccess, claim: BrowserProfileWriterClaim) -> None

revoke_profile (method)

async SQLiteBrowserProfileStore.revoke_profile(access: BrowserProfileAccess, *, revoked_at: datetime | None=None) -> BrowserProfileInspection

inspect_profile (method)

async SQLiteBrowserProfileStore.inspect_profile(access: BrowserProfileAccess) -> BrowserProfileInspection

list_profiles (method)

async SQLiteBrowserProfileStore.list_profiles(*, owner_fingerprint: str, sharing_fingerprint: str) -> tuple[BrowserProfileInspection, ...]

close (method)

async SQLiteBrowserProfileStore.close() -> None

Release source · Runtime guarantees · Capability guides