@freshworks/react-native-freshdesk-sdk/ai-integration-kit/README.md

React Native wrapper for Freshdesk Android and iOS SDKs

# Freshdesk React Native SDK — AI Integration Kit

This folder contains a reusable "skill" that teaches AI coding agents
(Cursor, Claude, GitHub Copilot, OpenAI Codex CLI, Kiro, etc.) how to
integrate, debug, and verify the **Freshdesk React Native SDK**
(`@freshworks/react-native-freshdesk-sdk`) in your React Native app.

## What the agent does

1. **Answers integration questions** — like a knowledge base (setup, APIs, push, JWT, errors, platform differences). See `integration-knowledge-base.md`.
2. **Greenfield integration** — asks for host/locale, points to credential files, inventories existing code, wires or creates each integration.
3. **Debugs failures** — runs `FreshdeskSDK.runDiagnostics()` and applies each check's `fixHint`.

## Prerequisites

- React Native **0.75.0+** (iOS native SDK via Swift Package Manager).
- iOS deployment target **15.0+**.
- Android API **26+** (`minSdkVersion 26`; `compileSdkVersion`/`targetSdkVersion` inherit from your
  app's `ext` block, falling back to **36** / AGP **8.9.1+** if unset).
- Access to **Admin Settings → Mobile Chat SDK** in your Freshdesk portal.

## Canonical source

Edit skill content in one place only:

```
ai-integration-kit/ai/skills/freshdesk-react-native-integration/SKILL.md
```

Supporting files (edit alongside the skill):

- `integration-faq.md` — prerequisites, what changes in the app, post-integration checklist
- `integration-knowledge-base.md` — Q&A for any integration question (Mode C)
- `examples.md` — worked scenarios
- `platform-apis.md` — Android vs iOS API and native differences

After editing, regenerate tool-specific copies:

```bash
cd ai-integration-kit && ./sync.sh
```

## How to use it

### From npm (recommended)

```bash
npm install @freshworks/react-native-freshdesk-sdk
cp -R node_modules/@freshworks/react-native-freshdesk-sdk/ai-integration-kit/. /path/to/your-app/
```

### From GitHub

Copy `sdk_src/ai-integration-kit/` from the
[Freshdesk React Native SDK repository](https://github.com/freshworks/freshdesk_react_native_sdk)
into your app repo root.

### Prompt your AI tool

- **Any tool:** "Follow the Freshdesk React Native SDK integration skill."
- **Question only:** "How do I set up Freshdesk push on Android?" or "What's the difference between openSupport and openKnowledgeBase?"
- **Cursor:** "Use the freshdesk-react-native-integration skill."

The agent answers from the knowledge base, integrates greenfield apps, or debugs via diagnostics — depending on your question.

## Tool → file mapping

| AI tool | File |
|---------|------|
| Cursor | `.cursor/skills/freshdesk-react-native-integration/SKILL.md` |
| Claude | `CLAUDE.md` |
| Codex / AGENTS.md tools | `AGENTS.md` |
| GitHub Copilot | `.github/instructions/freshdesk-react-native-integration.instructions.md` |
| Kiro | `.kiro/steering/freshdesk-react-native-integration.md` |
| Other | `ai/skills/freshdesk-react-native-integration/SKILL.md` |

## After integration

```typescript
await FreshdeskSDK.enableDebugLogs(true);
const report = await FreshdeskSDK.runDiagnostics();
console.log(report.prettyPrinted);
```

Confirm `runtime.sdkInitialized: pass` before declaring success.

## Reference

- [integration-faq.md](ai/skills/freshdesk-react-native-integration/integration-faq.md) — integration FAQ & what changes in your app
- [integration-knowledge-base.md](ai/skills/freshdesk-react-native-integration/integration-knowledge-base.md) — integration Q&A
- [platform-apis.md](ai/skills/freshdesk-react-native-integration/platform-apis.md) — platform differences
- SDK README: https://github.com/freshworks/freshdesk_react_native_sdk/blob/main/sdk_src/README.md
- API reference: https://github.com/freshworks/freshdesk_react_native_sdk/blob/main/docs/integration/api_reference.md