{"id":28261154,"url":"https://github.com/udamir/youtrack-workflow-api-types","last_synced_at":"2026-01-20T16:53:52.663Z","repository":{"id":292724219,"uuid":"981708102","full_name":"udamir/youtrack-workflow-api-types","owner":"udamir","description":"TypeScript definitions for the JetBrains YouTrack Scripting API","archived":false,"fork":false,"pushed_at":"2025-08-20T20:00:33.000Z","size":116,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-22T03:51:37.472Z","etag":null,"topics":["typescript-definitions","youtrack","youtrack-workflow"],"latest_commit_sha":null,"homepage":"","language":null,"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/udamir.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,"zenodo":null}},"created_at":"2025-05-11T18:03:49.000Z","updated_at":"2025-09-19T14:51:44.000Z","dependencies_parsed_at":"2025-05-11T20:35:38.734Z","dependency_job_id":null,"html_url":"https://github.com/udamir/youtrack-workflow-api-types","commit_stats":null,"previous_names":["udamir/youtrack-workflow-api-types"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/udamir/youtrack-workflow-api-types","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/udamir%2Fyoutrack-workflow-api-types","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/udamir%2Fyoutrack-workflow-api-types/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/udamir%2Fyoutrack-workflow-api-types/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/udamir%2Fyoutrack-workflow-api-types/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/udamir","download_url":"https://codeload.github.com/udamir/youtrack-workflow-api-types/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/udamir%2Fyoutrack-workflow-api-types/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278786692,"owners_count":26045588,"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","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["typescript-definitions","youtrack","youtrack-workflow"],"created_at":"2025-05-20T05:12:30.232Z","updated_at":"2025-10-07T13:47:04.226Z","avatar_url":"https://github.com/udamir.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# JetBrains YouTrack Scripting API TypeScript Definitions\n\u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/v/youtrack-workflow-api-types\"\u003e \u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/dm/youtrack-workflow-api-types?label=npm\"\u003e \n\u003cimg alt=\"npm type definitions\" src=\"https://img.shields.io/npm/types/youtrack-workflow-api-types\"\u003e  \u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/udamir/youtrack-workflow-api-types\"\u003e\n\nTypeScript definitions for the JetBrains YouTrack Scripting API.\n\n## Installation\n\n```shell\nnpm install --save-dev youtrack-workflow-api-types\n```\n\n## Usage\n\nAdd `paths` to your project's `tsconfig.json` with following content:\n\n```json\n{\n  \"compilerOptions\": {\n    \"checkJs\": true,\n    \"allowJs\": true,\n    \"resolveJsonModule\": true,\n    \"moduleResolution\": \"node\",\n    \"target\": \"es2021\",\n    \"module\": \"commonjs\",\n    \"baseUrl\": \".\",\n    \"paths\": {\n      \"@jetbrains/youtrack-scripting-api\": [\"node_modules/youtrack-workflow-api-types\"],\n      \"@jetbrains/youtrack-scripting-api/*\": [\"node_modules/youtrack-workflow-api-types/*\"]\n    }\n  },\n  \"include\": [\n    \"**/*.js\"\n  ],\n  \"exclude\": [\n    \"node_modules\"\n  ]\n}\n```\n\n## Generic types\n\n### Issue\n\n```typescript\n/**\n * Represents an issue in YouTrack.\n * @template F The type of the issue fields.\n * @template W The type of the workflow.\n */\nexport class Issue\u003cF extends IssueFields, W extends string\u003e extends BaseEntity \n```\n\n### IssueWorkItem\n\n```typescript\n/**\n * Represents a work item that has been added to an issue.\n * @template T The type of the work item.\n */\nexport class IssueWorkItem\u003cT extends string\u003e extends BaseWorkItem\u003cT\u003e\n```\n\n## Autogenerated project custom fields and work item types definitions\n\nYou can use [`youtrack-workflow-cli`](https://github.com/udamir/youtrack-workflow-cli) tool to generate project custom fields and work item types definitions.\n\nFirst, you need to initialize a new project:\n```shell\nnpx youtrack-workflow-cli init [project-name]\n\ncd [project-name]\n\nnpm install\n\n```\n\nThen, you can generate types:\n```shell\nnpx ytw types [\u003cyoutrack-project-short-name\u003e...]\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fudamir%2Fyoutrack-workflow-api-types","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fudamir%2Fyoutrack-workflow-api-types","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fudamir%2Fyoutrack-workflow-api-types/lists"}