@pokit/reporter-web 0.0.1

package/dist/types.d.ts

@@ -0,0 +1,131 @@
+/**
+ * Reporter Web Types
+ *
+ * State shape definitions for the web reporter store.
+ * Designed for React integration via useSyncExternalStore.
+ */
+import type { ActivityId, GroupId, GroupLayout, LogLevel } from '@pokit/core';
+/**
+ * Root lifecycle status
+ */
+export type RootStatus = 'idle' | 'running' | 'complete' | 'error';
+/**
+ * Activity status
+ */
+export type ActivityStatus = 'pending' | 'running' | 'success' | 'failure';
+/**
+ * Temporal markers for animation hints
+ * These auto-clear after a short delay (600ms) to enable smooth UI transitions
+ */
+export type TemporalMarkers = {
+    /** Activity just started (for entrance animations) */
+    justStarted?: boolean;
+    /** Activity just completed successfully (for success animations) */
+    justCompleted?: boolean;
+    /** Activity just failed (for error animations) */
+    justFailed?: boolean;
+    /** Group just started */
+    justStarted_group?: boolean;
+    /** Group just ended */
+    justEnded?: boolean;
+};
+/**
+ * Activity state - represents a unit of work
+ */
+export type ActivityState = TemporalMarkers & {
+    id: ActivityId;
+    parentId?: GroupId | ActivityId;
+    label: string;
+    status: ActivityStatus;
+    /** Progress 0-100 */
+    progress?: number;
+    /** Current status message */
+    message?: string;
+    /** Custom metadata */
+    meta?: Record<string, unknown>;
+    /** Error information if failed */
+    error?: {
+        message: string;
+        remediation?: string[];
+        documentationUrl?: string;
+    };
+    /** Custom payload data from updates */
+    payload?: Record<string, unknown>;
+    /** Timestamp when started */
+    startedAt: number;
+    /** Timestamp when completed (success or failure) */
+    completedAt?: number;
+};
+/**
+ * Group state - represents a container for activities
+ */
+export type GroupState = TemporalMarkers & {
+    id: GroupId;
+    parentId?: GroupId;
+    label: string;
+    layout: GroupLayout;
+    /** Child activity IDs in order */
+    activityIds: ActivityId[];
+    /** Child group IDs in order */
+    childGroupIds: GroupId[];
+    /** Whether any child has failed */
+    hasFailure: boolean;
+    /** Timestamp when started */
+    startedAt: number;
+    /** Timestamp when ended */
+    endedAt?: number;
+};
+/**
+ * Log entry
+ */
+export type LogEntry = {
+    id: string;
+    activityId?: ActivityId;
+    level: LogLevel;
+    message: string;
+    timestamp: number;
+};
+/**
+ * Root state for the reporter
+ */
+export type RootState = {
+    appName?: string;
+    version?: string;
+    status: RootStatus;
+    startedAt?: number;
+    endedAt?: number;
+    exitCode?: number;
+};
+/**
+ * Complete reporter state
+ */
+export type ReporterState = {
+    /** Root lifecycle state */
+    root: RootState;
+    /** Groups indexed by ID */
+    groups: Map<GroupId, GroupState>;
+    /** Activities indexed by ID */
+    activities: Map<ActivityId, ActivityState>;
+    /** Log entries in chronological order */
+    logs: LogEntry[];
+    /** Whether reporter output is suspended */
+    suspended: boolean;
+};
+/**
+ * Subscription callback type
+ */
+export type StateListener = () => void;
+/**
+ * Reporter store interface compatible with useSyncExternalStore
+ */
+export type ReporterStore = {
+    /** Get current state snapshot */
+    getState(): ReporterState;
+    /** Get snapshot for useSyncExternalStore (same as getState for immutable updates) */
+    getSnapshot(): ReporterState;
+    /** Subscribe to state changes */
+    subscribe(listener: StateListener): () => void;
+    /** Get server snapshot for SSR (returns same as getSnapshot) */
+    getServerSnapshot(): ReporterState;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE9E;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,OAAO,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;AAE3E;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,sDAAsD;IACtD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oEAAoE;IACpE,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,kDAAkD;IAClD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,yBAAyB;IACzB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,uBAAuB;IACvB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,eAAe,GAAG;IAC5C,EAAE,EAAE,UAAU,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,cAAc,CAAC;IACvB,qBAAqB;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sBAAsB;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,kCAAkC;IAClC,KAAK,CAAC,EAAE;QACN,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;IACF,uCAAuC;IACvC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,eAAe,GAAG;IACzC,EAAE,EAAE,OAAO,CAAC;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,WAAW,CAAC;IACpB,kCAAkC;IAClC,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,+BAA+B;IAC/B,aAAa,EAAE,OAAO,EAAE,CAAC;IACzB,mCAAmC;IACnC,UAAU,EAAE,OAAO,CAAC;IACpB,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,2BAA2B;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,KAAK,EAAE,QAAQ,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,UAAU,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,2BAA2B;IAC3B,IAAI,EAAE,SAAS,CAAC;IAChB,2BAA2B;IAC3B,MAAM,EAAE,GAAG,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IACjC,+BAA+B;IAC/B,UAAU,EAAE,GAAG,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;IAC3C,yCAAyC;IACzC,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,2CAA2C;IAC3C,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,iCAAiC;IACjC,QAAQ,IAAI,aAAa,CAAC;IAC1B,qFAAqF;IACrF,WAAW,IAAI,aAAa,CAAC;IAC7B,iCAAiC;IACjC,SAAS,CAAC,QAAQ,EAAE,aAAa,GAAG,MAAM,IAAI,CAAC;IAC/C,gEAAgE;IAChE,iBAAiB,IAAI,aAAa,CAAC;CACpC,CAAC"}

package/dist/types.js

@@ -0,0 +1,7 @@
+/**
+ * Reporter Web Types
+ *
+ * State shape definitions for the web reporter store.
+ * Designed for React integration via useSyncExternalStore.
+ */
+export {};

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@pokit/reporter-web",
+  "version": "0.0.1",
+  "description": "Web/React event reporter for pok CLI applications",
+  "keywords": [
+    "cli",
+    "command-line",
+    "typescript",
+    "bun",
+    "terminal",
+    "pok",
+    "pokjs",
+    "reporter",
+    "react",
+    "web"
+  ],
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/notation-dev/openpok.git",
+    "directory": "packages/reporter-web"
+  },
+  "homepage": "https://github.com/notation-dev/openpok#readme",
+  "bugs": {
+    "url": "https://github.com/notation-dev/openpok/issues"
+  },
+  "main": "./src/index.ts",
+  "module": "./src/index.ts",
+  "types": "./src/index.ts",
+  "exports": {
+    ".": {
+      "bun": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "@types/react": "^18.2.0",
+    "@pokit/core": "0.0.1"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0",
+    "@pokit/core": "0.0.1"
+  },
+  "engines": {
+    "bun": ">=1.0.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,59 @@
+/**
+ * @pokit/reporter-web
+ *
+ * Web/React implementation of the ReporterAdapter interface.
+ * Provides a store for state management and React hooks for subscription.
+ */
+
+// Store
+export { createReporterStore } from './store';
+export type { CreateReporterStoreOptions, ReporterStoreWithHandler } from './store';
+
+// Adapter
+export { createWebReporterAdapter } from './adapter';
+
+// Hooks
+export {
+  useReporterState,
+  useActivity,
+  useGroup,
+  useRootState,
+  useLogs,
+  useSuspended,
+} from './hooks';
+
+// Types
+export type {
+  RootStatus,
+  ActivityStatus,
+  TemporalMarkers,
+  ActivityState,
+  GroupState,
+  LogEntry,
+  RootState,
+  ReporterState,
+  StateListener,
+  ReporterStore,
+} from './types';
+
+// Components
+export {
+  TutorialStep,
+  FilePreview,
+  CommandBlock,
+  ProgressIndicator,
+  ContentBox,
+} from './components';
+export type {
+  TutorialStepProps,
+  TutorialStepStatus,
+  FilePreviewProps,
+  FilePreviewStatus,
+  FilePreviewActionProps,
+  CommandBlockProps,
+  CommandBlockStatus,
+  CommandBlockActionProps,
+  ProgressIndicatorProps,
+  ContentBoxProps,
+  ContentBoxVariant,
+} from './components';