Repository navigation
Generated types, pagination and new endpoints - #10
Merged
Merged
Conversation
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.
What
openapi.json->src/generated), and the public types are derived from them.passes.createDownloadLink,passes.redemptions.startingAfteron list methods, andlistAllhelpers for passes, templates, webhooks, events, pass events and webhook deliveries.templates.listtakesincludeArchived,limit,startingAfter.issuerName/locations/relevantDate,redemption_policy,require_download_link, PATCHdelivery+warnings, DELETEwarnings, templatewarnings, and thepass.update_failed/pass.redeemedwebhook events.@passmint/node; README updated.Why
Types are now derived from the API's spec, and lin.ky needs pagination and the new endpoints.
Compatibility
Minor release. Every 0.4.0 type name is still exported.
PASSMINT_EVENT_TYPESnow has 9 entries (addspass.update_failed,pass.redeemed). Code that subscribes webhooks withevents: [...PASSMINT_EVENT_TYPES]will start receiving those events.Pass.redeemed_count,Account.plan). Hand-built typed object literals ofPass/Template/Accountneed them; reads and casts are unaffected.pass.update_failed/pass.redeemed, andPassEvent['type']gainedupdate_failed,redeemed,download_link_created,update_not_delivered. Exhaustive switches andRecord<PassmintEventType, ...>maps will flag the new members.PassEventTypeis a new export.Pass.field_valuesandAccount.organization_slugkeep their 0.4.0 types for compatibility (see their docs).extends/implementsstill work, declaration merging into them no longer does.Testing
pnpm lint,pnpm test(172 unit + type tests, including the 0.4.0 compatibility suite),pnpm build,pnpm attw,pnpm publint,pnpm generate:checkall green.Release
Draft until the platform release with the matching API changes is deployed. Then re-sync the spec from platform main with
pnpm sync-specand confirm no diff. Merge and publish only with Alex's go-ahead.