@choiceapps/communityservices-sdk 0.1.0

package/examples/shelters.mts

@@ -0,0 +1,33 @@
+import type {WellSkyClient, GwtEnrollmentHelpers} from '@choiceapps/communityservices-sdk';
+import {
+  createShelters, readShelterProgram,
+  type ShelterUiPort, type UiMutationStore,
+  type ShelterCheckInInput, type ShelterCheckoutInput,
+} from '@choiceapps/communityservices-sdk/browser';
+
+/** Pass createShelterUi({page: session.page}) from a managed browser session.
+ * Prepare program-required assessment answers explicitly before check-in/checkout.
+ * Keep this store and the same source keys when reconciling an interrupted operation.
+ */
+export function shelterWorkflow(api:WellSkyClient, ui:ShelterUiPort, store:UiMutationStore,
+  enrollmentHelpers:Pick<GwtEnrollmentHelpers,'addHouseholdMembers'>) {
+  return createShelters({api,ui,store,enrollmentHelpers});
+}
+
+export async function checkInHousehold(
+  workflow:ReturnType<typeof shelterWorkflow>, input:ShelterCheckInInput,
+) {
+  // Require existing same-program enrollment unless the application explicitly
+  // selects create-if-missing for night-by-night. Named beds must be available.
+  return workflow.checkIn(input);
+}
+
+export async function checkOutHousehold(
+  workflow:ReturnType<typeof shelterWorkflow>, input:ShelterCheckoutInput,
+) {
+  // lastNight is established by the application. checkoutDate must fall on the
+  // following calendar day in timeZone. Nightly checkout leaves enrollment open.
+  return workflow.checkout(input);
+}
+
+export const discoverShelterMode = readShelterProgram;

package/examples/usage.ts

@@ -0,0 +1,23 @@
+import { WellSkyClient, toItems, type ClientOptions, type ServiceAddViewModel } from "@choiceapps/communityservices-sdk";
+import { WellSkyClient as WellSkyV2 } from "@choiceapps/communityservices-sdk/v2";
+
+// These functions do not run on import. Pass credentials from your server's secret store.
+export async function findClient(options: ClientOptions, clientId: number) {
+  const client = new WellSkyClient(options);
+  return toItems(await client.clients.get({ path: { clientId } }));
+}
+
+export async function readClients(options: ClientOptions, consume: (clientId: number) => Promise<void>) {
+  const client = new WellSkyClient(options);
+  for await (const person of client.paginate("GET /clients", { query: { perPage: 30 }, maxPages: 100 })) {
+    if (person.clientId !== undefined) await consume(person.clientId);
+  }
+}
+
+export async function createService(options: ClientOptions, body: ServiceAddViewModel) {
+  return toItems(await new WellSkyClient(options).services.create({ body }));
+}
+
+export async function findClientV2(options: ClientOptions, clientId: number) {
+  return toItems(await new WellSkyV2(options).clients.get({ path: { clientId } }));
+}

package/examples/verification-snapshot.ts

@@ -0,0 +1,9 @@
+import {readEnrollmentVerifications, type WellSkyClient} from '@choiceapps/communityservices-sdk';
+
+/** Supply the enrollment's actual instant and a permitted assessment code. No writes. */
+export function verificationSnapshot(
+	api:WellSkyClient,
+	request:Parameters<typeof readEnrollmentVerifications>[1],
+) {
+	return readEnrollmentVerifications(api, request);
+}

package/llms.txt

@@ -0,0 +1,26 @@
+# WellSky Community Services SDK
+
+> Server-side TypeScript SDK for WellSky Community Services (HMIS), formerly ServicePoint, using Client API V2/V3 and optional tenant-configured Playwright/GWT workflows.
+
+- [Agent guide](AGENTS.md): integration invariants, source navigation, verification.
+- [Documentation index](docs/README.md): task-oriented navigation.
+- [Using the SDK](docs/using-the-sdk.md): installation, credentials, REST and browser reads, durable workflows, and recovery.
+- [Quickstart](docs/getting-started.md): executable offline read.
+- [Capabilities](docs/capabilities.md): REST coverage versus verified workflows and limitations.
+- [Integration methods](docs/integration-methods.md): why each workflow uses REST, GWT-RPC, browser forms, or multipart and how retries preserve intent.
+- [WellSky feedback](docs/vendor-issues/README.md): reproduced failures, contract questions, and public API coverage requests; submission status is not assumed.
+- [Configuration](docs/configuration.md): authentication, tenant connection settings, request defaults.
+- [HTTP operations](API.md): generated named methods.
+- [Helper reference](docs/reference.md): runtime exports and declaration contracts.
+- [Assessments](docs/assessments.md): questions, picklists, encoding, verification records.
+- [Dates](docs/dates-and-answers.md): DOB, effective timestamps, intervals.
+- [Browser sessions](docs/browser-session.md): login, password recovery, GWT adapters.
+- [Enrollments](docs/enrollments.md): entry, household members, interim, exit.
+- [Durable records](docs/durable-records.md): client source identity, household membership, case plans, source-key notes, structured recovery.
+- [Examples](examples/README.md): shipped files and installed-package test coverage.
+- [Profiles](docs/profiles.md): Client Record, Sex, DOB.
+- [Services](docs/services.md): Closed/Fully Met needs, bulk input, Funding Sources.
+- [SSVF fields](SSVF.md): conditional field choices and requirements.
+- [Files and notes](docs/files-and-notes.md): attachment locations, goal case notes.
+- [Recovery](docs/troubleshooting.md): ambiguous writes and session expiry.
+- [Development](docs/development.md): source checks and releases.

package/package.json

@@ -0,0 +1,103 @@
+{
+  "name": "@choiceapps/communityservices-sdk",
+  "version": "0.1.0",
+  "description": "SDK for WellSky Community Services (HMIS), formerly ServicePoint, Client API V2 and V3",
+  "type": "module",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    },
+    "./v2": {
+      "import": {
+        "types": "./dist/esm/v2.d.ts",
+        "default": "./dist/esm/v2.js"
+      },
+      "require": {
+        "types": "./dist/cjs/v2.d.ts",
+        "default": "./dist/cjs/v2.js"
+      }
+    },
+    "./v3": {
+      "import": {
+        "types": "./dist/esm/v3.d.ts",
+        "default": "./dist/esm/v3.js"
+      },
+      "require": {
+        "types": "./dist/cjs/v3.d.ts",
+        "default": "./dist/cjs/v3.js"
+      }
+    },
+    "./testing": {
+      "import": {
+        "types": "./dist/esm/testing.d.ts",
+        "default": "./dist/esm/testing.js"
+      },
+      "require": {
+        "types": "./dist/cjs/testing.d.ts",
+        "default": "./dist/cjs/testing.js"
+      }
+    },
+    "./browser": {
+      "types": "./browser/index.d.mts",
+      "import": "./browser/index.mjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "API.md",
+    "SSVF.md",
+    "CHANGELOG.md",
+    "specs/provenance.json",
+    "browser",
+    "docs",
+    "examples",
+    "AGENTS.md",
+    "llms.txt",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "generate": "node scripts/generate.mjs",
+    "generate:check": "node scripts/generate.mjs --check",
+    "specs:check": "node scripts/check-specs.mjs",
+    "build": "node scripts/build.mjs",
+    "test": "npm run generate:check && npm run build && node scripts/check-docs.mjs && tsc -p test/tsconfig.json && node --test --test-concurrency=2 test/*.test.mjs",
+    "package:check": "npm test && node scripts/verify-package.mjs",
+    "prepack": "npm test",
+    "docs:check": "npm run build && node scripts/check-docs.mjs"
+  },
+  "devDependencies": {
+    "playwright-core": "^1.56.1",
+    "typescript": "5.9.3"
+  },
+  "peerDependencies": {
+    "playwright-core": ">=1.56.1 <2"
+  },
+  "peerDependenciesMeta": {
+    "playwright-core": {
+      "optional": true
+    }
+  },
+  "license": "Apache-2.0",
+  "author": "Choice Technology Solutions, LLC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nmbgeek/communityservices-sdk.git",
+    "directory": "packages/wellsky-sdk"
+  }
+}

package/specs/provenance.json

@@ -0,0 +1,17 @@
+{
+  "retrievedOn": "2026-10-22",
+  "sources": {
+    "v2": {
+      "url": "https://csclientapi.wellsky.com/client-api-prod/swagger/v2/swagger.json",
+      "sha256": "b66863462f3336a9f7032d259cdde978a9c5d91e0daa6a7012bfc739651bf638",
+      "operations": 78,
+      "schemas": 124
+    },
+    "v3": {
+      "url": "https://csclientapi.wellsky.com/client-api-prod/swagger/v3/swagger.json",
+      "sha256": "91e0175899573b137af27fb88a89c565a22caa3792163a7b6f6a4628a4f4cf04",
+      "operations": 78,
+      "schemas": 122
+    }
+  }
+}