commet 0.7.3 → 0.8.0

package/README.md

@@ -1,301 +1,86 @@
-# commet
+<div align="center">
+  <p align="center">
+    <a href="https://commet.co">
+      <img src="https://commet.co/logo-bg-dark.png" height="96">
+      <h3 align="center">Commet CLI</h3>
+    </a>
+  </p>
+  <p>CLI for Commet billing platform</p>
 
-CLI tool for Commet billing platform - authentication, project linking, and type generation.
+  <a href="https://www.npmjs.com/package/commet"><img alt="NPM version" src="https://img.shields.io/npm/v/commet.svg?style=for-the-badge&labelColor=000000"></a>
+  <a href="https://docs.commet.co/docs/library/cli/overview"><img alt="Documentation" src="https://img.shields.io/badge/docs-CLI-blue.svg?style=for-the-badge&labelColor=000000"></a>
+</div>
+
+<br/>
 
 ## Installation
 
 ```bash
 npm install -g commet
-# or
-pnpm add -g commet
-# or
-yarn global add commet
 ```
 
 ## Quick Start
 
 ```bash
-# 1. Authenticate with Commet
-commet login
-
-# 2. Navigate to your project directory
-cd apps/dashboard  # Recommended: use TypeScript project with tsconfig.json
-
-# 3. Link your project to an organization
-commet link
-
-# 4. Generate TypeScript types (automatically updates tsconfig.json and .gitignore if found)
-commet pull
-```
-
-## Commands
-
-### Authentication
-
-#### `commet login`
-
-Authenticate with Commet using OAuth device flow.
-
-```bash
+# Authenticate
 commet login
-```
-
-Prompts you to select an environment (Sandbox or Production), then opens your browser to authenticate. Creates `~/.commet/auth.json` with your credentials.
-
-**Important:** Sandbox and Production are completely isolated platforms with separate accounts:
-- **Sandbox**: `sandbox.commet.co` - Development and testing
-- **Production**: `commet.co` - Live billing operations
-
-Make sure to login to the correct environment for your needs.
-
-#### `commet logout`
-
-Log out and remove stored credentials.
-
-```bash
-commet logout
-```
-
-#### `commet whoami`
-
-Display current authentication and project status.
-
-```bash
-commet whoami
-```
 
-### Project Management
-
-#### `commet link`
-
-Link the current directory to a Commet organization.
-
-```bash
-cd apps/dashboard
+# Link to organization
 commet link
-```
-
-**What it does:**
-- Creates `.commet/config.json` with organization configuration
-- Works anywhere, but for best experience use a TypeScript project directory
-
-#### `commet unlink`
-
-Unlink the current directory from Commet.
 
-```bash
-commet unlink
-```
-
-#### `commet switch`
-
-Switch to a different organization or environment.
-
-```bash
-commet switch
-```
-
-#### `commet info`
-
-Display detailed information about the current project.
-
-```bash
-commet info
-```
-
-### Type Generation
-
-#### `commet pull`
-
-Generate TypeScript type definitions from your Commet configuration.
-
-```bash
-cd apps/dashboard  # Recommended: TypeScript project directory
+# Generate types
 commet pull
 ```
 
-**What it does:**
-1. Generates `.commet/types.d.ts` with your event and seat types
-2. Automatically updates `tsconfig.json` to include the types file (if found)
-3. Automatically updates `.gitignore` to exclude `.commet/` directory
-
-**Note:** Works anywhere, but if no `tsconfig.json` is found, you'll need to manually configure TypeScript to include the generated types.
+## Type Generation
 
-**Generated types:**
-
-```typescript
-// .commet/types.d.ts
-declare module '@commet/node' {
-  interface CommetGeneratedTypes {
-    eventType: "api_call" | "email_sent" | "payment_processed";
-    seatType: "admin" | "editor" | "viewer";
-  }
-}
-
-export {};
-```
-
-**Usage with the SDK:**
+The CLI generates TypeScript types from your organization for type-safe autocomplete:
 
 ```typescript
+// After running 'commet pull'
 import { Commet } from '@commet/node';
 
 const commet = new Commet({ apiKey: '...' });
 
-// Type-safe event tracking - autocomplete works automatically!
-await commet.usage.events.create({
-  customerId: 'cus_123',
+await commet.usage.create({
   eventType: 'api_call', // Autocomplete works!
-  timestamp: new Date().toISOString(),
+  customerId: 'cus_123'
 });
 
-// Type-safe seat management
-await commet.seats.add('cus_123', 'admin', 5);
-```
-
-### Type Inspection
-
-#### `commet list events`
-
-List all event types in your organization.
-
-```bash
-commet list events
-```
-
-#### `commet list seats`
-
-List all seat types in your organization.
-
-```bash
-commet list seats
-```
-
-## Configuration Files
-
-### Global Config (`~/.commet/auth.json`)
-
-Stores authentication credentials. Created by `commet login`.
-
-```json
-{
-  "token": "...",
-  "refreshToken": "...",
-  "expiresAt": 1234567890,
-  "environment": "sandbox"
-}
-```
-
-The `environment` field determines which platform your authentication is for (sandbox or production).
-
-### Project Config (`.commet/config.json`)
-
-Stores project-specific configuration. Created by `commet link`.
-
-```json
-{
-  "orgId": "org_123",
-  "orgName": "My Organization",
-  "environment": "sandbox"
-}
-```
-
-**Note:** The `.commet/` directory is automatically added to `.gitignore` by `commet pull`. This directory contains:
-- `config.json` - Project configuration
-- `types.d.ts` - Generated TypeScript type definitions
-
-Add `.commet/` to `.gitignore` if different developers use different organizations.
-
-## Environments
-
-Commet supports two completely isolated environments:
-
-- **Sandbox** (`sandbox.commet.co`): Development and testing with separate data
-- **Production** (`commet.co`): Live billing operations with real customers
-
-**Important:** Each environment requires separate authentication because they are independent platforms. To work with both:
-
-1. Login to sandbox: `commet login` → Select "Sandbox"
-2. Do your work in sandbox
-3. When ready for production: `commet logout` → `commet login` → Select "Production"
-
-Organizations and data do NOT transfer between environments.
-
-## Workflow
-
-Typical development workflow:
-
-```bash
-# 1. One-time setup (Sandbox)
-commet login           # Select "Sandbox"
-cd apps/dashboard      # Navigate to your TypeScript project (must have tsconfig.json)
-commet link            # Choose your organization
-commet pull            # Generate types (auto-updates tsconfig.json and .gitignore)
-
-# 2. Develop with type-safe autocomplete
-# Your IDE now has full autocomplete for event and seat types!
-
-# 3. When you add/change event or seat types in dashboard
-commet pull            # Regenerate types
-
-# 4. When ready for production
-commet logout
-commet login           # Select "Production"
-cd apps/dashboard      # Same TypeScript project directory
-commet link            # Link to production organization
-commet pull            # Generate production types
+await commet.subscriptions.create({
+  productId: 'prod_xxx', // Autocomplete with your products!
+  customerId: 'cus_123'
+});
 ```
 
-## Troubleshooting
-
-### "Not authenticated"
-
-Run `commet login` to authenticate.
-
-### "No tsconfig.json found" (Warning)
-
-This is just a warning - the CLI will still work, but won't automatically update your `tsconfig.json`.
-
-For the best experience, run commands from a TypeScript project directory:
+## Commands
 
 ```bash
-cd apps/dashboard  # Directory with tsconfig.json
-commet link
-commet pull
+commet login           # Authenticate with Commet
+commet logout          # Remove credentials
+commet link            # Link project to organization
+commet pull            # Generate TypeScript types
+commet info            # Show project status
+commet list events     # List event types
+commet list seats      # List seat types
 ```
 
-The CLI will automatically add `.commet/types.d.ts` to your TypeScript configuration.
-
-### "Project not linked"
-
-Run `commet link` to connect your project to an organization.
+## Documentation
 
-### "No types found"
+Visit [docs.commet.co/cli](https://docs.commet.co/cli) for:
 
-Create event types and seat types in your Commet dashboard first, then run `commet pull`.
+- Complete command reference
+- Configuration guide
+- Workflow examples
+- Troubleshooting
 
-### "Could not update tsconfig.json"
+## Resources
 
-The CLI will show a warning but continue. Manually add `.commet/types.d.ts` to your `tsconfig.json`:
-
-```json
-{
-  "include": [".commet/types.d.ts", "src/**/*"]
-}
-```
-
-### Authentication expired
-
-Run `commet login` again. Tokens expire after a certain period.
-
-## Links
-
-- [Documentation](https://docs.commet.co)
-- [API Reference](https://docs.commet.co/api)
-- [GitHub](https://github.com/commet-labs/commet-node)
-- [Issues](https://github.com/commet-labs/commet-node/issues)
+- [CLI Documentation](https://docs.commet.co/docs/library/cli/overview)
+- [SDK Reference](https://docs.commet.co/docs/library/quickstart)
+- [GitHub](https://github.com/commet-labs/commet)
+- [Issues](https://github.com/commet-labs/commet/issues)
 
 ## License
 
 MIT
-

package/dist/index.js

@@ -588,48 +588,41 @@ function validateTypeScriptProject() {
 }
 
 // src/utils/generator.ts
-function generateTypes(eventTypes, seatTypes) {
+function generateTypes(eventTypes, seatTypes, products) {
   const eventTypeUnion = eventTypes.length > 0 ? eventTypes.map((e) => `"${e.code}"`).join(" | ") : "string";
   const seatTypeUnion = seatTypes.length > 0 ? seatTypes.map((s) => `"${s.code}"`).join(" | ") : "string";
+  const productTypeUnion = products.length > 0 ? products.map((p) => `"${p.publicId}"`).join(" | ") : "string";
   const eventComments = eventTypes.map(
     (e) => ` * - "${e.code}": ${e.name}${e.description ? ` - ${e.description}` : ""}`
   ).join("\n");
   const seatComments = seatTypes.map(
     (s) => ` * - "${s.code}": ${s.name}${s.description ? ` - ${s.description}` : ""} ${s.isFree ? "(Free)" : ""}`
   ).join("\n");
+  const productComments = products.map(
+    (p) => ` * - "${p.publicId}": ${p.name}${p.description ? ` - ${p.description}` : ""}`
+  ).join("\n");
   return `// Auto-generated by Commet CLI
 // Do not edit this file manually - run 'commet pull' to update
 
 /**
- * Module augmentation for automatic type inference
- * 
  * This augments the Commet SDK to automatically use your organization's
- * specific event and seat types without requiring generic type parameters.
+ * specific event types, seat types, and products without requiring generic type parameters.
  * 
  * Event types available in your organization:
-${eventComments}
+${eventComments || " * (none)"}
  * 
  * Seat types available in your organization:
-${seatComments}
- * 
- * @example
- * import { Commet } from '@commet/node';
- * 
- * const commet = new Commet({ apiKey: 'your-api-key' });
+${seatComments || " * (none)"}
  * 
- * // \u2705 Autocomplete works automatically!
- * await commet.usage.events.create({
- *   eventType: 'api_call', // Only accepts your event types
- *   customerId: 'cus_123'
- * });
+ * Products available in your organization:
+${productComments || " * (none)"}
  * 
- * // \u2705 Same for seats
- * await commet.seats.add('cus_123', 'admin', 5);
- */
+ */ 
 declare module '@commet/node' {
   interface CommetGeneratedTypes {
     eventType: ${eventTypeUnion};
     seatType: ${seatTypeUnion};
+    productId: ${productTypeUnion};
   }
 }
 
@@ -709,8 +702,8 @@ var pullCommand = new import_commander6.Command("pull").description("Pull type d
     console.error(import_chalk7.default.red("Error:"), result.error);
     return;
   }
-  const { eventTypes, seatTypes } = result.data;
-  const typeDefinitions = generateTypes(eventTypes, seatTypes);
+  const { eventTypes, seatTypes, products } = result.data;
+  const typeDefinitions = generateTypes(eventTypes, seatTypes, products);
   const commetDir = path5.resolve(process.cwd(), ".commet");
   const outputPath = path5.join(commetDir, "types.d.ts");
   fs5.mkdirSync(commetDir, { recursive: true });
@@ -755,12 +748,17 @@ var pullCommand = new import_commander6.Command("pull").description("Pull type d
       `  Seat types: ${seatTypes.length > 0 ? seatTypes.map((s) => s.code).join(", ") : "none"}`
     )
   );
+  console.log(
+    import_chalk7.default.dim(
+      `  Products: ${products.length > 0 ? products.map((p) => p.publicId).join(", ") : "none"}`
+    )
+  );
   console.log(import_chalk7.default.dim(`
 Output: ${outputPath}`));
-  if (eventTypes.length === 0 && seatTypes.length === 0) {
+  if (eventTypes.length === 0 && seatTypes.length === 0 && products.length === 0) {
     console.log(
       import_chalk7.default.yellow(
-        "\n\u26A0 No types found. Create event types and seat types in your Commet dashboard."
+        "\n\u26A0 No types found. Create event types, seat types, and products in your Commet dashboard."
       )
     );
   }
@@ -888,7 +886,7 @@ var whoamiCommand = new import_commander9.Command("whoami").description("Display
 // package.json
 var package_default = {
   name: "commet",
-  version: "0.7.3",
+  version: "0.8.0",
   description: "Commet CLI - Manage your billing platform from the command line",
   bin: {
     commet: "./bin/commet"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commet",
-  "version": "0.7.3",
+  "version": "0.8.0",
   "description": "Commet CLI - Manage your billing platform from the command line",
   "bin": {
     "commet": "./bin/commet"
@@ -25,7 +25,7 @@
     "jsonc-parser": "^3.3.1",
     "open": "^10.0.0",
     "ora": "^7.0.1",
-    "@commet/node": "0.7.2"
+    "@commet/node": "0.9.0"
   },
   "devDependencies": {
     "@types/node": "^20.10.0",