@forgecharts/sdk 1.1.23 → 1.1.27

package/src/react/hooks/useChartCapabilities.ts

@@ -0,0 +1,76 @@
+import { useState, useEffect, useMemo } from 'react';
+import { LicenseManager, getCapabilities } from '../../';
+import type { ChartCapabilities } from '../../';
+import type { ChartRuntimeConfig } from '@forgecharts/types';
+
+/**
+ * Merges license-derived capabilities with optional host config overrides.
+ *
+ * A config flag explicitly set to `false` suppresses the feature even when
+ * the license permits it.  Omitting a field defers to the license.
+ * Derived render flags are recalculated from the updated feature flags so
+ * component-level gates remain consistent.
+ */
+function applyRuntimeConfig(
+  caps: ChartCapabilities,
+  config: ChartRuntimeConfig | undefined,
+): ChartCapabilities {
+  if (!config) return caps;
+
+  const orderEntry      = config.enableOrderEntry      === false ? false : caps.orderEntry;
+  const draggableOrders = config.enableDraggableOrders === false ? false : caps.draggableOrders;
+  const bracketOrders   = config.enableBracketOrders   === false ? false : caps.bracketOrders;
+  const managedTrading  = config.enableManagedTrading  === false ? false : caps.managedTrading;
+  const indicators      = config.enableIndicators      === false ? false : caps.indicators;
+
+  return {
+    ...caps,
+    orderEntry,
+    draggableOrders,
+    bracketOrders,
+    managedTrading,
+    indicators,
+    // Recalculate derived render flags from the updated feature flags.
+    renderOrderEntry:                orderEntry,
+    renderBuySellButtons:            orderEntry,
+    renderOrderTicket:               orderEntry,
+    renderBracketControls:           orderEntry && bracketOrders,
+    renderOrderModificationControls: orderEntry && draggableOrders,
+    renderManagedTradingControls:    managedTrading,
+    renderIndicators:                indicators,
+  };
+}
+
+/**
+ * useChartCapabilities
+ *
+ * Returns the current chart capability set derived from two independent layers
+ * (both must allow a feature for it to be considered active):
+ *   1. **License entitlement** — from the loaded `LicensePayload` via `LicenseManager`.
+ *   2. **Host runtime config** — optional `ChartRuntimeConfig` passed by the consumer.
+ *
+ * The hook re-evaluates whenever the license changes and whenever the
+ * `config` reference changes (use a stable/memoised object to avoid unnecessary
+ * re-renders).
+ *
+ * Usage:
+ *   const caps = useChartCapabilities();
+ *   const caps = useChartCapabilities({ enableOrderEntry: false }); // suppress order entry
+ *   if (caps.renderOrderEntry) { ... }
+ */
+export function useChartCapabilities(config?: ChartRuntimeConfig): ChartCapabilities {
+  const [licCaps, setLicCaps] = useState<ChartCapabilities>(() => getCapabilities());
+
+  useEffect(() => {
+    // Subscribe to license changes via LicenseManager only.
+    // Cross-tab StorageEvent sync is intentionally omitted — that coupling
+    // belongs at the app shell layer (ManagedAppShell reloads on auth change).
+    const unsub = LicenseManager.getInstance().subscribe(() => {
+      setLicCaps(getCapabilities());
+    });
+    return unsub;
+  }, []);
+
+  return useMemo(() => applyRuntimeConfig(licCaps, config), [licCaps, config]);
+}
+

package/src/react/index.ts

@@ -0,0 +1,51 @@
+/**
+ * @forgecharts/sdk/react — Public React embed API
+ *
+ * Supported external integration surfaces:
+ *
+ *   ChartCanvas    — embed a single chart pane with full tool/indicator support
+ *   ChartWorkspace — embed the full multi-tab workspace UI (toolbars included)
+ *
+ * For Unmanaged host integration, use ChartCanvas or ChartWorkspace.
+ * For trading intents, wire TradingBridgeCallbacks.
+ *
+ * The following are intentionally NOT part of the public API:
+ *   - ManagedAppShell   (ForgeCharts Managed product shell — apps/frontend only)
+ *   - Internal sub-components (LayoutMenu, IndicatorPane, toolbars, …)
+ *   - MultiPaneChart    (internal rendering layer beneath ChartCanvas)
+ *
+ * Import from @forgecharts/chart-components/internal for app-layer-only symbols.
+ *
+ * @semver BREAKING changes are communicated via package.json major version bumps.
+ */
+
+// ─── Canvas layer (primary single-pane embed API) ────────────────────────────
+export { ChartCanvas } from './canvas/ChartCanvas';
+export type { ChartCanvasHandle, ChartCanvasProps } from './canvas/ChartCanvas';
+
+// ─── Workspace layer (full workspace embed API) ───────────────────────────────
+export { ChartWorkspace } from './workspace/ChartWorkspace';
+export type { ChartWorkspaceProps, TabItem, TradingSession } from './workspace/ChartWorkspace';
+
+// ─── Capability hook (useful for custom shells and conditional UI) ────────────
+export { useChartCapabilities } from './hooks/useChartCapabilities';
+
+// ─── Trading bridge (Unmanaged host order intents) ────────────────────────────
+export type { TradingBridgeCallbacks } from './trading/TradingBridge';
+export { createTradingBridgeLogger } from './trading/TradingBridge';
+
+// ─── Types re-exported for consumer convenience ───────────────────────────────
+// Symbol resolver interface — implement this in your host to power symbol search.
+export type { ISymbolResolver, ChartRuntimeConfig } from '@forgecharts/types';
+
+// Trading intent contract — fired by the chart, confirmed by host via TradingOverlayStore.
+export type {
+  PlaceOrderIntent,
+  ModifyOrderIntent,
+  CancelOrderIntent,
+  BracketAdjustIntent,
+  TradingIntent,
+  TradingIntentSide,
+  TradingIntentOrderType,
+} from '@forgecharts/types';
+

package/src/react/internal.ts

@@ -0,0 +1,62 @@
+/**
+ * @forgecharts/sdk/react/internal
+ *
+ * Internal export surface — for use by the ForgeCharts Managed app layer ONLY.
+ * Do NOT import from this path in unmanaged host applications or external integrations.
+ * The semver stability guarantee of `@forgecharts/sdk/react` does NOT apply
+ * to symbols exported from this path.
+ *
+ * Direct internal consumers: apps/frontend
+ *
+ * Why this exists: ManagedAppShell is the ForgeCharts Managed product shell. It carries
+ * all Managed-mode state (layouts, preferences, workspace tabs, script drawer, watchlist,
+ * trade drawer). External hosts MUST NOT rely on it — they should compose ChartWorkspace
+ * or ChartCanvas directly with their own state management.
+ */
+
+// Re-export the full public API so an import from this path is a strict superset.
+export * from './index';
+
+// ─── Managed app shell ────────────────────────────────────────────────────────
+// Internal only: ForgeCharts Managed product shell (apps/frontend).
+// Hosts building Unmanaged integrations must NOT use this.
+export { ManagedAppShell } from './shell/ManagedAppShell';
+export type {
+  ManagedAppShellProps,
+  ManagedAppShellHandle,
+  LayoutsAPI,
+  PreferencesAPI,
+} from './shell/ManagedAppShell';
+
+// ─── Internal workspace sub-components ───────────────────────────────────────
+// Implementation details of ManagedAppShell / ChartWorkspace.
+// Not part of the public embed contract.
+export { LayoutMenu } from './workspace/LayoutMenu';
+export type { LayoutRecord } from './workspace/LayoutMenu';
+
+export { TabBar } from './workspace/TabBar';
+export type { TabItem as TabBarItem } from './workspace/TabBar';
+
+export { FloatingPanel } from './workspace/FloatingPanel';
+export { SymbolSearchDialog } from './workspace/SymbolSearchDialog';
+export { IndicatorsDialog } from './workspace/IndicatorsDialog';
+
+export { TopToolbar, DEFAULT_FAVORITES } from './workspace/toolbars/TopToolbar';
+export { RightToolbar } from './workspace/toolbars/RightToolbar';
+export { BottomToolbar } from './workspace/toolbars/BottomToolbar';
+
+// ─── Internal canvas sub-components ──────────────────────────────────────────
+// Used inside ChartCanvas / ChartWorkspace — not for external composition.
+export { IndicatorPane } from './canvas/IndicatorPane';
+export { IndicatorLabel } from './canvas/IndicatorLabel';
+export { ChartContextMenu } from './canvas/ChartContextMenu';
+export { ChartSettingsDialog } from './canvas/ChartSettingsDialog';
+export { PointerOverlay } from './canvas/PointerOverlay';
+
+export { LeftToolbar } from './canvas/toolbars/LeftToolbar';
+export type { VisibilityAction } from './canvas/toolbars/LeftToolbar';
+
+// MultiPaneChart is the native multi-pane rendering component underlying ChartCanvas.
+// It is available here for advanced internal scenarios only.
+export { MultiPaneChart } from './canvas/ChartCanvas';
+export type { MultiPaneChartHandle, MultiPaneChartProps } from './canvas/ChartCanvas';