Skip to content

update extensibility SDK name in comments#2633

Closed
xavdid-stripe wants to merge 2 commits intomasterfrom
RUN_DEVSDK-2299
Closed

update extensibility SDK name in comments#2633
xavdid-stripe wants to merge 2 commits intomasterfrom
RUN_DEVSDK-2299

Conversation

@xavdid-stripe
Copy link
Copy Markdown
Member

Why?

The Stripe Apps team asked that we update the name of their SDK in our comments

What?

  • update comments

See Also

RUN_DEVSDK-2299

@xavdid-stripe xavdid-stripe requested a review from a team as a code owner March 26, 2026 22:14
@xavdid-stripe xavdid-stripe requested review from jar-stripe and removed request for a team March 26, 2026 22:14
@xavdid-stripe xavdid-stripe enabled auto-merge (squash) March 26, 2026 22:14
Copy link
Copy Markdown
Contributor

@jar-stripe jar-stripe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should change this entirely. Since we're vendoring the code copied from that SDK, examples should be written to be relative to this SDK and not the other one.
E,.g

 * ```ts
 * declare module '@stripe/apps-extensibility-sdk/stdlib' {
 *   interface DecimalRoundingPresets {
 *     'my-custom-preset': DecimalRoundingOptions;
 *   }
 * }
 *

should actually be something like

 * ```ts
 * declare module 'stripe' {
 *   interface DecimalRoundingPresets {
 *     'my-custom-preset': DecimalRoundingOptions;
 *   }
 * }
 *

@xavdid-stripe xavdid-stripe disabled auto-merge March 26, 2026 22:49
@xavdid-stripe
Copy link
Copy Markdown
Member Author

Fair, i've updated!

I've updated the docs so that they work, but i'm a little concerned that we're not exporting the things the doc expects. For instance, you can't type something as a Stripe.Decimal, since it's only exported as a class, not a type. So a user couldn't write a function that accepted a stripe decimal type, for instance.

Do we need to update our exports?

*
* @example
* ```ts
* import { Decimal, RoundDirection } from '@stripe/apps-extensibility-sdk/stdlib';
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This wouldn't have worked - everything is imported under the root Stripe namespace

@jar-stripe
Copy link
Copy Markdown
Contributor

For instance, you can't type something as a Stripe.Decimal, since it's only exported as a class, not a type. So a user couldn't write a function that accepted a stripe decimal type, for instance.

My understanding was that if exported but not as a type, you can do anything with it (i.e. its only restricted if its a type export). I'll confirm.

@jar-stripe
Copy link
Copy Markdown
Contributor

For instance, you can't type something as a Stripe.Decimal, since it's only exported as a class, not a type. So a user couldn't write a function that accepted a stripe decimal type, for instance.

My understanding was that if exported but not as a type, you can do anything with it (i.e. its only restricted if its a type export). I'll confirm.

You are in fact correct. I'll put up a PR.

@xavdid-stripe
Copy link
Copy Markdown
Member Author

You're welcome to take this one over! It came in as a run ticket so I was grabbing, but you seem to have a lot more context

jar-stripe added a commit that referenced this pull request Mar 27, 2026
…omments

Delete the declaration-merging example and import example that referenced
the old `@stripe/apps-extensibility-sdk/stdlib` module name. These
comments are no longer accurate now that Decimal lives in `stripe`.

Folds in the intent of #2633 (which renamed the references); the
resolution is to remove the comments entirely.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Committed-By-Agent: claude
@jar-stripe
Copy link
Copy Markdown
Contributor

Folded into #2634 — the stale @stripe/apps-extensibility-sdk/stdlib comments were deleted entirely rather than renamed.

@jar-stripe jar-stripe closed this Mar 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants