@doist/comms-sdk 0.0.1 → 0.2.0

package/dist/types/testUtils/obsidian-fetch-adapter.d.ts

@@ -0,0 +1,29 @@
+import type { RequestUrlParam, RequestUrlResponse } from 'obsidian';
+import type { CustomFetch } from '../types/http.js';
+/**
+ * Creates a CustomFetch adapter for Obsidian's requestUrl API.
+ *
+ * This adapter bridges the gap between Obsidian's requestUrl interface and the
+ * standard fetch-like interface expected by the Comms API SDK.
+ *
+ * Key differences handled by this adapter:
+ * - Obsidian returns response data as properties (response.json, response.text)
+ *   while the SDK expects methods (response.json(), response.text())
+ * - Obsidian's requestUrl bypasses CORS restrictions that would block standard fetch
+ * - Obsidian throws on HTTP errors by default; we set throw: false to handle manually
+ * - Obsidian doesn't provide statusText; we default to empty string
+ *
+ * @example
+ * ```typescript
+ * import { requestUrl } from 'obsidian'
+ * import { createObsidianFetchAdapter } from './obsidian-fetch-adapter.js'
+ *
+ * const api = new CommsApi('your-token', {
+ *   customFetch: createObsidianFetchAdapter(requestUrl)
+ * })
+ * ```
+ *
+ * @param requestUrl - The Obsidian requestUrl function
+ * @returns A CustomFetch function compatible with the Comms API SDK
+ */
+export declare function createObsidianFetchAdapter(requestUrl: (request: RequestUrlParam | string) => Promise<RequestUrlResponse>): CustomFetch;

package/dist/types/testUtils/test-defaults.d.ts

@@ -0,0 +1,17 @@
+import type { Channel, Comment, Conversation, Group, Thread, User, Workspace, WorkspaceUser } from '../types/entities.js';
+export declare const TEST_API_TOKEN = "test-api-token";
+export declare const TEST_API_BASE_URL: string;
+export declare const TEST_CHANNEL_ID = "7YpL3oZ4kZ9vP7Q1tR2sX3y";
+export declare const TEST_THREAD_ID = "7YpL3oZ4kZ9vP7Q1tR2sX3z";
+export declare const TEST_COMMENT_ID = "7YpL3oZ4kZ9vP7Q1tR2sX41";
+export declare const TEST_CONVERSATION_ID = "7YpL3oZ4kZ9vP7Q1tR2sX42";
+export declare const TEST_MESSAGE_ID = "7YpL3oZ4kZ9vP7Q1tR2sX43";
+export declare const TEST_GROUP_ID = "7YpL3oZ4kZ9vP7Q1tR2sX44";
+export declare const mockUser: User;
+export declare const mockWorkspace: Workspace;
+export declare const mockChannel: Channel;
+export declare const mockThread: Thread;
+export declare const mockGroup: Group;
+export declare const mockConversation: Conversation;
+export declare const mockComment: Comment;
+export declare const mockWorkspaceUser: WorkspaceUser;

package/dist/types/transport/fetch-with-retry.d.ts

@@ -0,0 +1,4 @@
+import type { CustomFetch, HttpResponse } from '../types/http.js';
+export declare function fetchWithRetry<T>(url: string, options: RequestInit & {
+    timeout?: number;
+}, maxRetries?: number, customFetch?: CustomFetch): Promise<HttpResponse<T>>;

package/dist/types/transport/http-client.d.ts

@@ -0,0 +1,13 @@
+import type { CustomFetch, HttpMethod, HttpResponse } from '../types/http.js';
+export declare function paramsSerializer(params: Record<string, unknown>): string;
+export type RequestArgs = {
+    httpMethod: HttpMethod;
+    baseUri: string;
+    relativePath: string;
+    apiToken?: string;
+    payload?: Record<string, unknown>;
+    requestId?: string;
+    customFetch?: CustomFetch;
+};
+export declare function request<T>(args: RequestArgs): Promise<HttpResponse<T>>;
+export declare function isSuccess(response: HttpResponse): boolean;

package/dist/types/transport/http-dispatcher.d.ts

@@ -0,0 +1,10 @@
+import type { Dispatcher } from 'undici';
+export declare function getDefaultDispatcher(): Promise<Dispatcher | undefined>;
+/**
+ * Drains the default dispatcher's connection pool. CLIs and scripts should
+ * `await` this before exit so Node's event loop empties immediately instead
+ * of waiting ~4s on keep-alive. No-op in the browser branch.
+ */
+export declare function closeDefaultDispatcher(): Promise<void>;
+export declare function resetDefaultDispatcherForTests(): void;
+export declare function suppressExperimentalWarningsSync<T>(fn: () => T): T;

package/dist/types/types/api-version.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Supported Comms API versions
+ */
+export declare const API_VERSIONS: readonly ["v1"];
+export type ApiVersion = (typeof API_VERSIONS)[number];
+export declare const DEFAULT_API_VERSION: ApiVersion;