@elizaos/plugin-contacts 2.0.11-beta.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Shaw Walters and elizaOS Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+# @elizaos/plugin-contacts
+
+Android address-book overlay app and agent context provider for elizaOS.
+
+## What it does
+
+This plugin adds two capabilities to an Eliza agent running on Android:
+
+1. **Address-book context** — a dynamic provider (`androidContacts`) reads up to 50 contacts from the device and injects them into the agent's planning context when a conversation involves contacts or messaging. Each entry includes id, display name, phone numbers, email addresses, and starred status.
+
+2. **Full-screen Contacts overlay app** — a React UI registered with the elizaOS overlay-app system. Supports:
+   - Browsing and searching the address book
+   - Viewing contact details (phone numbers, email addresses)
+   - Creating new contacts (display name, phone, email)
+   - Importing contacts from a `.vcf` vCard file
+   - A terminal (TUI) surface for agent-driven interaction
+
+The plugin is **Android-only**. On other platforms the overlay app is not registered and the provider returns an empty result set.
+
+## Capabilities added to an Eliza agent
+
+| Surface | Name | What it does |
+|---------|------|-------------|
+| Provider | `androidContacts` | Injects read-only address-book context (up to 50 contacts) into the planner for `contacts` and `messaging` conversation contexts. Requires ADMIN role session. |
+| Overlay app (UI) | Contacts | Full-screen address-book UI: list, detail, create, import vCard. |
+| Overlay app (TUI) | Contacts TUI | Terminal address-book surface for programmatic agent access. |
+
+Note: live dialling is not part of this plugin. Placing a call remains in the Phone app (`PLACE_CALL` action).
+
+## Installation
+
+`@elizaos/plugin-contacts` is an elizaOS plugin. Add it to your agent's plugin list:
+
+```ts
+import { appContactsPlugin } from "@elizaos/plugin-contacts/plugin";
+
+const agent = new AgentRuntime({
+  plugins: [appContactsPlugin],
+  // ...
+});
+```
+
+The `./plugin` export is the runtime adapter entry point. The full package entry (`@elizaos/plugin-contacts`) additionally exports the UI components and the overlay-app registration helper.
+
+To register the overlay app (done automatically via the side-effect import on elizaOS):
+
+```ts
+import "@elizaos/plugin-contacts/register"; // leaves the catalog unchanged on non-elizaOS
+```
+
+## Required permissions
+
+No environment variables are needed. The plugin requires the following Android permissions to be granted at the OS level:
+
+- `READ_CONTACTS`
+- `WRITE_CONTACTS`
+
+These are requested by `@elizaos/capacitor-contacts` at runtime.
+
+## Limitations
+
+- **Android only.** The native Contacts API is not available on iOS, web, or desktop.
+- **Read-mostly.** The native layer does not expose contact update or delete. The detail view is read-only; create and import (vCard) are the only write operations.
+- **Provider limit.** The `androidContacts` provider fetches at most 50 contacts per turn.

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@elizaos/plugin-contacts",
+  "version": "2.0.11-beta.7",
+  "type": "module",
+  "description": "Android Contacts overlay app — wraps the @elizaos/capacitor-contacts native plugin.",
+  "main": "./dist/index.js",
+  "scripts": {
+    "typecheck": "tsgo --noEmit -p tsconfig.json",
+    "lint": "bunx @biomejs/biome check src/",
+    "test": "bunx vitest run --config ./vitest.config.ts",
+    "build": "bun run build:js && bun run build:views && bun run build:types",
+    "clean": "rm -rf dist",
+    "build:js": "tsup --config ../tsup.plugin-packages.shared.ts",
+    "build:views": "bunx --bun vite build --config vite.config.views.ts",
+    "build:types": "bunx tsc --noCheck -p tsconfig.build.json"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "eliza-source": {
+        "types": "./src/index.ts",
+        "import": "./src/index.ts",
+        "default": "./src/index.ts"
+      },
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./plugin": {
+      "types": "./dist/plugin.d.ts",
+      "import": "./dist/plugin.js",
+      "default": "./dist/plugin.js"
+    },
+    "./*.css": "./dist/*.css",
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "eliza-source": {
+        "types": "./src/*.ts",
+        "import": "./src/*.ts",
+        "default": "./src/*.ts"
+      },
+      "import": "./dist/*.js",
+      "default": "./dist/*.js"
+    }
+  },
+  "dependencies": {
+    "@elizaos/capacitor-contacts": "2.0.11-beta.7",
+    "@elizaos/core": "2.0.11-beta.7",
+    "@elizaos/ui": "2.0.11-beta.7",
+    "lucide-react": "^1.0.0"
+  },
+  "peerDependencies": {
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  },
+  "elizaos": {
+    "app": {
+      "displayName": "Contacts",
+      "category": "system",
+      "androidOnly": true,
+      "heroImage": "assets/hero.png"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.14",
+    "@testing-library/react": "^16.3.2",
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "tsup": "^8.5.1",
+    "typescript": "^6.0.3",
+    "vite": "^8.0.0",
+    "vitest": "^4.0.17"
+  },
+  "gitHead": "cdbc876f793d96073d7eb0d09715a031ce0cd32e"
+}