@choiceapps/communityservices-sdk 0.1.0

package/AGENTS.md

@@ -0,0 +1,43 @@
+# WellSky Community Services SDK agent guide
+
+This guide is for agents integrating or maintaining `@choiceapps/communityservices-sdk` for WellSky Community Services (HMIS), formerly ServicePoint. WellSky is the company, and its other software products are outside this SDK's scope. Legacy ServicePoint names in URLs and GWT classes refer to this same platform. The [documentation index](docs/README.md) is the human entry point. The REST SDK is server-side Node 22+. The ESM-only `browser` export controls Playwright from Node; do not import it into frontend bundles.
+
+## Establish the task before writing
+
+1. Read [capabilities](docs/capabilities.md) to choose the supported path. A generated method proves Swagger coverage, not a successful tenant-specific operation.
+2. Inspect the [API table](API.md) and [helper contracts](docs/reference.md). Preserve exact parameter names such as `clientId`, `client_id`, and `enrollment_id`.
+3. Obtain tenant, connection settings, permitted target IDs, provider, dates, and source keys from the application. Do not infer authorization from an ID, hostname, provider list, or example.
+4. Discover the program's assessment defaults, then its client-scoped questions and picklists. Resolve option codes; do not copy fixture IDs or numeric lookup values.
+5. Use `createClientCreator` for source-ID mapping, `createHouseholds` for membership, and `createCasePlans` for journaled notes/goals/actions. Read [durable records](docs/durable-records.md). Do not guess a lost client receipt from demographics.
+6. Make every assessment field an explicit answer, subassessment operation, carry-forward, or application-approved not-applicable explanation. Metadata does not decide eligibility or complete conditional branching.
+
+The package's examples use synthetic or application-owned inputs. Live verification can create records or mint tokens. Perform it only within the task's authorized tenant and scope; documentation work requires no live writes.
+
+## Preserve these invariants
+
+- REST authentication and UI login are separate. Never extract browser credentials, store cookies, print tokens, or copy `.env` values into reports. The REST client does not load credential files. Browser login reads the selected file.
+- Use the configured tenant consistently for REST, browser sessions, metadata, and durable journals. All configured tenants use identical operations. Reject mismatched REST/UI tenants and cross-tenant navigation.
+- A failed or empty read does not prove absence. An HTTP success does not prove all fields saved. Never retry a raw write because its response was lost.
+- Retain identical intent, source keys, and the durable store when resuming. Do not delete a journal, regenerate a key, remove an unexplained crash lock, or replay a captured RPC to get past a conflict.
+- Reauthentication refreshes the session, not the mutation. Reconcile the original operation. Read [the recovery procedure](docs/troubleshooting.md) for `SESSION_INTERRUPTED` or ambiguous commits.
+- A household enrollment needs a head throughout every member's enrollment. Never promote a later entrant or change the head mid-enrollment. Retroactive correction is a separate workflow and requires the same first entry date. A real mid-enrollment change normally requires closing all enrollments and starting a fresh one.
+- DOB is a strict calendar date through the DOB helper. Enrollment and review dates are explicit instants. Keep mobile effective-date correction separate from DOB encoding and stored verification dates. Read [date contracts](docs/dates-and-answers.md).
+- Every recorded service needs an associated need verified Closed/Fully Met. Use the service recorder for these guarantees and SSVF/UI completion. Generic `bulk` does not provide them.
+- Profile, case-plan, and goal attachments have different entity contexts. Do not promise public visibility or alter sharing based on a profile upload's location.
+- Keep the managed Playwright page dedicated to the helpers. Use fresh UI/GWT models and the shared page lock. Multi-host writers need a shared durable store and locking implementation.
+
+## Find the implementation
+
+Installed packages contain `dist/esm`, `dist/cjs`, `browser`, examples, and documentation. Use [declaration links](docs/reference.md) to inspect exact types. Internal file paths are not additional supported import entry points.
+
+In a source checkout, runtime logic is in `src`, generated REST contracts are in `src/generated`, and browser helpers are in `browser`. `specs` pins Swagger/provenance/overrides. Tests are in `test`. Run SDK commands in `packages/wellsky-sdk`. The repository contains only the SDK and its supporting documentation and tests.
+
+In the SDK source checkout, follow the enclosing repository's AGENTS.md, including its GitNexus impact checks before modifying symbols. In an application consuming the installed package, follow that application's repository instructions; this package does not install a GitNexus index or its tools. Do not hand-edit generated files or API.md; use `npm run generate` in the SDK checkout after an intentional contract change. Preserve unrelated workspace changes. Documented sandbox findings are dated evidence, not instructions to replay fixture setup or override current source contracts.
+
+## Verify and report
+
+For a source change, run the relevant tests, then `npm run package:check`. Documentation changes must pass `npm run docs:check`; the package check also validates shipped links and examples. Set `WELLSKY_TEST_CHROME` to an installed executable for full local browser fixtures. Tests can skip those fixtures when Chrome is unavailable; report skips rather than claiming full browser proof.
+
+For a live task, verify actual saved values through the appropriate REST and UI/GWT reads. Record original IDs, same-key retry results, and mutation counts. Do not claim production or live verification from fake tests alone. Keep private evidence outside the package.
+
+When finishing, state what changed, what passed, and what remains unverified. Do not claim that a workflow is atomic, that a journal prevents external writers from racing, or that the server supplies an idempotency key.

package/API.md

@@ -0,0 +1,86 @@
+# API coverage
+
+Generated from the pinned WellSky V2 and V3 Swagger documents. Every operation has a named method and a typed `client.request("METHOD /path", options)` equivalent.
+
+Both versions have the methods below. Import from `@choiceapps/communityservices-sdk/v2` or `@choiceapps/communityservices-sdk/v3` to select the matching request and response models.
+
+| Method | HTTP | Path | Pagination |
+| --- | --- | --- | --- |
+| `apiToApiAuthentication.createAuthKey` | POST | `/apitoapiauthentication/CreateAuthKey` |  |
+| `assessments.get` | GET | `/assessments/{clientId}/{assessmentCode}` |  |
+| `assessments.create` | POST | `/assessments/create/{clientId}/{assessmentCode}` |  |
+| `assessmentsMobile.getAnswers` | GET | `/assessmentsmobile/GetAssessmentAnswers/{clientId}/{assessmentCode}` |  |
+| `assessmentsMobile.addAnswer` | POST | `/assessmentsmobile/AddAssessmentAnswer/{clientId}/{assessmentCode}` |  |
+| `authentication.setAuthKey` | POST | `/authentication/SetAuthKey` |  |
+| `authentication.getCurrentAuthKey` | POST | `/authentication/GetCurrentAuthKey` |  |
+| `authentication.getCurrentAuthKeyList` | GET | `/authentication/GetCurrentAuthKeyList` |  |
+| `calls.list` | GET | `/calls` | Yes |
+| `caseManagers.list` | GET | `/casemanager` | Yes |
+| `caseManagers.listForClient` | GET | `/casemanager/{clientId}` | Yes |
+| `clientAuthentication.registerClient` | POST | `/clientAuthentication/RegisterClient` |  |
+| `clientAuthentication.getMobileInformation` | GET | `/clientAuthentication/MobileAuthenticationInformation` |  |
+| `clientAuthentication.updateClientDetails` | PUT | `/clientAuthentication/UpdateClientDetails` |  |
+| `clientAuthentication.getMobileAuthKey` | POST | `/clientAuthentication/GetAuthKeyFormobileapp` |  |
+| `clientAuthentication.resetPassword` | POST | `/clientAuthentication/ResetPassword` |  |
+| `clientAuthentication.changePassword` | PUT | `/clientAuthentication/ChangePassword` |  |
+| `clientAuthentication.getMobileMasterData` | GET | `/clientAuthentication/MobileMasterDataInformation` |  |
+| `clientAuthentication.saveUserDetails` | PUT | `/clientAuthentication/SaveUserDetails` |  |
+| `clientAuthentication.generateTokenUsingOldToken` | POST | `/clientAuthentication/GenerateTokenUsingOldToken` |  |
+| `clientNotes.list` | GET | `/clientnotes` | Yes |
+| `clientNotes.create` | POST | `/clientnotes/create` |  |
+| `clientNotes.update` | PUT | `/clientnotes/update` |  |
+| `clients.list` | GET | `/clients` | Yes |
+| `clients.get` | GET | `/clients/{clientId}` |  |
+| `clients.listSimplified` | GET | `/clients/simplified` | Yes |
+| `clients.getSimplified` | GET | `/clients/simplified/{clientId}` |  |
+| `clients.create` | POST | `/clients/create` |  |
+| `clients.update` | PUT | `/clients/update/{client_id}` |  |
+| `enrollments.createEntryAssessment` | POST | `/enrollments/entry/assessment/create` |  |
+| `enrollments.updateEntryAssessment` | PUT | `/enrollments/entry/assessment/update` |  |
+| `enrollments.list` | GET | `/enrollments` | Yes |
+| `enrollments.listForClient` | GET | `/enrollments/{clientId}` | Yes |
+| `enrollments.getComplete` | GET | `/enrollments/complete/{enrollmentId}` | Yes |
+| `enrollments.getAssessment` | GET | `/enrollments/assessment/{clientId}/{assessmentCode}` |  |
+| `fileAttachments.getForClient` | POST | `/fileattachments/clients/get` |  |
+| `fileAttachments.createForClient` | POST | `/fileattachments/clients/create` |  |
+| `goals.list` | GET | `/goals` | Yes |
+| `goals.listForClient` | GET | `/goals/client/{clientId}` | Yes |
+| `goals.get` | GET | `/goals/{goalId}` | Yes |
+| `goals.create` | POST | `/goals/create` |  |
+| `goals.update` | PUT | `/goals/update/{goalId}` |  |
+| `goals.createAction` | POST | `/goals/actions/create/{goalId}` |  |
+| `goals.updateAction` | PUT | `/goals/actions/update/{goalActionStepId}` |  |
+| `healthCheck.get` | GET | `/healthcheckup` |  |
+| `households.list` | GET | `/households` | Yes |
+| `households.get` | GET | `/households/{householdId}` | Yes |
+| `households.listForClient` | GET | `/households/client/{clientId}` | Yes |
+| `households.create` | POST | `/households/create` |  |
+| `households.update` | PUT | `/households/update/{householdId}` |  |
+| `needs.list` | GET | `/needs` | Yes |
+| `needs.listForClient` | GET | `/needs/{clientId}` | Yes |
+| `needs.listForCall` | GET | `/needs/call/{callRecordId}` | Yes |
+| `needs.getComplete` | GET | `/needs/complete/{needId}` |  |
+| `providers.list` | GET | `/providers` | Yes |
+| `providers.get` | GET | `/providers/{providerId}` |  |
+| `providers.getComplete` | GET | `/providers/complete/{providerId}` |  |
+| `referrals.list` | GET | `/referrals` | Yes |
+| `referrals.listForClient` | GET | `/referrals/client/{clientId}` | Yes |
+| `referrals.listForCall` | GET | `/referrals/call/{callRecordId}` | Yes |
+| `referrals.get` | GET | `/referrals/{referralId}` |  |
+| `referrals.create` | POST | `/referrals/create` |  |
+| `referrals.update` | PUT | `/referrals/update/{referral_id}` |  |
+| `releasesOfInformation.list` | GET | `/releasesofinformation` | Yes |
+| `services.updateHouseholdNeeds` | PUT | `/services/needs/household/update/{serviceId}` |  |
+| `services.list` | GET | `/services` | Yes |
+| `services.listForClient` | GET | `/services/{clientId}` | Yes |
+| `services.listForCall` | GET | `/services/call/{callRecordId}` | Yes |
+| `services.getComplete` | GET | `/services/complete/{serviceId}` |  |
+| `services.create` | POST | `/services/create` |  |
+| `services.update` | PUT | `/services/update/{serviceId}` |  |
+| `services.createHousehold` | POST | `/services/household/create` |  |
+| `services.updateHousehold` | PUT | `/services/household/update/{serviceId}` |  |
+| `tenants.list` | GET | `/tenants/GetCurrentTenants` |  |
+| `tenants.create` | POST | `/tenants/AddTenantRecord` |  |
+| `tenants.update` | PUT | `/tenants/UpdateTenantRecord` |  |
+| `tenants.updateByCode` | PUT | `/tenants/UpdateTenantRecord/{tenant_code}` |  |
+| `tenants.delete` | DELETE | `/tenants/DeleteTenantRecord` |  |

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 0.1.0 - 2026-10-28
+
+Initial development release of `@choiceapps/communityservices-sdk`.
+
+- Typed REST V2 and V3 clients with authentication, metadata, pagination, retry controls, and synthetic testing utilities.
+- Browser sessions and GWT adapters configured by tenant and module URL. All configured tenants use the same operations.
+- Enrollment, household, client profile, date of birth, case plan, attachment, service, independent need, shelter, inventory, and Current Living Situation workflows.
+- Durable mutation journals, read-back verification, tenant consistency checks, and interrupted-session recovery.
+- Neutral public helper and type names, without tenant-specific aliases or environment classification options.
+- Shipped examples, documentation, and installed-package regression checks.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,11 @@
+Community Services SDK
+Copyright 2026 Choice Technology Solutions, LLC
+
+This SDK is licensed under the Apache License, Version 2.0.
+
+The pinned API descriptions originate from WellSky Community Services.
+Their source URLs and hashes are recorded in specs/provenance.json within
+the SDK package. The SDK license does not grant rights to WellSky services,
+trademarks, or separately owned third-party materials.
+
+This is an independent integration and has no WellSky endorsement.

package/README.md

@@ -0,0 +1,100 @@
+# WellSky Community Services SDK
+
+`@choiceapps/communityservices-sdk` is a server-side TypeScript SDK for **WellSky Community Services (HMIS), formerly ServicePoint**. It provides typed Client API V2/V3 requests and workflow helpers for clients, households, assessments, enrollments, services, shelter stays, and contacts.
+
+**Start with [Using the SDK](docs/using-the-sdk.md)** for installation, credentials, a complete REST read, a browser session, and guidance on durable writes. The [documentation index](docs/README.md) links to the detailed task guides.
+
+## Requirements
+
+- Node 22 or newer.
+- Credentials for your Community Services tenant when connecting to WellSky.
+- For browser workflows: `playwright-core` and an installed Chrome/Chromium executable. These helpers run in Node, not in a frontend bundle.
+
+REST imports support ESM and CommonJS. The optional `/browser` export is ESM-only. All tenants use the same methods; your tenant and connection settings select the system.
+
+## Install
+
+```sh
+npm install @choiceapps/communityservices-sdk
+```
+
+The public package uses the default npm registry. No registry token is needed to install it.
+
+### Install from GitLab
+
+Add this to your application's `.npmrc`:
+
+```ini
+@choiceapps:registry=https://gitlab.home.nmbgeek.com/api/v4/projects/48/packages/npm/
+//gitlab.home.nmbgeek.com/api/v4/projects/48/packages/npm/:_authToken=${GITLAB_NPM_TOKEN}
+```
+
+Supply a GitLab token with package-read access through `GITLAB_NPM_TOKEN`, then install:
+
+```sh
+npm install @choiceapps/communityservices-sdk
+```
+
+Keep token values out of version control. The GitLab token installs the package; your REST and browser credentials authenticate to Community Services separately.
+
+## Run an offline example
+
+```sh
+node node_modules/@choiceapps/communityservices-sdk/examples/quickstart.mjs
+```
+
+It prints `Read synthetic client 123; no network requests.` and uses the real SDK transport with synthetic responses. No HMIS account is needed for this example. See the [source and explanation](docs/getting-started.md).
+
+## Make your first API call
+
+This fragment assumes your application supplies `tenant`, REST `username` and `password`, and an authorized `clientId`:
+
+```js
+import {WellSkyClient, toItems} from '@choiceapps/communityservices-sdk';
+
+const api = new WellSkyClient({
+  tenant,
+  auth: {kind: 'credentials', username, password},
+});
+const people = toItems(await api.clients.get({path: {clientId}}));
+```
+
+The root export uses V3; use `/v2` or `/v3` to choose explicitly. Responses preserve the server's shape, and `toItems()` extracts supported collection formats. See [the complete runnable read](docs/using-the-sdk.md#4-read-an-existing-client), [configuration](docs/configuration.md), and [all HTTP operations](API.md).
+
+## Choose a workflow
+
+| Work | Documentation |
+| --- | --- |
+| Authentication, reads, pagination, and bulk calls | [REST client](docs/rest-client.md) |
+| Client creation, households, notes, goals, and actions | [Durable records](docs/durable-records.md) |
+| Program metadata, questions, and picklist answers | [Assessments](docs/assessments.md) |
+| Enrollment, interim reviews, household changes, and exits | [Enrollments](docs/enrollments.md) |
+| Profile fields and date of birth | [Profiles](docs/profiles.md) |
+| Services, SSVF details, and Funding Sources | [Services](docs/services.md), [SSVF rules](SSVF.md) |
+| Needs without service delivery | [Independent needs](docs/independent-needs.md) |
+| Shelter check-in/check-out and bed availability | [Shelters](docs/shelters.md), [inventory](docs/shelter-inventory.md) |
+| Outreach and shelter contact events | [Current Living Situation](docs/current-living-situation.md) |
+| Attachments and goal case notes | [Files and notes](docs/files-and-notes.md) |
+
+For UI-backed operations, see [browser sessions](docs/browser-session.md). Use stable event keys and a persistent journal for workflow writes. After an error, reconcile the original operation before submitting again; a lost response does not prove rollback. [Troubleshooting](docs/troubleshooting.md) explains recovery.
+
+## Examples and reference
+
+- [Integration methods](docs/integration-methods.md) explains why workflows combine REST, GWT-RPC, browser forms, and multipart uploads.
+- [WellSky feedback](docs/vendor-issues/README.md) preserves reproduced issues, contract questions, and API coverage requests.
+
+- [Packaged examples](examples/README.md) cover individual and household workflows and compile against the public SDK.
+- [Helper reference](docs/reference.md) indexes public exports and type declarations.
+- [Capabilities](docs/capabilities.md) records supported behavior and findings reproduced in a sandbox tenant.
+- [Dates and answers](docs/dates-and-answers.md) explains calendar dates and effective timestamps.
+- [Development guide](docs/development.md) covers building, tests, and releases.
+- [Agent guide](AGENTS.md) documents integration rules for coding assistants.
+- [Changelog](CHANGELOG.md) records versioned changes.
+
+This is an independent integration and has no WellSky endorsement.
+
+## License and source
+
+Copyright 2026 Choice Technology Solutions, LLC. Licensed under [Apache-2.0](LICENSE); see [NOTICE](NOTICE) for attribution.
+
+[GitLab](https://gitlab.home.nmbgeek.com/nmbgeek/communityservices-sdk) is the source of truth. The [public GitHub mirror](https://github.com/nmbgeek/communityservices-sdk) receives branches and tags from GitLab and runs npm trusted publishing. Make repository changes in GitLab.

package/SSVF.md

@@ -0,0 +1,131 @@
+# SSVF service fields
+
+The browser SDK exposes `getSsvfServiceRules()` for application forms and validates these rules in `record` and `recordBulk` before reserving a journal entry or writing records. This is a verified snapshot of a service form reproduced in a sandbox tenant under an SSVF RRH provider on October 23, 2026. It is not a live provider configuration query or a statement of reporting requirements. The low-level REST client retains the supplied Swagger contract.
+
+```js
+import {getSsvfServiceRules} from '@choiceapps/communityservices-sdk/browser';
+const rules = getSsvfServiceRules({
+  typeOfSsvfService: 'Assistance obtaining VA benefits',
+});
+const visibleFields = rules.fields.filter(field => field.visible);
+// Each field includes key, label, control, required, transport and any options/maxLength.
+```
+
+Use `rules.serviceTypes` and `rules.financialAssistanceTypes` for choices. Omit unselected values instead of sending `-Select-`, null, or an empty string. When a user changes the service type, clear answers for the previous type. The recorder rejects inactive dependent fields rather than silently dropping them. Rules are returned as copies.
+
+## Service types and dependencies
+
+The service type and all four dependent fields are optional in the inspected UI. Blank values passed client-side validation with save requests intercepted before reaching the server. The Other text box has a 100-character limit. No selection within the three dependent picklists revealed another field.
+
+| Type of SSVF Service | Dependent SDK field | Control | UI required |
+| --- | --- | --- | --- |
+| Outreach services | None | None | No |
+| Case management services | None | None | No |
+| Assistance obtaining VA benefits | `ifObtainingVaAssistanceBenefits` | Picklist | No |
+| Assistance obtaining/coordinating other public benefits | `ifObtainingCoordinatingOtherPublicBenefits` | Picklist | No |
+| Direct provision of other public benefits | `ifDirectProvisionOfOtherPublicBenefits` | Picklist | No |
+| Other (non-TFA) supportive service approved by VA | `ifOtherNonTfaSupportiveServiceApprovedByVa` | Text, maximum 100 characters | No |
+| Shallow Subsidy | None | None | No |
+| Returning Home | None | None | No |
+| Rapid Resolution | None | None | No |
+| Healthcare Navigation | None | None | No |
+
+### Assistance obtaining VA benefits
+
+UI label: If "Assistance obtaining VA benefits". REST field: `ssvfInformation.ifObtainingVaAssistanceBenefits`.
+
+- VA vocational and rehabilitation counseling
+- Employment and training services
+- Educational assistance
+- Health care services
+
+### Assistance obtaining/coordinating other public benefits
+
+UI label: If "Assistance obtaining/coordinating other public benefits". REST field: `ssvfInformation.ifObtainingCoordinatingOtherPublicBenefits`.
+
+- Health care services
+- Daily living services
+- Personal financial planning services
+- Transportation services
+- Income support services
+- Fiduciary and representative payee services
+- Legal services - child support
+- Legal services - eviction prevention
+- Legal services - outstanding fines and penalties
+- Legal services - restore/acquire driver's license
+- Legal services - other
+- Child care
+- Housing counseling
+
+### Direct provision of other public benefits
+
+UI label: If "Direct provision of other public benefits". REST field: `ssvfInformation.ifDirectProvisionOfOtherPublicBenefits`.
+
+- Personal financial planning services
+- Transportation services
+- Income support services
+- Fiduciary and representative payee services
+- Legal services - child support
+- Legal services - eviction prevention
+- Legal services - outstanding fines and penalties
+- Legal services - restore/acquire driver's license
+- Legal services - other
+- Child care
+- Housing counseling
+
+### Other (non-TFA) supportive service approved by VA
+
+UI label: If "Other(Non-TFA) Supportive Service approved by VA". REST field: `ssvfInformation.ifOtherNonTfaSupportiveServiceApprovedByVa`.
+
+Free text. The SDK permits 1 to 100 characters when supplied; omit the field to leave it unanswered.
+
+## Financial assistance
+
+Financial assistance is independent of Type of SSVF Service. The same list remains available for all 10 service types. Shallow Subsidy does not automatically select a financial-assistance type. Type, amount, and both dates must be handled separately.
+
+`ssvfFinancialAssistanceType` has these choices:
+
+- Rental assistance
+- Utility fee payment assistance
+- Security deposit
+- Utility deposit
+- Moving costs
+- Transportation services: tokens/vouchers
+- Transportation services: vehicle repair/maintenance
+- Child Care
+- General housing stability assistance
+- Emergency housing assistance
+- Shallow subsidy financial assistance
+- Food assistance
+- Landlord incentive
+- Tenant incentive
+
+Selecting any of these 14 choices reveals and requires both SSVF Financial Assistance Start Date and SSVF Financial Assistance End Date. Blank dates triggered the UI's required-field validation for every choice, before any request to save. Leaving the financial type unselected hides the dates and removes their required markers.
+
+Pass those dates as `financialAssistancePeriod: {start, end}` using timezone-qualified timestamps. The recorder requires both, enforces their order, and rejects a period without a financial-assistance type. Swagger has no properties for these dates; the UI adapter fills them and verifies stored readback.
+
+`ssvfFinancialAssistanceAmount` is visible and not marked required in the inspected UI. It can be omitted for nonfinancial services. If supplied, the SDK accepts a finite nonnegative amount with at most two decimal places, up to 1,000,000,000. Funding Sources are separate allocations and retain their existing validation.
+
+## Recording a nonfinancial service
+
+```js
+await recorder.record({
+  key: 'source-system-stable-service-id',
+  body: {
+    clientId, serviceProvider,
+    serviceCode: 'BH-3800.7000', // Use the taxonomy appropriate to your service.
+    serviceStartDate: '2026-10-23T12:00:00-04:00',
+    serviceEndDate: '2026-10-23T12:00:00-04:00',
+    ssvfInformation: {
+      typeOfSsvfService: 'Assistance obtaining VA benefits',
+      ifObtainingVaAssistanceBenefits: 'Educational assistance',
+    },
+  },
+});
+```
+
+The four conditional values are supported by REST and are verified against both the REST readback and the visible UI control. No GWT workaround is needed for those values. The UI adapter still completes the associated need as Closed / Fully Met and handles financial dates and Funding Sources where supplied. Keep the same key, inputs, and durable journal for retries. Bulk input validates all rows first and stops after an uncertain write.
+
+`SsvfInformation` uses the service type as a discriminant, so TypeScript rejects a dependent field belonging to another branch and invalid picklist literals. `ServiceUiSnapshot.ssvfInformation` includes visible, nonblank values for verification. Hidden controls do not count as proof of stored answers.
+
+The hidden Moving On controls did not appear for any of the 10 currently offered service types. They are not exposed as supported SSVF inputs. Other tenants, providers, and future WellSky releases need their own UI verification before extending these rules.

package/browser/attachment-conflict.mjs

@@ -0,0 +1,6 @@
+/** A verified local/readback conflict cannot be resolved by logging in again. */
+export class AttachmentConflictError extends Error {
+ constructor(reason,message){
+  super(message);this.name='AttachmentConflictError';this.code='ATTACHMENT_CONFLICT';this.reason=reason;
+ }
+}

package/browser/case-plans-ui.mjs

@@ -0,0 +1,23 @@
+import {pageConnection} from './connection.mjs';
+import {withPageLock} from './page-lock.mjs';
+import {decodeMappedResponse} from './gwt-mapped.mjs';
+/** Fresh counted reads back the UI's initial empty notes/goals state. No writes or cached RPCs. */
+export function createCasePlanUi({page}){
+ const connection=pageConnection(page),base=connection.moduleBaseUrl;
+ const confirmEmpty=({kind,clientId})=>withPageLock(page,async()=>{
+  if(!['note','goal'].includes(kind)||!Number.isSafeInteger(clientId)||clientId<1||new URL(page.url()).origin+new URL(page.url()).pathname!==base+'index.html')throw Error('Client and record kind required');
+  if(await page.locator('[role=dialog]:visible').count())throw Error('Close dialogs before case-plan workflow');
+  const ready=()=>page.waitForFunction(()=>!document.body.innerText.includes('Processing...')&&!document.body.innerText.includes('Loading...'),null,{timeout:30000});
+  if(/Client - \(\d+\)/.test(await page.locator('body').innerText())){await page.getByRole('tab',{name:'Client Information',exact:true}).click();await page.getByRole('tab',{name:'Summary',exact:true}).click();await ready();await page.getByRole('button',{name:'Exit',exact:true}).click();await page.waitForURL(u=>u.hash==='#clientPointClientMain');}
+  let wire,pending;const listener=r=>{const b=r.postData()??'';if(r.url()===base+'service/MetaQueryService'&&b.includes('|getMappedResults|'))pending=r.allHeaders().then(h=>{wire={policy:b.split('|')[4],headers:Object.fromEntries(['content-type','x-gwt-module-base','x-gwt-permutation'].map(k=>[k,h[k]]))};});};page.on('request',listener);
+  try{
+   await page.goto(base+'index.html#loadClient;clientId='+clientId);await page.waitForFunction(id=>document.body.innerText.includes(`Client - (${id})`)&&!document.body.innerText.includes('Processing...'),clientId);
+   await page.getByRole('tab',{name:kind==='note'?'Client Profile':'Case Plans',exact:true}).click();await ready();await pending;if(!wire)throw Error('Fresh UI read context unavailable');
+  }finally{page.off('request',listener);}
+  const query=kind==='note'?`SELECT n.clientNoteId AS id FROM SpClientNote AS n WHERE n.active = true AND n.clientId = ${clientId}`:`SELECT g.goalId AS id FROM SpGoal AS g WHERE g.active = true AND g.clientId = ${clientId}`;
+  const strings=[base,wire.policy,'com.bowmansystems.sp5.core.client.services.GenericService','getMappedResults','java.lang.String/2004016611','java.util.HashMap/1797211028','I','Z',query+' LIMIT 1,0'];
+  const body=['7','0',strings.length,...strings,1,2,3,4,5,5,6,7,7,8,9,0,0,1,1,''].join('|');
+  const r=await page.evaluate(async({url,headers,body})=>{const r=await fetch(url,{method:'POST',headers,body,credentials:'same-origin',redirect:'error',signal:AbortSignal.timeout(30000)});return {status:r.status,body:await r.text()};},{url:base+'service/MetaQueryService',headers:wire.headers,body});
+  if(r.status!==200)throw Error('UI record read failed');const result=decodeMappedResponse(r.body);return result.total===0&&result.rows.length===0;
+ });return {connection,confirmEmpty};
+}