@drivemetadata-ai/sdk 0.1.1-beta.1 → 0.1.1-beta.2

package/docs/migration-cdn-to-npm.md

@@ -1,99 +0,0 @@
-# CDN to NPM Migration
-
-The existing CDN script remains supported:
-
-```html
-<script src="https://example-cdn/drivemetadata/dmdSDK_v3.js"></script>
-```
-
-The npm SDK adds typed imports and framework adapters.
-
-## Before
-
-```html
-<script src="/dmdSDK_v3.js"></script>
-<script>
-  window.dmdSDK = new window.DriveMetaDataSDK({
-    client_id: 'client_xxx',
-    workspace_id: 'workspace_xxx',
-    app_id: 'app_xxx',
-    writeKey: 'public_write_key',
-    consent: { analytics: 'granted', advertising: 'denied' }
-  });
-  window.dmdSDK.trackEvent('Product Viewed', { sku: 'sku_123' });
-</script>
-```
-
-## After
-
-```ts
-import { initDmdSDK, track } from '@drivemetadata/sdk/browser';
-
-initDmdSDK({
-  clientId: 'client_xxx',
-  workspaceId: 'workspace_xxx',
-  appId: 'app_xxx',
-  writeKey: 'public_write_key',
-  consent: { analytics: 'granted', advertising: 'denied' }
-});
-
-track('Product Viewed', { sku: 'sku_123' });
-```
-
-## Config Mapping
-
-| CDN config | NPM config |
-| --- | --- |
-| `client_id` | `clientId` |
-| `workspace_id` | `workspaceId` |
-| `app_id` | `appId` |
-| `token` | `writeKey` |
-| `api_host` | `apiHost` |
-| `capture_pageview` | `capturePageview` |
-| `capture_pageleave` | `capturePageleave` |
-| `capture_dead_clicks` | `captureDeadClicks` |
-| `disable_persistence` | `disablePersistence` |
-| `mask_all_text` | `maskAllText` |
-| `mask_all_element_attributes` | `maskAllElementAttributes` |
-
-## Compatibility
-
-The npm browser entry no longer requires a global CDN constructor. The global CDN script path remains available for customers who cannot move to npm immediately.
-
-## Behavior Parity Contract
-
-| Behavior | CDN `dmdSDK_v3.js` | npm browser SDK | Release Requirement |
-|---|---|---|---|
-| `track` | Sends event payload with configured client/workspace/app IDs | Same public event semantics | Covered by parity fixture |
-| `page` | Supports page view tracking | Same public page API | Covered by parity fixture |
-| `identify` | Associates user traits | Same public identify API | Covered by parity fixture |
-| `group` | Associates account/group traits when available | Same public group API | Covered by parity fixture |
-| `alias` | Links previous and current IDs when available | Same public alias API | Covered by parity fixture |
-| Consent denied | Drops analytics events | Drops analytics events and purges queue | Covered by consent tests |
-| Offline failure | Queues where supported | Persists queue in browser storage | Covered by delivery tests |
-| PII masking | Legacy masking behavior | Recursive property sanitization | Covered by privacy tests |
-
-## Legacy Parity Release Rule
-
-Before public npm release, the parity fixture suite must cover:
-
-- track
-- page
-- identify
-- group
-- alias
-- consent denied
-- consent revocation queue purge
-- nested PII redaction
-- offline queue persistence
-- reset cleanup
-
-The CDN script remains supported during migration. New framework integrations should use npm entry points.
-
-Behavior differences:
-
-- `track()` uses the SDK event enrichment and delivery path.
-- Browser `token` terminology is replaced by `writeKey`.
-- Runtime purpose-level consent can be updated with `consent.update()`.
-- npm browser analytics defaults to `pending` when consent is omitted.
-- Health diagnostics are available through `getDmdHealth()`.