@topolo/sdk 0.7.0 → 0.8.1

package/src/widgets.ts

@@ -1,362 +0,0 @@
-export const TOPOLO_WIDGET_ENDPOINT = "/api/widget";
-export const TOPOLO_WIDGET_REFRESH_INTERVAL_MS = 60_000;
-
-export type TopoloWidgetType =
-  | "stats"
-  | "recent-activity"
-  | "quick-actions"
-  | "notifications"
-  | "chart";
-
-export interface TopoloWidgetBase {
-  appId: string;
-  serviceName: string;
-  serviceIcon?: string;
-  type: TopoloWidgetType;
-  lastUpdated: string;
-  snapshot: TopoloWidgetSnapshotMetadata;
-}
-
-export interface TopoloWidgetMetric {
-  key?: string;
-  label: string;
-  value: string | number;
-  change?: number;
-  changeLabel?: string;
-  icon?: string;
-}
-
-export interface TopoloWidgetSnapshotMetric {
-  key: string;
-  label: string;
-  value: number;
-  unit?: string;
-  change?: number;
-  changeLabel?: string;
-}
-
-export interface TopoloWidgetSnapshotMetadata {
-  presetKey?: string;
-  audience?: string;
-  scope?: string;
-  scopeLabel?: string;
-  generatedAt?: string;
-  summary: string;
-  defaultMetricKeys?: string[];
-  availableMetrics?: TopoloWidgetSnapshotMetric[];
-  highlights?: string[];
-}
-
-export interface TopoloStatsWidget extends TopoloWidgetBase {
-  type: "stats";
-  stats: TopoloWidgetMetric[];
-}
-
-export interface TopoloWidgetActivityItem {
-  id: string;
-  title: string;
-  description?: string;
-  timestamp: string;
-  icon?: string;
-  link?: string;
-}
-
-export interface TopoloRecentActivityWidget extends TopoloWidgetBase {
-  type: "recent-activity";
-  activities: TopoloWidgetActivityItem[];
-}
-
-export interface TopoloWidgetActionItem {
-  id: string;
-  label: string;
-  icon?: string;
-  link: string;
-  primary?: boolean;
-}
-
-export interface TopoloQuickActionsWidget extends TopoloWidgetBase {
-  type: "quick-actions";
-  actions: TopoloWidgetActionItem[];
-}
-
-export interface TopoloWidgetNotificationItem {
-  id: string;
-  title: string;
-  message: string;
-  type: "info" | "warning" | "error" | "success";
-  timestamp: string;
-  read: boolean;
-  link?: string;
-}
-
-export interface TopoloNotificationsWidget extends TopoloWidgetBase {
-  type: "notifications";
-  notifications: TopoloWidgetNotificationItem[];
-  unreadCount: number;
-}
-
-export interface TopoloChartWidget extends TopoloWidgetBase {
-  type: "chart";
-  chartType: "line" | "bar" | "pie" | "donut";
-  title: string;
-  data: {
-    labels: string[];
-    values: number[];
-  };
-}
-
-export type TopoloWidget =
-  | TopoloStatsWidget
-  | TopoloRecentActivityWidget
-  | TopoloQuickActionsWidget
-  | TopoloNotificationsWidget
-  | TopoloChartWidget;
-
-type TopoloWidgetWithOptionalMetadata<T extends TopoloWidget> = Omit<
-  T,
-  "appId" | "serviceName" | "lastUpdated"
-> &
-  Partial<Pick<TopoloWidgetBase, "appId" | "serviceName" | "lastUpdated">>;
-
-export type TopoloWidgetDraft = TopoloWidget extends infer Widget
-  ? Widget extends TopoloWidget
-    ? TopoloWidgetWithOptionalMetadata<Widget>
-    : never
-  : never;
-
-export interface TopoloWidgetApiResponse {
-  success: boolean;
-  widgets: TopoloWidget[];
-  error?: string;
-}
-
-export interface TopoloWidgetResponseOptions {
-  appId: string;
-  serviceName: string;
-  widgets: TopoloWidgetDraft[];
-  now?: Date | string;
-}
-
-export interface TopoloWidgetValidationResult {
-  ok: boolean;
-  errors: string[];
-}
-
-export interface TopoloWidgetConfig {
-  appId: string;
-  serviceName: string;
-  baseUrl: string;
-  widgetEndpoint: string;
-  enabled: boolean;
-  refreshInterval: number;
-}
-
-export function defineTopoloStatsWidget(
-  widget: Omit<TopoloStatsWidget, "type">,
-): TopoloStatsWidget {
-  return { ...widget, type: "stats" };
-}
-
-export function defineTopoloRecentActivityWidget(
-  widget: Omit<TopoloRecentActivityWidget, "type">,
-): TopoloRecentActivityWidget {
-  return { ...widget, type: "recent-activity" };
-}
-
-export function defineTopoloQuickActionsWidget(
-  widget: Omit<TopoloQuickActionsWidget, "type">,
-): TopoloQuickActionsWidget {
-  return { ...widget, type: "quick-actions" };
-}
-
-export function defineTopoloNotificationsWidget(
-  widget: Omit<TopoloNotificationsWidget, "type">,
-): TopoloNotificationsWidget {
-  return { ...widget, type: "notifications" };
-}
-
-export function defineTopoloChartWidget(
-  widget: Omit<TopoloChartWidget, "type">,
-): TopoloChartWidget {
-  return { ...widget, type: "chart" };
-}
-
-export function createTopoloWidgetResponse({
-  appId,
-  serviceName,
-  widgets,
-  now,
-}: TopoloWidgetResponseOptions): TopoloWidgetApiResponse {
-  const lastUpdated = toIsoTimestamp(now);
-
-  return {
-    success: true,
-    widgets: widgets.map((widget) => ({
-      ...widget,
-      appId: widget.appId?.trim() || appId,
-      serviceName: widget.serviceName?.trim() || serviceName,
-      lastUpdated: widget.lastUpdated?.trim() || lastUpdated,
-    })) as TopoloWidget[],
-  };
-}
-
-export function createTopoloWidgetError(
-  error: string,
-): TopoloWidgetApiResponse {
-  return {
-    success: false,
-    widgets: [],
-    error,
-  };
-}
-
-export function validateTopoloWidgetResponse(
-  response: unknown,
-): TopoloWidgetValidationResult {
-  const errors: string[] = [];
-
-  if (!isRecord(response)) {
-    return { ok: false, errors: ["response must be an object"] };
-  }
-
-  if (typeof response.success !== "boolean") {
-    errors.push("success must be a boolean");
-  }
-
-  if (!Array.isArray(response.widgets)) {
-    errors.push("widgets must be an array");
-    return { ok: errors.length === 0, errors };
-  }
-
-  response.widgets.forEach((widget, index) => {
-    validateWidget(widget, `widgets[${index}]`, errors);
-  });
-
-  if (
-    response.success === false &&
-    response.error !== undefined &&
-    typeof response.error !== "string"
-  ) {
-    errors.push("error must be a string when provided");
-  }
-
-  return { ok: errors.length === 0, errors };
-}
-
-function validateWidget(widget: unknown, path: string, errors: string[]) {
-  if (!isRecord(widget)) {
-    errors.push(`${path} must be an object`);
-    return;
-  }
-
-  validateNonEmptyString(widget.appId, `${path}.appId`, errors);
-  validateNonEmptyString(widget.serviceName, `${path}.serviceName`, errors);
-  validateNonEmptyString(widget.lastUpdated, `${path}.lastUpdated`, errors);
-  validateSnapshotMetadata(widget.snapshot, `${path}.snapshot`, errors);
-
-  switch (widget.type) {
-    case "stats":
-      validateArray(widget.stats, `${path}.stats`, errors);
-      break;
-    case "recent-activity":
-      validateArray(widget.activities, `${path}.activities`, errors);
-      break;
-    case "quick-actions":
-      validateArray(widget.actions, `${path}.actions`, errors);
-      break;
-    case "notifications":
-      validateArray(widget.notifications, `${path}.notifications`, errors);
-      if (typeof widget.unreadCount !== "number") {
-        errors.push(`${path}.unreadCount must be a number`);
-      }
-      break;
-    case "chart":
-      validateNonEmptyString(widget.chartType, `${path}.chartType`, errors);
-      validateNonEmptyString(widget.title, `${path}.title`, errors);
-      if (!isRecord(widget.data)) {
-        errors.push(`${path}.data must be an object`);
-      } else {
-        validateArray(widget.data.labels, `${path}.data.labels`, errors);
-        validateArray(widget.data.values, `${path}.data.values`, errors);
-      }
-      break;
-    default:
-      errors.push(`${path}.type must be a supported Topolo widget type`);
-  }
-}
-
-function validateSnapshotMetadata(
-  snapshot: unknown,
-  path: string,
-  errors: string[],
-) {
-  if (snapshot === undefined) {
-    errors.push(`${path} must be an object`);
-    return;
-  }
-  if (!isRecord(snapshot)) {
-    errors.push(`${path} must be an object`);
-    return;
-  }
-  validateNonEmptyString(snapshot.summary, `${path}.summary`, errors);
-  if (
-    snapshot.defaultMetricKeys !== undefined &&
-    !Array.isArray(snapshot.defaultMetricKeys)
-  ) {
-    errors.push(`${path}.defaultMetricKeys must be an array when provided`);
-  }
-  if (
-    snapshot.highlights !== undefined &&
-    !Array.isArray(snapshot.highlights)
-  ) {
-    errors.push(`${path}.highlights must be an array when provided`);
-  }
-  if (snapshot.availableMetrics === undefined) {
-    return;
-  }
-  if (!Array.isArray(snapshot.availableMetrics)) {
-    errors.push(`${path}.availableMetrics must be an array when provided`);
-    return;
-  }
-
-  snapshot.availableMetrics.forEach((metric, index) => {
-    const metricPath = `${path}.availableMetrics[${index}]`;
-    if (!isRecord(metric)) {
-      errors.push(`${metricPath} must be an object`);
-      return;
-    }
-    validateNonEmptyString(metric.key, `${metricPath}.key`, errors);
-    validateNonEmptyString(metric.label, `${metricPath}.label`, errors);
-    if (typeof metric.value !== "number" || Number.isNaN(metric.value)) {
-      errors.push(`${metricPath}.value must be a number`);
-    }
-  });
-}
-
-function validateNonEmptyString(
-  value: unknown,
-  path: string,
-  errors: string[],
-) {
-  if (typeof value !== "string" || value.trim().length === 0) {
-    errors.push(`${path} must be a non-empty string`);
-  }
-}
-
-function validateArray(value: unknown, path: string, errors: string[]) {
-  if (!Array.isArray(value)) {
-    errors.push(`${path} must be an array`);
-  }
-}
-
-function isRecord(value: unknown): value is Record<string, unknown> {
-  return typeof value === "object" && value !== null && !Array.isArray(value);
-}
-
-function toIsoTimestamp(input: Date | string | undefined): string {
-  if (input instanceof Date) {
-    return input.toISOString();
-  }
-
-  return input ?? new Date().toISOString();
-}