Skip to content

feat(backend): Introduce OrganizationPermissionAPI (#2178)#2185

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
panteliselef merged 1 commit into from
Nov 22, 2023
Merged

feat(backend): Introduce OrganizationPermissionAPI (#2178) #2185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/swift-rocks-nail.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-sdk-node': patch
'@clerk/backend': patch
'@clerk/nextjs': patch
---

Add OrganizationPermissionAPI for CRUD operations regarding instance level organization permissions.
69 changes: 69 additions & 0 deletions packages/backend/src/api/endpoints/OrganizationPermissionApi.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import { joinPaths } from '../../util/path';
import type { DeletedObject, Permission } from '../resources';
import { AbstractAPI } from './AbstractApi';

const basePath = '/organizations_permissions';

type GetOrganizationPermissionListParams = {
limit?: number;
offset?: number;
query?: string;
orderBy?: string;
};

type CreateParams = {
name: string;
key: string;
description: string;
};

type GetOrganizationPermissionParams = { permissionId: string };

type UpdateParams = {
name?: string;
key?: string;
description?: string;
};

export class OrganizationPermissionAPI extends AbstractAPI {
public async getOrganizationPermissionList(params?: GetOrganizationPermissionListParams) {
return this.request<Permission[]>({
method: 'GET',
path: basePath,
queryParams: params,
});
}

public async createOrganizationPermission(params: CreateParams) {
return this.request<Permission>({
method: 'POST',
path: basePath,
bodyParams: params,
});
}

public async getOrganizationPermission(params: GetOrganizationPermissionParams) {
this.requireId(params.permissionId);

return this.request<Permission>({
method: 'GET',
path: joinPaths(basePath, params.permissionId),
});
}

public async updateOrganizationPermission(permissionId: string, params: UpdateParams) {
this.requireId(permissionId);
return this.request<Permission>({
method: 'PATCH',
path: joinPaths(basePath, permissionId),
bodyParams: params,
});
}

public async deleteOrganizationPermission(permissionId: string) {
return this.request<DeletedObject>({
method: 'DELETE',
path: joinPaths(basePath, permissionId),
});
}
}
1 change: 1 addition & 0 deletions packages/backend/src/api/endpoints/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ export * from './EmailApi';
export * from './InterstitialApi';
export * from './InvitationApi';
export * from './OrganizationApi';
export * from './OrganizationPermissionApi';
export * from './PhoneNumberApi';
export * from './RedirectUrlApi';
export * from './SessionApi';
Expand Down
3 changes: 2 additions & 1 deletion packages/backend/src/api/factory.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
InterstitialAPI,
InvitationAPI,
OrganizationAPI,
OrganizationPermissionAPI,
PhoneNumberAPI,
RedirectUrlAPI,
SessionAPI,
Expand DownExpand Up@@ -41,7 +42,6 @@ export type ApiClient = ReturnType<typeof createBackendApiClient>;

export function createBackendApiClient(options: CreateBackendApiOptions) {
const request = buildRequest(options);

return {
allowlistIdentifiers: new AllowlistIdentifierAPI(request),
clients: new ClientAPI(request),
Expand All@@ -50,6 +50,7 @@ export function createBackendApiClient(options: CreateBackendApiOptions) {
interstitial: new InterstitialAPI(request),
invitations: new InvitationAPI(request),
organizations: new OrganizationAPI(request),
organizationPermissions: new OrganizationPermissionAPI(request),
phoneNumbers: new PhoneNumberAPI(request),
redirectUrls: new RedirectUrlAPI(request),
sessions: new SessionAPI(request),
Expand Down
5 changes: 5 additions & 0 deletions packages/backend/src/api/resources/Enums.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ export type OAuthStrategy = `oauth_${OAuthProvider}`;

export type OrganizationInvitationStatus = 'pending' | 'accepted' | 'revoked';

export type PermissionType = 'system' | 'user';

/**
* @deprecated In the next major release this type will change to string
*/
export type OrganizationMembershipRole = 'basic_member' | 'guest_member' | 'admin';

export type SignInStatus = 'needs_identifier' | 'needs_factor_one' | 'needs_factor_two' | 'complete';
Expand Down
13 changes: 13 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type {
InvitationStatus,
OrganizationInvitationStatus,
OrganizationMembershipRole,
PermissionType,
SignInStatus,
SignUpAttributeRequirements,
SignUpStatus,
Expand All@@ -20,6 +21,7 @@ export enum ObjectType {
Organization = 'organization',
OrganizationInvitation = 'organization_invitation',
OrganizationMembership = 'organization_membership',
Permission = 'permission',
PhoneNumber = 'phone_number',
RedirectUrl = 'redirect_url',
Session = 'session',
Expand DownExpand Up@@ -184,6 +186,17 @@ export interface OrganizationMembershipPublicUserDataJSON {
user_id: string;
}

export interface PermissionJSON extends ClerkResourceJSON {
object: ObjectType.Permission;
id: string;
name: string;
key: string;
description: string;
type: PermissionType;
created_at: number;
updated_at: number;
}

export interface PhoneNumberJSON extends ClerkResourceJSON {
object: ObjectType.PhoneNumber;
phone_number: string;
Expand Down
18 changes: 18 additions & 0 deletions packages/backend/src/api/resources/Permission.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import type { PermissionType } from './Enums';
import type { PermissionJSON } from './JSON';

export class Permission {
constructor(
readonly id: string,
readonly name: string,
readonly key: string,
readonly description: string,
readonly type: PermissionType,
readonly createdAt: number,
readonly updatedAt: number,
) {}

static fromJSON(data: PermissionJSON) {
return new Permission(data.id, data.name, data.key, data.description, data.type, data.created_at, data.updated_at);
}
}
1 change: 1 addition & 0 deletions packages/backend/src/api/resources/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@ export * from './Invitation';
export * from './JSON';
export * from './OauthAccessToken';
export * from './Organization';
export * from './Permission';
export * from './OrganizationInvitation';
export * from './OrganizationMembership';
export * from './PhoneNumber';
Expand Down
1 change: 1 addition & 0 deletions packages/backend/src/exports.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ export default (QUnit: QUnit) => {
'OrganizationInvitation',
'OrganizationMembership',
'OrganizationMembershipPublicUserData',
'Permission',
'PhoneNumber',
'RedirectUrl',
'SMSMessage',
Expand Down
1 change: 1 addition & 0 deletions packages/nextjs/src/api/__tests__/__snapshots__/exports.test.ts.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ exports[`/api public exports should not include a breaking change 1`] = `
"OrganizationInvitation",
"OrganizationMembership",
"OrganizationMembershipPublicUserData",
"Permission",
"PhoneNumber",
"RedirectUrl",
"SMSMessage",
Expand Down
1 change: 1 addition & 0 deletions packages/nextjs/src/edge-middleware/__tests__/__snapshots__/exports.test.ts.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ exports[`/edge-middleware public exports should not include a breaking change 1`
"OrganizationInvitation",
"OrganizationMembership",
"OrganizationMembershipPublicUserData",
"Permission",
"PhoneNumber",
"RedirectUrl",
"SMSMessage",
Expand Down
1 change: 1 addition & 0 deletions packages/nextjs/src/server/__tests__/__snapshots__/exports.test.ts.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ exports[`/server public exports should not include a breaking change 1`] = `
"OrganizationMembershipPublicUserData",
"PROXY_URL",
"PUBLISHABLE_KEY",
"Permission",
"PhoneNumber",
"RedirectUrl",
"SECRET_KEY",
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ exports[`module exports should not change unless explicitly set 1`] = `
"OrganizationInvitation",
"OrganizationMembership",
"OrganizationMembershipPublicUserData",
"Permission",
"PhoneNumber",
"RedirectUrl",
"SMSMessage",
Expand DownExpand Up@@ -49,6 +50,7 @@ exports[`module exports should not change unless explicitly set 1`] = `
"invitations",
"loadInterstitialFromLocal",
"makeAuthObjectSerializable",
"organizationPermissions",
"organizations",
"phoneNumbers",
"prunePrivateMetadata",
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk-node/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ const {
emails,
invitations,
organizations,
organizationPermissions,
clients,
allowlistIdentifiers,
domains,
Expand All@@ -61,6 +62,7 @@ export {
emails,
invitations,
organizations,
organizationPermissions,
clients,
allowlistIdentifiers,
domains,
Expand Down
, '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(backend): Introduce OrganizationPermissionAPI (#2178) by panteliselef · Pull Request #2185 · clerk/javascript · GitHub
Skip to content
feat(backend): Introduce OrganizationPermissionAPI (#2178)#2185

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Nov 22, 2023
 Merged


feat(backend): Introduce OrganizationPermissionAPI (#2178)
#2185
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/swift-rocks-nail.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-sdk-node': patch
'@clerk/backend': patch
'@clerk/nextjs': patch
---

Add OrganizationPermissionAPI for CRUD operations regarding instance level organization permissions.

69 changes: 69 additions & 0 deletions
packages/backend/src/api/endpoints/OrganizationPermissionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import { joinPaths } from '../../util/path';
import type { DeletedObject, Permission } from '../resources';
import { AbstractAPI } from './AbstractApi';

const basePath = '/organizations_permissions';

type GetOrganizationPermissionListParams = {
 limit?: number;
 offset?: number;
 query?: string;
 orderBy?: string;
};

type CreateParams = {
 name: string;
 key: string;
 description: string;
};

type GetOrganizationPermissionParams = { permissionId: string };

type UpdateParams = {
 name?: string;
 key?: string;
 description?: string;
};

export class OrganizationPermissionAPI extends AbstractAPI {
 public async getOrganizationPermissionList(params?: GetOrganizationPermissionListParams) {
 return this.request<Permission[]>({
 method: 'GET',
 path: basePath,
 queryParams: params,
 });
 }

 public async createOrganizationPermission(params: CreateParams) {
 return this.request<Permission>({
 method: 'POST',
 path: basePath,
 bodyParams: params,
 });
 }

 public async getOrganizationPermission(params: GetOrganizationPermissionParams) {
 this.requireId(params.permissionId);

 return this.request<Permission>({
 method: 'GET',
 path: joinPaths(basePath, params.permissionId),
 });
 }

 public async updateOrganizationPermission(permissionId: string, params: UpdateParams) {
 this.requireId(permissionId);
 return this.request<Permission>({
 method: 'PATCH',
 path: joinPaths(basePath, permissionId),
 bodyParams: params,
 });
 }

 public async deleteOrganizationPermission(permissionId: string) {
 return this.request<DeletedObject>({
 method: 'DELETE',
 path: joinPaths(basePath, permissionId),
 });
 }
}

1 change: 1 addition & 0 deletions
packages/backend/src/api/endpoints/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ export * from './EmailApi';
export * from './InterstitialApi';
export * from './InvitationApi';
export * from './OrganizationApi';
export * from './OrganizationPermissionApi';
export * from './PhoneNumberApi';
export * from './RedirectUrlApi';
export * from './SessionApi';
Expand Down

3 changes: 2 additions & 1 deletion
packages/backend/src/api/factory.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
 InterstitialAPI,
 InvitationAPI,
 OrganizationAPI,
 OrganizationPermissionAPI,
 PhoneNumberAPI,
 RedirectUrlAPI,
 SessionAPI,
Expand DownExpand Up@@ -41,7 +42,6 @@ export type ApiClient = ReturnType<typeof createBackendApiClient>;

export function createBackendApiClient(options: CreateBackendApiOptions) {
 const request = buildRequest(options);

 return {
 allowlistIdentifiers: new AllowlistIdentifierAPI(request),
 clients: new ClientAPI(request),
Expand All@@ -50,6 +50,7 @@ export function createBackendApiClient(options: CreateBackendApiOptions) {
 interstitial: new InterstitialAPI(request),
 invitations: new InvitationAPI(request),
 organizations: new OrganizationAPI(request),
 organizationPermissions: new OrganizationPermissionAPI(request),
 phoneNumbers: new PhoneNumberAPI(request),
 redirectUrls: new RedirectUrlAPI(request),
 sessions: new SessionAPI(request),
Expand Down

5 changes: 5 additions & 0 deletions
packages/backend/src/api/resources/Enums.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ export type OAuthStrategy = `oauth_${OAuthProvider}`;

export type OrganizationInvitationStatus = 'pending' | 'accepted' | 'revoked';

export type PermissionType = 'system' | 'user';

/**
 * @deprecated In the next major release this type will change to string
 */
export type OrganizationMembershipRole = 'basic_member' | 'guest_member' | 'admin';

export type SignInStatus = 'needs_identifier' | 'needs_factor_one' | 'needs_factor_two' | 'complete';
Expand Down

13 changes: 13 additions & 0 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type {
 InvitationStatus,
 OrganizationInvitationStatus,
 OrganizationMembershipRole,
 PermissionType,
 SignInStatus,
 SignUpAttributeRequirements,
 SignUpStatus,
Expand All@@ -20,6 +21,7 @@ export enum ObjectType {
 Organization = 'organization',
 OrganizationInvitation = 'organization_invitation',
 OrganizationMembership = 'organization_membership',
 Permission = 'permission',
 PhoneNumber = 'phone_number',
 RedirectUrl = 'redirect_url',
 Session = 'session',
Expand DownExpand Up@@ -184,6 +186,17 @@ export interface OrganizationMembershipPublicUserDataJSON {
 user_id: string;
}

export interface PermissionJSON extends ClerkResourceJSON {
 object: ObjectType.Permission;
 id: string;
 name: string;
 key: string;
 description: string;
 type: PermissionType;
 created_at: number;
 updated_at: number;
}

export interface PhoneNumberJSON extends ClerkResourceJSON {
 object: ObjectType.PhoneNumber;
 phone_number: string;
Expand Down

18 changes: 18 additions & 0 deletions
packages/backend/src/api/resources/Permission.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import type { PermissionType } from './Enums';
import type { PermissionJSON } from './JSON';

export class Permission {
 constructor(
 readonly id: string,
 readonly name: string,
 readonly key: string,
 readonly description: string,
 readonly type: PermissionType,
 readonly createdAt: number,
 readonly updatedAt: number,
 ) {}

 static fromJSON(data: PermissionJSON) {
 return new Permission(data.id, data.name, data.key, data.description, data.type, data.created_at, data.updated_at);
 }
}

1 change: 1 addition & 0 deletions
packages/backend/src/api/resources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@ export * from './Invitation';
export * from './JSON';
export * from './OauthAccessToken';
export * from './Organization';
export * from './Permission';
export * from './OrganizationInvitation';
export * from './OrganizationMembership';
export * from './PhoneNumber';
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/exports.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ export default (QUnit: QUnit) => {
 'OrganizationInvitation',
 'OrganizationMembership',
 'OrganizationMembershipPublicUserData',
 'Permission',
 'PhoneNumber',
 'RedirectUrl',
 'SMSMessage',
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/api/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ exports[`/api public exports should not include a breaking change 1`] = `
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/edge-middleware/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ exports[`/edge-middleware public exports should not include a breaking change 1`
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/server/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ exports[`/server public exports should not include a breaking change 1`] = `
 "OrganizationMembershipPublicUserData",
 "PROXY_URL",
 "PUBLISHABLE_KEY",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SECRET_KEY",
Expand Down

2 changes: 2 additions & 0 deletions
packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ exports[`module exports should not change unless explicitly set 1`] = `
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand DownExpand Up@@ -49,6 +50,7 @@ exports[`module exports should not change unless explicitly set 1`] = `
 "invitations",
 "loadInterstitialFromLocal",
 "makeAuthObjectSerializable",
 "organizationPermissions",
 "organizations",
 "phoneNumbers",
 "prunePrivateMetadata",
Expand Down

2 changes: 2 additions & 0 deletions
packages/sdk-node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ const {
 emails,
 invitations,
 organizations,
 organizationPermissions,
 clients,
 allowlistIdentifiers,
 domains,
Expand All@@ -61,6 +62,7 @@ export {
 emails,
 invitations,
 organizations,
 organizationPermissions,
 clients,
 allowlistIdentifiers,
 domains,
Expand Down

, '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(backend): Introduce OrganizationPermissionAPI (#2178) by panteliselef · Pull Request #2185 · clerk/javascript · GitHub
Skip to content
feat(backend): Introduce OrganizationPermissionAPI (#2178)#2185

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Nov 22, 2023
 Merged


feat(backend): Introduce OrganizationPermissionAPI (#2178)
#2185
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/swift-rocks-nail.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-sdk-node': patch
'@clerk/backend': patch
'@clerk/nextjs': patch
---

Add OrganizationPermissionAPI for CRUD operations regarding instance level organization permissions.

69 changes: 69 additions & 0 deletions
packages/backend/src/api/endpoints/OrganizationPermissionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import { joinPaths } from '../../util/path';
import type { DeletedObject, Permission } from '../resources';
import { AbstractAPI } from './AbstractApi';

const basePath = '/organizations_permissions';

type GetOrganizationPermissionListParams = {
 limit?: number;
 offset?: number;
 query?: string;
 orderBy?: string;
};

type CreateParams = {
 name: string;
 key: string;
 description: string;
};

type GetOrganizationPermissionParams = { permissionId: string };

type UpdateParams = {
 name?: string;
 key?: string;
 description?: string;
};

export class OrganizationPermissionAPI extends AbstractAPI {
 public async getOrganizationPermissionList(params?: GetOrganizationPermissionListParams) {
 return this.request<Permission[]>({
 method: 'GET',
 path: basePath,
 queryParams: params,
 });
 }

 public async createOrganizationPermission(params: CreateParams) {
 return this.request<Permission>({
 method: 'POST',
 path: basePath,
 bodyParams: params,
 });
 }

 public async getOrganizationPermission(params: GetOrganizationPermissionParams) {
 this.requireId(params.permissionId);

 return this.request<Permission>({
 method: 'GET',
 path: joinPaths(basePath, params.permissionId),
 });
 }

 public async updateOrganizationPermission(permissionId: string, params: UpdateParams) {
 this.requireId(permissionId);
 return this.request<Permission>({
 method: 'PATCH',
 path: joinPaths(basePath, permissionId),
 bodyParams: params,
 });
 }

 public async deleteOrganizationPermission(permissionId: string) {
 return this.request<DeletedObject>({
 method: 'DELETE',
 path: joinPaths(basePath, permissionId),
 });
 }
}

1 change: 1 addition & 0 deletions
packages/backend/src/api/endpoints/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ export * from './EmailApi';
export * from './InterstitialApi';
export * from './InvitationApi';
export * from './OrganizationApi';
export * from './OrganizationPermissionApi';
export * from './PhoneNumberApi';
export * from './RedirectUrlApi';
export * from './SessionApi';
Expand Down

3 changes: 2 additions & 1 deletion
packages/backend/src/api/factory.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
 InterstitialAPI,
 InvitationAPI,
 OrganizationAPI,
 OrganizationPermissionAPI,
 PhoneNumberAPI,
 RedirectUrlAPI,
 SessionAPI,
Expand DownExpand Up@@ -41,7 +42,6 @@ export type ApiClient = ReturnType<typeof createBackendApiClient>;

export function createBackendApiClient(options: CreateBackendApiOptions) {
 const request = buildRequest(options);

 return {
 allowlistIdentifiers: new AllowlistIdentifierAPI(request),
 clients: new ClientAPI(request),
Expand All@@ -50,6 +50,7 @@ export function createBackendApiClient(options: CreateBackendApiOptions) {
 interstitial: new InterstitialAPI(request),
 invitations: new InvitationAPI(request),
 organizations: new OrganizationAPI(request),
 organizationPermissions: new OrganizationPermissionAPI(request),
 phoneNumbers: new PhoneNumberAPI(request),
 redirectUrls: new RedirectUrlAPI(request),
 sessions: new SessionAPI(request),
Expand Down

5 changes: 5 additions & 0 deletions
packages/backend/src/api/resources/Enums.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ export type OAuthStrategy = `oauth_${OAuthProvider}`;

export type OrganizationInvitationStatus = 'pending' | 'accepted' | 'revoked';

export type PermissionType = 'system' | 'user';

/**
 * @deprecated In the next major release this type will change to string
 */
export type OrganizationMembershipRole = 'basic_member' | 'guest_member' | 'admin';

export type SignInStatus = 'needs_identifier' | 'needs_factor_one' | 'needs_factor_two' | 'complete';
Expand Down

13 changes: 13 additions & 0 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type {
 InvitationStatus,
 OrganizationInvitationStatus,
 OrganizationMembershipRole,
 PermissionType,
 SignInStatus,
 SignUpAttributeRequirements,
 SignUpStatus,
Expand All@@ -20,6 +21,7 @@ export enum ObjectType {
 Organization = 'organization',
 OrganizationInvitation = 'organization_invitation',
 OrganizationMembership = 'organization_membership',
 Permission = 'permission',
 PhoneNumber = 'phone_number',
 RedirectUrl = 'redirect_url',
 Session = 'session',
Expand DownExpand Up@@ -184,6 +186,17 @@ export interface OrganizationMembershipPublicUserDataJSON {
 user_id: string;
}

export interface PermissionJSON extends ClerkResourceJSON {
 object: ObjectType.Permission;
 id: string;
 name: string;
 key: string;
 description: string;
 type: PermissionType;
 created_at: number;
 updated_at: number;
}

export interface PhoneNumberJSON extends ClerkResourceJSON {
 object: ObjectType.PhoneNumber;
 phone_number: string;
Expand Down

18 changes: 18 additions & 0 deletions
packages/backend/src/api/resources/Permission.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import type { PermissionType } from './Enums';
import type { PermissionJSON } from './JSON';

export class Permission {
 constructor(
 readonly id: string,
 readonly name: string,
 readonly key: string,
 readonly description: string,
 readonly type: PermissionType,
 readonly createdAt: number,
 readonly updatedAt: number,
 ) {}

 static fromJSON(data: PermissionJSON) {
 return new Permission(data.id, data.name, data.key, data.description, data.type, data.created_at, data.updated_at);
 }
}

1 change: 1 addition & 0 deletions
packages/backend/src/api/resources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@ export * from './Invitation';
export * from './JSON';
export * from './OauthAccessToken';
export * from './Organization';
export * from './Permission';
export * from './OrganizationInvitation';
export * from './OrganizationMembership';
export * from './PhoneNumber';
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/exports.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ export default (QUnit: QUnit) => {
 'OrganizationInvitation',
 'OrganizationMembership',
 'OrganizationMembershipPublicUserData',
 'Permission',
 'PhoneNumber',
 'RedirectUrl',
 'SMSMessage',
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/api/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ exports[`/api public exports should not include a breaking change 1`] = `
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/edge-middleware/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ exports[`/edge-middleware public exports should not include a breaking change 1`
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/server/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ exports[`/server public exports should not include a breaking change 1`] = `
 "OrganizationMembershipPublicUserData",
 "PROXY_URL",
 "PUBLISHABLE_KEY",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SECRET_KEY",
Expand Down

2 changes: 2 additions & 0 deletions
packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ exports[`module exports should not change unless explicitly set 1`] = `
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand DownExpand Up@@ -49,6 +50,7 @@ exports[`module exports should not change unless explicitly set 1`] = `
 "invitations",
 "loadInterstitialFromLocal",
 "makeAuthObjectSerializable",
 "organizationPermissions",
 "organizations",
 "phoneNumbers",
 "prunePrivateMetadata",
Expand Down

2 changes: 2 additions & 0 deletions
packages/sdk-node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ const {
 emails,
 invitations,
 organizations,
 organizationPermissions,
 clients,
 allowlistIdentifiers,
 domains,
Expand All@@ -61,6 +62,7 @@ export {
 emails,
 invitations,
 organizations,
 organizationPermissions,
 clients,
 allowlistIdentifiers,
 domains,
Expand Down

, '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(backend): Introduce OrganizationPermissionAPI (#2178) by panteliselef · Pull Request #2185 · clerk/javascript · GitHub
Skip to content
feat(backend): Introduce OrganizationPermissionAPI (#2178)#2185

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Nov 22, 2023
 Merged


feat(backend): Introduce OrganizationPermissionAPI (#2178)
#2185
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/swift-rocks-nail.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-sdk-node': patch
'@clerk/backend': patch
'@clerk/nextjs': patch
---

Add OrganizationPermissionAPI for CRUD operations regarding instance level organization permissions.

69 changes: 69 additions & 0 deletions
packages/backend/src/api/endpoints/OrganizationPermissionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import { joinPaths } from '../../util/path';
import type { DeletedObject, Permission } from '../resources';
import { AbstractAPI } from './AbstractApi';

const basePath = '/organizations_permissions';

type GetOrganizationPermissionListParams = {
 limit?: number;
 offset?: number;
 query?: string;
 orderBy?: string;
};

type CreateParams = {
 name: string;
 key: string;
 description: string;
};

type GetOrganizationPermissionParams = { permissionId: string };

type UpdateParams = {
 name?: string;
 key?: string;
 description?: string;
};

export class OrganizationPermissionAPI extends AbstractAPI {
 public async getOrganizationPermissionList(params?: GetOrganizationPermissionListParams) {
 return this.request<Permission[]>({
 method: 'GET',
 path: basePath,
 queryParams: params,
 });
 }

 public async createOrganizationPermission(params: CreateParams) {
 return this.request<Permission>({
 method: 'POST',
 path: basePath,
 bodyParams: params,
 });
 }

 public async getOrganizationPermission(params: GetOrganizationPermissionParams) {
 this.requireId(params.permissionId);

 return this.request<Permission>({
 method: 'GET',
 path: joinPaths(basePath, params.permissionId),
 });
 }

 public async updateOrganizationPermission(permissionId: string, params: UpdateParams) {
 this.requireId(permissionId);
 return this.request<Permission>({
 method: 'PATCH',
 path: joinPaths(basePath, permissionId),
 bodyParams: params,
 });
 }

 public async deleteOrganizationPermission(permissionId: string) {
 return this.request<DeletedObject>({
 method: 'DELETE',
 path: joinPaths(basePath, permissionId),
 });
 }
}

1 change: 1 addition & 0 deletions
packages/backend/src/api/endpoints/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ export * from './EmailApi';
export * from './InterstitialApi';
export * from './InvitationApi';
export * from './OrganizationApi';
export * from './OrganizationPermissionApi';
export * from './PhoneNumberApi';
export * from './RedirectUrlApi';
export * from './SessionApi';
Expand Down

3 changes: 2 additions & 1 deletion
packages/backend/src/api/factory.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
 InterstitialAPI,
 InvitationAPI,
 OrganizationAPI,
 OrganizationPermissionAPI,
 PhoneNumberAPI,
 RedirectUrlAPI,
 SessionAPI,
Expand DownExpand Up@@ -41,7 +42,6 @@ export type ApiClient = ReturnType<typeof createBackendApiClient>;

export function createBackendApiClient(options: CreateBackendApiOptions) {
 const request = buildRequest(options);

 return {
 allowlistIdentifiers: new AllowlistIdentifierAPI(request),
 clients: new ClientAPI(request),
Expand All@@ -50,6 +50,7 @@ export function createBackendApiClient(options: CreateBackendApiOptions) {
 interstitial: new InterstitialAPI(request),
 invitations: new InvitationAPI(request),
 organizations: new OrganizationAPI(request),
 organizationPermissions: new OrganizationPermissionAPI(request),
 phoneNumbers: new PhoneNumberAPI(request),
 redirectUrls: new RedirectUrlAPI(request),
 sessions: new SessionAPI(request),
Expand Down

5 changes: 5 additions & 0 deletions
packages/backend/src/api/resources/Enums.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ export type OAuthStrategy = `oauth_${OAuthProvider}`;

export type OrganizationInvitationStatus = 'pending' | 'accepted' | 'revoked';

export type PermissionType = 'system' | 'user';

/**
 * @deprecated In the next major release this type will change to string
 */
export type OrganizationMembershipRole = 'basic_member' | 'guest_member' | 'admin';

export type SignInStatus = 'needs_identifier' | 'needs_factor_one' | 'needs_factor_two' | 'complete';
Expand Down

13 changes: 13 additions & 0 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type {
 InvitationStatus,
 OrganizationInvitationStatus,
 OrganizationMembershipRole,
 PermissionType,
 SignInStatus,
 SignUpAttributeRequirements,
 SignUpStatus,
Expand All@@ -20,6 +21,7 @@ export enum ObjectType {
 Organization = 'organization',
 OrganizationInvitation = 'organization_invitation',
 OrganizationMembership = 'organization_membership',
 Permission = 'permission',
 PhoneNumber = 'phone_number',
 RedirectUrl = 'redirect_url',
 Session = 'session',
Expand DownExpand Up@@ -184,6 +186,17 @@ export interface OrganizationMembershipPublicUserDataJSON {
 user_id: string;
}

export interface PermissionJSON extends ClerkResourceJSON {
 object: ObjectType.Permission;
 id: string;
 name: string;
 key: string;
 description: string;
 type: PermissionType;
 created_at: number;
 updated_at: number;
}

export interface PhoneNumberJSON extends ClerkResourceJSON {
 object: ObjectType.PhoneNumber;
 phone_number: string;
Expand Down

18 changes: 18 additions & 0 deletions
packages/backend/src/api/resources/Permission.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import type { PermissionType } from './Enums';
import type { PermissionJSON } from './JSON';

export class Permission {
 constructor(
 readonly id: string,
 readonly name: string,
 readonly key: string,
 readonly description: string,
 readonly type: PermissionType,
 readonly createdAt: number,
 readonly updatedAt: number,
 ) {}

 static fromJSON(data: PermissionJSON) {
 return new Permission(data.id, data.name, data.key, data.description, data.type, data.created_at, data.updated_at);
 }
}

1 change: 1 addition & 0 deletions
packages/backend/src/api/resources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@ export * from './Invitation';
export * from './JSON';
export * from './OauthAccessToken';
export * from './Organization';
export * from './Permission';
export * from './OrganizationInvitation';
export * from './OrganizationMembership';
export * from './PhoneNumber';
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/exports.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ export default (QUnit: QUnit) => {
 'OrganizationInvitation',
 'OrganizationMembership',
 'OrganizationMembershipPublicUserData',
 'Permission',
 'PhoneNumber',
 'RedirectUrl',
 'SMSMessage',
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/api/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ exports[`/api public exports should not include a breaking change 1`] = `
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/edge-middleware/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ exports[`/edge-middleware public exports should not include a breaking change 1`
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/server/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ exports[`/server public exports should not include a breaking change 1`] = `
 "OrganizationMembershipPublicUserData",
 "PROXY_URL",
 "PUBLISHABLE_KEY",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SECRET_KEY",
Expand Down

2 changes: 2 additions & 0 deletions
packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ exports[`module exports should not change unless explicitly set 1`] = `
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand DownExpand Up@@ -49,6 +50,7 @@ exports[`module exports should not change unless explicitly set 1`] = `
 "invitations",
 "loadInterstitialFromLocal",
 "makeAuthObjectSerializable",
 "organizationPermissions",
 "organizations",
 "phoneNumbers",
 "prunePrivateMetadata",
Expand Down

2 changes: 2 additions & 0 deletions
packages/sdk-node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ const {
 emails,
 invitations,
 organizations,
 organizationPermissions,
 clients,
 allowlistIdentifiers,
 domains,
Expand All@@ -61,6 +62,7 @@ export {
 emails,
 invitations,
 organizations,
 organizationPermissions,
 clients,
 allowlistIdentifiers,
 domains,
Expand Down

, '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(backend): Introduce OrganizationPermissionAPI (#2178) by panteliselef · Pull Request #2185 · clerk/javascript · GitHub
Skip to content
feat(backend): Introduce OrganizationPermissionAPI (#2178)#2185

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Nov 22, 2023
 Merged


feat(backend): Introduce OrganizationPermissionAPI (#2178)
#2185
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/swift-rocks-nail.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-sdk-node': patch
'@clerk/backend': patch
'@clerk/nextjs': patch
---

Add OrganizationPermissionAPI for CRUD operations regarding instance level organization permissions.

69 changes: 69 additions & 0 deletions
packages/backend/src/api/endpoints/OrganizationPermissionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import { joinPaths } from '../../util/path';
import type { DeletedObject, Permission } from '../resources';
import { AbstractAPI } from './AbstractApi';

const basePath = '/organizations_permissions';

type GetOrganizationPermissionListParams = {
 limit?: number;
 offset?: number;
 query?: string;
 orderBy?: string;
};

type CreateParams = {
 name: string;
 key: string;
 description: string;
};

type GetOrganizationPermissionParams = { permissionId: string };

type UpdateParams = {
 name?: string;
 key?: string;
 description?: string;
};

export class OrganizationPermissionAPI extends AbstractAPI {
 public async getOrganizationPermissionList(params?: GetOrganizationPermissionListParams) {
 return this.request<Permission[]>({
 method: 'GET',
 path: basePath,
 queryParams: params,
 });
 }

 public async createOrganizationPermission(params: CreateParams) {
 return this.request<Permission>({
 method: 'POST',
 path: basePath,
 bodyParams: params,
 });
 }

 public async getOrganizationPermission(params: GetOrganizationPermissionParams) {
 this.requireId(params.permissionId);

 return this.request<Permission>({
 method: 'GET',
 path: joinPaths(basePath, params.permissionId),
 });
 }

 public async updateOrganizationPermission(permissionId: string, params: UpdateParams) {
 this.requireId(permissionId);
 return this.request<Permission>({
 method: 'PATCH',
 path: joinPaths(basePath, permissionId),
 bodyParams: params,
 });
 }

 public async deleteOrganizationPermission(permissionId: string) {
 return this.request<DeletedObject>({
 method: 'DELETE',
 path: joinPaths(basePath, permissionId),
 });
 }
}

1 change: 1 addition & 0 deletions
packages/backend/src/api/endpoints/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ export * from './EmailApi';
export * from './InterstitialApi';
export * from './InvitationApi';
export * from './OrganizationApi';
export * from './OrganizationPermissionApi';
export * from './PhoneNumberApi';
export * from './RedirectUrlApi';
export * from './SessionApi';
Expand Down

3 changes: 2 additions & 1 deletion
packages/backend/src/api/factory.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
 InterstitialAPI,
 InvitationAPI,
 OrganizationAPI,
 OrganizationPermissionAPI,
 PhoneNumberAPI,
 RedirectUrlAPI,
 SessionAPI,
Expand DownExpand Up@@ -41,7 +42,6 @@ export type ApiClient = ReturnType<typeof createBackendApiClient>;

export function createBackendApiClient(options: CreateBackendApiOptions) {
 const request = buildRequest(options);

 return {
 allowlistIdentifiers: new AllowlistIdentifierAPI(request),
 clients: new ClientAPI(request),
Expand All@@ -50,6 +50,7 @@ export function createBackendApiClient(options: CreateBackendApiOptions) {
 interstitial: new InterstitialAPI(request),
 invitations: new InvitationAPI(request),
 organizations: new OrganizationAPI(request),
 organizationPermissions: new OrganizationPermissionAPI(request),
 phoneNumbers: new PhoneNumberAPI(request),
 redirectUrls: new RedirectUrlAPI(request),
 sessions: new SessionAPI(request),
Expand Down

5 changes: 5 additions & 0 deletions
packages/backend/src/api/resources/Enums.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ export type OAuthStrategy = `oauth_${OAuthProvider}`;

export type OrganizationInvitationStatus = 'pending' | 'accepted' | 'revoked';

export type PermissionType = 'system' | 'user';

/**
 * @deprecated In the next major release this type will change to string
 */
export type OrganizationMembershipRole = 'basic_member' | 'guest_member' | 'admin';

export type SignInStatus = 'needs_identifier' | 'needs_factor_one' | 'needs_factor_two' | 'complete';
Expand Down

13 changes: 13 additions & 0 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type {
 InvitationStatus,
 OrganizationInvitationStatus,
 OrganizationMembershipRole,
 PermissionType,
 SignInStatus,
 SignUpAttributeRequirements,
 SignUpStatus,
Expand All@@ -20,6 +21,7 @@ export enum ObjectType {
 Organization = 'organization',
 OrganizationInvitation = 'organization_invitation',
 OrganizationMembership = 'organization_membership',
 Permission = 'permission',
 PhoneNumber = 'phone_number',
 RedirectUrl = 'redirect_url',
 Session = 'session',
Expand DownExpand Up@@ -184,6 +186,17 @@ export interface OrganizationMembershipPublicUserDataJSON {
 user_id: string;
}

export interface PermissionJSON extends ClerkResourceJSON {
 object: ObjectType.Permission;
 id: string;
 name: string;
 key: string;
 description: string;
 type: PermissionType;
 created_at: number;
 updated_at: number;
}

export interface PhoneNumberJSON extends ClerkResourceJSON {
 object: ObjectType.PhoneNumber;
 phone_number: string;
Expand Down

18 changes: 18 additions & 0 deletions
packages/backend/src/api/resources/Permission.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import type { PermissionType } from './Enums';
import type { PermissionJSON } from './JSON';

export class Permission {
 constructor(
 readonly id: string,
 readonly name: string,
 readonly key: string,
 readonly description: string,
 readonly type: PermissionType,
 readonly createdAt: number,
 readonly updatedAt: number,
 ) {}

 static fromJSON(data: PermissionJSON) {
 return new Permission(data.id, data.name, data.key, data.description, data.type, data.created_at, data.updated_at);
 }
}

1 change: 1 addition & 0 deletions
packages/backend/src/api/resources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@ export * from './Invitation';
export * from './JSON';
export * from './OauthAccessToken';
export * from './Organization';
export * from './Permission';
export * from './OrganizationInvitation';
export * from './OrganizationMembership';
export * from './PhoneNumber';
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/exports.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ export default (QUnit: QUnit) => {
 'OrganizationInvitation',
 'OrganizationMembership',
 'OrganizationMembershipPublicUserData',
 'Permission',
 'PhoneNumber',
 'RedirectUrl',
 'SMSMessage',
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/api/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ exports[`/api public exports should not include a breaking change 1`] = `
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/edge-middleware/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ exports[`/edge-middleware public exports should not include a breaking change 1`
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/server/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ exports[`/server public exports should not include a breaking change 1`] = `
 "OrganizationMembershipPublicUserData",
 "PROXY_URL",
 "PUBLISHABLE_KEY",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SECRET_KEY",
Expand Down

2 changes: 2 additions & 0 deletions
packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ exports[`module exports should not change unless explicitly set 1`] = `
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand DownExpand Up@@ -49,6 +50,7 @@ exports[`module exports should not change unless explicitly set 1`] = `
 "invitations",
 "loadInterstitialFromLocal",
 "makeAuthObjectSerializable",
 "organizationPermissions",
 "organizations",
 "phoneNumbers",
 "prunePrivateMetadata",
Expand Down

2 changes: 2 additions & 0 deletions
packages/sdk-node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ const {
 emails,
 invitations,
 organizations,
 organizationPermissions,
 clients,
 allowlistIdentifiers,
 domains,
Expand All@@ -61,6 +62,7 @@ export {
 emails,
 invitations,
 organizations,
 organizationPermissions,
 clients,
 allowlistIdentifiers,
 domains,
Expand Down

, '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(backend): Introduce OrganizationPermissionAPI (#2178) by panteliselef · Pull Request #2185 · clerk/javascript · GitHub
Skip to content
feat(backend): Introduce OrganizationPermissionAPI (#2178)#2185

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Nov 22, 2023
 Merged


feat(backend): Introduce OrganizationPermissionAPI (#2178)
#2185
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/swift-rocks-nail.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-sdk-node': patch
'@clerk/backend': patch
'@clerk/nextjs': patch
---

Add OrganizationPermissionAPI for CRUD operations regarding instance level organization permissions.

69 changes: 69 additions & 0 deletions
packages/backend/src/api/endpoints/OrganizationPermissionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import { joinPaths } from '../../util/path';
import type { DeletedObject, Permission } from '../resources';
import { AbstractAPI } from './AbstractApi';

const basePath = '/organizations_permissions';

type GetOrganizationPermissionListParams = {
 limit?: number;
 offset?: number;
 query?: string;
 orderBy?: string;
};

type CreateParams = {
 name: string;
 key: string;
 description: string;
};

type GetOrganizationPermissionParams = { permissionId: string };

type UpdateParams = {
 name?: string;
 key?: string;
 description?: string;
};

export class OrganizationPermissionAPI extends AbstractAPI {
 public async getOrganizationPermissionList(params?: GetOrganizationPermissionListParams) {
 return this.request<Permission[]>({
 method: 'GET',
 path: basePath,
 queryParams: params,
 });
 }

 public async createOrganizationPermission(params: CreateParams) {
 return this.request<Permission>({
 method: 'POST',
 path: basePath,
 bodyParams: params,
 });
 }

 public async getOrganizationPermission(params: GetOrganizationPermissionParams) {
 this.requireId(params.permissionId);

 return this.request<Permission>({
 method: 'GET',
 path: joinPaths(basePath, params.permissionId),
 });
 }

 public async updateOrganizationPermission(permissionId: string, params: UpdateParams) {
 this.requireId(permissionId);
 return this.request<Permission>({
 method: 'PATCH',
 path: joinPaths(basePath, permissionId),
 bodyParams: params,
 });
 }

 public async deleteOrganizationPermission(permissionId: string) {
 return this.request<DeletedObject>({
 method: 'DELETE',
 path: joinPaths(basePath, permissionId),
 });
 }
}

1 change: 1 addition & 0 deletions
packages/backend/src/api/endpoints/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ export * from './EmailApi';
export * from './InterstitialApi';
export * from './InvitationApi';
export * from './OrganizationApi';
export * from './OrganizationPermissionApi';
export * from './PhoneNumberApi';
export * from './RedirectUrlApi';
export * from './SessionApi';
Expand Down

3 changes: 2 additions & 1 deletion
packages/backend/src/api/factory.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
 InterstitialAPI,
 InvitationAPI,
 OrganizationAPI,
 OrganizationPermissionAPI,
 PhoneNumberAPI,
 RedirectUrlAPI,
 SessionAPI,
Expand DownExpand Up@@ -41,7 +42,6 @@ export type ApiClient = ReturnType<typeof createBackendApiClient>;

export function createBackendApiClient(options: CreateBackendApiOptions) {
 const request = buildRequest(options);

 return {
 allowlistIdentifiers: new AllowlistIdentifierAPI(request),
 clients: new ClientAPI(request),
Expand All@@ -50,6 +50,7 @@ export function createBackendApiClient(options: CreateBackendApiOptions) {
 interstitial: new InterstitialAPI(request),
 invitations: new InvitationAPI(request),
 organizations: new OrganizationAPI(request),
 organizationPermissions: new OrganizationPermissionAPI(request),
 phoneNumbers: new PhoneNumberAPI(request),
 redirectUrls: new RedirectUrlAPI(request),
 sessions: new SessionAPI(request),
Expand Down

5 changes: 5 additions & 0 deletions
packages/backend/src/api/resources/Enums.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ export type OAuthStrategy = `oauth_${OAuthProvider}`;

export type OrganizationInvitationStatus = 'pending' | 'accepted' | 'revoked';

export type PermissionType = 'system' | 'user';

/**
 * @deprecated In the next major release this type will change to string
 */
export type OrganizationMembershipRole = 'basic_member' | 'guest_member' | 'admin';

export type SignInStatus = 'needs_identifier' | 'needs_factor_one' | 'needs_factor_two' | 'complete';
Expand Down

13 changes: 13 additions & 0 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type {
 InvitationStatus,
 OrganizationInvitationStatus,
 OrganizationMembershipRole,
 PermissionType,
 SignInStatus,
 SignUpAttributeRequirements,
 SignUpStatus,
Expand All@@ -20,6 +21,7 @@ export enum ObjectType {
 Organization = 'organization',
 OrganizationInvitation = 'organization_invitation',
 OrganizationMembership = 'organization_membership',
 Permission = 'permission',
 PhoneNumber = 'phone_number',
 RedirectUrl = 'redirect_url',
 Session = 'session',
Expand DownExpand Up@@ -184,6 +186,17 @@ export interface OrganizationMembershipPublicUserDataJSON {
 user_id: string;
}

export interface PermissionJSON extends ClerkResourceJSON {
 object: ObjectType.Permission;
 id: string;
 name: string;
 key: string;
 description: string;
 type: PermissionType;
 created_at: number;
 updated_at: number;
}

export interface PhoneNumberJSON extends ClerkResourceJSON {
 object: ObjectType.PhoneNumber;
 phone_number: string;
Expand Down

18 changes: 18 additions & 0 deletions
packages/backend/src/api/resources/Permission.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import type { PermissionType } from './Enums';
import type { PermissionJSON } from './JSON';

export class Permission {
 constructor(
 readonly id: string,
 readonly name: string,
 readonly key: string,
 readonly description: string,
 readonly type: PermissionType,
 readonly createdAt: number,
 readonly updatedAt: number,
 ) {}

 static fromJSON(data: PermissionJSON) {
 return new Permission(data.id, data.name, data.key, data.description, data.type, data.created_at, data.updated_at);
 }
}

1 change: 1 addition & 0 deletions
packages/backend/src/api/resources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@ export * from './Invitation';
export * from './JSON';
export * from './OauthAccessToken';
export * from './Organization';
export * from './Permission';
export * from './OrganizationInvitation';
export * from './OrganizationMembership';
export * from './PhoneNumber';
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/exports.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ export default (QUnit: QUnit) => {
 'OrganizationInvitation',
 'OrganizationMembership',
 'OrganizationMembershipPublicUserData',
 'Permission',
 'PhoneNumber',
 'RedirectUrl',
 'SMSMessage',
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/api/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ exports[`/api public exports should not include a breaking change 1`] = `
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/edge-middleware/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ exports[`/edge-middleware public exports should not include a breaking change 1`
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/server/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ exports[`/server public exports should not include a breaking change 1`] = `
 "OrganizationMembershipPublicUserData",
 "PROXY_URL",
 "PUBLISHABLE_KEY",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SECRET_KEY",
Expand Down

2 changes: 2 additions & 0 deletions
packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ exports[`module exports should not change unless explicitly set 1`] = `
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand DownExpand Up@@ -49,6 +50,7 @@ exports[`module exports should not change unless explicitly set 1`] = `
 "invitations",
 "loadInterstitialFromLocal",
 "makeAuthObjectSerializable",
 "organizationPermissions",
 "organizations",
 "phoneNumbers",
 "prunePrivateMetadata",
Expand Down

2 changes: 2 additions & 0 deletions
packages/sdk-node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ const {
 emails,
 invitations,
 organizations,
 organizationPermissions,
 clients,
 allowlistIdentifiers,
 domains,
Expand All@@ -61,6 +62,7 @@ export {
 emails,
 invitations,
 organizations,
 organizationPermissions,
 clients,
 allowlistIdentifiers,
 domains,
Expand Down

, '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(backend): Introduce OrganizationPermissionAPI (#2178) by panteliselef · Pull Request #2185 · clerk/javascript · GitHub
Skip to content
feat(backend): Introduce OrganizationPermissionAPI (#2178)#2185

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Nov 22, 2023
 Merged


feat(backend): Introduce OrganizationPermissionAPI (#2178)
#2185
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/swift-rocks-nail.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-sdk-node': patch
'@clerk/backend': patch
'@clerk/nextjs': patch
---

Add OrganizationPermissionAPI for CRUD operations regarding instance level organization permissions.

69 changes: 69 additions & 0 deletions
packages/backend/src/api/endpoints/OrganizationPermissionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import { joinPaths } from '../../util/path';
import type { DeletedObject, Permission } from '../resources';
import { AbstractAPI } from './AbstractApi';

const basePath = '/organizations_permissions';

type GetOrganizationPermissionListParams = {
 limit?: number;
 offset?: number;
 query?: string;
 orderBy?: string;
};

type CreateParams = {
 name: string;
 key: string;
 description: string;
};

type GetOrganizationPermissionParams = { permissionId: string };

type UpdateParams = {
 name?: string;
 key?: string;
 description?: string;
};

export class OrganizationPermissionAPI extends AbstractAPI {
 public async getOrganizationPermissionList(params?: GetOrganizationPermissionListParams) {
 return this.request<Permission[]>({
 method: 'GET',
 path: basePath,
 queryParams: params,
 });
 }

 public async createOrganizationPermission(params: CreateParams) {
 return this.request<Permission>({
 method: 'POST',
 path: basePath,
 bodyParams: params,
 });
 }

 public async getOrganizationPermission(params: GetOrganizationPermissionParams) {
 this.requireId(params.permissionId);

 return this.request<Permission>({
 method: 'GET',
 path: joinPaths(basePath, params.permissionId),
 });
 }

 public async updateOrganizationPermission(permissionId: string, params: UpdateParams) {
 this.requireId(permissionId);
 return this.request<Permission>({
 method: 'PATCH',
 path: joinPaths(basePath, permissionId),
 bodyParams: params,
 });
 }

 public async deleteOrganizationPermission(permissionId: string) {
 return this.request<DeletedObject>({
 method: 'DELETE',
 path: joinPaths(basePath, permissionId),
 });
 }
}

1 change: 1 addition & 0 deletions
packages/backend/src/api/endpoints/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ export * from './EmailApi';
export * from './InterstitialApi';
export * from './InvitationApi';
export * from './OrganizationApi';
export * from './OrganizationPermissionApi';
export * from './PhoneNumberApi';
export * from './RedirectUrlApi';
export * from './SessionApi';
Expand Down

3 changes: 2 additions & 1 deletion
packages/backend/src/api/factory.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
 InterstitialAPI,
 InvitationAPI,
 OrganizationAPI,
 OrganizationPermissionAPI,
 PhoneNumberAPI,
 RedirectUrlAPI,
 SessionAPI,
Expand DownExpand Up@@ -41,7 +42,6 @@ export type ApiClient = ReturnType<typeof createBackendApiClient>;

export function createBackendApiClient(options: CreateBackendApiOptions) {
 const request = buildRequest(options);

 return {
 allowlistIdentifiers: new AllowlistIdentifierAPI(request),
 clients: new ClientAPI(request),
Expand All@@ -50,6 +50,7 @@ export function createBackendApiClient(options: CreateBackendApiOptions) {
 interstitial: new InterstitialAPI(request),
 invitations: new InvitationAPI(request),
 organizations: new OrganizationAPI(request),
 organizationPermissions: new OrganizationPermissionAPI(request),
 phoneNumbers: new PhoneNumberAPI(request),
 redirectUrls: new RedirectUrlAPI(request),
 sessions: new SessionAPI(request),
Expand Down

5 changes: 5 additions & 0 deletions
packages/backend/src/api/resources/Enums.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ export type OAuthStrategy = `oauth_${OAuthProvider}`;

export type OrganizationInvitationStatus = 'pending' | 'accepted' | 'revoked';

export type PermissionType = 'system' | 'user';

/**
 * @deprecated In the next major release this type will change to string
 */
export type OrganizationMembershipRole = 'basic_member' | 'guest_member' | 'admin';

export type SignInStatus = 'needs_identifier' | 'needs_factor_one' | 'needs_factor_two' | 'complete';
Expand Down

13 changes: 13 additions & 0 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type {
 InvitationStatus,
 OrganizationInvitationStatus,
 OrganizationMembershipRole,
 PermissionType,
 SignInStatus,
 SignUpAttributeRequirements,
 SignUpStatus,
Expand All@@ -20,6 +21,7 @@ export enum ObjectType {
 Organization = 'organization',
 OrganizationInvitation = 'organization_invitation',
 OrganizationMembership = 'organization_membership',
 Permission = 'permission',
 PhoneNumber = 'phone_number',
 RedirectUrl = 'redirect_url',
 Session = 'session',
Expand DownExpand Up@@ -184,6 +186,17 @@ export interface OrganizationMembershipPublicUserDataJSON {
 user_id: string;
}

export interface PermissionJSON extends ClerkResourceJSON {
 object: ObjectType.Permission;
 id: string;
 name: string;
 key: string;
 description: string;
 type: PermissionType;
 created_at: number;
 updated_at: number;
}

export interface PhoneNumberJSON extends ClerkResourceJSON {
 object: ObjectType.PhoneNumber;
 phone_number: string;
Expand Down

18 changes: 18 additions & 0 deletions
packages/backend/src/api/resources/Permission.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import type { PermissionType } from './Enums';
import type { PermissionJSON } from './JSON';

export class Permission {
 constructor(
 readonly id: string,
 readonly name: string,
 readonly key: string,
 readonly description: string,
 readonly type: PermissionType,
 readonly createdAt: number,
 readonly updatedAt: number,
 ) {}

 static fromJSON(data: PermissionJSON) {
 return new Permission(data.id, data.name, data.key, data.description, data.type, data.created_at, data.updated_at);
 }
}

1 change: 1 addition & 0 deletions
packages/backend/src/api/resources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@ export * from './Invitation';
export * from './JSON';
export * from './OauthAccessToken';
export * from './Organization';
export * from './Permission';
export * from './OrganizationInvitation';
export * from './OrganizationMembership';
export * from './PhoneNumber';
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/exports.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ export default (QUnit: QUnit) => {
 'OrganizationInvitation',
 'OrganizationMembership',
 'OrganizationMembershipPublicUserData',
 'Permission',
 'PhoneNumber',
 'RedirectUrl',
 'SMSMessage',
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/api/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ exports[`/api public exports should not include a breaking change 1`] = `
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/edge-middleware/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ exports[`/edge-middleware public exports should not include a breaking change 1`
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/server/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ exports[`/server public exports should not include a breaking change 1`] = `
 "OrganizationMembershipPublicUserData",
 "PROXY_URL",
 "PUBLISHABLE_KEY",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SECRET_KEY",
Expand Down

2 changes: 2 additions & 0 deletions
packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ exports[`module exports should not change unless explicitly set 1`] = `
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand DownExpand Up@@ -49,6 +50,7 @@ exports[`module exports should not change unless explicitly set 1`] = `
 "invitations",
 "loadInterstitialFromLocal",
 "makeAuthObjectSerializable",
 "organizationPermissions",
 "organizations",
 "phoneNumbers",
 "prunePrivateMetadata",
Expand Down

2 changes: 2 additions & 0 deletions
packages/sdk-node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ const {
 emails,
 invitations,
 organizations,
 organizationPermissions,
 clients,
 allowlistIdentifiers,
 domains,
Expand All@@ -61,6 +62,7 @@ export {
 emails,
 invitations,
 organizations,
 organizationPermissions,
 clients,
 allowlistIdentifiers,
 domains,
Expand Down

, '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(backend): Introduce OrganizationPermissionAPI (#2178) by panteliselef · Pull Request #2185 · clerk/javascript · GitHub
Skip to content
feat(backend): Introduce OrganizationPermissionAPI (#2178)#2185

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 1 commit into

from

Nov 22, 2023
 Merged


feat(backend): Introduce OrganizationPermissionAPI (#2178)
#2185
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/swift-rocks-nail.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-sdk-node': patch
'@clerk/backend': patch
'@clerk/nextjs': patch
---

Add OrganizationPermissionAPI for CRUD operations regarding instance level organization permissions.

69 changes: 69 additions & 0 deletions
packages/backend/src/api/endpoints/OrganizationPermissionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import { joinPaths } from '../../util/path';
import type { DeletedObject, Permission } from '../resources';
import { AbstractAPI } from './AbstractApi';

const basePath = '/organizations_permissions';

type GetOrganizationPermissionListParams = {
 limit?: number;
 offset?: number;
 query?: string;
 orderBy?: string;
};

type CreateParams = {
 name: string;
 key: string;
 description: string;
};

type GetOrganizationPermissionParams = { permissionId: string };

type UpdateParams = {
 name?: string;
 key?: string;
 description?: string;
};

export class OrganizationPermissionAPI extends AbstractAPI {
 public async getOrganizationPermissionList(params?: GetOrganizationPermissionListParams) {
 return this.request<Permission[]>({
 method: 'GET',
 path: basePath,
 queryParams: params,
 });
 }

 public async createOrganizationPermission(params: CreateParams) {
 return this.request<Permission>({
 method: 'POST',
 path: basePath,
 bodyParams: params,
 });
 }

 public async getOrganizationPermission(params: GetOrganizationPermissionParams) {
 this.requireId(params.permissionId);

 return this.request<Permission>({
 method: 'GET',
 path: joinPaths(basePath, params.permissionId),
 });
 }

 public async updateOrganizationPermission(permissionId: string, params: UpdateParams) {
 this.requireId(permissionId);
 return this.request<Permission>({
 method: 'PATCH',
 path: joinPaths(basePath, permissionId),
 bodyParams: params,
 });
 }

 public async deleteOrganizationPermission(permissionId: string) {
 return this.request<DeletedObject>({
 method: 'DELETE',
 path: joinPaths(basePath, permissionId),
 });
 }
}

1 change: 1 addition & 0 deletions
packages/backend/src/api/endpoints/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ export * from './EmailApi';
export * from './InterstitialApi';
export * from './InvitationApi';
export * from './OrganizationApi';
export * from './OrganizationPermissionApi';
export * from './PhoneNumberApi';
export * from './RedirectUrlApi';
export * from './SessionApi';
Expand Down

3 changes: 2 additions & 1 deletion
packages/backend/src/api/factory.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
 InterstitialAPI,
 InvitationAPI,
 OrganizationAPI,
 OrganizationPermissionAPI,
 PhoneNumberAPI,
 RedirectUrlAPI,
 SessionAPI,
Expand DownExpand Up@@ -41,7 +42,6 @@ export type ApiClient = ReturnType<typeof createBackendApiClient>;

export function createBackendApiClient(options: CreateBackendApiOptions) {
 const request = buildRequest(options);

 return {
 allowlistIdentifiers: new AllowlistIdentifierAPI(request),
 clients: new ClientAPI(request),
Expand All@@ -50,6 +50,7 @@ export function createBackendApiClient(options: CreateBackendApiOptions) {
 interstitial: new InterstitialAPI(request),
 invitations: new InvitationAPI(request),
 organizations: new OrganizationAPI(request),
 organizationPermissions: new OrganizationPermissionAPI(request),
 phoneNumbers: new PhoneNumberAPI(request),
 redirectUrls: new RedirectUrlAPI(request),
 sessions: new SessionAPI(request),
Expand Down

5 changes: 5 additions & 0 deletions
packages/backend/src/api/resources/Enums.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ export type OAuthStrategy = `oauth_${OAuthProvider}`;

export type OrganizationInvitationStatus = 'pending' | 'accepted' | 'revoked';

export type PermissionType = 'system' | 'user';

/**
 * @deprecated In the next major release this type will change to string
 */
export type OrganizationMembershipRole = 'basic_member' | 'guest_member' | 'admin';

export type SignInStatus = 'needs_identifier' | 'needs_factor_one' | 'needs_factor_two' | 'complete';
Expand Down

13 changes: 13 additions & 0 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type {
 InvitationStatus,
 OrganizationInvitationStatus,
 OrganizationMembershipRole,
 PermissionType,
 SignInStatus,
 SignUpAttributeRequirements,
 SignUpStatus,
Expand All@@ -20,6 +21,7 @@ export enum ObjectType {
 Organization = 'organization',
 OrganizationInvitation = 'organization_invitation',
 OrganizationMembership = 'organization_membership',
 Permission = 'permission',
 PhoneNumber = 'phone_number',
 RedirectUrl = 'redirect_url',
 Session = 'session',
Expand DownExpand Up@@ -184,6 +186,17 @@ export interface OrganizationMembershipPublicUserDataJSON {
 user_id: string;
}

export interface PermissionJSON extends ClerkResourceJSON {
 object: ObjectType.Permission;
 id: string;
 name: string;
 key: string;
 description: string;
 type: PermissionType;
 created_at: number;
 updated_at: number;
}

export interface PhoneNumberJSON extends ClerkResourceJSON {
 object: ObjectType.PhoneNumber;
 phone_number: string;
Expand Down

18 changes: 18 additions & 0 deletions
packages/backend/src/api/resources/Permission.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import type { PermissionType } from './Enums';
import type { PermissionJSON } from './JSON';

export class Permission {
 constructor(
 readonly id: string,
 readonly name: string,
 readonly key: string,
 readonly description: string,
 readonly type: PermissionType,
 readonly createdAt: number,
 readonly updatedAt: number,
 ) {}

 static fromJSON(data: PermissionJSON) {
 return new Permission(data.id, data.name, data.key, data.description, data.type, data.created_at, data.updated_at);
 }
}

1 change: 1 addition & 0 deletions
packages/backend/src/api/resources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@ export * from './Invitation';
export * from './JSON';
export * from './OauthAccessToken';
export * from './Organization';
export * from './Permission';
export * from './OrganizationInvitation';
export * from './OrganizationMembership';
export * from './PhoneNumber';
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/exports.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ export default (QUnit: QUnit) => {
 'OrganizationInvitation',
 'OrganizationMembership',
 'OrganizationMembershipPublicUserData',
 'Permission',
 'PhoneNumber',
 'RedirectUrl',
 'SMSMessage',
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/api/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ exports[`/api public exports should not include a breaking change 1`] = `
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/edge-middleware/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ exports[`/edge-middleware public exports should not include a breaking change 1`
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/server/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ exports[`/server public exports should not include a breaking change 1`] = `
 "OrganizationMembershipPublicUserData",
 "PROXY_URL",
 "PUBLISHABLE_KEY",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SECRET_KEY",
Expand Down

2 changes: 2 additions & 0 deletions
packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ exports[`module exports should not change unless explicitly set 1`] = `
 "OrganizationInvitation",
 "OrganizationMembership",
 "OrganizationMembershipPublicUserData",
 "Permission",
 "PhoneNumber",
 "RedirectUrl",
 "SMSMessage",
Expand DownExpand Up@@ -49,6 +50,7 @@ exports[`module exports should not change unless explicitly set 1`] = `
 "invitations",
 "loadInterstitialFromLocal",
 "makeAuthObjectSerializable",
 "organizationPermissions",
 "organizations",
 "phoneNumbers",
 "prunePrivateMetadata",
Expand Down

2 changes: 2 additions & 0 deletions
packages/sdk-node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ const {
 emails,
 invitations,
 organizations,
 organizationPermissions,
 clients,
 allowlistIdentifiers,
 domains,
Expand All@@ -61,6 +62,7 @@ export {
 emails,
 invitations,
 organizations,
 organizationPermissions,
 clients,
 allowlistIdentifiers,
 domains,
Expand Down