From a83c7b5a3f83baa421c166b59171898f9de986e1 Mon Sep 17 00:00:00 2001 From: wobsoriano Date: Sun, 14 Sep 2025 10:23:22 -0700 Subject: [PATCH 1/5] chore(backend): Add JSDoc around machines and m2m resource types --- packages/backend/src/api/resources/M2MToken.ts | 3 +++ packages/backend/src/api/resources/Machine.ts | 3 +++ packages/backend/src/api/resources/MachineScope.ts | 3 +++ 3 files changed, 9 insertions(+) diff --git a/packages/backend/src/api/resources/M2MToken.ts b/packages/backend/src/api/resources/M2MToken.ts index db8437ff0a7..48ccf78bf1d 100644 --- a/packages/backend/src/api/resources/M2MToken.ts +++ b/packages/backend/src/api/resources/M2MToken.ts @@ -1,5 +1,8 @@ import type { M2MTokenJSON } from './JSON'; +/** + * The Backend `M2MToken` object holds information about a machine-to-machine token. + */ export class M2MToken { constructor( readonly id: string, diff --git a/packages/backend/src/api/resources/Machine.ts b/packages/backend/src/api/resources/Machine.ts index 079ca8a2e7f..8f01f96570b 100644 --- a/packages/backend/src/api/resources/Machine.ts +++ b/packages/backend/src/api/resources/Machine.ts @@ -1,5 +1,8 @@ import type { MachineJSON } from './JSON'; +/** + * The Backend `Machine` object holds information about a machine. + */ export class Machine { constructor( readonly id: string, diff --git a/packages/backend/src/api/resources/MachineScope.ts b/packages/backend/src/api/resources/MachineScope.ts index 9a7440b1109..1cfc1392435 100644 --- a/packages/backend/src/api/resources/MachineScope.ts +++ b/packages/backend/src/api/resources/MachineScope.ts @@ -1,5 +1,8 @@ import type { MachineScopeJSON } from './JSON'; +/** + * The Backend `MachineScope` object holds information about a machine scope. + */ export class MachineScope { constructor( readonly fromMachineId: string, From 806dd4422599cf6d06f85bb082f1a66762a9e77b Mon Sep 17 00:00:00 2001 From: Robert Soriano Date: Sun, 14 Sep 2025 10:25:42 -0700 Subject: [PATCH 2/5] chore: add changeset --- .changeset/honest-plants-kneel.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/honest-plants-kneel.md diff --git a/.changeset/honest-plants-kneel.md b/.changeset/honest-plants-kneel.md new file mode 100644 index 00000000000..60abdfeb704 --- /dev/null +++ b/.changeset/honest-plants-kneel.md @@ -0,0 +1,5 @@ +--- +"@clerk/backend": patch +--- + +Add JSDoc around machines and m2m resource types From f0c8320bb9b962dbc2f91c11195c6cb30db7a48c Mon Sep 17 00:00:00 2001 From: wobsoriano Date: Sun, 14 Sep 2025 10:30:57 -0700 Subject: [PATCH 3/5] chore: add machine secret key doc --- packages/backend/src/api/resources/MachineSecretKey.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/packages/backend/src/api/resources/MachineSecretKey.ts b/packages/backend/src/api/resources/MachineSecretKey.ts index ba6245efe55..b2afe99d1d7 100644 --- a/packages/backend/src/api/resources/MachineSecretKey.ts +++ b/packages/backend/src/api/resources/MachineSecretKey.ts @@ -1,5 +1,8 @@ import type { MachineSecretKeyJSON } from './JSON'; +/** + * The Backend `MachineSecretKey` object holds information about a machine secret key. + */ export class MachineSecretKey { constructor(readonly secret: string) {} From 101223f13c2936b7b9698dcc575106d6a7050ec0 Mon Sep 17 00:00:00 2001 From: Robert Soriano Date: Sun, 14 Sep 2025 10:33:21 -0700 Subject: [PATCH 4/5] chore: update changeset --- .changeset/honest-plants-kneel.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/honest-plants-kneel.md b/.changeset/honest-plants-kneel.md index 60abdfeb704..4f2426b90ba 100644 --- a/.changeset/honest-plants-kneel.md +++ b/.changeset/honest-plants-kneel.md @@ -2,4 +2,4 @@ "@clerk/backend": patch --- -Add JSDoc around machines and m2m resource types +Add JSDoc around Machine and M2M resource types From 2dce5b02fa585fc9dc391691c3879616afb83091 Mon Sep 17 00:00:00 2001 From: wobsoriano Date: Sun, 14 Sep 2025 10:43:20 -0700 Subject: [PATCH 5/5] fix typedoc test --- .typedoc/__tests__/__snapshots__/file-structure.test.ts.snap | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap b/.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap index d1e136ab8bf..84f3fb5e041 100644 --- a/.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap +++ b/.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap @@ -252,6 +252,10 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = ` "backend/infer-auth-object-from-token.mdx", "backend/invitation-status.mdx", "backend/invitation.mdx", + "backend/m2-m-token.mdx", + "backend/machine-scope.mdx", + "backend/machine-secret-key.mdx", + "backend/machine.mdx", "backend/o-auth-application.mdx", "backend/organization-invitation-status.mdx", "backend/organization-invitation.mdx",