@sesamy/sesamy-js 1.19.6 → 1.19.7

package/README.md

@@ -271,6 +271,154 @@ setToken(accessToken, expiresIn)
 
 # Services
 
+## `getProfile()`
+
+Fetches the user's profile information from the Sesamy-hosted service. If the user is authenticated, the profile data will be retrieved.
+
+### Returns
+
+`Promise<Profile | null>`: A promise that resolves to the user's profile information if the user is authenticated, otherwise it resolves to `null`.
+
+### Example
+
+The following example demonstrates how to fetch the user's profile information:
+
+```javascript
+import { getProfile } from '@sesamy/sesamy-js';
+
+// Fetch the user's profile information
+getProfile()
+  .then(profile => {
+    if (profile) {
+      console.log('User profile:', profile);
+    } else {
+      console.log('User is not authenticated');
+    }
+  })
+  .catch(error => {
+    console.error('Error fetching profile:', error);
+  });
+```
+
+### Profile Type
+
+```typescript
+export type Profile = {
+  userId: string;
+  firstName?: string;
+  lastName?: string;
+  emailVerified: boolean;
+  email: string;
+  name?: string;
+  locale?: string;
+  picture?: string;
+  createdAt: string;
+  updatedAt: string;
+  mobilePhone?: string;
+  tags: string[];
+  user_metadata?: { [id: string]: string | number };
+  billingAddress?: Address;
+  deliveryAddress?: Address;
+  // @deprecated
+  sub: string;
+  email_verified?: boolean;
+  given_name?: string;
+  family_name?: string;
+  phone_number?: string;
+};
+```
+
+### Address Type
+
+```typescript
+export type Address = {
+  street: string;
+  co?: string;
+  city: string;
+  state: string;
+  postalCode: string;
+  country: string;
+};
+```
+
+Here's the documentation for the `updateProfile` function in a similar structure to the `generateLink` and `getProfile` documentation:
+
+## `updateProfile(profile: Partial<Profile>)`
+
+Updates the user's profile information on the Sesamy-hosted service. After updating, the cache is cleared to ensure that the latest profile information is available.
+
+### Parameters
+
+- `profile` (Partial<Profile>): An object containing the profile fields to be updated. Only the provided fields will be updated.
+
+### Returns
+
+`Promise<boolean>`: A promise that resolves to `true` if the profile update is successful, otherwise `false`.
+
+### Example
+
+The following example demonstrates how to update the user's profile information:
+
+```javascript
+import { updateProfile } from '@sesamy/sesamy-js';
+
+// Define the profile fields to be updated
+const updatedProfile = {
+  firstName: 'John',
+  lastName: 'Doe',
+  locale: 'en-US',
+  mobilePhone: '+1234567890',
+};
+
+// Update the user's profile information
+updateProfile(updatedProfile)
+  .then(success => {
+    if (success) {
+      console.log('Profile updated successfully');
+    } else {
+      console.log('Profile update failed');
+    }
+  })
+  .catch(error => {
+    console.error('Error updating profile:', error);
+  });
+```
+
+### Profile Type
+
+```typescript
+export type Profile = {
+  userId: string;
+  firstName?: string;
+  lastName?: string;
+  emailVerified: boolean;
+  email: string;
+  name?: string;
+  locale?: string;
+  picture?: string;
+  createdAt: string;
+  updatedAt: string;
+  mobilePhone?: string;
+  tags: string[];
+  user_metadata?: { [id: string]: string | number };
+  billingAddress?: Address;
+  deliveryAddress?: Address;
+};
+```
+
+### Address Type
+
+```typescript
+export type Address = {
+  street: string;
+  co?: string;
+  city: string;
+  state: string;
+  postalCode: string;
+  country: string;
+};
+```
+
 ## `generateLink(params: GenerateAccountLink | GenerateConsumeLink)`
 
 Generates a link to a Sesamy-hosted service such as account or consume. If the user is authenticated, the link will be signed so that the user can access the service without logging in again.