{"dist":{"shasum":"599916a130583bc5035a21b828788890b0fac167","tarball":"https://registry.npmjs.org/prisma-datamodel/-/prisma-datamodel-1.31.0-beta.5.tgz","fileCount":69,"integrity":"sha512-3o0k6pF2r3HFfZ4vuDOaygjR4KvEapl036hTUj7N+X2QzBOb2ogUixz8lgb3OVlnr4kakCSOjopaW7fgoPwUdw==","signatures":[{"sig":"MEUCIQDtmfC6M1I2VjA3ae3jvxgkqz3TqYbIR3SjQqDnGk4ixgIgLiSwVb2z9wQdBsU4vUYzL3mOGtEYYah7sK0hAelYpCU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":207764,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcr0ffCRA9TVsSAnZWagAAdZIP/0nQqxGCVwoZjZ27470A\n3kowAn8H4dKmzrwYXaf6zYZRtAe7DumZUGys7j1FLoOns0nDGNisbeQsfSQb\nVq25V2C5+JkXuSL0QVnCU6fYeo3zFKb4sz9l7nhWRK45Aovv5kzkjQHWvk6E\n/+A1VxeLDYeS1IY9SuP6wXuxHHXL29XMZALGJqehGbEHvRDAtwopvKmzKaDE\n/aL9tsOhGGvg2v7lN3seTmKFEUx5Q8Xd4Gq6YT4KYTb9gz2X8Fs7P40e0B9h\n8Ow4eRGk+9K/25WJ9rXl0C7eJl/SYVO4DJEunRgqpL2VA3oDAZBxj3JI/KnO\ncitdYT8QpiFy36NIKxyHvXD8mY/mOEJ/LIKwk8a3bu64KyFALoaAY1Zcq9aP\nb4Nt9uUr4Dc4hX3bfjCM1OvlG0l30c+RVETKn1Tk+0T8XcW/A5WKGSBjSTxP\nV+UPJoseCHaLOItG4G01ZSCY8ochZD7yBc3QvITpUW5YfBmhqtiyWX01IDIJ\nfs6sNuuhH6YLK/GvSjzSdz98HKOBGTJYVRVfCyNNEI0sqsOUJ3HTiPySm/zR\nku1s0dAO+AukNGtQBrDOdDXEuG5feiidWt/rFMdmvfkBF5laWwTw6KpVUAFe\n6uFkaDeQ7r8u9klaZEYOhtbLa1lVeBCMoi3D7dnW0dEpcwaig20+GhJQPRMg\nyLLl\r\n=lP57\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(`${type.name} has ${type.fields.length} fields and ${type.indices.length} indexes`)\n}\n\nconst enableDatamodel1_1 = true\nconst renderer = DefaultRenderer.create(DatabaseType.postgres, enableDatamodel1_1)\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.15.1","dependencies":{"graphql":"^14.0.2","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.31.0-beta.5_1554991070464_0.9851936044539797","host":"s3://npm-registry-packages"},"_id":"prisma-datamodel@1.31.0-beta.5","version":"1.31.0-beta.5"}