commet 0.4.3 → 0.5.0

package/README.md

@@ -18,10 +18,13 @@ yarn global add commet
 # 1. Authenticate with Commet
 commet login
 
-# 2. Link your project to an organization
+# 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
 
-# 3. Generate TypeScript types
+# 4. Generate TypeScript types (automatically updates tsconfig.json and .gitignore if found)
 commet pull
 ```
 
@@ -68,10 +71,13 @@ commet whoami
 Link the current directory to a Commet organization.
 
 ```bash
+cd apps/dashboard
 commet link
 ```
 
-Creates `.commet` file in the current directory with organization configuration.
+**What it does:**
+- Creates `.commet/config.json` with organization configuration
+- Works anywhere, but for best experience use a TypeScript project directory
 
 #### `commet unlink`
 
@@ -104,36 +110,47 @@ commet info
 Generate TypeScript type definitions from your Commet configuration.
 
 ```bash
+cd apps/dashboard  # Recommended: TypeScript project directory
 commet pull
-# or specify output file
-commet pull -o types/commet.d.ts
 ```
 
-Creates `.commet.d.ts` with your event and seat types:
+**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.
+
+**Generated types:**
 
 ```typescript
-// .commet.d.ts
-export type CommetEventType = "api_call" | "email_sent" | "payment_processed";
-export type CommetSeatType = "admin" | "editor" | "viewer";
+// .commet/types.d.ts
+declare module '@commet/node' {
+  interface CommetGeneratedTypes {
+    eventType: "api_call" | "email_sent" | "payment_processed";
+    seatType: "admin" | "editor" | "viewer";
+  }
+}
+
+export {};
 ```
 
-Use with the SDK:
+**Usage with the SDK:**
 
 ```typescript
 import { Commet } from '@commet/node';
-import type { CommetEventType, CommetSeatType } from './.commet';
 
 const commet = new Commet({ apiKey: '...' });
 
-// Type-safe event tracking
-await commet.usage.events.create<CommetEventType>({
+// Type-safe event tracking - autocomplete works automatically!
+await commet.usage.events.create({
   customerId: 'cus_123',
   eventType: 'api_call', // Autocomplete works!
   timestamp: new Date().toISOString(),
 });
 
 // Type-safe seat management
-await commet.seats.add<CommetSeatType>('cus_123', 'admin', 5);
+await commet.seats.add('cus_123', 'admin', 5);
 ```
 
 ### Type Inspection
@@ -171,7 +188,7 @@ Stores authentication credentials. Created by `commet login`.
 
 The `environment` field determines which platform your authentication is for (sandbox or production).
 
-### Project Config (`.commet`)
+### Project Config (`.commet/config.json`)
 
 Stores project-specific configuration. Created by `commet link`.
 
@@ -183,7 +200,11 @@ Stores project-specific configuration. Created by `commet link`.
 }
 ```
 
-**Note:** Add `.commet` to `.gitignore` if different developers use different organizations.
+**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
 
@@ -206,20 +227,23 @@ Typical development workflow:
 
 ```bash
 # 1. One-time setup (Sandbox)
-commet login  # Select "Sandbox"
-commet link   # Choose your organization
+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. Generate types when you add/change event or seat types
-commet pull
+# 2. Develop with type-safe autocomplete
+# Your IDE now has full autocomplete for event and seat types!
 
-# 3. Use types in your code with autocomplete
-# (see TypeScript examples above)
+# 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"
-commet link   # Link to production organization
-commet pull   # Generate production types
+commet login           # Select "Production"
+cd apps/dashboard      # Same TypeScript project directory
+commet link            # Link to production organization
+commet pull            # Generate production types
 ```
 
 ## Troubleshooting
@@ -228,6 +252,20 @@ commet pull   # Generate production types
 
 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:
+
+```bash
+cd apps/dashboard  # Directory with tsconfig.json
+commet link
+commet pull
+```
+
+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.
@@ -236,6 +274,16 @@ Run `commet link` to connect your project to an organization.
 
 Create event types and seat types in your Commet dashboard first, then run `commet pull`.
 
+### "Could not update tsconfig.json"
+
+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.

package/dist/index.js

@@ -39,6 +39,9 @@ function getAuthPath() {
   return path.join(os.homedir(), ".commet", "auth.json");
 }
 function getProjectConfigPath() {
+  return path.join(process.cwd(), ".commet", "config.json");
+}
+function getProjectConfigDir() {
   return path.join(process.cwd(), ".commet");
 }
 function authExists() {
@@ -83,13 +86,15 @@ function loadProjectConfig() {
   }
 }
 function saveProjectConfig(data) {
+  const configDir = getProjectConfigDir();
   const configPath = getProjectConfigPath();
+  fs.mkdirSync(configDir, { recursive: true });
   fs.writeFileSync(configPath, JSON.stringify(data, null, 2), "utf8");
 }
 function clearProjectConfig() {
-  const configPath = getProjectConfigPath();
-  if (fs.existsSync(configPath)) {
-    fs.unlinkSync(configPath);
+  const configDir = getProjectConfigDir();
+  if (fs.existsSync(configDir)) {
+    fs.rmSync(configDir, { recursive: true, force: true });
   }
 }
 
@@ -165,6 +170,39 @@ async function apiRequest(endpoint, options = {}) {
   }
 }
 
+// src/utils/gitignore-updater.ts
+var fs2 = __toESM(require("fs"));
+var path2 = __toESM(require("path"));
+function updateGitignore(entry) {
+  const cwd = process.cwd();
+  const gitignorePath = path2.join(cwd, ".gitignore");
+  try {
+    let content = "";
+    if (fs2.existsSync(gitignorePath)) {
+      content = fs2.readFileSync(gitignorePath, "utf8");
+      const lines = content.split("\n");
+      for (const line of lines) {
+        const trimmed = line.trim();
+        if (trimmed === entry) {
+          return { success: true };
+        }
+      }
+    }
+    if (content && !content.endsWith("\n")) {
+      content += "\n";
+    }
+    content += `${entry}
+`;
+    fs2.writeFileSync(gitignorePath, content, "utf8");
+    return { success: true };
+  } catch (error) {
+    return {
+      success: false,
+      error: error instanceof Error ? error.message : "Unknown error updating .gitignore"
+    };
+  }
+}
+
 // src/utils/prompt-theme.ts
 var import_chalk2 = __toESM(require("chalk"));
 var commetColor = import_chalk2.default.hex("#5BC0B0");
@@ -252,15 +290,17 @@ var linkCommand = new import_commander2.Command("link").description("Link this p
     orgName: selectedOrg.name,
     environment: auth.environment
   });
-  console.log(import_chalk3.default.green("\n\u2713 Project linked successfully!"));
-  console.log(import_chalk3.default.dim("\nProject configuration:"));
-  console.log(import_chalk3.default.dim(`  Organization: ${selectedOrg.name}`));
-  console.log(import_chalk3.default.dim(`  Environment: ${auth.environment}`));
-  console.log(
-    import_chalk3.default.dim(
-      "\nNext step:\n  Run `commet pull` to generate TypeScript types"
-    )
-  );
+  const gitignoreResult = updateGitignore(".commet/");
+  console.log(import_chalk3.default.green("\n\u2713 Project linked successfully"));
+  console.log(import_chalk3.default.dim(`Organization: ${selectedOrg.name}`));
+  console.log(import_chalk3.default.dim(`Environment: ${auth.environment}`));
+  if (gitignoreResult.success) {
+    console.log(import_chalk3.default.green("\u2713 Updated .gitignore"));
+  } else {
+    console.log(import_chalk3.default.yellow("\u26A0 No .gitignore found"));
+    console.log(import_chalk3.default.dim("Add .commet/ to your .gitignore file"));
+  }
+  console.log(import_chalk3.default.dim("\nRun 'commet pull' to generate TypeScript types"));
 });
 
 // src/commands/list.ts
@@ -523,12 +563,30 @@ var logoutCommand = new import_commander5.Command("logout").description("Log out
 });
 
 // src/commands/pull.ts
-var fs2 = __toESM(require("fs"));
-var path2 = __toESM(require("path"));
+var fs5 = __toESM(require("fs"));
+var path5 = __toESM(require("path"));
 var import_chalk7 = __toESM(require("chalk"));
 var import_commander6 = require("commander");
 var import_ora4 = __toESM(require("ora"));
 
+// src/utils/environment-validator.ts
+var fs3 = __toESM(require("fs"));
+var path3 = __toESM(require("path"));
+function validateTypeScriptProject() {
+  const cwd = process.cwd();
+  const tsconfigPath = path3.join(cwd, "tsconfig.json");
+  if (!fs3.existsSync(tsconfigPath)) {
+    return false;
+  }
+  try {
+    const content = fs3.readFileSync(tsconfigPath, "utf8");
+    JSON.parse(content);
+    return true;
+  } catch (error) {
+    return false;
+  }
+}
+
 // src/utils/generator.ts
 function generateTypes(eventTypes, seatTypes) {
   const eventTypeUnion = eventTypes.length > 0 ? eventTypes.map((e) => `"${e.code}"`).join(" | ") : "string";
@@ -574,16 +632,61 @@ declare module '@commet/node' {
     seatType: ${seatTypeUnion};
   }
 }
+
+// This export is required for TypeScript to treat this file as a module
+// and apply the module augmentation above
+export {};
 `;
 }
 
+// src/utils/tsconfig-updater.ts
+var fs4 = __toESM(require("fs"));
+var path4 = __toESM(require("path"));
+var import_jsonc_parser = require("jsonc-parser");
+function updateTsConfig(entry) {
+  const cwd = process.cwd();
+  const tsconfigPath = path4.join(cwd, "tsconfig.json");
+  try {
+    if (!fs4.existsSync(tsconfigPath)) {
+      return {
+        success: false,
+        error: "tsconfig.json not found"
+      };
+    }
+    const content = fs4.readFileSync(tsconfigPath, "utf8");
+    const config = (0, import_jsonc_parser.parse)(content);
+    if (config.include && Array.isArray(config.include)) {
+      if (config.include.includes(entry)) {
+        return { success: true };
+      }
+    }
+    const currentInclude = config.include || [];
+    const newInclude = [...currentInclude, entry];
+    const edits = (0, import_jsonc_parser.modify)(content, ["include"], newInclude, {
+      formattingOptions: {
+        insertSpaces: true,
+        tabSize: 2
+      }
+    });
+    const updatedContent = (0, import_jsonc_parser.applyEdits)(content, edits);
+    fs4.writeFileSync(tsconfigPath, updatedContent, "utf8");
+    return { success: true };
+  } catch (error) {
+    return {
+      success: false,
+      error: error instanceof Error ? error.message : "Unknown error updating tsconfig.json"
+    };
+  }
+}
+
 // src/commands/pull.ts
-var pullCommand = new import_commander6.Command("pull").description("Pull type definitions from Commet").option("-o, --output <file>", "Output file path", ".commet.d.ts").action(async (options) => {
+var pullCommand = new import_commander6.Command("pull").description("Pull type definitions from Commet").action(async () => {
   if (!authExists()) {
     console.log(import_chalk7.default.red("\u2717 Not authenticated"));
     console.log(import_chalk7.default.dim("Run `commet login` first"));
     return;
   }
+  const hasTsConfig = validateTypeScriptProject();
   if (!projectConfigExists()) {
     console.log(import_chalk7.default.red("\u2717 Project not linked"));
     console.log(
@@ -608,10 +711,39 @@ var pullCommand = new import_commander6.Command("pull").description("Pull type d
   }
   const { eventTypes, seatTypes } = result.data;
   const typeDefinitions = generateTypes(eventTypes, seatTypes);
-  const outputPath = path2.resolve(process.cwd(), options.output);
-  fs2.writeFileSync(outputPath, typeDefinitions, "utf8");
+  const commetDir = path5.resolve(process.cwd(), ".commet");
+  const outputPath = path5.join(commetDir, "types.d.ts");
+  fs5.mkdirSync(commetDir, { recursive: true });
+  fs5.writeFileSync(outputPath, typeDefinitions, "utf8");
   spinner.succeed("Type definitions generated!");
-  console.log(import_chalk7.default.green("\n\u2713 Success"));
+  if (hasTsConfig) {
+    const tsconfigResult = updateTsConfig(".commet/types.d.ts");
+    if (tsconfigResult.success) {
+      console.log(import_chalk7.default.green("\u2713 Updated tsconfig.json"));
+    } else {
+      console.log(import_chalk7.default.yellow("\u26A0 Could not update tsconfig.json"));
+      console.log(
+        import_chalk7.default.dim(
+          'Add ".commet/types.d.ts" to your tsconfig.json include array'
+        )
+      );
+    }
+  } else {
+    console.log(import_chalk7.default.yellow("\u26A0 No tsconfig.json found"));
+    console.log(
+      import_chalk7.default.dim(
+        'Add ".commet/types.d.ts" to your tsconfig.json to enable types'
+      )
+    );
+  }
+  const gitignoreResult = updateGitignore(".commet/");
+  if (gitignoreResult.success) {
+    console.log(import_chalk7.default.green("\u2713 Updated .gitignore"));
+  } else {
+    console.log(import_chalk7.default.yellow("\u26A0 No .gitignore found"));
+    console.log(import_chalk7.default.dim("Add .commet/ to your .gitignore file"));
+  }
+  console.log(import_chalk7.default.green("\nSuccess!"));
   console.log(import_chalk7.default.dim("\nGenerated types:"));
   console.log(
     import_chalk7.default.dim(
@@ -624,7 +756,7 @@ var pullCommand = new import_commander6.Command("pull").description("Pull type d
     )
   );
   console.log(import_chalk7.default.dim(`
-Output file: ${outputPath}`));
+Output: ${outputPath}`));
   if (eventTypes.length === 0 && seatTypes.length === 0) {
     console.log(
       import_chalk7.default.yellow(
@@ -722,7 +854,10 @@ var unlinkCommand = new import_commander8.Command("unlink").description("Unlink
   }
   clearProjectConfig();
   console.log(import_chalk9.default.green("\u2713 Project unlinked successfully"));
-  console.log(import_chalk9.default.dim("Run `commet link` to connect to an organization"));
+  console.log(import_chalk9.default.dim("\u2713 Removed .commet/ directory"));
+  console.log(
+    import_chalk9.default.dim("\nRun `commet link` to connect to a different organization")
+  );
 });
 
 // src/commands/whoami.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commet",
-  "version": "0.4.3",
+  "version": "0.5.0",
   "description": "Commet CLI - Manage your billing platform from the command line",
   "bin": {
     "commet": "./bin/commet"
@@ -22,6 +22,7 @@
     "@inquirer/prompts": "^7.8.6",
     "chalk": "^5.3.0",
     "commander": "^12.0.0",
+    "jsonc-parser": "^3.3.1",
     "open": "^10.0.0",
     "ora": "^7.0.1",
     "@commet/node": "0.5.0"