chore(clerk-js): Add experimental tags

clerk · Nov 2, 2023 · c8d0d5d · c8d0d5d
1 parent 9f87347
commit c8d0d5d
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 0 deletions.
diff --git a/packages/clerk-js/src/core/resources/Permission.ts b/packages/clerk-js/src/core/resources/Permission.ts
@@ -3,6 +3,9 @@ import type { PermissionJSON, PermissionResource } from '@clerk/types';
 import { unixEpochToDate } from '../../utils/date';
 import { BaseResource } from './internal';
 
+/**
+ * @experimental
+ */
 export class Permission extends BaseResource implements PermissionResource {
   id!: string;
   key!: string;

diff --git a/packages/clerk-js/src/core/resources/Role.ts b/packages/clerk-js/src/core/resources/Role.ts
@@ -4,6 +4,9 @@ import { unixEpochToDate } from '../../utils/date';
 import { BaseResource } from './internal';
 import { Permission } from './Permission';
 
+/**
+ * @experimental
+ */
 export class Role extends BaseResource implements RoleResource {
   id!: string;
   key!: string;

diff --git a/packages/types/src/json.ts b/packages/types/src/json.ts
@@ -363,6 +363,9 @@ export interface OrganizationDomainJSON extends ClerkResourceJSON {
   total_pending_suggestions: number;
 }
 
+/**
+ * @experimental
+ */
 export interface RoleJSON extends ClerkResourceJSON {
   object: 'role';
   id: string;
@@ -374,6 +377,9 @@ export interface RoleJSON extends ClerkResourceJSON {
   updated_at: number;
 }
 
+/**
+ * @experimental
+ */
 export interface PermissionJSON extends ClerkResourceJSON {
   object: 'permission';
   id: string;

diff --git a/packages/types/src/localization.ts b/packages/types/src/localization.ts
@@ -15,6 +15,11 @@ export type LocalizationResource = DeepPartial<_LocalizationResource>;
 
 type _LocalizationResource = {
   locale: string;
+  /**
+   * @experimental
+   * Add role keys and their localized value
+   * e.g. roles:{ 'org:teacher': 'Teacher'}
+   */
   roles: {
     [r: string]: LocalizationValue;
   };

diff --git a/packages/types/src/organization.ts b/packages/types/src/organization.ts
@@ -50,6 +50,9 @@ export interface OrganizationResource extends ClerkResource {
    */
   getPendingInvitations: (params?: GetPendingInvitationsParams) => Promise<OrganizationInvitationResource[]>;
   getInvitations: (params?: GetInvitationsParams) => Promise<ClerkPaginatedResponse<OrganizationInvitationResource>>;
+  /**
+   * @experimental
+   */
   getRoles: (params?: GetRolesParams) => Promise<ClerkPaginatedResponse<RoleResource>>;
   getDomains: (params?: GetDomainsParams) => Promise<ClerkPaginatedResponse<OrganizationDomainResource>>;
   getMembershipRequests: (
@@ -73,6 +76,9 @@ export type GetMembershipsParams = {
   role?: MembershipRole[];
 } & ClerkPaginationParams;
 
+/**
+ * @experimental
+ */
 export type GetRolesParams = {
   /**
    * This is the starting point for your fetched results. The initial value persists between re-renders

diff --git a/packages/types/src/permission.ts b/packages/types/src/permission.ts
@@ -1,5 +1,8 @@
 import type { ClerkResource } from './resource';
 
+/**
+ * @experimental
+ */
 export interface PermissionResource extends ClerkResource {
   id: string;
   key: string;

diff --git a/packages/types/src/role.ts b/packages/types/src/role.ts
@@ -1,6 +1,9 @@
 import type { PermissionResource } from './permission';
 import type { ClerkResource } from './resource';
 
+/**
+ * @experimental
+ */
 export interface RoleResource extends ClerkResource {
   id: string;
   key: string;