atomic

flowstate-epic-flowstate-community-epicdm-flowstate-rxdb-client

Package-local agent skill for @epicdm/flowstate-rxdb-client.

Tags

Publisher

Versions

1 version published — latest: 1.0.8

  • 1.0.8
    publishedInvalid Date

Skill

flowstate-rxdb-client Package Skill

Package: @epicdm/flowstate-rxdb-client Repository: epic-flowstate-community Path: packages/flowstate-rxdb-client Version: 1.0.8

Use this published Dojo skill as the package-level entrypoint. For detailed workflows, use the package-local skills listed below.

Primary Package Workflow

Collection Contracts

Use this skill when a task touches query shape, accessor methods, errors, update/delete semantics, or dynamic collection access.

Accessor Methods

Every collection wrapper presents:

  • insert(doc)
  • bulkInsert(docs)
  • findOne(query)
  • find(query)
  • update(id, updates)
  • delete(id)
  • findOne$(query) in replication mode only
  • find$(query) in replication mode only
  • getRxCollection() in replication mode only

Query Shape

{
  selector?: Record<string, unknown>
  sort?: Array<Record<string, 'asc' | 'desc'>>
  limit?: number
  skip?: number
}

REST query bodies omit optional fields when unset. Sort directions other than desc are normalized to asc.

Dynamic Typing

IRxDBClient advertises typed collection access but also includes [K: string]: any. Collection properties are assigned at runtime in connect.

Agents should verify:

  1. await client.connect() ran before collection access.
  2. The collection exists in the configured collection map.
  3. The chosen mode supports the called method.

Error Vocabulary

Use package errors for mode and connection failures:

  • ConfigurationError
  • ConnectionError
  • ReplicationError
  • NotSupportedError
  • RxDBClientError

Watch Outs

  • REST findOne returns null for many non-auth query errors.
  • REST find rethrows auth errors and wraps other failures.
  • REST delete can hide auth/server errors behind false.

Package Skill Inventory

Package Skill Inventory: @epicdm/flowstate-rxdb-client

Package path: packages/flowstate-rxdb-client.

Skill Map

SkillTypeTriggerTeachesDojo
flowstate-rxdb-clientorchestratorUse when integrating, changing, testing, or documenting @epicdm/flowstate-rxdb-clientMode selection, routing, public client surfacelocal-only
flowstate-rxdb-client-rest-workflowsworkflowUse when wiring REST clients for CLI, MCP, services, token refresh, CRUD, or aggregate callsRestClient, headers, dynamic accessors, AJV validation, soft delete, aggregateready-after-review
flowstate-rxdb-client-replication-workflowsworkflowUse when building local-first RxDB clients, reactive queries, or sync behaviorReplicationClient, local DB, reactive access, initial sync, partial replicationready-after-review
flowstate-rxdb-client-collection-contractsreferenceUse when checking accessor methods, query shape, update/delete semantics, errors, or dynamic collection accessCollectionAccessor, errors, REST limitations, runtime typingready-after-review
flowstate-rxdb-client-epic-flow-presetworkflowUse when using createEpicFlowClient or epicFlowCollectionsFull FlowState collection preset, subpath import, collection map contractready-after-review
flowstate-rxdb-client-maintenance-and-verificationmaintenanceUse before changing internals, dependency versions, generated docs, feature matrix, or downstream contractsVerification, docs drift, Dojo publication gatelocal-only

Anti-Sprawl Decision

Do not create one skill per exported class, error, or stub. Agents need to choose between REST and replication modes, use collection accessors correctly, and understand the FlowState preset.

Review Gate

Package Skill Review: @epicdm/flowstate-rxdb-client

Package path: packages/flowstate-rxdb-client.

Review Result

Status: drafted, source-backed, verified, pending publication.

The skillset teaches REST and replication workflows, collection contracts, the Epic Flow preset, and package maintenance. It intentionally avoids one skill per symbol.

Checks

  • Source review: completed from client source, wrapper source, package exports, downstream references, and generated artifact drift.
  • Skill inventory: completed.
  • Skill files: completed.
  • ASCII/frontmatter scan: passed.
  • Package tests: passed, 8 suites and 65 tests.
  • Package typecheck: passed.
  • Package lint: passed with 182 existing warnings.
  • Package build: passed through Nx.
  • Generated Dojo replacement: pending.
  • Cloud Dojo publication: pending.

Verification Commands

Run before publication:

yarn workspace @epicdm/flowstate-rxdb-client test --runInBand
yarn workspace @epicdm/flowstate-rxdb-client typecheck
yarn workspace @epicdm/flowstate-rxdb-client lint
yarn nx build @epicdm/flowstate-rxdb-client

Publication Gate

Do not publish existing .flowstate/dojo artifacts until they are rebuilt from reviewed package skills.

Usage

Start with this skill to understand the package purpose, then use the package-local focused skills for specific workflows. Keep this Dojo version aligned with packages/flowstate-rxdb-client/package.json. Do not treat generated feature lists as lessons; use workflow evidence from CODE-REVIEW.md, SKILL-INVENTORY.md, and REVIEW.md.

Install

Run this in your project to install via CLI:

fscloud dojo skill install flowstate-epic-flowstate-community-epicdm-flowstate-rxdb-client --target <target> --out ./skills

Replace <target> with your agent target identifier. See the CLI docs for details.