@apex-inc/sdk 0.1.0 → 0.1.1

package/README.md

@@ -1,6 +1,14 @@
 # @apex-inc/sdk
 
-Lightweight SDK for sending events and user data to Apex Growth Intelligence. Works in **Node.js** (18+) and **browser** environments. Zero runtime dependencies.
+Event tracking and identity SDK for Apex — currently in **private beta**.
+
+Works in Node.js 18+ and browser environments. Zero runtime dependencies.
+
+## Access
+
+Apex is invite-only during the private-beta period. If you received an invite, your onboarding email contains your `projectKey` and `apiUrl`. Full API documentation is available in-app once your account is active.
+
+Not in the beta yet? Request access at [apex.inc](https://apex.inc) (coming soon).
 
 ## Install
 
@@ -13,153 +21,15 @@ npm install @apex-inc/sdk
 ```typescript
 import { init, track, identify } from "@apex-inc/sdk";
 
-// Initialize (once, at app startup)
 init({
   projectKey: "your-project-key",
   apiUrl: "https://your-apex-instance.com",
 });
 
-// Identify a user
-identify("user_123", {
-  email: "jane@example.com",
-  plan: "starter",
-});
-
-// Track events
+identify("user_123", { email: "jane@example.com" });
 track("page_viewed", { path: "/pricing" });
-track("button_clicked", { label: "Start Trial", section: "hero" });
-track("form_submitted", { formId: "signup", fields: 3 });
-```
-
-## API
-
-### `init(config)`
-
-| Option          | Type     | Default                  | Description                       |
-|-----------------|----------|--------------------------|-----------------------------------|
-| `projectKey`    | string   | **required**             | Your Apex project key             |
-| `apiUrl`        | string   | `window.location.origin` | Apex API URL                      |
-| `flushInterval` | number   | `5000`                   | Auto-flush interval (ms)         |
-| `flushAt`       | number   | `20`                     | Max queued events before flush   |
-| `debug`         | boolean  | `false`                  | Log SDK activity to console      |
-
-### `track(event, properties?)`
-
-Send a named event with optional properties.
-
-```typescript
-track("page_viewed", { path: "/pricing", referrer: "google" });
-```
-
-### `identify(userId, traits?)`
-
-Associate subsequent events with a user. Also performs **identity stitching** — linking an anonymous visitor to a known email address.
-
-```typescript
-identify("jane@example.com", {
-  name: "Jane Smith",
-  plan: "growth",
-  company: "Acme Inc",
-});
-```
-
-#### Identity Stitching
-
-When the `userId` contains `@` (or `traits.email` is set), the SDK automatically calls the `/api/identity/stitch` endpoint to link the email to a visitor profile. This connects anonymous browsing behavior (from the Apex snippet) to a known user.
-
-For **server-side** identify calls (e.g., from a webhook handler), pass the browser's `apex_vid` cookie as `traits.visitorId` to ensure the stitch connects to the real browser session:
-
-```typescript
-identify("jane@example.com", {
-  visitorId: req.cookies.apex_vid,  // From the browser cookie
-  plan: "growth",
-});
-```
-
-Without `visitorId`, a synthetic visitor ID is created that won't connect to marketing touchpoints.
-
-### `trackForm(formData)`
-
-Track a form submission and identify the user in one call. Combines `track("form_submit", ...)` with `identify(email, ...)`.
-
-```typescript
-trackForm({
-  email: "jane@example.com",
-  formId: "signup-form",
-  action: "/api/register",
-  fields: { name: "Jane", company: "Acme" },
-});
-```
-
-| Option   | Type   | Required | Description                      |
-|----------|--------|----------|----------------------------------|
-| `email`  | string | Yes      | User's email address             |
-| `formId` | string | No       | Form identifier                  |
-| `action` | string | No       | Form action URL                  |
-| `fields` | object | No       | Additional form field data       |
-
-### `flush()`
-
-Immediately send all queued events.
-
-### `shutdown()`
-
-Flush remaining events and stop the background timer.
-
-## Node.js Usage
-
-The SDK works in Node.js 18+ (which includes global `fetch`). For older Node.js versions, install `node-fetch`:
-
-```bash
-npm install node-fetch
 ```
 
-```typescript
-import { init, track, identify, shutdown } from "@apex-inc/sdk";
-
-init({
-  projectKey: "your-project-key",
-  apiUrl: "https://your-apex-instance.com",
-});
-
-// In your webhook handler or API route:
-identify("new-signup@example.com", { source: "stripe_webhook" });
-track("subscription_created", { plan: "growth", mrr: 99 });
-
-// On process exit:
-shutdown();
-```
-
-## Management API (API key)
-
-For **server-side** access to experiments (same auth model as the Apex MCP server), use `createManagementClient` with your **`APEX_API_KEY`** and project key. The client sends **`x-api-key`** and **`x-apex-project`** so routes resolve the tenant without a browser session.
-
-```typescript
-import { createManagementClient, init, track } from "@apex-inc/sdk";
-
-const apex = createManagementClient({
-  projectKey: "your-project-key",
-  apiKey: process.env.APEX_API_KEY!,
-  apiUrl: "https://your-apex-instance.com",
-});
-
-const experiments = await apex.listExperiments();
-const { variant } = await apex.assignVariant("experiment-id-123", "stable-visitor-id-per-user");
-
-init({ projectKey: "your-project-key", apiUrl: "https://your-apex-instance.com" });
-track("notification_sent", { experimentId: "experiment-id-123", variant });
-```
-
-`assignVariant` uses a stable **visitor id** per end user (e.g. hashed internal user id) so variant assignment stays deterministic. Pass the same id on every call for that user and experiment.
-
-## Shipped skills (AI assistants)
-
-Cursor-style skills live in **`skills/apex-growth-tracking/SKILL.md`**. Copy that folder into `.cursor/skills/` so your AI assistant gets Apex tracking conventions in context.
-
-## How It Works
-
-Events are queued in memory and flushed in batches to `POST /api/events`. The SDK auto-flushes on a timer, when the queue hits `flushAt`, and on `beforeunload` / `visibilitychange` in browsers.
-
 ## License
 
 MIT — see [LICENSE](./LICENSE)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@apex-inc/sdk",
-  "version": "0.1.0",
-  "description": "Apex Growth Intelligence SDK — track events, identify users, and run experiments from any JavaScript runtime.",
+  "version": "0.1.1",
+  "description": "Event tracking and identity SDK for Apex — currently in private beta.",
   "main": "dist/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/index.d.ts",
@@ -17,12 +17,8 @@
     "build": "tsc && tsc -p tsconfig.esm.json",
     "dev": "tsc --watch"
   },
-  "keywords": ["apex", "growth", "analytics", "experiments", "ab-testing", "sdk"],
+  "keywords": ["apex", "sdk"],
   "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/apex-inc/sdk"
-  },
   "publishConfig": {
     "access": "public"
   },