@lifestreamdynamics/vault-sdk 1.0.0

package/dist/resources/teams.d.ts

@@ -0,0 +1,356 @@
+import type { KyInstance } from 'ky';
+import type { Vault } from '../types/index.js';
+/** A team object returned by the API. */
+export interface Team {
+    /** Unique team identifier. */
+    id: string;
+    /** Display name of the team. */
+    name: string;
+    /** Optional team description. */
+    description: string | null;
+    /** User ID of the team owner. */
+    ownerId: string;
+    /** ISO 8601 creation timestamp. */
+    createdAt: string;
+    /** ISO 8601 last-updated timestamp. */
+    updatedAt: string;
+}
+/** A team member with their associated user information. */
+export interface TeamMember {
+    /** Unique membership record identifier. */
+    id: string;
+    /** ID of the team this membership belongs to. */
+    teamId: string;
+    /** ID of the member user. */
+    userId: string;
+    /** Role within the team. */
+    role: 'owner' | 'admin' | 'member';
+    /** ISO 8601 timestamp when the user joined the team. */
+    joinedAt: string;
+    /** Basic user information for the member. */
+    user: {
+        id: string;
+        email: string;
+        name: string | null;
+    };
+}
+/** A pending invitation to join a team. */
+export interface TeamInvitation {
+    /** Unique invitation identifier. */
+    id: string;
+    /** ID of the team the invitation is for. */
+    teamId: string;
+    /** Email address of the invited user. */
+    email: string;
+    /** Role the user will receive upon accepting. */
+    role: 'admin' | 'member';
+    /** User ID of the person who sent the invitation. */
+    invitedBy: string;
+    /** ISO 8601 creation timestamp. */
+    createdAt: string;
+    /** ISO 8601 expiration timestamp. */
+    expiresAt: string;
+}
+/** Parameters for creating a new team. */
+export interface CreateTeamParams {
+    /** Display name for the team. */
+    name: string;
+    /** Optional description of the team's purpose. */
+    description?: string;
+}
+/** Parameters for updating an existing team. */
+export interface UpdateTeamParams {
+    /** New display name for the team. */
+    name?: string;
+    /** New description, or `null` to clear. */
+    description?: string | null;
+}
+/**
+ * Resource for managing teams, members, invitations, and team vaults.
+ *
+ * Teams allow users to collaborate on shared vaults with role-based access
+ * control. Team members can be owners, admins, or regular members.
+ *
+ * @example
+ * ```typescript
+ * const teams = await client.teams.list();
+ * const team = await client.teams.create({ name: 'Engineering' });
+ * const members = await client.teams.listMembers(team.id);
+ * ```
+ */
+export declare class TeamsResource {
+    private http;
+    constructor(http: KyInstance);
+    /**
+     * Lists all teams the authenticated user belongs to.
+     *
+     * @returns Array of team objects
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const teams = await client.teams.list();
+     * for (const team of teams) {
+     *   console.log(team.name);
+     * }
+     * ```
+     */
+    list(): Promise<Team[]>;
+    /**
+     * Retrieves a single team by ID.
+     *
+     * @param teamId - The unique identifier of the team
+     * @returns The team object
+     * @throws {NotFoundError} If no team exists with the given ID
+     * @throws {AuthorizationError} If the user is not a member of the team
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const team = await client.teams.get('team-uuid');
+     * console.log(team.name, team.description);
+     * ```
+     */
+    get(teamId: string): Promise<Team>;
+    /**
+     * Creates a new team. The authenticated user becomes the team owner.
+     *
+     * @param params - Team creation parameters
+     * @param params.name - Display name for the team (required)
+     * @param params.description - Optional description of the team's purpose
+     * @returns The newly created team object
+     * @throws {ValidationError} If the name is empty or invalid
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const team = await client.teams.create({
+     *   name: 'Engineering',
+     *   description: 'Backend and frontend engineering team',
+     * });
+     * console.log(team.id);
+     * ```
+     */
+    create(params: CreateTeamParams): Promise<Team>;
+    /**
+     * Updates an existing team's metadata. Requires admin or owner role.
+     *
+     * Only the provided fields are modified; omitted fields remain unchanged.
+     *
+     * @param teamId - The unique identifier of the team to update
+     * @param params - Fields to update
+     * @param params.name - New display name for the team
+     * @param params.description - New description, or `null` to clear
+     * @returns The updated team object
+     * @throws {NotFoundError} If no team exists with the given ID
+     * @throws {AuthorizationError} If the user lacks admin/owner role
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const updated = await client.teams.update('team-uuid', {
+     *   name: 'Platform Engineering',
+     * });
+     * ```
+     */
+    update(teamId: string, params: UpdateTeamParams): Promise<Team>;
+    /**
+     * Permanently deletes a team. Only the team owner can delete a team.
+     *
+     * This removes all memberships, invitations, and team vault associations.
+     *
+     * @param teamId - The unique identifier of the team to delete
+     * @throws {NotFoundError} If no team exists with the given ID
+     * @throws {AuthorizationError} If the user is not the team owner
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * await client.teams.delete('team-uuid');
+     * ```
+     */
+    delete(teamId: string): Promise<void>;
+    /**
+     * Lists all members of a team.
+     *
+     * @param teamId - The unique identifier of the team
+     * @returns Array of team member objects with user details
+     * @throws {NotFoundError} If no team exists with the given ID
+     * @throws {AuthorizationError} If the user is not a member of the team
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const members = await client.teams.listMembers('team-uuid');
+     * for (const member of members) {
+     *   console.log(member.user.email, member.role);
+     * }
+     * ```
+     */
+    listMembers(teamId: string): Promise<TeamMember[]>;
+    /**
+     * Updates a team member's role. Requires admin or owner role.
+     *
+     * Cannot change the owner's role. Admins cannot promote others to owner.
+     *
+     * @param teamId - The unique identifier of the team
+     * @param userId - The user ID of the member to update
+     * @param role - The new role to assign (`'admin'` or `'member'`)
+     * @returns The updated team member object
+     * @throws {NotFoundError} If the team or member is not found
+     * @throws {AuthorizationError} If the user lacks permission to change roles
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const member = await client.teams.updateMemberRole('team-uuid', 'user-uuid', 'admin');
+     * console.log(member.role); // 'admin'
+     * ```
+     */
+    updateMemberRole(teamId: string, userId: string, role: 'admin' | 'member'): Promise<TeamMember>;
+    /**
+     * Removes a member from a team. Requires admin or owner role.
+     *
+     * The team owner cannot be removed.
+     *
+     * @param teamId - The unique identifier of the team
+     * @param userId - The user ID of the member to remove
+     * @throws {NotFoundError} If the team or member is not found
+     * @throws {AuthorizationError} If the user lacks permission or is trying to remove the owner
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * await client.teams.removeMember('team-uuid', 'user-uuid');
+     * ```
+     */
+    removeMember(teamId: string, userId: string): Promise<void>;
+    /**
+     * Leaves a team. The authenticated user removes themselves from the team.
+     *
+     * The team owner cannot leave; they must delete the team or transfer ownership first.
+     *
+     * @param teamId - The unique identifier of the team to leave
+     * @throws {NotFoundError} If no team exists with the given ID
+     * @throws {AuthorizationError} If the user is the team owner
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * await client.teams.leave('team-uuid');
+     * ```
+     */
+    leave(teamId: string): Promise<void>;
+    /**
+     * Invites a user to join a team by email. Requires admin or owner role.
+     *
+     * @param teamId - The unique identifier of the team
+     * @param email - Email address of the user to invite
+     * @param role - Role to assign upon acceptance (`'admin'` or `'member'`)
+     * @returns The created invitation object
+     * @throws {ValidationError} If the email is invalid or the user is already a member
+     * @throws {AuthorizationError} If the user lacks admin/owner role
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const invitation = await client.teams.inviteMember(
+     *   'team-uuid',
+     *   'colleague@example.com',
+     *   'member',
+     * );
+     * console.log(invitation.expiresAt);
+     * ```
+     */
+    inviteMember(teamId: string, email: string, role: 'admin' | 'member'): Promise<TeamInvitation>;
+    /**
+     * Lists all pending invitations for a team.
+     *
+     * @param teamId - The unique identifier of the team
+     * @returns Array of pending invitation objects
+     * @throws {NotFoundError} If no team exists with the given ID
+     * @throws {AuthorizationError} If the user is not a member of the team
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const invitations = await client.teams.listInvitations('team-uuid');
+     * for (const inv of invitations) {
+     *   console.log(inv.email, inv.role, inv.expiresAt);
+     * }
+     * ```
+     */
+    listInvitations(teamId: string): Promise<TeamInvitation[]>;
+    /**
+     * Revokes a pending invitation. Requires admin or owner role.
+     *
+     * @param teamId - The unique identifier of the team
+     * @param invitationId - The unique identifier of the invitation to revoke
+     * @throws {NotFoundError} If the team or invitation is not found
+     * @throws {AuthorizationError} If the user lacks admin/owner role
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * await client.teams.revokeInvitation('team-uuid', 'invitation-uuid');
+     * ```
+     */
+    revokeInvitation(teamId: string, invitationId: string): Promise<void>;
+    /**
+     * Creates a new vault under a team. Requires editor role or above.
+     *
+     * @param teamId - The unique identifier of the team
+     * @param params - Vault creation parameters
+     * @param params.name - Display name for the vault (required)
+     * @param params.description - Optional description of the vault's purpose
+     * @returns The newly created vault object
+     * @throws {ValidationError} If the name is empty or the slug conflicts
+     * @throws {AuthorizationError} If the user lacks the required team role
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const vault = await client.teams.createVault('team-uuid', {
+     *   name: 'Shared Docs',
+     *   description: 'Team documentation',
+     * });
+     * ```
+     */
+    createVault(teamId: string, params: {
+        name: string;
+        description?: string;
+    }): Promise<Vault>;
+    /**
+     * Lists all vaults belonging to a team.
+     *
+     * @param teamId - The unique identifier of the team
+     * @returns Array of vault objects
+     * @throws {NotFoundError} If no team exists with the given ID
+     * @throws {AuthorizationError} If the user is not a member of the team
+     * @throws {AuthenticationError} If the request is not authenticated
+     * @throws {NetworkError} If the request fails due to network issues
+     *
+     * @example
+     * ```typescript
+     * const vaults = await client.teams.listVaults('team-uuid');
+     * for (const vault of vaults) {
+     *   console.log(vault.name);
+     * }
+     * ```
+     */
+    listVaults(teamId: string): Promise<Vault[]>;
+}
+//# sourceMappingURL=teams.d.ts.map

package/dist/resources/teams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"teams.d.ts","sourceRoot":"","sources":["../../src/resources/teams.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAErC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE/C,yCAAyC;AACzC,MAAM,WAAW,IAAI;IACnB,8BAA8B;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,iCAAiC;IACjC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,4DAA4D;AAC5D,MAAM,WAAW,UAAU;IACzB,2CAA2C;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;IACf,6BAA6B;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC;IACnC,wDAAwD;IACxD,QAAQ,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;KACrB,CAAC;CACH;AAED,2CAA2C;AAC3C,MAAM,WAAW,cAAc;IAC7B,oCAAoC;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,4CAA4C;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,IAAI,EAAE,OAAO,GAAG,QAAQ,CAAC;IACzB,qDAAqD;IACrD,SAAS,EAAE,MAAM,CAAC;IAClB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,0CAA0C;AAC1C,MAAM,WAAW,gBAAgB;IAC/B,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,gDAAgD;AAChD,MAAM,WAAW,gBAAgB;IAC/B,qCAAqC;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,aAAa;IACZ,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAIpC;;;;;;;;;;;;;;OAcG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;IAS7B;;;;;;;;;;;;;;;OAeG;IACG,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQxC;;;;;;;;;;;;;;;;;;;OAmBG;IACG,MAAM,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAQrD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAQrE;;;;;;;;;;;;;;;OAeG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU3C;;;;;;;;;;;;;;;;;OAiBG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IASxD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC;IAQrG;;;;;;;;;;;;;;;;OAgBG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQjE;;;;;;;;;;;;;;;OAeG;IACG,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU1C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC;IAQpG;;;;;;;;;;;;;;;;;OAiBG;IACG,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAShE;;;;;;;;;;;;;;OAcG;IACG,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU3E;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,CAAC;IAQjG;;;;;;;;;;;;;;;;;OAiBG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;CAQnD"}