{"dist":{"shasum":"b225312a94e979c39c63f62605d6c174546e4005","tarball":"https://registry.npmjs.org/prisma-datamodel/-/prisma-datamodel-1.36.0-alpha.1.tgz","fileCount":69,"integrity":"sha512-LxeTFRZNMm0HqX83FFZt7otGTiJ//WqMvBNS2JWKXCN2nZKvnmmofrswgjeXuTZ0jigApPItUI61dgxBHlzGCw==","signatures":[{"sig":"MEUCIDomvHpqh6f1CGFNMFGR/7Qybw5l32WHcPy0i3xcJwMeAiEApQAGPznqMHkpkEfnoTAec3lcUu2uoVKXpYtJo4KF/wU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":208911,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJc+T4CCRA9TVsSAnZWagAAWIoP/0s4xFC1zbs1/Re/vvHM\n2DvM2/mVhaxW3odTolXB3/BAKWf58kNEIuGgB2QN6brvNXjk+Ok6cEd+GWou\nPXfxHGFWnTBJUSpHTeDyk3grtQ+BEBIt2P/nPDZOt9qGo4Gf7zeDU2R94j/s\nm0cV2IqEtGknCjFzSfXo/Jv9xRtyl77GFq3oc2wvCzo+XYdBd8iP1tCiO2PT\nMR/gG6mjJi3s6AY/h6V8T8FKZsT04BRU2LZtuXSaFuX4D1/80xjTb45uzm/S\nati6PgMt8BCFZuescdmcTrMQqBorrG5xesqLDFNCRNeES9TG+xHqKWU36FxG\njvZyEI9jn/zAg301denMareaEOw6rTKXwikZCpZDnp6dnUf00Z+ogD8zu+PC\nff3oSVxVAMUbSp76C6jTp71RoKNj4ZJJwLRuuX3XbqWza9i3x/fSweUgvPtU\n0M9ZX2qFva0QMGHolaQwoQl/0f4eJPNnHLbwY6DGTq5jo/nuhYnO/S41gcRt\n9wX6dwHlzKRgD7ksObikMeWPjwfTRzWnbrVYnYeypIguybKiFbW+6aJ7xPXn\niSMqyHUPvuAEJUjVhVxit/PWrCdLuSLT1AtfjKVWjAeyKBQUvhbkv/Tdy3QC\nb3pGewAz9m3AabvXLyPxGmQmoZIw4/jWphYhbvVnt7IiX6/vzid9lX1vbacZ\n0BsP\r\n=JXIf\r\n-----END PGP SIGNATURE-----\r\n"},"jest":{"testRegex":"(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$","transform":{"^.+\\.tsx?$":"ts-jest"},"moduleFileExtensions":["ts","tsx","js","jsx","json","node"],"testPathIgnorePatterns":["/node_modules/","helpers.ts"]},"main":"dist/index.js","name":"prisma-datamodel","author":{"name":"Emanuel Jöbstl"},"readme":"# prisma-datamodel\n\nThe Prisma Datamodel package forms the foundation of all datamodel related tasks in the CLI.\n\n### Components\n\n- Data structures to represent datamodels in memory: `ISDL`, `IGQLType`, `IGQLField`. These data structures are documented inline. The data structures might be self referencing, and all operations in this library guarantee to keep the references valid.\n- Constants for known primitive types: `TypeIdentifier`, `TypeIdentifiers`\n- Classes to parse data models from strings into the internal format: `Parser`, with the factory class`DefaultParser`\n- Classes to render data models to strings, from the internal format: `Renderer`, with the factory class `Default Renderer`\n- Auxiliary functions: `cloneSchema` to safely clone an `ISDL`structure, `toposort`to sort a datamodel in topological order.\n\n### Different Database Types\n\nWhen creating a parser or renderer, a flag that indicates the database type has to be passed. The internal representation is guaranteed to be consistent between different databases. It is possible to parse a mongo schema and render a postgres schema without any transformations in between.\n\n### Datamodel V1 vs. V1.1\n\nThe parser is capable of parsing both datamodel formats, and even models with mixed directives from both standards. For rendering, a flag can be passed which indicates the datamodel format to follow.\n\n### Modifying a Model\n\nThe types `ISDL`, `IGQLType` and `IGQLField` are designed to allow convenient analysis and transformation. Most notably, they may contain circular references (for representing related types and indexes). Therefor, these types are **mutable**, and care has to be taken when modifying them, for example by cloning them using `cloneSchema`.\n\nWhen adding or removing a type, it is important to also update all referring fields or indexes, otherwise other transformations or the rendering process might break.\n\n### Usage\n\nBasic example:\n\n```typescript\nconst parser = DefaultParser.create(DatabaseType.mongo)\nconst model = parser.parse(datamodelAsString)\n\n// Do something with the model\nfor (const type of model.types) {\n  console.log(\n    `${type.name} has ${type.fields.length} fields and ${\n      type.indices.length\n    } indexes`,\n  )\n}\n\nconst enableDatamodel1_1 = true\nconst renderer = DefaultRenderer.create(\n  DatabaseType.postgres,\n  enableDatamodel1_1,\n)\n\nconst renderedAsString = renderer.render(model)\n```\n\n","license":"Apache-2.0","scripts":{"test":"rm -rf dist && jest","build":"tsc -d"},"typings":"dist/index.d.ts","_npmUser":{"name":"timsuchanek","email":"tim.suchanek@gmail.com"},"_npmVersion":"6.4.1","description":"Transform prisma datamodel SDL into graphql-js SDL","directories":{},"maintainers":[{"name":"timsuchanek","email":"tim.suchanek@gmail.com"}],"_nodeVersion":"8.16.0","dependencies":{"debug":"^4.1.1","graphql":"^14.3.0","popsicle":"10","pluralize":"^7.0.0"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"jest":"^23.5.0","ts-jest":"^23.1.4","jest-cli":"^23.6.0","typescript":"^3.2.2","@types/jest":"^23.3.1","tslint-eslint-rules":"^5.4.0","tslint-config-prettier":"^1.17.0"},"_npmOperationalInternal":{"tmp":"tmp/prisma-datamodel_1.36.0-alpha.1_1559838209564_0.00921444052936482","host":"s3://npm-registry-packages"},"_id":"prisma-datamodel@1.36.0-alpha.1","version":"1.36.0-alpha.1"}