@noematicsllc/talk-sdk 0.0.2 → 0.1.0

package/dist/index.d.mts

@@ -2144,4 +2144,96 @@ declare class TalkClient {
     get host(): string;
 }
 
-export { ActorType, type AddParticipantOptions, type AddReactionOptions, BreakoutRoomMode, type CallNotificationSettings, CallResource, type ChatPollResult, ChatResource, ConversationType, type CreatePollOptions, type CreateRoomOptions, type DeletedMessageRef, HttpClient, type HttpClientConfig, HttpClientError, type HttpResponse, InCallFlag, type JoinCallOptions, type JoinRoomOptions, type LeaveCallOptions, type ListRoomsOptions, ListableScope, type LobbySettings, LobbyState, type MessageMetadata, type MessageReminder, MessageType, type NormalizedMessage, type NormalizedParticipant, type NormalizedRoom, NotificationLevel, type NotificationSettings, type OCSResponse, ParticipantResource, ParticipantType, Permission, type PermissionMethod, type PermissionMode, type PollMessagesOptions, PollResource, PollResultMode, type PollVote, type ReactionActor, ReactionResource, type ReactionsByEmoji, ReadOnlyState, type ReceiveMessagesOptions, RecordingStatus, type RequestOptions, type ResponseMeta, Room, RoomResource, type RoomResources, RoomsAccessor, SIPState, type ScheduleMessageOptions, type SendMessageOptions, type SessionConflict, type SessionState, type SetPermissionsOptions, type ShareObjectOptions, SharedObjectType, type SignalingSettings, type TalkCallPeer, type TalkChatMentionSuggestion, type TalkChatMessage, type TalkChatMessageWithParent, TalkClient, type TalkClientConfig, type TalkParticipant, type TalkPoll, type TalkRichObjectParameter, type TalkRoom, type UpdateCallFlagsOptions, type VotePollOptions, normalizeMessage, normalizeMessageWithParent, normalizeMessages, normalizeParticipant, normalizeParticipants, normalizeRoom, normalizeRooms };
+/**
+ * Browser Utilities for Nextcloud Talk SDK
+ *
+ * Provides utilities for running the SDK in browser environments,
+ * including CORS proxy support.
+ */
+/**
+ * Options for creating a proxy fetch function
+ */
+interface ProxyFetchOptions {
+    /**
+     * The base path for the proxy endpoint.
+     * Default: '/nextcloud-proxy'
+     *
+     * The proxy should accept URLs in the format:
+     * {proxyPath}/{protocol}/{host}/{path}
+     *
+     * Example: /nextcloud-proxy/https/nextcloud.example.com/ocs/v2.php/apps/spreed/api/v4/room
+     */
+    proxyPath?: string;
+}
+/**
+ * Creates a fetch function that routes requests through a CORS proxy.
+ *
+ * This is useful when running the SDK in a browser environment where
+ * direct requests to the Nextcloud server are blocked by CORS policy.
+ *
+ * The proxy transforms URLs like:
+ *   https://nextcloud.example.com/ocs/v2.php/apps/spreed/api/v4/room
+ * into:
+ *   /nextcloud-proxy/https/nextcloud.example.com/ocs/v2.php/apps/spreed/api/v4/room
+ *
+ * @param targetHost - The Nextcloud server URL (e.g., 'https://nextcloud.example.com')
+ * @param options - Optional configuration
+ * @returns A fetch function that proxies requests
+ *
+ * @example
+ * ```typescript
+ * import { TalkClient, createProxyFetch } from '@noematicsllc/talk-sdk';
+ *
+ * const client = new TalkClient({
+ *   host: 'https://nextcloud.example.com',
+ *   username: 'admin',
+ *   password: 'app-password',
+ *   fetch: createProxyFetch('https://nextcloud.example.com'),
+ * });
+ * ```
+ *
+ * @remarks
+ * You'll need to set up a proxy server that handles the `/nextcloud-proxy` endpoint.
+ * For Vite, you can use a plugin like this:
+ *
+ * ```typescript
+ * // vite.config.ts
+ * import { defineConfig } from 'vite';
+ * import http from 'http';
+ * import https from 'https';
+ *
+ * export default defineConfig({
+ *   plugins: [{
+ *     name: 'nextcloud-proxy',
+ *     configureServer(server) {
+ *       server.middlewares.use('/nextcloud-proxy', (req, res) => {
+ *         const match = req.url?.match(/^\/(https?)\/([\w.-]+(?::\d+)?)(\/.*)?$/);
+ *         if (!match) {
+ *           res.statusCode = 400;
+ *           res.end('Invalid proxy URL');
+ *           return;
+ *         }
+ *         const [, protocol, host, path = '/'] = match;
+ *         const httpModule = protocol === 'https' ? https : http;
+ *         const proxyReq = httpModule.request({
+ *           hostname: host.split(':')[0],
+ *           port: host.split(':')[1] || (protocol === 'https' ? 443 : 80),
+ *           path,
+ *           method: req.method,
+ *           headers: { ...req.headers, host },
+ *         }, (proxyRes) => {
+ *           res.statusCode = proxyRes.statusCode || 500;
+ *           Object.entries(proxyRes.headers).forEach(([k, v]) => v && res.setHeader(k, v));
+ *           proxyRes.pipe(res);
+ *         });
+ *         proxyReq.on('error', (e) => { res.statusCode = 502; res.end(e.message); });
+ *         req.pipe(proxyReq);
+ *       });
+ *     },
+ *   }],
+ * });
+ * ```
+ */
+declare function createProxyFetch(targetHost: string, options?: ProxyFetchOptions): typeof fetch;
+
+export { ActorType, type AddParticipantOptions, type AddReactionOptions, BreakoutRoomMode, type CallNotificationSettings, CallResource, type ChatPollResult, ChatResource, ConversationType, type CreatePollOptions, type CreateRoomOptions, type DeletedMessageRef, HttpClient, type HttpClientConfig, HttpClientError, type HttpResponse, InCallFlag, type JoinCallOptions, type JoinRoomOptions, type LeaveCallOptions, type ListRoomsOptions, ListableScope, type LobbySettings, LobbyState, type MessageMetadata, type MessageReminder, MessageType, type NormalizedMessage, type NormalizedParticipant, type NormalizedRoom, NotificationLevel, type NotificationSettings, type OCSResponse, ParticipantResource, ParticipantType, Permission, type PermissionMethod, type PermissionMode, type PollMessagesOptions, PollResource, PollResultMode, type PollVote, type ProxyFetchOptions, type ReactionActor, ReactionResource, type ReactionsByEmoji, ReadOnlyState, type ReceiveMessagesOptions, RecordingStatus, type RequestOptions, type ResponseMeta, Room, RoomResource, type RoomResources, RoomsAccessor, SIPState, type ScheduleMessageOptions, type SendMessageOptions, type SessionConflict, type SessionState, type SetPermissionsOptions, type ShareObjectOptions, SharedObjectType, type SignalingSettings, type TalkCallPeer, type TalkChatMentionSuggestion, type TalkChatMessage, type TalkChatMessageWithParent, TalkClient, type TalkClientConfig, type TalkParticipant, type TalkPoll, type TalkRichObjectParameter, type TalkRoom, type UpdateCallFlagsOptions, type VotePollOptions, createProxyFetch, normalizeMessage, normalizeMessageWithParent, normalizeMessages, normalizeParticipant, normalizeParticipants, normalizeRoom, normalizeRooms };

package/dist/index.d.ts

@@ -2144,4 +2144,96 @@ declare class TalkClient {
     get host(): string;
 }
 
-export { ActorType, type AddParticipantOptions, type AddReactionOptions, BreakoutRoomMode, type CallNotificationSettings, CallResource, type ChatPollResult, ChatResource, ConversationType, type CreatePollOptions, type CreateRoomOptions, type DeletedMessageRef, HttpClient, type HttpClientConfig, HttpClientError, type HttpResponse, InCallFlag, type JoinCallOptions, type JoinRoomOptions, type LeaveCallOptions, type ListRoomsOptions, ListableScope, type LobbySettings, LobbyState, type MessageMetadata, type MessageReminder, MessageType, type NormalizedMessage, type NormalizedParticipant, type NormalizedRoom, NotificationLevel, type NotificationSettings, type OCSResponse, ParticipantResource, ParticipantType, Permission, type PermissionMethod, type PermissionMode, type PollMessagesOptions, PollResource, PollResultMode, type PollVote, type ReactionActor, ReactionResource, type ReactionsByEmoji, ReadOnlyState, type ReceiveMessagesOptions, RecordingStatus, type RequestOptions, type ResponseMeta, Room, RoomResource, type RoomResources, RoomsAccessor, SIPState, type ScheduleMessageOptions, type SendMessageOptions, type SessionConflict, type SessionState, type SetPermissionsOptions, type ShareObjectOptions, SharedObjectType, type SignalingSettings, type TalkCallPeer, type TalkChatMentionSuggestion, type TalkChatMessage, type TalkChatMessageWithParent, TalkClient, type TalkClientConfig, type TalkParticipant, type TalkPoll, type TalkRichObjectParameter, type TalkRoom, type UpdateCallFlagsOptions, type VotePollOptions, normalizeMessage, normalizeMessageWithParent, normalizeMessages, normalizeParticipant, normalizeParticipants, normalizeRoom, normalizeRooms };
+/**
+ * Browser Utilities for Nextcloud Talk SDK
+ *
+ * Provides utilities for running the SDK in browser environments,
+ * including CORS proxy support.
+ */
+/**
+ * Options for creating a proxy fetch function
+ */
+interface ProxyFetchOptions {
+    /**
+     * The base path for the proxy endpoint.
+     * Default: '/nextcloud-proxy'
+     *
+     * The proxy should accept URLs in the format:
+     * {proxyPath}/{protocol}/{host}/{path}
+     *
+     * Example: /nextcloud-proxy/https/nextcloud.example.com/ocs/v2.php/apps/spreed/api/v4/room
+     */
+    proxyPath?: string;
+}
+/**
+ * Creates a fetch function that routes requests through a CORS proxy.
+ *
+ * This is useful when running the SDK in a browser environment where
+ * direct requests to the Nextcloud server are blocked by CORS policy.
+ *
+ * The proxy transforms URLs like:
+ *   https://nextcloud.example.com/ocs/v2.php/apps/spreed/api/v4/room
+ * into:
+ *   /nextcloud-proxy/https/nextcloud.example.com/ocs/v2.php/apps/spreed/api/v4/room
+ *
+ * @param targetHost - The Nextcloud server URL (e.g., 'https://nextcloud.example.com')
+ * @param options - Optional configuration
+ * @returns A fetch function that proxies requests
+ *
+ * @example
+ * ```typescript
+ * import { TalkClient, createProxyFetch } from '@noematicsllc/talk-sdk';
+ *
+ * const client = new TalkClient({
+ *   host: 'https://nextcloud.example.com',
+ *   username: 'admin',
+ *   password: 'app-password',
+ *   fetch: createProxyFetch('https://nextcloud.example.com'),
+ * });
+ * ```
+ *
+ * @remarks
+ * You'll need to set up a proxy server that handles the `/nextcloud-proxy` endpoint.
+ * For Vite, you can use a plugin like this:
+ *
+ * ```typescript
+ * // vite.config.ts
+ * import { defineConfig } from 'vite';
+ * import http from 'http';
+ * import https from 'https';
+ *
+ * export default defineConfig({
+ *   plugins: [{
+ *     name: 'nextcloud-proxy',
+ *     configureServer(server) {
+ *       server.middlewares.use('/nextcloud-proxy', (req, res) => {
+ *         const match = req.url?.match(/^\/(https?)\/([\w.-]+(?::\d+)?)(\/.*)?$/);
+ *         if (!match) {
+ *           res.statusCode = 400;
+ *           res.end('Invalid proxy URL');
+ *           return;
+ *         }
+ *         const [, protocol, host, path = '/'] = match;
+ *         const httpModule = protocol === 'https' ? https : http;
+ *         const proxyReq = httpModule.request({
+ *           hostname: host.split(':')[0],
+ *           port: host.split(':')[1] || (protocol === 'https' ? 443 : 80),
+ *           path,
+ *           method: req.method,
+ *           headers: { ...req.headers, host },
+ *         }, (proxyRes) => {
+ *           res.statusCode = proxyRes.statusCode || 500;
+ *           Object.entries(proxyRes.headers).forEach(([k, v]) => v && res.setHeader(k, v));
+ *           proxyRes.pipe(res);
+ *         });
+ *         proxyReq.on('error', (e) => { res.statusCode = 502; res.end(e.message); });
+ *         req.pipe(proxyReq);
+ *       });
+ *     },
+ *   }],
+ * });
+ * ```
+ */
+declare function createProxyFetch(targetHost: string, options?: ProxyFetchOptions): typeof fetch;
+
+export { ActorType, type AddParticipantOptions, type AddReactionOptions, BreakoutRoomMode, type CallNotificationSettings, CallResource, type ChatPollResult, ChatResource, ConversationType, type CreatePollOptions, type CreateRoomOptions, type DeletedMessageRef, HttpClient, type HttpClientConfig, HttpClientError, type HttpResponse, InCallFlag, type JoinCallOptions, type JoinRoomOptions, type LeaveCallOptions, type ListRoomsOptions, ListableScope, type LobbySettings, LobbyState, type MessageMetadata, type MessageReminder, MessageType, type NormalizedMessage, type NormalizedParticipant, type NormalizedRoom, NotificationLevel, type NotificationSettings, type OCSResponse, ParticipantResource, ParticipantType, Permission, type PermissionMethod, type PermissionMode, type PollMessagesOptions, PollResource, PollResultMode, type PollVote, type ProxyFetchOptions, type ReactionActor, ReactionResource, type ReactionsByEmoji, ReadOnlyState, type ReceiveMessagesOptions, RecordingStatus, type RequestOptions, type ResponseMeta, Room, RoomResource, type RoomResources, RoomsAccessor, SIPState, type ScheduleMessageOptions, type SendMessageOptions, type SessionConflict, type SessionState, type SetPermissionsOptions, type ShareObjectOptions, SharedObjectType, type SignalingSettings, type TalkCallPeer, type TalkChatMentionSuggestion, type TalkChatMessage, type TalkChatMessageWithParent, TalkClient, type TalkClientConfig, type TalkParticipant, type TalkPoll, type TalkRichObjectParameter, type TalkRoom, type UpdateCallFlagsOptions, type VotePollOptions, createProxyFetch, normalizeMessage, normalizeMessageWithParent, normalizeMessages, normalizeParticipant, normalizeParticipants, normalizeRoom, normalizeRooms };

package/dist/index.js

@@ -46,6 +46,7 @@ __export(index_exports, {
   SIPState: () => SIPState,
   SharedObjectType: () => SharedObjectType,
   TalkClient: () => TalkClient,
+  createProxyFetch: () => createProxyFetch,
   normalizeMessage: () => normalizeMessage,
   normalizeMessageWithParent: () => normalizeMessageWithParent,
   normalizeMessages: () => normalizeMessages,
@@ -1826,6 +1827,27 @@ var TalkClient = class {
     return this.http.host;
   }
 };
+
+// src/browser.ts
+function createProxyFetch(targetHost, options = {}) {
+  const { proxyPath = "/nextcloud-proxy" } = options;
+  const url = new URL(targetHost);
+  const protocol = url.protocol.replace(":", "");
+  const host = url.host;
+  return (input, init) => {
+    let requestUrl;
+    if (typeof input === "string") {
+      requestUrl = input;
+    } else if (input instanceof URL) {
+      requestUrl = input.toString();
+    } else {
+      requestUrl = input.url;
+    }
+    const targetUrl = new URL(requestUrl);
+    const proxiedPath = `${proxyPath}/${protocol}/${host}${targetUrl.pathname}${targetUrl.search}`;
+    return fetch(proxiedPath, init);
+  };
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ActorType,
@@ -1854,6 +1876,7 @@ var TalkClient = class {
   SIPState,
   SharedObjectType,
   TalkClient,
+  createProxyFetch,
   normalizeMessage,
   normalizeMessageWithParent,
   normalizeMessages,

package/dist/index.mjs

@@ -1768,6 +1768,27 @@ var TalkClient = class {
     return this.http.host;
   }
 };
+
+// src/browser.ts
+function createProxyFetch(targetHost, options = {}) {
+  const { proxyPath = "/nextcloud-proxy" } = options;
+  const url = new URL(targetHost);
+  const protocol = url.protocol.replace(":", "");
+  const host = url.host;
+  return (input, init) => {
+    let requestUrl;
+    if (typeof input === "string") {
+      requestUrl = input;
+    } else if (input instanceof URL) {
+      requestUrl = input.toString();
+    } else {
+      requestUrl = input.url;
+    }
+    const targetUrl = new URL(requestUrl);
+    const proxiedPath = `${proxyPath}/${protocol}/${host}${targetUrl.pathname}${targetUrl.search}`;
+    return fetch(proxiedPath, init);
+  };
+}
 export {
   ActorType,
   BreakoutRoomMode,
@@ -1795,6 +1816,7 @@ export {
   SIPState,
   SharedObjectType,
   TalkClient,
+  createProxyFetch,
   normalizeMessage,
   normalizeMessageWithParent,
   normalizeMessages,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@noematicsllc/talk-sdk",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "Unofficial TypeScript SDK for Nextcloud Talk API",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",