@cstar.help/js 0.16.1 → 0.17.0

package/dist/community/index.d.cts

@@ -1,588 +1,6 @@
-/** Attachment metadata for community posts and comments (images only, max 5MB each). */
-interface CommunityAttachment {
-    filename: string;
-    content_type: string;
-    size_bytes: number;
-    storage_path: string;
-}
-/** Configuration for the CommunityClient. */
-interface CommunityConfig {
-    /** Team slug (e.g., 'acme'). Identifies the community to query. */
-    teamSlug: string;
-    /**
-     * Optional publishable key (`pk_test_*` or `pk_live_*`). When provided,
-     * the client switches data scope to match the key's mode (test vs live).
-     * Without a key, defaults to live — backwards-compatible with existing
-     * widget integrations. See `LibraryConfig.publishableKey` for the full
-     * test/live story.
-     */
-    publishableKey?: string;
-    /** Override the base URL (defaults to https://www.cstar.help). */
-    baseUrl?: string;
-}
-/** Parameters for creating a post as an identified customer. */
-interface CommunityCreatePostParams {
-    /** Post title. */
-    title: string;
-    /** Post body/content (optional). */
-    body?: string;
-    /** Topic UUID to post in. */
-    topicId: string;
-    /** Custom field values keyed by field definition ID. */
-    customFields?: Record<string, string>;
-    /** Image attachments (max 10, images only, 5MB each). */
-    attachments?: CommunityAttachment[];
-}
-/** Parameters for updating a post as the original author. */
-interface CommunityUpdatePostParams {
-    /** Updated post title. */
-    title?: string;
-    /** Updated post body/content. */
-    body?: string;
-    /** Updated custom field values keyed by field definition ID. */
-    customFields?: Record<string, string>;
-}
-/** Parameters for updating a comment as the original author. */
-interface CommunityUpdateCommentParams {
-    /** Updated comment body text. */
-    body: string;
-}
-/** Parameters for creating a comment as an identified customer. */
-interface CommunityCreateCommentParams {
-    /** Comment body text. */
-    body: string;
-    /** Parent comment ID for replies (optional, 1-level nesting). */
-    parentCommentId?: string | null;
-    /** Image attachments (max 5, images only, 5MB each). */
-    attachments?: CommunityAttachment[];
-}
-/** Response from creating a post. */
-interface CommunityCreatedPost {
-    id: string;
-    title: string;
-    slug: string;
-    body: string;
-    status: string;
-    visibility: string;
-    voteCount: number;
-    commentCount: number;
-    customFields: Record<string, string>;
-    topicName: string;
-    topicSlug: string;
-    authorName: string;
-    authorAvatar: string;
-    isTeamMember: boolean;
-    createdAt: string;
-}
-/** Response from creating a comment. */
-interface CommunityCreatedComment {
-    id: string;
-    body: string;
-    isOfficial: boolean;
-    voteScore: number;
-    parentCommentId: string | null;
-    authorName: string;
-    authorAvatar: string;
-    isTeamMember: boolean;
-    createdAt: string;
-}
-/** Response from toggling a vote. */
-interface CommunityVoteResult {
-    voted: boolean;
-    voteCount: number;
-}
-/** Response from toggling a follow. */
-interface CommunityFollowResult {
-    following: boolean;
-}
-/** Resolved custom field definition for a topic. */
-interface TopicCustomField {
-    id: string;
-    label: string;
-    type: 'text' | 'number' | 'date' | 'select' | 'checkbox' | 'url';
-    required: boolean;
-    options?: Array<{
-        value: string;
-        label: string;
-    }>;
-    defaultValue?: string;
-}
-/** A discussion topic/category in the community. */
-interface CommunityTopic {
-    id: string;
-    name: string;
-    slug: string;
-    description: string | null;
-    icon: string;
-    visibility: 'public' | 'members_only';
-    sort_order: number;
-    postCount: number;
-    customFields: TopicCustomField[];
-}
-/** A public community post. */
-interface CommunityPost {
-    id: string;
-    title: string;
-    slug: string;
-    body: string;
-    status: 'open' | 'answered' | 'officially_answered' | 'planned' | 'not_planned' | 'completed' | 'under_review';
-    visibility: 'public' | 'members_only';
-    voteCount: number;
-    commentCount: number;
-    isPinned: boolean;
-    isFeatured: boolean;
-    isLocked: boolean;
-    commentsEnabled: boolean;
-    customFields: Record<string, string>;
-    topicName: string;
-    topicSlug: string;
-    authorName: string;
-    authorAvatar: string;
-    authorBio: string;
-    authorPostCount: number;
-    authorCommentCount: number;
-    attachments: CommunityAttachment[];
-    isTeamMember: boolean;
-    lastActivityAt: string;
-    createdAt: string;
-}
-/** A comment on a community post. */
-interface CommunityComment {
-    id: string;
-    body: string;
-    isOfficial: boolean;
-    voteScore: number;
-    parentCommentId: string | null;
-    attachments: CommunityAttachment[];
-    authorName: string;
-    authorAvatar: string;
-    authorBio: string;
-    authorPostCount: number;
-    authorCommentCount: number;
-    isTeamMember: boolean;
-    createdAt: string;
-}
-/** Parameters for listing posts. */
-interface CommunityPostListParams {
-    /** Filter by topic slug. */
-    topicSlug?: string;
-    /** Filter by status. */
-    status?: string;
-    /** Sort order (default: 'recent'). */
-    sort?: 'recent' | 'votes' | 'comments';
-    /** Max results per page. */
-    limit?: number;
-    /** Pagination offset. */
-    offset?: number;
-}
-/** Search results. */
-interface CommunitySearchResult {
-    data: CommunityPost[];
-    count: number;
-    query: string;
-}
-/** A single post with its comments. */
-interface CommunityPostDetail {
-    post: CommunityPost;
-    comments: CommunityComment[];
-}
-
-/**
- * Error classes for the cStar SDK.
- *
- * NEW-v3-01 — Cross-subpath instanceof identity.
- *
- * Each public subpath (`/library`, `/auth`, `/community`, `/quickhelp`, ...)
- * is bundled as a separate tsup entry with `splitting: false`, so each one
- * carries its own copy of this module. Without deduplication, errors thrown
- * by `LibraryClient` carry the LibraryClient-bundled `CStarError` class —
- * not the one a consumer imports from `@cstar.help/js`. That makes
- * `instanceof CStarError` checks fail silently, invalidating every "did the
- * SDK throw a typed cStar error?" branch in user code.
- *
- * Fix: register each class on a `Symbol.for(...)` slot of `globalThis`. The
- * symbol is realm-shared, so every bundled copy of this module resolves to
- * the SAME class identity at runtime — the first copy to load wins, and all
- * subsequent copies surface the canonical class via the same slot. The
- * inline `Impl` definitions are only used as the seed for the very first
- * copy to register. Internal `parseError` / `parsePublicError` reference the
- * EXPORTED canonical names so instances they construct also land on the
- * canonical class.
- */
-/** Error type constants matching the cStar API. */
-declare const ErrorType: {
-    readonly AUTHENTICATION_ERROR: "authentication_error";
-    readonly PERMISSION_ERROR: "permission_error";
-    readonly INVALID_REQUEST_ERROR: "invalid_request_error";
-    readonly NOT_FOUND_ERROR: "not_found_error";
-    readonly CONFLICT_ERROR: "conflict_error";
-    readonly RATE_LIMIT_ERROR: "rate_limit_error";
-    readonly FEATURE_NOT_CONFIGURED: "feature_not_configured";
-    readonly API_ERROR: "api_error";
-    readonly SERVER_ERROR: "server_error";
-};
-/** Shape of the error object returned by the cStar API. */
-interface ApiErrorBody {
-    type: string;
-    code: string;
-    message: string;
-    param?: string;
-    doc_url: string;
-    request_id?: string;
-    feature?: string;
-    enable_url?: string;
-}
-/** Base error class for all cStar API errors. */
-declare const CStarErrorImpl: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody): {
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-declare const CStarAuthenticationErrorImpl: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody): {
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-declare const CStarRateLimitErrorImpl: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody, retryAfter?: number): {
-        readonly retryAfter: number;
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-declare const CStarNotFoundErrorImpl: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody): {
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-declare const CStarValidationErrorImpl: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody): {
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-declare const CStarPermissionErrorImpl: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody): {
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-declare const CStarConflictErrorImpl: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody): {
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-declare const CStarServerErrorImpl: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody): {
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-declare const CStarFeatureDisabledErrorImpl: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody): {
-        readonly feature: string;
-        readonly enableUrl: string;
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-declare const CStarRealtimeUnavailableErrorImpl: {
-    new (message?: string): {
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-declare const CStarError: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody): {
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-type CStarError = InstanceType<typeof CStarErrorImpl>;
-declare const CStarAuthenticationError: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody): {
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-type CStarAuthenticationError = InstanceType<typeof CStarAuthenticationErrorImpl>;
-declare const CStarRateLimitError: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody, retryAfter?: number): {
-        readonly retryAfter: number;
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-type CStarRateLimitError = InstanceType<typeof CStarRateLimitErrorImpl>;
-declare const CStarNotFoundError: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody): {
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-type CStarNotFoundError = InstanceType<typeof CStarNotFoundErrorImpl>;
-declare const CStarValidationError: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody): {
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-type CStarValidationError = InstanceType<typeof CStarValidationErrorImpl>;
-declare const CStarPermissionError: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody): {
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-type CStarPermissionError = InstanceType<typeof CStarPermissionErrorImpl>;
-declare const CStarConflictError: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody): {
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-type CStarConflictError = InstanceType<typeof CStarConflictErrorImpl>;
-declare const CStarServerError: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody): {
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-type CStarServerError = InstanceType<typeof CStarServerErrorImpl>;
-declare const CStarFeatureDisabledError: {
-    new (messageOrStatus: string | number, body?: ApiErrorBody): {
-        readonly feature: string;
-        readonly enableUrl: string;
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-type CStarFeatureDisabledError = InstanceType<typeof CStarFeatureDisabledErrorImpl>;
-declare const CStarRealtimeUnavailableError: {
-    new (message?: string): {
-        readonly type: string;
-        readonly code: string;
-        readonly param?: string;
-        readonly docUrl: string;
-        readonly requestId?: string;
-        readonly statusCode: number;
-        name: string;
-        message: string;
-        stack?: string;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};
-type CStarRealtimeUnavailableError = InstanceType<typeof CStarRealtimeUnavailableErrorImpl>;
-/**
- * Parse a public-route response (anonymous LibraryClient, CommunityClient,
- * QuickHelpClient, AuthClient) into a typed `CStarError`.
- *
- * Public routes don't always emit the structured `{error: {type, code,
- * doc_url, ...}}` envelope — many emit `{error: 'message string'}` or
- * `{message: '...'}`. This helper normalizes both shapes and dispatches
- * on HTTP status (closes F-026 and F-034 — Library/Auth used to throw
- * plain `Error`).
- */
-declare function parsePublicError(status: number, body: unknown, fallbackMessage: string): CStarError;
-declare function parseError(statusCode: number, body: {
-    error?: ApiErrorBody;
-} | null, retryAfter?: number): CStarError;
+import { h as CommunityConfig, i as CommunityTopic, j as CommunityPostListParams, k as CommunityPost, l as CommunityPostDetail, m as CommunitySearchResult, C as CommunityCreatePostParams, a as CommunityCreatedPost, b as CommunityUpdatePostParams, c as CommunityUpdateCommentParams, d as CommunityCreatedComment, e as CommunityVoteResult, f as CommunityCreateCommentParams, g as CommunityFollowResult } from '../types-DF7GprCV.cjs';
+export { n as CommunityComment } from '../types-DF7GprCV.cjs';
+export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-b5A4wfAg.cjs';
 
 /**
  * Public community client. No authentication required.
@@ -688,4 +106,4 @@ declare class CommunityClient {
     private fetch;
 }
 
-export { type ApiErrorBody, CStarAuthenticationError, CStarConflictError, CStarError, CStarFeatureDisabledError, CStarNotFoundError, CStarPermissionError, CStarRateLimitError, CStarRealtimeUnavailableError, CStarServerError, CStarValidationError, CommunityClient, type CommunityComment, type CommunityConfig, type CommunityCreateCommentParams, type CommunityCreatePostParams, type CommunityCreatedComment, type CommunityCreatedPost, type CommunityFollowResult, type CommunityPost, type CommunityPostDetail, type CommunityPostListParams, type CommunitySearchResult, type CommunityTopic, type CommunityUpdateCommentParams, type CommunityUpdatePostParams, type CommunityVoteResult, ErrorType, parseError, parsePublicError };
+export { CommunityClient, CommunityConfig, CommunityCreateCommentParams, CommunityCreatePostParams, CommunityCreatedComment, CommunityCreatedPost, CommunityFollowResult, CommunityPost, CommunityPostDetail, CommunityPostListParams, CommunitySearchResult, CommunityTopic, CommunityUpdateCommentParams, CommunityUpdatePostParams, CommunityVoteResult };