Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/backend-external-account-id.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Add an optional `externalAccountId` to the backend `ExternalAccount` resource. For Google and Facebook accounts the resource `id` is the `idn_`-prefixed identification id, which `users.deleteUserExternalAccount()` rejects; `externalAccountId` now exposes the `eac_`-prefixed id those calls expect. For all other providers `id` is already the `eac_` id and `externalAccountId` is `undefined`, so use `externalAccountId ?? id` to get an id you can delete with.
6 changes: 6 additions & 0 deletions packages/backend/src/api/__tests__/factory.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,12 @@ describe('api.client', () => {
expect(response.emailAddresses[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.phoneNumbers[0].phoneNumber).toBe('+311-555-2368');
expect(response.externalAccounts[0].emailAddress).toBe('john.doe@clerk.test');
// Google/Facebook: `id` is the `idn_` identification id and `externalAccountId` carries the `eac_` id.
expect(response.externalAccounts[0].id).toBe('idn_2abcGoogleIdentification00000');
expect(response.externalAccounts[0].externalAccountId).toBe('eac_2abcGoogleExternalAccount0000');
// Other providers: `id` is already the `eac_` id and `externalAccountId` is absent.
expect(response.externalAccounts[1].id).toBe('eac_2defGithubExternalAccount0000');
expect(response.externalAccounts[1].externalAccountId).toBeUndefined();
expect(response.enterpriseAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].provider).toBe('saml_okta');
expect(response.enterpriseAccounts[0].enterpriseConnection?.name).toBe('Okta SSO');
Expand Down
8 changes: 8 additions & 0 deletions packages/backend/src/api/resources/ExternalAccount.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,13 @@ export class ExternalAccount {
* An object holding information on the verification of this external account.
*/
readonly verification: Verification | null,
/**
* The `eac_`-prefixed id of the external account resource, which is the id
* `users.deleteUserExternalAccount()` expects. Only returned for Google and
* Facebook accounts; for other providers it is `undefined` and `id` already
* holds the `eac_` value. Use `externalAccountId ?? id` to get a deletable id.
*/
readonly externalAccountId?: string,
) {}

static fromJSON(data: ExternalAccountJSON): ExternalAccount {
Expand All@@ -88,6 +95,7 @@ export class ExternalAccount {
data.public_metadata,
data.label,
data.verification && Verification.fromJSON(data.verification),
data.external_account_id,
);
}
}
4 changes: 4 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,6 +231,10 @@ export interface EnterpriseAccountJSON extends ClerkResourceJSON {

export interface ExternalAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.ExternalAccount;
/**
* The `eac_`-prefixed external account id. Only present for Google and Facebook accounts.
*/
external_account_id?: string;
provider: string;
identification_id: string;
provider_user_id: string;
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import { describe, expect, it } from 'vitest';

import { ExternalAccount } from '../ExternalAccount';
import type { ExternalAccountJSON } from '../JSON';

describe('ExternalAccount', () => {
describe('fromJSON', () => {
const base = {
provider: 'oauth_google',
provider_user_id: '1029384756',
approved_scopes: 'email profile',
email_address: 'jane@example.com',
first_name: 'Jane',
last_name: 'Doe',
image_url: 'https://img.clerk.com/jane.png',
username: 'jane',
phone_number: null,
public_metadata: {},
label: null,
verification: null,
};

it('maps external_account_id to externalAccountId when present (Google/Facebook)', () => {
// Google/Facebook responses set `id` to the `idn_` identification id and add `external_account_id`.
const data = {
...base,
object: 'external_account',
id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
external_account_id: 'eac_2ABXLObDmeHsnLsLgOd5panvOPJ',
identification_id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
} as ExternalAccountJSON;

const externalAccount = ExternalAccount.fromJSON(data);

expect(externalAccount.externalAccountId).toBe('eac_2ABXLObDmeHsnLsLgOd5panvOPJ');
// `id` and `identificationId` keep the `idn_` value for these providers.
expect(externalAccount.id).toBe('idn_2ABXLLckIF5kLikvzAVRxuuN31M');
expect(externalAccount.identificationId).toBe('idn_2ABXLLckIF5kLikvzAVRxuuN31M');
});

it('leaves externalAccountId undefined for other providers, where id is already the eac_ id', () => {
// Other providers omit `external_account_id`; `id` already holds the `eac_` value.
const data = {
...base,
object: 'external_account',
provider: 'oauth_github',
id: 'eac_2ABXLObDmeHsnLsLgOd5panvOPJ',
identification_id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
} as ExternalAccountJSON;

const externalAccount = ExternalAccount.fromJSON(data);

expect(externalAccount.externalAccountId).toBeUndefined();
expect(externalAccount.id).toBe('eac_2ABXLObDmeHsnLsLgOd5panvOPJ');
});
});
});
26 changes: 23 additions & 3 deletions packages/backend/src/fixtures/user.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,10 +72,11 @@
],
"external_accounts": [
{
"object": "external_account",
"object": "google_account",
"provider": "google",
"id": "gac_google",
"identification_id": "1234567890",
"id": "idn_2abcGoogleIdentification00000",
"external_account_id": "eac_2abcGoogleExternalAccount0000",
"identification_id": "idn_2abcGoogleIdentification00000",
"provider_user_id": "1234567890",
"approved_scopes": "email https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile openid profile",
"email_address": "john.doe@clerk.test",
Expand All@@ -89,6 +90,25 @@
"verification": null,
"created_at": 1611948436,
"updated_at": 1611948436
},
{
"object": "external_account",
"provider": "github",
"id": "eac_2defGithubExternalAccount0000",
"identification_id": "idn_2defGithubIdentification00000",
"provider_user_id": "9876543210",
"approved_scopes": "read:user user:email",
"email_address": "john.doe@clerk.test",
"first_name": "John",
"last_name": "Doe",
"avatar_url": "https://clerk.com/test.jpg",
"username": "jdoe",
"phone_number": null,
"public_metadata": {},
"label": null,
"verification": null,
"created_at": 1611948436,
"updated_at": 1611948436
}
],
"enterprise_accounts": [
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(backend): expose externalAccountId on ExternalAccount resource by jacekradko · Pull Request #8995 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/backend-external-account-id.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Add an optional `externalAccountId` to the backend `ExternalAccount` resource. For Google and Facebook accounts the resource `id` is the `idn_`-prefixed identification id, which `users.deleteUserExternalAccount()` rejects; `externalAccountId` now exposes the `eac_`-prefixed id those calls expect. For all other providers `id` is already the `eac_` id and `externalAccountId` is `undefined`, so use `externalAccountId ?? id` to get an id you can delete with.
6 changes: 6 additions & 0 deletions packages/backend/src/api/__tests__/factory.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,12 @@ describe('api.client', () => {
expect(response.emailAddresses[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.phoneNumbers[0].phoneNumber).toBe('+311-555-2368');
expect(response.externalAccounts[0].emailAddress).toBe('john.doe@clerk.test');
// Google/Facebook: `id` is the `idn_` identification id and `externalAccountId` carries the `eac_` id.
expect(response.externalAccounts[0].id).toBe('idn_2abcGoogleIdentification00000');
expect(response.externalAccounts[0].externalAccountId).toBe('eac_2abcGoogleExternalAccount0000');
// Other providers: `id` is already the `eac_` id and `externalAccountId` is absent.
expect(response.externalAccounts[1].id).toBe('eac_2defGithubExternalAccount0000');
expect(response.externalAccounts[1].externalAccountId).toBeUndefined();
expect(response.enterpriseAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].provider).toBe('saml_okta');
expect(response.enterpriseAccounts[0].enterpriseConnection?.name).toBe('Okta SSO');
Expand Down
8 changes: 8 additions & 0 deletions packages/backend/src/api/resources/ExternalAccount.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,13 @@ export class ExternalAccount {
* An object holding information on the verification of this external account.
*/
readonly verification: Verification | null,
/**
* The `eac_`-prefixed id of the external account resource, which is the id
* `users.deleteUserExternalAccount()` expects. Only returned for Google and
* Facebook accounts; for other providers it is `undefined` and `id` already
* holds the `eac_` value. Use `externalAccountId ?? id` to get a deletable id.
*/
readonly externalAccountId?: string,
) {}

static fromJSON(data: ExternalAccountJSON): ExternalAccount {
Expand All@@ -88,6 +95,7 @@ export class ExternalAccount {
data.public_metadata,
data.label,
data.verification && Verification.fromJSON(data.verification),
data.external_account_id,
);
}
}
4 changes: 4 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,6 +231,10 @@ export interface EnterpriseAccountJSON extends ClerkResourceJSON {

export interface ExternalAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.ExternalAccount;
/**
* The `eac_`-prefixed external account id. Only present for Google and Facebook accounts.
*/
external_account_id?: string;
provider: string;
identification_id: string;
provider_user_id: string;
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import { describe, expect, it } from 'vitest';

import { ExternalAccount } from '../ExternalAccount';
import type { ExternalAccountJSON } from '../JSON';

describe('ExternalAccount', () => {
describe('fromJSON', () => {
const base = {
provider: 'oauth_google',
provider_user_id: '1029384756',
approved_scopes: 'email profile',
email_address: 'jane@example.com',
first_name: 'Jane',
last_name: 'Doe',
image_url: 'https://img.clerk.com/jane.png',
username: 'jane',
phone_number: null,
public_metadata: {},
label: null,
verification: null,
};

it('maps external_account_id to externalAccountId when present (Google/Facebook)', () => {
// Google/Facebook responses set `id` to the `idn_` identification id and add `external_account_id`.
const data = {
...base,
object: 'external_account',
id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
external_account_id: 'eac_2ABXLObDmeHsnLsLgOd5panvOPJ',
identification_id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
} as ExternalAccountJSON;

const externalAccount = ExternalAccount.fromJSON(data);

expect(externalAccount.externalAccountId).toBe('eac_2ABXLObDmeHsnLsLgOd5panvOPJ');
// `id` and `identificationId` keep the `idn_` value for these providers.
expect(externalAccount.id).toBe('idn_2ABXLLckIF5kLikvzAVRxuuN31M');
expect(externalAccount.identificationId).toBe('idn_2ABXLLckIF5kLikvzAVRxuuN31M');
});

it('leaves externalAccountId undefined for other providers, where id is already the eac_ id', () => {
// Other providers omit `external_account_id`; `id` already holds the `eac_` value.
const data = {
...base,
object: 'external_account',
provider: 'oauth_github',
id: 'eac_2ABXLObDmeHsnLsLgOd5panvOPJ',
identification_id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
} as ExternalAccountJSON;

const externalAccount = ExternalAccount.fromJSON(data);

expect(externalAccount.externalAccountId).toBeUndefined();
expect(externalAccount.id).toBe('eac_2ABXLObDmeHsnLsLgOd5panvOPJ');
});
});
});
26 changes: 23 additions & 3 deletions packages/backend/src/fixtures/user.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,10 +72,11 @@
],
"external_accounts": [
{
"object": "external_account",
"object": "google_account",
"provider": "google",
"id": "gac_google",
"identification_id": "1234567890",
"id": "idn_2abcGoogleIdentification00000",
"external_account_id": "eac_2abcGoogleExternalAccount0000",
"identification_id": "idn_2abcGoogleIdentification00000",
"provider_user_id": "1234567890",
"approved_scopes": "email https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile openid profile",
"email_address": "john.doe@clerk.test",
Expand All@@ -89,6 +90,25 @@
"verification": null,
"created_at": 1611948436,
"updated_at": 1611948436
},
{
"object": "external_account",
"provider": "github",
"id": "eac_2defGithubExternalAccount0000",
"identification_id": "idn_2defGithubIdentification00000",
"provider_user_id": "9876543210",
"approved_scopes": "read:user user:email",
"email_address": "john.doe@clerk.test",
"first_name": "John",
"last_name": "Doe",
"avatar_url": "https://clerk.com/test.jpg",
"username": "jdoe",
"phone_number": null,
"public_metadata": {},
"label": null,
"verification": null,
"created_at": 1611948436,
"updated_at": 1611948436
}
],
"enterprise_accounts": [
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(backend): expose externalAccountId on ExternalAccount resource by jacekradko · Pull Request #8995 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/backend-external-account-id.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Add an optional `externalAccountId` to the backend `ExternalAccount` resource. For Google and Facebook accounts the resource `id` is the `idn_`-prefixed identification id, which `users.deleteUserExternalAccount()` rejects; `externalAccountId` now exposes the `eac_`-prefixed id those calls expect. For all other providers `id` is already the `eac_` id and `externalAccountId` is `undefined`, so use `externalAccountId ?? id` to get an id you can delete with.
6 changes: 6 additions & 0 deletions packages/backend/src/api/__tests__/factory.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,12 @@ describe('api.client', () => {
expect(response.emailAddresses[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.phoneNumbers[0].phoneNumber).toBe('+311-555-2368');
expect(response.externalAccounts[0].emailAddress).toBe('john.doe@clerk.test');
// Google/Facebook: `id` is the `idn_` identification id and `externalAccountId` carries the `eac_` id.
expect(response.externalAccounts[0].id).toBe('idn_2abcGoogleIdentification00000');
expect(response.externalAccounts[0].externalAccountId).toBe('eac_2abcGoogleExternalAccount0000');
// Other providers: `id` is already the `eac_` id and `externalAccountId` is absent.
expect(response.externalAccounts[1].id).toBe('eac_2defGithubExternalAccount0000');
expect(response.externalAccounts[1].externalAccountId).toBeUndefined();
expect(response.enterpriseAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].provider).toBe('saml_okta');
expect(response.enterpriseAccounts[0].enterpriseConnection?.name).toBe('Okta SSO');
Expand Down
8 changes: 8 additions & 0 deletions packages/backend/src/api/resources/ExternalAccount.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,13 @@ export class ExternalAccount {
* An object holding information on the verification of this external account.
*/
readonly verification: Verification | null,
/**
* The `eac_`-prefixed id of the external account resource, which is the id
* `users.deleteUserExternalAccount()` expects. Only returned for Google and
* Facebook accounts; for other providers it is `undefined` and `id` already
* holds the `eac_` value. Use `externalAccountId ?? id` to get a deletable id.
*/
readonly externalAccountId?: string,
) {}

static fromJSON(data: ExternalAccountJSON): ExternalAccount {
Expand All@@ -88,6 +95,7 @@ export class ExternalAccount {
data.public_metadata,
data.label,
data.verification && Verification.fromJSON(data.verification),
data.external_account_id,
);
}
}
4 changes: 4 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,6 +231,10 @@ export interface EnterpriseAccountJSON extends ClerkResourceJSON {

export interface ExternalAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.ExternalAccount;
/**
* The `eac_`-prefixed external account id. Only present for Google and Facebook accounts.
*/
external_account_id?: string;
provider: string;
identification_id: string;
provider_user_id: string;
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import { describe, expect, it } from 'vitest';

import { ExternalAccount } from '../ExternalAccount';
import type { ExternalAccountJSON } from '../JSON';

describe('ExternalAccount', () => {
describe('fromJSON', () => {
const base = {
provider: 'oauth_google',
provider_user_id: '1029384756',
approved_scopes: 'email profile',
email_address: 'jane@example.com',
first_name: 'Jane',
last_name: 'Doe',
image_url: 'https://img.clerk.com/jane.png',
username: 'jane',
phone_number: null,
public_metadata: {},
label: null,
verification: null,
};

it('maps external_account_id to externalAccountId when present (Google/Facebook)', () => {
// Google/Facebook responses set `id` to the `idn_` identification id and add `external_account_id`.
const data = {
...base,
object: 'external_account',
id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
external_account_id: 'eac_2ABXLObDmeHsnLsLgOd5panvOPJ',
identification_id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
} as ExternalAccountJSON;

const externalAccount = ExternalAccount.fromJSON(data);

expect(externalAccount.externalAccountId).toBe('eac_2ABXLObDmeHsnLsLgOd5panvOPJ');
// `id` and `identificationId` keep the `idn_` value for these providers.
expect(externalAccount.id).toBe('idn_2ABXLLckIF5kLikvzAVRxuuN31M');
expect(externalAccount.identificationId).toBe('idn_2ABXLLckIF5kLikvzAVRxuuN31M');
});

it('leaves externalAccountId undefined for other providers, where id is already the eac_ id', () => {
// Other providers omit `external_account_id`; `id` already holds the `eac_` value.
const data = {
...base,
object: 'external_account',
provider: 'oauth_github',
id: 'eac_2ABXLObDmeHsnLsLgOd5panvOPJ',
identification_id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
} as ExternalAccountJSON;

const externalAccount = ExternalAccount.fromJSON(data);

expect(externalAccount.externalAccountId).toBeUndefined();
expect(externalAccount.id).toBe('eac_2ABXLObDmeHsnLsLgOd5panvOPJ');
});
});
});
26 changes: 23 additions & 3 deletions packages/backend/src/fixtures/user.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,10 +72,11 @@
],
"external_accounts": [
{
"object": "external_account",
"object": "google_account",
"provider": "google",
"id": "gac_google",
"identification_id": "1234567890",
"id": "idn_2abcGoogleIdentification00000",
"external_account_id": "eac_2abcGoogleExternalAccount0000",
"identification_id": "idn_2abcGoogleIdentification00000",
"provider_user_id": "1234567890",
"approved_scopes": "email https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile openid profile",
"email_address": "john.doe@clerk.test",
Expand All@@ -89,6 +90,25 @@
"verification": null,
"created_at": 1611948436,
"updated_at": 1611948436
},
{
"object": "external_account",
"provider": "github",
"id": "eac_2defGithubExternalAccount0000",
"identification_id": "idn_2defGithubIdentification00000",
"provider_user_id": "9876543210",
"approved_scopes": "read:user user:email",
"email_address": "john.doe@clerk.test",
"first_name": "John",
"last_name": "Doe",
"avatar_url": "https://clerk.com/test.jpg",
"username": "jdoe",
"phone_number": null,
"public_metadata": {},
"label": null,
"verification": null,
"created_at": 1611948436,
"updated_at": 1611948436
}
],
"enterprise_accounts": [
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(backend): expose externalAccountId on ExternalAccount resource by jacekradko · Pull Request #8995 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/backend-external-account-id.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Add an optional `externalAccountId` to the backend `ExternalAccount` resource. For Google and Facebook accounts the resource `id` is the `idn_`-prefixed identification id, which `users.deleteUserExternalAccount()` rejects; `externalAccountId` now exposes the `eac_`-prefixed id those calls expect. For all other providers `id` is already the `eac_` id and `externalAccountId` is `undefined`, so use `externalAccountId ?? id` to get an id you can delete with.
6 changes: 6 additions & 0 deletions packages/backend/src/api/__tests__/factory.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,12 @@ describe('api.client', () => {
expect(response.emailAddresses[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.phoneNumbers[0].phoneNumber).toBe('+311-555-2368');
expect(response.externalAccounts[0].emailAddress).toBe('john.doe@clerk.test');
// Google/Facebook: `id` is the `idn_` identification id and `externalAccountId` carries the `eac_` id.
expect(response.externalAccounts[0].id).toBe('idn_2abcGoogleIdentification00000');
expect(response.externalAccounts[0].externalAccountId).toBe('eac_2abcGoogleExternalAccount0000');
// Other providers: `id` is already the `eac_` id and `externalAccountId` is absent.
expect(response.externalAccounts[1].id).toBe('eac_2defGithubExternalAccount0000');
expect(response.externalAccounts[1].externalAccountId).toBeUndefined();
expect(response.enterpriseAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].provider).toBe('saml_okta');
expect(response.enterpriseAccounts[0].enterpriseConnection?.name).toBe('Okta SSO');
Expand Down
8 changes: 8 additions & 0 deletions packages/backend/src/api/resources/ExternalAccount.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,13 @@ export class ExternalAccount {
* An object holding information on the verification of this external account.
*/
readonly verification: Verification | null,
/**
* The `eac_`-prefixed id of the external account resource, which is the id
* `users.deleteUserExternalAccount()` expects. Only returned for Google and
* Facebook accounts; for other providers it is `undefined` and `id` already
* holds the `eac_` value. Use `externalAccountId ?? id` to get a deletable id.
*/
readonly externalAccountId?: string,
) {}

static fromJSON(data: ExternalAccountJSON): ExternalAccount {
Expand All@@ -88,6 +95,7 @@ export class ExternalAccount {
data.public_metadata,
data.label,
data.verification && Verification.fromJSON(data.verification),
data.external_account_id,
);
}
}
4 changes: 4 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,6 +231,10 @@ export interface EnterpriseAccountJSON extends ClerkResourceJSON {

export interface ExternalAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.ExternalAccount;
/**
* The `eac_`-prefixed external account id. Only present for Google and Facebook accounts.
*/
external_account_id?: string;
provider: string;
identification_id: string;
provider_user_id: string;
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import { describe, expect, it } from 'vitest';

import { ExternalAccount } from '../ExternalAccount';
import type { ExternalAccountJSON } from '../JSON';

describe('ExternalAccount', () => {
describe('fromJSON', () => {
const base = {
provider: 'oauth_google',
provider_user_id: '1029384756',
approved_scopes: 'email profile',
email_address: 'jane@example.com',
first_name: 'Jane',
last_name: 'Doe',
image_url: 'https://img.clerk.com/jane.png',
username: 'jane',
phone_number: null,
public_metadata: {},
label: null,
verification: null,
};

it('maps external_account_id to externalAccountId when present (Google/Facebook)', () => {
// Google/Facebook responses set `id` to the `idn_` identification id and add `external_account_id`.
const data = {
...base,
object: 'external_account',
id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
external_account_id: 'eac_2ABXLObDmeHsnLsLgOd5panvOPJ',
identification_id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
} as ExternalAccountJSON;

const externalAccount = ExternalAccount.fromJSON(data);

expect(externalAccount.externalAccountId).toBe('eac_2ABXLObDmeHsnLsLgOd5panvOPJ');
// `id` and `identificationId` keep the `idn_` value for these providers.
expect(externalAccount.id).toBe('idn_2ABXLLckIF5kLikvzAVRxuuN31M');
expect(externalAccount.identificationId).toBe('idn_2ABXLLckIF5kLikvzAVRxuuN31M');
});

it('leaves externalAccountId undefined for other providers, where id is already the eac_ id', () => {
// Other providers omit `external_account_id`; `id` already holds the `eac_` value.
const data = {
...base,
object: 'external_account',
provider: 'oauth_github',
id: 'eac_2ABXLObDmeHsnLsLgOd5panvOPJ',
identification_id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
} as ExternalAccountJSON;

const externalAccount = ExternalAccount.fromJSON(data);

expect(externalAccount.externalAccountId).toBeUndefined();
expect(externalAccount.id).toBe('eac_2ABXLObDmeHsnLsLgOd5panvOPJ');
});
});
});
26 changes: 23 additions & 3 deletions packages/backend/src/fixtures/user.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,10 +72,11 @@
],
"external_accounts": [
{
"object": "external_account",
"object": "google_account",
"provider": "google",
"id": "gac_google",
"identification_id": "1234567890",
"id": "idn_2abcGoogleIdentification00000",
"external_account_id": "eac_2abcGoogleExternalAccount0000",
"identification_id": "idn_2abcGoogleIdentification00000",
"provider_user_id": "1234567890",
"approved_scopes": "email https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile openid profile",
"email_address": "john.doe@clerk.test",
Expand All@@ -89,6 +90,25 @@
"verification": null,
"created_at": 1611948436,
"updated_at": 1611948436
},
{
"object": "external_account",
"provider": "github",
"id": "eac_2defGithubExternalAccount0000",
"identification_id": "idn_2defGithubIdentification00000",
"provider_user_id": "9876543210",
"approved_scopes": "read:user user:email",
"email_address": "john.doe@clerk.test",
"first_name": "John",
"last_name": "Doe",
"avatar_url": "https://clerk.com/test.jpg",
"username": "jdoe",
"phone_number": null,
"public_metadata": {},
"label": null,
"verification": null,
"created_at": 1611948436,
"updated_at": 1611948436
}
],
"enterprise_accounts": [
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' fix(backend): expose externalAccountId on ExternalAccount resource by jacekradko · Pull Request #8995 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/backend-external-account-id.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Add an optional `externalAccountId` to the backend `ExternalAccount` resource. For Google and Facebook accounts the resource `id` is the `idn_`-prefixed identification id, which `users.deleteUserExternalAccount()` rejects; `externalAccountId` now exposes the `eac_`-prefixed id those calls expect. For all other providers `id` is already the `eac_` id and `externalAccountId` is `undefined`, so use `externalAccountId ?? id` to get an id you can delete with.
6 changes: 6 additions & 0 deletions packages/backend/src/api/__tests__/factory.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,12 @@ describe('api.client', () => {
expect(response.emailAddresses[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.phoneNumbers[0].phoneNumber).toBe('+311-555-2368');
expect(response.externalAccounts[0].emailAddress).toBe('john.doe@clerk.test');
// Google/Facebook: `id` is the `idn_` identification id and `externalAccountId` carries the `eac_` id.
expect(response.externalAccounts[0].id).toBe('idn_2abcGoogleIdentification00000');
expect(response.externalAccounts[0].externalAccountId).toBe('eac_2abcGoogleExternalAccount0000');
// Other providers: `id` is already the `eac_` id and `externalAccountId` is absent.
expect(response.externalAccounts[1].id).toBe('eac_2defGithubExternalAccount0000');
expect(response.externalAccounts[1].externalAccountId).toBeUndefined();
expect(response.enterpriseAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].provider).toBe('saml_okta');
expect(response.enterpriseAccounts[0].enterpriseConnection?.name).toBe('Okta SSO');
Expand Down
8 changes: 8 additions & 0 deletions packages/backend/src/api/resources/ExternalAccount.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,13 @@ export class ExternalAccount {
* An object holding information on the verification of this external account.
*/
readonly verification: Verification | null,
/**
* The `eac_`-prefixed id of the external account resource, which is the id
* `users.deleteUserExternalAccount()` expects. Only returned for Google and
* Facebook accounts; for other providers it is `undefined` and `id` already
* holds the `eac_` value. Use `externalAccountId ?? id` to get a deletable id.
*/
readonly externalAccountId?: string,
) {}

static fromJSON(data: ExternalAccountJSON): ExternalAccount {
Expand All@@ -88,6 +95,7 @@ export class ExternalAccount {
data.public_metadata,
data.label,
data.verification && Verification.fromJSON(data.verification),
data.external_account_id,
);
}
}
4 changes: 4 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,6 +231,10 @@ export interface EnterpriseAccountJSON extends ClerkResourceJSON {

export interface ExternalAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.ExternalAccount;
/**
* The `eac_`-prefixed external account id. Only present for Google and Facebook accounts.
*/
external_account_id?: string;
provider: string;
identification_id: string;
provider_user_id: string;
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import { describe, expect, it } from 'vitest';

import { ExternalAccount } from '../ExternalAccount';
import type { ExternalAccountJSON } from '../JSON';

describe('ExternalAccount', () => {
describe('fromJSON', () => {
const base = {
provider: 'oauth_google',
provider_user_id: '1029384756',
approved_scopes: 'email profile',
email_address: 'jane@example.com',
first_name: 'Jane',
last_name: 'Doe',
image_url: 'https://img.clerk.com/jane.png',
username: 'jane',
phone_number: null,
public_metadata: {},
label: null,
verification: null,
};

it('maps external_account_id to externalAccountId when present (Google/Facebook)', () => {
// Google/Facebook responses set `id` to the `idn_` identification id and add `external_account_id`.
const data = {
...base,
object: 'external_account',
id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
external_account_id: 'eac_2ABXLObDmeHsnLsLgOd5panvOPJ',
identification_id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
} as ExternalAccountJSON;

const externalAccount = ExternalAccount.fromJSON(data);

expect(externalAccount.externalAccountId).toBe('eac_2ABXLObDmeHsnLsLgOd5panvOPJ');
// `id` and `identificationId` keep the `idn_` value for these providers.
expect(externalAccount.id).toBe('idn_2ABXLLckIF5kLikvzAVRxuuN31M');
expect(externalAccount.identificationId).toBe('idn_2ABXLLckIF5kLikvzAVRxuuN31M');
});

it('leaves externalAccountId undefined for other providers, where id is already the eac_ id', () => {
// Other providers omit `external_account_id`; `id` already holds the `eac_` value.
const data = {
...base,
object: 'external_account',
provider: 'oauth_github',
id: 'eac_2ABXLObDmeHsnLsLgOd5panvOPJ',
identification_id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
} as ExternalAccountJSON;

const externalAccount = ExternalAccount.fromJSON(data);

expect(externalAccount.externalAccountId).toBeUndefined();
expect(externalAccount.id).toBe('eac_2ABXLObDmeHsnLsLgOd5panvOPJ');
});
});
});
26 changes: 23 additions & 3 deletions packages/backend/src/fixtures/user.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,10 +72,11 @@
],
"external_accounts": [
{
"object": "external_account",
"object": "google_account",
"provider": "google",
"id": "gac_google",
"identification_id": "1234567890",
"id": "idn_2abcGoogleIdentification00000",
"external_account_id": "eac_2abcGoogleExternalAccount0000",
"identification_id": "idn_2abcGoogleIdentification00000",
"provider_user_id": "1234567890",
"approved_scopes": "email https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile openid profile",
"email_address": "john.doe@clerk.test",
Expand All@@ -89,6 +90,25 @@
"verification": null,
"created_at": 1611948436,
"updated_at": 1611948436
},
{
"object": "external_account",
"provider": "github",
"id": "eac_2defGithubExternalAccount0000",
"identification_id": "idn_2defGithubIdentification00000",
"provider_user_id": "9876543210",
"approved_scopes": "read:user user:email",
"email_address": "john.doe@clerk.test",
"first_name": "John",
"last_name": "Doe",
"avatar_url": "https://clerk.com/test.jpg",
"username": "jdoe",
"phone_number": null,
"public_metadata": {},
"label": null,
"verification": null,
"created_at": 1611948436,
"updated_at": 1611948436
}
],
"enterprise_accounts": [
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(backend): expose externalAccountId on ExternalAccount resource by jacekradko · Pull Request #8995 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/backend-external-account-id.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Add an optional `externalAccountId` to the backend `ExternalAccount` resource. For Google and Facebook accounts the resource `id` is the `idn_`-prefixed identification id, which `users.deleteUserExternalAccount()` rejects; `externalAccountId` now exposes the `eac_`-prefixed id those calls expect. For all other providers `id` is already the `eac_` id and `externalAccountId` is `undefined`, so use `externalAccountId ?? id` to get an id you can delete with.
6 changes: 6 additions & 0 deletions packages/backend/src/api/__tests__/factory.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,12 @@ describe('api.client', () => {
expect(response.emailAddresses[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.phoneNumbers[0].phoneNumber).toBe('+311-555-2368');
expect(response.externalAccounts[0].emailAddress).toBe('john.doe@clerk.test');
// Google/Facebook: `id` is the `idn_` identification id and `externalAccountId` carries the `eac_` id.
expect(response.externalAccounts[0].id).toBe('idn_2abcGoogleIdentification00000');
expect(response.externalAccounts[0].externalAccountId).toBe('eac_2abcGoogleExternalAccount0000');
// Other providers: `id` is already the `eac_` id and `externalAccountId` is absent.
expect(response.externalAccounts[1].id).toBe('eac_2defGithubExternalAccount0000');
expect(response.externalAccounts[1].externalAccountId).toBeUndefined();
expect(response.enterpriseAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].provider).toBe('saml_okta');
expect(response.enterpriseAccounts[0].enterpriseConnection?.name).toBe('Okta SSO');
Expand Down
8 changes: 8 additions & 0 deletions packages/backend/src/api/resources/ExternalAccount.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,13 @@ export class ExternalAccount {
* An object holding information on the verification of this external account.
*/
readonly verification: Verification | null,
/**
* The `eac_`-prefixed id of the external account resource, which is the id
* `users.deleteUserExternalAccount()` expects. Only returned for Google and
* Facebook accounts; for other providers it is `undefined` and `id` already
* holds the `eac_` value. Use `externalAccountId ?? id` to get a deletable id.
*/
readonly externalAccountId?: string,
) {}

static fromJSON(data: ExternalAccountJSON): ExternalAccount {
Expand All@@ -88,6 +95,7 @@ export class ExternalAccount {
data.public_metadata,
data.label,
data.verification && Verification.fromJSON(data.verification),
data.external_account_id,
);
}
}
4 changes: 4 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,6 +231,10 @@ export interface EnterpriseAccountJSON extends ClerkResourceJSON {

export interface ExternalAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.ExternalAccount;
/**
* The `eac_`-prefixed external account id. Only present for Google and Facebook accounts.
*/
external_account_id?: string;
provider: string;
identification_id: string;
provider_user_id: string;
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import { describe, expect, it } from 'vitest';

import { ExternalAccount } from '../ExternalAccount';
import type { ExternalAccountJSON } from '../JSON';

describe('ExternalAccount', () => {
describe('fromJSON', () => {
const base = {
provider: 'oauth_google',
provider_user_id: '1029384756',
approved_scopes: 'email profile',
email_address: 'jane@example.com',
first_name: 'Jane',
last_name: 'Doe',
image_url: 'https://img.clerk.com/jane.png',
username: 'jane',
phone_number: null,
public_metadata: {},
label: null,
verification: null,
};

it('maps external_account_id to externalAccountId when present (Google/Facebook)', () => {
// Google/Facebook responses set `id` to the `idn_` identification id and add `external_account_id`.
const data = {
...base,
object: 'external_account',
id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
external_account_id: 'eac_2ABXLObDmeHsnLsLgOd5panvOPJ',
identification_id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
} as ExternalAccountJSON;

const externalAccount = ExternalAccount.fromJSON(data);

expect(externalAccount.externalAccountId).toBe('eac_2ABXLObDmeHsnLsLgOd5panvOPJ');
// `id` and `identificationId` keep the `idn_` value for these providers.
expect(externalAccount.id).toBe('idn_2ABXLLckIF5kLikvzAVRxuuN31M');
expect(externalAccount.identificationId).toBe('idn_2ABXLLckIF5kLikvzAVRxuuN31M');
});

it('leaves externalAccountId undefined for other providers, where id is already the eac_ id', () => {
// Other providers omit `external_account_id`; `id` already holds the `eac_` value.
const data = {
...base,
object: 'external_account',
provider: 'oauth_github',
id: 'eac_2ABXLObDmeHsnLsLgOd5panvOPJ',
identification_id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
} as ExternalAccountJSON;

const externalAccount = ExternalAccount.fromJSON(data);

expect(externalAccount.externalAccountId).toBeUndefined();
expect(externalAccount.id).toBe('eac_2ABXLObDmeHsnLsLgOd5panvOPJ');
});
});
});
26 changes: 23 additions & 3 deletions packages/backend/src/fixtures/user.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,10 +72,11 @@
],
"external_accounts": [
{
"object": "external_account",
"object": "google_account",
"provider": "google",
"id": "gac_google",
"identification_id": "1234567890",
"id": "idn_2abcGoogleIdentification00000",
"external_account_id": "eac_2abcGoogleExternalAccount0000",
"identification_id": "idn_2abcGoogleIdentification00000",
"provider_user_id": "1234567890",
"approved_scopes": "email https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile openid profile",
"email_address": "john.doe@clerk.test",
Expand All@@ -89,6 +90,25 @@
"verification": null,
"created_at": 1611948436,
"updated_at": 1611948436
},
{
"object": "external_account",
"provider": "github",
"id": "eac_2defGithubExternalAccount0000",
"identification_id": "idn_2defGithubIdentification00000",
"provider_user_id": "9876543210",
"approved_scopes": "read:user user:email",
"email_address": "john.doe@clerk.test",
"first_name": "John",
"last_name": "Doe",
"avatar_url": "https://clerk.com/test.jpg",
"username": "jdoe",
"phone_number": null,
"public_metadata": {},
"label": null,
"verification": null,
"created_at": 1611948436,
"updated_at": 1611948436
}
],
"enterprise_accounts": [
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(backend): expose externalAccountId on ExternalAccount resource by jacekradko · Pull Request #8995 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/backend-external-account-id.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Add an optional `externalAccountId` to the backend `ExternalAccount` resource. For Google and Facebook accounts the resource `id` is the `idn_`-prefixed identification id, which `users.deleteUserExternalAccount()` rejects; `externalAccountId` now exposes the `eac_`-prefixed id those calls expect. For all other providers `id` is already the `eac_` id and `externalAccountId` is `undefined`, so use `externalAccountId ?? id` to get an id you can delete with.
6 changes: 6 additions & 0 deletions packages/backend/src/api/__tests__/factory.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,12 @@ describe('api.client', () => {
expect(response.emailAddresses[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.phoneNumbers[0].phoneNumber).toBe('+311-555-2368');
expect(response.externalAccounts[0].emailAddress).toBe('john.doe@clerk.test');
// Google/Facebook: `id` is the `idn_` identification id and `externalAccountId` carries the `eac_` id.
expect(response.externalAccounts[0].id).toBe('idn_2abcGoogleIdentification00000');
expect(response.externalAccounts[0].externalAccountId).toBe('eac_2abcGoogleExternalAccount0000');
// Other providers: `id` is already the `eac_` id and `externalAccountId` is absent.
expect(response.externalAccounts[1].id).toBe('eac_2defGithubExternalAccount0000');
expect(response.externalAccounts[1].externalAccountId).toBeUndefined();
expect(response.enterpriseAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].provider).toBe('saml_okta');
expect(response.enterpriseAccounts[0].enterpriseConnection?.name).toBe('Okta SSO');
Expand Down
8 changes: 8 additions & 0 deletions packages/backend/src/api/resources/ExternalAccount.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,13 @@ export class ExternalAccount {
* An object holding information on the verification of this external account.
*/
readonly verification: Verification | null,
/**
* The `eac_`-prefixed id of the external account resource, which is the id
* `users.deleteUserExternalAccount()` expects. Only returned for Google and
* Facebook accounts; for other providers it is `undefined` and `id` already
* holds the `eac_` value. Use `externalAccountId ?? id` to get a deletable id.
*/
readonly externalAccountId?: string,
) {}

static fromJSON(data: ExternalAccountJSON): ExternalAccount {
Expand All@@ -88,6 +95,7 @@ export class ExternalAccount {
data.public_metadata,
data.label,
data.verification && Verification.fromJSON(data.verification),
data.external_account_id,
);
}
}
4 changes: 4 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,6 +231,10 @@ export interface EnterpriseAccountJSON extends ClerkResourceJSON {

export interface ExternalAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.ExternalAccount;
/**
* The `eac_`-prefixed external account id. Only present for Google and Facebook accounts.
*/
external_account_id?: string;
provider: string;
identification_id: string;
provider_user_id: string;
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import { describe, expect, it } from 'vitest';

import { ExternalAccount } from '../ExternalAccount';
import type { ExternalAccountJSON } from '../JSON';

describe('ExternalAccount', () => {
describe('fromJSON', () => {
const base = {
provider: 'oauth_google',
provider_user_id: '1029384756',
approved_scopes: 'email profile',
email_address: 'jane@example.com',
first_name: 'Jane',
last_name: 'Doe',
image_url: 'https://img.clerk.com/jane.png',
username: 'jane',
phone_number: null,
public_metadata: {},
label: null,
verification: null,
};

it('maps external_account_id to externalAccountId when present (Google/Facebook)', () => {
// Google/Facebook responses set `id` to the `idn_` identification id and add `external_account_id`.
const data = {
...base,
object: 'external_account',
id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
external_account_id: 'eac_2ABXLObDmeHsnLsLgOd5panvOPJ',
identification_id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
} as ExternalAccountJSON;

const externalAccount = ExternalAccount.fromJSON(data);

expect(externalAccount.externalAccountId).toBe('eac_2ABXLObDmeHsnLsLgOd5panvOPJ');
// `id` and `identificationId` keep the `idn_` value for these providers.
expect(externalAccount.id).toBe('idn_2ABXLLckIF5kLikvzAVRxuuN31M');
expect(externalAccount.identificationId).toBe('idn_2ABXLLckIF5kLikvzAVRxuuN31M');
});

it('leaves externalAccountId undefined for other providers, where id is already the eac_ id', () => {
// Other providers omit `external_account_id`; `id` already holds the `eac_` value.
const data = {
...base,
object: 'external_account',
provider: 'oauth_github',
id: 'eac_2ABXLObDmeHsnLsLgOd5panvOPJ',
identification_id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
} as ExternalAccountJSON;

const externalAccount = ExternalAccount.fromJSON(data);

expect(externalAccount.externalAccountId).toBeUndefined();
expect(externalAccount.id).toBe('eac_2ABXLObDmeHsnLsLgOd5panvOPJ');
});
});
});
26 changes: 23 additions & 3 deletions packages/backend/src/fixtures/user.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,10 +72,11 @@
],
"external_accounts": [
{
"object": "external_account",
"object": "google_account",
"provider": "google",
"id": "gac_google",
"identification_id": "1234567890",
"id": "idn_2abcGoogleIdentification00000",
"external_account_id": "eac_2abcGoogleExternalAccount0000",
"identification_id": "idn_2abcGoogleIdentification00000",
"provider_user_id": "1234567890",
"approved_scopes": "email https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile openid profile",
"email_address": "john.doe@clerk.test",
Expand All@@ -89,6 +90,25 @@
"verification": null,
"created_at": 1611948436,
"updated_at": 1611948436
},
{
"object": "external_account",
"provider": "github",
"id": "eac_2defGithubExternalAccount0000",
"identification_id": "idn_2defGithubIdentification00000",
"provider_user_id": "9876543210",
"approved_scopes": "read:user user:email",
"email_address": "john.doe@clerk.test",
"first_name": "John",
"last_name": "Doe",
"avatar_url": "https://clerk.com/test.jpg",
"username": "jdoe",
"phone_number": null,
"public_metadata": {},
"label": null,
"verification": null,
"created_at": 1611948436,
"updated_at": 1611948436
}
],
"enterprise_accounts": [
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); fix(backend): expose externalAccountId on ExternalAccount resource by jacekradko · Pull Request #8995 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/backend-external-account-id.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Add an optional `externalAccountId` to the backend `ExternalAccount` resource. For Google and Facebook accounts the resource `id` is the `idn_`-prefixed identification id, which `users.deleteUserExternalAccount()` rejects; `externalAccountId` now exposes the `eac_`-prefixed id those calls expect. For all other providers `id` is already the `eac_` id and `externalAccountId` is `undefined`, so use `externalAccountId ?? id` to get an id you can delete with.
6 changes: 6 additions & 0 deletions packages/backend/src/api/__tests__/factory.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,12 @@ describe('api.client', () => {
expect(response.emailAddresses[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.phoneNumbers[0].phoneNumber).toBe('+311-555-2368');
expect(response.externalAccounts[0].emailAddress).toBe('john.doe@clerk.test');
// Google/Facebook: `id` is the `idn_` identification id and `externalAccountId` carries the `eac_` id.
expect(response.externalAccounts[0].id).toBe('idn_2abcGoogleIdentification00000');
expect(response.externalAccounts[0].externalAccountId).toBe('eac_2abcGoogleExternalAccount0000');
// Other providers: `id` is already the `eac_` id and `externalAccountId` is absent.
expect(response.externalAccounts[1].id).toBe('eac_2defGithubExternalAccount0000');
expect(response.externalAccounts[1].externalAccountId).toBeUndefined();
expect(response.enterpriseAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].provider).toBe('saml_okta');
expect(response.enterpriseAccounts[0].enterpriseConnection?.name).toBe('Okta SSO');
Expand Down
8 changes: 8 additions & 0 deletions packages/backend/src/api/resources/ExternalAccount.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,13 @@ export class ExternalAccount {
* An object holding information on the verification of this external account.
*/
readonly verification: Verification | null,
/**
* The `eac_`-prefixed id of the external account resource, which is the id
* `users.deleteUserExternalAccount()` expects. Only returned for Google and
* Facebook accounts; for other providers it is `undefined` and `id` already
* holds the `eac_` value. Use `externalAccountId ?? id` to get a deletable id.
*/
readonly externalAccountId?: string,
) {}

static fromJSON(data: ExternalAccountJSON): ExternalAccount {
Expand All@@ -88,6 +95,7 @@ export class ExternalAccount {
data.public_metadata,
data.label,
data.verification && Verification.fromJSON(data.verification),
data.external_account_id,
);
}
}
4 changes: 4 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,6 +231,10 @@ export interface EnterpriseAccountJSON extends ClerkResourceJSON {

export interface ExternalAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.ExternalAccount;
/**
* The `eac_`-prefixed external account id. Only present for Google and Facebook accounts.
*/
external_account_id?: string;
provider: string;
identification_id: string;
provider_user_id: string;
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import { describe, expect, it } from 'vitest';

import { ExternalAccount } from '../ExternalAccount';
import type { ExternalAccountJSON } from '../JSON';

describe('ExternalAccount', () => {
describe('fromJSON', () => {
const base = {
provider: 'oauth_google',
provider_user_id: '1029384756',
approved_scopes: 'email profile',
email_address: 'jane@example.com',
first_name: 'Jane',
last_name: 'Doe',
image_url: 'https://img.clerk.com/jane.png',
username: 'jane',
phone_number: null,
public_metadata: {},
label: null,
verification: null,
};

it('maps external_account_id to externalAccountId when present (Google/Facebook)', () => {
// Google/Facebook responses set `id` to the `idn_` identification id and add `external_account_id`.
const data = {
...base,
object: 'external_account',
id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
external_account_id: 'eac_2ABXLObDmeHsnLsLgOd5panvOPJ',
identification_id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
} as ExternalAccountJSON;

const externalAccount = ExternalAccount.fromJSON(data);

expect(externalAccount.externalAccountId).toBe('eac_2ABXLObDmeHsnLsLgOd5panvOPJ');
// `id` and `identificationId` keep the `idn_` value for these providers.
expect(externalAccount.id).toBe('idn_2ABXLLckIF5kLikvzAVRxuuN31M');
expect(externalAccount.identificationId).toBe('idn_2ABXLLckIF5kLikvzAVRxuuN31M');
});

it('leaves externalAccountId undefined for other providers, where id is already the eac_ id', () => {
// Other providers omit `external_account_id`; `id` already holds the `eac_` value.
const data = {
...base,
object: 'external_account',
provider: 'oauth_github',
id: 'eac_2ABXLObDmeHsnLsLgOd5panvOPJ',
identification_id: 'idn_2ABXLLckIF5kLikvzAVRxuuN31M',
} as ExternalAccountJSON;

const externalAccount = ExternalAccount.fromJSON(data);

expect(externalAccount.externalAccountId).toBeUndefined();
expect(externalAccount.id).toBe('eac_2ABXLObDmeHsnLsLgOd5panvOPJ');
});
});
});
26 changes: 23 additions & 3 deletions packages/backend/src/fixtures/user.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,10 +72,11 @@
],
"external_accounts": [
{
"object": "external_account",
"object": "google_account",
"provider": "google",
"id": "gac_google",
"identification_id": "1234567890",
"id": "idn_2abcGoogleIdentification00000",
"external_account_id": "eac_2abcGoogleExternalAccount0000",
"identification_id": "idn_2abcGoogleIdentification00000",
"provider_user_id": "1234567890",
"approved_scopes": "email https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile openid profile",
"email_address": "john.doe@clerk.test",
Expand All@@ -89,6 +90,25 @@
"verification": null,
"created_at": 1611948436,
"updated_at": 1611948436
},
{
"object": "external_account",
"provider": "github",
"id": "eac_2defGithubExternalAccount0000",
"identification_id": "idn_2defGithubIdentification00000",
"provider_user_id": "9876543210",
"approved_scopes": "read:user user:email",
"email_address": "john.doe@clerk.test",
"first_name": "John",
"last_name": "Doe",
"avatar_url": "https://clerk.com/test.jpg",
"username": "jdoe",
"phone_number": null,
"public_metadata": {},
"label": null,
"verification": null,
"created_at": 1611948436,
"updated_at": 1611948436
}
],
"enterprise_accounts": [
Expand Down
Loading