feat!: bump @gusto/embedded-api to v2026-02-01 [skill-driven competing PR]#2244
Closed
jeffredodd wants to merge 2 commits into
Closed
feat!: bump @gusto/embedded-api to v2026-02-01 [skill-driven competing PR]#2244jeffredodd wants to merge 2 commits into
jeffredodd wants to merge 2 commits into
Conversation
BREAKING CHANGE: upgrade the SDK from @gusto/embedded-api-v-2025-11-15 to @gusto/embedded-api-v-2026-02-01. Mechanical port: - import paths in src/ and sdk-app/ (single sed sweep) - hardcoded queryKey string literals on the same cache namespace - bare-date X-Gusto-API-Version constant in apiVersionHook.ts plus three unit-test assertion sites - docs (AGENTS.md, CLAUDE.md, src/CLAUDE.md, docs/api, docs/hooks, docs/reference) and build/deriveEndpointInventory.ts + e2e/utils/validationErrorCollector.test.ts - package.json: @gusto/embedded-api-v-2026-02-01 ^0.0.1 - usePreparedPayrollData.ts: QueryParamSortBy removed from the putv1...prepare operation; sortBy collapses to string - fix pre-existing MD040 lint in AGENTS.md / src/CLAUDE.md surfaced by the touch (add `text`/`bash` language tags to fenced code blocks) Generated autonomously by the api-version-upgrade skill for comparison against PR #2233. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Upgrade the SDK from
@gusto/embedded-api-v-2025-11-15to@gusto/embedded-api-v-2026-02-01.Every breaking change in v2026-02-01 is either:
usePreparedPayrollData.ts) — typecheck verifiesapiVersionHook.ts) — unit tests verifygrep -rln "@gusto/embedded-api-v-2025-11-15" .returns emptyBreaking-change matrix
QueryParamSortByremoved fromputv1companiescompanyidpayrollspayrollidprepare;sortBycollapses tostringsrc/components/Payroll/usePreparedPayrollData.ts:6,15sortBy?: string. Typecheck CI.X-Gusto-API-Versionruntime constant ('2025-11-15'→'2026-02-01')src/contexts/ApiProvider/apiVersionHook.ts:3(+ 2 test files)apiVersionHook.test.ts+ApiProvider.test.tsx.'@gusto/embedded-api-v-2025-11-15'flipped at 13+ sitescreateSdkQueryClient.ts,ApiProvider.tsx,TimeOff/*,Company/Locations/*,sdk-app/.../contractor-management/*grep -rln "@gusto/embedded-api-v-2025-11-15" . --exclude-dir=node_modules --exclude=package-lock.json --exclude=CHANGELOG.md→ empty.PartnerManagedCompanyMigrateRequestcollapses to{}(signer resolved from authed admin)grep partnerManagedCompanies|MigrateRequest src/ sdk-app/empty)MigrationStatusrenamed →PartnerManagedCompanyMigrateResponseErrorsCategory; newErrors/Warningson migrate responseErrors/Warningsnamespaced onmigration_readinessresponseCompany.fundingType:Brexremoved;PartnerDisbursement,Rtp,LineOfCreditadded'brex'narrowing insrc/EmployeeBenefit.deductionReducesTaxableIncome: required → optional (widening)PayrollCreditBlockerUnblockOptionWaitForReverseWireMetadatacollapses to{}reverseWireDetailIdconsumerContractorPayment*adds optionalinvoiceNumber,memoGetV1CompanyFormsQueryParamSortByremoved;SortByremoved fromgetv1...payrollid(collapse tostring)payrolls.tsmock importsRequest/Responsetypes, notSortBy)PostV1CompaniesCompanyIdReportsEmployeesAnnualFicaWageResponseBodyremoved (uses sharedEmployeesAnnualFicaWageReportAcceptancecomponent now)peoplebatch.PartialSuccessenum value removed'partial_success'consumerpartnerManagedCompanies*TermsOfService,payrollDigests*+PayrollDigestConflictErrorpayroll.autoPilotdoc rename → "automatic payroll enabled" (field name unchanged)getinformationrequestsadds optionalsortByquery paramNotFoundErrorObject/UnprocessableEntityErroradded to many ops)VersionHeadercomponent removed; per-opHeaderXGustoAPIVersionenum constants addedVersionHeaderWhat's in this PR
package.json+package-lock.json:@gusto/embedded-api-v-2025-11-15@^0.0.2→@gusto/embedded-api-v-2026-02-01@^0.0.1.src/contexts/ApiProvider/apiVersionHook.ts:3+ 3 test files: bare-date'2025-11-15'→'2026-02-01'. Separate explicit sed; the package-name sweep does not catch this.AGENTS.md,CLAUDE.md,src/CLAUDE.md,docs/hooks/,docs/api/,docs/reference/,build/deriveEndpointInventory.ts,e2e/utils/validationErrorCollector.test.ts.src/components/Payroll/usePreparedPayrollData.ts: removedQueryParamSortByimport;sortBy?: string.AGENTS.md,src/CLAUDE.md).Bare-date sweep — verification
These are payroll period-end calendar dates in a Storybook story — unrelated to the API version header.
Deviations from PR #2233 (for reviewers)
This PR is intentionally narrower than PR #2233. Differences a reviewer should know about:
e2e/tests/employee/04-self-onboarding-email-required.spec.tsande2e/tests/company/03-migration-status-boolean.spec.ts). The first guards a server-side change (email-required on the self-onboarding endpoint at create time) that does not appear in the package's type diff — the SDK's existing Zod schema already requiresemailwhen the self-onboarding switch is on, so the type contract is unchanged. The skill's analysis is driven by the type diff, so it did not surface this row. If this server-side behavior change is real, that spec should be ported here too — call this out in review. The migration-status spec is an exploratory anchor for a partner-managed company flow that the SDK has no current consumer for (see PR feat!: bump @gusto/embedded-api to v2026-02-01 #2233's own description acknowledging the misscope); it is verify-only and the skill correctly omits it.docs/upgrade-notes/file or migration guide. Same as PR feat!: bump @gusto/embedded-api to v2026-02-01 #2233.Test plan
X-Gusto-API-Version: 2026-02-01header on a real requestgrep -rln "@gusto/embedded-api-v-2025-11-15" .returns no hits outsideCHANGELOG.md/.reports//node_modules/🤖 Generated with Claude Code via the
api-version-upgradeskill