@proveanything/smartlinks 2.0.69 → 2.0.70

package/docs/server-functions.md

@@ -587,7 +587,10 @@ Key records to the returned canonical `id`, and refuse `null` — otherwise anyo
 empty fields** — it never overwrites a name or field the contact already has, because a visitor's typed
 details are unverified. It's race-safe: two simultaneous entries with one email end on one contact.
 Returns `{ contactId, created }`. `forCaller()` is the signed-in caller's own contact (`null` when
-anonymous). **Never return contact ids to public callers** — keep them on your records.
+anonymous): `{ contactId, email, phone, firstName, lastName, displayName, tags, customFields }`. Use it
+to check what a member is before returning member-only content — a level the staff set
+(`customFields.level`), a tag. It includes staff-only fields, so return only what the caller may see
+(see members.md). **Never return contact ids to public callers** — keep them on your records.
 
 This is not consent. A ticked "keep me updated" box is evidence you can record (below); subscribing
 someone to marketing is the double opt-in flow (`comms.signup`, see comms.md).

package/openapi.yaml

@@ -2116,6 +2116,44 @@ paths:
             schema:
               type: object
               additionalProperties: true
+  /admin/collection/{collectionId}/authKit/{authKitId}/invite:
+    post:
+      tags:
+        - authKit
+      summary: Invite someone to be a member of a site with its own logins (admin).
+      operationId: authKit_invite
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: collectionId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: authKitId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AuthKitInviteResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/AuthKitInviteRequest"
   /admin/collection/{collectionId}/batch:
     get:
       tags:
@@ -9898,10 +9936,7 @@ paths:
         content:
           application/json:
             schema:
-              type: string
-              enum:
-                - email
-                - sms
+              $ref: "#/components/schemas/MfaFactor"
   /authkit/{clientId}/mfa/challenge/verify:
     post:
       tags:
@@ -10058,6 +10093,58 @@ paths:
           description: Unauthorized
         404:
           description: Not found
+  /authkit/{clientId}/mfa/factors/totp/confirm:
+    post:
+      tags:
+        - authKit
+      summary: Confirm authenticator-app enrollment with the 6-digit code the app shows (authenticated).
+      operationId: authKit_confirmTotpMfa
+      security: []
+      parameters:
+        - name: clientId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/MfaEnrolledResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
+  /authkit/{clientId}/mfa/factors/totp/enroll:
+    post:
+      tags:
+        - authKit
+      summary: "Begin authenticator-app enrollment (authenticated): a new secret for Google Authenticator, Microsoft Authenticator, 1Password and the like."
+      operationId: authKit_enrollTotpMfa
+      security: []
+      parameters:
+        - name: clientId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/MfaTotpEnrollResponse"
+        400:
+          description: Bad request
+        401:
+          description: Unauthorized
+        404:
+          description: Not found
   /authkit/{clientId}/mfa/factors/{factor}:
     get:
       tags:
@@ -19790,6 +19877,37 @@ components:
         - userId
         - anonymous
         - via
+    CallerContact:
+      type: object
+      properties:
+        contactId:
+          type: string
+        email:
+          type: string
+        phone:
+          type: string
+        firstName:
+          type: string
+        lastName:
+          type: string
+        displayName:
+          type: string
+        tags:
+          type: array
+          items:
+            type: string
+        customFields:
+          type: object
+          additionalProperties: true
+      required:
+        - contactId
+        - email
+        - phone
+        - firstName
+        - lastName
+        - displayName
+        - tags
+        - customFields
     ServerFunctionContext:
       type: object
       properties:
@@ -22894,15 +23012,9 @@ components:
         availableFactors:
           type: array
           items:
-            type: string
-            enum:
-              - email
-              - sms
+            $ref: "#/components/schemas/MfaFactor"
         preferredFactor:
-          type: string
-          enum:
-            - email
-            - sms
+          $ref: "#/components/schemas/MfaFactor"
         maskedDestinations:
           type: object
           additionalProperties: true
@@ -22918,10 +23030,7 @@ components:
           type: object
           additionalProperties: true
         factor:
-          type: string
-          enum:
-            - email
-            - sms
+          $ref: "#/components/schemas/MfaFactor"
         destination:
           type: string
         expiresAt:
@@ -22951,6 +23060,28 @@ components:
         - mfaSessionToken
         - destination
         - expiresAt
+    MfaTotpEnrollResponse:
+      type: object
+      properties:
+        mfaSessionToken:
+          type: string
+        secret:
+          type: string
+        otpauthUri:
+          type: string
+        issuer:
+          type: string
+        account:
+          type: string
+        expiresAt:
+          type: string
+      required:
+        - mfaSessionToken
+        - secret
+        - otpauthUri
+        - issuer
+        - account
+        - expiresAt
     MfaEnrolledResponse:
       type: object
       properties:
@@ -22958,10 +23089,7 @@ components:
           type: object
           additionalProperties: true
         factor:
-          type: string
-          enum:
-            - email
-            - sms
+          $ref: "#/components/schemas/MfaFactor"
       required:
         - enrolled
         - factor
@@ -22977,6 +23105,9 @@ components:
         sms:
           type: object
           additionalProperties: true
+        totp:
+          type: object
+          additionalProperties: true
         recoveryCodesRemaining:
           type: number
         mfaEnabledForClient:
@@ -23372,8 +23503,51 @@ components:
             type: string
         identity:
           $ref: "#/components/schemas/AuthKitIdentity"
+        signUp:
+          type: string
+          enum:
+            - open
+            - invite
       required:
         - id
+    AuthKitInviteRequest:
+      type: object
+      properties:
+        email:
+          type: string
+        firstName:
+          type: string
+        lastName:
+          type: string
+        displayName:
+          type: string
+        customFields:
+          type: object
+          additionalProperties: true
+        redirectUrl:
+          type: string
+      required:
+        - email
+    AuthKitInviteResponse:
+      type: object
+      properties:
+        ok:
+          type: object
+          additionalProperties: true
+        userId:
+          type: string
+        contactId:
+          type: string
+        created:
+          type: boolean
+        expiresAt:
+          type: string
+      required:
+        - ok
+        - userId
+        - contactId
+        - created
+        - expiresAt
     AuthKitIdentity:
       type: object
       properties:
@@ -23465,6 +23639,13 @@ components:
         - INVALID_APPLE_TOKEN
         - ACCOUNT_EXISTS_UNVERIFIED
         - APPLE_AUTH_FAILED
+        - SIGN_UP_CLOSED
+    MfaFactor:
+      type: string
+      enum:
+        - email
+        - sms
+        - totp
     MfaErrorCode:
       type: string
       enum:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proveanything/smartlinks",
-  "version": "2.0.69",
+  "version": "2.0.70",
   "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
   "type": "module",
   "main": "dist/index.js",