chore(repo): Use markdown plugin for typedoc#5099

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
LekoArts merged 2 commits into from
Feb 7, 2025
Merged

chore(repo): Use markdown plugin for typedoc #5099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad24540
initial
LekoArts Feb 7, 2025
65b1862
add changeset
LekoArts Feb 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/late-bags-hang.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/types': patch
---

Small JSDoc and type improvements
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -128,7 +128,7 @@
"turbo": "^2.0.14",
"turbo-ignore": "^2.0.6",
"typedoc": "0.27.6",
"typedoc-plugin-missing-exports": "3.1.0",
"typedoc-plugin-markdown": "4.4.1",
"typescript": "catalog:repo",
"typescript-eslint": "8.21.0",
"uuid": "8.3.2",
Expand Down
2 changes: 1 addition & 1 deletion packages/shared/src/telemetry/throttler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ export class TelemetryEventThrottler {
#generateKey(event: TelemetryEvent): string {
const { sk: _sk, pk: _pk, payload, ...rest } = event;

const sanitizedEvent = {
const sanitizedEvent: Omit<TelemetryEvent, 'sk' | 'pk' | 'payload'> & TelemetryEvent['payload'] = {

@LekoArtsLekoArtsFeb 7, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Typedoc was complaining about the .map(key => sanitizedEvent[key]), line since it used string as the key

...payload,
...rest,
};
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/typedoc.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["./src/index.ts", "./src/react/index.ts"],
"compilerOptions": {
"noImplicitAny": false
}
}
156 changes: 6 additions & 150 deletions packages/types/src/hooks.ts
View file
Open in desktop

@LekoArtsLekoArtsFeb 7, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Was able to DRY up the comments after all, in Typedoc and in my testing it'll work like that

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ type CheckAuthorizationWithoutOrgOrUser = (params: Parameters<CheckAuthorization

/**
* Return values of the `useAuth()` hook
* @interface
*/
export type UseAuthReturn =
| {
Expand DownExpand Up@@ -63,137 +64,48 @@ export type UseAuthReturn =
getToken: GetToken;
}
| {
/**
* A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
*/
isLoaded: true;
/**
* A boolean that indicates whether a user is currently signed in.
*/
isSignedIn: false;
/**
* The ID of the current user.
*/
userId: null;
/**
* The ID for the current session.
*/
sessionId: null;
actor: null;
/**
* The ID of the user's active organization.
*/
orgId: null;
/**
* The current user's role in their active organization.
*/
orgRole: null;
/**
* The URL-friendly identifier of the user's active organization.
*/
orgSlug: null;
/**
* A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
*/
has: CheckAuthorizationWithoutOrgOrUser;
/**
* A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
*/
signOut: SignOut;
/**
* A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
*/
getToken: GetToken;
}
| {
/**
* A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
*/
isLoaded: true;
/**
* A boolean that indicates whether a user is currently signed in.
*/
isSignedIn: true;
/**
* The ID of the current user.
*/
userId: string;
/**
* The ID for the current session.
*/
sessionId: string;
actor: ActJWTClaim | null;
/**
* The ID of the user's active organization.
*/
orgId: null;
/**
* The current user's role in their active organization.
*/
orgRole: null;
/**
* The URL-friendly identifier of the user's active organization.
*/
orgSlug: null;
/**
* A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
*/
has: CheckAuthorizationWithCustomPermissions;
/**
* A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
*/
signOut: SignOut;
/**
* A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
*/
getToken: GetToken;
}
| {
/**
* A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
*/
isLoaded: true;
/**
* A boolean that indicates whether a user is currently signed in.
*/
isSignedIn: true;
/**
* The ID of the current user.
*/
userId: string;
/**
* The ID for the current session.
*/
sessionId: string;
actor: ActJWTClaim | null;
/**
* The ID of the user's active organization.
*/
orgId: string;
/**
* The current user's role in their active organization.
*/
orgRole: OrganizationCustomRoleKey;
/**
* The URL-friendly identifier of the user's active organization.
*/
orgSlug: string | null;
/**
* A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
*/
has: CheckAuthorizationWithCustomPermissions;
/**
* A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
*/
signOut: SignOut;
/**
* A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
*/
getToken: GetToken;
};

/**
* Return values of the `useSignIn()` hook
* @interface
*/
export type UseSignInReturn =
| {
Expand All@@ -211,22 +123,14 @@ export type UseSignInReturn =
setActive: undefined;
}
| {
/**
* A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
*/
isLoaded: true;
/**
* An object that contains the current sign-in attempt status and methods to create a new sign-in attempt.
*/
signIn: SignInResource;
/**
* A function that sets the active session.
*/
setActive: SetActive;
};

/**
* Return values of the `useSignUp()` hook
* @interface
*/
export type UseSignUpReturn =
| {
Expand All@@ -244,22 +148,14 @@ export type UseSignUpReturn =
setActive: undefined;
}
| {
/**
* A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
*/
isLoaded: true;
/**
* An object that contains the current sign-up attempt status and methods to create a new sign-up attempt.
*/
signUp: SignUpResource;
/**
* A function that sets the active session.
*/
setActive: SetActive;
};

/**
* Return values of the `useSession()` hook
* @interface
*/
export type UseSessionReturn =
| {
Expand All@@ -277,36 +173,19 @@ export type UseSessionReturn =
session: undefined;
}
| {
/**
* A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
*/
isLoaded: true;
/**
* A boolean that indicates whether a user is currently signed in.
*/
isSignedIn: false;
/**
* Holds the current active session for the user.
*/
session: null;
}
| {
/**
* A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
*/
isLoaded: true;
/**
* A boolean that indicates whether a user is currently signed in.
*/
isSignedIn: true;
/**
* Holds the current active session for the user.
*/
session: ActiveSessionResource;
};

/**
* Return values of the `useSessionList()` hook
* @interface
*/
export type UseSessionListReturn =
| {
Expand All@@ -324,22 +203,14 @@ export type UseSessionListReturn =
setActive: undefined;
}
| {
/**
* A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
*/
isLoaded: true;
/**
* A list of sessions that have been registered on the client device.
*/
sessions: SessionResource[];
/**
* A function that sets the active session and/or organization.
*/
setActive: SetActive;
};

/**
* Return values of the `useUser()` hook
* @interface
*/
export type UseUserReturn =
| {
Expand All@@ -358,26 +229,11 @@ export type UseUserReturn =
}
| {
isLoaded: true;
/**
* A boolean that indicates whether a user is currently signed in.
*/
isSignedIn: false;
/**
* The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
*/
user: null;
}
| {
/**
* A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
*/
isLoaded: true;
/**
* A boolean that indicates whether a user is currently signed in.
*/
isSignedIn: true;
/**
* The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
*/
user: UserResource;
};
15 changes: 8 additions & 7 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 14 additions & 3 deletions typedoc.config.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,13 +23,20 @@ function getPackages() {
return packages.filter(dir => !IGNORE_LIST.includes(dir)).map(dir => path.join('packages', dir));
}

/** @type {import("typedoc-plugin-markdown").PluginOptions} */
const typedocPluginMarkdownOptions = {
hidePageHeader: true,
hideBreadcrumbs: true,
hidePageTitle: true,
};

/** @type {Partial<import("typedoc").TypeDocOptions>} */
const config = {
out: './.typedoc/docs',
// TODO: Once we're happy with the output the JSON should be written to a non-gitignored location as we want to consume it in other places
json: './.typedoc/output.json',
entryPointStrategy: 'packages',
plugin: ['typedoc-plugin-missing-exports'],
plugin: ['typedoc-plugin-markdown'],
packageOptions: {
includeVersion: false,
excludePrivate: true,
Expand All@@ -39,11 +46,15 @@ const config = {
excludeInternal: true,
excludeNotDocumented: true,
gitRevision: 'main',
blockTags: [...OptionDefaults.blockTags, '@warning', '@note', '@important'],
blockTags: [...OptionDefaults.blockTags, '@warning', '@note', '@important', '@memberof'],
modifierTags: [...OptionDefaults.modifierTags],
exclude: ['src/**/*.test.ts', 'src/**/*.test.tsx'],
readme: 'none',
disableGit: true,
disableSources: true,
},
entryPoints: ['packages/nextjs', 'packages/react', 'packages/backend', 'packages/types'], // getPackages(),
entryPoints: ['packages/nextjs', 'packages/react', 'packages/shared', 'packages/types'], // getPackages(),
...typedocPluginMarkdownOptions,
};

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

Skip to content
chore(repo): Use markdown plugin for typedoc#5099

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

LekoArts
merged 2 commits into

from

Feb 7, 2025
 Merged


chore(repo): Use markdown plugin for typedoc
#5099
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ad24540

initial


LekoArts Feb 7, 2025
65b1862

add changeset


LekoArts Feb 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.changeset/late-bags-hang.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/types': patch
---

Small JSDoc and type improvements

2 changes: 1 addition & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,7 +128,7 @@
 "turbo": "^2.0.14",
 "turbo-ignore": "^2.0.6",
 "typedoc": "0.27.6",
 "typedoc-plugin-missing-exports": "3.1.0",
 "typedoc-plugin-markdown": "4.4.1",
 "typescript": "catalog:repo",
 "typescript-eslint": "8.21.0",
 "uuid": "8.3.2",
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/telemetry/throttler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ export class TelemetryEventThrottler {
 #generateKey(event: TelemetryEvent): string {
 const { sk: _sk, pk: _pk, payload, ...rest } = event;

 const sanitizedEvent = {
 const sanitizedEvent: Omit<TelemetryEvent, 'sk' | 'pk' | 'payload'> & TelemetryEvent['payload'] = {
@LekoArtsLekoArtsFeb 7, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Typedoc was complaining about the .map(key => sanitizedEvent[key]), line since it used string as the key
 ...payload,
 ...rest,
 };
Expand Down

7 changes: 7 additions & 0 deletions
packages/shared/typedoc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
{
 "$schema": "https://typedoc.org/schema.json",
 "entryPoints": ["./src/index.ts", "./src/react/index.ts"],
 "compilerOptions": {
 "noImplicitAny": false
 }
}

156 changes: 6 additions & 150 deletions
packages/types/src/hooks.ts

View file


Open in desktop

@LekoArtsLekoArtsFeb 7, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Was able to DRY up the comments after all, in Typedoc and in my testing it'll work like that
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ type CheckAuthorizationWithoutOrgOrUser = (params: Parameters<CheckAuthorization

/**
 * Return values of the `useAuth()` hook
 * @interface
 */
export type UseAuthReturn =
 | {
Expand DownExpand Up@@ -63,137 +64,48 @@ export type UseAuthReturn =
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * The ID of the current user.
 */
 userId: null;
 /**
 * The ID for the current session.
 */
 sessionId: null;
 actor: null;
 /**
 * The ID of the user's active organization.
 */
 orgId: null;
 /**
 * The current user's role in their active organization.
 */
 orgRole: null;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithoutOrgOrUser;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The ID of the current user.
 */
 userId: string;
 /**
 * The ID for the current session.
 */
 sessionId: string;
 actor: ActJWTClaim | null;
 /**
 * The ID of the user's active organization.
 */
 orgId: null;
 /**
 * The current user's role in their active organization.
 */
 orgRole: null;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithCustomPermissions;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The ID of the current user.
 */
 userId: string;
 /**
 * The ID for the current session.
 */
 sessionId: string;
 actor: ActJWTClaim | null;
 /**
 * The ID of the user's active organization.
 */
 orgId: string;
 /**
 * The current user's role in their active organization.
 */
 orgRole: OrganizationCustomRoleKey;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: string | null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithCustomPermissions;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 };

/**
 * Return values of the `useSignIn()` hook
 * @interface
 */
export type UseSignInReturn =
 | {
Expand All@@ -211,22 +123,14 @@ export type UseSignInReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * An object that contains the current sign-in attempt status and methods to create a new sign-in attempt.
 */
 signIn: SignInResource;
 /**
 * A function that sets the active session.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useSignUp()` hook
 * @interface
 */
export type UseSignUpReturn =
 | {
Expand All@@ -244,22 +148,14 @@ export type UseSignUpReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * An object that contains the current sign-up attempt status and methods to create a new sign-up attempt.
 */
 signUp: SignUpResource;
 /**
 * A function that sets the active session.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useSession()` hook
 * @interface
 */
export type UseSessionReturn =
 | {
Expand All@@ -277,36 +173,19 @@ export type UseSessionReturn =
 session: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * Holds the current active session for the user.
 */
 session: null;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * Holds the current active session for the user.
 */
 session: ActiveSessionResource;
 };

/**
 * Return values of the `useSessionList()` hook
 * @interface
 */
export type UseSessionListReturn =
 | {
Expand All@@ -324,22 +203,14 @@ export type UseSessionListReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A list of sessions that have been registered on the client device.
 */
 sessions: SessionResource[];
 /**
 * A function that sets the active session and/or organization.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useUser()` hook
 * @interface
 */
export type UseUserReturn =
 | {
Expand All@@ -358,26 +229,11 @@ export type UseUserReturn =
 }
 | {
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
 */
 user: null;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
 */
 user: UserResource;
 };

15 changes: 8 additions & 7 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


17 changes: 14 additions & 3 deletions
typedoc.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,13 +23,20 @@ function getPackages() {
 return packages.filter(dir => !IGNORE_LIST.includes(dir)).map(dir => path.join('packages', dir));
}

/** @type {import("typedoc-plugin-markdown").PluginOptions} */
const typedocPluginMarkdownOptions = {
 hidePageHeader: true,
 hideBreadcrumbs: true,
 hidePageTitle: true,
};

/** @type {Partial<import("typedoc").TypeDocOptions>} */
const config = {
 out: './.typedoc/docs',
 // TODO: Once we're happy with the output the JSON should be written to a non-gitignored location as we want to consume it in other places
 json: './.typedoc/output.json',
 entryPointStrategy: 'packages',
 plugin: ['typedoc-plugin-missing-exports'],
 plugin: ['typedoc-plugin-markdown'],
 packageOptions: {
 includeVersion: false,
 excludePrivate: true,
Expand All@@ -39,11 +46,15 @@ const config = {
 excludeInternal: true,
 excludeNotDocumented: true,
 gitRevision: 'main',
 blockTags: [...OptionDefaults.blockTags, '@warning', '@note', '@important'],
 blockTags: [...OptionDefaults.blockTags, '@warning', '@note', '@important', '@memberof'],
 modifierTags: [...OptionDefaults.modifierTags],
 exclude: ['src/**/*.test.ts', 'src/**/*.test.tsx'],
 readme: 'none',
 disableGit: true,
 disableSources: true,
 },
 entryPoints: ['packages/nextjs', 'packages/react', 'packages/backend', 'packages/types'], // getPackages(),
 entryPoints: ['packages/nextjs', 'packages/react', 'packages/shared', 'packages/types'], // getPackages(),
 ...typedocPluginMarkdownOptions,
};

export default config;

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

Skip to content
chore(repo): Use markdown plugin for typedoc#5099

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

LekoArts
merged 2 commits into

from

Feb 7, 2025
 Merged


chore(repo): Use markdown plugin for typedoc
#5099
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ad24540

initial


LekoArts Feb 7, 2025
65b1862

add changeset


LekoArts Feb 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.changeset/late-bags-hang.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/types': patch
---

Small JSDoc and type improvements

2 changes: 1 addition & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,7 +128,7 @@
 "turbo": "^2.0.14",
 "turbo-ignore": "^2.0.6",
 "typedoc": "0.27.6",
 "typedoc-plugin-missing-exports": "3.1.0",
 "typedoc-plugin-markdown": "4.4.1",
 "typescript": "catalog:repo",
 "typescript-eslint": "8.21.0",
 "uuid": "8.3.2",
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/telemetry/throttler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ export class TelemetryEventThrottler {
 #generateKey(event: TelemetryEvent): string {
 const { sk: _sk, pk: _pk, payload, ...rest } = event;

 const sanitizedEvent = {
 const sanitizedEvent: Omit<TelemetryEvent, 'sk' | 'pk' | 'payload'> & TelemetryEvent['payload'] = {
@LekoArtsLekoArtsFeb 7, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Typedoc was complaining about the .map(key => sanitizedEvent[key]), line since it used string as the key
 ...payload,
 ...rest,
 };
Expand Down

7 changes: 7 additions & 0 deletions
packages/shared/typedoc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
{
 "$schema": "https://typedoc.org/schema.json",
 "entryPoints": ["./src/index.ts", "./src/react/index.ts"],
 "compilerOptions": {
 "noImplicitAny": false
 }
}

156 changes: 6 additions & 150 deletions
packages/types/src/hooks.ts

View file


Open in desktop

@LekoArtsLekoArtsFeb 7, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Was able to DRY up the comments after all, in Typedoc and in my testing it'll work like that
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ type CheckAuthorizationWithoutOrgOrUser = (params: Parameters<CheckAuthorization

/**
 * Return values of the `useAuth()` hook
 * @interface
 */
export type UseAuthReturn =
 | {
Expand DownExpand Up@@ -63,137 +64,48 @@ export type UseAuthReturn =
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * The ID of the current user.
 */
 userId: null;
 /**
 * The ID for the current session.
 */
 sessionId: null;
 actor: null;
 /**
 * The ID of the user's active organization.
 */
 orgId: null;
 /**
 * The current user's role in their active organization.
 */
 orgRole: null;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithoutOrgOrUser;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The ID of the current user.
 */
 userId: string;
 /**
 * The ID for the current session.
 */
 sessionId: string;
 actor: ActJWTClaim | null;
 /**
 * The ID of the user's active organization.
 */
 orgId: null;
 /**
 * The current user's role in their active organization.
 */
 orgRole: null;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithCustomPermissions;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The ID of the current user.
 */
 userId: string;
 /**
 * The ID for the current session.
 */
 sessionId: string;
 actor: ActJWTClaim | null;
 /**
 * The ID of the user's active organization.
 */
 orgId: string;
 /**
 * The current user's role in their active organization.
 */
 orgRole: OrganizationCustomRoleKey;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: string | null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithCustomPermissions;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 };

/**
 * Return values of the `useSignIn()` hook
 * @interface
 */
export type UseSignInReturn =
 | {
Expand All@@ -211,22 +123,14 @@ export type UseSignInReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * An object that contains the current sign-in attempt status and methods to create a new sign-in attempt.
 */
 signIn: SignInResource;
 /**
 * A function that sets the active session.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useSignUp()` hook
 * @interface
 */
export type UseSignUpReturn =
 | {
Expand All@@ -244,22 +148,14 @@ export type UseSignUpReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * An object that contains the current sign-up attempt status and methods to create a new sign-up attempt.
 */
 signUp: SignUpResource;
 /**
 * A function that sets the active session.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useSession()` hook
 * @interface
 */
export type UseSessionReturn =
 | {
Expand All@@ -277,36 +173,19 @@ export type UseSessionReturn =
 session: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * Holds the current active session for the user.
 */
 session: null;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * Holds the current active session for the user.
 */
 session: ActiveSessionResource;
 };

/**
 * Return values of the `useSessionList()` hook
 * @interface
 */
export type UseSessionListReturn =
 | {
Expand All@@ -324,22 +203,14 @@ export type UseSessionListReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A list of sessions that have been registered on the client device.
 */
 sessions: SessionResource[];
 /**
 * A function that sets the active session and/or organization.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useUser()` hook
 * @interface
 */
export type UseUserReturn =
 | {
Expand All@@ -358,26 +229,11 @@ export type UseUserReturn =
 }
 | {
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
 */
 user: null;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
 */
 user: UserResource;
 };

15 changes: 8 additions & 7 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


17 changes: 14 additions & 3 deletions
typedoc.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,13 +23,20 @@ function getPackages() {
 return packages.filter(dir => !IGNORE_LIST.includes(dir)).map(dir => path.join('packages', dir));
}

/** @type {import("typedoc-plugin-markdown").PluginOptions} */
const typedocPluginMarkdownOptions = {
 hidePageHeader: true,
 hideBreadcrumbs: true,
 hidePageTitle: true,
};

/** @type {Partial<import("typedoc").TypeDocOptions>} */
const config = {
 out: './.typedoc/docs',
 // TODO: Once we're happy with the output the JSON should be written to a non-gitignored location as we want to consume it in other places
 json: './.typedoc/output.json',
 entryPointStrategy: 'packages',
 plugin: ['typedoc-plugin-missing-exports'],
 plugin: ['typedoc-plugin-markdown'],
 packageOptions: {
 includeVersion: false,
 excludePrivate: true,
Expand All@@ -39,11 +46,15 @@ const config = {
 excludeInternal: true,
 excludeNotDocumented: true,
 gitRevision: 'main',
 blockTags: [...OptionDefaults.blockTags, '@warning', '@note', '@important'],
 blockTags: [...OptionDefaults.blockTags, '@warning', '@note', '@important', '@memberof'],
 modifierTags: [...OptionDefaults.modifierTags],
 exclude: ['src/**/*.test.ts', 'src/**/*.test.tsx'],
 readme: 'none',
 disableGit: true,
 disableSources: true,
 },
 entryPoints: ['packages/nextjs', 'packages/react', 'packages/backend', 'packages/types'], // getPackages(),
 entryPoints: ['packages/nextjs', 'packages/react', 'packages/shared', 'packages/types'], // getPackages(),
 ...typedocPluginMarkdownOptions,
};

export default config;

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

Skip to content
chore(repo): Use markdown plugin for typedoc#5099

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

LekoArts
merged 2 commits into

from

Feb 7, 2025
 Merged


chore(repo): Use markdown plugin for typedoc
#5099
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ad24540

initial


LekoArts Feb 7, 2025
65b1862

add changeset


LekoArts Feb 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.changeset/late-bags-hang.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/types': patch
---

Small JSDoc and type improvements

2 changes: 1 addition & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,7 +128,7 @@
 "turbo": "^2.0.14",
 "turbo-ignore": "^2.0.6",
 "typedoc": "0.27.6",
 "typedoc-plugin-missing-exports": "3.1.0",
 "typedoc-plugin-markdown": "4.4.1",
 "typescript": "catalog:repo",
 "typescript-eslint": "8.21.0",
 "uuid": "8.3.2",
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/telemetry/throttler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ export class TelemetryEventThrottler {
 #generateKey(event: TelemetryEvent): string {
 const { sk: _sk, pk: _pk, payload, ...rest } = event;

 const sanitizedEvent = {
 const sanitizedEvent: Omit<TelemetryEvent, 'sk' | 'pk' | 'payload'> & TelemetryEvent['payload'] = {
@LekoArtsLekoArtsFeb 7, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Typedoc was complaining about the .map(key => sanitizedEvent[key]), line since it used string as the key
 ...payload,
 ...rest,
 };
Expand Down

7 changes: 7 additions & 0 deletions
packages/shared/typedoc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
{
 "$schema": "https://typedoc.org/schema.json",
 "entryPoints": ["./src/index.ts", "./src/react/index.ts"],
 "compilerOptions": {
 "noImplicitAny": false
 }
}

156 changes: 6 additions & 150 deletions
packages/types/src/hooks.ts

View file


Open in desktop

@LekoArtsLekoArtsFeb 7, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Was able to DRY up the comments after all, in Typedoc and in my testing it'll work like that
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ type CheckAuthorizationWithoutOrgOrUser = (params: Parameters<CheckAuthorization

/**
 * Return values of the `useAuth()` hook
 * @interface
 */
export type UseAuthReturn =
 | {
Expand DownExpand Up@@ -63,137 +64,48 @@ export type UseAuthReturn =
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * The ID of the current user.
 */
 userId: null;
 /**
 * The ID for the current session.
 */
 sessionId: null;
 actor: null;
 /**
 * The ID of the user's active organization.
 */
 orgId: null;
 /**
 * The current user's role in their active organization.
 */
 orgRole: null;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithoutOrgOrUser;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The ID of the current user.
 */
 userId: string;
 /**
 * The ID for the current session.
 */
 sessionId: string;
 actor: ActJWTClaim | null;
 /**
 * The ID of the user's active organization.
 */
 orgId: null;
 /**
 * The current user's role in their active organization.
 */
 orgRole: null;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithCustomPermissions;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The ID of the current user.
 */
 userId: string;
 /**
 * The ID for the current session.
 */
 sessionId: string;
 actor: ActJWTClaim | null;
 /**
 * The ID of the user's active organization.
 */
 orgId: string;
 /**
 * The current user's role in their active organization.
 */
 orgRole: OrganizationCustomRoleKey;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: string | null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithCustomPermissions;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 };

/**
 * Return values of the `useSignIn()` hook
 * @interface
 */
export type UseSignInReturn =
 | {
Expand All@@ -211,22 +123,14 @@ export type UseSignInReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * An object that contains the current sign-in attempt status and methods to create a new sign-in attempt.
 */
 signIn: SignInResource;
 /**
 * A function that sets the active session.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useSignUp()` hook
 * @interface
 */
export type UseSignUpReturn =
 | {
Expand All@@ -244,22 +148,14 @@ export type UseSignUpReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * An object that contains the current sign-up attempt status and methods to create a new sign-up attempt.
 */
 signUp: SignUpResource;
 /**
 * A function that sets the active session.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useSession()` hook
 * @interface
 */
export type UseSessionReturn =
 | {
Expand All@@ -277,36 +173,19 @@ export type UseSessionReturn =
 session: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * Holds the current active session for the user.
 */
 session: null;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * Holds the current active session for the user.
 */
 session: ActiveSessionResource;
 };

/**
 * Return values of the `useSessionList()` hook
 * @interface
 */
export type UseSessionListReturn =
 | {
Expand All@@ -324,22 +203,14 @@ export type UseSessionListReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A list of sessions that have been registered on the client device.
 */
 sessions: SessionResource[];
 /**
 * A function that sets the active session and/or organization.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useUser()` hook
 * @interface
 */
export type UseUserReturn =
 | {
Expand All@@ -358,26 +229,11 @@ export type UseUserReturn =
 }
 | {
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
 */
 user: null;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
 */
 user: UserResource;
 };

15 changes: 8 additions & 7 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


17 changes: 14 additions & 3 deletions
typedoc.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,13 +23,20 @@ function getPackages() {
 return packages.filter(dir => !IGNORE_LIST.includes(dir)).map(dir => path.join('packages', dir));
}

/** @type {import("typedoc-plugin-markdown").PluginOptions} */
const typedocPluginMarkdownOptions = {
 hidePageHeader: true,
 hideBreadcrumbs: true,
 hidePageTitle: true,
};

/** @type {Partial<import("typedoc").TypeDocOptions>} */
const config = {
 out: './.typedoc/docs',
 // TODO: Once we're happy with the output the JSON should be written to a non-gitignored location as we want to consume it in other places
 json: './.typedoc/output.json',
 entryPointStrategy: 'packages',
 plugin: ['typedoc-plugin-missing-exports'],
 plugin: ['typedoc-plugin-markdown'],
 packageOptions: {
 includeVersion: false,
 excludePrivate: true,
Expand All@@ -39,11 +46,15 @@ const config = {
 excludeInternal: true,
 excludeNotDocumented: true,
 gitRevision: 'main',
 blockTags: [...OptionDefaults.blockTags, '@warning', '@note', '@important'],
 blockTags: [...OptionDefaults.blockTags, '@warning', '@note', '@important', '@memberof'],
 modifierTags: [...OptionDefaults.modifierTags],
 exclude: ['src/**/*.test.ts', 'src/**/*.test.tsx'],
 readme: 'none',
 disableGit: true,
 disableSources: true,
 },
 entryPoints: ['packages/nextjs', 'packages/react', 'packages/backend', 'packages/types'], // getPackages(),
 entryPoints: ['packages/nextjs', 'packages/react', 'packages/shared', 'packages/types'], // getPackages(),
 ...typedocPluginMarkdownOptions,
};

export default config;

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

Skip to content
chore(repo): Use markdown plugin for typedoc#5099

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

LekoArts
merged 2 commits into

from

Feb 7, 2025
 Merged


chore(repo): Use markdown plugin for typedoc
#5099
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ad24540

initial


LekoArts Feb 7, 2025
65b1862

add changeset


LekoArts Feb 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.changeset/late-bags-hang.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/types': patch
---

Small JSDoc and type improvements

2 changes: 1 addition & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,7 +128,7 @@
 "turbo": "^2.0.14",
 "turbo-ignore": "^2.0.6",
 "typedoc": "0.27.6",
 "typedoc-plugin-missing-exports": "3.1.0",
 "typedoc-plugin-markdown": "4.4.1",
 "typescript": "catalog:repo",
 "typescript-eslint": "8.21.0",
 "uuid": "8.3.2",
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/telemetry/throttler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ export class TelemetryEventThrottler {
 #generateKey(event: TelemetryEvent): string {
 const { sk: _sk, pk: _pk, payload, ...rest } = event;

 const sanitizedEvent = {
 const sanitizedEvent: Omit<TelemetryEvent, 'sk' | 'pk' | 'payload'> & TelemetryEvent['payload'] = {
@LekoArtsLekoArtsFeb 7, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Typedoc was complaining about the .map(key => sanitizedEvent[key]), line since it used string as the key
 ...payload,
 ...rest,
 };
Expand Down

7 changes: 7 additions & 0 deletions
packages/shared/typedoc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
{
 "$schema": "https://typedoc.org/schema.json",
 "entryPoints": ["./src/index.ts", "./src/react/index.ts"],
 "compilerOptions": {
 "noImplicitAny": false
 }
}

156 changes: 6 additions & 150 deletions
packages/types/src/hooks.ts

View file


Open in desktop

@LekoArtsLekoArtsFeb 7, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Was able to DRY up the comments after all, in Typedoc and in my testing it'll work like that
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ type CheckAuthorizationWithoutOrgOrUser = (params: Parameters<CheckAuthorization

/**
 * Return values of the `useAuth()` hook
 * @interface
 */
export type UseAuthReturn =
 | {
Expand DownExpand Up@@ -63,137 +64,48 @@ export type UseAuthReturn =
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * The ID of the current user.
 */
 userId: null;
 /**
 * The ID for the current session.
 */
 sessionId: null;
 actor: null;
 /**
 * The ID of the user's active organization.
 */
 orgId: null;
 /**
 * The current user's role in their active organization.
 */
 orgRole: null;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithoutOrgOrUser;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The ID of the current user.
 */
 userId: string;
 /**
 * The ID for the current session.
 */
 sessionId: string;
 actor: ActJWTClaim | null;
 /**
 * The ID of the user's active organization.
 */
 orgId: null;
 /**
 * The current user's role in their active organization.
 */
 orgRole: null;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithCustomPermissions;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The ID of the current user.
 */
 userId: string;
 /**
 * The ID for the current session.
 */
 sessionId: string;
 actor: ActJWTClaim | null;
 /**
 * The ID of the user's active organization.
 */
 orgId: string;
 /**
 * The current user's role in their active organization.
 */
 orgRole: OrganizationCustomRoleKey;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: string | null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithCustomPermissions;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 };

/**
 * Return values of the `useSignIn()` hook
 * @interface
 */
export type UseSignInReturn =
 | {
Expand All@@ -211,22 +123,14 @@ export type UseSignInReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * An object that contains the current sign-in attempt status and methods to create a new sign-in attempt.
 */
 signIn: SignInResource;
 /**
 * A function that sets the active session.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useSignUp()` hook
 * @interface
 */
export type UseSignUpReturn =
 | {
Expand All@@ -244,22 +148,14 @@ export type UseSignUpReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * An object that contains the current sign-up attempt status and methods to create a new sign-up attempt.
 */
 signUp: SignUpResource;
 /**
 * A function that sets the active session.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useSession()` hook
 * @interface
 */
export type UseSessionReturn =
 | {
Expand All@@ -277,36 +173,19 @@ export type UseSessionReturn =
 session: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * Holds the current active session for the user.
 */
 session: null;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * Holds the current active session for the user.
 */
 session: ActiveSessionResource;
 };

/**
 * Return values of the `useSessionList()` hook
 * @interface
 */
export type UseSessionListReturn =
 | {
Expand All@@ -324,22 +203,14 @@ export type UseSessionListReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A list of sessions that have been registered on the client device.
 */
 sessions: SessionResource[];
 /**
 * A function that sets the active session and/or organization.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useUser()` hook
 * @interface
 */
export type UseUserReturn =
 | {
Expand All@@ -358,26 +229,11 @@ export type UseUserReturn =
 }
 | {
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
 */
 user: null;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
 */
 user: UserResource;
 };

15 changes: 8 additions & 7 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


17 changes: 14 additions & 3 deletions
typedoc.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,13 +23,20 @@ function getPackages() {
 return packages.filter(dir => !IGNORE_LIST.includes(dir)).map(dir => path.join('packages', dir));
}

/** @type {import("typedoc-plugin-markdown").PluginOptions} */
const typedocPluginMarkdownOptions = {
 hidePageHeader: true,
 hideBreadcrumbs: true,
 hidePageTitle: true,
};

/** @type {Partial<import("typedoc").TypeDocOptions>} */
const config = {
 out: './.typedoc/docs',
 // TODO: Once we're happy with the output the JSON should be written to a non-gitignored location as we want to consume it in other places
 json: './.typedoc/output.json',
 entryPointStrategy: 'packages',
 plugin: ['typedoc-plugin-missing-exports'],
 plugin: ['typedoc-plugin-markdown'],
 packageOptions: {
 includeVersion: false,
 excludePrivate: true,
Expand All@@ -39,11 +46,15 @@ const config = {
 excludeInternal: true,
 excludeNotDocumented: true,
 gitRevision: 'main',
 blockTags: [...OptionDefaults.blockTags, '@warning', '@note', '@important'],
 blockTags: [...OptionDefaults.blockTags, '@warning', '@note', '@important', '@memberof'],
 modifierTags: [...OptionDefaults.modifierTags],
 exclude: ['src/**/*.test.ts', 'src/**/*.test.tsx'],
 readme: 'none',
 disableGit: true,
 disableSources: true,
 },
 entryPoints: ['packages/nextjs', 'packages/react', 'packages/backend', 'packages/types'], // getPackages(),
 entryPoints: ['packages/nextjs', 'packages/react', 'packages/shared', 'packages/types'], // getPackages(),
 ...typedocPluginMarkdownOptions,
};

export default config;

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

Skip to content
chore(repo): Use markdown plugin for typedoc#5099

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

LekoArts
merged 2 commits into

from

Feb 7, 2025
 Merged


chore(repo): Use markdown plugin for typedoc
#5099
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ad24540

initial


LekoArts Feb 7, 2025
65b1862

add changeset


LekoArts Feb 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.changeset/late-bags-hang.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/types': patch
---

Small JSDoc and type improvements

2 changes: 1 addition & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,7 +128,7 @@
 "turbo": "^2.0.14",
 "turbo-ignore": "^2.0.6",
 "typedoc": "0.27.6",
 "typedoc-plugin-missing-exports": "3.1.0",
 "typedoc-plugin-markdown": "4.4.1",
 "typescript": "catalog:repo",
 "typescript-eslint": "8.21.0",
 "uuid": "8.3.2",
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/telemetry/throttler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ export class TelemetryEventThrottler {
 #generateKey(event: TelemetryEvent): string {
 const { sk: _sk, pk: _pk, payload, ...rest } = event;

 const sanitizedEvent = {
 const sanitizedEvent: Omit<TelemetryEvent, 'sk' | 'pk' | 'payload'> & TelemetryEvent['payload'] = {
@LekoArtsLekoArtsFeb 7, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Typedoc was complaining about the .map(key => sanitizedEvent[key]), line since it used string as the key
 ...payload,
 ...rest,
 };
Expand Down

7 changes: 7 additions & 0 deletions
packages/shared/typedoc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
{
 "$schema": "https://typedoc.org/schema.json",
 "entryPoints": ["./src/index.ts", "./src/react/index.ts"],
 "compilerOptions": {
 "noImplicitAny": false
 }
}

156 changes: 6 additions & 150 deletions
packages/types/src/hooks.ts

View file


Open in desktop

@LekoArtsLekoArtsFeb 7, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Was able to DRY up the comments after all, in Typedoc and in my testing it'll work like that
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ type CheckAuthorizationWithoutOrgOrUser = (params: Parameters<CheckAuthorization

/**
 * Return values of the `useAuth()` hook
 * @interface
 */
export type UseAuthReturn =
 | {
Expand DownExpand Up@@ -63,137 +64,48 @@ export type UseAuthReturn =
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * The ID of the current user.
 */
 userId: null;
 /**
 * The ID for the current session.
 */
 sessionId: null;
 actor: null;
 /**
 * The ID of the user's active organization.
 */
 orgId: null;
 /**
 * The current user's role in their active organization.
 */
 orgRole: null;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithoutOrgOrUser;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The ID of the current user.
 */
 userId: string;
 /**
 * The ID for the current session.
 */
 sessionId: string;
 actor: ActJWTClaim | null;
 /**
 * The ID of the user's active organization.
 */
 orgId: null;
 /**
 * The current user's role in their active organization.
 */
 orgRole: null;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithCustomPermissions;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The ID of the current user.
 */
 userId: string;
 /**
 * The ID for the current session.
 */
 sessionId: string;
 actor: ActJWTClaim | null;
 /**
 * The ID of the user's active organization.
 */
 orgId: string;
 /**
 * The current user's role in their active organization.
 */
 orgRole: OrganizationCustomRoleKey;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: string | null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithCustomPermissions;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 };

/**
 * Return values of the `useSignIn()` hook
 * @interface
 */
export type UseSignInReturn =
 | {
Expand All@@ -211,22 +123,14 @@ export type UseSignInReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * An object that contains the current sign-in attempt status and methods to create a new sign-in attempt.
 */
 signIn: SignInResource;
 /**
 * A function that sets the active session.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useSignUp()` hook
 * @interface
 */
export type UseSignUpReturn =
 | {
Expand All@@ -244,22 +148,14 @@ export type UseSignUpReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * An object that contains the current sign-up attempt status and methods to create a new sign-up attempt.
 */
 signUp: SignUpResource;
 /**
 * A function that sets the active session.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useSession()` hook
 * @interface
 */
export type UseSessionReturn =
 | {
Expand All@@ -277,36 +173,19 @@ export type UseSessionReturn =
 session: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * Holds the current active session for the user.
 */
 session: null;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * Holds the current active session for the user.
 */
 session: ActiveSessionResource;
 };

/**
 * Return values of the `useSessionList()` hook
 * @interface
 */
export type UseSessionListReturn =
 | {
Expand All@@ -324,22 +203,14 @@ export type UseSessionListReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A list of sessions that have been registered on the client device.
 */
 sessions: SessionResource[];
 /**
 * A function that sets the active session and/or organization.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useUser()` hook
 * @interface
 */
export type UseUserReturn =
 | {
Expand All@@ -358,26 +229,11 @@ export type UseUserReturn =
 }
 | {
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
 */
 user: null;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
 */
 user: UserResource;
 };

15 changes: 8 additions & 7 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


17 changes: 14 additions & 3 deletions
typedoc.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,13 +23,20 @@ function getPackages() {
 return packages.filter(dir => !IGNORE_LIST.includes(dir)).map(dir => path.join('packages', dir));
}

/** @type {import("typedoc-plugin-markdown").PluginOptions} */
const typedocPluginMarkdownOptions = {
 hidePageHeader: true,
 hideBreadcrumbs: true,
 hidePageTitle: true,
};

/** @type {Partial<import("typedoc").TypeDocOptions>} */
const config = {
 out: './.typedoc/docs',
 // TODO: Once we're happy with the output the JSON should be written to a non-gitignored location as we want to consume it in other places
 json: './.typedoc/output.json',
 entryPointStrategy: 'packages',
 plugin: ['typedoc-plugin-missing-exports'],
 plugin: ['typedoc-plugin-markdown'],
 packageOptions: {
 includeVersion: false,
 excludePrivate: true,
Expand All@@ -39,11 +46,15 @@ const config = {
 excludeInternal: true,
 excludeNotDocumented: true,
 gitRevision: 'main',
 blockTags: [...OptionDefaults.blockTags, '@warning', '@note', '@important'],
 blockTags: [...OptionDefaults.blockTags, '@warning', '@note', '@important', '@memberof'],
 modifierTags: [...OptionDefaults.modifierTags],
 exclude: ['src/**/*.test.ts', 'src/**/*.test.tsx'],
 readme: 'none',
 disableGit: true,
 disableSources: true,
 },
 entryPoints: ['packages/nextjs', 'packages/react', 'packages/backend', 'packages/types'], // getPackages(),
 entryPoints: ['packages/nextjs', 'packages/react', 'packages/shared', 'packages/types'], // getPackages(),
 ...typedocPluginMarkdownOptions,
};

export default config;

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

Skip to content
chore(repo): Use markdown plugin for typedoc#5099

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

LekoArts
merged 2 commits into

from

Feb 7, 2025
 Merged


chore(repo): Use markdown plugin for typedoc
#5099
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ad24540

initial


LekoArts Feb 7, 2025
65b1862

add changeset


LekoArts Feb 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.changeset/late-bags-hang.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/types': patch
---

Small JSDoc and type improvements

2 changes: 1 addition & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,7 +128,7 @@
 "turbo": "^2.0.14",
 "turbo-ignore": "^2.0.6",
 "typedoc": "0.27.6",
 "typedoc-plugin-missing-exports": "3.1.0",
 "typedoc-plugin-markdown": "4.4.1",
 "typescript": "catalog:repo",
 "typescript-eslint": "8.21.0",
 "uuid": "8.3.2",
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/telemetry/throttler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ export class TelemetryEventThrottler {
 #generateKey(event: TelemetryEvent): string {
 const { sk: _sk, pk: _pk, payload, ...rest } = event;

 const sanitizedEvent = {
 const sanitizedEvent: Omit<TelemetryEvent, 'sk' | 'pk' | 'payload'> & TelemetryEvent['payload'] = {
@LekoArtsLekoArtsFeb 7, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Typedoc was complaining about the .map(key => sanitizedEvent[key]), line since it used string as the key
 ...payload,
 ...rest,
 };
Expand Down

7 changes: 7 additions & 0 deletions
packages/shared/typedoc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
{
 "$schema": "https://typedoc.org/schema.json",
 "entryPoints": ["./src/index.ts", "./src/react/index.ts"],
 "compilerOptions": {
 "noImplicitAny": false
 }
}

156 changes: 6 additions & 150 deletions
packages/types/src/hooks.ts

View file


Open in desktop

@LekoArtsLekoArtsFeb 7, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Was able to DRY up the comments after all, in Typedoc and in my testing it'll work like that
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ type CheckAuthorizationWithoutOrgOrUser = (params: Parameters<CheckAuthorization

/**
 * Return values of the `useAuth()` hook
 * @interface
 */
export type UseAuthReturn =
 | {
Expand DownExpand Up@@ -63,137 +64,48 @@ export type UseAuthReturn =
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * The ID of the current user.
 */
 userId: null;
 /**
 * The ID for the current session.
 */
 sessionId: null;
 actor: null;
 /**
 * The ID of the user's active organization.
 */
 orgId: null;
 /**
 * The current user's role in their active organization.
 */
 orgRole: null;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithoutOrgOrUser;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The ID of the current user.
 */
 userId: string;
 /**
 * The ID for the current session.
 */
 sessionId: string;
 actor: ActJWTClaim | null;
 /**
 * The ID of the user's active organization.
 */
 orgId: null;
 /**
 * The current user's role in their active organization.
 */
 orgRole: null;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithCustomPermissions;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The ID of the current user.
 */
 userId: string;
 /**
 * The ID for the current session.
 */
 sessionId: string;
 actor: ActJWTClaim | null;
 /**
 * The ID of the user's active organization.
 */
 orgId: string;
 /**
 * The current user's role in their active organization.
 */
 orgRole: OrganizationCustomRoleKey;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: string | null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithCustomPermissions;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 };

/**
 * Return values of the `useSignIn()` hook
 * @interface
 */
export type UseSignInReturn =
 | {
Expand All@@ -211,22 +123,14 @@ export type UseSignInReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * An object that contains the current sign-in attempt status and methods to create a new sign-in attempt.
 */
 signIn: SignInResource;
 /**
 * A function that sets the active session.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useSignUp()` hook
 * @interface
 */
export type UseSignUpReturn =
 | {
Expand All@@ -244,22 +148,14 @@ export type UseSignUpReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * An object that contains the current sign-up attempt status and methods to create a new sign-up attempt.
 */
 signUp: SignUpResource;
 /**
 * A function that sets the active session.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useSession()` hook
 * @interface
 */
export type UseSessionReturn =
 | {
Expand All@@ -277,36 +173,19 @@ export type UseSessionReturn =
 session: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * Holds the current active session for the user.
 */
 session: null;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * Holds the current active session for the user.
 */
 session: ActiveSessionResource;
 };

/**
 * Return values of the `useSessionList()` hook
 * @interface
 */
export type UseSessionListReturn =
 | {
Expand All@@ -324,22 +203,14 @@ export type UseSessionListReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A list of sessions that have been registered on the client device.
 */
 sessions: SessionResource[];
 /**
 * A function that sets the active session and/or organization.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useUser()` hook
 * @interface
 */
export type UseUserReturn =
 | {
Expand All@@ -358,26 +229,11 @@ export type UseUserReturn =
 }
 | {
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
 */
 user: null;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
 */
 user: UserResource;
 };

15 changes: 8 additions & 7 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


17 changes: 14 additions & 3 deletions
typedoc.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,13 +23,20 @@ function getPackages() {
 return packages.filter(dir => !IGNORE_LIST.includes(dir)).map(dir => path.join('packages', dir));
}

/** @type {import("typedoc-plugin-markdown").PluginOptions} */
const typedocPluginMarkdownOptions = {
 hidePageHeader: true,
 hideBreadcrumbs: true,
 hidePageTitle: true,
};

/** @type {Partial<import("typedoc").TypeDocOptions>} */
const config = {
 out: './.typedoc/docs',
 // TODO: Once we're happy with the output the JSON should be written to a non-gitignored location as we want to consume it in other places
 json: './.typedoc/output.json',
 entryPointStrategy: 'packages',
 plugin: ['typedoc-plugin-missing-exports'],
 plugin: ['typedoc-plugin-markdown'],
 packageOptions: {
 includeVersion: false,
 excludePrivate: true,
Expand All@@ -39,11 +46,15 @@ const config = {
 excludeInternal: true,
 excludeNotDocumented: true,
 gitRevision: 'main',
 blockTags: [...OptionDefaults.blockTags, '@warning', '@note', '@important'],
 blockTags: [...OptionDefaults.blockTags, '@warning', '@note', '@important', '@memberof'],
 modifierTags: [...OptionDefaults.modifierTags],
 exclude: ['src/**/*.test.ts', 'src/**/*.test.tsx'],
 readme: 'none',
 disableGit: true,
 disableSources: true,
 },
 entryPoints: ['packages/nextjs', 'packages/react', 'packages/backend', 'packages/types'], // getPackages(),
 entryPoints: ['packages/nextjs', 'packages/react', 'packages/shared', 'packages/types'], // getPackages(),
 ...typedocPluginMarkdownOptions,
};

export default config;

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

Skip to content
chore(repo): Use markdown plugin for typedoc#5099

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

LekoArts
merged 2 commits into

from

Feb 7, 2025
 Merged


chore(repo): Use markdown plugin for typedoc
#5099
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ad24540

initial


LekoArts Feb 7, 2025
65b1862

add changeset


LekoArts Feb 7, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.changeset/late-bags-hang.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/types': patch
---

Small JSDoc and type improvements

2 changes: 1 addition & 1 deletion
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,7 +128,7 @@
 "turbo": "^2.0.14",
 "turbo-ignore": "^2.0.6",
 "typedoc": "0.27.6",
 "typedoc-plugin-missing-exports": "3.1.0",
 "typedoc-plugin-markdown": "4.4.1",
 "typescript": "catalog:repo",
 "typescript-eslint": "8.21.0",
 "uuid": "8.3.2",
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/telemetry/throttler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@ export class TelemetryEventThrottler {
 #generateKey(event: TelemetryEvent): string {
 const { sk: _sk, pk: _pk, payload, ...rest } = event;

 const sanitizedEvent = {
 const sanitizedEvent: Omit<TelemetryEvent, 'sk' | 'pk' | 'payload'> & TelemetryEvent['payload'] = {
@LekoArtsLekoArtsFeb 7, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Typedoc was complaining about the .map(key => sanitizedEvent[key]), line since it used string as the key
 ...payload,
 ...rest,
 };
Expand Down

7 changes: 7 additions & 0 deletions
packages/shared/typedoc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
{
 "$schema": "https://typedoc.org/schema.json",
 "entryPoints": ["./src/index.ts", "./src/react/index.ts"],
 "compilerOptions": {
 "noImplicitAny": false
 }
}

156 changes: 6 additions & 150 deletions
packages/types/src/hooks.ts

View file


Open in desktop

@LekoArtsLekoArtsFeb 7, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Was able to DRY up the comments after all, in Typedoc and in my testing it'll work like that
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ type CheckAuthorizationWithoutOrgOrUser = (params: Parameters<CheckAuthorization

/**
 * Return values of the `useAuth()` hook
 * @interface
 */
export type UseAuthReturn =
 | {
Expand DownExpand Up@@ -63,137 +64,48 @@ export type UseAuthReturn =
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * The ID of the current user.
 */
 userId: null;
 /**
 * The ID for the current session.
 */
 sessionId: null;
 actor: null;
 /**
 * The ID of the user's active organization.
 */
 orgId: null;
 /**
 * The current user's role in their active organization.
 */
 orgRole: null;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithoutOrgOrUser;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The ID of the current user.
 */
 userId: string;
 /**
 * The ID for the current session.
 */
 sessionId: string;
 actor: ActJWTClaim | null;
 /**
 * The ID of the user's active organization.
 */
 orgId: null;
 /**
 * The current user's role in their active organization.
 */
 orgRole: null;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithCustomPermissions;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The ID of the current user.
 */
 userId: string;
 /**
 * The ID for the current session.
 */
 sessionId: string;
 actor: ActJWTClaim | null;
 /**
 * The ID of the user's active organization.
 */
 orgId: string;
 /**
 * The current user's role in their active organization.
 */
 orgRole: OrganizationCustomRoleKey;
 /**
 * The URL-friendly identifier of the user's active organization.
 */
 orgSlug: string | null;
 /**
 * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/references/backend/types/auth-object#has).
 */
 has: CheckAuthorizationWithCustomPermissions;
 /**
 * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/references/javascript/clerk/clerk#sign-out).
 */
 signOut: SignOut;
 /**
 * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
 */
 getToken: GetToken;
 };

/**
 * Return values of the `useSignIn()` hook
 * @interface
 */
export type UseSignInReturn =
 | {
Expand All@@ -211,22 +123,14 @@ export type UseSignInReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * An object that contains the current sign-in attempt status and methods to create a new sign-in attempt.
 */
 signIn: SignInResource;
 /**
 * A function that sets the active session.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useSignUp()` hook
 * @interface
 */
export type UseSignUpReturn =
 | {
Expand All@@ -244,22 +148,14 @@ export type UseSignUpReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * An object that contains the current sign-up attempt status and methods to create a new sign-up attempt.
 */
 signUp: SignUpResource;
 /**
 * A function that sets the active session.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useSession()` hook
 * @interface
 */
export type UseSessionReturn =
 | {
Expand All@@ -277,36 +173,19 @@ export type UseSessionReturn =
 session: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * Holds the current active session for the user.
 */
 session: null;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * Holds the current active session for the user.
 */
 session: ActiveSessionResource;
 };

/**
 * Return values of the `useSessionList()` hook
 * @interface
 */
export type UseSessionListReturn =
 | {
Expand All@@ -324,22 +203,14 @@ export type UseSessionListReturn =
 setActive: undefined;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A list of sessions that have been registered on the client device.
 */
 sessions: SessionResource[];
 /**
 * A function that sets the active session and/or organization.
 */
 setActive: SetActive;
 };

/**
 * Return values of the `useUser()` hook
 * @interface
 */
export type UseUserReturn =
 | {
Expand All@@ -358,26 +229,11 @@ export type UseUserReturn =
 }
 | {
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: false;
 /**
 * The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
 */
 user: null;
 }
 | {
 /**
 * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
 */
 isLoaded: true;
 /**
 * A boolean that indicates whether a user is currently signed in.
 */
 isSignedIn: true;
 /**
 * The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
 */
 user: UserResource;
 };

15 changes: 8 additions & 7 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


17 changes: 14 additions & 3 deletions
typedoc.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,13 +23,20 @@ function getPackages() {
 return packages.filter(dir => !IGNORE_LIST.includes(dir)).map(dir => path.join('packages', dir));
}

/** @type {import("typedoc-plugin-markdown").PluginOptions} */
const typedocPluginMarkdownOptions = {
 hidePageHeader: true,
 hideBreadcrumbs: true,
 hidePageTitle: true,
};

/** @type {Partial<import("typedoc").TypeDocOptions>} */
const config = {
 out: './.typedoc/docs',
 // TODO: Once we're happy with the output the JSON should be written to a non-gitignored location as we want to consume it in other places
 json: './.typedoc/output.json',
 entryPointStrategy: 'packages',
 plugin: ['typedoc-plugin-missing-exports'],
 plugin: ['typedoc-plugin-markdown'],
 packageOptions: {
 includeVersion: false,
 excludePrivate: true,
Expand All@@ -39,11 +46,15 @@ const config = {
 excludeInternal: true,
 excludeNotDocumented: true,
 gitRevision: 'main',
 blockTags: [...OptionDefaults.blockTags, '@warning', '@note', '@important'],
 blockTags: [...OptionDefaults.blockTags, '@warning', '@note', '@important', '@memberof'],
 modifierTags: [...OptionDefaults.modifierTags],
 exclude: ['src/**/*.test.ts', 'src/**/*.test.tsx'],
 readme: 'none',
 disableGit: true,
 disableSources: true,
 },
 entryPoints: ['packages/nextjs', 'packages/react', 'packages/backend', 'packages/types'], // getPackages(),
 entryPoints: ['packages/nextjs', 'packages/react', 'packages/shared', 'packages/types'], // getPackages(),
 ...typedocPluginMarkdownOptions,
};

export default config;