tangl.service manager

The canonical service surface is the explicit tangl.service.ServiceManager.

Its public methods are the source of truth for service behavior. See tangl.service methods for the generated method catalog derived from tangl.service.service_method() metadata.

Related design docs

Related notes

Manager

class ServiceManager(persistence_manager=None)[source]

Explicit public service API over persistence-backed story resources.

classmethod get_service_methods()[source]

Return canonical public service-method metadata in declaration order.

open_user(user_id, *, write_back=False)[source]

Open one persisted user resource.

open_ledger(ledger_id, *, write_back=False)[source]

Open one persisted ledger resource.

open_world(world_id, /)[source]

Resolve one world by id.

open_session(*, user_id=None, ledger_id=None, write_back=False, user_auth=None)[source]

Open a linked user/ledger session context.

create_story(*, user_id, world_id, user_auth=None, **kwargs)[source]

Create a story session and return the initial runtime envelope.

resolve_choice(*, choice_id, user_id=None, ledger_id=None, user_auth=None, choice_payload=None)[source]

Resolve one choice edge and return the newest runtime envelope.

get_story_update(*, user_id=None, ledger_id=None, user_auth=None, since_step=None, limit=0)[source]

Return ordered runtime fragments for the active story session.

get_story_info(*, user_id=None, ledger_id=None, user_auth=None)[source]

Return projected current-state sections for the active story.

drop_story(*, user_id=None, ledger_id=None, user_auth=None, archive=False)[source]

Clear the active story and optionally delete the persisted ledger.

create_user(*, secret=None, **kwargs)[source]

Create and persist a service user.

update_user(*, user_id, user_auth=None, **kwargs)[source]

Update one persisted user record.

get_user_info(*, user_id, user_auth=None, **kwargs)[source]

Return persisted user profile information.

drop_user(*, user_id, user_auth=None)[source]

Delete one persisted user record.

get_key_for_secret(*, secret)[source]

Encode a user secret as an API key.

list_worlds()[source]

List available worlds as typed info models.

get_world_info(*, world_id)[source]

Return metadata for one resolved world.

get_world_media(*, world_id, media, **kwargs)[source]

Return implementation-specific media content for one world asset.

load_world(*, script_path=None, script_data=None)[source]

Load one ad hoc world into the process-local manual registry.

unload_world(*, world_id)[source]

Unload one process-local manual world.

get_system_info()[source]

Return service/system metadata.

reset_system(*, hard=False)[source]

Implementation-specific system reset hook.

class ServiceSession(user, ledger, frame)[source]

Live user/ledger/frame bundle opened by ServiceManager.