@native-engagement/sdk 0.8.2 → 0.9.1

package/package.json

@@ -1,23 +1,17 @@
 {
   "name": "@native-engagement/sdk",
-  "version": "0.8.2",
+  "version": "0.9.1",
   "type": "module",
-  "description": "Authenticated remote TypeScript client for Native Engagement",
   "engines": {
     "node": ">=24.22.1 <25"
   },
-  "license": "UNLICENSED",
+  "license": "Apache-2.0",
   "files": [
     "dist",
-    "README.md",
+    "LICENSE",
     "release.json",
     "THIRD_PARTY_LICENSES.txt"
   ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/SENLIN746/native-engagement.git"
-  },
-  "homepage": "https://engagement.shipkitx.com/downloads",
   "publishConfig": {
     "access": "public",
     "tag": "beta"

package/release.json

@@ -1,6 +1,6 @@
 {
   "schemaVersion": 1,
-  "sourceCommit": "0270865d1f69c5c4c01d3acab37090346699763a",
+  "sourceCommit": "bc4ff2a04ed51d004904430cabe24b6a739f88e8",
   "channel": "beta",
   "bundledComponents": [
     {
@@ -14,5 +14,5 @@
       "license": "MIT"
     }
   ],
-  "lockSha256": "6fed06159024d6c915e45acdd81734e0ec37fc25230cb6c1a9c00013d7a2ed66"
+  "lockSha256": "00164f8922c82350ad7cbe357f976d03b46faec9ebe48c634cb8ba2a922c3e3c"
 }

package/README.md

@@ -1,91 +0,0 @@
-# Native Engagement SDK
-
-JavaScript and TypeScript access to Native Engagement. Requires Node.js 24.22.1+ in the 24 LTS line.
-
-```sh
-npm install @native-engagement/sdk@0.8.2
-```
-
-## Account and password sign-in
-
-The SDK supports browser-based account sign-in through OAuth Authorization Code with S256 PKCE. Enter your account, password and any MFA challenge on the identity service's browser page. The SDK receives a validated authorization result; your application does not collect the password.
-
-```js
-import { createNativePublicLogin, openNativeLoginPage,
-  RemoteNativeEngagementSdk, prospectClient } from '@native-engagement/sdk';
-
-const origin = 'https://engagement.shipkitx.com';
-const login = await createNativePublicLogin(origin);
-const grant = await login.authorize(AbortSignal.timeout(180_000), openNativeLoginPage);
-const sdk = new RemoteNativeEngagementSdk({ baseUrl: origin, accessToken: () => grant.accessToken });
-const prospects = prospectClient(sdk);
-```
-
-`openNativeLoginPage` opens the system browser on macOS, Windows and Linux. Applications with their own browser UI can supply an `async authorizationUrl => { ... }` callback instead. The browser callback must reach the Node.js process on its configured loopback address. Use a local Node.js process for this flow; a browser-only application should use the service's web login.
-
-Public configuration comes from `/releases/cli-login.json` on the exact HTTPS center, with pinned issuer, public client, resource and business scopes. Your administrator must provision your account and tenant permissions. Current directory and Profile grants govern every operation.
-
-Keep the short-lived grant in memory or your protected credential store. Sign in again after expiry; an active identity-service browser session can reuse SSO. The SDK does not automatically persist credentials. Sign out with `await login.revoke(grant)`. For automation, supply a separately authorized access token through a token provider or protected process environment. Password arguments and password-grant login are not offered.
-
-## Complete import, creation and association
-
-Country, industry, address, contact name/title and original score are optional `profile` strings. Source URLs are optional; supply the actual credential-free HTTP(S) source page when known. Source reference/version, observation time and current/historical status remain explicit. Persist and reuse the complete input and its idempotency key when retrying.
-
-```js
-const observedAt = new Date().toISOString();
-const input = {
-  idempotencyKey: 'research-november-v1', batchRef: 'research-november-v1', datasetRef: 'November research',
-  rows: [{
-    rowRef: 'row-1', sourceRef: 'reviewed-research-file', sourceVersion: 'v1',
-    selection: 'SELECTED', displayName: 'Example Company',
-    companyIdentity: { namespace: 'reviewed-company', value: 'company-001' },
-    profile: { observedAt, temporalStatus: 'CURRENT', country: 'CN', industry: 'Logistics',
-      address: 'Shanghai', contactName: 'Research Contact', contactTitle: 'Director', score: '8/10' },
-    contacts: [{ channel: 'EMAIL', value: 'research@example.test', observation: {
-      sourceRef: 'reviewed-research-file', sourceVersion: 'v1', observedAt,
-      temporalStatus: 'CURRENT', verificationStatus: 'PUBLIC_UNVERIFIED'
-    } }]
-  }]
-};
-const preview = await prospects.preview(input); // No business write.
-console.log(preview.rows); // Review HELD/REJECTED outcomes before importing.
-await prospects.import(input);
-const batch = await prospects.batch(input.batchRef);
-const imported = batch.rows.find(row => row.status === 'IMPORTED');
-if (!imported?.prospectRef) throw Error('Review the import receipt');
-const company = await prospects.company(imported.prospectRef);
-console.log(company.profileObservations, company.contacts);
-
-const route = company.contacts.find(item => item.channel === 'EMAIL');
-const source = route?.observations.find(item => item.temporalStatus === 'CURRENT');
-if (!route || !source) throw Error('A current imported email observation is required');
-const create = {
-  idempotencyKey: 'research-november-engagement-001', engagementRef: 'research-november-engagement-001',
-  prospectRef: company.prospectRef, contactRouteRef: route.contactRouteRef,
-  sourceRef: source.sourceRef, sourceVersion: source.sourceVersion, observedAt: source.observedAt,
-  whyFit: 'Reviewed logistics fit', whyNow: 'Reviewed current opportunity'
-};
-await prospects.createEngagement(create);
-const associated = await prospects.engagements(company.prospectRef, { limit: 20 });
-console.log(associated.entries); // Continue with associated.nextCursor when present.
-```
-
-Creation uses an exact imported CURRENT observation, current authorization and STOP policy. It records why-fit/why-now without sending or scheduling work. Changed source rows require a new version; names, emails and domains are not stable company identifiers. Score strings retain their original scale. Original research and verification belong to the archive/Knowledge owner; Native Engagement owns imported observations, provenance, receipts and engagement facts.
-
-## Batch pagination
-
-Each response has at most 100 entries; total history has no 100-batch cap. Concurrent imports can shift offset pages; restart from the first page when refreshing. Associated engagements use a separate signed cursor.
-
-```js
-let offset = 0;
-for (;;) {
-  const page = await prospects.batches({ offset, limit: 20 });
-  console.log(page.total, page.entries);
-  if (page.nextOffset === null) break;
-  offset = page.nextOffset;
-}
-```
-
-Exports include `RemoteNativeEngagementSdk`, `RemoteNativeEngagementError`, `prospectClient`, `createNativePublicLogin`, `openNativeLoginPage`, `NativePublicLogin`, `NativeLoginConfiguration`, `NativeLoginGrant`, `RemoteSdkOptions` and Prospect DTOs. Generic `contracts`, `schema`, `query` and `command` remain available. Commands require a stable idempotency key. Unknown external effects require original-operation inspection.
-
-This beta uses license `UNLICENSED`. [Sign-in and MCP OAuth guide](https://engagement.shipkitx.com/releases/authentication.md) · [Downloads](https://engagement.shipkitx.com/downloads)