lanka 1.0.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 (97) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +242 -0
  3. package/dist/ALankaGateway-ExlRGT3D.d.ts +122 -0
  4. package/dist/ALankaSharedStore-B7uepuuk.d.ts +29 -0
  5. package/dist/ILankaApiError-zI_2bNs0.d.ts +16 -0
  6. package/dist/ILankaRuntimeConfig-Vl436GWK.d.ts +62 -0
  7. package/dist/ILankaScenarioMetadata-Bu-yggTZ.d.ts +14 -0
  8. package/dist/ILankaScenarioVM-DuCyPoyT.d.ts +260 -0
  9. package/dist/LankaError-B1HtuIkw.d.ts +86 -0
  10. package/dist/LankaScenarioLocator-BGQHwf3n.d.ts +144 -0
  11. package/dist/LankaSharedStoreLocator-MvCpav5F.d.ts +126 -0
  12. package/dist/TLankaErrorHandler-Yfqtdh1M.d.ts +3 -0
  13. package/dist/_extend/index.d.ts +34 -0
  14. package/dist/_extend/index.js +36 -0
  15. package/dist/_extend/index.js.map +1 -0
  16. package/dist/_internal/index.d.ts +43 -0
  17. package/dist/_internal/index.js +34 -0
  18. package/dist/_internal/index.js.map +1 -0
  19. package/dist/activeRuntime-FcsSJvUg.d.ts +84 -0
  20. package/dist/bootstrap/index.d.ts +242 -0
  21. package/dist/bootstrap/index.js +22 -0
  22. package/dist/bootstrap/index.js.map +1 -0
  23. package/dist/chunk-73IVH3C6.js +52 -0
  24. package/dist/chunk-73IVH3C6.js.map +1 -0
  25. package/dist/chunk-BGVDPDX4.js +29 -0
  26. package/dist/chunk-BGVDPDX4.js.map +1 -0
  27. package/dist/chunk-C2HP7CRD.js +224 -0
  28. package/dist/chunk-C2HP7CRD.js.map +1 -0
  29. package/dist/chunk-D27MREPB.js +13 -0
  30. package/dist/chunk-D27MREPB.js.map +1 -0
  31. package/dist/chunk-DTO27QFR.js +59 -0
  32. package/dist/chunk-DTO27QFR.js.map +1 -0
  33. package/dist/chunk-EWVDJYCC.js +296 -0
  34. package/dist/chunk-EWVDJYCC.js.map +1 -0
  35. package/dist/chunk-FIR4XTBL.js +136 -0
  36. package/dist/chunk-FIR4XTBL.js.map +1 -0
  37. package/dist/chunk-ILQNYQY5.js +200 -0
  38. package/dist/chunk-ILQNYQY5.js.map +1 -0
  39. package/dist/chunk-J5LA3Q6D.js +14 -0
  40. package/dist/chunk-J5LA3Q6D.js.map +1 -0
  41. package/dist/chunk-MDZ42XRH.js +10 -0
  42. package/dist/chunk-MDZ42XRH.js.map +1 -0
  43. package/dist/chunk-Q3SOVBIJ.js +176 -0
  44. package/dist/chunk-Q3SOVBIJ.js.map +1 -0
  45. package/dist/chunk-Q7QESSYF.js +49 -0
  46. package/dist/chunk-Q7QESSYF.js.map +1 -0
  47. package/dist/chunk-RKYKK6MN.js +19 -0
  48. package/dist/chunk-RKYKK6MN.js.map +1 -0
  49. package/dist/chunk-RYFZCAQ3.js +637 -0
  50. package/dist/chunk-RYFZCAQ3.js.map +1 -0
  51. package/dist/chunk-UJEC7H6K.js +39 -0
  52. package/dist/chunk-UJEC7H6K.js.map +1 -0
  53. package/dist/chunk-XESL274R.js +23 -0
  54. package/dist/chunk-XESL274R.js.map +1 -0
  55. package/dist/chunk-YR4MZXMU.js +13 -0
  56. package/dist/chunk-YR4MZXMU.js.map +1 -0
  57. package/dist/config/index.d.ts +63 -0
  58. package/dist/config/index.js +16 -0
  59. package/dist/config/index.js.map +1 -0
  60. package/dist/createLankaScope-Bc_vChRs.d.ts +30 -0
  61. package/dist/errors/index.d.ts +37 -0
  62. package/dist/errors/index.js +16 -0
  63. package/dist/errors/index.js.map +1 -0
  64. package/dist/gateway/index.d.ts +258 -0
  65. package/dist/gateway/index.js +438 -0
  66. package/dist/gateway/index.js.map +1 -0
  67. package/dist/index.d.ts +20 -0
  68. package/dist/index.js +43 -0
  69. package/dist/index.js.map +1 -0
  70. package/dist/lankaHttpInFlight-Bk1eIuSx.d.ts +43 -0
  71. package/dist/lankaRequestMiddleware-DAC5kCb7.d.ts +62 -0
  72. package/dist/lankaStandardValidator-CL-r-zEV.d.ts +34 -0
  73. package/dist/locator/index.d.ts +282 -0
  74. package/dist/locator/index.js +67 -0
  75. package/dist/locator/index.js.map +1 -0
  76. package/dist/logger/index.d.ts +146 -0
  77. package/dist/logger/index.js +11 -0
  78. package/dist/logger/index.js.map +1 -0
  79. package/dist/mock/index.d.ts +16 -0
  80. package/dist/mock/index.js +58 -0
  81. package/dist/mock/index.js.map +1 -0
  82. package/dist/role/index.d.ts +48 -0
  83. package/dist/role/index.js +7 -0
  84. package/dist/role/index.js.map +1 -0
  85. package/dist/scenario/index.d.ts +204 -0
  86. package/dist/scenario/index.js +28 -0
  87. package/dist/scenario/index.js.map +1 -0
  88. package/dist/validation/index.d.ts +18 -0
  89. package/dist/validation/index.js +53 -0
  90. package/dist/validation/index.js.map +1 -0
  91. package/dist/viewmodel/index.d.ts +478 -0
  92. package/dist/viewmodel/index.js +701 -0
  93. package/dist/viewmodel/index.js.map +1 -0
  94. package/package.json +99 -0
  95. package/skills/lanka-core/SKILL.md +241 -0
  96. package/skills/lanka-core/reference.md +1090 -0
  97. package/skills/lanka-packages/SKILL.md +70 -0
@@ -0,0 +1,70 @@
1
+ ---
2
+ name: lanka-packages
3
+ description: Choose which lanka package solves a problem, and find its skill. Use when a lanka application needs a capability it does not have yet — storage, realtime, caching, prefetching, optimistic updates, list handling, validation, cookies, start-up stages or a devtool — or when deciding whether something belongs in application code at all.
4
+ license: MIT
5
+ metadata:
6
+ author: lankajs
7
+ package: lanka
8
+ version: "1.0.0"
9
+ ---
10
+
11
+ # lanka — which package, and what it costs
12
+
13
+ The framework is `lanka` plus optional packages. This skill routes; each package
14
+ has a skill of its own with the detail.
15
+
16
+ > [!NOTE]
17
+ > Only what the framework or a gate refuses is binding. Everything else here is a
18
+ > recommendation you can adapt.
19
+
20
+ ## By the problem
21
+
22
+ | The problem | The package | Its skill |
23
+ | ------------------------------------------------------- | ------------------------------- | ---------------------------- |
24
+ | screens, data, state, events | `lanka` | `lanka-core` |
25
+ | stale data after several refreshes; bursts; polling | `@lankajs/async` | `lanka-async` |
26
+ | a button that must not double-fire; instant feedback | `@lankajs/optimistic` | `lanka-optimistic` |
27
+ | a table: sort, filter, paginate, stop re-rendering rows | `@lankajs/collection` | `lanka-collection` |
28
+ | localStorage, IndexedDB, encryption, persisted state | `@lankajs/storage` | `lanka-storage` |
29
+ | avatars and thumbnails that reload or flicker | `@lankajs/blob-cache` | `lanka-blob-cache` |
30
+ | cookies; stale caches after a new build shipped | `@lankajs/browser` | `lanka-browser` |
31
+ | validating responses with zod / valibot | `@lankajs/zod`, `@lankajs/valibot` | `lanka-zod`, `lanka-valibot` |
32
+ | retry, idempotency, timeouts, auth refresh, CSRF | `@lankajs/plugin-http` | `lanka-http` |
33
+ | realtime updates pushed by the server | `@lankajs/plugin-sse` | `lanka-sse` |
34
+ | warming data or route code before the user asks | `@lankajs/plugin-prefetch` | `lanka-prefetch` |
35
+ | ordered start-up stages that can redirect | `@lankajs/plugin-bootstrap-steps` | `lanka-bootstrap-steps` |
36
+ | seeing what the bus and the logger did | `@lankajs/plugin-devtools` | `lanka-devtools` |
37
+ | the `@lanka_di` wiring and its build-time check | `@lankajs/tool-di` | `lanka-di` |
38
+ | architectural boundaries as lint rules | `@lankajs/tool-eslint` | `lanka-eslint` |
39
+ | testing, and benchmarking | `@lankajs/tool-testing` | `lanka-testing` |
40
+
41
+ ## Module or plugin, and why you should care
42
+
43
+ - A **module** is called by your app (`app → module`). Core does not know it
44
+ exists; remove it and core works the same.
45
+ - A **plugin** is called by core (`app → core → plugin`) and is registered with
46
+ `lanka.use(...)`. Every plugin declares `lanka` as a **peer dependency** — a
47
+ normal dependency would give it its own copy of core, and its policy would
48
+ install into an instance your app never uses.
49
+
50
+ ## What NOT to install
51
+
52
+ - Both `@lankajs/zod` and `@lankajs/valibot`. Pick one; the point is that the choice
53
+ is visible in your dependency list.
54
+ - `@lankajs/plugin-prefetch` before the app is measurably slow somewhere. It is
55
+ three tiers of machinery for a problem you may not have.
56
+ - `@lankajs/blob-cache` for images whose URL can change. It never checks freshness.
57
+
58
+ ## Getting the skills
59
+
60
+ ```bash
61
+ # Claude Code, from git
62
+ /plugin marketplace add lankajs/lanka
63
+ /plugin install lanka-storage@lankajs
64
+
65
+ # or from the packages you already installed, version-matched
66
+ npx lanka-skills sync
67
+ ```
68
+
69
+ The second is worth preferring where it works: it installs the skill for the
70
+ version in your `node_modules`, not the one on the framework's main branch.