@devrev/airsync-sdk 2.0.0-beta.7 → 2.0.0-beta.8

package/docs/MIGRATION.md

@@ -53,10 +53,13 @@ v2; templates are copied into new connectors, so stale comments spread.
 6. **Sweep.** This must return nothing except legitimate hits (an
    `EventEmitter.emit`, the connector's own `axiosClient` from §9):
    ```bash
-   grep -rnE "@devrev/ts-adaas|airsync-sdk/dist|\bprocessTask\b|WorkerAdapter|\.emit\(|hasWorkerEmitted|Airdrop(Event|Message)|axiosClient|(format|serialize)AxiosError|workerPath:|overridenOptions|skipConfirmation|isLocalDevelopment|--local|(Extractor|Loader)EventType|ExtractionCommonError|ERROR_CODE=|sdkState|onUpload|uploadedArtifacts|currentEventDataLength|EXTRACTION_(DATA|METADATA|ATTACHMENTS|EXTERNAL_SYNC_UNITS)_" \
+   grep -rnE "@devrev/ts-adaas|airsync-sdk/dist|\bprocessTask\b|WorkerAdapter|\.emit\(|hasWorkerEmitted|Airdrop(Event|Message)|axiosClient|(format|serialize)AxiosError|workerPath:|overridenOptions|skipConfirmation|isLocalDevelopment|--local|@devrev/typescript-sdk|(Extractor|Loader)EventType|ExtractionCommonError|ERROR_CODE=|sdkState|onUpload|uploadedArtifacts|currentEventDataLength|EXTRACTION_(DATA|METADATA|ATTACHMENTS|EXTERNAL_SYNC_UNITS)_" \
      --include='*.ts' --include='*.js' --include='*.json' --include='*.yml' --include='*.yaml' --include='*.md' --include='*.mdc' . \
      | grep -vE 'node_modules|/dist/|/coverage/|package-lock.json|MIGRATION_REVIEW.md'
    ```
+   The sweep covers `test/` and other folders that tsc, lint and jest often
+   exclude. A hit there is real: `@devrev/typescript-sdk` must be in
+   `package.json` (§1), and a `local` argv must become the env var (§3).
    Also grep `getByExternalId|getByTargetId` and check each call against §10:
    existence checks there compile but silently invert.
    Then rewrite any connector docs (`README`, `AGENTS.md`, `CLAUDE.md`, `docs/`)
@@ -101,7 +104,13 @@ v2; templates are copied into new connectors, so stale comments spread.
 - `ts-node` and `@devrev/typescript-sdk` are no longer SDK dependencies. A
   connector that runs `.ts` workers directly needs `ts-node` in its own
   `devDependencies`. A connector that uses `@devrev/typescript-sdk` must list
-  it. `InputData` (the type of `event.input_data`) is now exported from the
+  it. The template's local test server (`code/test/runner.ts`, and the copy
+  `airsync start-worker` writes to `code/.snapin-test/`) imports
+  `@devrev/typescript-sdk/dist/snap-ins`, so template connectors add it to
+  `devDependencies`. Most connectors exclude `test/` from tsc, lint and jest,
+  so the gates pass and the local worker then fails with
+  `Cannot find module '@devrev/typescript-sdk/dist/snap-ins'`.
+  `InputData` (the type of `event.input_data`) is now exported from the
   root.
 
 ## 2. Event types
@@ -140,7 +149,7 @@ leave connector logic that uses them alone.
 | `baseWorkerPath?` | **required**, the directory containing `workers/` (usually `__dirname`) |
 | `options.workerPathOverrides` | top-level `workerPathOverrides` |
 | `options: WorkerAdapterOptions` | `options?: SpawnOptions` (`{ timeout?, batchSize? }`) |
-| `options.isLocalDevelopment`, `--local` argv | removed; set `AIRSYNC_LOCAL_DEVELOPMENT=1` |
+| `options.isLocalDevelopment`, `local` / `--local` argv | removed; set `AIRSYNC_LOCAL_DEVELOPMENT=1` |
 
 ```ts
 // v1
@@ -171,9 +180,14 @@ spawn({
   `START_DELETING_EXTRACTOR_STATE` and `START_EXTRACTING_ATTACHMENTS` /
   `CONTINUE_EXTRACTING_ATTACHMENTS` / `START_DELETING_EXTRACTOR_ATTACHMENTS_STATE`.
 - **Local mode** comes only from the `AIRSYNC_LOCAL_DEVELOPMENT=1` environment
-  variable, and is ignored on Lambda. A local runner that did
-  `process.argv.push('--local')` sets
-  `process.env.AIRSYNC_LOCAL_DEVELOPMENT = '1'` before calling `spawn` instead.
+  variable, and is ignored on Lambda. v1 also enabled it from a bare `local`
+  argument, which the template test server receives (`main.ts local --port …`,
+  also used by `airsync start-worker`). v2 ignores both `local` and `--local`
+  without an error: logs come out as production JSON and no copies land in
+  `extracted_files/`. A local runner that did `process.argv.push('--local')`
+  or relied on the `local` argument sets
+  `process.env.AIRSYNC_LOCAL_DEVELOPMENT = '1'` before calling `spawn` instead,
+  or documents running the worker with `AIRSYNC_LOCAL_DEVELOPMENT=1`.
 
 ## 4. Workers return a `TaskResult` instead of emitting
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devrev/airsync-sdk",
-  "version": "2.0.0-beta.7",
+  "version": "2.0.0-beta.8",
   "description": "Typescript SDK for building AirSync snap-ins on the DevRev platform.",
   "type": "commonjs",
   "main": "./dist/index.js",