commet 0.3.0 → 0.4.1

package/LICENSE

@@ -1,21 +1,202 @@
-MIT License
-
-Copyright (c) 2025 Commet
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Commet
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,39 +1,253 @@
 # commet
 
-TypeScript SDK for Commet billing and usage tracking.
+CLI tool for Commet billing platform - authentication, project linking, and type generation.
 
-## Install
+## Installation
 
 ```bash
-npm install commet
+npm install -g commet
+# or
+pnpm add -g commet
+# or
+yarn global add commet
 ```
 
 ## Quick Start
 
+```bash
+# 1. Authenticate with Commet
+commet login
+
+# 2. Link your project to an organization
+commet link
+
+# 3. Generate TypeScript types
+commet pull
+```
+
+## Commands
+
+### Authentication
+
+#### `commet login`
+
+Authenticate with Commet using OAuth device flow.
+
+```bash
+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**: `billing.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
+commet link
+```
+
+Creates `.commet` file in the current directory with organization configuration.
+
+#### `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
+commet pull
+# or specify output file
+commet pull -o types/commet.d.ts
+```
+
+Creates `.commet.d.ts` with your event and seat types:
+
 ```typescript
-import { Commet } from 'commet';
+// .commet.d.ts
+export type CommetEventType = "api_call" | "email_sent" | "payment_processed";
+export type CommetSeatType = "admin" | "editor" | "viewer";
+```
 
-const commet = new Commet({
-  apiKey: process.env.COMMET_API_KEY!,
-});
+Use with the SDK:
+
+```typescript
+import { Commet } from '@commet/node';
+import type { CommetEventType, CommetSeatType } from './.commet';
 
-// Track usage
-await commet.usage.events.create({
-  eventType: 'api_call',
+const commet = new Commet({ apiKey: '...' });
+
+// Type-safe event tracking
+await commet.usage.events.create<CommetEventType>({
   customerId: 'cus_123',
+  eventType: 'api_call', // Autocomplete works!
+  timestamp: new Date().toISOString(),
 });
 
-// Manage seats
-await commet.seats.add('cus_123', 'admin', 5);
+// Type-safe seat management
+await commet.seats.add<CommetSeatType>('cus_123', 'admin', 5);
+```
 
-// Create customer
-const customer = await commet.customers.create({
-  legalName: 'Acme Corporation',
-  currency: 'USD',
-  address: { /* address info */ }
-});
+### Type Inspection
+
+#### `commet list events`
+
+List all event types in your organization.
+
+```bash
+commet list events
 ```
 
-## Documentation
+#### `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`)
+
+Stores project-specific configuration. Created by `commet link`.
+
+```json
+{
+  "orgId": "org_123",
+  "orgName": "My Organization",
+  "environment": "sandbox"
+}
+```
+
+**Note:** 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** (`billing.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"
+commet link   # Choose your organization
+
+# 2. Generate types when you add/change event or seat types
+commet pull
+
+# 3. Use types in your code with autocomplete
+# (see TypeScript examples above)
+
+# 4. When ready for production
+commet logout
+commet login  # Select "Production"
+commet link   # Link to production organization
+commet pull   # Generate production types
+```
+
+## Troubleshooting
+
+### "Not authenticated"
+
+Run `commet login` to authenticate.
+
+### "Project not linked"
+
+Run `commet link` to connect your project to an organization.
+
+### "No types found"
+
+Create event types and seat types in your Commet dashboard first, then run `commet pull`.
+
+### 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)
+
+## License
+
+MIT
 
-See [docs](https://docs.commet.co) for complete documentation.

package/bin/commet

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../dist/index.js');