@owlmeans/client-planning 0.1.18-rc.28 → 0.1.18-rc.29

package/README.md

@@ -1,15 +1,15 @@
 # @owlmeans/client-planning
 
 The client half of OwlMeans planning: a `PlanningFacade` over the protocol tree a server mounted
-with [`@owlmeans/server-planning`](../server-planning), an optional state mirror of cards, links and
-commits, and a commit wait that subscribes first and then long-polls. It is React-free, so the same
+with [`@owlmeans/server-planning`](../server-planning), optional state mirrors of cards, links,
+commits, assignees, teams, comments and mentions, and a commit wait that subscribes first and then long-polls. It is React-free, so the same
 code runs in a browser app and in a Node client. Use `@owlmeans/server-planning` instead wherever the
 planning service runs in-process.
 
 ## Installation
 
 ```bash
-bun add @owlmeans/client-planning@^0.1.18-rc.28
+bun add @owlmeans/client-planning@^0.1.18-rc.29
 ```
 
 ## Concepts
@@ -36,9 +36,14 @@ import { appendPlanningClient, appendPlanningStores } from '@owlmeans/client-pla
 const planningProtocols = makePlanningProtocols({
   base: { alias: 'app:api:planning', path: '/planning', service: API },
   guards: DEFAULT_GUARD,
+  resources: true,
+  definitions: true,
 })
 
-appendPlanningClient(context, { protocols: planningProtocols, poll: 20 })
+appendPlanningClient(context, {
+  protocols: planningProtocols, poll: 20,
+  scopeKey: () => `${currentEntitySlug}:${currentSessionId}`,
+})
 appendPlanningStores(context)
 ```
 
@@ -81,6 +86,41 @@ appendPlanningClient(context, {
 })
 ```
 
+## Auxiliary resources and session lifecycle
+
+The remote facade supports the same `assignees`, `teams`, `comments` and `mentions` methods as
+the server, including compare-and-set writes, canonical team membership/project attachment,
+effective project assignees and mention-cache rebuilding. `definitions` supports assignee types
+when the server mounts writable schemas. Relationships include endpoint resource kinds and named
+inverse views; models resolve schemas through their nearest primary project.
+
+`appendPlanningStores` registers four auxiliary mirrors beside cards, links and commits. Reads
+and writes through the facade update those mirrors without replacing newer versions. A resource
+feed refreshes the requested subsets through the stock API:
+
+```ts
+import { makePlanningResourceFeed } from '@owlmeans/client-planning'
+
+const resources = makePlanningResourceFeed(context, {
+  assignees: { retired: false, size: 0 }, teams: { size: 0 },
+  comments: { card: cardId, size: 0 }, mentions: { card: cardId, size: 0 },
+  refresh: 5_000,
+})
+await resources.ready
+// Read context.planningStores().assignees, teams, comments and mentions.
+await resources.stop()
+```
+
+`scopeKey` identifies the current organization slug and authenticated session. A changed key
+cancels old requests and feeds, drains local mutations and clears mirrors; capture a new facade
+and feed for the new session. `await context.planning().close()` releases feeds, subscriptions,
+commit waits and sockets, including carriers that open late. Stopped requests cannot repopulate
+cleared mirrors, even when a transport ignores cancellation.
+
+The server derives authorization scope from credentials. Wire records omit native organization
+`entityId`; the client hydrates empty advisory metadata for the shared record shape. Never use
+that placeholder to authorize a request, and never send an organization record id on the wire.
+
 ## API
 
 - `appendPlanningClient(context, options)`, `makePlanningClientService(context, options)`
@@ -90,6 +130,8 @@ appendPlanningClient(context, {
 - `planningMirrorOf(stores)` (`makePlanningMirror`) — `.applyCommitEvent(event, facade?)`,
   `.applyReceipt(view)`, `.applyCards(cards)`
 - `makePlanningFeed(context, opts?)`
+- `makePlanningResourceFeed(context, opts?)`, `PlanningResourceFeedOptions`
+- `makePlanningClientLifecycle`, `PlanningClientLifecycle`; service `close()` and `scopeKey`
 - `planningContextOf(context)` (`makePlanningContextHelper`) — `.facade(scope?)`, `.model(card, scope?)`,
   `.stores()`
 - The former plain functions (`syncCards`, `applyCards`, `planningOf`, …) remain as deprecated
@@ -108,6 +150,9 @@ appendPlanningClient(context, {
 - `CommitTimeout` leaves the transition pending — re-wait or re-read, do not re-execute without a `key`.
 - A client refuses `store()`, `committed()` and plugins carrying hooks with `PlanningUnsupported`.
 - Mount one feed per screen; every other reader uses the store.
+- Auxiliary updates/removals require `{ version: record.version }`. Their `fields` replace the
+  previous object; card `changes.fields` merge.
+- After a scope/session change, acquire new facades and feeds. Old ones are deliberately stale.
 
 ## Related packages
 

package/agent-meta/manifest.json

@@ -1,8 +1,8 @@
 {
   "schemaVersion": 2,
   "package": "@owlmeans/client-planning",
-  "version": "0.1.18-rc.28",
-  "generatedAt": "2026-10-09T14:39:40.666Z",
+  "version": "0.1.18-rc.29",
+  "generatedAt": "2026-10-09T20:19:04.322Z",
   "canonicalRepo": "https://github.com/owlmeans/common",
   "entries": [
     {

package/agent-meta/skills/client-planning/SKILL.md

@@ -8,7 +8,7 @@ user-invocable: false
 # @owlmeans/client-planning
 
 **Layer:** Client
-**Install:** `"@owlmeans/client-planning": "^0.1.18-rc.28"` in `dependencies`
+**Install:** `"@owlmeans/client-planning": "^0.1.18-rc.29"` in `dependencies`
 
 The client half of OwlMeans planning. It answers the `PlanningFacade` interface of
 `@owlmeans/planning` over the protocol tree a server mounted with `@owlmeans/server-planning`, keeps

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@owlmeans/client-planning",
-  "version": "0.1.18-rc.28",
+  "version": "0.1.18-rc.29",
   "license": "MIT",
   "description": "The client half of OwlMeans planning — the remote planning facade, the state mirror and its commit fold, and the subscribe-then-poll commit wait. React-free: it runs in a browser and in a Node client alike.",
   "type": "module",
@@ -29,7 +29,7 @@
     "@owlmeans/context": "^0.1.18-rc.34",
     "@owlmeans/entrypoint": "^0.1.18-rc.41",
     "@owlmeans/error": "^0.1.18-rc.38",
-    "@owlmeans/planning": "^0.1.18-rc.24",
+    "@owlmeans/planning": "^0.1.18-rc.26",
     "@owlmeans/resource": "^0.1.18-rc.40",
     "@owlmeans/log": "^0.1.18-rc.3",
     "@owlmeans/route": "^0.1.18-rc.35",
@@ -42,7 +42,7 @@
   },
   "devDependencies": {
     "@owlmeans/dep-config": "workspace:*",
-    "@owlmeans/server-planning": "^0.1.18-rc.28",
+    "@owlmeans/server-planning": "^0.1.18-rc.30",
     "@owlmeans/test": "^0.1.18-rc.36",
     "@types/bun": "^1.4.2",
     "ajv": "^8.20.0",