{"id":28961858,"url":"https://github.com/microsoft/paris","last_synced_at":"2025-08-02T13:09:29.569Z","repository":{"id":45712490,"uuid":"103312096","full_name":"microsoft/paris","owner":"microsoft","description":"TypeScript library for implementing Domain-Driven Design in web apps","archived":false,"fork":false,"pushed_at":"2023-10-24T21:23:56.000Z","size":1816,"stargazers_count":102,"open_issues_count":5,"forks_count":13,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-07-26T18:47:22.601Z","etag":null,"topics":["domain-driven-design","library","typescript"],"latest_commit_sha":null,"homepage":null,"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/microsoft.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-12T19:28:59.000Z","updated_at":"2024-06-18T03:04:17.000Z","dependencies_parsed_at":"2024-11-18T15:52:41.022Z","dependency_job_id":null,"html_url":"https://github.com/microsoft/paris","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/microsoft/paris","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fparis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fparis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fparis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fparis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microsoft","download_url":"https://codeload.github.com/microsoft/paris/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fparis/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268393928,"owners_count":24243317,"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-08-02T02:00:12.353Z","response_time":74,"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":["domain-driven-design","library","typescript"],"created_at":"2025-06-24T02:06:06.934Z","updated_at":"2025-08-02T13:09:29.537Z","avatar_url":"https://github.com/microsoft.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n**🚧🚧🚧Danger🚧🚧🚧:**\n\nParis is unmaintained. The new decorators proposal, the new RxJS syntax, `useDeclareForClassFields` in modern TypeScript and modern decorator metadata meant that in order to property maintain Paris it'd need an effective rewrite. We no longer use Angular for new code internally and our React/MobX code does not use RxJS.\n\nWe are gradually migrating our internal code from it to our new next-gen data modeling framework. It _may_ eventually be open source but honestly that's a lot of work so we'll see. It is inspired by Paris but does not share any code with it.\n\nYou are free to use this code and we _will_ take pull requests but we will not regularly fix bugs or draft new releases.\n\n# Paris\n\n[![Build Status](https://travis-ci.org/Microsoft/paris.svg?branch=master)](https://travis-ci.org/Microsoft/paris)\n[![npm version](https://badge.fury.io/js/%40microsoft%2Fparis.svg)](https://badge.fury.io/js/%40microsoft%2Fparis)\n\nParis is a data management library for webapps, using TypeScript and RxJS to implement Domain-Driven Design.\n \n\n## Installation\n\n*Package size: ~15.8kb (gzipped)*\n\n1. Paris is a TypeScript library and also requires RxJs and lodash, so you'll need both those packages, if you don't already use them:\n\n\t```\n\tnpm install --save lodash-es rxjs typescript\n\t```\n\n2. Install the Paris NPM package:\n\n\t```\n\tnpm install --save @microsoft/paris\n\t```\n\n## Features\n\n- Data API abstraction and standardization - define and use your data easily, in a consistent way.\n- Strong-typed - data models are defined as classes with TypeScript\n- Full-tree modeling - Paris handles the creation of models and sub-models, essentially creating a model tree.\n- Implements Domain-Driven Design - true and tested development methodology that improves collaboration.\n- Reactive - all async code is done with RxJS Observables.\n- Caching - easily cache data (including time-based caching).\n\n\n## Usage\n\nFirst, define an Entity:\n\n```typescript\n// todo-item.entity.ts\n\nimport { Entity, EntityModelBase, EntityField } from \"@microsoft/paris\";\n\n@Entity({\n\tsingularName: \"Todo Item\",\n\tpluralName: \"Todo Items\",\n\tendpoint: \"todo/items\"\n})\nexport class TodoItem extends EntityModelBase{\n\t@EntityField()\n\ttext: string;\n\n\t@EntityField()\n\ttime: Date;\n}\n```\n\nThe above defines an Entity, which can be used to query the todo/items server endpoint, like this:\n\n```typescript\nimport { Paris } from \"@microsoft/paris\";\n\nconst paris = new Paris();\nparis.getItemById(TodoItem, 1).subscribe((todoItem:TodoItem) =\u003e {\n\tconsole.log(\"Todo item with ID 1: \", todoItem);\n});\n```\n\n## Advanced\n\nCheck the [Wiki](https://github.com/Microsoft/paris/wiki) for advanced uses and explanations.\n\nCheck the [Source Typescript models](https://microsoft.github.io/paris/) for a detailed look under the hood.\n\n[NPM](https://www.npmjs.com/package/@microsoft/paris) [GitHub](https://github.com/Microsoft/paris)\n\n\n## Contributing\n\nThis project welcomes contributions and suggestions.  Most contributions require you to agree to a\nContributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us\nthe rights to use your contribution. For details, visit https://cla.microsoft.com.\n\nWhen you submit a pull request, a CLA-bot will automatically determine whether you need to provide\na CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions\nprovided by the bot. You will only need to do this once across all repos using our CLA.\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\nFor more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or\ncontact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\n\n## Testing\nUnit tests are written using [Jest](https://jestjs.io/), and executed with [ts-jest](https://github.com/kulshekhar/ts-jest).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fparis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrosoft%2Fparis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fparis/lists"}