@myco-dev/sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,253 @@
+import * as better_auth from 'better-auth';
+import * as _better_fetch_fetch from '@better-fetch/fetch';
+import { M as MycoSDKConfig, W as Workspace, a as WorkspaceMember, G as GetRecordsOptions, E as Entity, P as PaginatedResponse, b as EntityRecord } from './types-D2J6kXGR.js';
+export { c as EntityField, J as JoinResponse, V as VerifiedUser } from './types-D2J6kXGR.js';
+import * as swr from 'swr';
+import { SWRResponse } from 'swr';
+
+/**
+ * Create auth namespace bound to the given config.
+ * Only exposes federated login - no direct sign-in/sign-up.
+ */
+declare function createAuth(config: MycoSDKConfig): {
+    /**
+     * Redirect to the federated login page.
+     * @param returnTo - URL to return to after login (defaults to current page)
+     */
+    login(returnTo?: string): void;
+    /**
+     * Sign out the current user and clear session.
+     */
+    logout(): Promise<void>;
+    /**
+     * Get the current session (React hook).
+     * Returns { data: session, isPending, error, refetch }
+     */
+    useSession: () => {
+        data: {
+            user: {
+                id: string;
+                createdAt: Date;
+                updatedAt: Date;
+                email: string;
+                emailVerified: boolean;
+                name: string;
+                image?: string | null | undefined;
+            };
+            session: {
+                id: string;
+                createdAt: Date;
+                updatedAt: Date;
+                userId: string;
+                expiresAt: Date;
+                token: string;
+                ipAddress?: string | null | undefined;
+                userAgent?: string | null | undefined;
+            };
+        } | null;
+        isPending: boolean;
+        isRefetching: boolean;
+        error: _better_fetch_fetch.BetterFetchError | null;
+        refetch: (queryParams?: {
+            query?: better_auth.SessionQueryParams;
+        } | undefined) => Promise<void>;
+    };
+    /**
+     * Get session data (non-hook version for use outside React components).
+     */
+    getSession: () => Promise<{
+        data: {
+            user: {
+                id: string;
+                createdAt: Date;
+                updatedAt: Date;
+                email: string;
+                emailVerified: boolean;
+                name: string;
+                image?: string | null | undefined;
+            };
+            session: {
+                id: string;
+                createdAt: Date;
+                updatedAt: Date;
+                userId: string;
+                expiresAt: Date;
+                token: string;
+                ipAddress?: string | null | undefined;
+                userAgent?: string | null | undefined;
+            };
+        } | null;
+        error: null;
+    } | {
+        data: null;
+        error: {
+            code?: string | undefined | undefined;
+            message?: string | undefined | undefined;
+            status: number;
+            statusText: string;
+        };
+    }>;
+};
+
+type ApiRequest$1 = <T>(path: string, options?: RequestInit) => Promise<T>;
+/**
+ * Create workspaces namespace bound to the given config and API client.
+ */
+declare function createWorkspaces(getConfig: () => MycoSDKConfig, setWorkspaceId: (id: string) => void, apiRequest: ApiRequest$1, ensureWorkspace: () => Promise<void>): {
+    /**
+     * Ensure a workspace is set up for the current user.
+     * Called automatically during SDK initialization.
+     * Call manually after login if redirectOnUnauth was false.
+     */
+    ensure: () => Promise<void>;
+    /**
+     * List all workspaces the current user has access to.
+     */
+    list(): Promise<Workspace[]>;
+    /**
+     * Get the current workspace details.
+     */
+    current(): Promise<Workspace>;
+    /**
+     * Switch to a different workspace.
+     */
+    switch(workspaceId: string): void;
+    /**
+     * Create a new workspace.
+     */
+    create(name: string): Promise<Workspace>;
+    /**
+     * Update the current workspace.
+     */
+    update(data: {
+        name?: string;
+    }): Promise<Workspace>;
+    /**
+     * Delete the current workspace.
+     */
+    delete(): Promise<void>;
+    /**
+     * Get members of the current workspace.
+     */
+    getMembers(): Promise<WorkspaceMember[]>;
+    /**
+     * Add a member to the current workspace.
+     */
+    addMember(userId: string, role?: "admin" | "member"): Promise<WorkspaceMember>;
+    /**
+     * Remove a member from the current workspace.
+     */
+    removeMember(userId: string): Promise<void>;
+};
+
+interface UseRecordsOptions extends Omit<GetRecordsOptions, "page"> {
+    initialPage?: number;
+    onPageChange?: (page: number) => void;
+}
+interface UseRecordsResult<T> extends SWRResponse<T[]> {
+    page: number;
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+    nextPage: () => void;
+    previousPage: () => void;
+    setPage: (page: number) => void;
+}
+
+type ApiRequest = <T>(path: string, options?: RequestInit) => Promise<T>;
+/**
+ * Helper type that wraps entity data with record metadata.
+ */
+type TypedEntityRecord<T> = Omit<EntityRecord, "data"> & {
+    data: T;
+};
+/**
+ * Create data namespace bound to the given API client.
+ * Accepts a generic type parameter for entity type mapping.
+ */
+declare function createData<TEntities extends Record<string, unknown>>(apiRequest: ApiRequest): {
+    /**
+     * Get all entities for the current app.
+     */
+    getEntities(): Promise<Entity[]>;
+    /**
+     * Get a single entity by slug.
+     */
+    getEntity<K extends keyof TEntities & string>(entitySlug: K): Promise<Entity>;
+    /**
+     * Get records for an entity.
+     */
+    getRecords<K extends keyof TEntities & string>(entitySlug: K, options?: GetRecordsOptions): Promise<PaginatedResponse<TypedEntityRecord<TEntities[K]>>>;
+    /**
+     * Get a single record by ID.
+     */
+    getRecord<K extends keyof TEntities & string>(entitySlug: K, recordId: string): Promise<TypedEntityRecord<TEntities[K]>>;
+    /**
+     * Create a new record.
+     */
+    createRecord<K extends keyof TEntities & string>(entitySlug: K, data: TEntities[K]): Promise<TypedEntityRecord<TEntities[K]>>;
+    /**
+     * Update an existing record.
+     */
+    updateRecord<K extends keyof TEntities & string>(entitySlug: K, recordId: string, data: Partial<TEntities[K]>): Promise<TypedEntityRecord<TEntities[K]>>;
+    /**
+     * Delete a record.
+     */
+    deleteRecord<K extends keyof TEntities & string>(entitySlug: K, recordId: string): Promise<void>;
+    /**
+     * Batch get multiple records by IDs.
+     */
+    batchGetRecords<K extends keyof TEntities & string>(entitySlug: K, ids: string[]): Promise<TypedEntityRecord<TEntities[K]>[]>;
+    useRecords<K extends keyof TEntities & string>(entitySlug: K | null | undefined, options?: UseRecordsOptions): UseRecordsResult<TypedEntityRecord<TEntities[K]>>;
+    useRecord<K extends keyof TEntities & string>(entitySlug: K | null | undefined, recordId: string | null | undefined): swr.SWRResponse<TypedEntityRecord<TEntities[K]>, any, any>;
+};
+type Data<TEntities extends Record<string, unknown>> = ReturnType<typeof createData<TEntities>>;
+
+/**
+ * Custom error class for API errors.
+ */
+declare class ApiError extends Error {
+    status: number;
+    body: string;
+    path: string;
+    constructor(status: number, body: string, path: string);
+}
+
+/**
+ * Additional options for createMycoSDK.
+ */
+interface MycoSDKOptions {
+    /** Base URL override (optional) */
+    baseUrl?: string;
+    /** If true, redirect to login when not authenticated (default: true) */
+    redirectOnUnauth?: boolean;
+}
+interface MycoSDKInstance<TEntities extends Record<string, unknown>> {
+    /** Promise that resolves when the SDK is fully initialized (workspace ready) */
+    readonly ready: Promise<void>;
+    /** Auth namespace - login, logout, session management */
+    auth: ReturnType<typeof createAuth>;
+    /** Workspaces namespace - manage user workspaces */
+    workspaces: ReturnType<typeof createWorkspaces>;
+    /** Data namespace - entity records CRUD */
+    data: Data<TEntities>;
+}
+/**
+ * Create a MycoSDK instance.
+ *
+ * @param appKey - The app key (required)
+ * @param options - Additional options
+ *
+ * @example
+ * ```typescript
+ * import { createMycoSDK } from '@myco/sdk';
+ * import type { EntityTypes } from './types/myco.generated';
+ *
+ * const myco = createMycoSDK<EntityTypes>("realestate");
+ *
+ * // All API calls automatically wait for SDK to be ready
+ * const records = await myco.data.getRecords('property');
+ * ```
+ */
+declare function createMycoSDK<TEntities extends Record<string, unknown>>(appKey: string, options?: MycoSDKOptions): MycoSDKInstance<TEntities>;
+
+export { ApiError, Entity, EntityRecord, GetRecordsOptions, MycoSDKConfig, type MycoSDKInstance, type MycoSDKOptions, PaginatedResponse, type TypedEntityRecord, Workspace, WorkspaceMember, createMycoSDK };