@linagora/ldap-rest-client 1.0.3 → 1.0.5

package/README.md

@@ -38,13 +38,16 @@ const client = new LdapRestClient({
   baseUrl: 'https://ldap-rest.example.com',
 });
 
-// Manage users in organization
-await client.organizations.createUser(orgId, userData);
+// Manage users in organization (returns baseDN)
+const { baseDN } = await client.organizations.createUser(orgId, userData);
 await client.organizations.listUsers(orgId, { page: 1, limit: 20 });
 
-// Manage groups
-await client.groups.create(orgId, { name: 'engineering' });
+// Manage groups (returns Group object)
+const group = await client.groups.create(orgId, { name: 'engineering' });
 await client.groups.addMembers(orgId, groupId, { usernames: ['user1'] });
+
+// Get user's organizations
+const orgs = await client.users.getUserOrganizations(userId, 'admin');
 ```
 
 ## API Reference
@@ -57,6 +60,7 @@ client.users.disable(username)
 client.users.delete(username)
 client.users.checkAvailability({ field, value })
 client.users.fetch({ by, value, fields })
+client.users.getUserOrganizations(userId, role?) // Get user's organizations by role
 ```
 
 ### Organizations
@@ -75,8 +79,12 @@ client.organizations.transferOwnership(orgId, { newOwnerUsername })
 
 ### B2B Users (within Organizations)
 ```typescript
-client.organizations.createUser(orgId, userData)
-client.organizations.updateUser(orgId, userId, updates)
+// Returns baseDN of created user
+const { baseDN } = await client.organizations.createUser(orgId, userData)
+
+// Returns User object or { success: true }
+const result = await client.organizations.updateUser(orgId, userId, updates)
+
 client.organizations.disableUser(orgId, userId)
 client.organizations.deleteUser(orgId, userId)
 client.organizations.getUser(orgId, { by, value })
@@ -89,7 +97,9 @@ client.organizations.changeUserRole(orgId, userId, { role })
 
 ### Groups
 ```typescript
-client.groups.create(orgId, { name, description })
+// Returns Group object directly
+const group = await client.groups.create(orgId, { name, description })
+
 client.groups.list(orgId, { page, limit })
 client.groups.get(orgId, groupId)
 client.groups.update(orgId, groupId, updates)

package/dist/index.d.mts

@@ -341,6 +341,8 @@ interface UserName {
  * Complete user model with all profile fields, credentials, and encryption keys
  */
 interface User {
+    /** Unique user identifier (mapped from LDAP entryUUID) */
+    _id?: string;
     /** Common name (username) */
     cn: string;
     /** Surname or last name */
@@ -736,13 +738,6 @@ interface CreateGroupRequest {
     /** Optional group description */
     description?: string;
 }
-/**
- * Response from creating a group
- */
-interface CreateGroupResponse {
-    success: true;
-    group: Group;
-}
 /**
  * Request parameters for updating a group
  */
@@ -895,6 +890,27 @@ declare class UsersResource extends BaseResource {
      * ```
      */
     fetch: (params: FetchUserRequest) => Promise<User>;
+    /**
+     * Gets organizations where a user has a role
+     *
+     * Returns organizations where the user is an admin or owner.
+     * Optionally filter by specific role.
+     *
+     * @param {string} userId - User identifier (username)
+     * @param {string} [role] - Optional role filter ('owner', 'admin', 'moderator', 'member')
+     * @returns {Promise<Organization[]>} Array of organizations
+     * @throws {ApiError} On API errors
+     *
+     * @example
+     * ```typescript
+     * // Get all organizations where user has any role
+     * const orgs = await client.users.getUserOrganizations('johndoe');
+     *
+     * // Get only organizations where user is owner
+     * const ownedOrgs = await client.users.getUserOrganizations('johndoe', 'owner');
+     * ```
+     */
+    getUserOrganizations: (userId: string, role?: string) => Promise<Organization[]>;
 }
 
 /**
@@ -1147,19 +1163,19 @@ declare class OrganizationsResource extends BaseResource {
      * @param {string} organizationId - Organization identifier
      * @param {string} userId - User identifier (username)
      * @param {UpdateUserRequest} data - Fields to update
-     * @returns {Promise<{ success: true }>} Success response
+     * @returns {Promise<User | { success: true }>} Updated user object or success response
      * @throws {NotFoundError} When user or organization is not found
      * @throws {ForbiddenError} When user lacks admin privileges
      * @throws {ApiError} On other API errors
      *
      * @example
      * ```typescript
-     * await client.organizations.updateUser('org_abc123', 'john.doe', {
+     * const result = await client.organizations.updateUser('org_abc123', 'john.doe', {
      *   mobile: '+33687654321'
      * });
      * ```
      */
-    updateUser: (organizationId: string, userId: string, data: UpdateUserRequest) => Promise<{
+    updateUser: (organizationId: string, userId: string, data: UpdateUserRequest) => Promise<User | {
         success: true;
     }>;
     /**
@@ -1330,7 +1346,7 @@ declare class GroupsResource extends BaseResource {
      *
      * @param {string} organizationId - Organization identifier
      * @param {CreateGroupRequest} data - Group data (name and optional description)
-     * @returns {Promise<CreateGroupResponse>} Created group details
+     * @returns {Promise<Group>} Created group object
      * @throws {ForbiddenError} When user lacks admin privileges
      * @throws {NotFoundError} When organization is not found
      * @throws {ConflictError} When group name already exists
@@ -1338,13 +1354,13 @@ declare class GroupsResource extends BaseResource {
      *
      * @examples
      * ```typescript
-     * const result = await client.groups.create('org_abc123', {
+     * const group = await client.groups.create('org_abc123', {
      *   name: 'engineering',
      *   description: 'Engineering team'
      * });
      * ```
      */
-    create: (organizationId: string, data: CreateGroupRequest) => Promise<CreateGroupResponse>;
+    create: (organizationId: string, data: CreateGroupRequest) => Promise<Group>;
     /**
      * Lists all groups in an organization with pagination
      *
@@ -1683,4 +1699,4 @@ declare class NetworkError extends LdapRestError {
     constructor(message: string, cause?: Error);
 }
 
-export { type AddGroupMembersRequest, type Address, ApiError, AuthenticationError, AuthorizationError, type ChangeUserRoleRequest, type CheckAvailabilityParams, type CheckAvailabilityResponse, type CheckOrganizationAvailabilityParams, type ClientConfig, ConflictError, type CreateAdminRequest, type CreateB2BUserResponse, type CreateGroupRequest, type CreateGroupResponse, type CreateOrganizationRequest, type CreateOrganizationResponse, type CreateUserRequest, type EmailAddress, type ExtendedAddress, type FetchUserRequest, type GeoLocation, type GetOwnerResponse, type Group, GroupsResource, type InstantMessaging, LdapRestClient, LdapRestError, type ListGroupsParams, type ListGroupsResponse, type ListUsersParams, type ListUsersResponse, NetworkError, NotFoundError, type Organization, type OrganizationMetadata, type OrganizationOwner, type OrganizationRole, type OrganizationSearchField, type OrganizationStatus, OrganizationsResource, type PhoneNumber, RateLimitError, type SetOwnerRequest, type TransferOwnershipRequest, type UpdateGroupRequest, type UpdateOrganizationRequest, type UpdateUserRequest, type User, type UserCredentials, type UserKeys, type UserName, type UserSearchField, type UserStatus, UsersResource, ValidationError };
+export { type AddGroupMembersRequest, type Address, ApiError, AuthenticationError, AuthorizationError, type ChangeUserRoleRequest, type CheckAvailabilityParams, type CheckAvailabilityResponse, type CheckOrganizationAvailabilityParams, type ClientConfig, ConflictError, type CreateAdminRequest, type CreateB2BUserResponse, type CreateGroupRequest, type CreateOrganizationRequest, type CreateOrganizationResponse, type CreateUserRequest, type EmailAddress, type ExtendedAddress, type FetchUserRequest, type GeoLocation, type GetOwnerResponse, type Group, GroupsResource, type InstantMessaging, LdapRestClient, LdapRestError, type ListGroupsParams, type ListGroupsResponse, type ListUsersParams, type ListUsersResponse, NetworkError, NotFoundError, type Organization, type OrganizationMetadata, type OrganizationOwner, type OrganizationRole, type OrganizationSearchField, type OrganizationStatus, OrganizationsResource, type PhoneNumber, RateLimitError, type SetOwnerRequest, type TransferOwnershipRequest, type UpdateGroupRequest, type UpdateOrganizationRequest, type UpdateUserRequest, type User, type UserCredentials, type UserKeys, type UserName, type UserSearchField, type UserStatus, UsersResource, ValidationError };

package/dist/index.d.ts

@@ -341,6 +341,8 @@ interface UserName {
  * Complete user model with all profile fields, credentials, and encryption keys
  */
 interface User {
+    /** Unique user identifier (mapped from LDAP entryUUID) */
+    _id?: string;
     /** Common name (username) */
     cn: string;
     /** Surname or last name */
@@ -736,13 +738,6 @@ interface CreateGroupRequest {
     /** Optional group description */
     description?: string;
 }
-/**
- * Response from creating a group
- */
-interface CreateGroupResponse {
-    success: true;
-    group: Group;
-}
 /**
  * Request parameters for updating a group
  */
@@ -895,6 +890,27 @@ declare class UsersResource extends BaseResource {
      * ```
      */
     fetch: (params: FetchUserRequest) => Promise<User>;
+    /**
+     * Gets organizations where a user has a role
+     *
+     * Returns organizations where the user is an admin or owner.
+     * Optionally filter by specific role.
+     *
+     * @param {string} userId - User identifier (username)
+     * @param {string} [role] - Optional role filter ('owner', 'admin', 'moderator', 'member')
+     * @returns {Promise<Organization[]>} Array of organizations
+     * @throws {ApiError} On API errors
+     *
+     * @example
+     * ```typescript
+     * // Get all organizations where user has any role
+     * const orgs = await client.users.getUserOrganizations('johndoe');
+     *
+     * // Get only organizations where user is owner
+     * const ownedOrgs = await client.users.getUserOrganizations('johndoe', 'owner');
+     * ```
+     */
+    getUserOrganizations: (userId: string, role?: string) => Promise<Organization[]>;
 }
 
 /**
@@ -1147,19 +1163,19 @@ declare class OrganizationsResource extends BaseResource {
      * @param {string} organizationId - Organization identifier
      * @param {string} userId - User identifier (username)
      * @param {UpdateUserRequest} data - Fields to update
-     * @returns {Promise<{ success: true }>} Success response
+     * @returns {Promise<User | { success: true }>} Updated user object or success response
      * @throws {NotFoundError} When user or organization is not found
      * @throws {ForbiddenError} When user lacks admin privileges
      * @throws {ApiError} On other API errors
      *
      * @example
      * ```typescript
-     * await client.organizations.updateUser('org_abc123', 'john.doe', {
+     * const result = await client.organizations.updateUser('org_abc123', 'john.doe', {
      *   mobile: '+33687654321'
      * });
      * ```
      */
-    updateUser: (organizationId: string, userId: string, data: UpdateUserRequest) => Promise<{
+    updateUser: (organizationId: string, userId: string, data: UpdateUserRequest) => Promise<User | {
         success: true;
     }>;
     /**
@@ -1330,7 +1346,7 @@ declare class GroupsResource extends BaseResource {
      *
      * @param {string} organizationId - Organization identifier
      * @param {CreateGroupRequest} data - Group data (name and optional description)
-     * @returns {Promise<CreateGroupResponse>} Created group details
+     * @returns {Promise<Group>} Created group object
      * @throws {ForbiddenError} When user lacks admin privileges
      * @throws {NotFoundError} When organization is not found
      * @throws {ConflictError} When group name already exists
@@ -1338,13 +1354,13 @@ declare class GroupsResource extends BaseResource {
      *
      * @examples
      * ```typescript
-     * const result = await client.groups.create('org_abc123', {
+     * const group = await client.groups.create('org_abc123', {
      *   name: 'engineering',
      *   description: 'Engineering team'
      * });
      * ```
      */
-    create: (organizationId: string, data: CreateGroupRequest) => Promise<CreateGroupResponse>;
+    create: (organizationId: string, data: CreateGroupRequest) => Promise<Group>;
     /**
      * Lists all groups in an organization with pagination
      *
@@ -1683,4 +1699,4 @@ declare class NetworkError extends LdapRestError {
     constructor(message: string, cause?: Error);
 }
 
-export { type AddGroupMembersRequest, type Address, ApiError, AuthenticationError, AuthorizationError, type ChangeUserRoleRequest, type CheckAvailabilityParams, type CheckAvailabilityResponse, type CheckOrganizationAvailabilityParams, type ClientConfig, ConflictError, type CreateAdminRequest, type CreateB2BUserResponse, type CreateGroupRequest, type CreateGroupResponse, type CreateOrganizationRequest, type CreateOrganizationResponse, type CreateUserRequest, type EmailAddress, type ExtendedAddress, type FetchUserRequest, type GeoLocation, type GetOwnerResponse, type Group, GroupsResource, type InstantMessaging, LdapRestClient, LdapRestError, type ListGroupsParams, type ListGroupsResponse, type ListUsersParams, type ListUsersResponse, NetworkError, NotFoundError, type Organization, type OrganizationMetadata, type OrganizationOwner, type OrganizationRole, type OrganizationSearchField, type OrganizationStatus, OrganizationsResource, type PhoneNumber, RateLimitError, type SetOwnerRequest, type TransferOwnershipRequest, type UpdateGroupRequest, type UpdateOrganizationRequest, type UpdateUserRequest, type User, type UserCredentials, type UserKeys, type UserName, type UserSearchField, type UserStatus, UsersResource, ValidationError };
+export { type AddGroupMembersRequest, type Address, ApiError, AuthenticationError, AuthorizationError, type ChangeUserRoleRequest, type CheckAvailabilityParams, type CheckAvailabilityResponse, type CheckOrganizationAvailabilityParams, type ClientConfig, ConflictError, type CreateAdminRequest, type CreateB2BUserResponse, type CreateGroupRequest, type CreateOrganizationRequest, type CreateOrganizationResponse, type CreateUserRequest, type EmailAddress, type ExtendedAddress, type FetchUserRequest, type GeoLocation, type GetOwnerResponse, type Group, GroupsResource, type InstantMessaging, LdapRestClient, LdapRestError, type ListGroupsParams, type ListGroupsResponse, type ListUsersParams, type ListUsersResponse, NetworkError, NotFoundError, type Organization, type OrganizationMetadata, type OrganizationOwner, type OrganizationRole, type OrganizationSearchField, type OrganizationStatus, OrganizationsResource, type PhoneNumber, RateLimitError, type SetOwnerRequest, type TransferOwnershipRequest, type UpdateGroupRequest, type UpdateOrganizationRequest, type UpdateUserRequest, type User, type UserCredentials, type UserKeys, type UserName, type UserSearchField, type UserStatus, UsersResource, ValidationError };

package/dist/index.js

@@ -632,6 +632,30 @@ var UsersResource = class extends BaseResource {
     const query = this.buildQueryString(params);
     return this.http.get(`/api/v1/users${query}`);
   };
+  /**
+   * Gets organizations where a user has a role
+   *
+   * Returns organizations where the user is an admin or owner.
+   * Optionally filter by specific role.
+   *
+   * @param {string} userId - User identifier (username)
+   * @param {string} [role] - Optional role filter ('owner', 'admin', 'moderator', 'member')
+   * @returns {Promise<Organization[]>} Array of organizations
+   * @throws {ApiError} On API errors
+   *
+   * @example
+   * ```typescript
+   * // Get all organizations where user has any role
+   * const orgs = await client.users.getUserOrganizations('johndoe');
+   *
+   * // Get only organizations where user is owner
+   * const ownedOrgs = await client.users.getUserOrganizations('johndoe', 'owner');
+   * ```
+   */
+  getUserOrganizations = async (userId, role) => {
+    const query = role ? this.buildQueryString({ role }) : "";
+    return this.http.get(`/api/v1/users/${encodeURIComponent(userId)}/organizations${query}`);
+  };
 };
 
 // src/resources/OrganizationsResource.ts
@@ -883,14 +907,14 @@ var OrganizationsResource = class extends BaseResource {
    * @param {string} organizationId - Organization identifier
    * @param {string} userId - User identifier (username)
    * @param {UpdateUserRequest} data - Fields to update
-   * @returns {Promise<{ success: true }>} Success response
+   * @returns {Promise<User | { success: true }>} Updated user object or success response
    * @throws {NotFoundError} When user or organization is not found
    * @throws {ForbiddenError} When user lacks admin privileges
    * @throws {ApiError} On other API errors
    *
    * @example
    * ```typescript
-   * await client.organizations.updateUser('org_abc123', 'john.doe', {
+   * const result = await client.organizations.updateUser('org_abc123', 'john.doe', {
    *   mobile: '+33687654321'
    * });
    * ```
@@ -1069,7 +1093,7 @@ var GroupsResource = class extends BaseResource {
    *
    * @param {string} organizationId - Organization identifier
    * @param {CreateGroupRequest} data - Group data (name and optional description)
-   * @returns {Promise<CreateGroupResponse>} Created group details
+   * @returns {Promise<Group>} Created group object
    * @throws {ForbiddenError} When user lacks admin privileges
    * @throws {NotFoundError} When organization is not found
    * @throws {ConflictError} When group name already exists
@@ -1077,7 +1101,7 @@ var GroupsResource = class extends BaseResource {
    *
    * @examples
    * ```typescript
-   * const result = await client.groups.create('org_abc123', {
+   * const group = await client.groups.create('org_abc123', {
    *   name: 'engineering',
    *   description: 'Engineering team'
    * });

package/dist/index.mjs

@@ -594,6 +594,30 @@ var UsersResource = class extends BaseResource {
     const query = this.buildQueryString(params);
     return this.http.get(`/api/v1/users${query}`);
   };
+  /**
+   * Gets organizations where a user has a role
+   *
+   * Returns organizations where the user is an admin or owner.
+   * Optionally filter by specific role.
+   *
+   * @param {string} userId - User identifier (username)
+   * @param {string} [role] - Optional role filter ('owner', 'admin', 'moderator', 'member')
+   * @returns {Promise<Organization[]>} Array of organizations
+   * @throws {ApiError} On API errors
+   *
+   * @example
+   * ```typescript
+   * // Get all organizations where user has any role
+   * const orgs = await client.users.getUserOrganizations('johndoe');
+   *
+   * // Get only organizations where user is owner
+   * const ownedOrgs = await client.users.getUserOrganizations('johndoe', 'owner');
+   * ```
+   */
+  getUserOrganizations = async (userId, role) => {
+    const query = role ? this.buildQueryString({ role }) : "";
+    return this.http.get(`/api/v1/users/${encodeURIComponent(userId)}/organizations${query}`);
+  };
 };
 
 // src/resources/OrganizationsResource.ts
@@ -845,14 +869,14 @@ var OrganizationsResource = class extends BaseResource {
    * @param {string} organizationId - Organization identifier
    * @param {string} userId - User identifier (username)
    * @param {UpdateUserRequest} data - Fields to update
-   * @returns {Promise<{ success: true }>} Success response
+   * @returns {Promise<User | { success: true }>} Updated user object or success response
    * @throws {NotFoundError} When user or organization is not found
    * @throws {ForbiddenError} When user lacks admin privileges
    * @throws {ApiError} On other API errors
    *
    * @example
    * ```typescript
-   * await client.organizations.updateUser('org_abc123', 'john.doe', {
+   * const result = await client.organizations.updateUser('org_abc123', 'john.doe', {
    *   mobile: '+33687654321'
    * });
    * ```
@@ -1031,7 +1055,7 @@ var GroupsResource = class extends BaseResource {
    *
    * @param {string} organizationId - Organization identifier
    * @param {CreateGroupRequest} data - Group data (name and optional description)
-   * @returns {Promise<CreateGroupResponse>} Created group details
+   * @returns {Promise<Group>} Created group object
    * @throws {ForbiddenError} When user lacks admin privileges
    * @throws {NotFoundError} When organization is not found
    * @throws {ConflictError} When group name already exists
@@ -1039,7 +1063,7 @@ var GroupsResource = class extends BaseResource {
    *
    * @examples
    * ```typescript
-   * const result = await client.groups.create('org_abc123', {
+   * const group = await client.groups.create('org_abc123', {
    *   name: 'engineering',
    *   description: 'Engineering team'
    * });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linagora/ldap-rest-client",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "TypeScript API client for LDAP-REST",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",