chore(clerk-js): Remove Clerk.commerce#5846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brkalow merged 6 commits into from
May 6, 2025
Merged

chore(clerk-js): Remove Clerk.commerce #5846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8af6f99
remove Clerk.commerce
brkalow May 5, 2025
f11e41c
snapdates
brkalow May 6, 2025
ee0e4c3
fix lint error
brkalow May 6, 2025
76c7443
fix type
brkalow May 6, 2025
c1b81a8
adjust changesets
brkalow May 6, 2025
05afd9c
sort imports
brkalow May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/proud-donuts-shop.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
22 changes: 12 additions & 10 deletions .changeset/witty-doors-hear.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,20 @@
'@clerk/types': minor
---

Expose stable commerce stable apis under `Clerk.commerce`
Expose Clerk Billing APIs.

## Render the pricing table component
- `Clerk.mountPricingTable`
- `Clerk.unmountPricingTable`

## Commerce namespace
- `Clerk.commerce.initializePaymentSource()`
- `Clerk.commerce.addPaymentSource()`
- `Clerk.commerce.getPaymentSources()`
- `Clerk.commerce.billing`
- `Clerk.commerce.billing.getPlans()`
- `Clerk.commerce.billing.getSubscriptions()`
- `Clerk.commerce.billing.getInvoices()`
- `Clerk.commerce.billing.startCheckout()`
## Manage payment methods
- `Clerk.[user|organization].initializePaymentSource()`
- `Clerk.[user|organization].addPaymentSource()`
- `Clerk.[user|organization].getPaymentSources()`

## Billing namespace
- `Clerk.billing`
- `Clerk.billing.getPlans()`
- `Clerk.billing.getSubscriptions()`
- `Clerk.billing.getInvoices()`
- `Clerk.billing.startCheckout()`
14 changes: 7 additions & 7 deletions packages/clerk-js/src/core/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ import type {
ClerkOptions,
ClientJSONSnapshot,
ClientResource,
CommerceNamespace,
CommerceBillingNamespace,
CreateOrganizationParams,
CreateOrganizationProps,
CredentialReturn,
Expand DownExpand Up@@ -131,7 +131,7 @@ import { eventBus, events } from './events';
import type { FapiClient, FapiRequestCallback } from './fapiClient';
import { createFapiClient } from './fapiClient';
import { createClientFromJwt } from './jwt-client';
import { Commerce } from './modules/commerce';
import { CommerceBilling } from './modules/commerce';
import {
BaseResource,
Client,
Expand DownExpand Up@@ -187,7 +187,7 @@ export class Clerk implements ClerkInterface {
version: __PKG_VERSION__,
environment: process.env.NODE_ENV || 'production',
};
private static _commerce: CommerceNamespace;
private static _billing: CommerceBillingNamespace;

public client: ClientResource | undefined;
public session: SignedInSessionResource | null | undefined;
Expand DownExpand Up@@ -316,11 +316,11 @@ export class Clerk implements ClerkInterface {
return this.#options.standardBrowser || false;
}

get commerce(): CommerceNamespace {
if (!Clerk._commerce) {
Clerk._commerce = new Commerce();
get billing(): CommerceBillingNamespace {
if (!Clerk._billing) {
Clerk._billing = new CommerceBilling();
}
return Clerk._commerce;
return Clerk._billing;
}

public __internal_getOption<K extends keyof ClerkOptions>(key: K): ClerkOptions[K] {
Expand Down
69 changes: 0 additions & 69 deletions packages/clerk-js/src/core/modules/commerce/Commerce.ts
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/modules/commerce/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
export * from './Commerce';
export * from './CommerceBilling';
export * from './payment-source-methods';
55 changes: 55 additions & 0 deletions packages/clerk-js/src/core/modules/commerce/payment-source-methods.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
import type {
AddPaymentSourceParams,
ClerkPaginatedResponse,
CommerceInitializedPaymentSourceJSON,
CommercePaymentSourceJSON,
GetPaymentSourcesParams,
InitializePaymentSourceParams,
} from '@clerk/types';

import { convertPageToOffsetSearchParams } from '../../../utils/convertPageToOffsetSearchParams';
import { BaseResource, CommerceInitializedPaymentSource, CommercePaymentSource } from '../../resources/internal';

export const initializePaymentSource = async (params: InitializePaymentSourceParams) => {
const { orgId, ...rest } = params;
const json = (
await BaseResource._fetch({
path: orgId
? `/organizations/${orgId}/commerce/payment_sources/initialize`
: `/me/commerce/payment_sources/initialize`,
method: 'POST',
body: rest as any,
})
)?.response as unknown as CommerceInitializedPaymentSourceJSON;
return new CommerceInitializedPaymentSource(json);
};

export const addPaymentSource = async (params: AddPaymentSourceParams) => {
const { orgId, ...rest } = params;

const json = (
await BaseResource._fetch({
path: orgId ? `/organizations/${orgId}/commerce/payment_sources` : `/me/commerce/payment_sources`,
method: 'POST',
body: rest as any,
})
)?.response as unknown as CommercePaymentSourceJSON;
return new CommercePaymentSource(json);
};

export const getPaymentSources = async (params: GetPaymentSourcesParams) => {
const { orgId, ...rest } = params;

return await BaseResource._fetch({
path: orgId ? `/organizations/${orgId}/commerce/payment_sources` : `/me/commerce/payment_sources`,
method: 'GET',
search: convertPageToOffsetSearchParams(rest),
}).then(res => {
const { data: paymentSources, total_count } =
res?.response as unknown as ClerkPaginatedResponse<CommercePaymentSourceJSON>;
return {
total_count,
data: paymentSources.map(paymentSource => new CommercePaymentSource(paymentSource)),
};
});
};
22 changes: 22 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ import type {

import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
import { unixEpochToDate } from '../../utils/date';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BaseResource, CommerceSubscription, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
Expand DownExpand Up@@ -282,6 +283,27 @@ export class Organization extends BaseResource implements OrganizationResource {
}).then(res => new Organization(res?.response as OrganizationJSON));
};

initializePaymentSource: typeof initializePaymentSource = params => {
return initializePaymentSource({
...params,
orgId: this.id,
});
};

addPaymentSource: typeof addPaymentSource = params => {
return addPaymentSource({
...params,
orgId: this.id,
});
};

getPaymentSources: typeof getPaymentSources = params => {
return getPaymentSources({
...params,
orgId: this.id,
});
};

protected fromJSON(data: OrganizationJSON | OrganizationJSONSnapshot | null): this {
if (!data) {
return this;
Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/User.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,7 @@ import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { eventBus, events } from '../events';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BackupCode } from './BackupCode';
import {
BaseResource,
Expand DownExpand Up@@ -290,6 +291,18 @@ export class User extends BaseResource implements UserResource {
return new DeletedObject(json);
};

initializePaymentSource: typeof initializePaymentSource = params => {
return initializePaymentSource(params);
};

addPaymentSource: typeof addPaymentSource = params => {
return addPaymentSource(params);
};

getPaymentSources: typeof getPaymentSources = params => {
return getPaymentSources(params);
};

get verifiedExternalAccounts() {
return this.externalAccounts.filter(externalAccount => externalAccount.verification?.status == 'verified');
}
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/core/resources/__tests__/__snapshots__/Organization.test.ts.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
exports[`Organization has the same initial properties 1`] = `
Organization {
"addMember": [Function],
"addPaymentSource": [Function],
"adminDeleteEnabled": true,
"createDomain": [Function],
"createdAt": 1970-01-01T00:00:12.345Z,
Expand All@@ -12,11 +13,13 @@ Organization {
"getInvitations": [Function],
"getMembershipRequests": [Function],
"getMemberships": [Function],
"getPaymentSources": [Function],
"getRoles": [Function],
"getSubscriptions": [Function],
"hasImage": true,
"id": "test_id",
"imageUrl": "https://img.clerk.com/eyJ0eXBlIjoiZGVmYXVsdCIsImlpZCI6Imluc18xbHlXRFppb2JyNjAwQUtVZVFEb1NsckVtb00iLCJyaWQiOiJ1c2VyXzJKbElJQTN2VXNjWXh1N2VUMnhINmFrTGgxOCIsImluaXRpYWxzIjoiREsifQ?width=160",
"initializePaymentSource": [Function],
"inviteMember": [Function],
"inviteMembers": [Function],
"maxAllowedMemberships": 3,
Expand Down
3 changes: 3 additions & 0 deletions ...s/clerk-js/src/core/resources/__tests__/__snapshots__/OrganizationMembership.test.ts.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ OrganizationMembership {
"id": "test_id",
"organization": Organization {
"addMember": [Function],
"addPaymentSource": [Function],
"adminDeleteEnabled": true,
"createDomain": [Function],
"createdAt": 1970-01-01T00:00:12.345Z,
Expand All@@ -16,11 +17,13 @@ OrganizationMembership {
"getInvitations": [Function],
"getMembershipRequests": [Function],
"getMemberships": [Function],
"getPaymentSources": [Function],
"getRoles": [Function],
"getSubscriptions": [Function],
"hasImage": true,
"id": "test_org_id",
"imageUrl": "https://img.clerk.com/eyJ0eXBlIjoiZGVmYXVsdCIsImlpZCI6Imluc18xbHlXRFppb2JyNjAwQUtVZVFEb1NsckVtb00iLCJyaWQiOiJ1c2VyXzJKbElJQTN2VXNjWXh1N2VUMnhINmFrTGgxOCIsImluaXRpYWxzIjoiREsifQ?width=160",
"initializePaymentSource": [Function],
"inviteMember": [Function],
"inviteMembers": [Function],
"maxAllowedMemberships": 3,
Expand Down
14 changes: 5 additions & 9 deletions packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk, useOrganization, useUser } from '@clerk/shared/react';
import { useOrganization } from '@clerk/shared/react';
import type {
ClerkAPIError,
ClerkRuntimeError,
Expand DownExpand Up@@ -114,22 +114,18 @@ const CheckoutFormElements = ({
checkout: CommerceCheckoutResource;
onCheckoutComplete: (checkout: CommerceCheckoutResource) => void;
}) => {
const { commerce } = useClerk();
const { user } = useUser();
const { organization } = useOrganization();
const { subscriberType } = useCheckoutContext();
const { subscriber, subscriberType } = useCheckoutContext();

const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>('existing');
const [isSubmitting, setIsSubmitting] = useState(false);
const [submitError, setSubmitError] = useState<ClerkRuntimeError | ClerkAPIError | string | undefined>();

const { data, revalidate: revalidatePaymentSources } = useFetch(
commerce?.getPaymentSources,
{
...(subscriberType === 'org' ? { orgId: organization?.id } : {}),
},
subscriber().getPaymentSources,
{},
undefined,
`commerce-payment-sources-${user?.id}`,
`commerce-payment-sources-${subscriber().id}`,
);
const { data: paymentSources } = data || { data: [] };

Expand Down
8 changes: 4 additions & 4 deletions packages/clerk-js/src/ui/components/PaymentSources/AddPaymentSource.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,12 +37,13 @@ export const AddPaymentSource = (props: AddPaymentSourceProps) => {
onPayWithTestPaymentSourceSuccess,
showPayWithTestCardSection,
} = props;
const { commerce } = useClerk();
const { commerceSettings } = useEnvironment();
const { organization } = useOrganization();
const { user } = useUser();
const subscriberType = useSubscriberTypeContext();

const resource = subscriberType === 'org' ? organization : user;

const stripePromiseRef = useRef<Promise<Stripe | null> | null>(null);
const [stripe, setStripe] = useState<Stripe | null>(null);

Expand DownExpand Up@@ -73,13 +74,12 @@ export const AddPaymentSource = (props: AddPaymentSourceProps) => {
invalidate,
revalidate: revalidateInitializedPaymentSource,
} = useFetch(
commerce.initializePaymentSource,
resource?.initializePaymentSource,
{
gateway: 'stripe',
...(subscriberType === 'org' ? { orgId: organization?.id } : {}),
},
undefined,
`commerce-payment-source-initialize-${user?.id}`,
`commerce-payment-source-initialize-${resource?.id}`,
);

const externalGatewayId = initializedPaymentSource?.externalGatewayId;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
chore(clerk-js): Remove Clerk.commerce#5846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 6 commits into

from

May 6, 2025
 Merged


chore(clerk-js): Remove Clerk.commerce
#5846
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
8af6f99

remove Clerk.commerce


brkalow May 5, 2025
f11e41c

snapdates


brkalow May 6, 2025
ee0e4c3

fix lint error


brkalow May 6, 2025
76c7443

fix type


brkalow May 6, 2025
c1b81a8

adjust changesets


brkalow May 6, 2025
05afd9c

sort imports


brkalow May 6, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/proud-donuts-shop.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

22 changes: 12 additions & 10 deletions
.changeset/witty-doors-hear.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,20 @@
'@clerk/types': minor
---

Expose stable commerce stable apis under `Clerk.commerce`
Expose Clerk Billing APIs.

## Render the pricing table component
- `Clerk.mountPricingTable`
- `Clerk.unmountPricingTable`

## Commerce namespace
- `Clerk.commerce.initializePaymentSource()`
- `Clerk.commerce.addPaymentSource()`
- `Clerk.commerce.getPaymentSources()`
- `Clerk.commerce.billing`
 - `Clerk.commerce.billing.getPlans()`
 - `Clerk.commerce.billing.getSubscriptions()`
 - `Clerk.commerce.billing.getInvoices()`
 - `Clerk.commerce.billing.startCheckout()`
## Manage payment methods
- `Clerk.[user|organization].initializePaymentSource()`
- `Clerk.[user|organization].addPaymentSource()`
- `Clerk.[user|organization].getPaymentSources()`

## Billing namespace
- `Clerk.billing`
 - `Clerk.billing.getPlans()`
 - `Clerk.billing.getSubscriptions()`
 - `Clerk.billing.getInvoices()`
 - `Clerk.billing.startCheckout()`

14 changes: 7 additions & 7 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ import type {
 ClerkOptions,
 ClientJSONSnapshot,
 ClientResource,
CommerceNamespace,
CommerceBillingNamespace,
 CreateOrganizationParams,
 CreateOrganizationProps,
 CredentialReturn,
Expand DownExpand Up@@ -131,7 +131,7 @@ import { eventBus, events } from './events';
import type { FapiClient, FapiRequestCallback } from './fapiClient';
import { createFapiClient } from './fapiClient';
import { createClientFromJwt } from './jwt-client';
import { Commerce } from './modules/commerce';
import { CommerceBilling } from './modules/commerce';
import {
 BaseResource,
 Client,
Expand DownExpand Up@@ -187,7 +187,7 @@ export class Clerk implements ClerkInterface {
 version: __PKG_VERSION__,
 environment: process.env.NODE_ENV || 'production',
 };
 private static _commerce: CommerceNamespace;
 private static _billing: CommerceBillingNamespace;

 public client: ClientResource | undefined;
 public session: SignedInSessionResource | null | undefined;
Expand DownExpand Up@@ -316,11 +316,11 @@ export class Clerk implements ClerkInterface {
 return this.#options.standardBrowser || false;
 }

 get commerce(): CommerceNamespace {
 if (!Clerk._commerce) {
 Clerk._commerce = new Commerce();
 get billing(): CommerceBillingNamespace {
 if (!Clerk._billing) {
 Clerk._billing = new CommerceBilling();
 }
 return Clerk._commerce;
 return Clerk._billing;
 }

 public __internal_getOption<K extends keyof ClerkOptions>(key: K): ClerkOptions[K] {
Expand Down

69 changes: 0 additions & 69 deletions
packages/clerk-js/src/core/modules/commerce/Commerce.ts

View file


Open in desktop


This file was deleted.


2 changes: 1 addition & 1 deletion
packages/clerk-js/src/core/modules/commerce/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
export * from './Commerce';
export * from './CommerceBilling';
export * from './payment-source-methods';

55 changes: 55 additions & 0 deletions
packages/clerk-js/src/core/modules/commerce/payment-source-methods.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
import type {
 AddPaymentSourceParams,
 ClerkPaginatedResponse,
 CommerceInitializedPaymentSourceJSON,
 CommercePaymentSourceJSON,
 GetPaymentSourcesParams,
 InitializePaymentSourceParams,
} from '@clerk/types';

import { convertPageToOffsetSearchParams } from '../../../utils/convertPageToOffsetSearchParams';
import { BaseResource, CommerceInitializedPaymentSource, CommercePaymentSource } from '../../resources/internal';

export const initializePaymentSource = async (params: InitializePaymentSourceParams) => {
 const { orgId, ...rest } = params;
 const json = (
 await BaseResource._fetch({
 path: orgId
 ? `/organizations/${orgId}/commerce/payment_sources/initialize`
 : `/me/commerce/payment_sources/initialize`,
 method: 'POST',
 body: rest as any,
 })
 )?.response as unknown as CommerceInitializedPaymentSourceJSON;
 return new CommerceInitializedPaymentSource(json);
};

export const addPaymentSource = async (params: AddPaymentSourceParams) => {
 const { orgId, ...rest } = params;

 const json = (
 await BaseResource._fetch({
 path: orgId ? `/organizations/${orgId}/commerce/payment_sources` : `/me/commerce/payment_sources`,
 method: 'POST',
 body: rest as any,
 })
 )?.response as unknown as CommercePaymentSourceJSON;
 return new CommercePaymentSource(json);
};

export const getPaymentSources = async (params: GetPaymentSourcesParams) => {
 const { orgId, ...rest } = params;

 return await BaseResource._fetch({
 path: orgId ? `/organizations/${orgId}/commerce/payment_sources` : `/me/commerce/payment_sources`,
 method: 'GET',
 search: convertPageToOffsetSearchParams(rest),
 }).then(res => {
 const { data: paymentSources, total_count } =
 res?.response as unknown as ClerkPaginatedResponse<CommercePaymentSourceJSON>;
 return {
 total_count,
 data: paymentSources.map(paymentSource => new CommercePaymentSource(paymentSource)),
 };
 });
};

22 changes: 22 additions & 0 deletions
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ import type {

import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
import { unixEpochToDate } from '../../utils/date';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BaseResource, CommerceSubscription, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
Expand DownExpand Up@@ -282,6 +283,27 @@ export class Organization extends BaseResource implements OrganizationResource {
 }).then(res => new Organization(res?.response as OrganizationJSON));
 };

 initializePaymentSource: typeof initializePaymentSource = params => {
 return initializePaymentSource({
 ...params,
 orgId: this.id,
 });
 };

 addPaymentSource: typeof addPaymentSource = params => {
 return addPaymentSource({
 ...params,
 orgId: this.id,
 });
 };

 getPaymentSources: typeof getPaymentSources = params => {
 return getPaymentSources({
 ...params,
 orgId: this.id,
 });
 };

 protected fromJSON(data: OrganizationJSON | OrganizationJSONSnapshot | null): this {
 if (!data) {
 return this;
Expand Down

13 changes: 13 additions & 0 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,7 @@ import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { eventBus, events } from '../events';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BackupCode } from './BackupCode';
import {
 BaseResource,
Expand DownExpand Up@@ -290,6 +291,18 @@ export class User extends BaseResource implements UserResource {
 return new DeletedObject(json);
 };

 initializePaymentSource: typeof initializePaymentSource = params => {
 return initializePaymentSource(params);
 };

 addPaymentSource: typeof addPaymentSource = params => {
 return addPaymentSource(params);
 };

 getPaymentSources: typeof getPaymentSources = params => {
 return getPaymentSources(params);
 };

 get verifiedExternalAccounts() {
 return this.externalAccounts.filter(externalAccount => externalAccount.verification?.status == 'verified');
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/resources/__tests__/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
exports[`Organization has the same initial properties 1`] = `
Organization {
 "addMember": [Function],
 "addPaymentSource": [Function],
 "adminDeleteEnabled": true,
 "createDomain": [Function],
 "createdAt": 1970-01-01T00:00:12.345Z,
Expand All@@ -12,11 +13,13 @@ Organization {
 "getInvitations": [Function],
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPaymentSources": [Function],
 "getRoles": [Function],
 "getSubscriptions": [Function],
 "hasImage": true,
 "id": "test_id",
 "imageUrl": "https://img.clerk.com/eyJ0eXBlIjoiZGVmYXVsdCIsImlpZCI6Imluc18xbHlXRFppb2JyNjAwQUtVZVFEb1NsckVtb00iLCJyaWQiOiJ1c2VyXzJKbElJQTN2VXNjWXh1N2VUMnhINmFrTGgxOCIsImluaXRpYWxzIjoiREsifQ?width=160",
 "initializePaymentSource": [Function],
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "maxAllowedMemberships": 3,
Expand Down

3 changes: 3 additions & 0 deletions
...s/clerk-js/src/core/resources/__tests__/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ OrganizationMembership {
 "id": "test_id",
 "organization": Organization {
 "addMember": [Function],
 "addPaymentSource": [Function],
 "adminDeleteEnabled": true,
 "createDomain": [Function],
 "createdAt": 1970-01-01T00:00:12.345Z,
Expand All@@ -16,11 +17,13 @@ OrganizationMembership {
 "getInvitations": [Function],
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPaymentSources": [Function],
 "getRoles": [Function],
 "getSubscriptions": [Function],
 "hasImage": true,
 "id": "test_org_id",
 "imageUrl": "https://img.clerk.com/eyJ0eXBlIjoiZGVmYXVsdCIsImlpZCI6Imluc18xbHlXRFppb2JyNjAwQUtVZVFEb1NsckVtb00iLCJyaWQiOiJ1c2VyXzJKbElJQTN2VXNjWXh1N2VUMnhINmFrTGgxOCIsImluaXRpYWxzIjoiREsifQ?width=160",
 "initializePaymentSource": [Function],
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "maxAllowedMemberships": 3,
Expand Down

14 changes: 5 additions & 9 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk, useOrganization, useUser } from '@clerk/shared/react';
import { useOrganization } from '@clerk/shared/react';
import type {
 ClerkAPIError,
 ClerkRuntimeError,
Expand DownExpand Up@@ -114,22 +114,18 @@ const CheckoutFormElements = ({
 checkout: CommerceCheckoutResource;
 onCheckoutComplete: (checkout: CommerceCheckoutResource) => void;
}) => {
 const { commerce } = useClerk();
 const { user } = useUser();
 const { organization } = useOrganization();
 const { subscriberType } = useCheckoutContext();
 const { subscriber, subscriberType } = useCheckoutContext();

 const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>('existing');
 const [isSubmitting, setIsSubmitting] = useState(false);
 const [submitError, setSubmitError] = useState<ClerkRuntimeError | ClerkAPIError | string | undefined>();

 const { data, revalidate: revalidatePaymentSources } = useFetch(
 commerce?.getPaymentSources,
 {
 ...(subscriberType === 'org' ? { orgId: organization?.id } : {}),
 },
 subscriber().getPaymentSources,
 {},
 undefined,
 `commerce-payment-sources-${user?.id}`,
 `commerce-payment-sources-${subscriber().id}`,
 );
 const { data: paymentSources } = data || { data: [] };

Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/components/PaymentSources/AddPaymentSource.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,12 +37,13 @@ export const AddPaymentSource = (props: AddPaymentSourceProps) => {
 onPayWithTestPaymentSourceSuccess,
 showPayWithTestCardSection,
 } = props;
 const { commerce } = useClerk();
 const { commerceSettings } = useEnvironment();
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();

 const resource = subscriberType === 'org' ? organization : user;

 const stripePromiseRef = useRef<Promise<Stripe | null> | null>(null);
 const [stripe, setStripe] = useState<Stripe | null>(null);

Expand DownExpand Up@@ -73,13 +74,12 @@ export const AddPaymentSource = (props: AddPaymentSourceProps) => {
 invalidate,
 revalidate: revalidateInitializedPaymentSource,
 } = useFetch(
commerce.initializePaymentSource,
resource?.initializePaymentSource,
 {
 gateway: 'stripe',
 ...(subscriberType === 'org' ? { orgId: organization?.id } : {}),
 },
 undefined,
 `commerce-payment-source-initialize-${user?.id}`,
 `commerce-payment-source-initialize-${resource?.id}`,
 );

 const externalGatewayId = initializedPaymentSource?.externalGatewayId;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(clerk-js): Remove Clerk.commerce#5846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 6 commits into

from

May 6, 2025
 Merged


chore(clerk-js): Remove Clerk.commerce
#5846
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
8af6f99

remove Clerk.commerce


brkalow May 5, 2025
f11e41c

snapdates


brkalow May 6, 2025
ee0e4c3

fix lint error


brkalow May 6, 2025
76c7443

fix type


brkalow May 6, 2025
c1b81a8

adjust changesets


brkalow May 6, 2025
05afd9c

sort imports


brkalow May 6, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/proud-donuts-shop.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

22 changes: 12 additions & 10 deletions
.changeset/witty-doors-hear.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,20 @@
'@clerk/types': minor
---

Expose stable commerce stable apis under `Clerk.commerce`
Expose Clerk Billing APIs.

## Render the pricing table component
- `Clerk.mountPricingTable`
- `Clerk.unmountPricingTable`

## Commerce namespace
- `Clerk.commerce.initializePaymentSource()`
- `Clerk.commerce.addPaymentSource()`
- `Clerk.commerce.getPaymentSources()`
- `Clerk.commerce.billing`
 - `Clerk.commerce.billing.getPlans()`
 - `Clerk.commerce.billing.getSubscriptions()`
 - `Clerk.commerce.billing.getInvoices()`
 - `Clerk.commerce.billing.startCheckout()`
## Manage payment methods
- `Clerk.[user|organization].initializePaymentSource()`
- `Clerk.[user|organization].addPaymentSource()`
- `Clerk.[user|organization].getPaymentSources()`

## Billing namespace
- `Clerk.billing`
 - `Clerk.billing.getPlans()`
 - `Clerk.billing.getSubscriptions()`
 - `Clerk.billing.getInvoices()`
 - `Clerk.billing.startCheckout()`

14 changes: 7 additions & 7 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ import type {
 ClerkOptions,
 ClientJSONSnapshot,
 ClientResource,
CommerceNamespace,
CommerceBillingNamespace,
 CreateOrganizationParams,
 CreateOrganizationProps,
 CredentialReturn,
Expand DownExpand Up@@ -131,7 +131,7 @@ import { eventBus, events } from './events';
import type { FapiClient, FapiRequestCallback } from './fapiClient';
import { createFapiClient } from './fapiClient';
import { createClientFromJwt } from './jwt-client';
import { Commerce } from './modules/commerce';
import { CommerceBilling } from './modules/commerce';
import {
 BaseResource,
 Client,
Expand DownExpand Up@@ -187,7 +187,7 @@ export class Clerk implements ClerkInterface {
 version: __PKG_VERSION__,
 environment: process.env.NODE_ENV || 'production',
 };
 private static _commerce: CommerceNamespace;
 private static _billing: CommerceBillingNamespace;

 public client: ClientResource | undefined;
 public session: SignedInSessionResource | null | undefined;
Expand DownExpand Up@@ -316,11 +316,11 @@ export class Clerk implements ClerkInterface {
 return this.#options.standardBrowser || false;
 }

 get commerce(): CommerceNamespace {
 if (!Clerk._commerce) {
 Clerk._commerce = new Commerce();
 get billing(): CommerceBillingNamespace {
 if (!Clerk._billing) {
 Clerk._billing = new CommerceBilling();
 }
 return Clerk._commerce;
 return Clerk._billing;
 }

 public __internal_getOption<K extends keyof ClerkOptions>(key: K): ClerkOptions[K] {
Expand Down

69 changes: 0 additions & 69 deletions
packages/clerk-js/src/core/modules/commerce/Commerce.ts

View file


Open in desktop


This file was deleted.


2 changes: 1 addition & 1 deletion
packages/clerk-js/src/core/modules/commerce/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
export * from './Commerce';
export * from './CommerceBilling';
export * from './payment-source-methods';

55 changes: 55 additions & 0 deletions
packages/clerk-js/src/core/modules/commerce/payment-source-methods.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
import type {
 AddPaymentSourceParams,
 ClerkPaginatedResponse,
 CommerceInitializedPaymentSourceJSON,
 CommercePaymentSourceJSON,
 GetPaymentSourcesParams,
 InitializePaymentSourceParams,
} from '@clerk/types';

import { convertPageToOffsetSearchParams } from '../../../utils/convertPageToOffsetSearchParams';
import { BaseResource, CommerceInitializedPaymentSource, CommercePaymentSource } from '../../resources/internal';

export const initializePaymentSource = async (params: InitializePaymentSourceParams) => {
 const { orgId, ...rest } = params;
 const json = (
 await BaseResource._fetch({
 path: orgId
 ? `/organizations/${orgId}/commerce/payment_sources/initialize`
 : `/me/commerce/payment_sources/initialize`,
 method: 'POST',
 body: rest as any,
 })
 )?.response as unknown as CommerceInitializedPaymentSourceJSON;
 return new CommerceInitializedPaymentSource(json);
};

export const addPaymentSource = async (params: AddPaymentSourceParams) => {
 const { orgId, ...rest } = params;

 const json = (
 await BaseResource._fetch({
 path: orgId ? `/organizations/${orgId}/commerce/payment_sources` : `/me/commerce/payment_sources`,
 method: 'POST',
 body: rest as any,
 })
 )?.response as unknown as CommercePaymentSourceJSON;
 return new CommercePaymentSource(json);
};

export const getPaymentSources = async (params: GetPaymentSourcesParams) => {
 const { orgId, ...rest } = params;

 return await BaseResource._fetch({
 path: orgId ? `/organizations/${orgId}/commerce/payment_sources` : `/me/commerce/payment_sources`,
 method: 'GET',
 search: convertPageToOffsetSearchParams(rest),
 }).then(res => {
 const { data: paymentSources, total_count } =
 res?.response as unknown as ClerkPaginatedResponse<CommercePaymentSourceJSON>;
 return {
 total_count,
 data: paymentSources.map(paymentSource => new CommercePaymentSource(paymentSource)),
 };
 });
};

22 changes: 22 additions & 0 deletions
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ import type {

import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
import { unixEpochToDate } from '../../utils/date';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BaseResource, CommerceSubscription, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
Expand DownExpand Up@@ -282,6 +283,27 @@ export class Organization extends BaseResource implements OrganizationResource {
 }).then(res => new Organization(res?.response as OrganizationJSON));
 };

 initializePaymentSource: typeof initializePaymentSource = params => {
 return initializePaymentSource({
 ...params,
 orgId: this.id,
 });
 };

 addPaymentSource: typeof addPaymentSource = params => {
 return addPaymentSource({
 ...params,
 orgId: this.id,
 });
 };

 getPaymentSources: typeof getPaymentSources = params => {
 return getPaymentSources({
 ...params,
 orgId: this.id,
 });
 };

 protected fromJSON(data: OrganizationJSON | OrganizationJSONSnapshot | null): this {
 if (!data) {
 return this;
Expand Down

13 changes: 13 additions & 0 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,7 @@ import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { eventBus, events } from '../events';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BackupCode } from './BackupCode';
import {
 BaseResource,
Expand DownExpand Up@@ -290,6 +291,18 @@ export class User extends BaseResource implements UserResource {
 return new DeletedObject(json);
 };

 initializePaymentSource: typeof initializePaymentSource = params => {
 return initializePaymentSource(params);
 };

 addPaymentSource: typeof addPaymentSource = params => {
 return addPaymentSource(params);
 };

 getPaymentSources: typeof getPaymentSources = params => {
 return getPaymentSources(params);
 };

 get verifiedExternalAccounts() {
 return this.externalAccounts.filter(externalAccount => externalAccount.verification?.status == 'verified');
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/resources/__tests__/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
exports[`Organization has the same initial properties 1`] = `
Organization {
 "addMember": [Function],
 "addPaymentSource": [Function],
 "adminDeleteEnabled": true,
 "createDomain": [Function],
 "createdAt": 1970-01-01T00:00:12.345Z,
Expand All@@ -12,11 +13,13 @@ Organization {
 "getInvitations": [Function],
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPaymentSources": [Function],
 "getRoles": [Function],
 "getSubscriptions": [Function],
 "hasImage": true,
 "id": "test_id",
 "imageUrl": "https://img.clerk.com/eyJ0eXBlIjoiZGVmYXVsdCIsImlpZCI6Imluc18xbHlXRFppb2JyNjAwQUtVZVFEb1NsckVtb00iLCJyaWQiOiJ1c2VyXzJKbElJQTN2VXNjWXh1N2VUMnhINmFrTGgxOCIsImluaXRpYWxzIjoiREsifQ?width=160",
 "initializePaymentSource": [Function],
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "maxAllowedMemberships": 3,
Expand Down

3 changes: 3 additions & 0 deletions
...s/clerk-js/src/core/resources/__tests__/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ OrganizationMembership {
 "id": "test_id",
 "organization": Organization {
 "addMember": [Function],
 "addPaymentSource": [Function],
 "adminDeleteEnabled": true,
 "createDomain": [Function],
 "createdAt": 1970-01-01T00:00:12.345Z,
Expand All@@ -16,11 +17,13 @@ OrganizationMembership {
 "getInvitations": [Function],
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPaymentSources": [Function],
 "getRoles": [Function],
 "getSubscriptions": [Function],
 "hasImage": true,
 "id": "test_org_id",
 "imageUrl": "https://img.clerk.com/eyJ0eXBlIjoiZGVmYXVsdCIsImlpZCI6Imluc18xbHlXRFppb2JyNjAwQUtVZVFEb1NsckVtb00iLCJyaWQiOiJ1c2VyXzJKbElJQTN2VXNjWXh1N2VUMnhINmFrTGgxOCIsImluaXRpYWxzIjoiREsifQ?width=160",
 "initializePaymentSource": [Function],
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "maxAllowedMemberships": 3,
Expand Down

14 changes: 5 additions & 9 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk, useOrganization, useUser } from '@clerk/shared/react';
import { useOrganization } from '@clerk/shared/react';
import type {
 ClerkAPIError,
 ClerkRuntimeError,
Expand DownExpand Up@@ -114,22 +114,18 @@ const CheckoutFormElements = ({
 checkout: CommerceCheckoutResource;
 onCheckoutComplete: (checkout: CommerceCheckoutResource) => void;
}) => {
 const { commerce } = useClerk();
 const { user } = useUser();
 const { organization } = useOrganization();
 const { subscriberType } = useCheckoutContext();
 const { subscriber, subscriberType } = useCheckoutContext();

 const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>('existing');
 const [isSubmitting, setIsSubmitting] = useState(false);
 const [submitError, setSubmitError] = useState<ClerkRuntimeError | ClerkAPIError | string | undefined>();

 const { data, revalidate: revalidatePaymentSources } = useFetch(
 commerce?.getPaymentSources,
 {
 ...(subscriberType === 'org' ? { orgId: organization?.id } : {}),
 },
 subscriber().getPaymentSources,
 {},
 undefined,
 `commerce-payment-sources-${user?.id}`,
 `commerce-payment-sources-${subscriber().id}`,
 );
 const { data: paymentSources } = data || { data: [] };

Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/components/PaymentSources/AddPaymentSource.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,12 +37,13 @@ export const AddPaymentSource = (props: AddPaymentSourceProps) => {
 onPayWithTestPaymentSourceSuccess,
 showPayWithTestCardSection,
 } = props;
 const { commerce } = useClerk();
 const { commerceSettings } = useEnvironment();
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();

 const resource = subscriberType === 'org' ? organization : user;

 const stripePromiseRef = useRef<Promise<Stripe | null> | null>(null);
 const [stripe, setStripe] = useState<Stripe | null>(null);

Expand DownExpand Up@@ -73,13 +74,12 @@ export const AddPaymentSource = (props: AddPaymentSourceProps) => {
 invalidate,
 revalidate: revalidateInitializedPaymentSource,
 } = useFetch(
commerce.initializePaymentSource,
resource?.initializePaymentSource,
 {
 gateway: 'stripe',
 ...(subscriberType === 'org' ? { orgId: organization?.id } : {}),
 },
 undefined,
 `commerce-payment-source-initialize-${user?.id}`,
 `commerce-payment-source-initialize-${resource?.id}`,
 );

 const externalGatewayId = initializedPaymentSource?.externalGatewayId;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(clerk-js): Remove Clerk.commerce#5846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 6 commits into

from

May 6, 2025
 Merged


chore(clerk-js): Remove Clerk.commerce
#5846
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
8af6f99

remove Clerk.commerce


brkalow May 5, 2025
f11e41c

snapdates


brkalow May 6, 2025
ee0e4c3

fix lint error


brkalow May 6, 2025
76c7443

fix type


brkalow May 6, 2025
c1b81a8

adjust changesets


brkalow May 6, 2025
05afd9c

sort imports


brkalow May 6, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/proud-donuts-shop.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

22 changes: 12 additions & 10 deletions
.changeset/witty-doors-hear.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,20 @@
'@clerk/types': minor
---

Expose stable commerce stable apis under `Clerk.commerce`
Expose Clerk Billing APIs.

## Render the pricing table component
- `Clerk.mountPricingTable`
- `Clerk.unmountPricingTable`

## Commerce namespace
- `Clerk.commerce.initializePaymentSource()`
- `Clerk.commerce.addPaymentSource()`
- `Clerk.commerce.getPaymentSources()`
- `Clerk.commerce.billing`
 - `Clerk.commerce.billing.getPlans()`
 - `Clerk.commerce.billing.getSubscriptions()`
 - `Clerk.commerce.billing.getInvoices()`
 - `Clerk.commerce.billing.startCheckout()`
## Manage payment methods
- `Clerk.[user|organization].initializePaymentSource()`
- `Clerk.[user|organization].addPaymentSource()`
- `Clerk.[user|organization].getPaymentSources()`

## Billing namespace
- `Clerk.billing`
 - `Clerk.billing.getPlans()`
 - `Clerk.billing.getSubscriptions()`
 - `Clerk.billing.getInvoices()`
 - `Clerk.billing.startCheckout()`

14 changes: 7 additions & 7 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ import type {
 ClerkOptions,
 ClientJSONSnapshot,
 ClientResource,
CommerceNamespace,
CommerceBillingNamespace,
 CreateOrganizationParams,
 CreateOrganizationProps,
 CredentialReturn,
Expand DownExpand Up@@ -131,7 +131,7 @@ import { eventBus, events } from './events';
import type { FapiClient, FapiRequestCallback } from './fapiClient';
import { createFapiClient } from './fapiClient';
import { createClientFromJwt } from './jwt-client';
import { Commerce } from './modules/commerce';
import { CommerceBilling } from './modules/commerce';
import {
 BaseResource,
 Client,
Expand DownExpand Up@@ -187,7 +187,7 @@ export class Clerk implements ClerkInterface {
 version: __PKG_VERSION__,
 environment: process.env.NODE_ENV || 'production',
 };
 private static _commerce: CommerceNamespace;
 private static _billing: CommerceBillingNamespace;

 public client: ClientResource | undefined;
 public session: SignedInSessionResource | null | undefined;
Expand DownExpand Up@@ -316,11 +316,11 @@ export class Clerk implements ClerkInterface {
 return this.#options.standardBrowser || false;
 }

 get commerce(): CommerceNamespace {
 if (!Clerk._commerce) {
 Clerk._commerce = new Commerce();
 get billing(): CommerceBillingNamespace {
 if (!Clerk._billing) {
 Clerk._billing = new CommerceBilling();
 }
 return Clerk._commerce;
 return Clerk._billing;
 }

 public __internal_getOption<K extends keyof ClerkOptions>(key: K): ClerkOptions[K] {
Expand Down

69 changes: 0 additions & 69 deletions
packages/clerk-js/src/core/modules/commerce/Commerce.ts

View file


Open in desktop


This file was deleted.


2 changes: 1 addition & 1 deletion
packages/clerk-js/src/core/modules/commerce/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
export * from './Commerce';
export * from './CommerceBilling';
export * from './payment-source-methods';

55 changes: 55 additions & 0 deletions
packages/clerk-js/src/core/modules/commerce/payment-source-methods.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
import type {
 AddPaymentSourceParams,
 ClerkPaginatedResponse,
 CommerceInitializedPaymentSourceJSON,
 CommercePaymentSourceJSON,
 GetPaymentSourcesParams,
 InitializePaymentSourceParams,
} from '@clerk/types';

import { convertPageToOffsetSearchParams } from '../../../utils/convertPageToOffsetSearchParams';
import { BaseResource, CommerceInitializedPaymentSource, CommercePaymentSource } from '../../resources/internal';

export const initializePaymentSource = async (params: InitializePaymentSourceParams) => {
 const { orgId, ...rest } = params;
 const json = (
 await BaseResource._fetch({
 path: orgId
 ? `/organizations/${orgId}/commerce/payment_sources/initialize`
 : `/me/commerce/payment_sources/initialize`,
 method: 'POST',
 body: rest as any,
 })
 )?.response as unknown as CommerceInitializedPaymentSourceJSON;
 return new CommerceInitializedPaymentSource(json);
};

export const addPaymentSource = async (params: AddPaymentSourceParams) => {
 const { orgId, ...rest } = params;

 const json = (
 await BaseResource._fetch({
 path: orgId ? `/organizations/${orgId}/commerce/payment_sources` : `/me/commerce/payment_sources`,
 method: 'POST',
 body: rest as any,
 })
 )?.response as unknown as CommercePaymentSourceJSON;
 return new CommercePaymentSource(json);
};

export const getPaymentSources = async (params: GetPaymentSourcesParams) => {
 const { orgId, ...rest } = params;

 return await BaseResource._fetch({
 path: orgId ? `/organizations/${orgId}/commerce/payment_sources` : `/me/commerce/payment_sources`,
 method: 'GET',
 search: convertPageToOffsetSearchParams(rest),
 }).then(res => {
 const { data: paymentSources, total_count } =
 res?.response as unknown as ClerkPaginatedResponse<CommercePaymentSourceJSON>;
 return {
 total_count,
 data: paymentSources.map(paymentSource => new CommercePaymentSource(paymentSource)),
 };
 });
};

22 changes: 22 additions & 0 deletions
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ import type {

import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
import { unixEpochToDate } from '../../utils/date';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BaseResource, CommerceSubscription, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
Expand DownExpand Up@@ -282,6 +283,27 @@ export class Organization extends BaseResource implements OrganizationResource {
 }).then(res => new Organization(res?.response as OrganizationJSON));
 };

 initializePaymentSource: typeof initializePaymentSource = params => {
 return initializePaymentSource({
 ...params,
 orgId: this.id,
 });
 };

 addPaymentSource: typeof addPaymentSource = params => {
 return addPaymentSource({
 ...params,
 orgId: this.id,
 });
 };

 getPaymentSources: typeof getPaymentSources = params => {
 return getPaymentSources({
 ...params,
 orgId: this.id,
 });
 };

 protected fromJSON(data: OrganizationJSON | OrganizationJSONSnapshot | null): this {
 if (!data) {
 return this;
Expand Down

13 changes: 13 additions & 0 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,7 @@ import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { eventBus, events } from '../events';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BackupCode } from './BackupCode';
import {
 BaseResource,
Expand DownExpand Up@@ -290,6 +291,18 @@ export class User extends BaseResource implements UserResource {
 return new DeletedObject(json);
 };

 initializePaymentSource: typeof initializePaymentSource = params => {
 return initializePaymentSource(params);
 };

 addPaymentSource: typeof addPaymentSource = params => {
 return addPaymentSource(params);
 };

 getPaymentSources: typeof getPaymentSources = params => {
 return getPaymentSources(params);
 };

 get verifiedExternalAccounts() {
 return this.externalAccounts.filter(externalAccount => externalAccount.verification?.status == 'verified');
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/resources/__tests__/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
exports[`Organization has the same initial properties 1`] = `
Organization {
 "addMember": [Function],
 "addPaymentSource": [Function],
 "adminDeleteEnabled": true,
 "createDomain": [Function],
 "createdAt": 1970-01-01T00:00:12.345Z,
Expand All@@ -12,11 +13,13 @@ Organization {
 "getInvitations": [Function],
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPaymentSources": [Function],
 "getRoles": [Function],
 "getSubscriptions": [Function],
 "hasImage": true,
 "id": "test_id",
 "imageUrl": "https://img.clerk.com/eyJ0eXBlIjoiZGVmYXVsdCIsImlpZCI6Imluc18xbHlXRFppb2JyNjAwQUtVZVFEb1NsckVtb00iLCJyaWQiOiJ1c2VyXzJKbElJQTN2VXNjWXh1N2VUMnhINmFrTGgxOCIsImluaXRpYWxzIjoiREsifQ?width=160",
 "initializePaymentSource": [Function],
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "maxAllowedMemberships": 3,
Expand Down

3 changes: 3 additions & 0 deletions
...s/clerk-js/src/core/resources/__tests__/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ OrganizationMembership {
 "id": "test_id",
 "organization": Organization {
 "addMember": [Function],
 "addPaymentSource": [Function],
 "adminDeleteEnabled": true,
 "createDomain": [Function],
 "createdAt": 1970-01-01T00:00:12.345Z,
Expand All@@ -16,11 +17,13 @@ OrganizationMembership {
 "getInvitations": [Function],
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPaymentSources": [Function],
 "getRoles": [Function],
 "getSubscriptions": [Function],
 "hasImage": true,
 "id": "test_org_id",
 "imageUrl": "https://img.clerk.com/eyJ0eXBlIjoiZGVmYXVsdCIsImlpZCI6Imluc18xbHlXRFppb2JyNjAwQUtVZVFEb1NsckVtb00iLCJyaWQiOiJ1c2VyXzJKbElJQTN2VXNjWXh1N2VUMnhINmFrTGgxOCIsImluaXRpYWxzIjoiREsifQ?width=160",
 "initializePaymentSource": [Function],
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "maxAllowedMemberships": 3,
Expand Down

14 changes: 5 additions & 9 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk, useOrganization, useUser } from '@clerk/shared/react';
import { useOrganization } from '@clerk/shared/react';
import type {
 ClerkAPIError,
 ClerkRuntimeError,
Expand DownExpand Up@@ -114,22 +114,18 @@ const CheckoutFormElements = ({
 checkout: CommerceCheckoutResource;
 onCheckoutComplete: (checkout: CommerceCheckoutResource) => void;
}) => {
 const { commerce } = useClerk();
 const { user } = useUser();
 const { organization } = useOrganization();
 const { subscriberType } = useCheckoutContext();
 const { subscriber, subscriberType } = useCheckoutContext();

 const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>('existing');
 const [isSubmitting, setIsSubmitting] = useState(false);
 const [submitError, setSubmitError] = useState<ClerkRuntimeError | ClerkAPIError | string | undefined>();

 const { data, revalidate: revalidatePaymentSources } = useFetch(
 commerce?.getPaymentSources,
 {
 ...(subscriberType === 'org' ? { orgId: organization?.id } : {}),
 },
 subscriber().getPaymentSources,
 {},
 undefined,
 `commerce-payment-sources-${user?.id}`,
 `commerce-payment-sources-${subscriber().id}`,
 );
 const { data: paymentSources } = data || { data: [] };

Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/components/PaymentSources/AddPaymentSource.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,12 +37,13 @@ export const AddPaymentSource = (props: AddPaymentSourceProps) => {
 onPayWithTestPaymentSourceSuccess,
 showPayWithTestCardSection,
 } = props;
 const { commerce } = useClerk();
 const { commerceSettings } = useEnvironment();
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();

 const resource = subscriberType === 'org' ? organization : user;

 const stripePromiseRef = useRef<Promise<Stripe | null> | null>(null);
 const [stripe, setStripe] = useState<Stripe | null>(null);

Expand DownExpand Up@@ -73,13 +74,12 @@ export const AddPaymentSource = (props: AddPaymentSourceProps) => {
 invalidate,
 revalidate: revalidateInitializedPaymentSource,
 } = useFetch(
commerce.initializePaymentSource,
resource?.initializePaymentSource,
 {
 gateway: 'stripe',
 ...(subscriberType === 'org' ? { orgId: organization?.id } : {}),
 },
 undefined,
 `commerce-payment-source-initialize-${user?.id}`,
 `commerce-payment-source-initialize-${resource?.id}`,
 );

 const externalGatewayId = initializedPaymentSource?.externalGatewayId;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
chore(clerk-js): Remove Clerk.commerce#5846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 6 commits into

from

May 6, 2025
 Merged


chore(clerk-js): Remove Clerk.commerce
#5846
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
8af6f99

remove Clerk.commerce


brkalow May 5, 2025
f11e41c

snapdates


brkalow May 6, 2025
ee0e4c3

fix lint error


brkalow May 6, 2025
76c7443

fix type


brkalow May 6, 2025
c1b81a8

adjust changesets


brkalow May 6, 2025
05afd9c

sort imports


brkalow May 6, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/proud-donuts-shop.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

22 changes: 12 additions & 10 deletions
.changeset/witty-doors-hear.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,20 @@
'@clerk/types': minor
---

Expose stable commerce stable apis under `Clerk.commerce`
Expose Clerk Billing APIs.

## Render the pricing table component
- `Clerk.mountPricingTable`
- `Clerk.unmountPricingTable`

## Commerce namespace
- `Clerk.commerce.initializePaymentSource()`
- `Clerk.commerce.addPaymentSource()`
- `Clerk.commerce.getPaymentSources()`
- `Clerk.commerce.billing`
 - `Clerk.commerce.billing.getPlans()`
 - `Clerk.commerce.billing.getSubscriptions()`
 - `Clerk.commerce.billing.getInvoices()`
 - `Clerk.commerce.billing.startCheckout()`
## Manage payment methods
- `Clerk.[user|organization].initializePaymentSource()`
- `Clerk.[user|organization].addPaymentSource()`
- `Clerk.[user|organization].getPaymentSources()`

## Billing namespace
- `Clerk.billing`
 - `Clerk.billing.getPlans()`
 - `Clerk.billing.getSubscriptions()`
 - `Clerk.billing.getInvoices()`
 - `Clerk.billing.startCheckout()`

14 changes: 7 additions & 7 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ import type {
 ClerkOptions,
 ClientJSONSnapshot,
 ClientResource,
CommerceNamespace,
CommerceBillingNamespace,
 CreateOrganizationParams,
 CreateOrganizationProps,
 CredentialReturn,
Expand DownExpand Up@@ -131,7 +131,7 @@ import { eventBus, events } from './events';
import type { FapiClient, FapiRequestCallback } from './fapiClient';
import { createFapiClient } from './fapiClient';
import { createClientFromJwt } from './jwt-client';
import { Commerce } from './modules/commerce';
import { CommerceBilling } from './modules/commerce';
import {
 BaseResource,
 Client,
Expand DownExpand Up@@ -187,7 +187,7 @@ export class Clerk implements ClerkInterface {
 version: __PKG_VERSION__,
 environment: process.env.NODE_ENV || 'production',
 };
 private static _commerce: CommerceNamespace;
 private static _billing: CommerceBillingNamespace;

 public client: ClientResource | undefined;
 public session: SignedInSessionResource | null | undefined;
Expand DownExpand Up@@ -316,11 +316,11 @@ export class Clerk implements ClerkInterface {
 return this.#options.standardBrowser || false;
 }

 get commerce(): CommerceNamespace {
 if (!Clerk._commerce) {
 Clerk._commerce = new Commerce();
 get billing(): CommerceBillingNamespace {
 if (!Clerk._billing) {
 Clerk._billing = new CommerceBilling();
 }
 return Clerk._commerce;
 return Clerk._billing;
 }

 public __internal_getOption<K extends keyof ClerkOptions>(key: K): ClerkOptions[K] {
Expand Down

69 changes: 0 additions & 69 deletions
packages/clerk-js/src/core/modules/commerce/Commerce.ts

View file


Open in desktop


This file was deleted.


2 changes: 1 addition & 1 deletion
packages/clerk-js/src/core/modules/commerce/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
export * from './Commerce';
export * from './CommerceBilling';
export * from './payment-source-methods';

55 changes: 55 additions & 0 deletions
packages/clerk-js/src/core/modules/commerce/payment-source-methods.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
import type {
 AddPaymentSourceParams,
 ClerkPaginatedResponse,
 CommerceInitializedPaymentSourceJSON,
 CommercePaymentSourceJSON,
 GetPaymentSourcesParams,
 InitializePaymentSourceParams,
} from '@clerk/types';

import { convertPageToOffsetSearchParams } from '../../../utils/convertPageToOffsetSearchParams';
import { BaseResource, CommerceInitializedPaymentSource, CommercePaymentSource } from '../../resources/internal';

export const initializePaymentSource = async (params: InitializePaymentSourceParams) => {
 const { orgId, ...rest } = params;
 const json = (
 await BaseResource._fetch({
 path: orgId
 ? `/organizations/${orgId}/commerce/payment_sources/initialize`
 : `/me/commerce/payment_sources/initialize`,
 method: 'POST',
 body: rest as any,
 })
 )?.response as unknown as CommerceInitializedPaymentSourceJSON;
 return new CommerceInitializedPaymentSource(json);
};

export const addPaymentSource = async (params: AddPaymentSourceParams) => {
 const { orgId, ...rest } = params;

 const json = (
 await BaseResource._fetch({
 path: orgId ? `/organizations/${orgId}/commerce/payment_sources` : `/me/commerce/payment_sources`,
 method: 'POST',
 body: rest as any,
 })
 )?.response as unknown as CommercePaymentSourceJSON;
 return new CommercePaymentSource(json);
};

export const getPaymentSources = async (params: GetPaymentSourcesParams) => {
 const { orgId, ...rest } = params;

 return await BaseResource._fetch({
 path: orgId ? `/organizations/${orgId}/commerce/payment_sources` : `/me/commerce/payment_sources`,
 method: 'GET',
 search: convertPageToOffsetSearchParams(rest),
 }).then(res => {
 const { data: paymentSources, total_count } =
 res?.response as unknown as ClerkPaginatedResponse<CommercePaymentSourceJSON>;
 return {
 total_count,
 data: paymentSources.map(paymentSource => new CommercePaymentSource(paymentSource)),
 };
 });
};

22 changes: 22 additions & 0 deletions
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ import type {

import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
import { unixEpochToDate } from '../../utils/date';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BaseResource, CommerceSubscription, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
Expand DownExpand Up@@ -282,6 +283,27 @@ export class Organization extends BaseResource implements OrganizationResource {
 }).then(res => new Organization(res?.response as OrganizationJSON));
 };

 initializePaymentSource: typeof initializePaymentSource = params => {
 return initializePaymentSource({
 ...params,
 orgId: this.id,
 });
 };

 addPaymentSource: typeof addPaymentSource = params => {
 return addPaymentSource({
 ...params,
 orgId: this.id,
 });
 };

 getPaymentSources: typeof getPaymentSources = params => {
 return getPaymentSources({
 ...params,
 orgId: this.id,
 });
 };

 protected fromJSON(data: OrganizationJSON | OrganizationJSONSnapshot | null): this {
 if (!data) {
 return this;
Expand Down

13 changes: 13 additions & 0 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,7 @@ import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { eventBus, events } from '../events';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BackupCode } from './BackupCode';
import {
 BaseResource,
Expand DownExpand Up@@ -290,6 +291,18 @@ export class User extends BaseResource implements UserResource {
 return new DeletedObject(json);
 };

 initializePaymentSource: typeof initializePaymentSource = params => {
 return initializePaymentSource(params);
 };

 addPaymentSource: typeof addPaymentSource = params => {
 return addPaymentSource(params);
 };

 getPaymentSources: typeof getPaymentSources = params => {
 return getPaymentSources(params);
 };

 get verifiedExternalAccounts() {
 return this.externalAccounts.filter(externalAccount => externalAccount.verification?.status == 'verified');
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/resources/__tests__/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
exports[`Organization has the same initial properties 1`] = `
Organization {
 "addMember": [Function],
 "addPaymentSource": [Function],
 "adminDeleteEnabled": true,
 "createDomain": [Function],
 "createdAt": 1970-01-01T00:00:12.345Z,
Expand All@@ -12,11 +13,13 @@ Organization {
 "getInvitations": [Function],
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPaymentSources": [Function],
 "getRoles": [Function],
 "getSubscriptions": [Function],
 "hasImage": true,
 "id": "test_id",
 "imageUrl": "https://img.clerk.com/eyJ0eXBlIjoiZGVmYXVsdCIsImlpZCI6Imluc18xbHlXRFppb2JyNjAwQUtVZVFEb1NsckVtb00iLCJyaWQiOiJ1c2VyXzJKbElJQTN2VXNjWXh1N2VUMnhINmFrTGgxOCIsImluaXRpYWxzIjoiREsifQ?width=160",
 "initializePaymentSource": [Function],
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "maxAllowedMemberships": 3,
Expand Down

3 changes: 3 additions & 0 deletions
...s/clerk-js/src/core/resources/__tests__/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ OrganizationMembership {
 "id": "test_id",
 "organization": Organization {
 "addMember": [Function],
 "addPaymentSource": [Function],
 "adminDeleteEnabled": true,
 "createDomain": [Function],
 "createdAt": 1970-01-01T00:00:12.345Z,
Expand All@@ -16,11 +17,13 @@ OrganizationMembership {
 "getInvitations": [Function],
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPaymentSources": [Function],
 "getRoles": [Function],
 "getSubscriptions": [Function],
 "hasImage": true,
 "id": "test_org_id",
 "imageUrl": "https://img.clerk.com/eyJ0eXBlIjoiZGVmYXVsdCIsImlpZCI6Imluc18xbHlXRFppb2JyNjAwQUtVZVFEb1NsckVtb00iLCJyaWQiOiJ1c2VyXzJKbElJQTN2VXNjWXh1N2VUMnhINmFrTGgxOCIsImluaXRpYWxzIjoiREsifQ?width=160",
 "initializePaymentSource": [Function],
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "maxAllowedMemberships": 3,
Expand Down

14 changes: 5 additions & 9 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk, useOrganization, useUser } from '@clerk/shared/react';
import { useOrganization } from '@clerk/shared/react';
import type {
 ClerkAPIError,
 ClerkRuntimeError,
Expand DownExpand Up@@ -114,22 +114,18 @@ const CheckoutFormElements = ({
 checkout: CommerceCheckoutResource;
 onCheckoutComplete: (checkout: CommerceCheckoutResource) => void;
}) => {
 const { commerce } = useClerk();
 const { user } = useUser();
 const { organization } = useOrganization();
 const { subscriberType } = useCheckoutContext();
 const { subscriber, subscriberType } = useCheckoutContext();

 const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>('existing');
 const [isSubmitting, setIsSubmitting] = useState(false);
 const [submitError, setSubmitError] = useState<ClerkRuntimeError | ClerkAPIError | string | undefined>();

 const { data, revalidate: revalidatePaymentSources } = useFetch(
 commerce?.getPaymentSources,
 {
 ...(subscriberType === 'org' ? { orgId: organization?.id } : {}),
 },
 subscriber().getPaymentSources,
 {},
 undefined,
 `commerce-payment-sources-${user?.id}`,
 `commerce-payment-sources-${subscriber().id}`,
 );
 const { data: paymentSources } = data || { data: [] };

Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/components/PaymentSources/AddPaymentSource.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,12 +37,13 @@ export const AddPaymentSource = (props: AddPaymentSourceProps) => {
 onPayWithTestPaymentSourceSuccess,
 showPayWithTestCardSection,
 } = props;
 const { commerce } = useClerk();
 const { commerceSettings } = useEnvironment();
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();

 const resource = subscriberType === 'org' ? organization : user;

 const stripePromiseRef = useRef<Promise<Stripe | null> | null>(null);
 const [stripe, setStripe] = useState<Stripe | null>(null);

Expand DownExpand Up@@ -73,13 +74,12 @@ export const AddPaymentSource = (props: AddPaymentSourceProps) => {
 invalidate,
 revalidate: revalidateInitializedPaymentSource,
 } = useFetch(
commerce.initializePaymentSource,
resource?.initializePaymentSource,
 {
 gateway: 'stripe',
 ...(subscriberType === 'org' ? { orgId: organization?.id } : {}),
 },
 undefined,
 `commerce-payment-source-initialize-${user?.id}`,
 `commerce-payment-source-initialize-${resource?.id}`,
 );

 const externalGatewayId = initializedPaymentSource?.externalGatewayId;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(clerk-js): Remove Clerk.commerce#5846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 6 commits into

from

May 6, 2025
 Merged


chore(clerk-js): Remove Clerk.commerce
#5846
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
8af6f99

remove Clerk.commerce


brkalow May 5, 2025
f11e41c

snapdates


brkalow May 6, 2025
ee0e4c3

fix lint error


brkalow May 6, 2025
76c7443

fix type


brkalow May 6, 2025
c1b81a8

adjust changesets


brkalow May 6, 2025
05afd9c

sort imports


brkalow May 6, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/proud-donuts-shop.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

22 changes: 12 additions & 10 deletions
.changeset/witty-doors-hear.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,20 @@
'@clerk/types': minor
---

Expose stable commerce stable apis under `Clerk.commerce`
Expose Clerk Billing APIs.

## Render the pricing table component
- `Clerk.mountPricingTable`
- `Clerk.unmountPricingTable`

## Commerce namespace
- `Clerk.commerce.initializePaymentSource()`
- `Clerk.commerce.addPaymentSource()`
- `Clerk.commerce.getPaymentSources()`
- `Clerk.commerce.billing`
 - `Clerk.commerce.billing.getPlans()`
 - `Clerk.commerce.billing.getSubscriptions()`
 - `Clerk.commerce.billing.getInvoices()`
 - `Clerk.commerce.billing.startCheckout()`
## Manage payment methods
- `Clerk.[user|organization].initializePaymentSource()`
- `Clerk.[user|organization].addPaymentSource()`
- `Clerk.[user|organization].getPaymentSources()`

## Billing namespace
- `Clerk.billing`
 - `Clerk.billing.getPlans()`
 - `Clerk.billing.getSubscriptions()`
 - `Clerk.billing.getInvoices()`
 - `Clerk.billing.startCheckout()`

14 changes: 7 additions & 7 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ import type {
 ClerkOptions,
 ClientJSONSnapshot,
 ClientResource,
CommerceNamespace,
CommerceBillingNamespace,
 CreateOrganizationParams,
 CreateOrganizationProps,
 CredentialReturn,
Expand DownExpand Up@@ -131,7 +131,7 @@ import { eventBus, events } from './events';
import type { FapiClient, FapiRequestCallback } from './fapiClient';
import { createFapiClient } from './fapiClient';
import { createClientFromJwt } from './jwt-client';
import { Commerce } from './modules/commerce';
import { CommerceBilling } from './modules/commerce';
import {
 BaseResource,
 Client,
Expand DownExpand Up@@ -187,7 +187,7 @@ export class Clerk implements ClerkInterface {
 version: __PKG_VERSION__,
 environment: process.env.NODE_ENV || 'production',
 };
 private static _commerce: CommerceNamespace;
 private static _billing: CommerceBillingNamespace;

 public client: ClientResource | undefined;
 public session: SignedInSessionResource | null | undefined;
Expand DownExpand Up@@ -316,11 +316,11 @@ export class Clerk implements ClerkInterface {
 return this.#options.standardBrowser || false;
 }

 get commerce(): CommerceNamespace {
 if (!Clerk._commerce) {
 Clerk._commerce = new Commerce();
 get billing(): CommerceBillingNamespace {
 if (!Clerk._billing) {
 Clerk._billing = new CommerceBilling();
 }
 return Clerk._commerce;
 return Clerk._billing;
 }

 public __internal_getOption<K extends keyof ClerkOptions>(key: K): ClerkOptions[K] {
Expand Down

69 changes: 0 additions & 69 deletions
packages/clerk-js/src/core/modules/commerce/Commerce.ts

View file


Open in desktop


This file was deleted.


2 changes: 1 addition & 1 deletion
packages/clerk-js/src/core/modules/commerce/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
export * from './Commerce';
export * from './CommerceBilling';
export * from './payment-source-methods';

55 changes: 55 additions & 0 deletions
packages/clerk-js/src/core/modules/commerce/payment-source-methods.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
import type {
 AddPaymentSourceParams,
 ClerkPaginatedResponse,
 CommerceInitializedPaymentSourceJSON,
 CommercePaymentSourceJSON,
 GetPaymentSourcesParams,
 InitializePaymentSourceParams,
} from '@clerk/types';

import { convertPageToOffsetSearchParams } from '../../../utils/convertPageToOffsetSearchParams';
import { BaseResource, CommerceInitializedPaymentSource, CommercePaymentSource } from '../../resources/internal';

export const initializePaymentSource = async (params: InitializePaymentSourceParams) => {
 const { orgId, ...rest } = params;
 const json = (
 await BaseResource._fetch({
 path: orgId
 ? `/organizations/${orgId}/commerce/payment_sources/initialize`
 : `/me/commerce/payment_sources/initialize`,
 method: 'POST',
 body: rest as any,
 })
 )?.response as unknown as CommerceInitializedPaymentSourceJSON;
 return new CommerceInitializedPaymentSource(json);
};

export const addPaymentSource = async (params: AddPaymentSourceParams) => {
 const { orgId, ...rest } = params;

 const json = (
 await BaseResource._fetch({
 path: orgId ? `/organizations/${orgId}/commerce/payment_sources` : `/me/commerce/payment_sources`,
 method: 'POST',
 body: rest as any,
 })
 )?.response as unknown as CommercePaymentSourceJSON;
 return new CommercePaymentSource(json);
};

export const getPaymentSources = async (params: GetPaymentSourcesParams) => {
 const { orgId, ...rest } = params;

 return await BaseResource._fetch({
 path: orgId ? `/organizations/${orgId}/commerce/payment_sources` : `/me/commerce/payment_sources`,
 method: 'GET',
 search: convertPageToOffsetSearchParams(rest),
 }).then(res => {
 const { data: paymentSources, total_count } =
 res?.response as unknown as ClerkPaginatedResponse<CommercePaymentSourceJSON>;
 return {
 total_count,
 data: paymentSources.map(paymentSource => new CommercePaymentSource(paymentSource)),
 };
 });
};

22 changes: 22 additions & 0 deletions
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ import type {

import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
import { unixEpochToDate } from '../../utils/date';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BaseResource, CommerceSubscription, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
Expand DownExpand Up@@ -282,6 +283,27 @@ export class Organization extends BaseResource implements OrganizationResource {
 }).then(res => new Organization(res?.response as OrganizationJSON));
 };

 initializePaymentSource: typeof initializePaymentSource = params => {
 return initializePaymentSource({
 ...params,
 orgId: this.id,
 });
 };

 addPaymentSource: typeof addPaymentSource = params => {
 return addPaymentSource({
 ...params,
 orgId: this.id,
 });
 };

 getPaymentSources: typeof getPaymentSources = params => {
 return getPaymentSources({
 ...params,
 orgId: this.id,
 });
 };

 protected fromJSON(data: OrganizationJSON | OrganizationJSONSnapshot | null): this {
 if (!data) {
 return this;
Expand Down

13 changes: 13 additions & 0 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,7 @@ import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { eventBus, events } from '../events';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BackupCode } from './BackupCode';
import {
 BaseResource,
Expand DownExpand Up@@ -290,6 +291,18 @@ export class User extends BaseResource implements UserResource {
 return new DeletedObject(json);
 };

 initializePaymentSource: typeof initializePaymentSource = params => {
 return initializePaymentSource(params);
 };

 addPaymentSource: typeof addPaymentSource = params => {
 return addPaymentSource(params);
 };

 getPaymentSources: typeof getPaymentSources = params => {
 return getPaymentSources(params);
 };

 get verifiedExternalAccounts() {
 return this.externalAccounts.filter(externalAccount => externalAccount.verification?.status == 'verified');
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/resources/__tests__/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
exports[`Organization has the same initial properties 1`] = `
Organization {
 "addMember": [Function],
 "addPaymentSource": [Function],
 "adminDeleteEnabled": true,
 "createDomain": [Function],
 "createdAt": 1970-01-01T00:00:12.345Z,
Expand All@@ -12,11 +13,13 @@ Organization {
 "getInvitations": [Function],
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPaymentSources": [Function],
 "getRoles": [Function],
 "getSubscriptions": [Function],
 "hasImage": true,
 "id": "test_id",
 "imageUrl": "https://img.clerk.com/eyJ0eXBlIjoiZGVmYXVsdCIsImlpZCI6Imluc18xbHlXRFppb2JyNjAwQUtVZVFEb1NsckVtb00iLCJyaWQiOiJ1c2VyXzJKbElJQTN2VXNjWXh1N2VUMnhINmFrTGgxOCIsImluaXRpYWxzIjoiREsifQ?width=160",
 "initializePaymentSource": [Function],
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "maxAllowedMemberships": 3,
Expand Down

3 changes: 3 additions & 0 deletions
...s/clerk-js/src/core/resources/__tests__/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ OrganizationMembership {
 "id": "test_id",
 "organization": Organization {
 "addMember": [Function],
 "addPaymentSource": [Function],
 "adminDeleteEnabled": true,
 "createDomain": [Function],
 "createdAt": 1970-01-01T00:00:12.345Z,
Expand All@@ -16,11 +17,13 @@ OrganizationMembership {
 "getInvitations": [Function],
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPaymentSources": [Function],
 "getRoles": [Function],
 "getSubscriptions": [Function],
 "hasImage": true,
 "id": "test_org_id",
 "imageUrl": "https://img.clerk.com/eyJ0eXBlIjoiZGVmYXVsdCIsImlpZCI6Imluc18xbHlXRFppb2JyNjAwQUtVZVFEb1NsckVtb00iLCJyaWQiOiJ1c2VyXzJKbElJQTN2VXNjWXh1N2VUMnhINmFrTGgxOCIsImluaXRpYWxzIjoiREsifQ?width=160",
 "initializePaymentSource": [Function],
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "maxAllowedMemberships": 3,
Expand Down

14 changes: 5 additions & 9 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk, useOrganization, useUser } from '@clerk/shared/react';
import { useOrganization } from '@clerk/shared/react';
import type {
 ClerkAPIError,
 ClerkRuntimeError,
Expand DownExpand Up@@ -114,22 +114,18 @@ const CheckoutFormElements = ({
 checkout: CommerceCheckoutResource;
 onCheckoutComplete: (checkout: CommerceCheckoutResource) => void;
}) => {
 const { commerce } = useClerk();
 const { user } = useUser();
 const { organization } = useOrganization();
 const { subscriberType } = useCheckoutContext();
 const { subscriber, subscriberType } = useCheckoutContext();

 const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>('existing');
 const [isSubmitting, setIsSubmitting] = useState(false);
 const [submitError, setSubmitError] = useState<ClerkRuntimeError | ClerkAPIError | string | undefined>();

 const { data, revalidate: revalidatePaymentSources } = useFetch(
 commerce?.getPaymentSources,
 {
 ...(subscriberType === 'org' ? { orgId: organization?.id } : {}),
 },
 subscriber().getPaymentSources,
 {},
 undefined,
 `commerce-payment-sources-${user?.id}`,
 `commerce-payment-sources-${subscriber().id}`,
 );
 const { data: paymentSources } = data || { data: [] };

Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/components/PaymentSources/AddPaymentSource.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,12 +37,13 @@ export const AddPaymentSource = (props: AddPaymentSourceProps) => {
 onPayWithTestPaymentSourceSuccess,
 showPayWithTestCardSection,
 } = props;
 const { commerce } = useClerk();
 const { commerceSettings } = useEnvironment();
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();

 const resource = subscriberType === 'org' ? organization : user;

 const stripePromiseRef = useRef<Promise<Stripe | null> | null>(null);
 const [stripe, setStripe] = useState<Stripe | null>(null);

Expand DownExpand Up@@ -73,13 +74,12 @@ export const AddPaymentSource = (props: AddPaymentSourceProps) => {
 invalidate,
 revalidate: revalidateInitializedPaymentSource,
 } = useFetch(
commerce.initializePaymentSource,
resource?.initializePaymentSource,
 {
 gateway: 'stripe',
 ...(subscriberType === 'org' ? { orgId: organization?.id } : {}),
 },
 undefined,
 `commerce-payment-source-initialize-${user?.id}`,
 `commerce-payment-source-initialize-${resource?.id}`,
 );

 const externalGatewayId = initializedPaymentSource?.externalGatewayId;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(clerk-js): Remove Clerk.commerce#5846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 6 commits into

from

May 6, 2025
 Merged


chore(clerk-js): Remove Clerk.commerce
#5846
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
8af6f99

remove Clerk.commerce


brkalow May 5, 2025
f11e41c

snapdates


brkalow May 6, 2025
ee0e4c3

fix lint error


brkalow May 6, 2025
76c7443

fix type


brkalow May 6, 2025
c1b81a8

adjust changesets


brkalow May 6, 2025
05afd9c

sort imports


brkalow May 6, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/proud-donuts-shop.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

22 changes: 12 additions & 10 deletions
.changeset/witty-doors-hear.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,20 @@
'@clerk/types': minor
---

Expose stable commerce stable apis under `Clerk.commerce`
Expose Clerk Billing APIs.

## Render the pricing table component
- `Clerk.mountPricingTable`
- `Clerk.unmountPricingTable`

## Commerce namespace
- `Clerk.commerce.initializePaymentSource()`
- `Clerk.commerce.addPaymentSource()`
- `Clerk.commerce.getPaymentSources()`
- `Clerk.commerce.billing`
 - `Clerk.commerce.billing.getPlans()`
 - `Clerk.commerce.billing.getSubscriptions()`
 - `Clerk.commerce.billing.getInvoices()`
 - `Clerk.commerce.billing.startCheckout()`
## Manage payment methods
- `Clerk.[user|organization].initializePaymentSource()`
- `Clerk.[user|organization].addPaymentSource()`
- `Clerk.[user|organization].getPaymentSources()`

## Billing namespace
- `Clerk.billing`
 - `Clerk.billing.getPlans()`
 - `Clerk.billing.getSubscriptions()`
 - `Clerk.billing.getInvoices()`
 - `Clerk.billing.startCheckout()`

14 changes: 7 additions & 7 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ import type {
 ClerkOptions,
 ClientJSONSnapshot,
 ClientResource,
CommerceNamespace,
CommerceBillingNamespace,
 CreateOrganizationParams,
 CreateOrganizationProps,
 CredentialReturn,
Expand DownExpand Up@@ -131,7 +131,7 @@ import { eventBus, events } from './events';
import type { FapiClient, FapiRequestCallback } from './fapiClient';
import { createFapiClient } from './fapiClient';
import { createClientFromJwt } from './jwt-client';
import { Commerce } from './modules/commerce';
import { CommerceBilling } from './modules/commerce';
import {
 BaseResource,
 Client,
Expand DownExpand Up@@ -187,7 +187,7 @@ export class Clerk implements ClerkInterface {
 version: __PKG_VERSION__,
 environment: process.env.NODE_ENV || 'production',
 };
 private static _commerce: CommerceNamespace;
 private static _billing: CommerceBillingNamespace;

 public client: ClientResource | undefined;
 public session: SignedInSessionResource | null | undefined;
Expand DownExpand Up@@ -316,11 +316,11 @@ export class Clerk implements ClerkInterface {
 return this.#options.standardBrowser || false;
 }

 get commerce(): CommerceNamespace {
 if (!Clerk._commerce) {
 Clerk._commerce = new Commerce();
 get billing(): CommerceBillingNamespace {
 if (!Clerk._billing) {
 Clerk._billing = new CommerceBilling();
 }
 return Clerk._commerce;
 return Clerk._billing;
 }

 public __internal_getOption<K extends keyof ClerkOptions>(key: K): ClerkOptions[K] {
Expand Down

69 changes: 0 additions & 69 deletions
packages/clerk-js/src/core/modules/commerce/Commerce.ts

View file


Open in desktop


This file was deleted.


2 changes: 1 addition & 1 deletion
packages/clerk-js/src/core/modules/commerce/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
export * from './Commerce';
export * from './CommerceBilling';
export * from './payment-source-methods';

55 changes: 55 additions & 0 deletions
packages/clerk-js/src/core/modules/commerce/payment-source-methods.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
import type {
 AddPaymentSourceParams,
 ClerkPaginatedResponse,
 CommerceInitializedPaymentSourceJSON,
 CommercePaymentSourceJSON,
 GetPaymentSourcesParams,
 InitializePaymentSourceParams,
} from '@clerk/types';

import { convertPageToOffsetSearchParams } from '../../../utils/convertPageToOffsetSearchParams';
import { BaseResource, CommerceInitializedPaymentSource, CommercePaymentSource } from '../../resources/internal';

export const initializePaymentSource = async (params: InitializePaymentSourceParams) => {
 const { orgId, ...rest } = params;
 const json = (
 await BaseResource._fetch({
 path: orgId
 ? `/organizations/${orgId}/commerce/payment_sources/initialize`
 : `/me/commerce/payment_sources/initialize`,
 method: 'POST',
 body: rest as any,
 })
 )?.response as unknown as CommerceInitializedPaymentSourceJSON;
 return new CommerceInitializedPaymentSource(json);
};

export const addPaymentSource = async (params: AddPaymentSourceParams) => {
 const { orgId, ...rest } = params;

 const json = (
 await BaseResource._fetch({
 path: orgId ? `/organizations/${orgId}/commerce/payment_sources` : `/me/commerce/payment_sources`,
 method: 'POST',
 body: rest as any,
 })
 )?.response as unknown as CommercePaymentSourceJSON;
 return new CommercePaymentSource(json);
};

export const getPaymentSources = async (params: GetPaymentSourcesParams) => {
 const { orgId, ...rest } = params;

 return await BaseResource._fetch({
 path: orgId ? `/organizations/${orgId}/commerce/payment_sources` : `/me/commerce/payment_sources`,
 method: 'GET',
 search: convertPageToOffsetSearchParams(rest),
 }).then(res => {
 const { data: paymentSources, total_count } =
 res?.response as unknown as ClerkPaginatedResponse<CommercePaymentSourceJSON>;
 return {
 total_count,
 data: paymentSources.map(paymentSource => new CommercePaymentSource(paymentSource)),
 };
 });
};

22 changes: 22 additions & 0 deletions
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ import type {

import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
import { unixEpochToDate } from '../../utils/date';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BaseResource, CommerceSubscription, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
Expand DownExpand Up@@ -282,6 +283,27 @@ export class Organization extends BaseResource implements OrganizationResource {
 }).then(res => new Organization(res?.response as OrganizationJSON));
 };

 initializePaymentSource: typeof initializePaymentSource = params => {
 return initializePaymentSource({
 ...params,
 orgId: this.id,
 });
 };

 addPaymentSource: typeof addPaymentSource = params => {
 return addPaymentSource({
 ...params,
 orgId: this.id,
 });
 };

 getPaymentSources: typeof getPaymentSources = params => {
 return getPaymentSources({
 ...params,
 orgId: this.id,
 });
 };

 protected fromJSON(data: OrganizationJSON | OrganizationJSONSnapshot | null): this {
 if (!data) {
 return this;
Expand Down

13 changes: 13 additions & 0 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,7 @@ import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { eventBus, events } from '../events';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BackupCode } from './BackupCode';
import {
 BaseResource,
Expand DownExpand Up@@ -290,6 +291,18 @@ export class User extends BaseResource implements UserResource {
 return new DeletedObject(json);
 };

 initializePaymentSource: typeof initializePaymentSource = params => {
 return initializePaymentSource(params);
 };

 addPaymentSource: typeof addPaymentSource = params => {
 return addPaymentSource(params);
 };

 getPaymentSources: typeof getPaymentSources = params => {
 return getPaymentSources(params);
 };

 get verifiedExternalAccounts() {
 return this.externalAccounts.filter(externalAccount => externalAccount.verification?.status == 'verified');
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/resources/__tests__/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
exports[`Organization has the same initial properties 1`] = `
Organization {
 "addMember": [Function],
 "addPaymentSource": [Function],
 "adminDeleteEnabled": true,
 "createDomain": [Function],
 "createdAt": 1970-01-01T00:00:12.345Z,
Expand All@@ -12,11 +13,13 @@ Organization {
 "getInvitations": [Function],
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPaymentSources": [Function],
 "getRoles": [Function],
 "getSubscriptions": [Function],
 "hasImage": true,
 "id": "test_id",
 "imageUrl": "https://img.clerk.com/eyJ0eXBlIjoiZGVmYXVsdCIsImlpZCI6Imluc18xbHlXRFppb2JyNjAwQUtVZVFEb1NsckVtb00iLCJyaWQiOiJ1c2VyXzJKbElJQTN2VXNjWXh1N2VUMnhINmFrTGgxOCIsImluaXRpYWxzIjoiREsifQ?width=160",
 "initializePaymentSource": [Function],
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "maxAllowedMemberships": 3,
Expand Down

3 changes: 3 additions & 0 deletions
...s/clerk-js/src/core/resources/__tests__/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ OrganizationMembership {
 "id": "test_id",
 "organization": Organization {
 "addMember": [Function],
 "addPaymentSource": [Function],
 "adminDeleteEnabled": true,
 "createDomain": [Function],
 "createdAt": 1970-01-01T00:00:12.345Z,
Expand All@@ -16,11 +17,13 @@ OrganizationMembership {
 "getInvitations": [Function],
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPaymentSources": [Function],
 "getRoles": [Function],
 "getSubscriptions": [Function],
 "hasImage": true,
 "id": "test_org_id",
 "imageUrl": "https://img.clerk.com/eyJ0eXBlIjoiZGVmYXVsdCIsImlpZCI6Imluc18xbHlXRFppb2JyNjAwQUtVZVFEb1NsckVtb00iLCJyaWQiOiJ1c2VyXzJKbElJQTN2VXNjWXh1N2VUMnhINmFrTGgxOCIsImluaXRpYWxzIjoiREsifQ?width=160",
 "initializePaymentSource": [Function],
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "maxAllowedMemberships": 3,
Expand Down

14 changes: 5 additions & 9 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk, useOrganization, useUser } from '@clerk/shared/react';
import { useOrganization } from '@clerk/shared/react';
import type {
 ClerkAPIError,
 ClerkRuntimeError,
Expand DownExpand Up@@ -114,22 +114,18 @@ const CheckoutFormElements = ({
 checkout: CommerceCheckoutResource;
 onCheckoutComplete: (checkout: CommerceCheckoutResource) => void;
}) => {
 const { commerce } = useClerk();
 const { user } = useUser();
 const { organization } = useOrganization();
 const { subscriberType } = useCheckoutContext();
 const { subscriber, subscriberType } = useCheckoutContext();

 const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>('existing');
 const [isSubmitting, setIsSubmitting] = useState(false);
 const [submitError, setSubmitError] = useState<ClerkRuntimeError | ClerkAPIError | string | undefined>();

 const { data, revalidate: revalidatePaymentSources } = useFetch(
 commerce?.getPaymentSources,
 {
 ...(subscriberType === 'org' ? { orgId: organization?.id } : {}),
 },
 subscriber().getPaymentSources,
 {},
 undefined,
 `commerce-payment-sources-${user?.id}`,
 `commerce-payment-sources-${subscriber().id}`,
 );
 const { data: paymentSources } = data || { data: [] };

Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/components/PaymentSources/AddPaymentSource.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,12 +37,13 @@ export const AddPaymentSource = (props: AddPaymentSourceProps) => {
 onPayWithTestPaymentSourceSuccess,
 showPayWithTestCardSection,
 } = props;
 const { commerce } = useClerk();
 const { commerceSettings } = useEnvironment();
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();

 const resource = subscriberType === 'org' ? organization : user;

 const stripePromiseRef = useRef<Promise<Stripe | null> | null>(null);
 const [stripe, setStripe] = useState<Stripe | null>(null);

Expand DownExpand Up@@ -73,13 +74,12 @@ export const AddPaymentSource = (props: AddPaymentSourceProps) => {
 invalidate,
 revalidate: revalidateInitializedPaymentSource,
 } = useFetch(
commerce.initializePaymentSource,
resource?.initializePaymentSource,
 {
 gateway: 'stripe',
 ...(subscriberType === 'org' ? { orgId: organization?.id } : {}),
 },
 undefined,
 `commerce-payment-source-initialize-${user?.id}`,
 `commerce-payment-source-initialize-${resource?.id}`,
 );

 const externalGatewayId = initializedPaymentSource?.externalGatewayId;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
chore(clerk-js): Remove Clerk.commerce#5846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 6 commits into

from

May 6, 2025
 Merged


chore(clerk-js): Remove Clerk.commerce
#5846
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
8af6f99

remove Clerk.commerce


brkalow May 5, 2025
f11e41c

snapdates


brkalow May 6, 2025
ee0e4c3

fix lint error


brkalow May 6, 2025
76c7443

fix type


brkalow May 6, 2025
c1b81a8

adjust changesets


brkalow May 6, 2025
05afd9c

sort imports


brkalow May 6, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/proud-donuts-shop.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

22 changes: 12 additions & 10 deletions
.changeset/witty-doors-hear.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,20 @@
'@clerk/types': minor
---

Expose stable commerce stable apis under `Clerk.commerce`
Expose Clerk Billing APIs.

## Render the pricing table component
- `Clerk.mountPricingTable`
- `Clerk.unmountPricingTable`

## Commerce namespace
- `Clerk.commerce.initializePaymentSource()`
- `Clerk.commerce.addPaymentSource()`
- `Clerk.commerce.getPaymentSources()`
- `Clerk.commerce.billing`
 - `Clerk.commerce.billing.getPlans()`
 - `Clerk.commerce.billing.getSubscriptions()`
 - `Clerk.commerce.billing.getInvoices()`
 - `Clerk.commerce.billing.startCheckout()`
## Manage payment methods
- `Clerk.[user|organization].initializePaymentSource()`
- `Clerk.[user|organization].addPaymentSource()`
- `Clerk.[user|organization].getPaymentSources()`

## Billing namespace
- `Clerk.billing`
 - `Clerk.billing.getPlans()`
 - `Clerk.billing.getSubscriptions()`
 - `Clerk.billing.getInvoices()`
 - `Clerk.billing.startCheckout()`

14 changes: 7 additions & 7 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,7 @@ import type {
 ClerkOptions,
 ClientJSONSnapshot,
 ClientResource,
CommerceNamespace,
CommerceBillingNamespace,
 CreateOrganizationParams,
 CreateOrganizationProps,
 CredentialReturn,
Expand DownExpand Up@@ -131,7 +131,7 @@ import { eventBus, events } from './events';
import type { FapiClient, FapiRequestCallback } from './fapiClient';
import { createFapiClient } from './fapiClient';
import { createClientFromJwt } from './jwt-client';
import { Commerce } from './modules/commerce';
import { CommerceBilling } from './modules/commerce';
import {
 BaseResource,
 Client,
Expand DownExpand Up@@ -187,7 +187,7 @@ export class Clerk implements ClerkInterface {
 version: __PKG_VERSION__,
 environment: process.env.NODE_ENV || 'production',
 };
 private static _commerce: CommerceNamespace;
 private static _billing: CommerceBillingNamespace;

 public client: ClientResource | undefined;
 public session: SignedInSessionResource | null | undefined;
Expand DownExpand Up@@ -316,11 +316,11 @@ export class Clerk implements ClerkInterface {
 return this.#options.standardBrowser || false;
 }

 get commerce(): CommerceNamespace {
 if (!Clerk._commerce) {
 Clerk._commerce = new Commerce();
 get billing(): CommerceBillingNamespace {
 if (!Clerk._billing) {
 Clerk._billing = new CommerceBilling();
 }
 return Clerk._commerce;
 return Clerk._billing;
 }

 public __internal_getOption<K extends keyof ClerkOptions>(key: K): ClerkOptions[K] {
Expand Down

69 changes: 0 additions & 69 deletions
packages/clerk-js/src/core/modules/commerce/Commerce.ts

View file


Open in desktop


This file was deleted.


2 changes: 1 addition & 1 deletion
packages/clerk-js/src/core/modules/commerce/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
export * from './Commerce';
export * from './CommerceBilling';
export * from './payment-source-methods';

55 changes: 55 additions & 0 deletions
packages/clerk-js/src/core/modules/commerce/payment-source-methods.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
import type {
 AddPaymentSourceParams,
 ClerkPaginatedResponse,
 CommerceInitializedPaymentSourceJSON,
 CommercePaymentSourceJSON,
 GetPaymentSourcesParams,
 InitializePaymentSourceParams,
} from '@clerk/types';

import { convertPageToOffsetSearchParams } from '../../../utils/convertPageToOffsetSearchParams';
import { BaseResource, CommerceInitializedPaymentSource, CommercePaymentSource } from '../../resources/internal';

export const initializePaymentSource = async (params: InitializePaymentSourceParams) => {
 const { orgId, ...rest } = params;
 const json = (
 await BaseResource._fetch({
 path: orgId
 ? `/organizations/${orgId}/commerce/payment_sources/initialize`
 : `/me/commerce/payment_sources/initialize`,
 method: 'POST',
 body: rest as any,
 })
 )?.response as unknown as CommerceInitializedPaymentSourceJSON;
 return new CommerceInitializedPaymentSource(json);
};

export const addPaymentSource = async (params: AddPaymentSourceParams) => {
 const { orgId, ...rest } = params;

 const json = (
 await BaseResource._fetch({
 path: orgId ? `/organizations/${orgId}/commerce/payment_sources` : `/me/commerce/payment_sources`,
 method: 'POST',
 body: rest as any,
 })
 )?.response as unknown as CommercePaymentSourceJSON;
 return new CommercePaymentSource(json);
};

export const getPaymentSources = async (params: GetPaymentSourcesParams) => {
 const { orgId, ...rest } = params;

 return await BaseResource._fetch({
 path: orgId ? `/organizations/${orgId}/commerce/payment_sources` : `/me/commerce/payment_sources`,
 method: 'GET',
 search: convertPageToOffsetSearchParams(rest),
 }).then(res => {
 const { data: paymentSources, total_count } =
 res?.response as unknown as ClerkPaginatedResponse<CommercePaymentSourceJSON>;
 return {
 total_count,
 data: paymentSources.map(paymentSource => new CommercePaymentSource(paymentSource)),
 };
 });
};

22 changes: 22 additions & 0 deletions
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ import type {

import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
import { unixEpochToDate } from '../../utils/date';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BaseResource, CommerceSubscription, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
Expand DownExpand Up@@ -282,6 +283,27 @@ export class Organization extends BaseResource implements OrganizationResource {
 }).then(res => new Organization(res?.response as OrganizationJSON));
 };

 initializePaymentSource: typeof initializePaymentSource = params => {
 return initializePaymentSource({
 ...params,
 orgId: this.id,
 });
 };

 addPaymentSource: typeof addPaymentSource = params => {
 return addPaymentSource({
 ...params,
 orgId: this.id,
 });
 };

 getPaymentSources: typeof getPaymentSources = params => {
 return getPaymentSources({
 ...params,
 orgId: this.id,
 });
 };

 protected fromJSON(data: OrganizationJSON | OrganizationJSONSnapshot | null): this {
 if (!data) {
 return this;
Expand Down

13 changes: 13 additions & 0 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,7 @@ import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { eventBus, events } from '../events';
import { addPaymentSource, getPaymentSources, initializePaymentSource } from '../modules/commerce';
import { BackupCode } from './BackupCode';
import {
 BaseResource,
Expand DownExpand Up@@ -290,6 +291,18 @@ export class User extends BaseResource implements UserResource {
 return new DeletedObject(json);
 };

 initializePaymentSource: typeof initializePaymentSource = params => {
 return initializePaymentSource(params);
 };

 addPaymentSource: typeof addPaymentSource = params => {
 return addPaymentSource(params);
 };

 getPaymentSources: typeof getPaymentSources = params => {
 return getPaymentSources(params);
 };

 get verifiedExternalAccounts() {
 return this.externalAccounts.filter(externalAccount => externalAccount.verification?.status == 'verified');
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/resources/__tests__/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
exports[`Organization has the same initial properties 1`] = `
Organization {
 "addMember": [Function],
 "addPaymentSource": [Function],
 "adminDeleteEnabled": true,
 "createDomain": [Function],
 "createdAt": 1970-01-01T00:00:12.345Z,
Expand All@@ -12,11 +13,13 @@ Organization {
 "getInvitations": [Function],
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPaymentSources": [Function],
 "getRoles": [Function],
 "getSubscriptions": [Function],
 "hasImage": true,
 "id": "test_id",
 "imageUrl": "https://img.clerk.com/eyJ0eXBlIjoiZGVmYXVsdCIsImlpZCI6Imluc18xbHlXRFppb2JyNjAwQUtVZVFEb1NsckVtb00iLCJyaWQiOiJ1c2VyXzJKbElJQTN2VXNjWXh1N2VUMnhINmFrTGgxOCIsImluaXRpYWxzIjoiREsifQ?width=160",
 "initializePaymentSource": [Function],
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "maxAllowedMemberships": 3,
Expand Down

3 changes: 3 additions & 0 deletions
...s/clerk-js/src/core/resources/__tests__/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ OrganizationMembership {
 "id": "test_id",
 "organization": Organization {
 "addMember": [Function],
 "addPaymentSource": [Function],
 "adminDeleteEnabled": true,
 "createDomain": [Function],
 "createdAt": 1970-01-01T00:00:12.345Z,
Expand All@@ -16,11 +17,13 @@ OrganizationMembership {
 "getInvitations": [Function],
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPaymentSources": [Function],
 "getRoles": [Function],
 "getSubscriptions": [Function],
 "hasImage": true,
 "id": "test_org_id",
 "imageUrl": "https://img.clerk.com/eyJ0eXBlIjoiZGVmYXVsdCIsImlpZCI6Imluc18xbHlXRFppb2JyNjAwQUtVZVFEb1NsckVtb00iLCJyaWQiOiJ1c2VyXzJKbElJQTN2VXNjWXh1N2VUMnhINmFrTGgxOCIsImluaXRpYWxzIjoiREsifQ?width=160",
 "initializePaymentSource": [Function],
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "maxAllowedMemberships": 3,
Expand Down

14 changes: 5 additions & 9 deletions
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk, useOrganization, useUser } from '@clerk/shared/react';
import { useOrganization } from '@clerk/shared/react';
import type {
 ClerkAPIError,
 ClerkRuntimeError,
Expand DownExpand Up@@ -114,22 +114,18 @@ const CheckoutFormElements = ({
 checkout: CommerceCheckoutResource;
 onCheckoutComplete: (checkout: CommerceCheckoutResource) => void;
}) => {
 const { commerce } = useClerk();
 const { user } = useUser();
 const { organization } = useOrganization();
 const { subscriberType } = useCheckoutContext();
 const { subscriber, subscriberType } = useCheckoutContext();

 const [paymentMethodSource, setPaymentMethodSource] = useState<PaymentMethodSource>('existing');
 const [isSubmitting, setIsSubmitting] = useState(false);
 const [submitError, setSubmitError] = useState<ClerkRuntimeError | ClerkAPIError | string | undefined>();

 const { data, revalidate: revalidatePaymentSources } = useFetch(
 commerce?.getPaymentSources,
 {
 ...(subscriberType === 'org' ? { orgId: organization?.id } : {}),
 },
 subscriber().getPaymentSources,
 {},
 undefined,
 `commerce-payment-sources-${user?.id}`,
 `commerce-payment-sources-${subscriber().id}`,
 );
 const { data: paymentSources } = data || { data: [] };

Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/components/PaymentSources/AddPaymentSource.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,12 +37,13 @@ export const AddPaymentSource = (props: AddPaymentSourceProps) => {
 onPayWithTestPaymentSourceSuccess,
 showPayWithTestCardSection,
 } = props;
 const { commerce } = useClerk();
 const { commerceSettings } = useEnvironment();
 const { organization } = useOrganization();
 const { user } = useUser();
 const subscriberType = useSubscriberTypeContext();

 const resource = subscriberType === 'org' ? organization : user;

 const stripePromiseRef = useRef<Promise<Stripe | null> | null>(null);
 const [stripe, setStripe] = useState<Stripe | null>(null);

Expand DownExpand Up@@ -73,13 +74,12 @@ export const AddPaymentSource = (props: AddPaymentSourceProps) => {
 invalidate,
 revalidate: revalidateInitializedPaymentSource,
 } = useFetch(
commerce.initializePaymentSource,
resource?.initializePaymentSource,
 {
 gateway: 'stripe',
 ...(subscriberType === 'org' ? { orgId: organization?.id } : {}),
 },
 undefined,
 `commerce-payment-source-initialize-${user?.id}`,
 `commerce-payment-source-initialize-${resource?.id}`,
 );

 const externalGatewayId = initializedPaymentSource?.externalGatewayId;
Expand Down
Loading