{"dist":{"shasum":"21d05738e218825fa664cc56d437ae4f3044f435","tarball":"https://registry.npmjs.org/prisma-datamodel/-/prisma-datamodel-1.33.0-alpha.1.tgz","fileCount":69,"integrity":"sha512-d60DCJW0iOBC2egoAUzManErjbOWWX0eYF9idTXgDVP/vepbULMPFQJ6CS3fGJ5rHNypMzZA0KG1HqahHbM+lA==","signatures":[{"sig":"MEUCIFahRxqgIxsq9ONU2Xfq+AULc77LxYWGx98StvZbAtPJAiEAtLrzxW1Vg3Qq5jxO61WGijrItavUWCQ/Z7ccV9loK48=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":208806,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcvwKdCRA9TVsSAnZWagAAU+sP/R2CREzi7c63DO2/m9Zg\nce5OPV5pDKow0d2d1dCf/gzcML9ypD/bun48R/yxBSqCpkPbeGwR5OdoKSKc\nkQcb39Zt/e/PDENVc5wA2+SPyVRj6MNfeaYqYRTh98HKfIs+2CHqiN34Zmsb\nlJzOLRVDKRb6Y9DQb2a7qxQhBBXXMr/rd6ddO/o+sEx/uzp7X53AnriUuccU\n1kt3RaoPYPTZKGN77QdtVRItXBXmt9aN1Rm0r1DOmlbfOy0oyO5Cu2LAHuE/\nPbol9mRaLUPoXLCOpS8rPEAwwerk4I8zcW1KvpjhgeRXPRt4/Mnq9u6/mvjh\nVNIOxYLBO/C115q8YvB/iIiWiMkBJCQt3RVHSvnnPrStfiynSl9b2LKQXeJ1\nZrCShMYqgNBJqreBg6oMRMbYD/Hrotaod0rWtXWfdYJqfkXW3+YP27WwQgCz\n0y/xPjVBAiLv6Ld4I3ND6F7lxSVZ1aBj5CCD2QbgfRWULNZn3ud8EVpBP+w+\nhDT8ZfnFlmmyalmJDbHMZQ5751kSy9e3zKpgGxemcJWeP/7R4GzVHB+9wjr9\nuzhQPijGNdTe2eQHxb+Jr8mvIB0LHmbKwThyFELH9/7krYcTZV8y7getj9jn\nDpqi9a3znZjtBOph/eGUEo6cIaYfaMPm+RM/3b06UExn8deJQmUeBgh0DIAt\nLv4c\r\n=3AS4\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","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":{"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.33.0-alpha.1_1556021916688_0.5748892673795678","host":"s3://npm-registry-packages"},"_id":"prisma-datamodel@1.33.0-alpha.1","version":"1.33.0-alpha.1"}