{"id":22787349,"url":"https://github.com/aserto-dev/console-type-definitions","last_synced_at":"2026-02-13T22:19:49.626Z","repository":{"id":37817460,"uuid":"404116775","full_name":"aserto-dev/console-type-definitions","owner":"aserto-dev","description":"Automated generation of Aserto console-type-definitions.","archived":false,"fork":false,"pushed_at":"2025-03-10T14:00:04.000Z","size":739,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-30T16:16:46.558Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aserto-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-07T20:40:36.000Z","updated_at":"2025-03-10T14:00:07.000Z","dependencies_parsed_at":"2025-03-10T14:44:23.657Z","dependency_job_id":null,"html_url":"https://github.com/aserto-dev/console-type-definitions","commit_stats":null,"previous_names":["aserto-dev/type-definitions"],"tags_count":42,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aserto-dev%2Fconsole-type-definitions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aserto-dev%2Fconsole-type-definitions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aserto-dev%2Fconsole-type-definitions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aserto-dev%2Fconsole-type-definitions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aserto-dev","download_url":"https://codeload.github.com/aserto-dev/console-type-definitions/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251703190,"owners_count":21630194,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":"2024-12-12T00:54:18.594Z","updated_at":"2026-02-13T22:19:44.590Z","avatar_url":"https://github.com/aserto-dev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# console-type-definitions\nAutomated generation of Aserto console-type-definitions.\n\n## Consuming the definitions\nThese definitions can be consumed by `yarn` from `npm registry` or directly from `git` using the following reference:\n```\n\"devDependencies\": {\n    \"@aserto/console-type-definitions\": \"^0.8.83\",\n```\n\nReplace `0.8.83` with the version you would like to use.\n\n## Generation Process\n### Environment Variables\nGeneration is driven by `generate.sh`. To work with the latest specs available in `aserto-dev/openapi-grpc`, invoke `generate.sh --fetch-specs` with the following environment variables set:\n * USERNAME: GitHub username to use when authenticating with the GitHub REST API. Typically this is the value of `\u003cvault\u003e/kv/github/USERNAME`.\n * READ_WRITE_TOKEN: GitHub token enabling at minimum READ access to the GitHub REST API for the `aserto-dev/grpc-openapi` repo. Typically this is the value of `\u003cvault\u003e/kv/github/READ_WRITE_TOKEN`.\n * COMMIT_HASH: the `aserto-dev/grpc-openapi` commit for which to generate type definitions. This value is stored in `downloaded/commit_hash.sh` to enable build reproducability. That file is re-generated each time this repo's workflow is invoked by the GitHub Workflow Dispatch API.\n\n### generate.sh\nWhen invoked with the `--fetch-specs` flag, `generate.sh` uses the Environment Variables to download the appropriate openapi.json files into the `downloaded/specs` directory. It then runs `typescript-openapi` to generate the type definitions. If no flag is provided, then it will run `typescript-openapi` with any existing openapi.json files in `downloaded/specs`.\n\n### Local Dev Experience\nTo run the script locally, set the USERNAME and READ_WRITE_TOKEN as described above and run `./generate.sh` from the workspace root directory. Because the commit_hash is checked in, the build will be identical to how it occured in the GitHub Workflow to generate this commit. To debug an older build, simply check out that commit and follow these same steps.\n\n## GitHub Workflow\nThe GitHub Workflow is triggered as a workflow_dispatch. It expects to be provided with two required parameters:\n- grpc_openapi_commit_hash: The `aserto-dev/grpc-openapi` commit hash for which type definitions should be created. This value is used to download the appropriate version of the `openapi.json` files from that repo.\n- proto_version: The version tag of `aserto-dev/proto` that is represented by the `grpc_openapi_commit_hash`. This is used to tag the `console-type-definitions` commit with the same proto version.\n\nUsing these variables the GitHub Workflow runs the same `./generate.sh` script, commits, and tags its results for downstream consumption. Run results are deterministic as explicit commit hash and version numbers are taken as explicit input parameters.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faserto-dev%2Fconsole-type-definitions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faserto-dev%2Fconsole-type-definitions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faserto-dev%2Fconsole-type-definitions/lists"}