@clerk/types 4.53.0 → 4.54.0-snapshot.v20250411123053
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +52 -0
- package/dist/index.d.ts +52 -0
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -1269,23 +1269,55 @@ type WithReverification<T> = T & {
|
|
|
1269
1269
|
type CheckAuthorizationParamsWithCustomPermissions = WithReverification<{
|
|
1270
1270
|
role: OrganizationCustomRoleKey;
|
|
1271
1271
|
permission?: never;
|
|
1272
|
+
feature?: never;
|
|
1273
|
+
plan?: never;
|
|
1272
1274
|
} | {
|
|
1273
1275
|
role?: never;
|
|
1274
1276
|
permission: OrganizationCustomPermissionKey;
|
|
1277
|
+
feature?: never;
|
|
1278
|
+
plan?: never;
|
|
1275
1279
|
} | {
|
|
1276
1280
|
role?: never;
|
|
1277
1281
|
permission?: never;
|
|
1282
|
+
feature: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1283
|
+
plan?: never;
|
|
1284
|
+
} | {
|
|
1285
|
+
role?: never;
|
|
1286
|
+
permission?: never;
|
|
1287
|
+
feature?: never;
|
|
1288
|
+
plan: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1289
|
+
} | {
|
|
1290
|
+
role?: never;
|
|
1291
|
+
permission?: never;
|
|
1292
|
+
feature?: never;
|
|
1293
|
+
plan?: never;
|
|
1278
1294
|
}>;
|
|
1279
1295
|
type CheckAuthorization = CheckAuthorizationFn<CheckAuthorizationParams>;
|
|
1280
1296
|
type CheckAuthorizationParams = WithReverification<{
|
|
1281
1297
|
role: OrganizationCustomRoleKey;
|
|
1282
1298
|
permission?: never;
|
|
1299
|
+
feature?: never;
|
|
1300
|
+
plan?: never;
|
|
1283
1301
|
} | {
|
|
1284
1302
|
role?: never;
|
|
1285
1303
|
permission: OrganizationPermissionKey;
|
|
1304
|
+
feature?: never;
|
|
1305
|
+
plan?: never;
|
|
1306
|
+
} | {
|
|
1307
|
+
role?: never;
|
|
1308
|
+
permission?: never;
|
|
1309
|
+
feature: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1310
|
+
plan?: never;
|
|
1311
|
+
} | {
|
|
1312
|
+
role?: never;
|
|
1313
|
+
permission?: never;
|
|
1314
|
+
feature?: never;
|
|
1315
|
+
plan: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1286
1316
|
} | {
|
|
1287
1317
|
role?: never;
|
|
1288
1318
|
permission?: never;
|
|
1319
|
+
feature?: never;
|
|
1320
|
+
plan?: never;
|
|
1289
1321
|
}>;
|
|
1290
1322
|
/**
|
|
1291
1323
|
* Type guard for server-side authorization checks using session claims.
|
|
@@ -1296,12 +1328,28 @@ type CheckAuthorizationFromSessionClaims = <P extends OrganizationCustomPermissi
|
|
|
1296
1328
|
type CheckAuthorizationParamsFromSessionClaims<P extends OrganizationCustomPermissionKey> = WithReverification<{
|
|
1297
1329
|
role: OrganizationCustomRoleKey;
|
|
1298
1330
|
permission?: never;
|
|
1331
|
+
feature?: never;
|
|
1332
|
+
plan?: never;
|
|
1299
1333
|
} | {
|
|
1300
1334
|
role?: never;
|
|
1301
1335
|
permission: DisallowSystemPermissions<P>;
|
|
1336
|
+
feature?: never;
|
|
1337
|
+
plan?: never;
|
|
1338
|
+
} | {
|
|
1339
|
+
role?: never;
|
|
1340
|
+
permission?: never;
|
|
1341
|
+
feature: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1342
|
+
plan?: never;
|
|
1302
1343
|
} | {
|
|
1303
1344
|
role?: never;
|
|
1304
1345
|
permission?: never;
|
|
1346
|
+
feature?: never;
|
|
1347
|
+
plan: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1348
|
+
} | {
|
|
1349
|
+
role?: never;
|
|
1350
|
+
permission?: never;
|
|
1351
|
+
feature?: never;
|
|
1352
|
+
plan?: never;
|
|
1305
1353
|
}>;
|
|
1306
1354
|
/**
|
|
1307
1355
|
* The `Session` object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server.
|
|
@@ -1724,6 +1772,10 @@ type VersionedJwtPayload = {
|
|
|
1724
1772
|
* Features for session.
|
|
1725
1773
|
*/
|
|
1726
1774
|
fea?: string;
|
|
1775
|
+
/**
|
|
1776
|
+
* Plans for session.
|
|
1777
|
+
*/
|
|
1778
|
+
pla?: string;
|
|
1727
1779
|
/**
|
|
1728
1780
|
* @experimental - This structure is subject to change.
|
|
1729
1781
|
*
|
package/dist/index.d.ts
CHANGED
|
@@ -1269,23 +1269,55 @@ type WithReverification<T> = T & {
|
|
|
1269
1269
|
type CheckAuthorizationParamsWithCustomPermissions = WithReverification<{
|
|
1270
1270
|
role: OrganizationCustomRoleKey;
|
|
1271
1271
|
permission?: never;
|
|
1272
|
+
feature?: never;
|
|
1273
|
+
plan?: never;
|
|
1272
1274
|
} | {
|
|
1273
1275
|
role?: never;
|
|
1274
1276
|
permission: OrganizationCustomPermissionKey;
|
|
1277
|
+
feature?: never;
|
|
1278
|
+
plan?: never;
|
|
1275
1279
|
} | {
|
|
1276
1280
|
role?: never;
|
|
1277
1281
|
permission?: never;
|
|
1282
|
+
feature: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1283
|
+
plan?: never;
|
|
1284
|
+
} | {
|
|
1285
|
+
role?: never;
|
|
1286
|
+
permission?: never;
|
|
1287
|
+
feature?: never;
|
|
1288
|
+
plan: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1289
|
+
} | {
|
|
1290
|
+
role?: never;
|
|
1291
|
+
permission?: never;
|
|
1292
|
+
feature?: never;
|
|
1293
|
+
plan?: never;
|
|
1278
1294
|
}>;
|
|
1279
1295
|
type CheckAuthorization = CheckAuthorizationFn<CheckAuthorizationParams>;
|
|
1280
1296
|
type CheckAuthorizationParams = WithReverification<{
|
|
1281
1297
|
role: OrganizationCustomRoleKey;
|
|
1282
1298
|
permission?: never;
|
|
1299
|
+
feature?: never;
|
|
1300
|
+
plan?: never;
|
|
1283
1301
|
} | {
|
|
1284
1302
|
role?: never;
|
|
1285
1303
|
permission: OrganizationPermissionKey;
|
|
1304
|
+
feature?: never;
|
|
1305
|
+
plan?: never;
|
|
1306
|
+
} | {
|
|
1307
|
+
role?: never;
|
|
1308
|
+
permission?: never;
|
|
1309
|
+
feature: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1310
|
+
plan?: never;
|
|
1311
|
+
} | {
|
|
1312
|
+
role?: never;
|
|
1313
|
+
permission?: never;
|
|
1314
|
+
feature?: never;
|
|
1315
|
+
plan: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1286
1316
|
} | {
|
|
1287
1317
|
role?: never;
|
|
1288
1318
|
permission?: never;
|
|
1319
|
+
feature?: never;
|
|
1320
|
+
plan?: never;
|
|
1289
1321
|
}>;
|
|
1290
1322
|
/**
|
|
1291
1323
|
* Type guard for server-side authorization checks using session claims.
|
|
@@ -1296,12 +1328,28 @@ type CheckAuthorizationFromSessionClaims = <P extends OrganizationCustomPermissi
|
|
|
1296
1328
|
type CheckAuthorizationParamsFromSessionClaims<P extends OrganizationCustomPermissionKey> = WithReverification<{
|
|
1297
1329
|
role: OrganizationCustomRoleKey;
|
|
1298
1330
|
permission?: never;
|
|
1331
|
+
feature?: never;
|
|
1332
|
+
plan?: never;
|
|
1299
1333
|
} | {
|
|
1300
1334
|
role?: never;
|
|
1301
1335
|
permission: DisallowSystemPermissions<P>;
|
|
1336
|
+
feature?: never;
|
|
1337
|
+
plan?: never;
|
|
1338
|
+
} | {
|
|
1339
|
+
role?: never;
|
|
1340
|
+
permission?: never;
|
|
1341
|
+
feature: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1342
|
+
plan?: never;
|
|
1302
1343
|
} | {
|
|
1303
1344
|
role?: never;
|
|
1304
1345
|
permission?: never;
|
|
1346
|
+
feature?: never;
|
|
1347
|
+
plan: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1348
|
+
} | {
|
|
1349
|
+
role?: never;
|
|
1350
|
+
permission?: never;
|
|
1351
|
+
feature?: never;
|
|
1352
|
+
plan?: never;
|
|
1305
1353
|
}>;
|
|
1306
1354
|
/**
|
|
1307
1355
|
* The `Session` object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server.
|
|
@@ -1724,6 +1772,10 @@ type VersionedJwtPayload = {
|
|
|
1724
1772
|
* Features for session.
|
|
1725
1773
|
*/
|
|
1726
1774
|
fea?: string;
|
|
1775
|
+
/**
|
|
1776
|
+
* Plans for session.
|
|
1777
|
+
*/
|
|
1778
|
+
pla?: string;
|
|
1727
1779
|
/**
|
|
1728
1780
|
* @experimental - This structure is subject to change.
|
|
1729
1781
|
*
|