zikzak_session library
zikzak_session — portable browser sessions for the Zuraffa ecosystem.
A standalone Dart package providing self-contained units of webview state (cookies + DOM storage) that persist to a relocatable store and reload into a webview for a specific site. Built entirely with the zfa clean-architecture CLI: entities, datasources, repositories, and usecases are generated; the SessionPort surfaces them through a general session contract (save/load/list/delete) independent of browser internals.
final getIt = GetIt.instance;
await registerSessionDependencies(getIt, storeDir: dir);
final sessions = getIt<SessionPort>();
await sessions.save(session);
final restored = await sessions.load(session.id);
Classes
- $CookieEntry
- CookieEntry entity
- $PortableSession
- PortableSession entity
- $StorageEntry
- StorageEntry entity
- CookieEntry
- CookieEntryFields
- Field descriptors for CookieEntry query construction
- CookieEntryPatch
- ExportSessionUseCase
- Exports a stored session into a self-contained, relocatable artifact (spec FR-007).
- FileSessionStore
- File-backed SessionPort (spec FR-006/FR-008/FR-009).
- ImportSessionUseCase
- Imports a PortableSessionArtifact into the store (spec FR-008 / FR-010 / FR-011).
- PortableSession
- PortableSessionArtifact
-
A self-contained, relocatable transport bundle produced by
exportand consumed byimport(spec FR-007 / FR-008 / FR-010 / FR-011). - PortableSessionFields
- Field descriptors for PortableSession query construction
- PortableSessionFileDataSource
-
Bridges the generated
PortableSessionDataSourcecontract onto a FileSessionStore (spec FR-007 / US4). - PortableSessionPatch
- PortableSessionRepository
- SessionArtifactCodec
- Encodes/decodes a PortableSessionArtifact (spec FR-007 / FR-008 / FR-010 / FR-011).
- SessionManager
- High-level, consumer-facing facade over the session subsystem (spec FR-001 / FR-002 / FR-003 / FR-004 / FR-005 / FR-006 / FR-007 / FR-008).
- SessionPort
- The technology-agnostic session contract (spec FR-007 / US4).
- SessionValidator
- Validates and normalizes PortableSession data for consistency across saves and imports (spec FR-010).
- StorageEntry
- StorageEntryFields
- Field descriptors for StorageEntry query construction
- StorageEntryPatch
Extensions
- CookieEntryCompareE on CookieEntry
- CookieEntryPropertyHelpers on CookieEntry
- CookieEntrySerialization on CookieEntry
- PortableSessionCompareE on PortableSession
- PortableSessionPropertyHelpers on PortableSession
- PortableSessionSerialization on PortableSession
- StorageEntryCompareE on StorageEntry
- StorageEntryPropertyHelpers on StorageEntry
- StorageEntrySerialization on StorageEntry
Functions
-
registerSessionDependencies(
GetIt getIt, {required Directory storeDir}) → void -
Registers the real session stack onto
getIt(spec FR-006/FR-007).
Exceptions / Errors
- SessionChecksumException
- Recoverable codec-level error: the artifact's integrity checksum does not match the wrapped session (spec FR-010).
- SessionFileException
- Recoverable store-level error (corrupt/unreadable session data).
- SessionNotFoundException
- Thrown when an export is requested for a session id that does not exist.
- SessionUnsupportedVersionException
- Recoverable codec-level error: the artifact declares a format version this package cannot read (spec FR-011).
- SessionValidationException
- Thrown when a session fails validation (spec FR-010).