@procedures/splay 0.42.0 → 0.44.0

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # @procedures/splay
 
+## 0.44.0
+
+### Patch Changes
+
+- Updated dependencies [4dada47]
+- Updated dependencies [19b7a25]
+  - @procedures/client@0.44.0
+
+## 0.43.0
+
+### Minor Changes
+
+- 79536cf: The component helpers of `@procedures/splay` register nothing in the global registry (O75, rule I2). This change breaks the API.
+  
+  - `defineComponent()`, `simpleComponent()`, `namespacedComponent()` and `streamingComponent()` only give the definition. They do not register a procedure in `PROCEDURE_REGISTRY`.
+  - `registerBundle()` and its export are removed.
+  - `componentModule(name, components)` replaces the two. It gives the procedures of a bundle or of a list of definitions as a module. Give the module to `createRegistry()` or `registerModules()`.
+  - `./register` of `@procedures/splay` does not change. It registers the bridge procedures `splay.bridge.info` and `splay.bridge.health`.
+  
+  Migration:
+  
+  - An app that calls `defineComponent()` and then starts the procedure of a component by its path gives the definitions to `componentModule()`. Then it registers the module.
+    - For a registry of the app: `createRegistry(componentModule("my-app/ui", [userCard, badge]))`.
+    - For the global registry: `registerModules(PROCEDURE_REGISTRY, [componentModule("my-app/ui", [userCard, badge])])`. Put this call in the `src/register.ts` of the app.
+  - An app that uses `registerBundle(bundle)` uses `registerModules(PROCEDURE_REGISTRY, [componentModule("my-app/ui", bundle)])`. The components of the bundle keep their paths.
+  - The site: the site does not use these functions. No step is necessary.
+  - MiniMongo, Graph and jarvis: find each call of `defineComponent`, `simpleComponent`, `namespacedComponent`, `streamingComponent` and `registerBundle`. Do the steps above for each one. An app without these calls has no step.
+  - `componentModule()` and `createBundle()` accept a definition with a typed `input` schema. `AnyComponentDefinition` erases the data type with `any`, as `AnyProcedure` does.
+
+### Patch Changes
+
+- @procedures/client@0.43.0
+
 ## 0.42.0
 
 ### Patch Changes

package/README.md

@@ -378,7 +378,20 @@ import {
 } from "@procedures/splay";
 ```
 
-`componentModule(name, components)` gives the component procedures as a module for `createRegistry()`. It registers nothing. `defineComponent`, `simpleComponent`, `namespacedComponent`, `streamingComponent` and `registerBundle` register in the global registry. That registration is deprecated, and the next MINOR removes it.
+`defineComponent`, `simpleComponent`, `namespacedComponent` and `streamingComponent` give the definition of a component. They register nothing. `componentModule(name, components)` gives the procedures of the components as a module. The path of each procedure is `["components", namespace?, type]`. Give the module to `createRegistry()`, or to `registerModules()` for the global registry:
+
+```typescript
+import { createRegistry, registerModules, PROCEDURE_REGISTRY } from "@procedures/client";
+import { componentModule, createBundle, simpleComponent } from "@procedures/splay";
+
+const badge = simpleComponent("badge", (ctx) => ({ type: "badge", props: { label: ctx.data } }));
+const uiModule = componentModule("my-app/ui", createBundle("ui", [badge]));
+
+const registry = createRegistry(uiModule); // components.ui.badge in a new registry
+registerModules(PROCEDURE_REGISTRY, [uiModule]); // components.ui.badge in the global registry
+```
+
+Before 0.42.0, the four functions registered each component in the global registry, and `registerBundle()` registered a bundle. At this time, `componentModule()` replaces the two.
 
 ### Package Hierarchy