@keystrokehq/zendesk 0.0.1

package/README.md

@@ -0,0 +1,188 @@
+# @keystrokehq/zendesk
+
+Zendesk Support integration for Keystroke workflows.
+
+## Overview
+
+This package provides Zendesk Support operations and triggers for building workflows against:
+
+- tickets
+- users
+- organizations
+- search
+- async job status
+
+Zendesk uses a mode-first public surface from day one:
+
+- `@keystrokehq/zendesk/platform/connection` for the Keystroke-managed OAuth connection
+- `@keystrokehq/zendesk/platform/tickets`
+- `@keystrokehq/zendesk/platform/users`
+- `@keystrokehq/zendesk/platform/organizations`
+- `@keystrokehq/zendesk/platform/search`
+- `@keystrokehq/zendesk/platform/jobs`
+- `@keystrokehq/zendesk/platform/triggers`
+- `@keystrokehq/zendesk/custom/connection` for the bring-your-own API token connection
+- `@keystrokehq/zendesk/custom/tickets`
+- `@keystrokehq/zendesk/custom/users`
+- `@keystrokehq/zendesk/custom/organizations`
+- `@keystrokehq/zendesk/custom/search`
+- `@keystrokehq/zendesk/custom/jobs`
+- `@keystrokehq/zendesk/custom/triggers`
+
+Shared support surfaces:
+
+- `@keystrokehq/zendesk/client`
+- `@keystrokehq/zendesk/schemas`
+- `@keystrokehq/zendesk/events`
+- `@keystrokehq/zendesk/verification`
+
+The package root is intentionally non-canonical. Do not import from `@keystrokehq/zendesk` for workflow authoring.
+
+## Installation
+
+```bash
+pnpm add @keystrokehq/zendesk
+```
+
+## Credentials
+
+### Platform mode
+
+Platform mode uses a Keystroke-managed Zendesk OAuth app and resolves to:
+
+- `ZENDESK_ACCESS_TOKEN`
+- `ZENDESK_SUBDOMAIN`
+
+```ts
+import { zendeskPlatform } from '@keystrokehq/zendesk/platform/connection';
+```
+
+Internal provider-app secrets used for OAuth and webhook verification are not part of the public auth contract.
+
+### Custom mode
+
+Custom mode uses a bring-your-own Zendesk API token connection:
+
+- `ZENDESK_SUBDOMAIN`
+- `ZENDESK_EMAIL`
+- `ZENDESK_API_TOKEN`
+
+```ts
+import { zendeskCustom } from '@keystrokehq/zendesk/custom/connection';
+```
+
+## Triggers
+
+Platform mode exposes both webhook and polling helpers:
+
+```ts
+import { polling, webhooks } from '@keystrokehq/zendesk/platform/triggers';
+
+const userCreated = webhooks.userCreated({
+  transform: (event) => ({
+    eventId: event.eventId,
+    subject: event.subject,
+  }),
+});
+
+const recentTickets = polling.recentTickets({
+  schedule: '10m',
+  transform: (event) => ({
+    eventId: event.eventId,
+    ticketCount: event.tickets.length,
+  }),
+});
+```
+
+Custom mode exposes polling helpers on day one:
+
+```ts
+import { polling } from '@keystrokehq/zendesk/custom/triggers';
+
+const recentTickets = polling.recentTickets({
+  schedule: '10m',
+});
+```
+
+## Operations
+
+Operations are Keystroke steps and are called with `.run(...)`.
+
+### Tickets
+
+```ts
+import {
+  createTicket,
+  getTicket,
+  listTickets,
+  mergeTickets,
+  replyToTicket,
+  updateManyTickets,
+} from '@keystrokehq/zendesk/platform/tickets';
+```
+
+### Users
+
+```ts
+import {
+  createManyUsers,
+  getCurrentUser,
+  getUser,
+  searchUsers,
+  updateUser,
+} from '@keystrokehq/zendesk/custom/users';
+```
+
+### Organizations and search
+
+```ts
+import {
+  autocompleteOrganizations,
+  countOrganizations,
+  createOrganization,
+} from '@keystrokehq/zendesk/platform/organizations';
+import { countSearchResults, search } from '@keystrokehq/zendesk/custom/search';
+```
+
+### Async job status
+
+```ts
+import { getJobStatus } from '@keystrokehq/zendesk/platform/jobs';
+```
+
+## Type Safety
+
+Shared schemas and curated event payloads are available from explicit support surfaces:
+
+```ts
+import type { ZendeskRecentTicketsEvent, ZendeskUserCreatedEvent } from '@keystrokehq/zendesk/events';
+import { zendeskTicketSchema } from '@keystrokehq/zendesk/schemas';
+```
+
+## Webhook Verification
+
+Platform webhook triggers verify Zendesk signatures before any user-authored trigger code runs.
+
+Low-level helpers are available from `@keystrokehq/zendesk/verification` when needed.
+
+## Integration Testing
+
+Live provider coverage is exposed through `test:int` and intentionally skips by credential mode when the required Zendesk env is absent.
+
+Required env in `.env.test`:
+
+- Custom mode: `ZENDESK_CUSTOM_SUBDOMAIN`, `ZENDESK_CUSTOM_EMAIL`, `ZENDESK_CUSTOM_API_TOKEN`
+- Platform mode: `ZENDESK_PLATFORM_SUBDOMAIN`, `ZENDESK_PLATFORM_ACCESS_TOKEN`
+- Platform webhook delivery: `ZENDESK_PLATFORM_WEBHOOK_SIGNING_SECRET`
+
+Run the package validation suite with:
+
+```bash
+turbo run test:int --filter=@keystrokehq/zendesk
+```
+
+## Migration Notes
+
+- Prefer explicit `platform/<domain>` and `custom/<domain>` imports in all docs and workflows.
+- Use `client`, `schemas`, `events`, and `verification` for shared support surfaces.
+- Do not import from the package root for workflow authoring.

package/dist/_official/index.d.mts

@@ -0,0 +1,2 @@
+import { a as zendeskCustomOfficialIntegration, c as zendeskPlatformOfficialIntegration, i as zendeskCustomBundle, l as zendeskPlatformAppCredentialSet, s as zendeskPlatformBundle, u as zendeskPlatformProviderSeed } from "../integration-BYDT8ccc.mjs";
+export { zendeskCustomBundle, zendeskCustomOfficialIntegration, zendeskPlatformAppCredentialSet, zendeskPlatformBundle, zendeskPlatformOfficialIntegration, zendeskPlatformProviderSeed };

package/dist/_official/index.mjs

@@ -0,0 +1,3 @@
+import { a as zendeskPlatformBundle, c as zendeskPlatformProviderSeed, n as zendeskCustomBundle, o as zendeskPlatformOfficialIntegration, r as zendeskCustomOfficialIntegration, s as zendeskPlatformAppCredentialSet } from "../integration-BGHdDCMn.mjs";
+
+export { zendeskCustomBundle, zendeskCustomOfficialIntegration, zendeskPlatformAppCredentialSet, zendeskPlatformBundle, zendeskPlatformOfficialIntegration, zendeskPlatformProviderSeed };