Skip to content
Merged
32 changes: 31 additions & 1 deletion packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,13 @@ import type {
Clerk as ClerkInterface,
ClerkOptions,
ClientResource,
CreateOrganizationInvitationParams,
CreateOrganizationParams,
EnvironmentResource,
HandleMagicLinkVerificationParams,
HandleOAuthCallbackParams,
ListenerCallback,
OrganizationResource,
RedirectOptions,
Resources,
SignInProps,
Expand DownExpand Up@@ -61,6 +64,8 @@ import {
Environment,
MagicLinkError,
MagicLinkErrorCode,
Organization,
OrganizationInvitation,
} from './resources/internal';

export type ClerkCoreBroadcastChannelEvent = { type: 'signout' };
Expand DownExpand Up@@ -296,7 +301,7 @@ export default class Clerk implements ClerkInterface {
if (this.#unloading) {
return;
}
this.session = session;
this.session = session;
this.user = this.session ? this.session.user : null;

this.#emit();
Expand DownExpand Up@@ -573,6 +578,24 @@ export default class Clerk implements ClerkInterface {
}
};

public createOrganization = async ({
name,
}: CreateOrganizationParams): Promise<OrganizationResource> => {
return await Organization.create(name);
};

public getOrganizations = async (): Promise<OrganizationResource[]> => {
return await Organization.retrieve();
};

public getOrganization = async (
organizationId: string,
): Promise<OrganizationResource | undefined> => {
return (await Organization.retrieve()).find(
org => org.id === organizationId,
);
};

updateClient = (newClient: ClientResource): void => {
if (!this.client) {
// This is the first time client is being
Expand DownExpand Up@@ -609,6 +632,13 @@ export default class Clerk implements ClerkInterface {
this.#fapiClient.onAfterResponse(callback);
}

__unstable_inviteMember = async (

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@igneel64 Can you please elaborate why do we consider this an unstable method at this point?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❓ A follow up question, does this method invite a member or creates an org? Something seems to be missing.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@SokratisVidros , thanks for the comment.

The use of the __unstable prefix is intended here. Currently we cannot expose methods on clerk-react from internal clerk-js resources. The only way this can be done is through the Clerk interface.
The same interface though is exposed globally. That means that adding a method there, it is also exposed in window.Clerk.methodName.
Since adding methods indiscriminately on the global Clerk object is not the optimal outcome, for now we are adding to those methods the __unstable prefix to prevent misuse.

(Also this method just invites a member on an organization. The organizations can be retrieved from the useOrganizations hook.)

organizationId: string,
params: CreateOrganizationInvitationParams,
) => {
return await OrganizationInvitation.create(organizationId, params);
};

#loadInBrowser = async (): Promise<void> => {
this.#authService = new AuthenticationService(this);

Expand Down
18 changes: 18 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import { Organization } from 'core/resources/internal';

describe('Organization', () => {
it('has the same initial properties', () => {
const organization = new Organization({
object: 'organization',
id: 'test_id',
name: 'test_name',
role: 'basic_member',
created_at: 12345,
updated_at: 5678,
created_by: 'test_user_id',
instance_id: 'test_instance_id',
});

expect(organization).toMatchSnapshot();
});
});
140 changes: 140 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
import type {
GetMembersParams,
MembershipRole,
OrganizationInvitationJSON,
OrganizationJSON,
OrganizationMembershipJSON,
OrganizationResource,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

import {
BaseResource,
OrganizationInvitation,
OrganizationMembership,
} from './internal';

export class Organization extends BaseResource implements OrganizationResource {
id!: string;
name!: string;
role!: MembershipRole;
instanceId!: string;
createdBy!: string;
createdAt!: Date;
updatedAt!: Date;

constructor(data: OrganizationJSON) {
super();
this.fromJSON(data);
}

static async create(name: string): Promise<OrganizationResource> {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

❓ IIRC, all resources use the this.basePost | this.baseGet | ... methods that retrieve a json and return the instantiated resource. Why did we decide to use the static BaseResource._fetch here?

To be honest, I'm not a huge fan of the this.basePost approach, but if we don't have any specific reasons to do otherwise, I think it'd be better to remain consistent and tackle them all at once in a different PR

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@nikosdouvlis
Discussed offline.

const json = (
await BaseResource._fetch<OrganizationJSON>({
path: '/organizations',
method: 'POST',
body: { name } as any,
})
)?.response as unknown as OrganizationJSON;

return new Organization(json);
}

static async retrieve(
getOrganizationParams?: GetOrganizationParams,
): Promise<Organization[]> {
return await BaseResource._fetch({
path: '/me/organizations',
method: 'GET',
search: getOrganizationParams as any,
})
.then(res => {
const organizationsJSON =
res?.response as unknown as OrganizationJSON[];
return organizationsJSON.map(org => new Organization(org));
})
.catch(() => []);
}

getMembers = async (
getMemberParams?: GetMembersParams,
): Promise<OrganizationMembership[]> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/memberships`,
method: 'GET',
search: getMemberParams as any,
})
.then(res => {
const members =
res?.response as unknown as OrganizationMembershipJSON[];
return members.map(member => new OrganizationMembership(member));
})
.catch(() => []);
};

getPendingInvitations = async (): Promise<OrganizationInvitation[]> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/invitations/pending`,
method: 'GET',
})
.then(res => {
const pendingInvitations =
res?.response as unknown as OrganizationInvitationJSON[];
return pendingInvitations.map(
pendingInvitation => new OrganizationInvitation(pendingInvitation),
);
})
.catch(() => []);
};

inviteUser = async (inviteUserParams: InviteUserParams) => {
return await OrganizationInvitation.create(this.id, inviteUserParams);
};

updateMember = async ({
userId,
role,
}: UpdateMembershipParams): Promise<OrganizationMembership> => {
return await BaseResource._fetch({
method: 'PATCH',
path: `/organizations/${this.id}/memberships/${userId}`,
body: { role } as any,
}).then(
res =>
new OrganizationMembership(res?.response as OrganizationMembershipJSON),
);
};

removeMember = async (userId: string) => {
return await this._baseDelete({
path: `/organizations/${this.id}/memberships/${userId}`,
});
};

protected fromJSON(data: OrganizationJSON): this {
this.id = data.id;
this.name = data.name;
this.role = data.role;
this.instanceId = data.instance_id;
this.createdBy = data.created_by;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}

export type GetOrganizationParams = {
limit?: number;
offset?: number;
};

export type InviteUserParams = {
emailAddress: string;
role: MembershipRole;
redirectUrl?: string;
};

export type UpdateMembershipParams = {
userId: string;
role: MembershipRole;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import { OrganizationInvitation } from 'core/resources/internal';

describe('OrganizationInvitation', () => {
it('has the same initial properties', () => {
const organizationInvitation = new OrganizationInvitation({
object: 'organization_invitation',
email_address: 'test_email',
id: 'test_id',
organization_id: 'test_organization_id',
role: 'basic_member',
created_at: 12345,
updated_at: 5678,
status: 'pending',
});

expect(organizationInvitation).toMatchSnapshot();
});
});
69 changes: 69 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationInvitation.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import {
MembershipRole,
OrganizationInvitationJSON,
OrganizationInvitationResource,
OrganizationInvitationStatus,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

import { BaseResource } from './internal';

export class OrganizationInvitation
extends BaseResource
implements OrganizationInvitationResource
{
id!: string;
emailAddress!: string;
organizationId!: string;
status!: OrganizationInvitationStatus;
role!: MembershipRole;
createdAt!: Date;
updatedAt!: Date;

static async create(
organizationId: string,
{ emailAddress, role, redirectUrl }: CreateOrganizationInvitationParams,
): Promise<OrganizationInvitationResource> {
const json = (
await BaseResource._fetch<OrganizationInvitationJSON>({
path: `/organizations/${organizationId}/invitations`,
method: 'POST',
body: {
email_address: emailAddress,
role,
redirect_url: redirectUrl,
} as any,
})
)?.response as unknown as OrganizationInvitationJSON;

return new OrganizationInvitation(json);
}

constructor(data: OrganizationInvitationJSON) {
super();
this.fromJSON(data);
}

revoke = async () => {
return await this._basePost({
path: `/organizations/${this.organizationId}/invitations/${this.id}/revoke`,
});
};

protected fromJSON(data: OrganizationInvitationJSON): this {
this.id = data.id;
this.emailAddress = data.email_address;
this.organizationId = data.organization_id;
this.role = data.role;
this.status = data.status;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}

export type CreateOrganizationInvitationParams = {
emailAddress: string;
role: MembershipRole;
redirectUrl?: string;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import { OrganizationMembership } from 'core/resources/internal';

describe('OrganizationMembership', () => {
it('has the same initial properties', () => {
const organizationMemberShip = new OrganizationMembership({
object: 'organization_membership',
id: 'test_id',
created_at: 12345,
updated_at: 5678,
role: 'admin',
public_user_data: {
object: 'public_user_data',
first_name: 'test_first_name',
last_name: 'test_last_name',
profile_image_url: 'test_url',
identifier: 'test@identifier.gr',
id: 'test_user_id',
},
});

expect(organizationMemberShip).toMatchSnapshot();
});
});
34 changes: 34 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationMembership.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
import {
MembershipRole,
OrganizationMembershipJSON,
OrganizationMembershipResource,
PublicUserData,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

export class OrganizationMembership implements OrganizationMembershipResource {
id!: string;
publicUserData!: PublicUserData;
role!: MembershipRole;
createdAt!: Date;
updatedAt!: Date;

constructor(data: OrganizationMembershipJSON) {
this.fromJSON(data);
}

protected fromJSON(data: OrganizationMembershipJSON): this {
this.id = data.id;
this.publicUserData = {
firstName: data.public_user_data.first_name,
lastName: data.public_user_data.last_name,
profileImageUrl: data.public_user_data.profile_image_url,
identifier: data.public_user_data.identifier,
userId: data.public_user_data.user_id,
};
this.role = data.role;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}
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" + '
feat(clerk-js): Add organization basic resources by igneel64 · Pull Request #57 · clerk/javascript · GitHub
Skip to content
Merged
32 changes: 31 additions & 1 deletion packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,13 @@ import type {
Clerk as ClerkInterface,
ClerkOptions,
ClientResource,
CreateOrganizationInvitationParams,
CreateOrganizationParams,
EnvironmentResource,
HandleMagicLinkVerificationParams,
HandleOAuthCallbackParams,
ListenerCallback,
OrganizationResource,
RedirectOptions,
Resources,
SignInProps,
Expand DownExpand Up@@ -61,6 +64,8 @@ import {
Environment,
MagicLinkError,
MagicLinkErrorCode,
Organization,
OrganizationInvitation,
} from './resources/internal';

export type ClerkCoreBroadcastChannelEvent = { type: 'signout' };
Expand DownExpand Up@@ -296,7 +301,7 @@ export default class Clerk implements ClerkInterface {
if (this.#unloading) {
return;
}
this.session = session;
this.session = session;
this.user = this.session ? this.session.user : null;

this.#emit();
Expand DownExpand Up@@ -573,6 +578,24 @@ export default class Clerk implements ClerkInterface {
}
};

public createOrganization = async ({
name,
}: CreateOrganizationParams): Promise<OrganizationResource> => {
return await Organization.create(name);
};

public getOrganizations = async (): Promise<OrganizationResource[]> => {
return await Organization.retrieve();
};

public getOrganization = async (
organizationId: string,
): Promise<OrganizationResource | undefined> => {
return (await Organization.retrieve()).find(
org => org.id === organizationId,
);
};

updateClient = (newClient: ClientResource): void => {
if (!this.client) {
// This is the first time client is being
Expand DownExpand Up@@ -609,6 +632,13 @@ export default class Clerk implements ClerkInterface {
this.#fapiClient.onAfterResponse(callback);
}

__unstable_inviteMember = async (

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@igneel64 Can you please elaborate why do we consider this an unstable method at this point?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❓ A follow up question, does this method invite a member or creates an org? Something seems to be missing.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@SokratisVidros , thanks for the comment.

The use of the __unstable prefix is intended here. Currently we cannot expose methods on clerk-react from internal clerk-js resources. The only way this can be done is through the Clerk interface.
The same interface though is exposed globally. That means that adding a method there, it is also exposed in window.Clerk.methodName.
Since adding methods indiscriminately on the global Clerk object is not the optimal outcome, for now we are adding to those methods the __unstable prefix to prevent misuse.

(Also this method just invites a member on an organization. The organizations can be retrieved from the useOrganizations hook.)

organizationId: string,
params: CreateOrganizationInvitationParams,
) => {
return await OrganizationInvitation.create(organizationId, params);
};

#loadInBrowser = async (): Promise<void> => {
this.#authService = new AuthenticationService(this);

Expand Down
18 changes: 18 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import { Organization } from 'core/resources/internal';

describe('Organization', () => {
it('has the same initial properties', () => {
const organization = new Organization({
object: 'organization',
id: 'test_id',
name: 'test_name',
role: 'basic_member',
created_at: 12345,
updated_at: 5678,
created_by: 'test_user_id',
instance_id: 'test_instance_id',
});

expect(organization).toMatchSnapshot();
});
});
140 changes: 140 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
import type {
GetMembersParams,
MembershipRole,
OrganizationInvitationJSON,
OrganizationJSON,
OrganizationMembershipJSON,
OrganizationResource,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

import {
BaseResource,
OrganizationInvitation,
OrganizationMembership,
} from './internal';

export class Organization extends BaseResource implements OrganizationResource {
id!: string;
name!: string;
role!: MembershipRole;
instanceId!: string;
createdBy!: string;
createdAt!: Date;
updatedAt!: Date;

constructor(data: OrganizationJSON) {
super();
this.fromJSON(data);
}

static async create(name: string): Promise<OrganizationResource> {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

❓ IIRC, all resources use the this.basePost | this.baseGet | ... methods that retrieve a json and return the instantiated resource. Why did we decide to use the static BaseResource._fetch here?

To be honest, I'm not a huge fan of the this.basePost approach, but if we don't have any specific reasons to do otherwise, I think it'd be better to remain consistent and tackle them all at once in a different PR

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@nikosdouvlis
Discussed offline.

const json = (
await BaseResource._fetch<OrganizationJSON>({
path: '/organizations',
method: 'POST',
body: { name } as any,
})
)?.response as unknown as OrganizationJSON;

return new Organization(json);
}

static async retrieve(
getOrganizationParams?: GetOrganizationParams,
): Promise<Organization[]> {
return await BaseResource._fetch({
path: '/me/organizations',
method: 'GET',
search: getOrganizationParams as any,
})
.then(res => {
const organizationsJSON =
res?.response as unknown as OrganizationJSON[];
return organizationsJSON.map(org => new Organization(org));
})
.catch(() => []);
}

getMembers = async (
getMemberParams?: GetMembersParams,
): Promise<OrganizationMembership[]> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/memberships`,
method: 'GET',
search: getMemberParams as any,
})
.then(res => {
const members =
res?.response as unknown as OrganizationMembershipJSON[];
return members.map(member => new OrganizationMembership(member));
})
.catch(() => []);
};

getPendingInvitations = async (): Promise<OrganizationInvitation[]> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/invitations/pending`,
method: 'GET',
})
.then(res => {
const pendingInvitations =
res?.response as unknown as OrganizationInvitationJSON[];
return pendingInvitations.map(
pendingInvitation => new OrganizationInvitation(pendingInvitation),
);
})
.catch(() => []);
};

inviteUser = async (inviteUserParams: InviteUserParams) => {
return await OrganizationInvitation.create(this.id, inviteUserParams);
};

updateMember = async ({
userId,
role,
}: UpdateMembershipParams): Promise<OrganizationMembership> => {
return await BaseResource._fetch({
method: 'PATCH',
path: `/organizations/${this.id}/memberships/${userId}`,
body: { role } as any,
}).then(
res =>
new OrganizationMembership(res?.response as OrganizationMembershipJSON),
);
};

removeMember = async (userId: string) => {
return await this._baseDelete({
path: `/organizations/${this.id}/memberships/${userId}`,
});
};

protected fromJSON(data: OrganizationJSON): this {
this.id = data.id;
this.name = data.name;
this.role = data.role;
this.instanceId = data.instance_id;
this.createdBy = data.created_by;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}

export type GetOrganizationParams = {
limit?: number;
offset?: number;
};

export type InviteUserParams = {
emailAddress: string;
role: MembershipRole;
redirectUrl?: string;
};

export type UpdateMembershipParams = {
userId: string;
role: MembershipRole;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import { OrganizationInvitation } from 'core/resources/internal';

describe('OrganizationInvitation', () => {
it('has the same initial properties', () => {
const organizationInvitation = new OrganizationInvitation({
object: 'organization_invitation',
email_address: 'test_email',
id: 'test_id',
organization_id: 'test_organization_id',
role: 'basic_member',
created_at: 12345,
updated_at: 5678,
status: 'pending',
});

expect(organizationInvitation).toMatchSnapshot();
});
});
69 changes: 69 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationInvitation.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import {
MembershipRole,
OrganizationInvitationJSON,
OrganizationInvitationResource,
OrganizationInvitationStatus,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

import { BaseResource } from './internal';

export class OrganizationInvitation
extends BaseResource
implements OrganizationInvitationResource
{
id!: string;
emailAddress!: string;
organizationId!: string;
status!: OrganizationInvitationStatus;
role!: MembershipRole;
createdAt!: Date;
updatedAt!: Date;

static async create(
organizationId: string,
{ emailAddress, role, redirectUrl }: CreateOrganizationInvitationParams,
): Promise<OrganizationInvitationResource> {
const json = (
await BaseResource._fetch<OrganizationInvitationJSON>({
path: `/organizations/${organizationId}/invitations`,
method: 'POST',
body: {
email_address: emailAddress,
role,
redirect_url: redirectUrl,
} as any,
})
)?.response as unknown as OrganizationInvitationJSON;

return new OrganizationInvitation(json);
}

constructor(data: OrganizationInvitationJSON) {
super();
this.fromJSON(data);
}

revoke = async () => {
return await this._basePost({
path: `/organizations/${this.organizationId}/invitations/${this.id}/revoke`,
});
};

protected fromJSON(data: OrganizationInvitationJSON): this {
this.id = data.id;
this.emailAddress = data.email_address;
this.organizationId = data.organization_id;
this.role = data.role;
this.status = data.status;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}

export type CreateOrganizationInvitationParams = {
emailAddress: string;
role: MembershipRole;
redirectUrl?: string;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import { OrganizationMembership } from 'core/resources/internal';

describe('OrganizationMembership', () => {
it('has the same initial properties', () => {
const organizationMemberShip = new OrganizationMembership({
object: 'organization_membership',
id: 'test_id',
created_at: 12345,
updated_at: 5678,
role: 'admin',
public_user_data: {
object: 'public_user_data',
first_name: 'test_first_name',
last_name: 'test_last_name',
profile_image_url: 'test_url',
identifier: 'test@identifier.gr',
id: 'test_user_id',
},
});

expect(organizationMemberShip).toMatchSnapshot();
});
});
34 changes: 34 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationMembership.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
import {
MembershipRole,
OrganizationMembershipJSON,
OrganizationMembershipResource,
PublicUserData,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

export class OrganizationMembership implements OrganizationMembershipResource {
id!: string;
publicUserData!: PublicUserData;
role!: MembershipRole;
createdAt!: Date;
updatedAt!: Date;

constructor(data: OrganizationMembershipJSON) {
this.fromJSON(data);
}

protected fromJSON(data: OrganizationMembershipJSON): this {
this.id = data.id;
this.publicUserData = {
firstName: data.public_user_data.first_name,
lastName: data.public_user_data.last_name,
profileImageUrl: data.public_user_data.profile_image_url,
identifier: data.public_user_data.identifier,
userId: data.public_user_data.user_id,
};
this.role = data.role;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}
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('^' + ".*" + ' feat(clerk-js): Add organization basic resources by igneel64 · Pull Request #57 · clerk/javascript · GitHub
Skip to content
Merged
32 changes: 31 additions & 1 deletion packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,13 @@ import type {
Clerk as ClerkInterface,
ClerkOptions,
ClientResource,
CreateOrganizationInvitationParams,
CreateOrganizationParams,
EnvironmentResource,
HandleMagicLinkVerificationParams,
HandleOAuthCallbackParams,
ListenerCallback,
OrganizationResource,
RedirectOptions,
Resources,
SignInProps,
Expand DownExpand Up@@ -61,6 +64,8 @@ import {
Environment,
MagicLinkError,
MagicLinkErrorCode,
Organization,
OrganizationInvitation,
} from './resources/internal';

export type ClerkCoreBroadcastChannelEvent = { type: 'signout' };
Expand DownExpand Up@@ -296,7 +301,7 @@ export default class Clerk implements ClerkInterface {
if (this.#unloading) {
return;
}
this.session = session;
this.session = session;
this.user = this.session ? this.session.user : null;

this.#emit();
Expand DownExpand Up@@ -573,6 +578,24 @@ export default class Clerk implements ClerkInterface {
}
};

public createOrganization = async ({
name,
}: CreateOrganizationParams): Promise<OrganizationResource> => {
return await Organization.create(name);
};

public getOrganizations = async (): Promise<OrganizationResource[]> => {
return await Organization.retrieve();
};

public getOrganization = async (
organizationId: string,
): Promise<OrganizationResource | undefined> => {
return (await Organization.retrieve()).find(
org => org.id === organizationId,
);
};

updateClient = (newClient: ClientResource): void => {
if (!this.client) {
// This is the first time client is being
Expand DownExpand Up@@ -609,6 +632,13 @@ export default class Clerk implements ClerkInterface {
this.#fapiClient.onAfterResponse(callback);
}

__unstable_inviteMember = async (

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@igneel64 Can you please elaborate why do we consider this an unstable method at this point?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❓ A follow up question, does this method invite a member or creates an org? Something seems to be missing.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@SokratisVidros , thanks for the comment.

The use of the __unstable prefix is intended here. Currently we cannot expose methods on clerk-react from internal clerk-js resources. The only way this can be done is through the Clerk interface.
The same interface though is exposed globally. That means that adding a method there, it is also exposed in window.Clerk.methodName.
Since adding methods indiscriminately on the global Clerk object is not the optimal outcome, for now we are adding to those methods the __unstable prefix to prevent misuse.

(Also this method just invites a member on an organization. The organizations can be retrieved from the useOrganizations hook.)

organizationId: string,
params: CreateOrganizationInvitationParams,
) => {
return await OrganizationInvitation.create(organizationId, params);
};

#loadInBrowser = async (): Promise<void> => {
this.#authService = new AuthenticationService(this);

Expand Down
18 changes: 18 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import { Organization } from 'core/resources/internal';

describe('Organization', () => {
it('has the same initial properties', () => {
const organization = new Organization({
object: 'organization',
id: 'test_id',
name: 'test_name',
role: 'basic_member',
created_at: 12345,
updated_at: 5678,
created_by: 'test_user_id',
instance_id: 'test_instance_id',
});

expect(organization).toMatchSnapshot();
});
});
140 changes: 140 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
import type {
GetMembersParams,
MembershipRole,
OrganizationInvitationJSON,
OrganizationJSON,
OrganizationMembershipJSON,
OrganizationResource,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

import {
BaseResource,
OrganizationInvitation,
OrganizationMembership,
} from './internal';

export class Organization extends BaseResource implements OrganizationResource {
id!: string;
name!: string;
role!: MembershipRole;
instanceId!: string;
createdBy!: string;
createdAt!: Date;
updatedAt!: Date;

constructor(data: OrganizationJSON) {
super();
this.fromJSON(data);
}

static async create(name: string): Promise<OrganizationResource> {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

❓ IIRC, all resources use the this.basePost | this.baseGet | ... methods that retrieve a json and return the instantiated resource. Why did we decide to use the static BaseResource._fetch here?

To be honest, I'm not a huge fan of the this.basePost approach, but if we don't have any specific reasons to do otherwise, I think it'd be better to remain consistent and tackle them all at once in a different PR

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@nikosdouvlis
Discussed offline.

const json = (
await BaseResource._fetch<OrganizationJSON>({
path: '/organizations',
method: 'POST',
body: { name } as any,
})
)?.response as unknown as OrganizationJSON;

return new Organization(json);
}

static async retrieve(
getOrganizationParams?: GetOrganizationParams,
): Promise<Organization[]> {
return await BaseResource._fetch({
path: '/me/organizations',
method: 'GET',
search: getOrganizationParams as any,
})
.then(res => {
const organizationsJSON =
res?.response as unknown as OrganizationJSON[];
return organizationsJSON.map(org => new Organization(org));
})
.catch(() => []);
}

getMembers = async (
getMemberParams?: GetMembersParams,
): Promise<OrganizationMembership[]> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/memberships`,
method: 'GET',
search: getMemberParams as any,
})
.then(res => {
const members =
res?.response as unknown as OrganizationMembershipJSON[];
return members.map(member => new OrganizationMembership(member));
})
.catch(() => []);
};

getPendingInvitations = async (): Promise<OrganizationInvitation[]> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/invitations/pending`,
method: 'GET',
})
.then(res => {
const pendingInvitations =
res?.response as unknown as OrganizationInvitationJSON[];
return pendingInvitations.map(
pendingInvitation => new OrganizationInvitation(pendingInvitation),
);
})
.catch(() => []);
};

inviteUser = async (inviteUserParams: InviteUserParams) => {
return await OrganizationInvitation.create(this.id, inviteUserParams);
};

updateMember = async ({
userId,
role,
}: UpdateMembershipParams): Promise<OrganizationMembership> => {
return await BaseResource._fetch({
method: 'PATCH',
path: `/organizations/${this.id}/memberships/${userId}`,
body: { role } as any,
}).then(
res =>
new OrganizationMembership(res?.response as OrganizationMembershipJSON),
);
};

removeMember = async (userId: string) => {
return await this._baseDelete({
path: `/organizations/${this.id}/memberships/${userId}`,
});
};

protected fromJSON(data: OrganizationJSON): this {
this.id = data.id;
this.name = data.name;
this.role = data.role;
this.instanceId = data.instance_id;
this.createdBy = data.created_by;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}

export type GetOrganizationParams = {
limit?: number;
offset?: number;
};

export type InviteUserParams = {
emailAddress: string;
role: MembershipRole;
redirectUrl?: string;
};

export type UpdateMembershipParams = {
userId: string;
role: MembershipRole;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import { OrganizationInvitation } from 'core/resources/internal';

describe('OrganizationInvitation', () => {
it('has the same initial properties', () => {
const organizationInvitation = new OrganizationInvitation({
object: 'organization_invitation',
email_address: 'test_email',
id: 'test_id',
organization_id: 'test_organization_id',
role: 'basic_member',
created_at: 12345,
updated_at: 5678,
status: 'pending',
});

expect(organizationInvitation).toMatchSnapshot();
});
});
69 changes: 69 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationInvitation.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import {
MembershipRole,
OrganizationInvitationJSON,
OrganizationInvitationResource,
OrganizationInvitationStatus,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

import { BaseResource } from './internal';

export class OrganizationInvitation
extends BaseResource
implements OrganizationInvitationResource
{
id!: string;
emailAddress!: string;
organizationId!: string;
status!: OrganizationInvitationStatus;
role!: MembershipRole;
createdAt!: Date;
updatedAt!: Date;

static async create(
organizationId: string,
{ emailAddress, role, redirectUrl }: CreateOrganizationInvitationParams,
): Promise<OrganizationInvitationResource> {
const json = (
await BaseResource._fetch<OrganizationInvitationJSON>({
path: `/organizations/${organizationId}/invitations`,
method: 'POST',
body: {
email_address: emailAddress,
role,
redirect_url: redirectUrl,
} as any,
})
)?.response as unknown as OrganizationInvitationJSON;

return new OrganizationInvitation(json);
}

constructor(data: OrganizationInvitationJSON) {
super();
this.fromJSON(data);
}

revoke = async () => {
return await this._basePost({
path: `/organizations/${this.organizationId}/invitations/${this.id}/revoke`,
});
};

protected fromJSON(data: OrganizationInvitationJSON): this {
this.id = data.id;
this.emailAddress = data.email_address;
this.organizationId = data.organization_id;
this.role = data.role;
this.status = data.status;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}

export type CreateOrganizationInvitationParams = {
emailAddress: string;
role: MembershipRole;
redirectUrl?: string;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import { OrganizationMembership } from 'core/resources/internal';

describe('OrganizationMembership', () => {
it('has the same initial properties', () => {
const organizationMemberShip = new OrganizationMembership({
object: 'organization_membership',
id: 'test_id',
created_at: 12345,
updated_at: 5678,
role: 'admin',
public_user_data: {
object: 'public_user_data',
first_name: 'test_first_name',
last_name: 'test_last_name',
profile_image_url: 'test_url',
identifier: 'test@identifier.gr',
id: 'test_user_id',
},
});

expect(organizationMemberShip).toMatchSnapshot();
});
});
34 changes: 34 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationMembership.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
import {
MembershipRole,
OrganizationMembershipJSON,
OrganizationMembershipResource,
PublicUserData,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

export class OrganizationMembership implements OrganizationMembershipResource {
id!: string;
publicUserData!: PublicUserData;
role!: MembershipRole;
createdAt!: Date;
updatedAt!: Date;

constructor(data: OrganizationMembershipJSON) {
this.fromJSON(data);
}

protected fromJSON(data: OrganizationMembershipJSON): this {
this.id = data.id;
this.publicUserData = {
firstName: data.public_user_data.first_name,
lastName: data.public_user_data.last_name,
profileImageUrl: data.public_user_data.profile_image_url,
identifier: data.public_user_data.identifier,
userId: data.public_user_data.user_id,
};
this.role = data.role;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}
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('^' + ".*" + ' feat(clerk-js): Add organization basic resources by igneel64 · Pull Request #57 · clerk/javascript · GitHub
Skip to content
Merged
32 changes: 31 additions & 1 deletion packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,13 @@ import type {
Clerk as ClerkInterface,
ClerkOptions,
ClientResource,
CreateOrganizationInvitationParams,
CreateOrganizationParams,
EnvironmentResource,
HandleMagicLinkVerificationParams,
HandleOAuthCallbackParams,
ListenerCallback,
OrganizationResource,
RedirectOptions,
Resources,
SignInProps,
Expand DownExpand Up@@ -61,6 +64,8 @@ import {
Environment,
MagicLinkError,
MagicLinkErrorCode,
Organization,
OrganizationInvitation,
} from './resources/internal';

export type ClerkCoreBroadcastChannelEvent = { type: 'signout' };
Expand DownExpand Up@@ -296,7 +301,7 @@ export default class Clerk implements ClerkInterface {
if (this.#unloading) {
return;
}
this.session = session;
this.session = session;
this.user = this.session ? this.session.user : null;

this.#emit();
Expand DownExpand Up@@ -573,6 +578,24 @@ export default class Clerk implements ClerkInterface {
}
};

public createOrganization = async ({
name,
}: CreateOrganizationParams): Promise<OrganizationResource> => {
return await Organization.create(name);
};

public getOrganizations = async (): Promise<OrganizationResource[]> => {
return await Organization.retrieve();
};

public getOrganization = async (
organizationId: string,
): Promise<OrganizationResource | undefined> => {
return (await Organization.retrieve()).find(
org => org.id === organizationId,
);
};

updateClient = (newClient: ClientResource): void => {
if (!this.client) {
// This is the first time client is being
Expand DownExpand Up@@ -609,6 +632,13 @@ export default class Clerk implements ClerkInterface {
this.#fapiClient.onAfterResponse(callback);
}

__unstable_inviteMember = async (

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@igneel64 Can you please elaborate why do we consider this an unstable method at this point?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❓ A follow up question, does this method invite a member or creates an org? Something seems to be missing.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@SokratisVidros , thanks for the comment.

The use of the __unstable prefix is intended here. Currently we cannot expose methods on clerk-react from internal clerk-js resources. The only way this can be done is through the Clerk interface.
The same interface though is exposed globally. That means that adding a method there, it is also exposed in window.Clerk.methodName.
Since adding methods indiscriminately on the global Clerk object is not the optimal outcome, for now we are adding to those methods the __unstable prefix to prevent misuse.

(Also this method just invites a member on an organization. The organizations can be retrieved from the useOrganizations hook.)

organizationId: string,
params: CreateOrganizationInvitationParams,
) => {
return await OrganizationInvitation.create(organizationId, params);
};

#loadInBrowser = async (): Promise<void> => {
this.#authService = new AuthenticationService(this);

Expand Down
18 changes: 18 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import { Organization } from 'core/resources/internal';

describe('Organization', () => {
it('has the same initial properties', () => {
const organization = new Organization({
object: 'organization',
id: 'test_id',
name: 'test_name',
role: 'basic_member',
created_at: 12345,
updated_at: 5678,
created_by: 'test_user_id',
instance_id: 'test_instance_id',
});

expect(organization).toMatchSnapshot();
});
});
140 changes: 140 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
import type {
GetMembersParams,
MembershipRole,
OrganizationInvitationJSON,
OrganizationJSON,
OrganizationMembershipJSON,
OrganizationResource,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

import {
BaseResource,
OrganizationInvitation,
OrganizationMembership,
} from './internal';

export class Organization extends BaseResource implements OrganizationResource {
id!: string;
name!: string;
role!: MembershipRole;
instanceId!: string;
createdBy!: string;
createdAt!: Date;
updatedAt!: Date;

constructor(data: OrganizationJSON) {
super();
this.fromJSON(data);
}

static async create(name: string): Promise<OrganizationResource> {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

❓ IIRC, all resources use the this.basePost | this.baseGet | ... methods that retrieve a json and return the instantiated resource. Why did we decide to use the static BaseResource._fetch here?

To be honest, I'm not a huge fan of the this.basePost approach, but if we don't have any specific reasons to do otherwise, I think it'd be better to remain consistent and tackle them all at once in a different PR

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@nikosdouvlis
Discussed offline.

const json = (
await BaseResource._fetch<OrganizationJSON>({
path: '/organizations',
method: 'POST',
body: { name } as any,
})
)?.response as unknown as OrganizationJSON;

return new Organization(json);
}

static async retrieve(
getOrganizationParams?: GetOrganizationParams,
): Promise<Organization[]> {
return await BaseResource._fetch({
path: '/me/organizations',
method: 'GET',
search: getOrganizationParams as any,
})
.then(res => {
const organizationsJSON =
res?.response as unknown as OrganizationJSON[];
return organizationsJSON.map(org => new Organization(org));
})
.catch(() => []);
}

getMembers = async (
getMemberParams?: GetMembersParams,
): Promise<OrganizationMembership[]> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/memberships`,
method: 'GET',
search: getMemberParams as any,
})
.then(res => {
const members =
res?.response as unknown as OrganizationMembershipJSON[];
return members.map(member => new OrganizationMembership(member));
})
.catch(() => []);
};

getPendingInvitations = async (): Promise<OrganizationInvitation[]> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/invitations/pending`,
method: 'GET',
})
.then(res => {
const pendingInvitations =
res?.response as unknown as OrganizationInvitationJSON[];
return pendingInvitations.map(
pendingInvitation => new OrganizationInvitation(pendingInvitation),
);
})
.catch(() => []);
};

inviteUser = async (inviteUserParams: InviteUserParams) => {
return await OrganizationInvitation.create(this.id, inviteUserParams);
};

updateMember = async ({
userId,
role,
}: UpdateMembershipParams): Promise<OrganizationMembership> => {
return await BaseResource._fetch({
method: 'PATCH',
path: `/organizations/${this.id}/memberships/${userId}`,
body: { role } as any,
}).then(
res =>
new OrganizationMembership(res?.response as OrganizationMembershipJSON),
);
};

removeMember = async (userId: string) => {
return await this._baseDelete({
path: `/organizations/${this.id}/memberships/${userId}`,
});
};

protected fromJSON(data: OrganizationJSON): this {
this.id = data.id;
this.name = data.name;
this.role = data.role;
this.instanceId = data.instance_id;
this.createdBy = data.created_by;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}

export type GetOrganizationParams = {
limit?: number;
offset?: number;
};

export type InviteUserParams = {
emailAddress: string;
role: MembershipRole;
redirectUrl?: string;
};

export type UpdateMembershipParams = {
userId: string;
role: MembershipRole;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import { OrganizationInvitation } from 'core/resources/internal';

describe('OrganizationInvitation', () => {
it('has the same initial properties', () => {
const organizationInvitation = new OrganizationInvitation({
object: 'organization_invitation',
email_address: 'test_email',
id: 'test_id',
organization_id: 'test_organization_id',
role: 'basic_member',
created_at: 12345,
updated_at: 5678,
status: 'pending',
});

expect(organizationInvitation).toMatchSnapshot();
});
});
69 changes: 69 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationInvitation.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import {
MembershipRole,
OrganizationInvitationJSON,
OrganizationInvitationResource,
OrganizationInvitationStatus,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

import { BaseResource } from './internal';

export class OrganizationInvitation
extends BaseResource
implements OrganizationInvitationResource
{
id!: string;
emailAddress!: string;
organizationId!: string;
status!: OrganizationInvitationStatus;
role!: MembershipRole;
createdAt!: Date;
updatedAt!: Date;

static async create(
organizationId: string,
{ emailAddress, role, redirectUrl }: CreateOrganizationInvitationParams,
): Promise<OrganizationInvitationResource> {
const json = (
await BaseResource._fetch<OrganizationInvitationJSON>({
path: `/organizations/${organizationId}/invitations`,
method: 'POST',
body: {
email_address: emailAddress,
role,
redirect_url: redirectUrl,
} as any,
})
)?.response as unknown as OrganizationInvitationJSON;

return new OrganizationInvitation(json);
}

constructor(data: OrganizationInvitationJSON) {
super();
this.fromJSON(data);
}

revoke = async () => {
return await this._basePost({
path: `/organizations/${this.organizationId}/invitations/${this.id}/revoke`,
});
};

protected fromJSON(data: OrganizationInvitationJSON): this {
this.id = data.id;
this.emailAddress = data.email_address;
this.organizationId = data.organization_id;
this.role = data.role;
this.status = data.status;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}

export type CreateOrganizationInvitationParams = {
emailAddress: string;
role: MembershipRole;
redirectUrl?: string;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import { OrganizationMembership } from 'core/resources/internal';

describe('OrganizationMembership', () => {
it('has the same initial properties', () => {
const organizationMemberShip = new OrganizationMembership({
object: 'organization_membership',
id: 'test_id',
created_at: 12345,
updated_at: 5678,
role: 'admin',
public_user_data: {
object: 'public_user_data',
first_name: 'test_first_name',
last_name: 'test_last_name',
profile_image_url: 'test_url',
identifier: 'test@identifier.gr',
id: 'test_user_id',
},
});

expect(organizationMemberShip).toMatchSnapshot();
});
});
34 changes: 34 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationMembership.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
import {
MembershipRole,
OrganizationMembershipJSON,
OrganizationMembershipResource,
PublicUserData,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

export class OrganizationMembership implements OrganizationMembershipResource {
id!: string;
publicUserData!: PublicUserData;
role!: MembershipRole;
createdAt!: Date;
updatedAt!: Date;

constructor(data: OrganizationMembershipJSON) {
this.fromJSON(data);
}

protected fromJSON(data: OrganizationMembershipJSON): this {
this.id = data.id;
this.publicUserData = {
firstName: data.public_user_data.first_name,
lastName: data.public_user_data.last_name,
profileImageUrl: data.public_user_data.profile_image_url,
identifier: data.public_user_data.identifier,
userId: data.public_user_data.user_id,
};
this.role = data.role;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}
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" + ' feat(clerk-js): Add organization basic resources by igneel64 · Pull Request #57 · clerk/javascript · GitHub
Skip to content
Merged
32 changes: 31 additions & 1 deletion packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,13 @@ import type {
Clerk as ClerkInterface,
ClerkOptions,
ClientResource,
CreateOrganizationInvitationParams,
CreateOrganizationParams,
EnvironmentResource,
HandleMagicLinkVerificationParams,
HandleOAuthCallbackParams,
ListenerCallback,
OrganizationResource,
RedirectOptions,
Resources,
SignInProps,
Expand DownExpand Up@@ -61,6 +64,8 @@ import {
Environment,
MagicLinkError,
MagicLinkErrorCode,
Organization,
OrganizationInvitation,
} from './resources/internal';

export type ClerkCoreBroadcastChannelEvent = { type: 'signout' };
Expand DownExpand Up@@ -296,7 +301,7 @@ export default class Clerk implements ClerkInterface {
if (this.#unloading) {
return;
}
this.session = session;
this.session = session;
this.user = this.session ? this.session.user : null;

this.#emit();
Expand DownExpand Up@@ -573,6 +578,24 @@ export default class Clerk implements ClerkInterface {
}
};

public createOrganization = async ({
name,
}: CreateOrganizationParams): Promise<OrganizationResource> => {
return await Organization.create(name);
};

public getOrganizations = async (): Promise<OrganizationResource[]> => {
return await Organization.retrieve();
};

public getOrganization = async (
organizationId: string,
): Promise<OrganizationResource | undefined> => {
return (await Organization.retrieve()).find(
org => org.id === organizationId,
);
};

updateClient = (newClient: ClientResource): void => {
if (!this.client) {
// This is the first time client is being
Expand DownExpand Up@@ -609,6 +632,13 @@ export default class Clerk implements ClerkInterface {
this.#fapiClient.onAfterResponse(callback);
}

__unstable_inviteMember = async (

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@igneel64 Can you please elaborate why do we consider this an unstable method at this point?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❓ A follow up question, does this method invite a member or creates an org? Something seems to be missing.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@SokratisVidros , thanks for the comment.

The use of the __unstable prefix is intended here. Currently we cannot expose methods on clerk-react from internal clerk-js resources. The only way this can be done is through the Clerk interface.
The same interface though is exposed globally. That means that adding a method there, it is also exposed in window.Clerk.methodName.
Since adding methods indiscriminately on the global Clerk object is not the optimal outcome, for now we are adding to those methods the __unstable prefix to prevent misuse.

(Also this method just invites a member on an organization. The organizations can be retrieved from the useOrganizations hook.)

organizationId: string,
params: CreateOrganizationInvitationParams,
) => {
return await OrganizationInvitation.create(organizationId, params);
};

#loadInBrowser = async (): Promise<void> => {
this.#authService = new AuthenticationService(this);

Expand Down
18 changes: 18 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import { Organization } from 'core/resources/internal';

describe('Organization', () => {
it('has the same initial properties', () => {
const organization = new Organization({
object: 'organization',
id: 'test_id',
name: 'test_name',
role: 'basic_member',
created_at: 12345,
updated_at: 5678,
created_by: 'test_user_id',
instance_id: 'test_instance_id',
});

expect(organization).toMatchSnapshot();
});
});
140 changes: 140 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
import type {
GetMembersParams,
MembershipRole,
OrganizationInvitationJSON,
OrganizationJSON,
OrganizationMembershipJSON,
OrganizationResource,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

import {
BaseResource,
OrganizationInvitation,
OrganizationMembership,
} from './internal';

export class Organization extends BaseResource implements OrganizationResource {
id!: string;
name!: string;
role!: MembershipRole;
instanceId!: string;
createdBy!: string;
createdAt!: Date;
updatedAt!: Date;

constructor(data: OrganizationJSON) {
super();
this.fromJSON(data);
}

static async create(name: string): Promise<OrganizationResource> {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

❓ IIRC, all resources use the this.basePost | this.baseGet | ... methods that retrieve a json and return the instantiated resource. Why did we decide to use the static BaseResource._fetch here?

To be honest, I'm not a huge fan of the this.basePost approach, but if we don't have any specific reasons to do otherwise, I think it'd be better to remain consistent and tackle them all at once in a different PR

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@nikosdouvlis
Discussed offline.

const json = (
await BaseResource._fetch<OrganizationJSON>({
path: '/organizations',
method: 'POST',
body: { name } as any,
})
)?.response as unknown as OrganizationJSON;

return new Organization(json);
}

static async retrieve(
getOrganizationParams?: GetOrganizationParams,
): Promise<Organization[]> {
return await BaseResource._fetch({
path: '/me/organizations',
method: 'GET',
search: getOrganizationParams as any,
})
.then(res => {
const organizationsJSON =
res?.response as unknown as OrganizationJSON[];
return organizationsJSON.map(org => new Organization(org));
})
.catch(() => []);
}

getMembers = async (
getMemberParams?: GetMembersParams,
): Promise<OrganizationMembership[]> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/memberships`,
method: 'GET',
search: getMemberParams as any,
})
.then(res => {
const members =
res?.response as unknown as OrganizationMembershipJSON[];
return members.map(member => new OrganizationMembership(member));
})
.catch(() => []);
};

getPendingInvitations = async (): Promise<OrganizationInvitation[]> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/invitations/pending`,
method: 'GET',
})
.then(res => {
const pendingInvitations =
res?.response as unknown as OrganizationInvitationJSON[];
return pendingInvitations.map(
pendingInvitation => new OrganizationInvitation(pendingInvitation),
);
})
.catch(() => []);
};

inviteUser = async (inviteUserParams: InviteUserParams) => {
return await OrganizationInvitation.create(this.id, inviteUserParams);
};

updateMember = async ({
userId,
role,
}: UpdateMembershipParams): Promise<OrganizationMembership> => {
return await BaseResource._fetch({
method: 'PATCH',
path: `/organizations/${this.id}/memberships/${userId}`,
body: { role } as any,
}).then(
res =>
new OrganizationMembership(res?.response as OrganizationMembershipJSON),
);
};

removeMember = async (userId: string) => {
return await this._baseDelete({
path: `/organizations/${this.id}/memberships/${userId}`,
});
};

protected fromJSON(data: OrganizationJSON): this {
this.id = data.id;
this.name = data.name;
this.role = data.role;
this.instanceId = data.instance_id;
this.createdBy = data.created_by;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}

export type GetOrganizationParams = {
limit?: number;
offset?: number;
};

export type InviteUserParams = {
emailAddress: string;
role: MembershipRole;
redirectUrl?: string;
};

export type UpdateMembershipParams = {
userId: string;
role: MembershipRole;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import { OrganizationInvitation } from 'core/resources/internal';

describe('OrganizationInvitation', () => {
it('has the same initial properties', () => {
const organizationInvitation = new OrganizationInvitation({
object: 'organization_invitation',
email_address: 'test_email',
id: 'test_id',
organization_id: 'test_organization_id',
role: 'basic_member',
created_at: 12345,
updated_at: 5678,
status: 'pending',
});

expect(organizationInvitation).toMatchSnapshot();
});
});
69 changes: 69 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationInvitation.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import {
MembershipRole,
OrganizationInvitationJSON,
OrganizationInvitationResource,
OrganizationInvitationStatus,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

import { BaseResource } from './internal';

export class OrganizationInvitation
extends BaseResource
implements OrganizationInvitationResource
{
id!: string;
emailAddress!: string;
organizationId!: string;
status!: OrganizationInvitationStatus;
role!: MembershipRole;
createdAt!: Date;
updatedAt!: Date;

static async create(
organizationId: string,
{ emailAddress, role, redirectUrl }: CreateOrganizationInvitationParams,
): Promise<OrganizationInvitationResource> {
const json = (
await BaseResource._fetch<OrganizationInvitationJSON>({
path: `/organizations/${organizationId}/invitations`,
method: 'POST',
body: {
email_address: emailAddress,
role,
redirect_url: redirectUrl,
} as any,
})
)?.response as unknown as OrganizationInvitationJSON;

return new OrganizationInvitation(json);
}

constructor(data: OrganizationInvitationJSON) {
super();
this.fromJSON(data);
}

revoke = async () => {
return await this._basePost({
path: `/organizations/${this.organizationId}/invitations/${this.id}/revoke`,
});
};

protected fromJSON(data: OrganizationInvitationJSON): this {
this.id = data.id;
this.emailAddress = data.email_address;
this.organizationId = data.organization_id;
this.role = data.role;
this.status = data.status;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}

export type CreateOrganizationInvitationParams = {
emailAddress: string;
role: MembershipRole;
redirectUrl?: string;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import { OrganizationMembership } from 'core/resources/internal';

describe('OrganizationMembership', () => {
it('has the same initial properties', () => {
const organizationMemberShip = new OrganizationMembership({
object: 'organization_membership',
id: 'test_id',
created_at: 12345,
updated_at: 5678,
role: 'admin',
public_user_data: {
object: 'public_user_data',
first_name: 'test_first_name',
last_name: 'test_last_name',
profile_image_url: 'test_url',
identifier: 'test@identifier.gr',
id: 'test_user_id',
},
});

expect(organizationMemberShip).toMatchSnapshot();
});
});
34 changes: 34 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationMembership.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
import {
MembershipRole,
OrganizationMembershipJSON,
OrganizationMembershipResource,
PublicUserData,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

export class OrganizationMembership implements OrganizationMembershipResource {
id!: string;
publicUserData!: PublicUserData;
role!: MembershipRole;
createdAt!: Date;
updatedAt!: Date;

constructor(data: OrganizationMembershipJSON) {
this.fromJSON(data);
}

protected fromJSON(data: OrganizationMembershipJSON): this {
this.id = data.id;
this.publicUserData = {
firstName: data.public_user_data.first_name,
lastName: data.public_user_data.last_name,
profileImageUrl: data.public_user_data.profile_image_url,
identifier: data.public_user_data.identifier,
userId: data.public_user_data.user_id,
};
this.role = data.role;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}
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('^' + ".*" + ' feat(clerk-js): Add organization basic resources by igneel64 · Pull Request #57 · clerk/javascript · GitHub
Skip to content
Merged
32 changes: 31 additions & 1 deletion packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,13 @@ import type {
Clerk as ClerkInterface,
ClerkOptions,
ClientResource,
CreateOrganizationInvitationParams,
CreateOrganizationParams,
EnvironmentResource,
HandleMagicLinkVerificationParams,
HandleOAuthCallbackParams,
ListenerCallback,
OrganizationResource,
RedirectOptions,
Resources,
SignInProps,
Expand DownExpand Up@@ -61,6 +64,8 @@ import {
Environment,
MagicLinkError,
MagicLinkErrorCode,
Organization,
OrganizationInvitation,
} from './resources/internal';

export type ClerkCoreBroadcastChannelEvent = { type: 'signout' };
Expand DownExpand Up@@ -296,7 +301,7 @@ export default class Clerk implements ClerkInterface {
if (this.#unloading) {
return;
}
this.session = session;
this.session = session;
this.user = this.session ? this.session.user : null;

this.#emit();
Expand DownExpand Up@@ -573,6 +578,24 @@ export default class Clerk implements ClerkInterface {
}
};

public createOrganization = async ({
name,
}: CreateOrganizationParams): Promise<OrganizationResource> => {
return await Organization.create(name);
};

public getOrganizations = async (): Promise<OrganizationResource[]> => {
return await Organization.retrieve();
};

public getOrganization = async (
organizationId: string,
): Promise<OrganizationResource | undefined> => {
return (await Organization.retrieve()).find(
org => org.id === organizationId,
);
};

updateClient = (newClient: ClientResource): void => {
if (!this.client) {
// This is the first time client is being
Expand DownExpand Up@@ -609,6 +632,13 @@ export default class Clerk implements ClerkInterface {
this.#fapiClient.onAfterResponse(callback);
}

__unstable_inviteMember = async (

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@igneel64 Can you please elaborate why do we consider this an unstable method at this point?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❓ A follow up question, does this method invite a member or creates an org? Something seems to be missing.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@SokratisVidros , thanks for the comment.

The use of the __unstable prefix is intended here. Currently we cannot expose methods on clerk-react from internal clerk-js resources. The only way this can be done is through the Clerk interface.
The same interface though is exposed globally. That means that adding a method there, it is also exposed in window.Clerk.methodName.
Since adding methods indiscriminately on the global Clerk object is not the optimal outcome, for now we are adding to those methods the __unstable prefix to prevent misuse.

(Also this method just invites a member on an organization. The organizations can be retrieved from the useOrganizations hook.)

organizationId: string,
params: CreateOrganizationInvitationParams,
) => {
return await OrganizationInvitation.create(organizationId, params);
};

#loadInBrowser = async (): Promise<void> => {
this.#authService = new AuthenticationService(this);

Expand Down
18 changes: 18 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import { Organization } from 'core/resources/internal';

describe('Organization', () => {
it('has the same initial properties', () => {
const organization = new Organization({
object: 'organization',
id: 'test_id',
name: 'test_name',
role: 'basic_member',
created_at: 12345,
updated_at: 5678,
created_by: 'test_user_id',
instance_id: 'test_instance_id',
});

expect(organization).toMatchSnapshot();
});
});
140 changes: 140 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
import type {
GetMembersParams,
MembershipRole,
OrganizationInvitationJSON,
OrganizationJSON,
OrganizationMembershipJSON,
OrganizationResource,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

import {
BaseResource,
OrganizationInvitation,
OrganizationMembership,
} from './internal';

export class Organization extends BaseResource implements OrganizationResource {
id!: string;
name!: string;
role!: MembershipRole;
instanceId!: string;
createdBy!: string;
createdAt!: Date;
updatedAt!: Date;

constructor(data: OrganizationJSON) {
super();
this.fromJSON(data);
}

static async create(name: string): Promise<OrganizationResource> {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

❓ IIRC, all resources use the this.basePost | this.baseGet | ... methods that retrieve a json and return the instantiated resource. Why did we decide to use the static BaseResource._fetch here?

To be honest, I'm not a huge fan of the this.basePost approach, but if we don't have any specific reasons to do otherwise, I think it'd be better to remain consistent and tackle them all at once in a different PR

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@nikosdouvlis
Discussed offline.

const json = (
await BaseResource._fetch<OrganizationJSON>({
path: '/organizations',
method: 'POST',
body: { name } as any,
})
)?.response as unknown as OrganizationJSON;

return new Organization(json);
}

static async retrieve(
getOrganizationParams?: GetOrganizationParams,
): Promise<Organization[]> {
return await BaseResource._fetch({
path: '/me/organizations',
method: 'GET',
search: getOrganizationParams as any,
})
.then(res => {
const organizationsJSON =
res?.response as unknown as OrganizationJSON[];
return organizationsJSON.map(org => new Organization(org));
})
.catch(() => []);
}

getMembers = async (
getMemberParams?: GetMembersParams,
): Promise<OrganizationMembership[]> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/memberships`,
method: 'GET',
search: getMemberParams as any,
})
.then(res => {
const members =
res?.response as unknown as OrganizationMembershipJSON[];
return members.map(member => new OrganizationMembership(member));
})
.catch(() => []);
};

getPendingInvitations = async (): Promise<OrganizationInvitation[]> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/invitations/pending`,
method: 'GET',
})
.then(res => {
const pendingInvitations =
res?.response as unknown as OrganizationInvitationJSON[];
return pendingInvitations.map(
pendingInvitation => new OrganizationInvitation(pendingInvitation),
);
})
.catch(() => []);
};

inviteUser = async (inviteUserParams: InviteUserParams) => {
return await OrganizationInvitation.create(this.id, inviteUserParams);
};

updateMember = async ({
userId,
role,
}: UpdateMembershipParams): Promise<OrganizationMembership> => {
return await BaseResource._fetch({
method: 'PATCH',
path: `/organizations/${this.id}/memberships/${userId}`,
body: { role } as any,
}).then(
res =>
new OrganizationMembership(res?.response as OrganizationMembershipJSON),
);
};

removeMember = async (userId: string) => {
return await this._baseDelete({
path: `/organizations/${this.id}/memberships/${userId}`,
});
};

protected fromJSON(data: OrganizationJSON): this {
this.id = data.id;
this.name = data.name;
this.role = data.role;
this.instanceId = data.instance_id;
this.createdBy = data.created_by;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}

export type GetOrganizationParams = {
limit?: number;
offset?: number;
};

export type InviteUserParams = {
emailAddress: string;
role: MembershipRole;
redirectUrl?: string;
};

export type UpdateMembershipParams = {
userId: string;
role: MembershipRole;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import { OrganizationInvitation } from 'core/resources/internal';

describe('OrganizationInvitation', () => {
it('has the same initial properties', () => {
const organizationInvitation = new OrganizationInvitation({
object: 'organization_invitation',
email_address: 'test_email',
id: 'test_id',
organization_id: 'test_organization_id',
role: 'basic_member',
created_at: 12345,
updated_at: 5678,
status: 'pending',
});

expect(organizationInvitation).toMatchSnapshot();
});
});
69 changes: 69 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationInvitation.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import {
MembershipRole,
OrganizationInvitationJSON,
OrganizationInvitationResource,
OrganizationInvitationStatus,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

import { BaseResource } from './internal';

export class OrganizationInvitation
extends BaseResource
implements OrganizationInvitationResource
{
id!: string;
emailAddress!: string;
organizationId!: string;
status!: OrganizationInvitationStatus;
role!: MembershipRole;
createdAt!: Date;
updatedAt!: Date;

static async create(
organizationId: string,
{ emailAddress, role, redirectUrl }: CreateOrganizationInvitationParams,
): Promise<OrganizationInvitationResource> {
const json = (
await BaseResource._fetch<OrganizationInvitationJSON>({
path: `/organizations/${organizationId}/invitations`,
method: 'POST',
body: {
email_address: emailAddress,
role,
redirect_url: redirectUrl,
} as any,
})
)?.response as unknown as OrganizationInvitationJSON;

return new OrganizationInvitation(json);
}

constructor(data: OrganizationInvitationJSON) {
super();
this.fromJSON(data);
}

revoke = async () => {
return await this._basePost({
path: `/organizations/${this.organizationId}/invitations/${this.id}/revoke`,
});
};

protected fromJSON(data: OrganizationInvitationJSON): this {
this.id = data.id;
this.emailAddress = data.email_address;
this.organizationId = data.organization_id;
this.role = data.role;
this.status = data.status;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}

export type CreateOrganizationInvitationParams = {
emailAddress: string;
role: MembershipRole;
redirectUrl?: string;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import { OrganizationMembership } from 'core/resources/internal';

describe('OrganizationMembership', () => {
it('has the same initial properties', () => {
const organizationMemberShip = new OrganizationMembership({
object: 'organization_membership',
id: 'test_id',
created_at: 12345,
updated_at: 5678,
role: 'admin',
public_user_data: {
object: 'public_user_data',
first_name: 'test_first_name',
last_name: 'test_last_name',
profile_image_url: 'test_url',
identifier: 'test@identifier.gr',
id: 'test_user_id',
},
});

expect(organizationMemberShip).toMatchSnapshot();
});
});
34 changes: 34 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationMembership.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
import {
MembershipRole,
OrganizationMembershipJSON,
OrganizationMembershipResource,
PublicUserData,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

export class OrganizationMembership implements OrganizationMembershipResource {
id!: string;
publicUserData!: PublicUserData;
role!: MembershipRole;
createdAt!: Date;
updatedAt!: Date;

constructor(data: OrganizationMembershipJSON) {
this.fromJSON(data);
}

protected fromJSON(data: OrganizationMembershipJSON): this {
this.id = data.id;
this.publicUserData = {
firstName: data.public_user_data.first_name,
lastName: data.public_user_data.last_name,
profileImageUrl: data.public_user_data.profile_image_url,
identifier: data.public_user_data.identifier,
userId: data.public_user_data.user_id,
};
this.role = data.role;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}
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('^' + ".*" + ' feat(clerk-js): Add organization basic resources by igneel64 · Pull Request #57 · clerk/javascript · GitHub
Skip to content
Merged
32 changes: 31 additions & 1 deletion packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,13 @@ import type {
Clerk as ClerkInterface,
ClerkOptions,
ClientResource,
CreateOrganizationInvitationParams,
CreateOrganizationParams,
EnvironmentResource,
HandleMagicLinkVerificationParams,
HandleOAuthCallbackParams,
ListenerCallback,
OrganizationResource,
RedirectOptions,
Resources,
SignInProps,
Expand DownExpand Up@@ -61,6 +64,8 @@ import {
Environment,
MagicLinkError,
MagicLinkErrorCode,
Organization,
OrganizationInvitation,
} from './resources/internal';

export type ClerkCoreBroadcastChannelEvent = { type: 'signout' };
Expand DownExpand Up@@ -296,7 +301,7 @@ export default class Clerk implements ClerkInterface {
if (this.#unloading) {
return;
}
this.session = session;
this.session = session;
this.user = this.session ? this.session.user : null;

this.#emit();
Expand DownExpand Up@@ -573,6 +578,24 @@ export default class Clerk implements ClerkInterface {
}
};

public createOrganization = async ({
name,
}: CreateOrganizationParams): Promise<OrganizationResource> => {
return await Organization.create(name);
};

public getOrganizations = async (): Promise<OrganizationResource[]> => {
return await Organization.retrieve();
};

public getOrganization = async (
organizationId: string,
): Promise<OrganizationResource | undefined> => {
return (await Organization.retrieve()).find(
org => org.id === organizationId,
);
};

updateClient = (newClient: ClientResource): void => {
if (!this.client) {
// This is the first time client is being
Expand DownExpand Up@@ -609,6 +632,13 @@ export default class Clerk implements ClerkInterface {
this.#fapiClient.onAfterResponse(callback);
}

__unstable_inviteMember = async (

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@igneel64 Can you please elaborate why do we consider this an unstable method at this point?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❓ A follow up question, does this method invite a member or creates an org? Something seems to be missing.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@SokratisVidros , thanks for the comment.

The use of the __unstable prefix is intended here. Currently we cannot expose methods on clerk-react from internal clerk-js resources. The only way this can be done is through the Clerk interface.
The same interface though is exposed globally. That means that adding a method there, it is also exposed in window.Clerk.methodName.
Since adding methods indiscriminately on the global Clerk object is not the optimal outcome, for now we are adding to those methods the __unstable prefix to prevent misuse.

(Also this method just invites a member on an organization. The organizations can be retrieved from the useOrganizations hook.)

organizationId: string,
params: CreateOrganizationInvitationParams,
) => {
return await OrganizationInvitation.create(organizationId, params);
};

#loadInBrowser = async (): Promise<void> => {
this.#authService = new AuthenticationService(this);

Expand Down
18 changes: 18 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import { Organization } from 'core/resources/internal';

describe('Organization', () => {
it('has the same initial properties', () => {
const organization = new Organization({
object: 'organization',
id: 'test_id',
name: 'test_name',
role: 'basic_member',
created_at: 12345,
updated_at: 5678,
created_by: 'test_user_id',
instance_id: 'test_instance_id',
});

expect(organization).toMatchSnapshot();
});
});
140 changes: 140 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
import type {
GetMembersParams,
MembershipRole,
OrganizationInvitationJSON,
OrganizationJSON,
OrganizationMembershipJSON,
OrganizationResource,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

import {
BaseResource,
OrganizationInvitation,
OrganizationMembership,
} from './internal';

export class Organization extends BaseResource implements OrganizationResource {
id!: string;
name!: string;
role!: MembershipRole;
instanceId!: string;
createdBy!: string;
createdAt!: Date;
updatedAt!: Date;

constructor(data: OrganizationJSON) {
super();
this.fromJSON(data);
}

static async create(name: string): Promise<OrganizationResource> {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

❓ IIRC, all resources use the this.basePost | this.baseGet | ... methods that retrieve a json and return the instantiated resource. Why did we decide to use the static BaseResource._fetch here?

To be honest, I'm not a huge fan of the this.basePost approach, but if we don't have any specific reasons to do otherwise, I think it'd be better to remain consistent and tackle them all at once in a different PR

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@nikosdouvlis
Discussed offline.

const json = (
await BaseResource._fetch<OrganizationJSON>({
path: '/organizations',
method: 'POST',
body: { name } as any,
})
)?.response as unknown as OrganizationJSON;

return new Organization(json);
}

static async retrieve(
getOrganizationParams?: GetOrganizationParams,
): Promise<Organization[]> {
return await BaseResource._fetch({
path: '/me/organizations',
method: 'GET',
search: getOrganizationParams as any,
})
.then(res => {
const organizationsJSON =
res?.response as unknown as OrganizationJSON[];
return organizationsJSON.map(org => new Organization(org));
})
.catch(() => []);
}

getMembers = async (
getMemberParams?: GetMembersParams,
): Promise<OrganizationMembership[]> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/memberships`,
method: 'GET',
search: getMemberParams as any,
})
.then(res => {
const members =
res?.response as unknown as OrganizationMembershipJSON[];
return members.map(member => new OrganizationMembership(member));
})
.catch(() => []);
};

getPendingInvitations = async (): Promise<OrganizationInvitation[]> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/invitations/pending`,
method: 'GET',
})
.then(res => {
const pendingInvitations =
res?.response as unknown as OrganizationInvitationJSON[];
return pendingInvitations.map(
pendingInvitation => new OrganizationInvitation(pendingInvitation),
);
})
.catch(() => []);
};

inviteUser = async (inviteUserParams: InviteUserParams) => {
return await OrganizationInvitation.create(this.id, inviteUserParams);
};

updateMember = async ({
userId,
role,
}: UpdateMembershipParams): Promise<OrganizationMembership> => {
return await BaseResource._fetch({
method: 'PATCH',
path: `/organizations/${this.id}/memberships/${userId}`,
body: { role } as any,
}).then(
res =>
new OrganizationMembership(res?.response as OrganizationMembershipJSON),
);
};

removeMember = async (userId: string) => {
return await this._baseDelete({
path: `/organizations/${this.id}/memberships/${userId}`,
});
};

protected fromJSON(data: OrganizationJSON): this {
this.id = data.id;
this.name = data.name;
this.role = data.role;
this.instanceId = data.instance_id;
this.createdBy = data.created_by;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}

export type GetOrganizationParams = {
limit?: number;
offset?: number;
};

export type InviteUserParams = {
emailAddress: string;
role: MembershipRole;
redirectUrl?: string;
};

export type UpdateMembershipParams = {
userId: string;
role: MembershipRole;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import { OrganizationInvitation } from 'core/resources/internal';

describe('OrganizationInvitation', () => {
it('has the same initial properties', () => {
const organizationInvitation = new OrganizationInvitation({
object: 'organization_invitation',
email_address: 'test_email',
id: 'test_id',
organization_id: 'test_organization_id',
role: 'basic_member',
created_at: 12345,
updated_at: 5678,
status: 'pending',
});

expect(organizationInvitation).toMatchSnapshot();
});
});
69 changes: 69 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationInvitation.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import {
MembershipRole,
OrganizationInvitationJSON,
OrganizationInvitationResource,
OrganizationInvitationStatus,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

import { BaseResource } from './internal';

export class OrganizationInvitation
extends BaseResource
implements OrganizationInvitationResource
{
id!: string;
emailAddress!: string;
organizationId!: string;
status!: OrganizationInvitationStatus;
role!: MembershipRole;
createdAt!: Date;
updatedAt!: Date;

static async create(
organizationId: string,
{ emailAddress, role, redirectUrl }: CreateOrganizationInvitationParams,
): Promise<OrganizationInvitationResource> {
const json = (
await BaseResource._fetch<OrganizationInvitationJSON>({
path: `/organizations/${organizationId}/invitations`,
method: 'POST',
body: {
email_address: emailAddress,
role,
redirect_url: redirectUrl,
} as any,
})
)?.response as unknown as OrganizationInvitationJSON;

return new OrganizationInvitation(json);
}

constructor(data: OrganizationInvitationJSON) {
super();
this.fromJSON(data);
}

revoke = async () => {
return await this._basePost({
path: `/organizations/${this.organizationId}/invitations/${this.id}/revoke`,
});
};

protected fromJSON(data: OrganizationInvitationJSON): this {
this.id = data.id;
this.emailAddress = data.email_address;
this.organizationId = data.organization_id;
this.role = data.role;
this.status = data.status;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}

export type CreateOrganizationInvitationParams = {
emailAddress: string;
role: MembershipRole;
redirectUrl?: string;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import { OrganizationMembership } from 'core/resources/internal';

describe('OrganizationMembership', () => {
it('has the same initial properties', () => {
const organizationMemberShip = new OrganizationMembership({
object: 'organization_membership',
id: 'test_id',
created_at: 12345,
updated_at: 5678,
role: 'admin',
public_user_data: {
object: 'public_user_data',
first_name: 'test_first_name',
last_name: 'test_last_name',
profile_image_url: 'test_url',
identifier: 'test@identifier.gr',
id: 'test_user_id',
},
});

expect(organizationMemberShip).toMatchSnapshot();
});
});
34 changes: 34 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationMembership.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
import {
MembershipRole,
OrganizationMembershipJSON,
OrganizationMembershipResource,
PublicUserData,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

export class OrganizationMembership implements OrganizationMembershipResource {
id!: string;
publicUserData!: PublicUserData;
role!: MembershipRole;
createdAt!: Date;
updatedAt!: Date;

constructor(data: OrganizationMembershipJSON) {
this.fromJSON(data);
}

protected fromJSON(data: OrganizationMembershipJSON): this {
this.id = data.id;
this.publicUserData = {
firstName: data.public_user_data.first_name,
lastName: data.public_user_data.last_name,
profileImageUrl: data.public_user_data.profile_image_url,
identifier: data.public_user_data.identifier,
userId: data.public_user_data.user_id,
};
this.role = data.role;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}
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); } })(); })(); feat(clerk-js): Add organization basic resources by igneel64 · Pull Request #57 · clerk/javascript · GitHub
Skip to content
Merged
32 changes: 31 additions & 1 deletion packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,13 @@ import type {
Clerk as ClerkInterface,
ClerkOptions,
ClientResource,
CreateOrganizationInvitationParams,
CreateOrganizationParams,
EnvironmentResource,
HandleMagicLinkVerificationParams,
HandleOAuthCallbackParams,
ListenerCallback,
OrganizationResource,
RedirectOptions,
Resources,
SignInProps,
Expand DownExpand Up@@ -61,6 +64,8 @@ import {
Environment,
MagicLinkError,
MagicLinkErrorCode,
Organization,
OrganizationInvitation,
} from './resources/internal';

export type ClerkCoreBroadcastChannelEvent = { type: 'signout' };
Expand DownExpand Up@@ -296,7 +301,7 @@ export default class Clerk implements ClerkInterface {
if (this.#unloading) {
return;
}
this.session = session;
this.session = session;
this.user = this.session ? this.session.user : null;

this.#emit();
Expand DownExpand Up@@ -573,6 +578,24 @@ export default class Clerk implements ClerkInterface {
}
};

public createOrganization = async ({
name,
}: CreateOrganizationParams): Promise<OrganizationResource> => {
return await Organization.create(name);
};

public getOrganizations = async (): Promise<OrganizationResource[]> => {
return await Organization.retrieve();
};

public getOrganization = async (
organizationId: string,
): Promise<OrganizationResource | undefined> => {
return (await Organization.retrieve()).find(
org => org.id === organizationId,
);
};

updateClient = (newClient: ClientResource): void => {
if (!this.client) {
// This is the first time client is being
Expand DownExpand Up@@ -609,6 +632,13 @@ export default class Clerk implements ClerkInterface {
this.#fapiClient.onAfterResponse(callback);
}

__unstable_inviteMember = async (

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@igneel64 Can you please elaborate why do we consider this an unstable method at this point?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❓ A follow up question, does this method invite a member or creates an org? Something seems to be missing.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@SokratisVidros , thanks for the comment.

The use of the __unstable prefix is intended here. Currently we cannot expose methods on clerk-react from internal clerk-js resources. The only way this can be done is through the Clerk interface.
The same interface though is exposed globally. That means that adding a method there, it is also exposed in window.Clerk.methodName.
Since adding methods indiscriminately on the global Clerk object is not the optimal outcome, for now we are adding to those methods the __unstable prefix to prevent misuse.

(Also this method just invites a member on an organization. The organizations can be retrieved from the useOrganizations hook.)

organizationId: string,
params: CreateOrganizationInvitationParams,
) => {
return await OrganizationInvitation.create(organizationId, params);
};

#loadInBrowser = async (): Promise<void> => {
this.#authService = new AuthenticationService(this);

Expand Down
18 changes: 18 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import { Organization } from 'core/resources/internal';

describe('Organization', () => {
it('has the same initial properties', () => {
const organization = new Organization({
object: 'organization',
id: 'test_id',
name: 'test_name',
role: 'basic_member',
created_at: 12345,
updated_at: 5678,
created_by: 'test_user_id',
instance_id: 'test_instance_id',
});

expect(organization).toMatchSnapshot();
});
});
140 changes: 140 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
import type {
GetMembersParams,
MembershipRole,
OrganizationInvitationJSON,
OrganizationJSON,
OrganizationMembershipJSON,
OrganizationResource,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

import {
BaseResource,
OrganizationInvitation,
OrganizationMembership,
} from './internal';

export class Organization extends BaseResource implements OrganizationResource {
id!: string;
name!: string;
role!: MembershipRole;
instanceId!: string;
createdBy!: string;
createdAt!: Date;
updatedAt!: Date;

constructor(data: OrganizationJSON) {
super();
this.fromJSON(data);
}

static async create(name: string): Promise<OrganizationResource> {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

❓ IIRC, all resources use the this.basePost | this.baseGet | ... methods that retrieve a json and return the instantiated resource. Why did we decide to use the static BaseResource._fetch here?

To be honest, I'm not a huge fan of the this.basePost approach, but if we don't have any specific reasons to do otherwise, I think it'd be better to remain consistent and tackle them all at once in a different PR

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@nikosdouvlis
Discussed offline.

const json = (
await BaseResource._fetch<OrganizationJSON>({
path: '/organizations',
method: 'POST',
body: { name } as any,
})
)?.response as unknown as OrganizationJSON;

return new Organization(json);
}

static async retrieve(
getOrganizationParams?: GetOrganizationParams,
): Promise<Organization[]> {
return await BaseResource._fetch({
path: '/me/organizations',
method: 'GET',
search: getOrganizationParams as any,
})
.then(res => {
const organizationsJSON =
res?.response as unknown as OrganizationJSON[];
return organizationsJSON.map(org => new Organization(org));
})
.catch(() => []);
}

getMembers = async (
getMemberParams?: GetMembersParams,
): Promise<OrganizationMembership[]> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/memberships`,
method: 'GET',
search: getMemberParams as any,
})
.then(res => {
const members =
res?.response as unknown as OrganizationMembershipJSON[];
return members.map(member => new OrganizationMembership(member));
})
.catch(() => []);
};

getPendingInvitations = async (): Promise<OrganizationInvitation[]> => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/invitations/pending`,
method: 'GET',
})
.then(res => {
const pendingInvitations =
res?.response as unknown as OrganizationInvitationJSON[];
return pendingInvitations.map(
pendingInvitation => new OrganizationInvitation(pendingInvitation),
);
})
.catch(() => []);
};

inviteUser = async (inviteUserParams: InviteUserParams) => {
return await OrganizationInvitation.create(this.id, inviteUserParams);
};

updateMember = async ({
userId,
role,
}: UpdateMembershipParams): Promise<OrganizationMembership> => {
return await BaseResource._fetch({
method: 'PATCH',
path: `/organizations/${this.id}/memberships/${userId}`,
body: { role } as any,
}).then(
res =>
new OrganizationMembership(res?.response as OrganizationMembershipJSON),
);
};

removeMember = async (userId: string) => {
return await this._baseDelete({
path: `/organizations/${this.id}/memberships/${userId}`,
});
};

protected fromJSON(data: OrganizationJSON): this {
this.id = data.id;
this.name = data.name;
this.role = data.role;
this.instanceId = data.instance_id;
this.createdBy = data.created_by;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}

export type GetOrganizationParams = {
limit?: number;
offset?: number;
};

export type InviteUserParams = {
emailAddress: string;
role: MembershipRole;
redirectUrl?: string;
};

export type UpdateMembershipParams = {
userId: string;
role: MembershipRole;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import { OrganizationInvitation } from 'core/resources/internal';

describe('OrganizationInvitation', () => {
it('has the same initial properties', () => {
const organizationInvitation = new OrganizationInvitation({
object: 'organization_invitation',
email_address: 'test_email',
id: 'test_id',
organization_id: 'test_organization_id',
role: 'basic_member',
created_at: 12345,
updated_at: 5678,
status: 'pending',
});

expect(organizationInvitation).toMatchSnapshot();
});
});
69 changes: 69 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationInvitation.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import {
MembershipRole,
OrganizationInvitationJSON,
OrganizationInvitationResource,
OrganizationInvitationStatus,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

import { BaseResource } from './internal';

export class OrganizationInvitation
extends BaseResource
implements OrganizationInvitationResource
{
id!: string;
emailAddress!: string;
organizationId!: string;
status!: OrganizationInvitationStatus;
role!: MembershipRole;
createdAt!: Date;
updatedAt!: Date;

static async create(
organizationId: string,
{ emailAddress, role, redirectUrl }: CreateOrganizationInvitationParams,
): Promise<OrganizationInvitationResource> {
const json = (
await BaseResource._fetch<OrganizationInvitationJSON>({
path: `/organizations/${organizationId}/invitations`,
method: 'POST',
body: {
email_address: emailAddress,
role,
redirect_url: redirectUrl,
} as any,
})
)?.response as unknown as OrganizationInvitationJSON;

return new OrganizationInvitation(json);
}

constructor(data: OrganizationInvitationJSON) {
super();
this.fromJSON(data);
}

revoke = async () => {
return await this._basePost({
path: `/organizations/${this.organizationId}/invitations/${this.id}/revoke`,
});
};

protected fromJSON(data: OrganizationInvitationJSON): this {
this.id = data.id;
this.emailAddress = data.email_address;
this.organizationId = data.organization_id;
this.role = data.role;
this.status = data.status;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}

export type CreateOrganizationInvitationParams = {
emailAddress: string;
role: MembershipRole;
redirectUrl?: string;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import { OrganizationMembership } from 'core/resources/internal';

describe('OrganizationMembership', () => {
it('has the same initial properties', () => {
const organizationMemberShip = new OrganizationMembership({
object: 'organization_membership',
id: 'test_id',
created_at: 12345,
updated_at: 5678,
role: 'admin',
public_user_data: {
object: 'public_user_data',
first_name: 'test_first_name',
last_name: 'test_last_name',
profile_image_url: 'test_url',
identifier: 'test@identifier.gr',
id: 'test_user_id',
},
});

expect(organizationMemberShip).toMatchSnapshot();
});
});
34 changes: 34 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationMembership.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
import {
MembershipRole,
OrganizationMembershipJSON,
OrganizationMembershipResource,
PublicUserData,
} from '@clerk/types';
import { unixEpochToDate } from 'utils/date';

export class OrganizationMembership implements OrganizationMembershipResource {
id!: string;
publicUserData!: PublicUserData;
role!: MembershipRole;
createdAt!: Date;
updatedAt!: Date;

constructor(data: OrganizationMembershipJSON) {
this.fromJSON(data);
}

protected fromJSON(data: OrganizationMembershipJSON): this {
this.id = data.id;
this.publicUserData = {
firstName: data.public_user_data.first_name,
lastName: data.public_user_data.last_name,
profileImageUrl: data.public_user_data.profile_image_url,
identifier: data.public_user_data.identifier,
userId: data.public_user_data.user_id,
};
this.role = data.role;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}
Loading