{"id":24764519,"url":"https://github.com/seamapi/blueprint","last_synced_at":"2026-04-02T12:47:59.067Z","repository":{"id":244826833,"uuid":"816385818","full_name":"seamapi/blueprint","owner":"seamapi","description":"Build tools for the Seam API using this blueprint.","archived":false,"fork":false,"pushed_at":"2026-03-03T01:09:47.000Z","size":42352,"stargazers_count":0,"open_issues_count":8,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-03-03T04:50:51.101Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://blueprint.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":"2024-06-17T16:32:28.000Z","updated_at":"2026-01-26T01:35:53.000Z","dependencies_parsed_at":"2024-06-27T02:24:36.532Z","dependency_job_id":"01767bf1-a7a7-45d0-9d02-46b9fb5d7f08","html_url":"https://github.com/seamapi/blueprint","commit_stats":null,"previous_names":["seamapi/blueprint"],"tags_count":116,"template":false,"template_full_name":null,"purl":"pkg:github/seamapi/blueprint","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seamapi%2Fblueprint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seamapi%2Fblueprint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seamapi%2Fblueprint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seamapi%2Fblueprint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/seamapi","download_url":"https://codeload.github.com/seamapi/blueprint/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seamapi%2Fblueprint/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30186780,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-06T14:42:24.748Z","status":"ssl_error","status_checked_at":"2026-03-06T14:42:14.925Z","response_time":250,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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:32:15.414Z","updated_at":"2026-04-02T12:47:59.056Z","avatar_url":"https://github.com/seamapi.png","language":"TypeScript","readme":"# Seam API Blueprint\n\n[![npm](https://img.shields.io/npm/v/@seamapi/blueprint.svg)](https://www.npmjs.com/package/@seamapi/blueprint)\n[![GitHub Actions](https://github.com/seamapi/blueprint/actions/workflows/check.yml/badge.svg)](https://github.com/seamapi/blueprint/actions/workflows/check.yml)\n\nBuild tools for the Seam API using this blueprint.\n\n## Description\n\nA blueprint is a simplified description of an API schema that is optimized for code and documentation generation.\n\nThe blueprint schema assumes the API follows Seam API design guidelines,\nand will evolve with those guidelines and any SDK, documentation, or product quality requirements.\n\nThe blueprint defines the following core concepts:\n\n- Endpoint: a path that accepts an HTTP request and returns a response.\n- Route: the direct parent path of a collection of one or more endpoints.\n- Subroute: a route that is nested under another route.\n- Namespace: the direct parent path of a collection routes only: there are no endpoints under this path.\n- Resource: every endpoint that returns non-empty data returns a resource or a collection of resources.\n\n## Motivation\n\nThe scope of the [OpenAPI Specification](https://swagger.io/specification/) covers arbitrarily complicated APIs,\nwhile the Seam API follows very predictable and simplified API design patterns.\n\nFor this reason, Seam has encountered several challenges working directly with the OpenAPI Specification:\n\n- Existing tools built on the OpenAPI Specification cannot meet Seam's requirements or require non-trivial extensions.\n- Extending the OpenAPI Specification with non-standard properties to support Seam's SDK and documentation requirements\n  is not directly compatible with existing tools.\n- Seam's requirements and scope are overall simpler than the broad use-cases existing tools based on the OpenAPI Specification are trying to solve.\n- All existing Seam tooling must first expend duplicated effort parsing and flattening the OpenAPI Specification into a form more natural to the Seam API.\n- This creates a high barrier of entry for working with the Seam API specification\n  as one must first deeply understand how to parse the OpenAPI Specification for any practical application.\n\nThe blueprint addresses these concerns:\n\n- The blueprint module centralizes on a source of truth for parsing the OpenAPI Specification into something usable.\n- The blueprint schema matches naturally to the Seam API design and is immediately usable for practical application.\n- The blueprint is not limited by the OpenAPI Specification or constrained by the wide scope of supporting any API.\n  It is optimized for Seam's requirements and can evolve faster to meet Seam's specific concerns and integrate directly with other Seam integrated tooling.\n\n## Installation\n\nAdd this as a dependency to your project using [npm] with\n\n```\n$ npm install --save-dev @seamapi/blueprint\n```\n\n[npm]: https://www.npmjs.com/\n\n## Usage\n\n```ts\nimport { createBlueprint, TypesModuleSchema } from '@seamapi/blueprint'\nimport * as types from '@seamapi/types/connect'\n\nconst typesModule = TypesModuleSchema.parse(types)\nconst blueprint = await createBlueprint(typesModule)\nconsole.log(JSON.stringify(blueprint)\n```\n\n## Development and Testing\n\n### Quickstart\n\n```\n$ git clone https://github.com/seamapi/blueprint.git\n$ cd blueprint\n$ nvm install\n$ npm install\n$ npm run test:watch\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/blueprint.git\n```\n\n[source code]: https://github.com/seamapi/blueprint\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/blueprint/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%2Fblueprint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseamapi%2Fblueprint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseamapi%2Fblueprint/lists"}