{"id":18735103,"url":"https://github.com/irontec/typescript-generator-bundle","last_synced_at":"2025-04-12T19:12:40.003Z","repository":{"id":36946982,"uuid":"233002761","full_name":"irontec/typescript-generator-bundle","owner":"irontec","description":"Bundle to generate TypeScript elements based on a Symfony project","archived":false,"fork":false,"pushed_at":"2025-01-10T11:19:18.000Z","size":45,"stargazers_count":3,"open_issues_count":2,"forks_count":10,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-04-12T19:12:02.429Z","etag":null,"topics":["doctrine","entity","symfony","symfony-bundle","typescript"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"eupl-1.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/irontec.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2020-01-10T08:37:13.000Z","updated_at":"2025-01-10T11:19:12.000Z","dependencies_parsed_at":"2024-02-15T10:42:57.563Z","dependency_job_id":null,"html_url":"https://github.com/irontec/typescript-generator-bundle","commit_stats":{"total_commits":22,"total_committers":5,"mean_commits":4.4,"dds":0.4545454545454546,"last_synced_commit":"2fa648408c605740d4b55234a7cc3587ece457d6"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irontec%2Ftypescript-generator-bundle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irontec%2Ftypescript-generator-bundle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irontec%2Ftypescript-generator-bundle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irontec%2Ftypescript-generator-bundle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/irontec","download_url":"https://codeload.github.com/irontec/typescript-generator-bundle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248618281,"owners_count":21134201,"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":["doctrine","entity","symfony","symfony-bundle","typescript"],"created_at":"2024-11-07T15:15:46.114Z","updated_at":"2025-04-12T19:12:39.987Z","avatar_url":"https://github.com/irontec.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TypeScriptGeneratorBundle\n\nEste bundle genera complementeos para usar en TypeScript, basados en un proyecto symfony.\n\n# Install\n\n````bash\ncomposer require irontec/typescript-generator-bundle\n````\n\n\u003e PHP *\u003e=8.0*\n\n# Commands\n\n[Generate Interface](#generate-interface)\n[Generate Package](#generate-package)\n[Generate All](#generate-all)\n\n## Generate Interface\n\nEste funcionalidad consiste, en crear interfaces de TypeScript basandose clases PHP pensadas en funcionar como entidades de doctrine.\n\nEstas interfaces se crean teniendo en cuenta las propiedades de estas clases. Como tal se tiene 3 formas de obtener el tipo de cada propiedad.\n\n* Definición del tipado de la propiedad fuerte, disponible desde PHP 7.4\n  * \u003e private int $id;\n* Definición del tipado de la propiedad, en el comentario de esta\n  * \u003e @var int\n* Definición del tipado de la propiedad, en anotaciones de doctrine\n  * \u003e @ORM\\Column(type=\"integer\")\n\nEn caso de no encontrar un tipo, se generara la interface con el tipo \"**unknown**\".\n\n---\n\nLa generación de interfaces se hace ejecutando el siguiente comando:\n\n````bash\nbin/console typescript:generate:interface output-dir [entities-dir]\n````\n\nEste comando acepta 2 parametros, los cuales uno es obligatorio y otro opcional.\n\n**output-dir** [*Obligatorio*]: Directorio donde se crearan las interfaces\n**entities-dir** [*Opcional*]: Directorio de las entidades que se usaran para generar las interfaces. Por defecto se busca en \"**src/Entity/**\"\n\nPara volver una entidad en una interface, es necesario escribir el comentario \"**#TypeScriptMe**\" o  atributo `#[TypeScriptMe]` en la definición de la clase, Ejemplo:\n\n````php\n\u003c?php\nnamespace App\\Entity;\n\n...\n\n/**\n * #TypeScriptMe\n * @ORM\\Entity(repositoryClass=\"App\\Repository\\UserRepository\")\n */\nclass User\n{\n\n...\n````\n\n````php\n\u003c?php\nnamespace App\\Entity;\n\n...\n\n#[TypeScriptMe]\n#[ORM\\Entity(repositoryClass: UserRepository::class)]\nclass User\n{\n\n...\n````\n\n\n### Tipado en TypeScript\n\nListado de tipados soportados:\n\n| TypeScript | PHP/Doctrine |\n|-|-|\n| number | int - integer - smallint - bigint - decimal - float |\n| string | string - text - guid - date - time - datetime - datetimetz |\n| boolean | boolean |\n| interface | Interface de una interface relacionada en un uno a uno |\n| interface[] | Array de interfaces, en una relación uno a muchos |\n| unknown | Cuando no es ninguna de las anteriores |\n\n\u003e Si se usan las anotaciones de dotrine y se tiene definido \"**nullable=true**\" o en el tipado fuerte de la propiedad esta definido el ? antes del tipo, se aplica el ? despues del nombre de la propiedad, que se interpreta como un parametro optativo.\n\n### Example\n\nEntidad en PHP y con anotaciones.\n\n````php\n// src/Entity/User.php\n\u003c?php\n\nnamespace App\\Entity;\n\n/**\n * #TypeScriptMe\n * @ORM\\Table(name=\"user\")\n */\nclass User\n{\n\n   /**\n     * @ORM\\Id\n     * @ORM\\GeneratedValue\n     * @ORM\\Column(type=\"integer\")\n     * @var int\n     */\n    private int $id;\n\n    /**\n     * @ORM\\Column(type=\"string\", length=100)\n     * @var string\n     */\n    private $name;\n\n    /**\n     * @ORM\\Column(type=\"string\", length=100, nullable=true)\n     */\n    private $lastname;\n\n    /**\n     * @ORM\\OneToMany(targetEntity=\"Factory\", mappedBy=\"author\")\n     */\n    private \\Doctrine\\Common\\Collections\\Collection $factories;\n\n    /**\n     * @ORM\\OneToOne(targetEntity=\"Photo\", mappedBy=\"user\")\n     */\n    private $photo;\n\n....\n\n````\n\nInterface de TypeScript generada\n\n````typescript\n// interfaces/User.ts\n\nexport interface User {\n  id: number,\n  name: string,\n  lastname?: string,\n  enabled: boolean,\n  photo: Photo,\n  factories: Factory[]\n}\n````\n\nPara facilitar el uso de las interfaces, se general el fichero \"**models.d.ts**\" en el que se hace el export de todas las interfaces.\n\n````typescript\n// interfaces/models.d.ts\n\nexport * from './User';\nexport * from './Photo';\nexport * from './Factory';\n````\n\n## Generate Package\n\n````bash\nbin/console typescript:generate:package output-dir [package-name] [version]\n````\n\nCon este comando se genera un fichero **package.json** con los datos básicos para publicar en un reposiorio privado de npm.\n\nCada vez que se ejecute el generador de package, por defecto se actualiza la versión \"**Patch**\" de este, con la opción de pasar una versión en concreto o subir de \"patch\", \"minor\" o \"major\".\n\nEjemplo del **package.json** que se genera:\n\n````json\n// interfaces/package.json\n{\n    \"name\": \"@irontec/example\",\n    \"version\": \"0.0.1\",\n    \"description\": \"typescript interfaces for @irontec/example project\",\n    \"types\": \"models.d.ts\",\n    \"keywords\": [],\n    \"author\": \"\",\n    \"license\": \"EUPL\"\n}\n````\n\n\u003e [Librería con la que se gestionan las versiones](https://github.com/PHLAK/SemVer)\n\n## Generate All\n\n````bash\nbin/console typescript:generate:all output-dir [entities-dir] [package-name] [version]\n````\n\nEjecuta los comandos anteriores.\n\n\n### Publicar en un repositorio privado de NPM\n\nPara publicar en un repositorio privado, es necesario generar previamente el fichero **package.json** y [tener instalado npm](https://github.com/nvm-sh/nvm#installing-and-updating)\n\n\n1) Iniciar sesión en NPM\n\n````bash\nnpm adduser --registry https://npm.example.com\n````\n\n2) Publicar/Actualizar los cambios en las interfaces\n\n````bash\nnpm publish --registry https://npm.example.com\n````\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firontec%2Ftypescript-generator-bundle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Firontec%2Ftypescript-generator-bundle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firontec%2Ftypescript-generator-bundle/lists"}