@oxyhq/core 3.18.0 → 4.0.0

package/dist/types/mixins/OxyServices.managedAccounts.d.ts

@@ -1,145 +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 declare function OxyServicesManagedAccountsMixin<T extends typeof OxyServicesBase>(Base: T): {
-    new (...args: 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.
-         */
-        createManagedAccount(data: CreateManagedAccountInput): Promise<ManagedAccount>;
-        /**
-         * List all accounts the authenticated user manages.
-         */
-        getManagedAccounts(): Promise<ManagedAccount[]>;
-        /**
-         * Get details for a specific managed account.
-         */
-        getManagedAccountDetails(accountId: string): Promise<ManagedAccount>;
-        /**
-         * 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.
-         */
-        updateManagedAccount(accountId: string, data: Partial<CreateManagedAccountInput>): Promise<ManagedAccount>;
-        /**
-         * Delete a managed account permanently.
-         * Requires owner role.
-         *
-         * Invalidates the cached detail and list responses so the deleted account
-         * is not served from cache.
-         */
-        deleteManagedAccount(accountId: string): Promise<void>;
-        /**
-         * 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'
-         */
-        addManager(accountId: string, userId: string, role: "admin" | "editor"): Promise<void>;
-        /**
-         * 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
-         */
-        removeManager(accountId: string, userId: string): Promise<void>;
-        httpService: import("../HttpService").HttpService;
-        cloudURL: string;
-        config: import("../OxyServices.base").OxyConfig;
-        __resetTokensForTests(): void;
-        makeRequest<T_1>(method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE", url: string, data?: any, options?: import("../HttpService").RequestOptions): Promise<T_1>;
-        getBaseURL(): string;
-        getSessionBaseUrl(): string;
-        getClient(): import("../HttpService").HttpService;
-        createLinkedClient(config: import("../OxyServices.base").OxyConfig): import("..").LinkedHttpClient;
-        getMetrics(): {
-            totalRequests: number;
-            successfulRequests: number;
-            failedRequests: number;
-            cacheHits: number;
-            cacheMisses: number;
-            averageResponseTime: number;
-        };
-        clearCache(): void;
-        clearCacheEntry(key: string): void;
-        clearCacheByPrefix(prefix: string): number;
-        getCacheStats(): {
-            size: number;
-            hits: number;
-            misses: number;
-            hitRate: number;
-        };
-        getCloudURL(): string;
-        setTokens(accessToken: string): void;
-        clearTokens(): void;
-        onTokensChanged(listener: (accessToken: string | null) => void): () => void;
-        _cachedUserId: string | null | undefined;
-        _cachedAccessToken: string | null;
-        getCurrentUserId(): string | null;
-        hasValidToken(): boolean;
-        getAccessToken(): string | null;
-        getAccessTokenExpiry(): number | null;
-        setActingAs(userId: string | null): void;
-        getActingAs(): string | null;
-        waitForAuth(timeoutMs?: number): Promise<boolean>;
-        withAuthRetry<T_1>(operation: () => Promise<T_1>, operationName: string, options?: {
-            maxRetries?: number;
-            retryDelay?: number;
-            authTimeoutMs?: number;
-        }): Promise<T_1>;
-        validate(): Promise<boolean>;
-        handleError(error: unknown): Error;
-        healthCheck(): Promise<{
-            status: string;
-            users?: number;
-            timestamp?: string;
-            [key: string]: any;
-        }>;
-    };
-} & T;

package/dist/types/mixins/OxyServices.workspaces.d.ts

@@ -1,219 +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';
-/** 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 declare function OxyServicesWorkspacesMixin<T extends typeof OxyServicesBase>(Base: T): {
-    new (...args: any[]): {
-        /**
-         * List workspaces the current user is an active member of.
-         */
-        getWorkspaces(): Promise<Workspace[]>;
-        /**
-         * Create a new team workspace. The caller becomes its `owner`.
-         * @param data - Workspace configuration.
-         */
-        createWorkspace(data: CreateWorkspaceInput): Promise<Workspace>;
-        /**
-         * Fetch a single workspace by id.
-         * @param workspaceId - The workspace's Mongo `_id`.
-         */
-        getWorkspace(workspaceId: string): Promise<Workspace>;
-        /**
-         * Update a workspace's mutable fields.
-         * @param workspaceId - The workspace's Mongo `_id`.
-         * @param data - Subset of updatable fields.
-         */
-        updateWorkspace(workspaceId: string, data: UpdateWorkspaceInput): Promise<Workspace>;
-        /**
-         * Soft-delete a workspace (owner only).
-         * @param workspaceId - The workspace's Mongo `_id`.
-         */
-        deleteWorkspace(workspaceId: string): Promise<WorkspaceSuccessResult>;
-        /**
-         * List members of a workspace.
-         * @param workspaceId - The workspace's Mongo `_id`.
-         */
-        getWorkspaceMembers(workspaceId: string): Promise<WorkspaceMember[]>;
-        /**
-         * 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".
-         */
-        inviteWorkspaceMember(workspaceId: string, data: InviteWorkspaceMemberInput): Promise<WorkspaceMember>;
-        /**
-         * 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`).
-         */
-        updateWorkspaceMember(workspaceId: string, memberId: string, data: UpdateWorkspaceMemberInput): Promise<WorkspaceMember>;
-        /**
-         * Remove a member from a workspace.
-         * @param workspaceId - The workspace's Mongo `_id`.
-         * @param memberId - The member's Mongo `_id`.
-         */
-        removeWorkspaceMember(workspaceId: string, memberId: string): Promise<WorkspaceSuccessResult>;
-        /**
-         * 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.
-         */
-        transferWorkspaceOwnership(workspaceId: string, data: TransferWorkspaceOwnershipInput): Promise<WorkspaceSuccessResult>;
-        /**
-         * 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;
-        httpService: import("../HttpService").HttpService;
-        cloudURL: string;
-        config: import("../OxyServices.base").OxyConfig;
-        __resetTokensForTests(): void;
-        makeRequest<T_1>(method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE", url: string, data?: any, options?: import("../HttpService").RequestOptions): Promise<T_1>;
-        getBaseURL(): string;
-        getSessionBaseUrl(): string;
-        getClient(): import("../HttpService").HttpService;
-        createLinkedClient(config: import("../OxyServices.base").OxyConfig): import("..").LinkedHttpClient;
-        getMetrics(): {
-            totalRequests: number;
-            successfulRequests: number;
-            failedRequests: number;
-            cacheHits: number;
-            cacheMisses: number;
-            averageResponseTime: number;
-        };
-        clearCache(): void;
-        clearCacheEntry(key: string): void;
-        clearCacheByPrefix(prefix: string): number;
-        getCacheStats(): {
-            size: number;
-            hits: number;
-            misses: number;
-            hitRate: number;
-        };
-        getCloudURL(): string;
-        setTokens(accessToken: string): void;
-        clearTokens(): void;
-        onTokensChanged(listener: (accessToken: string | null) => void): () => void;
-        _cachedUserId: string | null | undefined;
-        _cachedAccessToken: string | null;
-        getCurrentUserId(): string | null;
-        hasValidToken(): boolean;
-        getAccessToken(): string | null;
-        getAccessTokenExpiry(): number | null;
-        setActingAs(userId: string | null): void;
-        getActingAs(): string | null;
-        waitForAuth(timeoutMs?: number): Promise<boolean>;
-        withAuthRetry<T_1>(operation: () => Promise<T_1>, operationName: string, options?: {
-            maxRetries?: number;
-            retryDelay?: number;
-            authTimeoutMs?: number;
-        }): Promise<T_1>;
-        validate(): Promise<boolean>;
-        handleError(error: unknown): Error;
-        healthCheck(): Promise<{
-            status: string;
-            users?: number;
-            timestamp?: string;
-            [key: string]: any;
-        }>;
-    };
-} & T;