Merge branch 'main' into docs-improvements2

Author: roncohen

docs.sh

@@ -2,7 +2,7 @@
 
 set -e
 
-typedoc
+typedoc --treatWarningsAsErrors
 
 # We need to fix the links in the generated markdown files.
 # Typedoc generates anchors for properties in tables which can collide with anchors for types.

packages/browser-sdk/src/client.ts

@@ -13,7 +13,7 @@ import {
   RequestFeedbackOptions,
 } from "./feedback/feedback";
 import * as feedbackLib from "./feedback/ui";
-import { ToolbarPosition } from "./toolbar/Toolbar";
+import { ToolbarPosition } from "./ui/types";
 import { API_BASE_URL, APP_BASE_URL, SSE_REALTIME_BASE_URL } from "./config";
 import { BucketContext, CompanyContext, UserContext } from "./context";
 import { HookArgs, HooksManager } from "./hooksManager";
@@ -145,7 +145,7 @@ export type PayloadContext = {
 /**
  * BucketClient configuration.
  */
-interface Config {
+export interface Config {
   /**
    * Base URL of Bucket servers.
    */
@@ -499,6 +499,7 @@ export class BucketClient {
    * @param type Type of event to remove.
    * @param handler The same function that was passed to `on`.
    *
+   * @returns A function to remove the hook.
    */
   off<THookType extends keyof HookArgs>(
     type: THookType,

packages/browser-sdk/src/feedback/feedback.ts

@@ -64,7 +64,6 @@ export type RequestFeedbackData = Omit<
    * copy of the feedback in your own application or CRM.
    *
    * @param {Object} data
-   * @param data.
    */
   onAfterSubmit?: (data: FeedbackSubmission) => void;
 

packages/browser-sdk/src/hooksManager.ts

@@ -1,9 +1,6 @@
 import { CheckEvent, RawFeatures } from "./feature/features";
 import { CompanyContext, UserContext } from "./context";
 
-/**
- * @internal
- */
 export interface HookArgs {
   /**
    * Deprecated: Use `check` instead.

packages/browser-sdk/src/index.ts

@@ -1,9 +1,16 @@
-export type { Feature, InitOptions, ToolbarOptions } from "./client";
+export type {
+  Config,
+  Feature,
+  FeatureRemoteConfig,
+  InitOptions,
+  ToolbarOptions,
+} from "./client";
 export { BucketClient } from "./client";
 export type { BucketContext, CompanyContext, UserContext } from "./context";
 export type {
   CheckEvent,
   FallbackFeatureOverride,
+  FetchedFeature,
   RawFeature,
   RawFeatures,
 } from "./feature/features";
@@ -28,6 +35,13 @@ export type {
   OnScoreSubmitResult,
   OpenFeedbackFormOptions,
 } from "./feedback/ui/types";
-export type { TrackEvent } from "./hooksManager";
+export type { HookArgs, TrackEvent } from "./hooksManager";
 export type { Logger } from "./logger";
 export { feedbackContainerId, propagatedEvents } from "./ui/constants";
+export type {
+  DialogPlacement,
+  Offset,
+  PopoverPlacement,
+  Position,
+  ToolbarPosition,
+} from "./ui/types";

packages/browser-sdk/src/toolbar/Toolbar.tsx

@@ -11,7 +11,7 @@ import { BucketClient } from "../client";
 import { toolbarContainerId } from "../ui/constants";
 import { Dialog, DialogContent, DialogHeader, useDialog } from "../ui/Dialog";
 import { Logo } from "../ui/icons/Logo";
-import { DialogPlacement, Offset } from "../ui/types";
+import { ToolbarPosition } from "../ui/types";
 import { parseUnanchoredPosition } from "../ui/utils";
 
 import { FeatureSearch, FeaturesTable } from "./Features";
@@ -22,10 +22,6 @@ export type FeatureItem = {
   localOverride: boolean | null;
   isEnabled: boolean;
 };
-export interface ToolbarPosition {
-  placement: DialogPlacement;
-  offset?: Offset;
-}
 
 type Feature = {
   key: string;

packages/browser-sdk/src/toolbar/index.ts

@@ -2,9 +2,10 @@ import { h, render } from "preact";
 
 import { BucketClient } from "../client";
 import { toolbarContainerId } from "../ui/constants";
+import { ToolbarPosition } from "../ui/types";
 import { attachContainer } from "../ui/utils";
 
-import Toolbar, { ToolbarPosition } from "./Toolbar";
+import Toolbar from "./Toolbar";
 
 type showToolbarToggleOptions = {
   bucketClient: BucketClient;

packages/browser-sdk/src/ui/types.ts

@@ -31,3 +31,8 @@ export type Position =
       anchor: HTMLElement | null;
       placement?: PopoverPlacement;
     };
+
+export interface ToolbarPosition {
+  placement: DialogPlacement;
+  offset?: Offset;
+}

packages/node-sdk/src/client.ts

@@ -413,12 +413,7 @@ export class BucketClient {
   /**
    * Tracks an event in Bucket.
 
-   * @param event - The event to track.
-   * @param userId - The userId of the user who performed the event
-   * @param opts - The options.
-   * @param opts.attributes - The attributes of the event (optional).
-   * @param opts.meta - The meta context associated with tracking (optional).
-   * @param opts.companyId - Optional company ID for the event (optional).
+   * @param options.companyId - Optional company ID for the event (optional).
    *
    * @throws An error if the user is not set or the event is invalid or the options are invalid.
    * @remarks
@@ -1228,7 +1223,6 @@ export class BoundBucketClient {
    * @param client - The `BucketClient` to use.
    * @param options - The options for the client.
    * @param options.enableTracking - Whether to enable tracking for the client.
-   * @param options.context - The context for the client.
    *
    * @internal
    */

packages/node-sdk/src/index.ts

@@ -5,18 +5,24 @@ export type {
   ClientOptions,
   Context,
   ContextWithTracking,
+  EmptyFeatureRemoteConfig,
   Feature,
+  FeatureOverride,
   FeatureOverrides,
   FeatureOverridesFn,
+  FeatureRemoteConfig,
   Features,
+  FullFeatureOverride,
   HttpClient,
   HttpClientResponse,
   IdType,
   LOG_LEVELS,
   Logger,
   LogLevel,
   RawFeature,
+  RawFeatureRemoteConfig,
   TrackingMeta,
   TrackOptions,
+  TypedFeatureKey,
   TypedFeatures,
 } from "./types";