ZIP-562/v0.2.0-beta

[ericlakich]

This pull request introduces a comprehensive integration of TaxCloud API for order management and adds automated version checking to the CI workflow. The changes include new environment variables and configuration options, detailed documentation, and a robust GitHub Actions workflow to enforce semantic versioning and changelog updates. These improvements enhance both the functionality of the SDK and the reliability of the development process.

TaxCloud API Integration & Configuration:

• Added TaxCloud API credentials (TAXCLOUD_CONNECTION_ID, TAXCLOUD_API_KEY) to .env.example for order management support.
• Updated CHANGELOG.md to document TaxCloud integration, new endpoints (CreateOrder, GetOrder, UpdateOrder, RefundOrder, GetRatesByPostalCode), new configuration options, TypeScript types, and examples.

Documentation Improvements:

• Added .github/workflows/README.md with detailed explanations for all CI workflows, semantic versioning guidelines, troubleshooting, best practices, and contributing instructions.

CI/CD Workflow Enhancements:

• Introduced .github/workflows/version-check.yml GitHub Actions workflow to enforce version bumps, validate semantic versioning, check for changelog updates, and provide automated PR feedback.

[Copilot]

Pull request overview

Integrates optional TaxCloud order-management APIs into the SDK (new client methods + TypeScript models), updates docs/examples accordingly, and bumps the package to 0.2.0-beta while tightening validation and HTTP error handling.

Changes:

• Added TaxCloud order methods to ZiptaxClient (createOrder, getOrder, updateOrder, refundOrder) plus new TaxCloud models/exports.
• Enhanced HTTPClient with PATCH support and response-body error detection; updated historical date validation to YYYYMM.
• Updated docs/spec/examples/tests/changelog/env template and bumped package version + lockfile.

Reviewed changes

Copilot reviewed 20 out of 21 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
tests/taxcloud-orders.test.ts	New Jest coverage for TaxCloud order CRUD/refunds + config errors.
tests/http.test.ts	Updates expected User-Agent version in constructor test.
tests/client.test.ts	Updates account-metrics fixture fields; expands historical format validation tests.
src/utils/http.ts	Adds dynamic-ish User-Agent, patch(), and response-body error checks.
src/models/taxcloud.ts	New TaxCloud request/response model interfaces for orders/refunds.
src/models/responses.ts	Updates V60AccountMetrics shape to request_* fields.
src/models/index.ts	Re-exports TaxCloud models.
src/index.ts	Exports additional config/types including TaxCloud + postal-code response types.
src/config.ts	Adds TaxCloud credentials to config and updates historical doc to YYYYMM.
src/client.ts	Adds TaxCloud HTTP client + order methods; updates historical regex validation.
package.json	Bumps to 0.2.0-beta and adds example:taxcloud script.
package-lock.json	Updates package metadata/version and axios resolution.
examples/taxcloud-orders.ts	New runnable TaxCloud order-management example.
examples/basic-usage.ts	Updates metrics field names to new request_* shape.
docs/spec.yaml	Documents dual ZipTax/TaxCloud APIs, endpoints, models, and YYYYMM historical format.
README.md	Adds TaxCloud docs + postal-code section; updates historical format + metrics fields.
CONTRIBUTING.md	New contribution/versioning guidelines and workflow expectations.
CLAUDE.md	New repo context/architecture notes (incl. dual API support and workflow expectations).
CHANGELOG.md	Adds 0.2.0-beta release notes covering TaxCloud, validation, and workflow changes.
.github/workflows/README.md	New CI workflow documentation (incl. version-check behavior).
.env.example	Adds TaxCloud env vars for examples/features.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.