@shuffl/sdk 0.1.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +5 -5
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Shuffl TypeScript SDK
2
2
 
3
- Use the Shuffl workspace API from Node.js 22+, Bun, or an agent runtime.
3
+ Use the Shuffl team API from Node.js 22+, Bun, or an agent runtime.
4
4
 
5
5
  ```sh
6
6
  npm install @shuffl/sdk
@@ -8,7 +8,7 @@ npm install @shuffl/sdk
8
8
 
9
9
  The package is ESM-only and ships its own types. It installs `@shuffl/api-contracts`, which carries the input and output types for every method. The SDK, [CLI](https://www.npmjs.com/package/@shuffl/cli) and contracts are released together under one version.
10
10
 
11
- Create an API key in **Settings → API keys**. The key is bound to one workspace and the issuing user's current permissions, and expires within 30 days. There is one kind of API key: the same key works for the SDK, CLI, HTTP API and, when it carries the `mcp.knowledge` permission, the MCP server.
11
+ Create an API key in **Settings → API keys**. The key is bound to one team and the issuing user's current permissions, and expires within 30 days. There is one kind of API key: the same key works for the SDK, CLI, HTTP API and, when it carries the `mcp.knowledge` permission, the MCP server.
12
12
 
13
13
  Choose exact endpoint permissions such as `users.list` and `units.save`, grouped by resource and Read/Write. Discover them with `shuffl.permissions.list()`. A write grant does not imply reads or sibling operations. See [endpoint permissions and delegation](https://shuffl-rebuild.vercel.app/docs/api-permissions).
14
14
 
@@ -31,9 +31,9 @@ const preview = await shuffl.programs.preview({
31
31
  });
32
32
  ```
33
33
 
34
- `users` means people in the workspace directory, including people who have no web login. IDs are Shuffl person IDs, not Slack IDs or authentication account IDs.
34
+ `users` means people in the team directory, including people who have no web login. IDs are Shuffl person IDs, not Slack IDs or authentication account IDs.
35
35
 
36
- The client includes people, teams, access, identity links, programs, runs, knowledge, invitations, provisioning, HR, support, billing, reports, exports, credentials and assistant conversations. See the [permission reference](https://shuffl-rebuild.vercel.app/docs/api-permissions) for every method. Input and output types come directly from the portable public oRPC contract.
36
+ The client includes people and their profiles, teams and departments, access, identity links, programs and runs, Knowledge, invitations, People sync, onboarding and first 90 days check-ins, celebrations, Pulse, Praise, badges, communities, reminders, Home, the HR digest, HR requests, support, reports, exports, credentials and assistant conversations. Company settings and billing are not in the API: a team key never gains company scope. See the [permission reference](https://shuffl-rebuild.vercel.app/docs/api-permissions) for every method. Input and output types come directly from the portable public oRPC contract.
37
37
 
38
38
  Program creation requires a stable `requestKey`. Repeating the same creation request returns the existing program; using that key with different settings returns `CONFLICT`. Programs start paused unless `draft: false` is explicitly supplied. Updates require `expectedRevision`. Run requests require a preview and request key and return a durable run ID; poll `runs.get` for status. The application scheduler owns execution and delivery.
39
39
 
@@ -58,6 +58,6 @@ const teams = await shuffl.units.list({}); // Same persisted teams the web app r
58
58
 
59
59
  Management writes return `{receipt, result}`. A duplicate request returns the same receipt with `result: null`; it never replays an action or a private result. Reusing a key with changed input fails. Read the resource after replay and reconcile an `unknown` receipt before issuing a new command. Sensitive actions require `confirm` equal to the method name (for example `knowledge.sources.publish`). Initial program/run methods retain the shapes described above.
60
60
 
61
- Credentials with `credentials:write` can delegate only their own scopes, with bounded expiry and inherited revocation. Account sign-in, switching to another workspace, provider consent and payment confirmation remain explicit browser/account flows.
61
+ Credentials with `credentials:write` can delegate only their own scopes, with bounded expiry and inherited revocation. Account sign-in, switching to another team, provider consent and payment confirmation remain explicit browser/account flows.
62
62
 
63
63
  Full guide: [Use the SDK and HTTP API](https://shuffl-rebuild.vercel.app/docs/sdk).
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "dependencies": {
3
3
  "@orpc/client": "1.15.3",
4
4
  "@orpc/contract": "1.15.3",
5
- "@shuffl/api-contracts": "0.1.0"
5
+ "@shuffl/api-contracts": "0.2.1"
6
6
  },
7
7
  "description": "TypeScript client for the Shuffl API: people, teams, knowledge, programs and management commands.",
8
8
  "engines": {
@@ -34,5 +34,5 @@
34
34
  "sideEffects": false,
35
35
  "type": "module",
36
36
  "types": "./dist/index.d.ts",
37
- "version": "0.1.0"
37
+ "version": "0.2.1"
38
38
  }