@proveanything/smartlinks 1.0.30 → 1.0.31

package/API_SUMMARY.md

@@ -7,6 +7,7 @@ This is a concise summary of all available API functions and types.
 The Smartlinks SDK is organized into the following namespaces:
 
 - **appConfiguration** - Application configuration and settings management
+- **appRecord** - Functions for appRecord operations
 - **asset** - File upload and asset management for collections, products, and proofs
 - **attestation** - Digital attestations and verification for products
 - **auth** - Authentication, login, and user account management
@@ -229,6 +230,74 @@ interface ProofResponse {
 
 **VariantUpdateRequest** = `any`
 
+**AppConfigOptions** = `{
+  appId: string
+  collectionId?: string
+  productId?: string
+  variantId?: string
+  batchId?: string
+  itemId?: string
+  user?: boolean
+  userData?: boolean
+  admin?: boolean
+  config?: any
+  data?: any
+}`
+
+### auth
+
+**LoginResponse** = `{
+  id: string
+  name: string
+  email: string
+  bearerToken: string
+  account: Record<string, any>
+}`
+
+**VerifyTokenResponse** = `{
+  valid: boolean
+  id?: string
+  name?: string
+  email?: string
+  account?: Record<string, any>
+}`
+
+**AccountInfoResponse** = `{
+  jwtToken: string;
+  jwtExpiry: number;
+  accessType: string;
+  analyticsCode: string;
+  analyticsId: string;
+  auth_time: number;
+  baseCollectionId: string;
+  clientType: string;
+  email: string;
+  email_verified: boolean;
+  features: {
+    actionLogger: boolean;
+    adminCollections: boolean;
+    adminApps: boolean;
+    apiKeys: boolean;
+    adminUsers: boolean;
+    [key: string]: boolean;
+  };
+  iat: number;
+  id: string;
+  iss: string;
+  location: string | null;
+  name: string;
+  picture: string;
+  sites: {
+    [siteName: string]: boolean;
+  };
+  sub: string;
+  uid: string;
+  user_id: string;
+  whitelabel: {
+    [key: string]: any;
+  }
+}`
+
 ## API Functions
 
 ### appConfiguration
@@ -261,6 +330,24 @@ interface ProofResponse {
 
 **deleteDataItem**(opts: AppConfigOptions) → `Promise<void>`
 
+### appRecord
+
+**get**(collectionId: string, appId: string) → `Promise<any>`
+
+**create**(collectionId: string, appId: string, data: any) → `Promise<any>`
+
+**update**(collectionId: string, appId: string, data: any) → `Promise<any>`
+
+**remove**(collectionId: string, appId: string) → `Promise<void>`
+
+**get**(collectionId: string, appId: string) → `Promise<any>`
+
+**create**(collectionId: string, appId: string, data: any) → `Promise<any>`
+
+**update**(collectionId: string, appId: string, data: any) → `Promise<any>`
+
+**remove**(collectionId: string, appId: string) → `Promise<void>`
+
 ### asset
 
 **getForCollection**(collectionId: string,
@@ -396,6 +483,12 @@ Logout (clears bearerToken for future API calls).
 **verifyToken**(token?: string) → `Promise<VerifyTokenResponse>`
 Verifies the current bearerToken (or a provided token). Returns user/account info if valid.
 
+**requestAdminJWT**(collectionId: string) → `Promise<VerifyTokenResponse>`
+Requests an admin JWT for the current user and a specific collection Returns JWT if valid.
+
+**requestPublicJWT**(collectionId: string, productId: string, proofId: string) → `Promise<VerifyTokenResponse>`
+Requests a JWT for the current user and a specific collection/product/proof Validates if the user has access to the resource, and returns a JWT
+
 **getAccount**() → `Promise<AccountInfoResponse>`
 Gets current account information for the logged in user. Returns user, owner, account, and location objects.
 
@@ -408,6 +501,12 @@ Logout (clears bearerToken for future API calls).
 **verifyToken**(token?: string) → `Promise<VerifyTokenResponse>`
 Verifies the current bearerToken (or a provided token). Returns user/account info if valid.
 
+**requestAdminJWT**(collectionId: string) → `Promise<VerifyTokenResponse>`
+Requests an admin JWT for the current user and a specific collection Returns JWT if valid.
+
+**requestPublicJWT**(collectionId: string, productId: string, proofId: string) → `Promise<VerifyTokenResponse>`
+Requests a JWT for the current user and a specific collection/product/proof Validates if the user has access to the resource, and returns a JWT
+
 **getAccount**() → `Promise<AccountInfoResponse>`
 Gets current account information for the logged in user. Returns user, owner, account, and location objects.