/smartsheet-typescript

(Discontinued) An end-to-end type-safe, declarative, and intuitive Smartsheet SDK for TypeScript.

Primary LanguageTypeScriptMIT LicenseMIT

Warning

Due to an unforeseen decision, ECA Solar LLC can no longer support the development of this project. Our team really appreciate the past support from ECA. If you are intersted in the future of this project, please head to new repository for future updates or PRs.

Cover

Smartsheet TypeScript SDK (Monorepo)

IMPORTANT: Maintenance and development has fully stopped for this repo. Please head to new repository for future updates or PRs.

Package Documentation

Visit the package README for more information.

Development Roadmap

  • Base architecture for end-to-end type-safety SDK
  • Smartsheet API Authentication and fetcher
  • Basic verification test of sheets, columns, rows, and cells execution
  • Sheets
  • Columns
  • Rows
    • Cells
    • Cell types
    • Cell formats
  • Schema definition support and type hints
  • Attachments
  • Importing and Exporting
  • Arbitrary error handling
  • Complex structure verification (TBD)

Development Guide

1. Install dependencies

bun install
# or
npm install
# or
yarn install
# or
pnpm install

Bun runtime is recommended for the development of this package.

2. Set up environment variables for local development

cp .env.example .env

3. Run the example script defined in ./example/index.ts

bun dev

Versioning

We are using SemVer for versioning. In addition to that, we have added dev tag for the development version, such as 1.0.0-dev.1.

As a contributor, you can consider using bun version dev to bump up the development version when needed. This version will not be released to the public.

When it is ready to be finalized, you can use bun version <major|minor|patch> to bump up the version to the next stable version with proper change size.