Interface ScreenCatalogEntry<X, R>

One screen as the engine holds it among the others of its screen set, typed by the screen's own failures X and services R: what an edge (which knows its target by id) and a retrace need of a definition.

interface ScreenCatalogEntry<X, R> {
    encodeInput: (
        input: unknown,
    ) => Effect<ScreenEncodedInput, ScreenEdgeInputError>;
    enter: (
        args: {
            input: ScreenEncodedInput;
            origin: ScreenHandle | undefined;
            reach: ScreenEdgeReach | undefined;
            via: ScreenVia;
        },
    ) => Effect<
        ScreenFrameHandle,
        ScreenTrailDecodeError
        | ScreenRetraceStepError<X>,
        ScreenEnterServices<R, never>,
    >;
    findItem: (
        host: ScreenHandle,
        item: ScreenItemLocation,
    ) => Effect<
        ScreenHandle
        | undefined,
        ScreenRetraceError | ScreenRetraceStepError<X>,
        R,
    >;
    id:
        | "LoginHomepage"
        | "LoginHomeCds"
        | "LandingScreen"
        | "LoginTwoFactorEntrypoint"
        | "LoginTwoFactorMethodPicker"
        | "LoginTwoFactorEnterTotpCode"
        | "AccountRecoverySearchCds"
        | "AccountRecoverySearch"
        | "AccountRecoveryAuthenticationConfirmation"
        | "AccountRecoveryEmailCode"
        | "RegistrationPhoneNumber"
        | "RegistrationConfirmationCode"
        | "RegistrationPassword"
        | "RegistrationBirthday"
        | "RegistrationName"
        | "RegistrationUsername"
        | "RegistrationTermsOfService"
        | "SaveCredentials"
        | "AccountRecoverySuccessLocationPermission"
        | "FeedTimeline"
        | "PostOpenedFromLink"
        | "ReelsViewer"
        | "MediaComments"
        | "RepostNoteEditor"
        | "Explore"
        | "SearchInput"
        | "SearchResultsTopTab"
        | "SearchResultsAccountsTab"
        | "UserProfile"
        | "ProfileMediaTab"
        | "MyProfile"
        | "MyProfileMediaTab"
        | "EditProfile"
        | "EditProfileBio"
        | "EditProfileUsername"
        | "EditProfileLinks"
        | "EditProfileAddLink"
        | "ProfilePostsFeed"
        | "FeedTimelineFollowing"
        | "UserProfileReelsTab"
        | "DirectInbox"
        | "DirectRecipientPicker"
        | "DirectThread"
        | "DirectForwardingSheet"
        | "DirectMediaPickerPhotos"
        | "DirectStickerTabTray"
        | "DirectGifTray"
        | "DirectStickerPickerGrid"
        | "DirectImagineLoading"
        | "DirectImagineCreation"
        | "DirectDoodleEditor"
        | "DirectCustomizeChat"
        | "DirectThreadThemePicker"
        | "DirectThreadDetails"
        | "DirectThreadSharedMedia"
        | "DirectThreadNicknames"
        | "DirectThreadNicknameChange"
        | "DirectGroupNameAndPhotoEditor"
        | "DirectShareSheet"
        | "StoriesViewer"
        | "PostingGalleryPicker"
        | "PostingPostEdit"
        | "PostingNewPost"
        | "PostingCamera"
        | "PostingCameraGallery"
        | "PostingReelEditor"
        | "PostingNewReel"
        | "PostingPostVideoCameraGallery"
        | "PostingPostVideoCamera"
        | "PostingReelCamera"
        | "PostingStoryCameraHost"
        | "PostingStoryCameraGallery"
        | "PostingPostVideoNewReel"
        | "PostingStoryPhotoEditor"
        | "PostingStoryVideoEditor"
        | "PostingStoryStickerTray"
        | "PostingStoryMusicStickerEditor"
        | "PostingStoryShareSheet"
        | "PostingStoryAlsoShareTo"
        | "PostingStoryDoneCamera"
        | "PostingStoryMusicSearchHost"
        | "PostingMusicBrowser"
        | "PostingMusicSearchResults"
        | "PostingReelMusicOverlayDetail"
        | "PostingReelMusicEditor"
        | "ChallengeSelectVerifyMethod"
        | "ChallengeVerifyCode"
        | "ChallengeSubmitPhone"
        | "ChallengeSetNewPassword"
        | "ChallengeAddBirthday"
        | "ChallengeLoginReview"
        | "ChallengeAccountTemporarilyLocked"
        | "ChallengeEscalationInformation"
        | "ChallengeReviewContactPointChange"
        | "ChallengeScrapingWarning"
        | "ChallengeWebRecaptcha"
        | "ChallengeWebSetNewPassword"
        | "ChallengeTextCaptcha"
        | "ChallengeRecaptcha"
        | "ChallengeSetContactPoint"
        | "ChallengeContactPointCode"
        | "ChallengeAuthenticityWizard"
        | "ChallengeAwaitingReview"
        | "ChallengeThanksForProvidingInfo"
        | "ChallengeAccountSuspended";
    kind: EnterableScreenKind;
    releasedItemLists: Readonly<Record<string, string>>;
    restorePosition: (
        handle: ScreenHandle,
        position: Json,
    ) => Effect<void, ScreenRetraceError | ScreenRetraceStepError<X>, R>;
    sameInput: (
        a: ScreenEncodedInput,
        b: ScreenEncodedInput,
    ) => Effect<boolean, ScreenTrailDecodeError>;
    take: (
        args: {
            input: unknown;
            origin: ScreenHandle | undefined;
            reach: ScreenEdgeReach;
            via: ScreenVia;
        },
    ) => Effect<
        ScreenFrameHandle,
        X
        | ScreenEdgeInputError,
        ScreenEnterServices<R, never>,
    >;
}

Type Parameters

Index

Properties

encodeInput enter findItem id kind releasedItemLists restorePosition sameInput take

Properties

`Readonly`encodeInput

encodeInput: (
input: unknown,
) => Effect<ScreenEncodedInput, ScreenEdgeInputError>

Checks an edge step's input against the screen's input schema and encodes it.

`Readonly`enter

enter: (
    args: {
        input: ScreenEncodedInput;
        origin: ScreenHandle | undefined;
        reach: ScreenEdgeReach | undefined;
        via: ScreenVia;
    },
) => Effect<
    ScreenFrameHandle,
    ScreenTrailDecodeError
    | ScreenRetraceStepError<X>,
    ScreenEnterServices<R, never>,
>

A retrace: decodes the stored input and opens the screen (its enter burst runs and emits navigation).

`Readonly`findItem

findItem: (
    host: ScreenHandle,
    item: ScreenItemLocation,
) => Effect<
    ScreenHandle
    | undefined,
    ScreenRetraceError | ScreenRetraceStepError<X>,
    R,
>

A retrace's lookup of an item a trail names, on a fresh handle of the screen (see ScreenDefinition.findItem).

`Readonly`id

`Readonly`kind

kind: EnterableScreenKind

`Readonly`releasedItemLists

releasedItemLists: Readonly<Record<string, string>>

How a released trail format named the screen's item lists, mapped to today's names (see ScreenDefinition.releasedItemLists).

`Readonly`restorePosition

restorePosition: (
handle: ScreenHandle,
position: Json,
) => Effect<void, ScreenRetraceError | ScreenRetraceStepError<X>, R>

A retrace's return of a fresh frame to a stored position (see ScreenDefinition.restorePosition).

`Readonly`sameInput

sameInput: (
a: ScreenEncodedInput,
b: ScreenEncodedInput,
) => Effect<boolean, ScreenTrailDecodeError>

Whether two encoded inputs of the screen are the same input (by the input schema's equivalence).

`Readonly`take

take: (
    args: {
        input: unknown;
        origin: ScreenHandle | undefined;
        reach: ScreenEdgeReach;
        via: ScreenVia;
    },
) => Effect<
    ScreenFrameHandle,
    X
    | ScreenEdgeInputError,
    ScreenEnterServices<R, never>,
>

An edge: checks the step's input against the screen's schema and opens the screen.

Interface ScreenCatalogEntry<X, R>

Type Parameters

Index

Properties

Properties

`Readonly`encodeInput

`Readonly`enter

`Readonly`findItem

`Readonly`id

`Readonly`kind

`Readonly`releasedItemLists

`Readonly`restorePosition

`Readonly`sameInput

`Readonly`take

Settings

On This Page

Interface ScreenCatalogEntry<X, R>

Type Parameters

Index

Properties

Properties

ReadonlyencodeInput

Readonlyenter

ReadonlyfindItem

Readonlyid

Readonlykind

ReadonlyreleasedItemLists

ReadonlyrestorePosition

ReadonlysameInput

Readonlytake

Settings

On This Page

`Readonly`encodeInput

`Readonly`enter

`Readonly`findItem

`Readonly`id

`Readonly`kind

`Readonly`releasedItemLists

`Readonly`restorePosition

`Readonly`sameInput

`Readonly`take