{"id":17617350,"url":"https://github.com/lundjrl/directus-types-endpoint","last_synced_at":"2026-01-03T09:43:01.942Z","repository":{"id":249998089,"uuid":"832663161","full_name":"lundjrl/directus-types-endpoint","owner":"lundjrl","description":"Endpoint to generate schema types for TS development.","archived":false,"fork":false,"pushed_at":"2024-07-26T17:21:00.000Z","size":70,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-17T04:40:39.550Z","etag":null,"topics":["directus","directus-extension","directus-extension-endpoint","typescript"],"latest_commit_sha":null,"homepage":"","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/lundjrl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2024-07-23T13:24:58.000Z","updated_at":"2024-09-26T11:22:35.000Z","dependencies_parsed_at":"2024-10-23T01:51:57.734Z","dependency_job_id":"db2f5287-8ef7-4e87-afa2-ba10e9c1e1ce","html_url":"https://github.com/lundjrl/directus-types-endpoint","commit_stats":null,"previous_names":["lundjrl/directus-types-endpoint"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lundjrl%2Fdirectus-types-endpoint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lundjrl%2Fdirectus-types-endpoint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lundjrl%2Fdirectus-types-endpoint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lundjrl%2Fdirectus-types-endpoint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lundjrl","download_url":"https://codeload.github.com/lundjrl/directus-types-endpoint/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244166840,"owners_count":20409206,"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":["directus","directus-extension","directus-extension-endpoint","typescript"],"created_at":"2024-10-22T19:12:46.425Z","updated_at":"2026-01-03T09:43:01.879Z","avatar_url":"https://github.com/lundjrl.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Types Endpoint for Directus\n\n   \u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\n          \u003cimg alt=\"License MIT\" src=\"https://img.shields.io/badge/License-MIT-yellow.svg?color=blue\" /\u003e\n        \u003c/a\u003e\n\nThis extension exposes your Directus schema to an endpoint.\nIt is specifically designed to be passed as the \"SCHEMA\" interface in the Directus client SDK but is certainly not limited to that.\n\n\u003e [!IMPORTANT]  \n\u003e This work was greatly inspired from [maltejur's generate types extension](https://www.npmjs.com/package/directus-extension-generate-types),\n\u003e however our team needed something that would expose an endpoint and work with newer versions of Directus. We sincerely hope you find it useful ☺️\n\n\u003e [!WARNING]  \n\u003e It is not recommended to expose your database schema in production. We use this tool to generate a types file and commit it to git.\n\u003e We recommend you do the same.\n\n## Requirements\n\nThis extensions only works with Directus 10 and higher.\n\n## Installation\n\nAdd `directus-extension-types` as a dependency to your directus app.\n\n```bash\n# Using npm\nnpm install directus-extension-types\n# Using bun\nbun install directus-extension-types\n# Using yarn\nyarn add directus-extension-types\n# Using pnpm\npnpm add directus-extension-types\n```\n\n## Usage\n\n### Getting types\n\nAfter installation, the extension should be good to go.\nTo get your types, you'll need to ping the `/types` endpoint of your application.\n\nEx: `http://localhost:8055/types`\n\n### Using types\n\nThis endpoint is typically used to auto-generate the `SCHEMA` interface for the Directus client sdk.\n\nThe endpoint has a type called `CustomDirectusTypes`, this is your `SCHEMA` interface. Use that in your client SDK and see your types match the model of your back-end.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flundjrl%2Fdirectus-types-endpoint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flundjrl%2Fdirectus-types-endpoint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flundjrl%2Fdirectus-types-endpoint/lists"}