Appearance
Upgrading
No longer maintained by hand (owner decision, 2026-10-31: «отменяю оба правила, нам нужна автоматизация для этого из конвенциональных коммитов»; the automation for it is still in the backlog). The entries below are history, kept as written.
This page is the release-by-release record of the Simulator: what you change in your program when you move to a newer version. Versions follow one rule: a major version only for a large change to the Simulator's own core, a minor version for a breaking change that Instagram's remote API forces, a patch for a fix. Read every minor release between your version and the one you install.
Two things hold for every upgrade:
- Stored sessions: see Keep a session. A checkpoint from release 4.11.0 or later starts in any later release, by
launchor by a resume: the import keeps the app build the snapshot declares (a session saved on 222 sends the 222 user agent and build number) and fills only the fields the snapshot omits from the release's presented build. - A snapshot saved by any release from 4.0.3 on restores. A field that cannot be understood is dropped and logged instead of failing the restore.
4.15
- A display field of a screen's
dataor of a decoded answer isT | undefined. A schema states only the fields the library itself acts on; every other field is a display field, wrapped inShown, and reads asundefinedwhen it is absent,nullor of another type — a drifted answer never fails the call or the screen enter. Read a display field asfield ?? fallback; a field the library decides on — an id, a cursor — stays required and its type is unchanged. This release sweeps the search results' Accounts tab, the typeahead's dictionaries and the search field's recent accounts, and the Explore tab's recent-searches answer; the remaining screen and decode schemas keep their shape until their own sweep. - The Android
pushTokenoption is removed. An Android device registers its own push token, and a caller's token is never sent;AndroidApp({ pushToken }),AndroidIgpapi.install({ pushToken })andlaunch({ pushToken })are type errors. Delete the option. iOS keepspushTokenfor the APNs token Apple issues. AndroidPushRegisterandAndroidPushRegisterInputare no longer exported. The launch registers the device itself; delete a call to it.- The Pigeon building blocks only log.
pigeonSendEventsis removed andpigeonSendInfraBatchesis renamedemitPigeonInfraBatches; the process's one sender delivers what they logged. Log events withemitPigeonEvents, begin the session withemitPigeonInfraBatches, and callFlushTelemetrywhere your program must wait for the upload. AnalyticsSendis no longer a member of the runtime surface. A service set built fromAndroidRuntimeServicesorIosRuntimeServicesno longer provides it; stop requiring it and callFlushTelemetrywhere the program must wait for the upload.perfClientTtiandigTimeSpentScreenTimetake the measured duration —perfClientTti({ durationMs }),igTimeSpentScreenTime({ sessionLengthSec })— instead of drawing one at random. Pass the time your program measured.MobileTelemetryStateno longer holdsevents; the events are the device's (MobileDeviceState.telemetry.pending).TakeTelemetryreturns queued events whose payload is JSON text (read it withqueuedTelemetryPayloadOf), andRestoreTelemetrytakes the channel first. Read the device's queue.LoginHomepageHandleno longer hasopenEmailCode(),openApproveFromAnotherDevice()andopenMethodPicker().logIntakes them itself when the login hands off to the email code, the approval on another device or the two-factor method picker. CalllogIn(credentials)and read the screen it answers instead of calling the transition.- An edge a screen's action takes after the person's input is declared in the definition's
actionEdgestable, besideactions;actionEdge(member)and theActionEdgetype are removed. Move eachactionEdge(opens(…))out ofactionsintoactionEdgesas the plainopens(…), and keep calling it from the action asopenNext(self, state)(…). VoiceAttachmentMessagerequires itswaveform, and the photo and the voice message no longer carrybody. Passwaveform(measure it withvoiceWaveformOfor pass your own samples), and stop readingbodyon these two types: the form iscompose's.- The app's own restrictions are gone: the server decides.
MediaRepostTextTooLongError,checkRepostTextandMEDIA_REPOST_TEXT_MAX_LENGTHare removed (a repost text of any length is sent), andRepostNoteEditorUnavailableError,DirectGroupNameUnavailableErrorandMediaRepostTextNotAcceptedErrorare removed (the screens open and the server decides). Drop their handlers and calls; a refusal reaches you as its typed error —MediaRepostTextRejectedErroror the core'sRequestError. - A reaction names the tray's emoji.
react()takes{ emoji }andDirectReactionis{ emoji: DirectReactionEmoji }, one of ❤, 😂, 😮, 😢, 😡 and 👍.message.react('like')becomesmessage.react({ emoji: '❤' }). DirectEditMessageis the 451 GraphQL mutation and reads its answer.originalMessageClientContextis renamedofflineThreadingIdand is optional, and the call resolves to the edit's value, failing withDirectEditMessageRejectedErrorwhen Instagram refused it orGraphqlRootFieldMissingErrorwhen the answer carries no result. Pass the message'sclient_contextasofflineThreadingIdand answer the two errors.DirectThreadDeleteItemhas noisSshMode(the 451 delete form carries nois_ssh_mode). Drop the argument.DirectBroadcastFormPartscarries the caller'ssendSilently,isShhMode,isXTransportForwardandextras, and acomposereturns its fields throughwithBroadcastOptions. Wrap the fields a customcomposereturns inwithBroadcastOptions(parts, fields).- A
PigeonContextyou build yourself changed.sessionIdisfamilyId,hmacTokensisauthTokens(thehmac_ttltoken ishmacTtlToken),identityRequest,samplingChecksumandconfigChecksumare required, andPigeonChecksum.timestampis text. Rename the two fields, passidentityRequest: falseand{ timestamp: '0', hash: '' }when the upload is not a session's own, and write a checksum'stimestampas a string. A platform that provides its ownMobileAppLifecycleaddsforegroundCount, its count of foreground moments (return0when it models none). - A follow no longer reloads the profile's suggested-users rail.
follow()answers the visit'ssuggestedrows, andProfileFollowAnswer.backgroundFailuresis empty;ProfileReachedFromgains{ kind: 'recent' }for a profile opened from the search field's Recent list. A switch overProfileReachedFromgains therecentcase, and a caller that wants the header's rail callsopenSuggestedUsers(). reactionMessage'sreactionActionSourcedefaults toemoji_tray, the message menu's source (a double tap on a message sends nothing in the 451 app). PassreactionActionSource: 'double_tap'to send the old form.
4.14
- Every id is a
string, in every response type and every input. An id that named an entity — a user, a media, a comment, a thread, an item, a story, a location, a hashtag, an audio, a broadcast — was anumberin about 340 response types, orstring | numberin the inputs and some responses; it isstringeverywhere now, whatever its length, and the library reads a number under an id key as its exact text. The inputs that tookstring | numbertakestring, so a program that passes a number gets a type error. Keep ids as strings and compare them as strings (media.user.pk === '555', not=== 555), replaceNumber(user.pk)with the text itself, passString(id)where you held a number, and read a stored list of ids asstring[]; convert at the one place that needs a number (BigInt(id)for a long one). A zero the server writes under an id key is'0', and'0'is truthy: check emptiness with=== '0'. The readers return text for ids too:parseJson,parseNdjson,jsonWithLongIdsAsText,fromJsonText, a typed error'sbodyand a screen item'sraw. MediaOembedResponsedescribes only what the library reads: every field is optional, and a field the answer adds is kept. Check a field forundefinedbefore using it.WebChallengeInfois the page as the server answered it (unknown), and the web challenge step'schallengeTypeisstring | undefined;webChallengeTypeOf(challenge)reads the type.- A telemetry id keeps every digit, and
MobileTelemetryEventSchemaisMobileTelemetryEventTrailSchema. The trail reader reads a stored payload of plain JSON; the live event is theMobileTelemetryEventtype. Rename the schema you use. DirectRecipientPickerScreen'ssearch(query)answers{ recipients, threads }instead of the recipients array. Read.recipientsfor the people and.threadswhere the search shows conversations.DirectBroadcastMessage.bodyis optional, and a message may lay its own form out.DirectBroadcastMessage.compose(withDirectBroadcastFormParts) returns the whole form and the broadcast adds nothing around it;DirectBroadcastInput.extrasadds fields after the navigation chain. A message type with abodykeeps it; a message that lays out every field returnscompose.DirectThreadInput'ssend_attributionis a closed set —inbox,inbox_new_message,direct_thread_creation_omnipicker,message_button. Pass one of the four.DirectThreadDetailsis a sum on the thread's kind: a one-to-one thread carries its peer'speer_user_idandpeer_user_fbid, a group its first participant'slead_user_id. Narrow onis_groupbefore reading a peer's field.- The oldest TypeScript a user may have is 7. TypeScript 5.9 support is gone; the published declarations are checked with TypeScript 7.
4.13
effectis a peer dependency.@igpapi/core,@igpapi/mobile,@igpapi/android,@igpapi/iosand@igpapi/pigeon-nestdeclareeffect(^4.0.6) as a peer instead of carrying their own copy, so your project and the packages share one copy of Effect. Install it beside the platform package:npm install @igpapi/android [email protected](orpnpm add …,yarn add …). npm 7 and later and pnpm 8 and later install a missing peer by themselves; Yarn only warns, and the import fails untileffectis a dependency of your project. A project that already depends on[email protected]or a later 4.x changes nothing. The install page has the registry setup for each package manager.- A launch returns as soon as the feed is on screen. The rest of the start-up runs on in the process's background; the call still waits for it before the app closes, and
checkpoint()andExportSnapshotwait for it before they read. A session-fatal answer to it rejects the call with the same typed error (The app process). MobileProcessBackgroundchanged shape:startTimer,armedTimersandrestoreTimersare gone. A program that waited for the process's background work usesawaitMobileProcessBackground, which fails with the session-fatal error the background met.- New:
totpCodeOf(secret)returns the code an authenticator app shows, so a headless login can submit it (Log in, with two-factor).share()of a post, a Reel or a story reports the media's shortcodewhen Instagram's answer carries it.
4.12
- A list whose items are a tagged union is open. An item of a kind the Simulator does not model is kept as an explicit unknown item and never fails the screen. The types of these lists are wider, so TypeScript code that read a member without narrowing, or switched exhaustively, stops compiling.
TypeaheadResultandTypeaheadRow, andTimelineFeedResponseFeedItemsItemandFeedTimelineEntry, have one more member (the typeahead result's discriminant iskind: 'unknown'; the timeline entry hastype: 'unknown'; the typeahead row has__typename: 'unknown'). Narrow before you read a member, and add a branch for the unknown one. effectis the stable 4.0.6. Programs that compose the Simulator's services with their own Effect code useContext.ServiceandContext.Referencewhere the beta hadServiceMap.- Three exports of
@igpapi/core/mobilechanged with the snapshot restore:legacySnapshotNetworkOftakes the stored value,settleDeviceAdsOptOuttakes the stored value instead of the session, andsettleSessionNavigationis removed. A caller passes the stored value or drops the call:MobileSnapshotSchemareads the stored fields itself.
4.11: program is main
- Rename
programtomain. The callback option ofAndroidIgpapi.install,launch,resumeSilently,resumeFromBackground,resumeByReentering, and ofIosIgpapi.installandlaunch, ismain. A caller that still passesprogramfails at run time withTypeError: main is not a function. The type names follow:AndroidIgpapiProgramisAndroidIgpapiMain, andIosIgpapiProgramisIosIgpapiMain. mainnever receives a challenge. Code that caughtIgCheckpointErrorinsidemainand calledOpenChallengemoves into anotherwisebranch (Answer a challenge withotherwise).OpenChallengestays for a program that composesAndroidAppitself.IosIgpapihas the rename alone, because iOS has no screens.- Publish through the screens. The one-call posting bricks are removed (
TimelinePhotoPost,AlbumPost,ClipPost,UploadPhoto,UploadVideoand their inputs). UseFeedTimelineScreen.openCreation(mode), pick, edit,share, in a launched process (Publishing). openCreation(mode)takes'post' | 'story' | 'reel'and answers exactly that mode's first screen.PostingPhotoInputandPostingVideoInputlosetakenAtandfolder; the device's media store answers them through the gallery's second argument.PostingMusicSearchResultis a union with akinddiscriminant ('track'or'originalAudio'), andPostingMusicProducthaskind: 'story-sticker'andkind: 'reel'.ClipMusicOptionslosesassetId,clusterId,songName,artistNameandsessionId; all are derived fromtrack. Passtrack(aReelSongTrack) and the two volumes.jsonBigStringisjsonWithLongIdsAsText. It returnsunknown; rename the import and read the value through the Simulator's schemas.ScreenNotOnTopError.reason:coveredonly while the screen is still open under another; a handle whose screen was closed, opened again or replaced isnavigation-moved.- A checkpoint written by an earlier release is refused; log in again and take a new one.