@foru-ms/sdk 1.3.2 → 2.0.2

package/dist/esm/api/types/ThreadUpdate.d.mts

@@ -0,0 +1,14 @@
+export interface ThreadUpdate {
+    /** New title */
+    title?: string;
+    /** New content */
+    body?: string;
+    /** Lock/unlock thread */
+    locked?: boolean;
+    /** Pin/unpin thread */
+    pinned?: boolean;
+    /** Update tags by slug, name, or ID */
+    tags?: string[];
+    /** Update extended data */
+    extendedData?: Record<string, unknown>;
+}

package/dist/esm/api/types/ThreadUpdate.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/UserList.d.mts

@@ -0,0 +1,18 @@
+export interface UserList {
+    /** Items per page (max 75) */
+    limit?: number;
+    /** Cursor for pagination */
+    cursor?: string;
+    /** Search by username or display name */
+    search?: string;
+    /** Sort by creation date */
+    sort?: UserList.Sort;
+}
+export declare namespace UserList {
+    /** Sort by creation date */
+    const Sort: {
+        readonly Newest: "newest";
+        readonly Oldest: "oldest";
+    };
+    type Sort = (typeof Sort)[keyof typeof Sort];
+}

package/dist/esm/api/types/UserList.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var UserList;
+(function (UserList) {
+    /** Sort by creation date */
+    UserList.Sort = {
+        Newest: "newest",
+        Oldest: "oldest",
+    };
+})(UserList || (UserList = {}));

package/dist/esm/api/types/UserResponse.d.mts

@@ -0,0 +1,18 @@
+export interface UserResponse {
+    /** Items per page (max 75) */
+    limit?: number;
+    /** Cursor for pagination */
+    cursor?: string;
+    /** Search by username or display name */
+    search?: string;
+    /** Sort by creation date */
+    sort?: UserResponse.Sort;
+}
+export declare namespace UserResponse {
+    /** Sort by creation date */
+    const Sort: {
+        readonly Newest: "newest";
+        readonly Oldest: "oldest";
+    };
+    type Sort = (typeof Sort)[keyof typeof Sort];
+}

package/dist/esm/api/types/UserResponse.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var UserResponse;
+(function (UserResponse) {
+    /** Sort by creation date */
+    UserResponse.Sort = {
+        Newest: "newest",
+        Oldest: "oldest",
+    };
+})(UserResponse || (UserResponse = {}));

package/dist/esm/api/types/UserUpdate.d.mts

@@ -0,0 +1,20 @@
+export interface UserUpdate {
+    /** Display name */
+    displayName?: string;
+    /** User bio */
+    bio?: string;
+    /** Forum signature */
+    signature?: string;
+    /** Username (letters, numbers, underscores, hyphens) */
+    username?: string;
+    /** Email address */
+    email?: string;
+    /** New password */
+    password?: string;
+    /** Website URL */
+    url?: string;
+    /** Extended data */
+    extendedData?: Record<string, unknown>;
+    /** Role slugs (admin only) */
+    roles?: string[];
+}

package/dist/esm/api/types/UserUpdate.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/WebhookCreate.d.mts

@@ -0,0 +1,10 @@
+export interface WebhookCreate {
+    /** Webhook name */
+    name: string;
+    /** Target URL */
+    url: string;
+    /** List of event types (e.g. post.created) */
+    events: string[];
+    /** Secret for signature verification (auto-generated if missing) */
+    secret?: string;
+}

package/dist/esm/api/types/WebhookCreate.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/WebhookList.d.mts

@@ -0,0 +1,6 @@
+export interface WebhookList {
+    /** Items per page (max 75) */
+    limit?: number;
+    /** Cursor for pagination */
+    cursor?: string;
+}

package/dist/esm/api/types/WebhookList.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/index.d.mts

@@ -0,0 +1,34 @@
+export * from "./AuthResponse.mjs";
+export * from "./ErrorResponse.mjs";
+export * from "./IntegrationCreate.mjs";
+export * from "./IntegrationUpdate.mjs";
+export * from "./NotificationCreate.mjs";
+export * from "./NotificationList.mjs";
+export * from "./NotificationUpdate.mjs";
+export * from "./PostCreate.mjs";
+export * from "./PostList.mjs";
+export * from "./PostResponse.mjs";
+export * from "./PostUpdate.mjs";
+export * from "./PrivateMessageCreate.mjs";
+export * from "./PrivateMessageList.mjs";
+export * from "./ReportCreate.mjs";
+export * from "./ReportList.mjs";
+export * from "./ReportResponse.mjs";
+export * from "./RoleCreate.mjs";
+export * from "./RoleResponse.mjs";
+export * from "./RoleUpdate.mjs";
+export * from "./SsoCreate.mjs";
+export * from "./SsoUpdate.mjs";
+export * from "./TagCreate.mjs";
+export * from "./TagList.mjs";
+export * from "./TagResponse.mjs";
+export * from "./TagUpdate.mjs";
+export * from "./ThreadCreate.mjs";
+export * from "./ThreadList.mjs";
+export * from "./ThreadResponse.mjs";
+export * from "./ThreadUpdate.mjs";
+export * from "./UserList.mjs";
+export * from "./UserResponse.mjs";
+export * from "./UserUpdate.mjs";
+export * from "./WebhookCreate.mjs";
+export * from "./WebhookList.mjs";

package/dist/esm/api/types/index.mjs

@@ -0,0 +1,34 @@
+export * from "./AuthResponse.mjs";
+export * from "./ErrorResponse.mjs";
+export * from "./IntegrationCreate.mjs";
+export * from "./IntegrationUpdate.mjs";
+export * from "./NotificationCreate.mjs";
+export * from "./NotificationList.mjs";
+export * from "./NotificationUpdate.mjs";
+export * from "./PostCreate.mjs";
+export * from "./PostList.mjs";
+export * from "./PostResponse.mjs";
+export * from "./PostUpdate.mjs";
+export * from "./PrivateMessageCreate.mjs";
+export * from "./PrivateMessageList.mjs";
+export * from "./ReportCreate.mjs";
+export * from "./ReportList.mjs";
+export * from "./ReportResponse.mjs";
+export * from "./RoleCreate.mjs";
+export * from "./RoleResponse.mjs";
+export * from "./RoleUpdate.mjs";
+export * from "./SsoCreate.mjs";
+export * from "./SsoUpdate.mjs";
+export * from "./TagCreate.mjs";
+export * from "./TagList.mjs";
+export * from "./TagResponse.mjs";
+export * from "./TagUpdate.mjs";
+export * from "./ThreadCreate.mjs";
+export * from "./ThreadList.mjs";
+export * from "./ThreadResponse.mjs";
+export * from "./ThreadUpdate.mjs";
+export * from "./UserList.mjs";
+export * from "./UserResponse.mjs";
+export * from "./UserUpdate.mjs";
+export * from "./WebhookCreate.mjs";
+export * from "./WebhookList.mjs";

package/dist/esm/auth/HeaderAuthProvider.d.mts

@@ -0,0 +1,16 @@
+import * as core from "../core/index.mjs";
+export declare namespace HeaderAuthProvider {
+    interface AuthOptions {
+        apiKey?: core.Supplier<string>;
+    }
+    interface Options extends AuthOptions {
+    }
+}
+export declare class HeaderAuthProvider implements core.AuthProvider {
+    private readonly headerValue;
+    constructor(options: HeaderAuthProvider.Options);
+    static canCreate(options: HeaderAuthProvider.Options): boolean;
+    getAuthRequest(_arg?: {
+        endpointMetadata?: core.EndpointMetadata;
+    }): Promise<core.AuthRequest>;
+}

package/dist/esm/auth/HeaderAuthProvider.mjs

@@ -0,0 +1,34 @@
+// This file was auto-generated by Fern from our API Definition.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as core from "../core/index.mjs";
+import * as errors from "../errors/index.mjs";
+export class HeaderAuthProvider {
+    constructor(options) {
+        this.headerValue = options.apiKey;
+    }
+    static canCreate(options) {
+        return options.apiKey != null;
+    }
+    getAuthRequest(_arg) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiKey = yield core.Supplier.get(this.headerValue);
+            if (apiKey == null) {
+                throw new errors.ForumError({
+                    message: "Please specify a apiKey by passing it in to the constructor",
+                });
+            }
+            const headerValue = apiKey;
+            return {
+                headers: { "x-api-key": headerValue },
+            };
+        });
+    }
+}

package/dist/esm/auth/index.d.mts

@@ -0,0 +1 @@
+export { HeaderAuthProvider } from "./HeaderAuthProvider.mjs";

package/dist/esm/auth/index.mjs

@@ -0,0 +1 @@
+export { HeaderAuthProvider } from "./HeaderAuthProvider.mjs";

package/dist/esm/core/auth/AuthProvider.d.mts

@@ -0,0 +1,7 @@
+import type { EndpointMetadata } from "../fetcher/EndpointMetadata.mjs";
+import type { AuthRequest } from "./AuthRequest.mjs";
+export interface AuthProvider {
+    getAuthRequest(arg?: {
+        endpointMetadata?: EndpointMetadata;
+    }): Promise<AuthRequest>;
+}

package/dist/esm/core/auth/AuthProvider.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/core/auth/AuthRequest.d.mts

@@ -0,0 +1,9 @@
+/**
+ * Request parameters for authentication requests.
+ */
+export interface AuthRequest {
+    /**
+     * The headers to be included in the request.
+     */
+    headers: Record<string, string>;
+}

package/dist/esm/core/auth/AuthRequest.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/core/auth/BasicAuth.d.mts

@@ -0,0 +1,8 @@
+export interface BasicAuth {
+    username: string;
+    password: string;
+}
+export declare const BasicAuth: {
+    toAuthorizationHeader: (basicAuth: BasicAuth | undefined) => string | undefined;
+    fromAuthorizationHeader: (header: string) => BasicAuth;
+};

package/dist/esm/core/auth/BasicAuth.mjs

@@ -0,0 +1,24 @@
+import { base64Decode, base64Encode } from "../base64.mjs";
+const BASIC_AUTH_HEADER_PREFIX = /^Basic /i;
+export const BasicAuth = {
+    toAuthorizationHeader: (basicAuth) => {
+        if (basicAuth == null) {
+            return undefined;
+        }
+        const token = base64Encode(`${basicAuth.username}:${basicAuth.password}`);
+        return `Basic ${token}`;
+    },
+    fromAuthorizationHeader: (header) => {
+        const credentials = header.replace(BASIC_AUTH_HEADER_PREFIX, "");
+        const decoded = base64Decode(credentials);
+        const [username, ...passwordParts] = decoded.split(":");
+        const password = passwordParts.length > 0 ? passwordParts.join(":") : undefined;
+        if (username == null || password == null) {
+            throw new Error("Invalid basic auth");
+        }
+        return {
+            username,
+            password,
+        };
+    },
+};

package/dist/esm/core/auth/BearerToken.d.mts

@@ -0,0 +1,7 @@
+export type BearerToken = string;
+declare function toAuthorizationHeader(token: string | undefined): string | undefined;
+export declare const BearerToken: {
+    toAuthorizationHeader: typeof toAuthorizationHeader;
+    fromAuthorizationHeader: (header: string) => BearerToken;
+};
+export {};

package/dist/esm/core/auth/BearerToken.mjs

@@ -0,0 +1,13 @@
+const BEARER_AUTH_HEADER_PREFIX = /^Bearer /i;
+function toAuthorizationHeader(token) {
+    if (token == null) {
+        return undefined;
+    }
+    return `Bearer ${token}`;
+}
+export const BearerToken = {
+    toAuthorizationHeader: toAuthorizationHeader,
+    fromAuthorizationHeader: (header) => {
+        return header.replace(BEARER_AUTH_HEADER_PREFIX, "").trim();
+    },
+};

package/dist/esm/core/auth/NoOpAuthProvider.d.mts

@@ -0,0 +1,5 @@
+import type { AuthProvider } from "./AuthProvider.mjs";
+import type { AuthRequest } from "./AuthRequest.mjs";
+export declare class NoOpAuthProvider implements AuthProvider {
+    getAuthRequest(): Promise<AuthRequest>;
+}

package/dist/esm/core/auth/NoOpAuthProvider.mjs

@@ -0,0 +1,5 @@
+export class NoOpAuthProvider {
+    getAuthRequest() {
+        return Promise.resolve({ headers: {} });
+    }
+}

package/dist/esm/core/auth/index.d.mts

@@ -0,0 +1,5 @@
+export type { AuthProvider } from "./AuthProvider.mjs";
+export type { AuthRequest } from "./AuthRequest.mjs";
+export { BasicAuth } from "./BasicAuth.mjs";
+export { BearerToken } from "./BearerToken.mjs";
+export { NoOpAuthProvider } from "./NoOpAuthProvider.mjs";

package/dist/esm/core/auth/index.mjs

@@ -0,0 +1,3 @@
+export { BasicAuth } from "./BasicAuth.mjs";
+export { BearerToken } from "./BearerToken.mjs";
+export { NoOpAuthProvider } from "./NoOpAuthProvider.mjs";

package/dist/esm/core/base64.d.mts

@@ -0,0 +1,2 @@
+export declare function base64Encode(input: string): string;
+export declare function base64Decode(input: string): string;

package/dist/esm/core/base64.mjs

@@ -0,0 +1,22 @@
+function base64ToBytes(base64) {
+    const binString = atob(base64);
+    return Uint8Array.from(binString, (m) => m.codePointAt(0));
+}
+function bytesToBase64(bytes) {
+    const binString = String.fromCodePoint(...bytes);
+    return btoa(binString);
+}
+export function base64Encode(input) {
+    if (typeof Buffer !== "undefined") {
+        return Buffer.from(input, "utf8").toString("base64");
+    }
+    const bytes = new TextEncoder().encode(input);
+    return bytesToBase64(bytes);
+}
+export function base64Decode(input) {
+    if (typeof Buffer !== "undefined") {
+        return Buffer.from(input, "base64").toString("utf8");
+    }
+    const bytes = base64ToBytes(input);
+    return new TextDecoder().decode(bytes);
+}

package/dist/esm/core/exports.d.mts

@@ -0,0 +1 @@
+export * from "./logging/exports.mjs";

package/dist/esm/core/exports.mjs

@@ -0,0 +1 @@
+export * from "./logging/exports.mjs";

package/dist/esm/core/fetcher/APIResponse.d.mts

@@ -0,0 +1,20 @@
+import type { RawResponse } from "./RawResponse.mjs";
+/**
+ * The response of an API call.
+ * It is a successful response or a failed response.
+ */
+export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
+export interface SuccessfulResponse<T> {
+    ok: true;
+    body: T;
+    /**
+     * @deprecated Use `rawResponse` instead
+     */
+    headers?: Record<string, any>;
+    rawResponse: RawResponse;
+}
+export interface FailedResponse<T> {
+    ok: false;
+    error: T;
+    rawResponse: RawResponse;
+}

package/dist/esm/core/fetcher/APIResponse.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/core/fetcher/BinaryResponse.d.mts

@@ -0,0 +1,19 @@
+export type BinaryResponse = {
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed) */
+    bodyUsed: Response["bodyUsed"];
+    /**
+     * Returns a ReadableStream of the response body.
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body)
+     */
+    stream: () => Response["body"];
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer) */
+    arrayBuffer: () => ReturnType<Response["arrayBuffer"]>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob) */
+    blob: () => ReturnType<Response["blob"]>;
+    /**
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes)
+     * Some versions of the Fetch API may not support this method.
+     */
+    bytes?(): ReturnType<Response["bytes"]>;
+};
+export declare function getBinaryResponse(response: Response): BinaryResponse;

package/dist/esm/core/fetcher/BinaryResponse.mjs

@@ -0,0 +1,14 @@
+export function getBinaryResponse(response) {
+    const binaryResponse = {
+        get bodyUsed() {
+            return response.bodyUsed;
+        },
+        stream: () => response.body,
+        arrayBuffer: response.arrayBuffer.bind(response),
+        blob: response.blob.bind(response),
+    };
+    if ("bytes" in response && typeof response.bytes === "function") {
+        binaryResponse.bytes = response.bytes.bind(response);
+    }
+    return binaryResponse;
+}

package/dist/esm/core/fetcher/EndpointMetadata.d.mts

@@ -0,0 +1,13 @@
+export type SecuritySchemeKey = string;
+/**
+ * A collection of security schemes, where the key is the name of the security scheme and the value is the list of scopes required for that scheme.
+ * All schemes in the collection must be satisfied for authentication to be successful.
+ */
+export type SecuritySchemeCollection = Record<SecuritySchemeKey, AuthScope[]>;
+export type AuthScope = string;
+export type EndpointMetadata = {
+    /**
+     * An array of security scheme collections. Each collection represents an alternative way to authenticate.
+     */
+    security?: SecuritySchemeCollection[];
+};

package/dist/esm/core/fetcher/EndpointMetadata.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/core/fetcher/EndpointSupplier.d.mts

@@ -0,0 +1,12 @@
+import type { EndpointMetadata } from "./EndpointMetadata.mjs";
+import type { Supplier } from "./Supplier.mjs";
+type EndpointSupplierFn<T> = (arg: {
+    endpointMetadata: EndpointMetadata;
+}) => T | Promise<T>;
+export type EndpointSupplier<T> = Supplier<T> | EndpointSupplierFn<T>;
+export declare const EndpointSupplier: {
+    get: <T>(supplier: EndpointSupplier<T>, arg: {
+        endpointMetadata: EndpointMetadata;
+    }) => Promise<T>;
+};
+export {};

package/dist/esm/core/fetcher/EndpointSupplier.mjs

@@ -0,0 +1,19 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+export const EndpointSupplier = {
+    get: (supplier, arg) => __awaiter(void 0, void 0, void 0, function* () {
+        if (typeof supplier === "function") {
+            return supplier(arg);
+        }
+        else {
+            return supplier;
+        }
+    }),
+};

package/dist/esm/core/fetcher/Fetcher.d.mts

@@ -0,0 +1,49 @@
+import { type LogConfig, type Logger } from "../logging/logger.mjs";
+import type { APIResponse } from "./APIResponse.mjs";
+import type { EndpointMetadata } from "./EndpointMetadata.mjs";
+import { EndpointSupplier } from "./EndpointSupplier.mjs";
+export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
+export declare namespace Fetcher {
+    interface Args {
+        url: string;
+        method: string;
+        contentType?: string;
+        headers?: Record<string, string | EndpointSupplier<string | null | undefined> | null | undefined>;
+        queryParameters?: Record<string, unknown>;
+        body?: unknown;
+        timeoutMs?: number;
+        maxRetries?: number;
+        withCredentials?: boolean;
+        abortSignal?: AbortSignal;
+        requestType?: "json" | "file" | "bytes" | "form" | "other";
+        responseType?: "json" | "blob" | "sse" | "streaming" | "text" | "arrayBuffer" | "binary-response";
+        duplex?: "half";
+        endpointMetadata?: EndpointMetadata;
+        fetchFn?: typeof fetch;
+        logging?: LogConfig | Logger;
+    }
+    type Error = FailedStatusCodeError | NonJsonError | BodyIsNullError | TimeoutError | UnknownError;
+    interface FailedStatusCodeError {
+        reason: "status-code";
+        statusCode: number;
+        body: unknown;
+    }
+    interface NonJsonError {
+        reason: "non-json";
+        statusCode: number;
+        rawBody: string;
+    }
+    interface BodyIsNullError {
+        reason: "body-is-null";
+        statusCode: number;
+    }
+    interface TimeoutError {
+        reason: "timeout";
+    }
+    interface UnknownError {
+        reason: "unknown";
+        errorMessage: string;
+    }
+}
+export declare function fetcherImpl<R = unknown>(args: Fetcher.Args): Promise<APIResponse<R, Fetcher.Error>>;
+export declare const fetcher: FetchFunction;