Add user agent for requests.

[jmoseley]

Summary by CodeRabbit

• New Features
  • Updated the package version for the project to indicate new features or bug fixes.
  • Enhanced API client to include a dynamic User-Agent header for improved tracking and version management in HTTP requests.
• Improvements
  • Enabled JSON module resolution in TypeScript, allowing for seamless imports of JSON files, enhancing data handling capabilities.

[coderabbitai]

Walkthrough

This update presents a version increment in package.json from 0.0.8 to 0.0.9, indicating active development. The CortexApiClient class in src/api-client.ts has been enhanced by incorporating a dynamic User-Agent header in HTTP requests, which improves version tracking and debugging. Furthermore, the tsconfig.json file now permits direct imports of JSON files, facilitating smoother data handling in TypeScript.

Changes

File	Change Summary
package.json	Bumped version from 0.0.8 to 0.0.9, indicating a new software release.
src/api-client.ts	Enhanced CortexApiClient by adding dynamic User-Agent headers to requests.
tsconfig.json	Uncommented JSON module resolution to enable direct imports of .json files.

Poem

🐰 In a world of code, we hop and play,
Version numbers change, brightening the day.
With headers that tell us just who we are,
Our API dances, a shining star!
JSON welcomes us, a cheerful embrace,
Together we leap, in this tech-filled space! 🌟

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 91b2eec and d2d693c.

Files selected for processing (3)

• package.json (1 hunks)
• src/api-client.ts (3 hunks)
• tsconfig.json (1 hunks)

Files skipped from review due to trivial changes (1)

• package.json

Additional comments not posted (3)

src/api-client.ts (2)

1-1: LGTM! Import statement is correct.

The import statement correctly imports the version from package.json.

---

43-43: LGTM! User-Agent header correctly added.

The User-Agent header is correctly added using the version information from package.json.

Ensure that the POSTForm and makeRequest methods are used correctly in the codebase.

Also applies to: 62-62

Verification successful

---

LGTM! User-Agent header correctly added.

The User-Agent header is correctly added using the version information from package.json. The POSTForm and makeRequest methods are used correctly in the codebase.

• POSTForm is defined in src/api-client.ts and used in src/catalog.ts.
• makeRequest is defined and used in src/api-client.ts.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of `POSTForm` and `makeRequest` methods in the codebase.

# Test: Search for the method usage. Expect: Correct usage of the methods.
rg --type python -A 5 $'POSTForm'
rg --type python -A 5 $'makeRequest'

Length of output: 130

---

Script:

#!/bin/bash
# Description: Verify the usage of `POSTForm` and `makeRequest` methods in the codebase.

# Test: Search for the method usage. Expect: Correct usage of the methods.
rg --type typescript -A 5 $'POSTForm'
rg --type typescript -A 5 $'makeRequest'

Length of output: 146

---

Script:

#!/bin/bash
# Description: Verify the usage of `POSTForm` and `makeRequest` methods in the codebase.

# Test: Search for the method usage. Expect: Correct usage of the methods.
rg --type ts -A 5 $'POSTForm'
rg --type ts -A 5 $'makeRequest'

Length of output: 1970

tsconfig.json (1)

45-45: LGTM! JSON module resolution enabled.

The resolveJsonModule option is correctly enabled to allow importing JSON files.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d2d693c and b25cb05.

Files selected for processing (1)

• src/api-client.ts (3 hunks)

Files skipped from review as they are similar to previous changes (1)

• src/api-client.ts