@cstar.help/js 0.16.0 → 0.17.0

package/dist/quickhelp/index.d.cts

@@ -1,3 +1,5 @@
+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';
+
 /**
  * Options for the QuickHelpClient. No auth — Quick Help is anonymous by
  * design.
@@ -55,403 +57,6 @@ interface QuickHelpAskResult {
     turnNumber: number;
 }
 
-/**
- * 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;
-
 /**
  * Quick Help — anonymous AI Q&A client.
  *
@@ -524,4 +129,4 @@ declare class QuickHelpError extends Error {
     });
 }
 
-export { type ApiErrorBody, CStarAuthenticationError, CStarConflictError, CStarError, CStarFeatureDisabledError, CStarNotFoundError, CStarPermissionError, CStarRateLimitError, CStarRealtimeUnavailableError, CStarServerError, CStarValidationError, ErrorType, type QuickHelpAskParams, type QuickHelpAskResult, QuickHelpClient, type QuickHelpConfig, QuickHelpError, type QuickHelpPublicConfig, type QuickHelpTurnOutcome, parseError, parsePublicError };
+export { type QuickHelpAskParams, type QuickHelpAskResult, QuickHelpClient, type QuickHelpConfig, QuickHelpError, type QuickHelpPublicConfig, type QuickHelpTurnOutcome };