{"id":24764495,"url":"https://github.com/seamapi/types","last_synced_at":"2026-04-22T05:08:13.803Z","repository":{"id":180475289,"uuid":"664876046","full_name":"seamapi/types","owner":"seamapi","description":"TypeScript types for the Seam API.","archived":false,"fork":false,"pushed_at":"2026-04-01T14:05:17.000Z","size":29564,"stargazers_count":3,"open_issues_count":3,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-04-02T02:39:08.981Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://types.seam.vc","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/seamapi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-07-11T00:37:46.000Z","updated_at":"2026-04-01T14:05:25.000Z","dependencies_parsed_at":"2026-01-02T21:10:53.081Z","dependency_job_id":"7f6c8f39-b6ee-4afd-979f-da219bd1f06b","html_url":"https://github.com/seamapi/types","commit_stats":null,"previous_names":["seamapi/types"],"tags_count":1020,"template":false,"template_full_name":null,"purl":"pkg:github/seamapi/types","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seamapi%2Ftypes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seamapi%2Ftypes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seamapi%2Ftypes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seamapi%2Ftypes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/seamapi","download_url":"https://codeload.github.com/seamapi/types/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seamapi%2Ftypes/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31483380,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-06T17:22:55.647Z","status":"ssl_error","status_checked_at":"2026-04-06T17:22:54.741Z","response_time":112,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-28T22:31:53.308Z","updated_at":"2026-04-06T18:00:56.614Z","avatar_url":"https://github.com/seamapi.png","language":"TypeScript","readme":"# Seam API Types\n\n[![npm](https://img.shields.io/npm/v/@seamapi/types.svg)](https://www.npmjs.com/package/@seamapi/types)\n[![GitHub Actions](https://github.com/seamapi/types/actions/workflows/check.yml/badge.svg)](https://github.com/seamapi/types/actions/workflows/check.yml)\n\nTypeScript types for the Seam API.\n\n## Description\n\nThis repository aggregates the latest route schemas and type definitions for the Seam API.\nUpstream Seam repositories automatically contribute updates on every deployment\nvia a Pull Request opened by Seam Bot.\nThis ensures downstream consumers, e.g., the SDK, fakes, documentation generators, etc.,\nhave a single source of truth that stays up to date with the API.\n\n### Structure\n\nThere is dedicated entrypoint for each Seam API namespace.\nThe main entrypoint for this module is re-exports the connect namespace.\n\nEach directory under `src/lib/seam/*` is owned by an upstream Seam repository.\nThese files should not be edited manually as they will be overridden by automation.\n\nEach entrypoint may export one or more of the following:\n\n- Zod schemas: collectively exported as a single object named `schemas`.\n- Types: derived directly from the [Zod Schemas][zod] and exported at the top level.\n- A separate collection of Zod schmeas named `routes`.\n- A type named `Routes` that implements the\n  [Route Definition interface from typed-axios][typed-axios Route Definition].\n- The OpenAPI schema as a plain object named `openapi`.\n\n[nextlove]: https://github.com/seamapi/nextlove\n[typed-axios Route Definition]: https://github.com/seamapi/typed-axios#route-definition\n[OpenAPI]: https://www.openapis.org/\n[zod]: https://zod.dev/\n\n## Installation\n\n_This is a low-level package meant for applications and libraries with particular dependency requirements.\nThese types and schemas are entirely contained in the [seam package]. Seam recommends using that package instead\nfor simpler dependency management._\n\n### Types Only\n\nAdd this as a development dependency to your project using [npm] with\n\n```\n$ npm install --save-dev @seamapi/types\n```\n\n### Types and Zod Schemas\n\nAdd this as a dependency to your project using [npm] with\n\n```\n$ npm install @seamapi/types\n```\n\n[npm]: https://www.npmjs.com/\n[seam package]: https://www.npmjs.com/package/seam\n\n## Development and Testing\n\n### Quickstart\n\n```\n$ git clone https://github.com/seamapi/types.git\n$ cd types\n$ nvm install\n$ npm install\n```\n\nPrimary development tasks are defined under `scripts` in `package.json`\nand available via `npm run`.\nView them with\n\n```\n$ npm run\n```\n\n### Source code\n\nThe [source code] is hosted on GitHub.\nClone the project with\n\n```\n$ git clone git@github.com:seamapi/types.git\n```\n\n[source code]: https://github.com/seamapi/types\n\n### Requirements\n\nYou will need [Node.js] with [npm] and a [Node.js debugging] client.\n\nBe sure that all commands run under the correct Node version, e.g.,\nif using [nvm], install the correct version with\n\n```\n$ nvm install\n```\n\nSet the active version for each shell session with\n\n```\n$ nvm use\n```\n\nInstall the development dependencies with\n\n```\n$ npm install\n```\n\n[Node.js]: https://nodejs.org/\n[Node.js debugging]: https://nodejs.org/en/docs/guides/debugging-getting-started/\n[npm]: https://www.npmjs.com/\n[nvm]: https://github.com/creationix/nvm\n\n### Publishing\n\n#### Automatic\n\nNew versions are released automatically with [semantic-release]\nas long as commits follow the [Angular Commit Message Conventions].\n\n[Angular Commit Message Conventions]: https://semantic-release.gitbook.io/semantic-release/#commit-message-format\n[semantic-release]: https://semantic-release.gitbook.io/\n\n#### Manual\n\nPublish a new version by triggering a [version workflow_dispatch on GitHub Actions].\nThe `version` input will be passed as the first argument to [npm-version].\n\nThis may be done on the web or using the [GitHub CLI] with\n\n```\n$ gh workflow run version.yml --raw-field version=\u003cversion\u003e\n```\n\n[GitHub CLI]: https://cli.github.com/\n[npm-version]: https://docs.npmjs.com/cli/version\n[version workflow_dispatch on GitHub Actions]: https://github.com/seamapi/types/actions?query=workflow%3Aversion\n\n## GitHub Actions\n\n_GitHub Actions should already be configured: this section is for reference only._\n\nThe following repository secrets must be set on [GitHub Actions]:\n\n- `GH_TOKEN`: A personal access token for the bot user with\n  `packages:write` and `contents:write` permission.\n- `GIT_USER_NAME`: The GitHub bot user's real name.\n- `GIT_USER_EMAIL`: The GitHub bot user's email.\n- `GPG_PRIVATE_KEY`: The GitHub bot user's [GPG private key].\n- `GPG_PASSPHRASE`: The GitHub bot user's GPG passphrase.\n\n[GitHub Actions]: https://github.com/features/actions\n[GPG private key]: https://github.com/marketplace/actions/import-gpg#prerequisites\n\n## Contributing\n\n\u003e If using squash merge, edit and ensure the commit message follows the [Angular Commit Message Conventions] specification.\n\u003e Otherwise, each individual commit must follow the [Angular Commit Message Conventions] specification.\n\n1. Create your feature branch (`git checkout -b my-new-feature`).\n2. Make changes.\n3. Commit your changes (`git commit -am 'Add some feature'`).\n4. Push to the branch (`git push origin my-new-feature`).\n5. Create a new draft pull request.\n6. Ensure all checks pass.\n7. Mark your pull request ready for review.\n8. Wait for the required approval from the code owners.\n9. Merge when ready.\n\n[Angular Commit Message Conventions]: https://semantic-release.gitbook.io/semantic-release/#commit-message-format\n\n## License\n\nThis npm package is licensed under the MIT license.\n\n## Warranty\n\nThis software is provided by the copyright holders and contributors \"as is\" and\nany express or implied warranties, including, but not limited to, the implied\nwarranties of merchantability and fitness for a particular purpose are\ndisclaimed. In no event shall the copyright holder or contributors be liable for\nany direct, indirect, incidental, special, exemplary, or consequential damages\n(including, but not limited to, procurement of substitute goods or services;\nloss of use, data, or profits; or business interruption) however caused and on\nany theory of liability, whether in contract, strict liability, or tort\n(including negligence or otherwise) arising in any way out of the use of this\nsoftware, even if advised of the possibility of such damage.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseamapi%2Ftypes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseamapi%2Ftypes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseamapi%2Ftypes/lists"}