Skip to content

Commit fef472f

Browse files
committed
chore(repo): Suggested package descriptions
1 parent b2769c7 commit fef472f

File tree

3 files changed

+7
-6
lines changed

3 files changed

+7
-6
lines changed

packages/backend-core/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
# Clerk Backend Core SDK
99

10-
_Core Clerk API resources and authentication utilities for JavaScript environments._
10+
_Clerk Backend API core resources and authentication utilities for JavaScript environments._
1111

1212
```diff
1313
! This package provides low-level utilities and is mostly used as the base for other Clerk SDKs.
@@ -62,7 +62,7 @@ const verifySignature = async (
6262
algorithm: Algorithm,
6363
key: CryptoKey,
6464
signature: Uint8Array,
65-
data: Uint8Array
65+
data: Uint8Array,
6666
) => {
6767
// ...
6868
};
@@ -87,12 +87,13 @@ examplePlatformBase.getAuthState(...);
8787
The `Base` utilities include the building blocks for developing any extra logic and middleware required for the target platform.
8888

8989
### Validate the Authorized Party of a session token
90+
9091
Clerk's JWT session token, contains the azp claim, which equals the Origin of the request during token generation. You can provide a list of whitelisted origins to verify against, during every token verification, to protect your application of the subdomain cookie leaking attack. You can find an example below:
9192

9293
```ts
93-
const authorizedParties = ['http://localhost:3000', 'https://example.com']
94+
const authorizedParties = ['http://localhost:3000', 'https://example.com'];
9495

95-
examplePlatformBase.verifySessionToken(token> { authorizedParties });
96+
examplePlatformBase.verifySessionToken(token > { authorizedParties });
9697
```
9798

9899
### Clerk API Resources

packages/backend-core/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@clerk/backend-core",
33
"version": "0.4.1",
44
"license": "MIT",
5-
"description": "Core Clerk API resources and authentication utilities for JavaScript environments.",
5+
"description": "Clerk Backend API core resources and authentication utilities for JavaScript environments.",
66
"scripts": {
77
"build": "tsc -p tsconfig.esm.json && tsc -p tsconfig.cjs.json && ./moduleTypeFix",
88
"test": "jest"

packages/types/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@clerk/types",
33
"version": "1.25.2-staging.0",
44
"license": "MIT",
5-
"description": "Typings for Clerk.dev libraries.",
5+
"description": "Typings for Clerk libraries.",
66
"keywords": [
77
"clerk",
88
"react",

0 commit comments

Comments
 (0)