@or-sdk/users 3.8.6-beta.4281.0 → 3.9.1-beta.4282.0

package/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.9.0](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/users@3.8.5...@or-sdk/users@3.9.0) (2026-08-05)
+
+
+### Features
+
+* **packages:** add package descriptions and published files metadata ([801f823](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/commit/801f823034717ef8b961405a73d51ebc2ec07649))
+
+
+
 ## [3.8.5](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/users@3.8.0...@or-sdk/users@3.8.5) (2026-08-04)
 
 **Note:** Version bump only for package @or-sdk/users

package/README.md

@@ -1,9 +1,23 @@
-## Installation:
+# `@or-sdk/users`
+
+OneReach SDK client for Users.
+
+## When to use
+
+- Use this package when integrating with the Users capability on the OneReach platform.
+- Use its typed client and exported models instead of hand-writing requests to that service.
+
+## When not to use
+
+- Do not use it for a different platform capability; choose the dedicated `@or-sdk/*` package instead.
+- Do not use it for generic third-party HTTP calls.
+
+## Installation
 ```
 $ npm i @or-sdk/users
 ```
 
-## Usage:
+## Usage
 ```typescript
 import { Users } from '@or-sdk/users'
 
@@ -20,3 +34,69 @@ const users = new Users({
   discoveryUrl: 'http://example.discovery/endpoint'
 });
  ```
+
+## Configuration
+
+- Prefer `sdkUrl` when the service URL is known; it avoids a discovery request.
+- Use `discoveryUrl` only when the service URL is not available.
+- Provide `token` as a bearer-token string or getter where supported.
+
+## Common pitfalls
+
+- Keep the client token current when it can expire; a token getter is preferable where the constructor accepts one.
+- Treat the generated TypeScript types as the authoritative contract for optional parameters and response shapes.
+
+## Common workflows
+
+```typescript
+const page = await users.listUsers({ from: 0, size: 50, orderProperty: 'email' });
+const user = await users.getUserById('user-id', ['email', 'name']);
+await users.disableUser(user.id);
+```
+
+Use `getCurrentUser` for the identity represented by the token. `listAccounts` is restricted
+to super administrators; cross-account operations require the corresponding SDK configuration
+and authorization.
+
+## Complete API reference
+
+All public methods below are taken from the package source. Parameter and return types use the exported TypeScript names; import the corresponding types from this package when constructing requests.
+
+| Method | Returns | Purpose |
+|---|---|---|
+| `makeRequest(params: CalApiParams)` | `Promise<T>` | See the exported TypeScript signature for behavior and constraints. |
+| `listUsers(params = {} as ListUsersParams)` | `Promise<ListUsersResult>` | List users in account |
+| `getUserById(userId: GetUserByIdParams['userId'], projection: GetUserByIdParams['projection'])` | `Promise<User>` | Get account user by Id |
+| `getCurrentMultiUserProfile({ validate }: ValidateParams = { validate: true })` | `Promise<CurrentMultiUserProfile>` | Get multi-user profile using user token |
+| `getAccountInfo()` | `Promise<AccountItem>` | Get account info based on given token |
+| `listAccountProfiles()` | `Promise<ListAccountProfilesResult>` | List account multi-user profiles |
+| `listProfiles(params: ListProfilesParams)` | `Promise<ListProfilesResult>` | List profiles with ability for partial match by email, username or match by id. |
+| `listUsersAdvanced(params: ListUsersAdvancedParams)` | `Promise<UserAdvanced[]>` | List users with profile information |
+| `getProfileByEmail(email: string)` | `Promise<AccountProfile>` | Get profile by email |
+| `getProfileById(profileId: string)` | `Promise<Profile>` | Get multi-user profile by Id |
+| `getProfile()` | `Promise<Profile>` | Get profile |
+| `attachProfile(params: AttachParams)` | `Promise<AttachResult>` | Attach profile. |
+| `listProfileUsers()` | `Promise<List<ProfileUserItem>>` | List profiles users. |
+| `getCurrentUser()` | `Promise<TokenData>` | Get current user |
+| `getUserEmail(userId?: string)` | `Promise<{ email: string; }>` | Get profile email if exists or user email |
+| `deleteUser(userId: string, accountId?: string)` | `Promise<void>` | Delete a user from account |
+| `updateUser(userId: string, user: UpdateUserParam, accountId?: string)` | `Promise<void>` | Update user |
+| `requestForceChangePassword(userId: string, multi?: boolean)` | `Promise<void>` | Request force change password for user |
+| `disableUser(userId: string, accountId?: string)` | `Promise<void>` | Disable user |
+| `enableUser(userId: string, accountId?: string)` | `Promise<void>` | Enable user |
+| `createUserWithMulti(userData: CreateUserWithMultData, accountId = this.targetAccountId)` | `Promise<CreateUserWithMultResult>` | Initiate the creation of the multi-user |
+| `userListProfileAccounts()` | `Promise<ProfileAccountItem[]>` | List accounts by profile |
+| `listAccounts(params: ListAccountsParams = {})` | `Promise<ListAccountsResult>` | List accounts (super admin only) |
+| `upsertMultiUser(params: UpsertMultiUserParams)` | `Promise<UpsertMultiUserResult>` | Upsert multi-user. |
+
+## More detail
+
+Full signatures and exported types are available in `src/` and `dist/types/`.
+
+
+## Exported utility reference
+
+| Function | Returns | Purpose |
+|---|---|---|
+| `okRes(data: JsonBodyType, status = 200)` | `unknown` | Exported utility; see its TypeScript signature for behavior. |
+| `errorRes(errorMessage: string, status = 500)` | `unknown` | Exported utility; see its TypeScript signature for behavior. |

package/package.json

@@ -1,12 +1,35 @@
 {
   "name": "@or-sdk/users",
-  "version": "3.8.6-beta.4281.0",
+  "version": "3.9.1-beta.4282.0",
+  "description": "OneReach SDK client for Users",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "dependencies": {
+    "validator": "^13.15.23",
+    "zod": "^3.24.4",
+    "@or-sdk/base": "^0.44.8-beta.4282.0",
+    "@or-sdk/sdk-api": "^0.30.1-beta.4282.0"
+  },
+  "devDependencies": {
+    "@types/validator": "^13.12.0",
+    "concurrently": "^9.2.0",
+    "msw": "^2.11.3",
+    "typescript": "^5.6.2",
+    "vitest": "^4.1.10"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
-    "build": "pnpm clean && concurrently 'npm:build:*(!watch)'",
+    "build": "concurrently 'npm:build:*(!watch)'",
     "build:cjs": "tsc --project tsconfig.json",
     "build:esm": "tsc --project tsconfig.esm.json",
     "build:types": "tsc --project tsconfig.types.json",
@@ -18,20 +41,5 @@
     "dev": "pnpm build:watch:esm",
     "test": "vitest",
     "test:watch": "vitest --watch"
-  },
-  "dependencies": {
-    "@or-sdk/base": "^0.44.7",
-    "@or-sdk/sdk-api": "^0.29.6-beta.4281.0",
-    "validator": "^13.15.23",
-    "zod": "^3.24.4"
-  },
-  "devDependencies": {
-    "@types/validator": "^13.11.8",
-    "concurrently": "9.0.1",
-    "msw": "^2.8.2",
-    "typescript": "5.6.2"
-  },
-  "publishConfig": {
-    "access": "public"
   }
-}
+}

package/tsconfig.build.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "rootDir": "./src"
-  },
-  "exclude": [
-    "./src/__tests__"
-  ]
-}

package/tsconfig.dev.json

@@ -1,7 +0,0 @@
-{
-  "extends": "./tsconfig.esm.json",
-  "compilerOptions": {
-    "declarationDir": "./dist/types",
-    "declaration": true
-  }
-}

package/tsconfig.esm.json

@@ -1,11 +0,0 @@
-{
-  "extends": "./tsconfig.build.json",
-  "compilerOptions": {
-    "outDir": "./dist/esm",
-    "declarationDir": "./dist/types",
-    "module": "ES6",
-    "target": "es6",
-    "declaration": true,
-    "declarationMap": true
-  }
-}

package/tsconfig.json

@@ -1,6 +0,0 @@
-{
-  "extends": "./tsconfig.build.json",
-  "compilerOptions": {
-    "outDir": "./dist/cjs"
-  }
-}

package/tsconfig.types.json

@@ -1,10 +0,0 @@
-{
-  "extends": "./tsconfig.build.json",
-  "compilerOptions": {
-    "outDir": "./dist/types",
-    "declaration": true,
-    "declarationMap": true,
-    "emitDeclarationOnly": true,
-    "removeComments": false
-  }
-}

package/vitest.config.mjs

@@ -1,25 +0,0 @@
-import { defineConfig } from 'vitest/config';
-
-export default defineConfig({
-  test: {
-    reporters: ['junit', 'default'],
-    outputFile: 'test-results/junit.xml',
-    include: ['src/**/*.{test,spec}.ts'],
-    exclude: ['dist/**'],
-    coverage: {
-      reporter: ['text', 'json', 'html', 'cobertura', 'text-summary'],
-      clean: true,
-      include: [
-        'src/**',
-      ],
-      exclude: [
-        'src/types.ts',
-        '**/*.spec.ts',
-      ],
-    },
-    globals: true,
-    environment: 'node',
-    clearMocks: true,
-    watch: false,
-  },
-});