@devrev/airsync-sdk 2.0.0 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/MIGRATION.md +8 -8
- package/package.json +1 -1
package/docs/MIGRATION.md
CHANGED
|
@@ -9,8 +9,8 @@ own:
|
|
|
9
9
|
It ships in the package at `node_modules/@devrev/airsync-sdk/docs/MIGRATION.md`
|
|
10
10
|
(read it from disk; the `exports` map only blocks `import`/`require`). Before
|
|
11
11
|
v2 is installed, use
|
|
12
|
-
`https://raw.githubusercontent.com/devrev/
|
|
13
|
-
|
|
12
|
+
`https://raw.githubusercontent.com/devrev/airsync-sdk/main/docs/MIGRATION.md`.
|
|
13
|
+
The installed guide always takes precedence.
|
|
14
14
|
|
|
15
15
|
**The modern wire protocol is unchanged.** Event names, routes, headers,
|
|
16
16
|
artifact formats and `ERROR_CODE=…` strings remain compatible with platforms
|
|
@@ -35,8 +35,8 @@ v2; templates are copied into new connectors, so stale comments spread.
|
|
|
35
35
|
1. **Locate the package.** Find the `package.json` that depends on
|
|
36
36
|
`@devrev/ts-adaas` (generated connectors keep it in `code/`). Run everything
|
|
37
37
|
from there. If it already depends on `@devrev/airsync-sdk`, inspect its
|
|
38
|
-
installed version and migration review.
|
|
39
|
-
changes under **Rare cases** below; upgrade to the
|
|
38
|
+
installed version and migration review. Earlier versions may still need
|
|
39
|
+
the changes under **Rare cases** below; upgrade to the latest v2 version
|
|
40
40
|
and verify source, tests and local runners against this guide. Stop only
|
|
41
41
|
when the current-contract migration and verification are complete.
|
|
42
42
|
2. **Start from green latest v1.** If behind the latest stable 1.x, upgrade and
|
|
@@ -48,7 +48,7 @@ v2; templates are copied into new connectors, so stale comments spread.
|
|
|
48
48
|
3. **Install v2.**
|
|
49
49
|
```bash
|
|
50
50
|
npm uninstall @devrev/ts-adaas
|
|
51
|
-
npm install @devrev/airsync-sdk@
|
|
51
|
+
npm install @devrev/airsync-sdk@latest
|
|
52
52
|
```
|
|
53
53
|
Rename or remove `overrides` / `resolutions` entries keyed on
|
|
54
54
|
`@devrev/ts-adaas`; `npm uninstall` leaves them behind. If the installed
|
|
@@ -776,6 +776,6 @@ change.
|
|
|
776
776
|
that matters.
|
|
777
777
|
- **`is_sdk_log`** is no longer on log lines; update dashboards that filter on
|
|
778
778
|
it.
|
|
779
|
-
- **Connectors migrated
|
|
780
|
-
§3–§14 against
|
|
781
|
-
State they wrote is still read.
|
|
779
|
+
- **Connectors migrated before the v2 GA release** must re-apply
|
|
780
|
+
§3–§14 against the latest release, because most of the API above changed
|
|
781
|
+
before GA. State they wrote is still read.
|