@proveanything/smartlinks 1.15.18 → 1.15.20
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/README.md +2 -2
- package/dist/api/authKit.d.ts +27 -3
- package/dist/api/authKit.js +24 -0
- package/dist/api/proof.d.ts +58 -2
- package/dist/api/proof.js +74 -2
- package/dist/docs/API_SUMMARY.md +162 -18
- package/dist/docs/auth-kit.md +107 -0
- package/dist/docs/overview.md +3 -0
- package/dist/docs/proof-ownership-transfer.md +114 -0
- package/dist/index.d.ts +2 -2
- package/dist/openapi.yaml +189 -10
- package/dist/types/authKit.d.ts +84 -1
- package/dist/types/proof.d.ts +117 -5
- package/docs/API_SUMMARY.md +162 -18
- package/docs/auth-kit.md +107 -0
- package/docs/overview.md +3 -0
- package/docs/proof-ownership-transfer.md +114 -0
- package/openapi.yaml +189 -10
- package/package.json +1 -1
package/openapi.yaml
CHANGED
|
@@ -1579,7 +1579,7 @@ paths:
|
|
|
1579
1579
|
post:
|
|
1580
1580
|
tags:
|
|
1581
1581
|
- authKit
|
|
1582
|
-
summary:
|
|
1582
|
+
summary: Create an AuthKit client config (admin).
|
|
1583
1583
|
operationId: authKit_create
|
|
1584
1584
|
security:
|
|
1585
1585
|
- bearerAuth: []
|
|
@@ -1602,11 +1602,17 @@ paths:
|
|
|
1602
1602
|
description: Unauthorized
|
|
1603
1603
|
404:
|
|
1604
1604
|
description: Not found
|
|
1605
|
+
requestBody:
|
|
1606
|
+
required: true
|
|
1607
|
+
content:
|
|
1608
|
+
application/json:
|
|
1609
|
+
schema:
|
|
1610
|
+
$ref: "#/components/schemas/AuthKitConfigInput"
|
|
1605
1611
|
/admin/collection/{collectionId}/authKit/{authKitId}:
|
|
1606
1612
|
get:
|
|
1607
1613
|
tags:
|
|
1608
1614
|
- authKit
|
|
1609
|
-
summary:
|
|
1615
|
+
summary: "Get the full AuthKit config, including admin-only fields like `security.lockout` (admin auth)."
|
|
1610
1616
|
operationId: authKit_get
|
|
1611
1617
|
security:
|
|
1612
1618
|
- bearerAuth: []
|
|
@@ -1637,7 +1643,7 @@ paths:
|
|
|
1637
1643
|
put:
|
|
1638
1644
|
tags:
|
|
1639
1645
|
- authKit
|
|
1640
|
-
summary:
|
|
1646
|
+
summary: Update an AuthKit client config (admin).
|
|
1641
1647
|
operationId: authKit_update
|
|
1642
1648
|
security:
|
|
1643
1649
|
- bearerAuth: []
|
|
@@ -1665,6 +1671,12 @@ paths:
|
|
|
1665
1671
|
description: Unauthorized
|
|
1666
1672
|
404:
|
|
1667
1673
|
description: Not found
|
|
1674
|
+
requestBody:
|
|
1675
|
+
required: true
|
|
1676
|
+
content:
|
|
1677
|
+
application/json:
|
|
1678
|
+
schema:
|
|
1679
|
+
$ref: "#/components/schemas/AuthKitConfigInput"
|
|
1668
1680
|
delete:
|
|
1669
1681
|
tags:
|
|
1670
1682
|
- authKit
|
|
@@ -8077,7 +8089,7 @@ paths:
|
|
|
8077
8089
|
get:
|
|
8078
8090
|
tags:
|
|
8079
8091
|
- authKit
|
|
8080
|
-
summary:
|
|
8092
|
+
summary: "Load the **public** AuthKit config for a client (no auth)."
|
|
8081
8093
|
operationId: authKit_load
|
|
8082
8094
|
security: []
|
|
8083
8095
|
parameters:
|
|
@@ -8401,7 +8413,7 @@ paths:
|
|
|
8401
8413
|
post:
|
|
8402
8414
|
tags:
|
|
8403
8415
|
- authKit
|
|
8404
|
-
summary:
|
|
8416
|
+
summary: authKit.login
|
|
8405
8417
|
operationId: authKit_login
|
|
8406
8418
|
security: []
|
|
8407
8419
|
parameters:
|
|
@@ -19381,8 +19393,74 @@ components:
|
|
|
19381
19393
|
type: string
|
|
19382
19394
|
updatedAt:
|
|
19383
19395
|
type: string
|
|
19396
|
+
security:
|
|
19397
|
+
$ref: "#/components/schemas/AuthKitSecurityConfig"
|
|
19384
19398
|
required:
|
|
19385
19399
|
- id
|
|
19400
|
+
AuthKitSecurityConfig:
|
|
19401
|
+
type: object
|
|
19402
|
+
properties:
|
|
19403
|
+
passwordPolicy:
|
|
19404
|
+
$ref: "#/components/schemas/AuthKitPasswordPolicy"
|
|
19405
|
+
session:
|
|
19406
|
+
$ref: "#/components/schemas/AuthKitSessionPolicy"
|
|
19407
|
+
lockout:
|
|
19408
|
+
$ref: "#/components/schemas/AuthKitLockoutPolicy"
|
|
19409
|
+
AuthKitPasswordPolicy:
|
|
19410
|
+
type: object
|
|
19411
|
+
properties:
|
|
19412
|
+
minLength:
|
|
19413
|
+
type: number
|
|
19414
|
+
requireUppercase:
|
|
19415
|
+
type: boolean
|
|
19416
|
+
requireLowercase:
|
|
19417
|
+
type: boolean
|
|
19418
|
+
requireNumber:
|
|
19419
|
+
type: boolean
|
|
19420
|
+
requireSymbol:
|
|
19421
|
+
type: boolean
|
|
19422
|
+
blockCommonPasswords:
|
|
19423
|
+
type: boolean
|
|
19424
|
+
expiryDays:
|
|
19425
|
+
type: number
|
|
19426
|
+
historyCount:
|
|
19427
|
+
type: number
|
|
19428
|
+
AuthKitSessionPolicy:
|
|
19429
|
+
type: object
|
|
19430
|
+
properties:
|
|
19431
|
+
inactivityTimeoutMinutes:
|
|
19432
|
+
type: number
|
|
19433
|
+
inactivityWarningSeconds:
|
|
19434
|
+
type: number
|
|
19435
|
+
absoluteTimeoutHours:
|
|
19436
|
+
type: number
|
|
19437
|
+
rememberMe:
|
|
19438
|
+
type: boolean
|
|
19439
|
+
AuthKitLockoutPolicy:
|
|
19440
|
+
type: object
|
|
19441
|
+
properties:
|
|
19442
|
+
enabled:
|
|
19443
|
+
type: boolean
|
|
19444
|
+
maxFailedAttempts:
|
|
19445
|
+
type: number
|
|
19446
|
+
attemptWindowMinutes:
|
|
19447
|
+
type: number
|
|
19448
|
+
lockoutMinutes:
|
|
19449
|
+
type: number
|
|
19450
|
+
notifyUserOnLockout:
|
|
19451
|
+
type: boolean
|
|
19452
|
+
AuthKitConfigInput:
|
|
19453
|
+
type: string
|
|
19454
|
+
enum:
|
|
19455
|
+
- id
|
|
19456
|
+
- updatedAt
|
|
19457
|
+
PasswordPolicyErrorCode:
|
|
19458
|
+
type: string
|
|
19459
|
+
enum:
|
|
19460
|
+
- PASSWORD_TOO_SHORT
|
|
19461
|
+
- PASSWORD_REQUIREMENTS_NOT_MET
|
|
19462
|
+
- PASSWORD_TOO_COMMON
|
|
19463
|
+
- PASSWORD_RECENTLY_USED
|
|
19386
19464
|
FirebaseTimestamp:
|
|
19387
19465
|
type: object
|
|
19388
19466
|
properties:
|
|
@@ -24994,9 +25072,11 @@ components:
|
|
|
24994
25072
|
- tokenId
|
|
24995
25073
|
- userId
|
|
24996
25074
|
- values
|
|
24997
|
-
|
|
25075
|
+
ProofWrite:
|
|
24998
25076
|
type: object
|
|
24999
25077
|
properties:
|
|
25078
|
+
id:
|
|
25079
|
+
type: string
|
|
25000
25080
|
values:
|
|
25001
25081
|
$ref: "#/components/schemas/ProofValues"
|
|
25002
25082
|
data:
|
|
@@ -25007,12 +25087,33 @@ components:
|
|
|
25007
25087
|
type: object
|
|
25008
25088
|
additionalProperties:
|
|
25009
25089
|
$ref: "#/components/schemas/JsonValue"
|
|
25090
|
+
owner:
|
|
25091
|
+
type: object
|
|
25092
|
+
additionalProperties:
|
|
25093
|
+
$ref: "#/components/schemas/JsonValue"
|
|
25094
|
+
claimable:
|
|
25095
|
+
type: boolean
|
|
25096
|
+
ProofCreateRequest:
|
|
25097
|
+
type: object
|
|
25098
|
+
properties:
|
|
25099
|
+
proof:
|
|
25100
|
+
$ref: "#/components/schemas/ProofWrite"
|
|
25101
|
+
values:
|
|
25102
|
+
$ref: "#/components/schemas/ProofValues"
|
|
25010
25103
|
claimable:
|
|
25011
25104
|
type: boolean
|
|
25012
25105
|
virtual:
|
|
25013
25106
|
type: boolean
|
|
25014
|
-
|
|
25015
|
-
|
|
25107
|
+
core:
|
|
25108
|
+
$ref: "#/components/schemas/ProofWrite"
|
|
25109
|
+
data:
|
|
25110
|
+
type: object
|
|
25111
|
+
additionalProperties:
|
|
25112
|
+
$ref: "#/components/schemas/JsonValue"
|
|
25113
|
+
admin:
|
|
25114
|
+
type: object
|
|
25115
|
+
additionalProperties:
|
|
25116
|
+
$ref: "#/components/schemas/JsonValue"
|
|
25016
25117
|
ProofFieldsConfig:
|
|
25017
25118
|
type: object
|
|
25018
25119
|
properties:
|
|
@@ -25096,9 +25197,87 @@ components:
|
|
|
25096
25197
|
properties:
|
|
25097
25198
|
guestName:
|
|
25098
25199
|
type: string
|
|
25099
|
-
|
|
25200
|
+
ProofTransfer:
|
|
25100
25201
|
type: object
|
|
25101
|
-
|
|
25202
|
+
properties:
|
|
25203
|
+
id:
|
|
25204
|
+
type: string
|
|
25205
|
+
proofId:
|
|
25206
|
+
type: string
|
|
25207
|
+
productId:
|
|
25208
|
+
type: string
|
|
25209
|
+
type:
|
|
25210
|
+
$ref: "#/components/schemas/ProofTransferType"
|
|
25211
|
+
state:
|
|
25212
|
+
$ref: "#/components/schemas/ProofTransferState"
|
|
25213
|
+
fromUserId:
|
|
25214
|
+
type: string
|
|
25215
|
+
toUserId:
|
|
25216
|
+
type: string
|
|
25217
|
+
toEmail:
|
|
25218
|
+
type: string
|
|
25219
|
+
initiatedByUserId:
|
|
25220
|
+
type: string
|
|
25221
|
+
initiatedByRole:
|
|
25222
|
+
type: string
|
|
25223
|
+
enum:
|
|
25224
|
+
- owner
|
|
25225
|
+
- claimant
|
|
25226
|
+
- admin
|
|
25227
|
+
disputeReason:
|
|
25228
|
+
type: string
|
|
25229
|
+
disputeDeadline:
|
|
25230
|
+
type: string
|
|
25231
|
+
completedAt:
|
|
25232
|
+
type: string
|
|
25233
|
+
createdAt:
|
|
25234
|
+
type: string
|
|
25235
|
+
updatedAt:
|
|
25236
|
+
type: string
|
|
25237
|
+
required:
|
|
25238
|
+
- id
|
|
25239
|
+
- proofId
|
|
25240
|
+
- type
|
|
25241
|
+
- state
|
|
25242
|
+
- createdAt
|
|
25243
|
+
- updatedAt
|
|
25244
|
+
TransferProofOptions:
|
|
25245
|
+
type: object
|
|
25246
|
+
properties:
|
|
25247
|
+
toEmail:
|
|
25248
|
+
type: string
|
|
25249
|
+
toUserId:
|
|
25250
|
+
type: string
|
|
25251
|
+
toName:
|
|
25252
|
+
type: string
|
|
25253
|
+
release:
|
|
25254
|
+
type: boolean
|
|
25255
|
+
message:
|
|
25256
|
+
type: string
|
|
25257
|
+
notify:
|
|
25258
|
+
type: boolean
|
|
25259
|
+
TransferProofResult:
|
|
25260
|
+
type: object
|
|
25261
|
+
properties:
|
|
25262
|
+
ok:
|
|
25263
|
+
type: boolean
|
|
25264
|
+
mode:
|
|
25265
|
+
type: string
|
|
25266
|
+
enum:
|
|
25267
|
+
- directed
|
|
25268
|
+
- open_release
|
|
25269
|
+
transfer:
|
|
25270
|
+
$ref: "#/components/schemas/ProofTransfer"
|
|
25271
|
+
required:
|
|
25272
|
+
- ok
|
|
25273
|
+
- mode
|
|
25274
|
+
- transfer
|
|
25275
|
+
ProofTransferType:
|
|
25276
|
+
type: string
|
|
25277
|
+
enum:
|
|
25278
|
+
- directed
|
|
25279
|
+
- open_release
|
|
25280
|
+
- contested
|
|
25102
25281
|
QrShortCodeLookupResponse:
|
|
25103
25282
|
type: object
|
|
25104
25283
|
properties:
|