effect-cursor-sdk 0.3.4 → 0.4.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/DEPRECATIONS.md +2 -85
- package/README.md +51 -45
- package/dist/index.d.ts +33 -80
- package/dist/index.js +27 -37
- package/dist/index.js.map +1 -1
- package/docs/RECIPES.md +7 -15
- package/docs/SDK_COVERAGE.md +3 -3
- package/docs/changeset-agent.md +1 -1
- package/package.json +2 -2
- package/docs/MIGRATION_NEXT_MAJOR.md +0 -22
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# Next major migration (planned)
|
|
2
|
-
|
|
3
|
-
This mirrors [DEPRECATIONS.md](../DEPRECATIONS.md) at a high level. **No breaking release is scheduled in this document**; it only records the intended end state.
|
|
4
|
-
|
|
5
|
-
## Agent entry renames
|
|
6
|
-
|
|
7
|
-
| Current (0.2.x) | Planned after removing deprecated overloads |
|
|
8
|
-
| ----------------------------------------------- | ------------------------------------------- |
|
|
9
|
-
| `createFromConfig(config, overrides?)` | `create(config, overrides?)` |
|
|
10
|
-
| `resumeFromConfig(agentId, config, overrides?)` | `resume(agentId, config, overrides?)` |
|
|
11
|
-
| `promptFromConfig(message, config, overrides?)` | `prompt(message, config, overrides?)` |
|
|
12
|
-
| `scopedFromConfig(config, overrides?)` | `scoped(config, overrides?)` |
|
|
13
|
-
|
|
14
|
-
Legacy methods that accept raw [`AgentOptions`](https://cursor.com/docs/sdk/typescript) (plain `apiKey` string) will be removed; [`loadCursorConfig`](../README.md#quick-start) and the config-first signatures above become the only entry points.
|
|
15
|
-
|
|
16
|
-
## Application code actions before upgrading (when the major ships)
|
|
17
|
-
|
|
18
|
-
1. Replace `agents.create({ apiKey: … })` with [`loadCursorConfig`](../README.md#quick-start) + `createFromConfig` (or the renamed `create`).
|
|
19
|
-
2. Remove uses of deprecated [`CursorSdkFactory`](../DEPRECATIONS.md#other-deprecations) `create` / `resume` / `prompt` from application layers (keep for tests if needed).
|
|
20
|
-
3. Run tests with [`mockLayer`](../README.md#mocks-and-tests); confirm `CursorSdkFactory` mocks still implement any new factory methods required by that major.
|
|
21
|
-
|
|
22
|
-
Watch [CHANGELOG.md](../CHANGELOG.md) and [DEPRECATIONS.md](../DEPRECATIONS.md) for the actual major version and any codemods.
|