@kb-labs/core-types 1.0.0

package/README.md

@@ -0,0 +1,88 @@
+# @kb-labs/core-types
+
+> **Shared TypeScript type definitions for KB Labs core packages.** Provides common types used across all KB Labs packages for consistency and type safety.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Node.js](https://img.shields.io/badge/Node.js-18.18.0+-green.svg)](https://nodejs.org/)
+[![pnpm](https://img.shields.io/badge/pnpm-9.0.0+-orange.svg)](https://pnpm.io/)
+
+## 🎯 Vision & Purpose
+
+**@kb-labs/core-types** provides shared TypeScript type definitions for KB Labs core packages. It ensures type consistency across the ecosystem and provides a single source of truth for common types like `ProductId`.
+
+## 🏗️ Architecture
+
+### Core Components
+
+#### Type Definitions
+
+- **Purpose**: Define shared types
+- **Responsibilities**: Export types for use in other packages
+- **Dependencies**: None (types only)
+
+### Design Patterns
+
+- **Type Library Pattern**: Centralized type definitions
+- **Union Types**: ProductId as union type for type safety
+
+### Data Flow
+
+```
+Import from @kb-labs/core-types
+    │
+    ├──► TypeScript compiler resolves types
+    ├──► Types available at compile time
+    └──► No runtime code
+```
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+pnpm add @kb-labs/core-types
+```
+
+### Basic Usage
+
+```typescript
+import type { ProductId } from '@kb-labs/core-types';
+
+function processProduct(product: ProductId) {
+  // Type-safe product handling
+  switch (product) {
+    case 'aiReview':
+      // ...
+      break;
+    case 'aiDocs':
+      // ...
+      break;
+  }
+}
+```
+
+## ✨ Features
+
+### Type Definitions
+
+- **ProductId**: Union type for all KB Labs products
+- **Type Safety**: Strong typing prevents invalid values
+- **Consistency**: Single source of truth for product IDs
+
+## 🔧 Configuration
+
+### Configuration Options
+
+No configuration needed (types only).
+
+### Environment Variables
+
+None (compile-time only).
+
+## 🤝 Contributing
+
+See [CONTRIBUTING.md](../../CONTRIBUTING.md) for development guidelines.
+
+## 📄 License
+
+KB Public License v1.1 © KB Labs

package/dist/index.d.ts

@@ -0,0 +1,79 @@
+/**
+ * @module @kb-labs/core-types/types
+ * Shared types for KB Labs core packages
+ * This package is used to break circular dependencies between core packages
+ */
+/**
+ * Product identifier for KB Labs products
+ */
+type ProductId = 'devlink' | 'release' | 'aiReview' | 'aiDocs' | 'devkit' | 'analytics';
+
+/**
+ * @module @kb-labs/core-types/telemetry
+ * Telemetry abstraction for KB Labs ecosystem
+ *
+ * This module provides a product-agnostic interface for telemetry/analytics,
+ * allowing core packages to emit events without depending on specific implementations.
+ */
+/**
+ * Result of emitting a telemetry event
+ */
+interface TelemetryEmitResult {
+    /** Whether the event was queued for delivery */
+    queued: boolean;
+    /** Reason if event was not queued */
+    reason?: string;
+}
+/**
+ * Telemetry event payload (product-agnostic)
+ */
+interface TelemetryEvent {
+    /** Event type/name */
+    type?: string;
+    /** Event payload data */
+    payload?: Record<string, unknown>;
+    /** Run/execution ID for grouping events */
+    runId?: string;
+    /** Actor information */
+    actor?: {
+        type: string;
+        id: string;
+        name?: string;
+    };
+    /** Context information */
+    ctx?: {
+        workspace?: string;
+        command?: string;
+        [key: string]: unknown;
+    };
+    /** Timestamp (ISO string) */
+    timestamp?: string;
+    /** Additional event data */
+    [key: string]: unknown;
+}
+/**
+ * Telemetry emitter interface
+ *
+ * Implementations should never throw - failures should be handled gracefully
+ * and returned as part of TelemetryEmitResult.
+ */
+interface TelemetryEmitter {
+    /**
+     * Emit a telemetry event
+     * @param event Event to emit
+     * @returns Result indicating success/failure
+     */
+    emit(event: Partial<TelemetryEvent>): Promise<TelemetryEmitResult>;
+}
+/**
+ * No-op telemetry emitter (for when telemetry is disabled or not available)
+ */
+declare class NoOpTelemetryEmitter implements TelemetryEmitter {
+    emit(_event: Partial<TelemetryEvent>): Promise<TelemetryEmitResult>;
+}
+/**
+ * Create a no-op telemetry emitter
+ */
+declare function createNoOpTelemetryEmitter(): TelemetryEmitter;
+
+export { NoOpTelemetryEmitter, type ProductId, type TelemetryEmitResult, type TelemetryEmitter, type TelemetryEvent, createNoOpTelemetryEmitter };

package/dist/index.js

@@ -0,0 +1,13 @@
+// src/telemetry.ts
+var NoOpTelemetryEmitter = class {
+  async emit(_event) {
+    return { queued: false, reason: "Telemetry disabled" };
+  }
+};
+function createNoOpTelemetryEmitter() {
+  return new NoOpTelemetryEmitter();
+}
+
+export { NoOpTelemetryEmitter, createNoOpTelemetryEmitter };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/telemetry.ts"],"names":[],"mappings":";AAgEO,IAAM,uBAAN,MAAuD;AAAA,EAC5D,MAAM,KAAK,MAAA,EAA+D;AACxE,IAAA,OAAO,EAAE,MAAA,EAAQ,KAAA,EAAO,MAAA,EAAQ,oBAAA,EAAqB;AAAA,EACvD;AACF;AAKO,SAAS,0BAAA,GAA+C;AAC7D,EAAA,OAAO,IAAI,oBAAA,EAAqB;AAClC","file":"index.js","sourcesContent":["/**\n * @module @kb-labs/core-types/telemetry\n * Telemetry abstraction for KB Labs ecosystem\n * \n * This module provides a product-agnostic interface for telemetry/analytics,\n * allowing core packages to emit events without depending on specific implementations.\n */\n\n/**\n * Result of emitting a telemetry event\n */\nexport interface TelemetryEmitResult {\n  /** Whether the event was queued for delivery */\n  queued: boolean;\n  /** Reason if event was not queued */\n  reason?: string;\n}\n\n/**\n * Telemetry event payload (product-agnostic)\n */\nexport interface TelemetryEvent {\n  /** Event type/name */\n  type?: string;\n  /** Event payload data */\n  payload?: Record<string, unknown>;\n  /** Run/execution ID for grouping events */\n  runId?: string;\n  /** Actor information */\n  actor?: {\n    type: string;\n    id: string;\n    name?: string;\n  };\n  /** Context information */\n  ctx?: {\n    workspace?: string;\n    command?: string;\n    [key: string]: unknown;\n  };\n  /** Timestamp (ISO string) */\n  timestamp?: string;\n  /** Additional event data */\n  [key: string]: unknown;\n}\n\n/**\n * Telemetry emitter interface\n * \n * Implementations should never throw - failures should be handled gracefully\n * and returned as part of TelemetryEmitResult.\n */\nexport interface TelemetryEmitter {\n  /**\n   * Emit a telemetry event\n   * @param event Event to emit\n   * @returns Result indicating success/failure\n   */\n  emit(event: Partial<TelemetryEvent>): Promise<TelemetryEmitResult>;\n}\n\n/**\n * No-op telemetry emitter (for when telemetry is disabled or not available)\n */\nexport class NoOpTelemetryEmitter implements TelemetryEmitter {\n  async emit(_event: Partial<TelemetryEvent>): Promise<TelemetryEmitResult> {\n    return { queued: false, reason: 'Telemetry disabled' };\n  }\n}\n\n/**\n * Create a no-op telemetry emitter\n */\nexport function createNoOpTelemetryEmitter(): TelemetryEmitter {\n  return new NoOpTelemetryEmitter();\n}\n\n"]}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@kb-labs/core-types",
+  "version": "1.0.0",
+  "description": "Shared TypeScript type definitions for KB Labs core packages",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "devDependencies": {
+    "@kb-labs/devkit": "link:../../../kb-labs-devkit",
+    "@types/node": "^24.3.3",
+    "@typescript-eslint/eslint-plugin": "^8",
+    "@typescript-eslint/parser": "^8",
+    "eslint": "^9",
+    "rimraf": "^6.0.1",
+    "tsup": "^8.5.0",
+    "typescript": "^5.6.3",
+    "vitest": "^3.2.4"
+  },
+  "engines": {
+    "node": ">=20.0.0",
+    "pnpm": ">=9.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "pnpm clean && tsup --config tsup.config.ts",
+    "dev": "tsup --config tsup.config.ts --watch",
+    "type-check": "tsc --noEmit",
+    "test": "vitest run --passWithNoTests",
+    "lint": "eslint . --ignore-pattern 'dist/**'",
+    "lint:fix": "eslint . --fix --ignore-pattern 'dist/**'",
+    "test:watch": "vitest"
+  }
+}