@oxyhq/core 3.18.1 → 4.0.0

package/src/mixins/OxyServices.managedAccounts.ts

@@ -1,173 +0,0 @@
-/**
- * Managed Accounts Methods Mixin
- *
- * Provides SDK methods for creating and managing sub-accounts (managed identities).
- * Managed accounts are full User documents without passwords, accessible only
- * by their owners/managers via the X-Acting-As header mechanism.
- */
-import type { User } from '../models/interfaces';
-import type { OxyServicesBase } from '../OxyServices.base';
-
-export interface CreateManagedAccountInput {
-  username: string;
-  name?: { first?: string; last?: string };
-  bio?: string;
-  avatar?: string;
-}
-
-export interface ManagedAccountManager {
-  userId: string;
-  role: 'owner' | 'admin' | 'editor';
-  addedAt: string;
-  addedBy?: string;
-}
-
-export interface ManagedAccount {
-  accountId: string;
-  ownerId: string;
-  managers: ManagedAccountManager[];
-  account?: User;
-  createdAt?: string;
-  updatedAt?: string;
-}
-
-export function OxyServicesManagedAccountsMixin<T extends typeof OxyServicesBase>(Base: T) {
-  return class extends Base {
-    constructor(...args: any[]) {
-      super(...(args as [any]));
-    }
-
-    /**
-     * Create a new managed account (sub-account).
-     *
-     * The server creates a User document with `isManagedAccount: true` and links
-     * it to the authenticated user as owner. Invalidates the cached
-     * `GET /managed-accounts` list (~2-minute TTL, identity-scoped) so the next
-     * read includes the newly created account.
-     */
-    async createManagedAccount(data: CreateManagedAccountInput): Promise<ManagedAccount> {
-      try {
-        const result = await this.makeRequest<ManagedAccount>('POST', '/managed-accounts', data, {
-          cache: false,
-        });
-        this.clearCacheEntry('GET:/managed-accounts');
-        return result;
-      } catch (error) {
-        throw this.handleError(error);
-      }
-    }
-
-    /**
-     * List all accounts the authenticated user manages.
-     */
-    async getManagedAccounts(): Promise<ManagedAccount[]> {
-      try {
-        return await this.makeRequest<ManagedAccount[]>('GET', '/managed-accounts', undefined, {
-          cache: true,
-          cacheTTL: 2 * 60 * 1000, // 2 minutes cache
-        });
-      } catch (error) {
-        throw this.handleError(error);
-      }
-    }
-
-    /**
-     * Get details for a specific managed account.
-     */
-    async getManagedAccountDetails(accountId: string): Promise<ManagedAccount> {
-      try {
-        return await this.makeRequest<ManagedAccount>('GET', `/managed-accounts/${accountId}`, undefined, {
-          cache: true,
-          cacheTTL: 2 * 60 * 1000,
-        });
-      } catch (error) {
-        throw this.handleError(error);
-      }
-    }
-
-    /**
-     * Update a managed account's profile data.
-     * Requires owner or admin role.
-     *
-     * Invalidates both the cached detail (`GET /managed-accounts/<id>`) and the
-     * cached list (`GET /managed-accounts`, which embeds account profile data)
-     * so neither serves the pre-update snapshot within their ~2-minute TTL.
-     */
-    async updateManagedAccount(accountId: string, data: Partial<CreateManagedAccountInput>): Promise<ManagedAccount> {
-      try {
-        const result = await this.makeRequest<ManagedAccount>('PUT', `/managed-accounts/${accountId}`, data, {
-          cache: false,
-        });
-        this.clearCacheEntry(`GET:/managed-accounts/${accountId}`);
-        this.clearCacheEntry('GET:/managed-accounts');
-        return result;
-      } catch (error) {
-        throw this.handleError(error);
-      }
-    }
-
-    /**
-     * Delete a managed account permanently.
-     * Requires owner role.
-     *
-     * Invalidates the cached detail and list responses so the deleted account
-     * is not served from cache.
-     */
-    async deleteManagedAccount(accountId: string): Promise<void> {
-      try {
-        await this.makeRequest<void>('DELETE', `/managed-accounts/${accountId}`, undefined, {
-          cache: false,
-        });
-        this.clearCacheEntry(`GET:/managed-accounts/${accountId}`);
-        this.clearCacheEntry('GET:/managed-accounts');
-      } catch (error) {
-        throw this.handleError(error);
-      }
-    }
-
-    /**
-     * Add a manager to a managed account.
-     * Requires owner or admin role on the account.
-     *
-     * Mutates the account's `managers[]`, which is returned by the detail and
-     * list reads — invalidate both so they re-fetch the updated manager set.
-     *
-     * @param accountId - The managed account to add the manager to
-     * @param userId - The user to grant management access
-     * @param role - The role to assign: 'admin' or 'editor'
-     */
-    async addManager(accountId: string, userId: string, role: 'admin' | 'editor'): Promise<void> {
-      try {
-        await this.makeRequest<void>('POST', `/managed-accounts/${accountId}/managers`, { userId, role }, {
-          cache: false,
-        });
-        this.clearCacheEntry(`GET:/managed-accounts/${accountId}`);
-        this.clearCacheEntry('GET:/managed-accounts');
-      } catch (error) {
-        throw this.handleError(error);
-      }
-    }
-
-    /**
-     * Remove a manager from a managed account.
-     * Requires owner role.
-     *
-     * Invalidates the detail and list responses so the updated `managers[]`
-     * is observed on the next read (see `addManager`).
-     *
-     * @param accountId - The managed account
-     * @param userId - The manager to remove
-     */
-    async removeManager(accountId: string, userId: string): Promise<void> {
-      try {
-        await this.makeRequest<void>('DELETE', `/managed-accounts/${accountId}/managers/${userId}`, undefined, {
-          cache: false,
-        });
-        this.clearCacheEntry(`GET:/managed-accounts/${accountId}`);
-        this.clearCacheEntry('GET:/managed-accounts');
-      } catch (error) {
-        throw this.handleError(error);
-      }
-    }
-  };
-}

package/src/mixins/OxyServices.workspaces.ts

@@ -1,351 +0,0 @@
-/**
- * Workspaces Methods Mixin
- *
- * Provides methods for managing Oxy workspaces and their members via the
- * `/workspaces` API. A workspace is a multi-user container that owns
- * applications and other resources: membership (with a role) grants
- * permissions. A `personal` workspace is created implicitly for every user;
- * `team` workspaces are created explicitly and can invite additional members.
- *
- * Reference workspaces by their Mongo `_id` and members by their member `_id`.
- * Never by name or slug.
- */
-import type { OxyServicesBase } from '../OxyServices.base';
-import { CACHE_TIMES } from './mixinHelpers';
-
-/** Role a member holds within a workspace. */
-export type WorkspaceRole = 'owner' | 'admin' | 'member' | 'viewer';
-
-/** Workspace classification. A `personal` workspace is implicit per user. */
-export type WorkspaceType = 'personal' | 'team';
-
-/** Lifecycle status of a workspace. */
-export type WorkspaceStatus = 'active' | 'deleted';
-
-/** Membership lifecycle status. */
-export type WorkspaceMemberStatus = 'active' | 'invited' | 'removed';
-
-/**
- * Client-facing WorkspaceMember shape. `permissions` is derived from `role`
- * on the server at write time.
- */
-export interface WorkspaceMember {
-  _id: string;
-  workspaceId: string;
-  userId: string;
-  role: WorkspaceRole;
-  permissions: string[];
-  invitedByUserId?: string | null;
-  joinedAt?: string | null;
-  status: WorkspaceMemberStatus;
-  createdAt: string;
-  updatedAt: string;
-}
-
-/**
- * Client-facing Workspace shape returned by the `/workspaces` API. Mirrors the
- * server `Workspace` model with `_id` as a string and dates serialized to ISO
- * strings.
- */
-export interface Workspace {
-  _id: string;
-  name: string;
-  slug: string;
-  type: WorkspaceType;
-  description?: string | null;
-  icon?: string | null;
-  ownerId: string;
-  status: WorkspaceStatus;
-  createdAt: string;
-  updatedAt: string;
-  /**
-   * The calling user's own membership in this workspace, embedded by the API
-   * on list (`GET /workspaces`) and detail (`GET /workspaces/:id`) responses.
-   * Use `callerMembership.permissions` to gate UI affordances.
-   */
-  callerMembership?: WorkspaceMember | null;
-}
-
-/** Input accepted by `createWorkspace`. */
-export interface CreateWorkspaceInput {
-  name: string;
-  description?: string;
-  icon?: string;
-}
-
-/** Input accepted by `updateWorkspace`. */
-export interface UpdateWorkspaceInput {
-  name?: string;
-  description?: string | null;
-  icon?: string | null;
-}
-
-/** Input accepted by `inviteWorkspaceMember`. The owner role cannot be invited. */
-export interface InviteWorkspaceMemberInput {
-  /**
-   * The username or email of the user to invite. Resolved to a user server-side;
-   * an unknown value yields a 404 "User not found".
-   */
-  usernameOrEmail: string;
-  role: Exclude<WorkspaceRole, 'owner'>;
-}
-
-/** Input accepted by `updateWorkspaceMember`. The owner role cannot be assigned. */
-export interface UpdateWorkspaceMemberInput {
-  role: Exclude<WorkspaceRole, 'owner'>;
-}
-
-/** Input accepted by `transferWorkspaceOwnership`. */
-export interface TransferWorkspaceOwnershipInput {
-  userId: string;
-}
-
-/** Result of a delete/remove/transfer operation. */
-export interface WorkspaceSuccessResult {
-  success: boolean;
-}
-
-export function OxyServicesWorkspacesMixin<T extends typeof OxyServicesBase>(Base: T) {
-  return class extends Base {
-    constructor(...args: any[]) {
-      super(...(args as [any]));
-    }
-
-    /**
-     * List workspaces the current user is an active member of.
-     */
-    async getWorkspaces(): Promise<Workspace[]> {
-      try {
-        const res = await this.makeRequest<{ workspaces?: Workspace[] }>(
-          'GET',
-          '/workspaces',
-          undefined,
-          { cache: true, cacheTTL: CACHE_TIMES.MEDIUM },
-        );
-        return res.workspaces ?? [];
-      } catch (error) {
-        throw this.handleError(error);
-      }
-    }
-
-    /**
-     * Create a new team workspace. The caller becomes its `owner`.
-     * @param data - Workspace configuration.
-     */
-    async createWorkspace(data: CreateWorkspaceInput): Promise<Workspace> {
-      try {
-        const res = await this.makeRequest<{ workspace: Workspace }>(
-          'POST',
-          '/workspaces',
-          data,
-          { cache: false },
-        );
-        // Bust the cached workspace list so the new workspace appears on the
-        // next `getWorkspaces()` read within the TTL window.
-        this.clearCacheEntry('GET:/workspaces');
-        return res.workspace;
-      } catch (error) {
-        throw this.handleError(error);
-      }
-    }
-
-    /**
-     * Fetch a single workspace by id.
-     * @param workspaceId - The workspace's Mongo `_id`.
-     */
-    async getWorkspace(workspaceId: string): Promise<Workspace> {
-      try {
-        const res = await this.makeRequest<{ workspace: Workspace }>(
-          'GET',
-          `/workspaces/${encodeURIComponent(workspaceId)}`,
-          undefined,
-          { cache: true, cacheTTL: CACHE_TIMES.LONG },
-        );
-        return res.workspace;
-      } catch (error) {
-        throw this.handleError(error);
-      }
-    }
-
-    /**
-     * Update a workspace's mutable fields.
-     * @param workspaceId - The workspace's Mongo `_id`.
-     * @param data - Subset of updatable fields.
-     */
-    async updateWorkspace(
-      workspaceId: string,
-      data: UpdateWorkspaceInput,
-    ): Promise<Workspace> {
-      try {
-        const res = await this.makeRequest<{ workspace: Workspace }>(
-          'PATCH',
-          `/workspaces/${encodeURIComponent(workspaceId)}`,
-          data,
-          { cache: false },
-        );
-        // Bust the cached detail and list — both surface workspace fields.
-        this.clearCacheEntry(`GET:/workspaces/${encodeURIComponent(workspaceId)}`);
-        this.clearCacheEntry('GET:/workspaces');
-        return res.workspace;
-      } catch (error) {
-        throw this.handleError(error);
-      }
-    }
-
-    /**
-     * Soft-delete a workspace (owner only).
-     * @param workspaceId - The workspace's Mongo `_id`.
-     */
-    async deleteWorkspace(workspaceId: string): Promise<WorkspaceSuccessResult> {
-      try {
-        const result = await this.makeRequest<WorkspaceSuccessResult>(
-          'DELETE',
-          `/workspaces/${encodeURIComponent(workspaceId)}`,
-          undefined,
-          { cache: false },
-        );
-        // Bust every cached representation of the deleted workspace.
-        this.clearCacheEntry(`GET:/workspaces/${encodeURIComponent(workspaceId)}`);
-        this.clearCacheEntry(`GET:/workspaces/${encodeURIComponent(workspaceId)}/members`);
-        this.clearCacheEntry('GET:/workspaces');
-        return result;
-      } catch (error) {
-        throw this.handleError(error);
-      }
-    }
-
-    /**
-     * List members of a workspace.
-     * @param workspaceId - The workspace's Mongo `_id`.
-     */
-    async getWorkspaceMembers(workspaceId: string): Promise<WorkspaceMember[]> {
-      try {
-        const res = await this.makeRequest<{ members?: WorkspaceMember[] }>(
-          'GET',
-          `/workspaces/${encodeURIComponent(workspaceId)}/members`,
-          undefined,
-          { cache: true, cacheTTL: CACHE_TIMES.MEDIUM },
-        );
-        return res.members ?? [];
-      } catch (error) {
-        throw this.handleError(error);
-      }
-    }
-
-    /**
-     * Add a member to a workspace.
-     * @param workspaceId - The workspace's Mongo `_id`.
-     * @param data - Target user's username or email and role (never `owner`).
-     *   The server resolves `usernameOrEmail` to a user; an unknown value yields
-     *   a 404 "User not found".
-     */
-    async inviteWorkspaceMember(
-      workspaceId: string,
-      data: InviteWorkspaceMemberInput,
-    ): Promise<WorkspaceMember> {
-      try {
-        const res = await this.makeRequest<{ member: WorkspaceMember }>(
-          'POST',
-          `/workspaces/${encodeURIComponent(workspaceId)}/members`,
-          data,
-          { cache: false },
-        );
-        this._invalidateWorkspaceMembership(workspaceId);
-        return res.member;
-      } catch (error) {
-        throw this.handleError(error);
-      }
-    }
-
-    /**
-     * Change a member's role.
-     * @param workspaceId - The workspace's Mongo `_id`.
-     * @param memberId - The member's Mongo `_id`.
-     * @param data - New role (never `owner`).
-     */
-    async updateWorkspaceMember(
-      workspaceId: string,
-      memberId: string,
-      data: UpdateWorkspaceMemberInput,
-    ): Promise<WorkspaceMember> {
-      try {
-        const res = await this.makeRequest<{ member: WorkspaceMember }>(
-          'PATCH',
-          `/workspaces/${encodeURIComponent(workspaceId)}/members/${encodeURIComponent(memberId)}`,
-          data,
-          { cache: false },
-        );
-        this._invalidateWorkspaceMembership(workspaceId);
-        return res.member;
-      } catch (error) {
-        throw this.handleError(error);
-      }
-    }
-
-    /**
-     * Remove a member from a workspace.
-     * @param workspaceId - The workspace's Mongo `_id`.
-     * @param memberId - The member's Mongo `_id`.
-     */
-    async removeWorkspaceMember(
-      workspaceId: string,
-      memberId: string,
-    ): Promise<WorkspaceSuccessResult> {
-      try {
-        const result = await this.makeRequest<WorkspaceSuccessResult>(
-          'DELETE',
-          `/workspaces/${encodeURIComponent(workspaceId)}/members/${encodeURIComponent(memberId)}`,
-          undefined,
-          { cache: false },
-        );
-        this._invalidateWorkspaceMembership(workspaceId);
-        return result;
-      } catch (error) {
-        throw this.handleError(error);
-      }
-    }
-
-    /**
-     * Transfer ownership of a workspace to another member (owner only).
-     * Demotes the current owner and promotes the target to `owner`.
-     * @param workspaceId - The workspace's Mongo `_id`.
-     * @param data - Target user id.
-     */
-    async transferWorkspaceOwnership(
-      workspaceId: string,
-      data: TransferWorkspaceOwnershipInput,
-    ): Promise<WorkspaceSuccessResult> {
-      try {
-        const result = await this.makeRequest<WorkspaceSuccessResult>(
-          'POST',
-          `/workspaces/${encodeURIComponent(workspaceId)}/transfer-ownership`,
-          data,
-          { cache: false },
-        );
-        // Ownership change alters roles in the member list AND the detail, and
-        // can change which workspaces the caller "owns" in the list view.
-        this._invalidateWorkspaceMembership(workspaceId);
-        this.clearCacheEntry('GET:/workspaces');
-        return result;
-      } catch (error) {
-        throw this.handleError(error);
-      }
-    }
-
-    /**
-     * Bust the cached member list and detail for a workspace after a membership
-     * mutation. The member list (`getWorkspaceMembers`) and the detail
-     * (`getWorkspace`, which can embed member counts) both go stale when the
-     * member set or a member's role changes.
-     *
-     * Internal helper (leading underscore); not part of the supported public
-     * surface. Public rather than `private` because mixins compose into an
-     * exported anonymous class, where TypeScript cannot represent a private
-     * member in the emitted declaration file (TS4094).
-     */
-    _invalidateWorkspaceMembership(workspaceId: string): void {
-      this.clearCacheEntry(`GET:/workspaces/${encodeURIComponent(workspaceId)}/members`);
-      this.clearCacheEntry(`GET:/workspaces/${encodeURIComponent(workspaceId)}`);
-    }
-  };
-}