@sylphx/sdk 0.5.0 → 0.7.0

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.
Files changed (30) hide show
  1. package/README.md +13 -0
  2. package/dist/index.d.cts +3304 -20506
  3. package/dist/index.d.ts +3304 -20506
  4. package/dist/index.js +8399 -1698
  5. package/dist/index.js.map +1 -1
  6. package/dist/index.mjs +8108 -1456
  7. package/dist/index.mjs.map +1 -1
  8. package/dist/nextjs/index.d.cts +24 -5697
  9. package/dist/nextjs/index.d.ts +24 -5697
  10. package/dist/nextjs/index.js +24 -25
  11. package/dist/nextjs/index.js.map +1 -1
  12. package/dist/nextjs/index.mjs +24 -25
  13. package/dist/nextjs/index.mjs.map +1 -1
  14. package/dist/react/index.d.cts +404 -6088
  15. package/dist/react/index.d.ts +404 -6088
  16. package/dist/react/index.js +1124 -611
  17. package/dist/react/index.js.map +1 -1
  18. package/dist/react/index.mjs +1191 -677
  19. package/dist/react/index.mjs.map +1 -1
  20. package/dist/server/index.d.cts +116 -19551
  21. package/dist/server/index.d.ts +116 -19551
  22. package/dist/server/index.js +128 -61
  23. package/dist/server/index.js.map +1 -1
  24. package/dist/server/index.mjs +128 -51
  25. package/dist/server/index.mjs.map +1 -1
  26. package/dist/web-analytics.js +0 -3
  27. package/dist/web-analytics.js.map +1 -1
  28. package/dist/web-analytics.mjs +0 -3
  29. package/dist/web-analytics.mjs.map +1 -1
  30. package/package.json +2 -5
package/README.md CHANGED
@@ -427,3 +427,16 @@ const config = createConfig({
427
427
 
428
428
  > **Note:** `SYLPHX_PLATFORM_URL` has been removed (was deprecated). Use `projectRef` instead.
429
429
  > If using hosted Sylphx at [sylphx.com](https://sylphx.com), no additional config is needed.
430
+
431
+ ---
432
+
433
+ ## Architecture — contract-first
434
+
435
+ This SDK is part of the [two-plane architecture](../../docs/adr/ADR-083-two-plane-sdk-architecture.md) (ADR-083) with a single source of truth (ADR-084):
436
+
437
+ - **`@sylphx/contract`** (Effect Schema) drives the types you see here. The types are not hand-written and not separately maintained — add an endpoint to the contract and both this SDK and the sibling [`@sylphx/management`](../management) inherit it. Hand-written shims are a bug.
438
+ - **Promise surface, Effect-free.** Internally `@sylphx/contract` is Effect Schema, but the published `.d.ts` is stripped of Effect imports (strip-at-publish CI guard). You get clean `Promise<User>` / `Promise<Plan[]>` signatures with zero Effect dependency in your bundle.
439
+ - **Standard Schema compliant.** Every input schema in the contract exposes the `~standard` interface — compatible with Zod, Valibot, ArkType, TypeBox, Effect Schema, and any future Standard-Schema-compliant validator.
440
+ - **Agent surface via the CLI.** The `sylphx` CLI is the first-class agent entry point (Claude Code, Cursor, ChatGPT Apps). If you want a custom MCP, compose it on top of `@sylphx/management` yourself — Sylphx does not ship a standalone stdio MCP binary.
441
+
442
+ See [ADR-084](../../docs/adr/ADR-084-effect-schema-contract.md) for the full design rationale.