Skip to content

Commit 02d7a0d

Browse files
serslonserslon
committed
feat: Astrology API TypeScript SDK v0.1.0
Complete TypeScript SDK for RapidAPI Astrology API with: - Modular category-based client architecture - Full TypeScript types generated from OpenAPI spec - Axios-powered HTTP layer with retry/backoff - 100% test coverage with Vitest - CI/CD workflows for manual releases 🤖 Generated with [Claude Code](https://claude.ai/code)
0 parents  commit 02d7a0d

73 files changed

Lines changed: 50616 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.cursorrules‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## Project Overview
2+
- Package: `@procoders/astrology-api-client`
3+
- Purpose: TypeScript SDK for https://api.astrology-api.io (OpenAPI spec saved in `docs-openapi.json`)
4+
- Runtime: Node.js (ES modules)
5+
- HTTP layer: Axios with request/response interceptors, automatic retry logic, strict validation
6+
- Tests: Vitest with 100% coverage enforced (`npm run test:coverage`)
7+
8+
## Directory Layout
9+
- `src/client.ts` — core client implementation
10+
- `src/types/` — strongly typed configs, requests, and responses
11+
- `src/errors/` — custom error hierarchy (`AstrologyError`)
12+
- `src/utils/validators.ts` — runtime validation helpers used prior to network calls
13+
- `tests/` — unit tests with axios-mock-adapter (keep coverage at 100%)
14+
- `examples/usage.ts` — sample usage (guarded by `RUN_ASTROLOGY_EXAMPLE` flag)
15+
- `docs-openapi.json` — locally cached OpenAPI v3 spec (use for type references)
16+
17+
## Coding Guidelines
18+
- Always prefer type-safe solutions; keep files in strict TypeScript.
19+
- Keep code DRY, KISS, and single-responsibility. Extract helpers if logic repeats.
20+
- Comments, docs, and logs MUST be written in English.
21+
- When adding HTTP endpoints ensure:
22+
- URL assembled via RapidAPI base URL (default from `DEFAULT_RAPIDAPI_HOST`)
23+
- RapidAPI headers are set (`x-rapidapi-key`, `x-rapidapi-host`)
24+
- Environment variables: `RAPIDAPI_KEY`, `RAPIDAPI_HOST`, `ASTROLOGY_API_BASE_URL`
25+
- Payload validated via `validators.ts`.
26+
- For additions touching API schema, consult `docs-openapi.json` first.
27+
- Update or add Vitest suites and maintain 100% coverage. Use axios-mock-adapter for HTTP mocks.
28+
- Run `npm run lint` and `npm run test:coverage` before completion.
29+
30+
## Documentation & Examples
31+
- README must show installation, configuration, environment variables, and code snippets.
32+
- When adding examples, wrap network calls with environment checks so examples do not run by default.
33+
34+
## Tooling
35+
- ESLint + Prettier already configured; match formatting in existing files.
36+
- Coverage enforced in `vitest.config.ts`. If coverage drops, add tests instead of raising thresholds.
37+
38+
## PR / Commit Checklist
39+
1. Update relevant types in `src/types/`.
40+
2. Keep public API exported via `src/index.ts`.
41+
3. Add/adjust tests to maintain 100% coverage.
42+
4. Document new features in README.
43+
5. Ensure `.cursorrules` stays aligned with architecture changes.
44+

‎.github/release.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Configuration for GitHub's automatically generated release notes
2+
changelog:
3+
exclude:
4+
labels:
5+
- ignore-for-release
6+
authors:
7+
- github-actions[bot]
8+
- dependabot[bot]
9+
categories:
10+
- title: 🚀 Features
11+
labels:
12+
- feature
13+
- enhancement
14+
- title: 🐛 Bug Fixes
15+
labels:
16+
- bug
17+
- fix
18+
- title: 📚 Documentation
19+
labels:
20+
- documentation
21+
- docs
22+
- title: 🧪 Tests
23+
labels:
24+
- test
25+
- testing
26+
- title: 🔧 Maintenance
27+
labels:
28+
- chore
29+
- maintenance
30+
- dependencies
31+
- title: 🔒 Security
32+
labels:
33+
- security
34+
- title: ⚡ Performance
35+
labels:
36+
- performance
37+
- title: Other Changes
38+
labels:
39+
- '*'

‎.github/workflows/ci.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [master]
6+
pull_request:
7+
branches: [master]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
13+
strategy:
14+
matrix:
15+
node-version: [22]
16+
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@v4
20+
21+
- name: Setup Node.js ${{ matrix.node-version }}
22+
uses: actions/setup-node@v4
23+
with:
24+
node-version: ${{ matrix.node-version }}
25+
cache: 'npm'
26+
27+
- name: Install dependencies
28+
run: npm install
29+
30+
- name: Run linting
31+
run: npm run lint
32+
33+
- name: Run tests with coverage
34+
run: npm run test:coverage
35+
36+
- name: Build package
37+
run: npm run build
38+
39+
- name: Upload coverage reports
40+
if: matrix.node-version == 20
41+
uses: codecov/codecov-action@v4
42+
with:
43+
token: ${{ secrets.CODECOV_TOKEN }}
44+
fail_ci_if_error: false
45+
46+
commitlint:
47+
runs-on: ubuntu-latest
48+
if: github.event_name == 'pull_request'
49+
50+
steps:
51+
- name: Checkout repository
52+
uses: actions/checkout@v4
53+
with:
54+
fetch-depth: 0
55+
56+
- name: Setup Node.js
57+
uses: actions/setup-node@v4
58+
with:
59+
node-version: 22
60+
cache: 'npm'
61+
62+
- name: Install dependencies
63+
run: npm install
64+
65+
- name: Validate PR commits
66+
run: npx commitlint --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }} --verbose

‎.github/workflows/manual-release.yml‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: Manual Release
2+
3+
on:
4+
workflow_dispatch:
5+
inputs:
6+
release_type:
7+
description: 'Release type'
8+
required: true
9+
type: choice
10+
options:
11+
- patch
12+
- minor
13+
- major
14+
dry_run:
15+
description: 'Dry run (no actual release)'
16+
required: false
17+
type: boolean
18+
default: false
19+
20+
permissions:
21+
contents: write
22+
issues: write
23+
pull-requests: write
24+
id-token: write
25+
26+
jobs:
27+
manual-release:
28+
runs-on: ubuntu-latest
29+
30+
steps:
31+
- name: Checkout repository
32+
uses: actions/checkout@v4
33+
with:
34+
fetch-depth: 0
35+
token: ${{ secrets.GITHUB_TOKEN }}
36+
37+
- name: Setup Node.js
38+
uses: actions/setup-node@v4
39+
with:
40+
node-version: 22
41+
cache: 'npm'
42+
43+
- name: Install dependencies
44+
run: npm install
45+
46+
- name: Run tests
47+
run: npm run test:coverage
48+
49+
- name: Build package
50+
run: npm run build
51+
52+
- name: Configure Git
53+
run: |
54+
git config user.name "github-actions[bot]"
55+
git config user.email "github-actions[bot]@users.noreply.github.com"
56+
57+
- name: Bump version
58+
id: version
59+
run: |
60+
npm version ${{ inputs.release_type }} --no-git-tag-version
61+
NEW_VERSION=$(node -p "require('./package.json').version")
62+
echo "new_version=$NEW_VERSION" >> $GITHUB_OUTPUT
63+
64+
- name: Commit and push version bump
65+
if: ${{ !inputs.dry_run }}
66+
run: |
67+
git add package.json package-lock.json
68+
git commit -m "chore(release): v${{ steps.version.outputs.new_version }}"
69+
git tag "v${{ steps.version.outputs.new_version }}"
70+
git push origin master --tags
71+
72+
- name: Publish to NPM
73+
if: ${{ !inputs.dry_run }}
74+
run: npm publish --access public
75+
env:
76+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
77+
78+
- name: Create GitHub Release
79+
if: ${{ !inputs.dry_run }}
80+
uses: softprops/action-gh-release@v2
81+
with:
82+
tag_name: v${{ steps.version.outputs.new_version }}
83+
name: Release v${{ steps.version.outputs.new_version }}
84+
generate_release_notes: true
85+
env:
86+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
87+
88+
- name: Dry run summary
89+
if: ${{ inputs.dry_run }}
90+
run: |
91+
echo "🧪 Dry run completed!"
92+
echo "Would have released version: ${{ steps.version.outputs.new_version }}"

‎.github/workflows/release.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Release
2+
3+
# Automatic release disabled - use manual-release.yml instead
4+
# To re-enable, uncomment the push trigger below
5+
on:
6+
workflow_dispatch:
7+
# push:
8+
# branches: [master]
9+
10+
permissions:
11+
contents: write
12+
issues: write
13+
pull-requests: write
14+
id-token: write
15+
16+
jobs:
17+
release:
18+
runs-on: ubuntu-latest
19+
if: github.repository == 'procoders/astrology-typescript'
20+
21+
steps:
22+
- name: Checkout repository
23+
uses: actions/checkout@v4
24+
with:
25+
fetch-depth: 0
26+
persist-credentials: false
27+
28+
- name: Setup Node.js
29+
uses: actions/setup-node@v4
30+
with:
31+
node-version: 22
32+
cache: 'npm'
33+
34+
- name: Install dependencies
35+
run: npm install
36+
37+
- name: Build package
38+
run: npm run build
39+
40+
- name: Run tests
41+
run: npm run test:coverage
42+
43+
- name: Semantic Release
44+
env:
45+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
46+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
47+
run: npx semantic-release

‎.gitignore‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
node_modules/
2+
dist/
3+
*.cjs
4+
*.d.cts
5+
coverage/
6+
.env
7+
.env.*
8+
.DS_Store
9+
npm-debug.log*
10+
pnpm-debug.log*
11+
vite.config.ts.timestamp-*
12+
.vitest
13+
.dist

‎.husky/commit-msg‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
npx --no -- commitlint --edit $1

‎.prettierrc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"singleQuote": true,
3+
"printWidth": 120,
4+
"semi": true,
5+
"trailingComma": "all",
6+
"arrowParens": "always"
7+
}
8+

‎.releaserc.json‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"branches": ["master"],
3+
"plugins": [
4+
"@semantic-release/commit-analyzer",
5+
"@semantic-release/release-notes-generator",
6+
[
7+
"@semantic-release/changelog",
8+
{
9+
"changelogFile": "CHANGELOG.md"
10+
}
11+
],
12+
"@semantic-release/npm",
13+
[
14+
"@semantic-release/git",
15+
{
16+
"assets": ["package.json", "package-lock.json", "CHANGELOG.md"],
17+
"message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
18+
}
19+
],
20+
"@semantic-release/github"
21+
]
22+
}

‎CHANGELOG.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.1.0] - 2024-01-01
9+
10+
### Added
11+
12+
- Initial release of `@procoders/astrology-api-client`
13+
- Core API client with configurable base URL and authentication
14+
- Support for natal chart calculations
15+
- Support for transit calculations
16+
- Support for synastry analysis
17+
- Full TypeScript support with comprehensive type definitions
18+
- ESM and CommonJS module support
19+
- Comprehensive test coverage

0 commit comments

Comments
 (0)