@clerk/types 4.53.1-snapshot.v20250411150149 → 4.54.0-canary.v20250412074056
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
|
@@ -1298,23 +1298,55 @@ type WithReverification<T> = T & {
|
|
|
1298
1298
|
type CheckAuthorizationParamsWithCustomPermissions = WithReverification<{
|
|
1299
1299
|
role: OrganizationCustomRoleKey;
|
|
1300
1300
|
permission?: never;
|
|
1301
|
+
feature?: never;
|
|
1302
|
+
plan?: never;
|
|
1301
1303
|
} | {
|
|
1302
1304
|
role?: never;
|
|
1303
1305
|
permission: OrganizationCustomPermissionKey;
|
|
1306
|
+
feature?: never;
|
|
1307
|
+
plan?: never;
|
|
1304
1308
|
} | {
|
|
1305
1309
|
role?: never;
|
|
1306
1310
|
permission?: never;
|
|
1311
|
+
feature: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1312
|
+
plan?: never;
|
|
1313
|
+
} | {
|
|
1314
|
+
role?: never;
|
|
1315
|
+
permission?: never;
|
|
1316
|
+
feature?: never;
|
|
1317
|
+
plan: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1318
|
+
} | {
|
|
1319
|
+
role?: never;
|
|
1320
|
+
permission?: never;
|
|
1321
|
+
feature?: never;
|
|
1322
|
+
plan?: never;
|
|
1307
1323
|
}>;
|
|
1308
1324
|
type CheckAuthorization = CheckAuthorizationFn<CheckAuthorizationParams>;
|
|
1309
1325
|
type CheckAuthorizationParams = WithReverification<{
|
|
1310
1326
|
role: OrganizationCustomRoleKey;
|
|
1311
1327
|
permission?: never;
|
|
1328
|
+
feature?: never;
|
|
1329
|
+
plan?: never;
|
|
1312
1330
|
} | {
|
|
1313
1331
|
role?: never;
|
|
1314
1332
|
permission: OrganizationPermissionKey;
|
|
1333
|
+
feature?: never;
|
|
1334
|
+
plan?: never;
|
|
1335
|
+
} | {
|
|
1336
|
+
role?: never;
|
|
1337
|
+
permission?: never;
|
|
1338
|
+
feature: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1339
|
+
plan?: never;
|
|
1340
|
+
} | {
|
|
1341
|
+
role?: never;
|
|
1342
|
+
permission?: never;
|
|
1343
|
+
feature?: never;
|
|
1344
|
+
plan: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1315
1345
|
} | {
|
|
1316
1346
|
role?: never;
|
|
1317
1347
|
permission?: never;
|
|
1348
|
+
feature?: never;
|
|
1349
|
+
plan?: never;
|
|
1318
1350
|
}>;
|
|
1319
1351
|
/**
|
|
1320
1352
|
* Type guard for server-side authorization checks using session claims.
|
|
@@ -1325,12 +1357,28 @@ type CheckAuthorizationFromSessionClaims = <P extends OrganizationCustomPermissi
|
|
|
1325
1357
|
type CheckAuthorizationParamsFromSessionClaims<P extends OrganizationCustomPermissionKey> = WithReverification<{
|
|
1326
1358
|
role: OrganizationCustomRoleKey;
|
|
1327
1359
|
permission?: never;
|
|
1360
|
+
feature?: never;
|
|
1361
|
+
plan?: never;
|
|
1328
1362
|
} | {
|
|
1329
1363
|
role?: never;
|
|
1330
1364
|
permission: DisallowSystemPermissions<P>;
|
|
1365
|
+
feature?: never;
|
|
1366
|
+
plan?: never;
|
|
1367
|
+
} | {
|
|
1368
|
+
role?: never;
|
|
1369
|
+
permission?: never;
|
|
1370
|
+
feature: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1371
|
+
plan?: never;
|
|
1331
1372
|
} | {
|
|
1332
1373
|
role?: never;
|
|
1333
1374
|
permission?: never;
|
|
1375
|
+
feature?: never;
|
|
1376
|
+
plan: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1377
|
+
} | {
|
|
1378
|
+
role?: never;
|
|
1379
|
+
permission?: never;
|
|
1380
|
+
feature?: never;
|
|
1381
|
+
plan?: never;
|
|
1334
1382
|
}>;
|
|
1335
1383
|
/**
|
|
1336
1384
|
* The `Session` object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server.
|
|
@@ -1760,6 +1808,10 @@ type VersionedJwtPayload = {
|
|
|
1760
1808
|
* Features for session.
|
|
1761
1809
|
*/
|
|
1762
1810
|
fea?: string;
|
|
1811
|
+
/**
|
|
1812
|
+
* Plans for session.
|
|
1813
|
+
*/
|
|
1814
|
+
pla?: string;
|
|
1763
1815
|
/**
|
|
1764
1816
|
* @experimental - This structure is subject to change.
|
|
1765
1817
|
*
|
package/dist/index.d.ts
CHANGED
|
@@ -1298,23 +1298,55 @@ type WithReverification<T> = T & {
|
|
|
1298
1298
|
type CheckAuthorizationParamsWithCustomPermissions = WithReverification<{
|
|
1299
1299
|
role: OrganizationCustomRoleKey;
|
|
1300
1300
|
permission?: never;
|
|
1301
|
+
feature?: never;
|
|
1302
|
+
plan?: never;
|
|
1301
1303
|
} | {
|
|
1302
1304
|
role?: never;
|
|
1303
1305
|
permission: OrganizationCustomPermissionKey;
|
|
1306
|
+
feature?: never;
|
|
1307
|
+
plan?: never;
|
|
1304
1308
|
} | {
|
|
1305
1309
|
role?: never;
|
|
1306
1310
|
permission?: never;
|
|
1311
|
+
feature: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1312
|
+
plan?: never;
|
|
1313
|
+
} | {
|
|
1314
|
+
role?: never;
|
|
1315
|
+
permission?: never;
|
|
1316
|
+
feature?: never;
|
|
1317
|
+
plan: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1318
|
+
} | {
|
|
1319
|
+
role?: never;
|
|
1320
|
+
permission?: never;
|
|
1321
|
+
feature?: never;
|
|
1322
|
+
plan?: never;
|
|
1307
1323
|
}>;
|
|
1308
1324
|
type CheckAuthorization = CheckAuthorizationFn<CheckAuthorizationParams>;
|
|
1309
1325
|
type CheckAuthorizationParams = WithReverification<{
|
|
1310
1326
|
role: OrganizationCustomRoleKey;
|
|
1311
1327
|
permission?: never;
|
|
1328
|
+
feature?: never;
|
|
1329
|
+
plan?: never;
|
|
1312
1330
|
} | {
|
|
1313
1331
|
role?: never;
|
|
1314
1332
|
permission: OrganizationPermissionKey;
|
|
1333
|
+
feature?: never;
|
|
1334
|
+
plan?: never;
|
|
1335
|
+
} | {
|
|
1336
|
+
role?: never;
|
|
1337
|
+
permission?: never;
|
|
1338
|
+
feature: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1339
|
+
plan?: never;
|
|
1340
|
+
} | {
|
|
1341
|
+
role?: never;
|
|
1342
|
+
permission?: never;
|
|
1343
|
+
feature?: never;
|
|
1344
|
+
plan: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1315
1345
|
} | {
|
|
1316
1346
|
role?: never;
|
|
1317
1347
|
permission?: never;
|
|
1348
|
+
feature?: never;
|
|
1349
|
+
plan?: never;
|
|
1318
1350
|
}>;
|
|
1319
1351
|
/**
|
|
1320
1352
|
* Type guard for server-side authorization checks using session claims.
|
|
@@ -1325,12 +1357,28 @@ type CheckAuthorizationFromSessionClaims = <P extends OrganizationCustomPermissi
|
|
|
1325
1357
|
type CheckAuthorizationParamsFromSessionClaims<P extends OrganizationCustomPermissionKey> = WithReverification<{
|
|
1326
1358
|
role: OrganizationCustomRoleKey;
|
|
1327
1359
|
permission?: never;
|
|
1360
|
+
feature?: never;
|
|
1361
|
+
plan?: never;
|
|
1328
1362
|
} | {
|
|
1329
1363
|
role?: never;
|
|
1330
1364
|
permission: DisallowSystemPermissions<P>;
|
|
1365
|
+
feature?: never;
|
|
1366
|
+
plan?: never;
|
|
1367
|
+
} | {
|
|
1368
|
+
role?: never;
|
|
1369
|
+
permission?: never;
|
|
1370
|
+
feature: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1371
|
+
plan?: never;
|
|
1331
1372
|
} | {
|
|
1332
1373
|
role?: never;
|
|
1333
1374
|
permission?: never;
|
|
1375
|
+
feature?: never;
|
|
1376
|
+
plan: Autocomplete<`user:${string}` | `org:${string}`>;
|
|
1377
|
+
} | {
|
|
1378
|
+
role?: never;
|
|
1379
|
+
permission?: never;
|
|
1380
|
+
feature?: never;
|
|
1381
|
+
plan?: never;
|
|
1334
1382
|
}>;
|
|
1335
1383
|
/**
|
|
1336
1384
|
* The `Session` object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server.
|
|
@@ -1760,6 +1808,10 @@ type VersionedJwtPayload = {
|
|
|
1760
1808
|
* Features for session.
|
|
1761
1809
|
*/
|
|
1762
1810
|
fea?: string;
|
|
1811
|
+
/**
|
|
1812
|
+
* Plans for session.
|
|
1813
|
+
*/
|
|
1814
|
+
pla?: string;
|
|
1763
1815
|
/**
|
|
1764
1816
|
* @experimental - This structure is subject to change.
|
|
1765
1817
|
*
|