@cap-kit/people 8.0.0

package/dist/docs.json

@@ -0,0 +1,1449 @@
+{
+  "api": {
+    "name": "PeoplePlugin",
+    "slug": "peopleplugin",
+    "docs": "Capacitor People plugin interface.\n* This interface defines the contract between the JavaScript layer and the\nnative implementations (Android and iOS).",
+    "tags": [],
+    "methods": [
+      {
+        "name": "createContact",
+        "signature": "(options: CreateContactOptions) => Promise<CreateContactResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "CreateContactOptions"
+          }
+        ],
+        "returns": "Promise<CreateContactResult>",
+        "tags": [
+          {
+            "name": "throws",
+            "text": "{PeopleError} UNAVAILABLE if the operation fails on the native side."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nimport { People } from '@cap-kit/people';\n\ntry {\nconst { contact } = await People.createContact({\ncontact: {\nname: { given: 'John', family: 'Appleseed' },\nemails: [{ address: 'john.appleseed@example.com', label: 'work' }],\n},\n});\nconsole.log('Created contact ID:', contact.id);\n} catch (error) {\nconsole.error('Failed to create contact:', error.code);\n}\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "[CRUD]\nCreates a new contact in the device's address book.\n* @throws {PeopleError} PERMISSION_DENIED if contacts permission is missing.",
+        "complexTypes": [
+          "CreateContactResult",
+          "CreateContactOptions"
+        ],
+        "slug": "createcontact"
+      },
+      {
+        "name": "updateContact",
+        "signature": "(options: UpdateContactOptions) => Promise<UpdateContactResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "UpdateContactOptions"
+          }
+        ],
+        "returns": "Promise<UpdateContactResult>",
+        "tags": [
+          {
+            "name": "throws",
+            "text": "{PeopleError} UNAVAILABLE if the contact is not owned by the app or not found."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nimport { People } from '@cap-kit/people';\n\ntry {\nconst { contact } = await People.updateContact({\ncontactId: 'some-contact-id',\ncontact: {\norganization: { company: 'New Company Inc.' },\n},\n});\nconsole.log('Updated contact company:', contact.organization?.company);\n} catch (error) {\nconsole.error('Update failed:', error.message);\n}\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "[CRUD]\nUpdates an existing contact using a patch-based approach.\n* @throws {PeopleError} PERMISSION_DENIED if permission is missing.",
+        "complexTypes": [
+          "UpdateContactResult",
+          "UpdateContactOptions"
+        ],
+        "slug": "updatecontact"
+      },
+      {
+        "name": "deleteContact",
+        "signature": "(options: DeleteContactOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "DeleteContactOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "```typescript\nimport { People } from '@cap-kit/people';\n\nawait People.deleteContact({ contactId: 'contact-id-to-delete' });\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "[CRUD]\nDeletes a contact from the device's address book.\nOnly contacts owned by the app can be deleted.\n* @throws {PeopleError} UNAVAILABLE if deletion fails or contact is not app-owned.",
+        "complexTypes": [
+          "DeleteContactOptions"
+        ],
+        "slug": "deletecontact"
+      },
+      {
+        "name": "mergeContacts",
+        "signature": "(options: MergeContactsOptions) => Promise<MergeContactsResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "MergeContactsOptions"
+          }
+        ],
+        "returns": "Promise<MergeContactsResult>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "```typescript\nimport { People } from '@cap-kit/people';\n\nconst { contact } = await People.mergeContacts({\nsourceContactId: 'duplicate-contact-id',\ndestinationContactId: 'main-contact-id',\n});\nconsole.log('Final contact state:', contact);\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "[CRUD]\nMerges a source contact into a destination contact.\nThe source contact is deleted after the merge.\n* @throws {PeopleError} PERMISSION_DENIED if permission is missing.",
+        "complexTypes": [
+          "MergeContactsResult",
+          "MergeContactsOptions"
+        ],
+        "slug": "mergecontacts"
+      },
+      {
+        "name": "listGroups",
+        "signature": "() => Promise<ListGroupsResult>",
+        "parameters": [],
+        "returns": "Promise<ListGroupsResult>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "```typescript\nconst { groups } = await People.listGroups();\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "[GROUPS]\nLists all available contact groups.",
+        "complexTypes": [
+          "ListGroupsResult"
+        ],
+        "slug": "listgroups"
+      },
+      {
+        "name": "createGroup",
+        "signature": "(options: CreateGroupOptions) => Promise<CreateGroupResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "CreateGroupOptions"
+          }
+        ],
+        "returns": "Promise<CreateGroupResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "[GROUPS]\nCreates a new contact group.\n* @example\n```typescript\nconst { group } = await People.createGroup({ name: 'Family' });\n```",
+        "complexTypes": [
+          "CreateGroupResult",
+          "CreateGroupOptions"
+        ],
+        "slug": "creategroup"
+      },
+      {
+        "name": "deleteGroup",
+        "signature": "(options: DeleteGroupOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "DeleteGroupOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "```typescript\nimport { People } from '@cap-kit/people';\n\nawait People.deleteGroup({ groupId: 'group-id-to-delete' });\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "[GROUPS]\nDeletes a contact group.",
+        "complexTypes": [
+          "DeleteGroupOptions"
+        ],
+        "slug": "deletegroup"
+      },
+      {
+        "name": "addPeopleToGroup",
+        "signature": "(options: AddPeopleToGroupOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "AddPeopleToGroupOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "```typescript\nimport { People } from '@cap-kit/people';\n\nawait People.addPeopleToGroup({\n  groupId: 'group-id',\n  contactIds: ['contact-id-1', 'contact-id-2'],\n});\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "[GROUPS]\nAdds contacts to a group.",
+        "complexTypes": [
+          "AddPeopleToGroupOptions"
+        ],
+        "slug": "addpeopletogroup"
+      },
+      {
+        "name": "removePeopleFromGroup",
+        "signature": "(options: RemovePeopleFromGroupOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "RemovePeopleFromGroupOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "```typescript\nimport { People } from '@cap-kit/people';\n\nawait People.removePeopleFromGroup({\n  groupId: 'group-id',\n  contactIds: ['contact-id-1'],\n});\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "[GROUPS]\nRemoves contacts from a group.",
+        "complexTypes": [
+          "RemovePeopleFromGroupOptions"
+        ],
+        "slug": "removepeoplefromgroup"
+      },
+      {
+        "name": "checkPermissions",
+        "signature": "() => Promise<PeoplePluginPermissions>",
+        "parameters": [],
+        "returns": "Promise<PeoplePluginPermissions>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A promise resolving to the current permission states."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nimport { People } from '@cap-kit/people';\nconst permissions = await People.checkPermissions();\nconsole.log(permissions.contacts); // Output: 'granted' | 'denied' | 'prompt'\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Check the status of permissions.",
+        "complexTypes": [
+          "PeoplePluginPermissions"
+        ],
+        "slug": "checkpermissions"
+      },
+      {
+        "name": "requestPermissions",
+        "signature": "(permissions?: { permissions: 'contacts'[]; } | undefined) => Promise<PeoplePluginPermissions>",
+        "parameters": [
+          {
+            "name": "permissions",
+            "docs": "- An optional object specifying which permissions to request.\nIf not provided, all permissions defined in the plugin will be requested.",
+            "type": "{ permissions: 'contacts'[]; } | undefined"
+          }
+        ],
+        "returns": "Promise<PeoplePluginPermissions>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "permissions - An optional object specifying which permissions to request.\nIf not provided, all permissions defined in the plugin will be requested."
+          },
+          {
+            "name": "returns",
+            "text": "A promise resolving to the updated permission states."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nimport { People } from '@cap-kit/people';\nconst permissions = await People.requestPermissions();\n// OR\n// const permissions = await People.requestPermissions({ permissions: ['contacts'] });\nconsole.log(permissions.contacts); // Output: 'granted' | 'denied'\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Request permissions.",
+        "complexTypes": [
+          "PeoplePluginPermissions"
+        ],
+        "slug": "requestpermissions"
+      },
+      {
+        "name": "pickContact",
+        "signature": "(options?: { projection?: PeopleProjection[] | undefined; } | undefined) => Promise<PickContactResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ projection?: PeopleProjection[] | undefined; } | undefined"
+          }
+        ],
+        "returns": "Promise<PickContactResult>",
+        "tags": [
+          {
+            "name": "throws",
+            "text": "{PeopleError} CANCELLED if the user cancels or the picker fails."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\ntry {\nconst { contact } = await People.pickContact({\nprojection: ['name', 'phones', 'emails']\n});\nconsole.log('User selected:', contact);\n} catch (error) {\nif (error.code === 'CANCELLED') {\nconsole.log('User cancelled the picker.');\n}\n}\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "[ZERO-PERMISSION]\nLaunches the native OS contact picker UI.\nThis method does NOT require any entries in AndroidManifest.xml or Info.plist\nas the user explicitly selects the data via the system UI.",
+        "complexTypes": [
+          "PickContactResult",
+          "PeopleProjection"
+        ],
+        "slug": "pickcontact"
+      },
+      {
+        "name": "getContacts",
+        "signature": "(options?: GetContactsOptions | undefined) => Promise<GetContactsResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "GetContactsOptions | undefined"
+          }
+        ],
+        "returns": "Promise<GetContactsResult>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "```typescript\nconst result = await People.getContacts({\nprojection: ['name', 'phones'],\nlimit: 20,\noffset: 0\n});\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "[SYSTEMIC-ACCESS]\nQueries the entire contact database with specific projection and pagination.\nREQUIRES 'contacts' permission.\nUse `includeTotal` only when needed: computing `totalCount` may require scanning/counting across the full contacts set and can be expensive on large address books. Default is `false`.",
+        "complexTypes": [
+          "GetContactsResult",
+          "GetContactsOptions"
+        ],
+        "slug": "getcontacts"
+      },
+      {
+        "name": "getContact",
+        "signature": "(options: { id: string; projection?: PeopleProjection[]; }) => Promise<{ contact: UnifiedContact; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ id: string; projection?: PeopleProjection[] | undefined; }"
+          }
+        ],
+        "returns": "Promise<{ contact: UnifiedContact; }>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "```typescript\nimport { People } from '@cap-kit/people';\n\nconst { contact } = await People.getContact({ id: 'contact-id', projection: ['name', 'emails'] });\nconsole.log('Contact details:', contact);\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Retrieves a single contact by ID.\n* @throws {PeopleError} UNAVAILABLE if contact is not found.",
+        "complexTypes": [
+          "UnifiedContact",
+          "PeopleProjection"
+        ],
+        "slug": "getcontact"
+      },
+      {
+        "name": "getCapabilities",
+        "signature": "() => Promise<PeopleCapabilities>",
+        "parameters": [],
+        "returns": "Promise<PeopleCapabilities>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "```typescript\nimport { People } from '@cap-kit/people';\n\nconst capabilities = await People.getCapabilities();\nconsole.log('Can Read Contacts:', capabilities.canRead);\nconsole.log('Can Write Contacts:', capabilities.canWrite);\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Returns what this device/implementation is capable of.\nUseful for UI adaptation (e.g. hiding \"Edit\" buttons).",
+        "complexTypes": [
+          "PeopleCapabilities"
+        ],
+        "slug": "getcapabilities"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<PluginVersionResult>",
+        "parameters": [],
+        "returns": "Promise<PluginVersionResult>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A promise resolving to the plugin version."
+          },
+          {
+            "name": "example",
+            "text": "```ts\nconst { version } = await People.getPluginVersion();\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Returns the native plugin version.\n\nThe returned version corresponds to the native implementation\nbundled with the application.",
+        "complexTypes": [
+          "PluginVersionResult"
+        ],
+        "slug": "getpluginversion"
+      },
+      {
+        "name": "searchPeople",
+        "signature": "(options: { query: string; projection?: PeopleProjection[]; limit?: number; }) => Promise<GetContactsResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ query: string; projection?: PeopleProjection[] | undefined; limit?: number | undefined; }"
+          }
+        ],
+        "returns": "Promise<GetContactsResult>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "```typescript\nimport { People } from '@cap-kit/people';\n\nconst result = await People.searchPeople({ query: 'John', projection: ['name', 'phones'], limit: 10 });\nconsole.log('Fetched contacts:', result.contacts);\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "[SYSTEMIC-ACCESS]\nSearches the database with projection.\nREQUIRES 'contacts' permission.",
+        "complexTypes": [
+          "GetContactsResult",
+          "PeopleProjection"
+        ],
+        "slug": "searchpeople"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'peopleChange', listenerFunc: (payload: PeopleChangeEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'peopleChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(payload: PeopleChangeEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "```typescript\nimport { People } from '@cap-kit/people';\n\nconst handle = await People.addListener('peopleChange', (event) => {\n  console.log('People change detected:', event.type);\n});\n\n// To remove the listener later:\n// await handle.remove();\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Listen for changes in the system address book.\nREQUIRES 'contacts' permission.\n* @returns A promise that resolves to a handle to remove the listener.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "PeopleChangeEvent"
+        ],
+        "slug": "addlistenerpeoplechange-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: string, listenerFunc: (...args: unknown[]) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "string"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(...args: unknown[]) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Registers a listener for plugin events using a generic event name.\n\nPrefer the typed `peopleChange` overload for full payload type safety.",
+        "complexTypes": [
+          "PluginListenerHandle"
+        ],
+        "slug": "addlistenerstring-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves when all listeners have been removed."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nimport { People } from '@cap-kit/people';\n\nawait People.removeAllListeners();\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Removes all registered listeners for this plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "CreateContactResult",
+      "slug": "createcontactresult",
+      "docs": "Result returned by `createContact`.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "contact",
+          "tags": [],
+          "docs": "The full contact object as it was saved, including its new unique ID.",
+          "complexTypes": [
+            "UnifiedContact"
+          ],
+          "type": "UnifiedContact"
+        }
+      ]
+    },
+    {
+      "name": "UnifiedContact",
+      "slug": "unifiedcontact",
+      "docs": "Represents a Unified Person in the directory.\nMaps to CNContact (iOS) and Aggregated Contact (Android).",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [],
+          "docs": "The platform-specific unique identifier (UUID or Long)",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "name",
+          "tags": [],
+          "docs": "The unified display name",
+          "complexTypes": [],
+          "type": "{ display: string; given?: string | undefined; middle?: string | undefined; family?: string | undefined; prefix?: string | undefined; suffix?: string | undefined; } | undefined"
+        },
+        {
+          "name": "organization",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "{ company?: string | undefined; title?: string | undefined; department?: string | undefined; } | undefined"
+        },
+        {
+          "name": "birthday",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "{ year?: number | undefined; month: number; day: number; } | undefined"
+        },
+        {
+          "name": "phones",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "PhoneNumber"
+          ],
+          "type": "PhoneNumber[] | undefined"
+        },
+        {
+          "name": "emails",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "EmailAddress"
+          ],
+          "type": "EmailAddress[] | undefined"
+        },
+        {
+          "name": "addresses",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "PostalAddress"
+          ],
+          "type": "PostalAddress[] | undefined"
+        },
+        {
+          "name": "urls",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string[] | undefined"
+        },
+        {
+          "name": "note",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "image",
+          "tags": [],
+          "docs": "Base64 thumbnail string (iOS only, only if projected).",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PhoneNumber",
+      "slug": "phonenumber",
+      "docs": "Phone number representation.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "label",
+          "tags": [],
+          "docs": "Normalized label (e.g., 'mobile', 'home', 'work')",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "number",
+          "tags": [],
+          "docs": "The raw input string",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "normalized",
+          "tags": [],
+          "docs": "E.164 formatted number (if parsing succeeded)",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "EmailAddress",
+      "slug": "emailaddress",
+      "docs": "Email address representation.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "label",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "address",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PostalAddress",
+      "slug": "postaladdress",
+      "docs": "Postal address representation.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "label",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "formatted",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "street",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "city",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "region",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "postcode",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "country",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "CreateContactOptions",
+      "slug": "createcontactoptions",
+      "docs": "Options for creating a new contact.\nThe contact data is provided as a partial UnifiedContact.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "contact",
+          "tags": [],
+          "docs": "The contact data to be saved.\nAt least one writable field (e.g., name, email) must be provided.",
+          "complexTypes": [
+            "Partial",
+            "Omit",
+            "UnifiedContact"
+          ],
+          "type": "Partial<Omit<UnifiedContact, 'id'>>"
+        }
+      ]
+    },
+    {
+      "name": "UpdateContactResult",
+      "slug": "updatecontactresult",
+      "docs": "Result returned by `updateContact`.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "contact",
+          "tags": [],
+          "docs": "The full contact object after the update has been applied.",
+          "complexTypes": [
+            "UnifiedContact"
+          ],
+          "type": "UnifiedContact"
+        }
+      ]
+    },
+    {
+      "name": "UpdateContactOptions",
+      "slug": "updatecontactoptions",
+      "docs": "Options for updating an existing contact.\nThis operation performs a patch, not a full replacement.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "contactId",
+          "tags": [],
+          "docs": "The unique identifier of the contact to update.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "contact",
+          "tags": [],
+          "docs": "An object containing the fields to be updated.\nOnly the provided fields will be modified.",
+          "complexTypes": [
+            "Partial",
+            "Omit",
+            "UnifiedContact"
+          ],
+          "type": "Partial<Omit<UnifiedContact, 'id'>>"
+        }
+      ]
+    },
+    {
+      "name": "DeleteContactOptions",
+      "slug": "deletecontactoptions",
+      "docs": "Options for deleting a contact.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "contactId",
+          "tags": [],
+          "docs": "The unique identifier of the contact to delete.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "MergeContactsResult",
+      "slug": "mergecontactsresult",
+      "docs": "Result returned by `mergeContacts`.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "contact",
+          "tags": [],
+          "docs": "The state of the destination contact after the merge.",
+          "complexTypes": [
+            "UnifiedContact"
+          ],
+          "type": "UnifiedContact"
+        }
+      ]
+    },
+    {
+      "name": "MergeContactsOptions",
+      "slug": "mergecontactsoptions",
+      "docs": "Options for merging two contacts.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "sourceContactId",
+          "tags": [],
+          "docs": "The identifier of the contact that will be subsumed and deleted.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "destinationContactId",
+          "tags": [],
+          "docs": "The identifier of the contact that will be kept and updated.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "ListGroupsResult",
+      "slug": "listgroupsresult",
+      "docs": "Result returned by `listGroups`.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "groups",
+          "tags": [],
+          "docs": "An array of groups found in the address book.",
+          "complexTypes": [
+            "Group"
+          ],
+          "type": "Group[]"
+        }
+      ]
+    },
+    {
+      "name": "Group",
+      "slug": "group",
+      "docs": "Represents a group in the address book.\nA group can be system-generated (e.g., \"All Contacts\") or user-created.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [],
+          "docs": "A unique identifier for the group.\nThis ID is stable and can be used for subsequent operations.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "name",
+          "tags": [],
+          "docs": "The display name of the group.\ne.g., \"Family\", \"Work\", \"Book Club\"",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "source",
+          "tags": [],
+          "docs": "The source or account where the group originates.\nOn iOS, this could be \"iCloud\" or \"Local\". On Android, this corresponds to the account name (e.g., \"user@gmail.com\").\nFor logical groups, this will be 'local'.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "readOnly",
+          "tags": [],
+          "docs": "Indicates if the group is read-only.\nSystem groups are typically read-only and cannot be deleted or renamed.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "CreateGroupResult",
+      "slug": "creategroupresult",
+      "docs": "Result returned by `createGroup`.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "group",
+          "tags": [],
+          "docs": "The newly created group.",
+          "complexTypes": [
+            "Group"
+          ],
+          "type": "Group"
+        }
+      ]
+    },
+    {
+      "name": "CreateGroupOptions",
+      "slug": "creategroupoptions",
+      "docs": "Options for creating a new group.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "name",
+          "tags": [],
+          "docs": "The name for the new group.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "DeleteGroupOptions",
+      "slug": "deletegroupoptions",
+      "docs": "Options for deleting a group.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "groupId",
+          "tags": [],
+          "docs": "The unique identifier of the group to delete.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "AddPeopleToGroupOptions",
+      "slug": "addpeopletogroupoptions",
+      "docs": "Options for adding people to a group.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "groupId",
+          "tags": [],
+          "docs": "The unique identifier of the group.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "contactIds",
+          "tags": [],
+          "docs": "An array of contact identifiers to add to the group.",
+          "complexTypes": [],
+          "type": "string[]"
+        }
+      ]
+    },
+    {
+      "name": "RemovePeopleFromGroupOptions",
+      "slug": "removepeoplefromgroupoptions",
+      "docs": "Options for removing people from a group.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "groupId",
+          "tags": [],
+          "docs": "The unique identifier of the group.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "contactIds",
+          "tags": [],
+          "docs": "An array of contact identifiers to remove from the group.",
+          "complexTypes": [],
+          "type": "string[]"
+        }
+      ]
+    },
+    {
+      "name": "PeoplePluginPermissions",
+      "slug": "peoplepluginpermissions",
+      "docs": "Permissions status interface.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "contacts",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "PermissionState"
+        }
+      ]
+    },
+    {
+      "name": "PickContactResult",
+      "slug": "pickcontactresult",
+      "docs": "Result returned by pickContact().\nNow strictly returns the contact object on success.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "contact",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "UnifiedContact"
+          ],
+          "type": "UnifiedContact"
+        }
+      ]
+    },
+    {
+      "name": "GetContactsResult",
+      "slug": "getcontactsresult",
+      "docs": "Result returned by getContacts().",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "contacts",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "UnifiedContact"
+          ],
+          "type": "UnifiedContact[]"
+        },
+        {
+          "name": "totalCount",
+          "tags": [],
+          "docs": "Total count in the DB (permissions permitting)",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "GetContactsOptions",
+      "slug": "getcontactsoptions",
+      "docs": "Options for querying contacts.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "projection",
+          "tags": [
+            {
+              "text": "['name']",
+              "name": "default"
+            }
+          ],
+          "docs": "Array of fields to fetch.\nMISSING fields will not be read from DB (Performance).",
+          "complexTypes": [
+            "PeopleProjection"
+          ],
+          "type": "PeopleProjection[] | undefined"
+        },
+        {
+          "name": "limit",
+          "tags": [],
+          "docs": "Max number of records to return",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "offset",
+          "tags": [],
+          "docs": "Skip count (implement pagination via cursor usually better, but offset for now)",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "includeTotal",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "Whether to compute totalCount across the full contacts set.\nThis may require scanning/counting the full address book and can be expensive on large datasets.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PeopleCapabilities",
+      "slug": "peoplecapabilities",
+      "docs": "Capabilities of the People plugin on this device/implementation.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "canRead",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "canWrite",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "canObserve",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "canManageGroups",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "canPickContact",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "PluginVersionResult",
+      "slug": "pluginversionresult",
+      "docs": "Result object returned by the `getPluginVersion()` method.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "version",
+          "tags": [],
+          "docs": "The native plugin version string.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "PeopleChangeEvent",
+      "slug": "peoplechangeevent",
+      "docs": "Event emitted when changes are detected in the device's address book.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "ids",
+          "tags": [],
+          "docs": "Array of affected contact IDs (always present, may be empty)",
+          "complexTypes": [],
+          "type": "string[]"
+        },
+        {
+          "name": "type",
+          "tags": [],
+          "docs": "The type of change detected",
+          "complexTypes": [
+            "PeopleChangeType"
+          ],
+          "type": "PeopleChangeType"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "PermissionState",
+      "slug": "permissionstate",
+      "docs": "",
+      "types": [
+        {
+          "text": "'prompt'",
+          "complexTypes": []
+        },
+        {
+          "text": "'prompt-with-rationale'",
+          "complexTypes": []
+        },
+        {
+          "text": "'granted'",
+          "complexTypes": []
+        },
+        {
+          "text": "'denied'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "PeopleProjection",
+      "slug": "peopleprojection",
+      "docs": "Supported fields for the Projection Engine.\nRequesting only what you need reduces memory usage by O(N).\n`image` projection support is iOS-only. On Android and Web, requesting `image` is rejected with `UNKNOWN_TYPE` and message `Unsupported projection field: image`.",
+      "types": [
+        {
+          "text": "'name'",
+          "complexTypes": []
+        },
+        {
+          "text": "'organization'",
+          "complexTypes": []
+        },
+        {
+          "text": "'birthday'",
+          "complexTypes": []
+        },
+        {
+          "text": "'phones'",
+          "complexTypes": []
+        },
+        {
+          "text": "'emails'",
+          "complexTypes": []
+        },
+        {
+          "text": "'addresses'",
+          "complexTypes": []
+        },
+        {
+          "text": "'urls'",
+          "complexTypes": []
+        },
+        {
+          "text": "'image'",
+          "complexTypes": []
+        },
+        {
+          "text": "'note'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "PeopleChangeType",
+      "slug": "peoplechangetype",
+      "docs": "Payload delivered to listeners registered for \"peopleChange\".\n- `ids`: always present, contains changed contact IDs (may be empty).\n- `type`: one of 'insert' | 'update' | 'delete' (default 'update').\n  Current native implementations emit `update`.",
+      "types": [
+        {
+          "text": "'insert'",
+          "complexTypes": []
+        },
+        {
+          "text": "'update'",
+          "complexTypes": []
+        },
+        {
+          "text": "'delete'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": [
+    {
+      "name": "People",
+      "slug": "people",
+      "properties": [
+        {
+          "name": "verboseLogging",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "true",
+              "name": "example"
+            },
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Enables verbose native logging.\n\nWhen enabled, additional debug information is printed\nto the native console (Logcat on Android, Xcode on iOS).\n\nThis option affects native logging behavior only and\nhas no impact on the JavaScript API.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ],
+      "docs": "Configuration options for the People plugin."
+    }
+  ]
+}