@visulima/prisma-dmmf-transformer 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## @visulima/prisma-dmmf-transformer [1.0.1](https://github.com/visulima/visulima/compare/@visulima/prisma-dmmf-transformer@1.0.0...@visulima/prisma-dmmf-transformer@1.0.1) (2022-12-01)
+
+
+### Bug Fixes
+
+* added correct folder to files key in package.json ([da9f987](https://github.com/visulima/visulima/commit/da9f9871462a0b2663046cde5f05e9a90df4c496))
+
 ## @visulima/prisma-dmmf-transformer 1.0.0 (2022-11-15)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@visulima/prisma-dmmf-transformer",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "A generator for Prisma to generate a valid JSON Schema v7.",
     "keywords": [
         "anolilab",
@@ -49,8 +49,7 @@
     "source": "src/index.ts",
     "types": "dist/index.d.ts",
     "files": [
-        "src",
-        "dist",
+        "dist/**",
         "README.md",
         "CHANGELOG.md",
         "LICENSE.md"
@@ -61,25 +60,25 @@
         "clean": "rimraf node_modules dist",
         "coverage": "vitest run --coverage",
         "dev": "pnpm predev && pnpm run build --watch",
-        "lint:eslint": "cross-env NO_LOGS=true eslint --ext js,jsx,ts,tsx --max-warnings=0 --config .eslintrc.cjs",
+        "lint:eslint": "cross-env NO_LOGS=true eslint . --ext js,jsx,ts,tsx --max-warnings=0 --config .eslintrc.cjs --cache --cache-strategy content .",
         "lint:eslint:fix": "pnpm run lint:eslint --fix",
         "test": "vitest"
     },
     "dependencies": {
-        "@prisma/generator-helper": "4.6.1",
-        "@prisma/internals": "4.6.1"
+        "@prisma/generator-helper": "4.7.0",
+        "@prisma/internals": "4.7.0"
     },
     "devDependencies": {
         "@anolilab/eslint-config": "^4.0.9",
         "@anolilab/semantic-release-preset": "^2.0.7",
-        "@prisma/client": "4.6.1",
+        "@prisma/client": "4.7.0",
         "@rushstack/eslint-plugin-security": "^0.5.0",
         "@types/json-schema": "7.0.11",
         "@types/micromatch": "^4.0.2",
         "@types/node": "^18.8.4",
         "@typescript-eslint/eslint-plugin": "^5.40.0",
         "@typescript-eslint/parser": "^5.40.0",
-        "ajv": "8.11.0",
+        "ajv": "8.11.2",
         "ajv-formats": "2.1.1",
         "cross-env": "^7.0.3",
         "eslint": "^8.25.0",
@@ -97,22 +96,22 @@
         "eslint-plugin-optimize-regex": "^1.2.1",
         "eslint-plugin-promise": "^6.0.1",
         "eslint-plugin-radar": "^0.2.1",
-        "eslint-plugin-react": "7.31.10",
+        "eslint-plugin-react": "7.31.11",
         "eslint-plugin-react-hooks": "4.6.0",
         "eslint-plugin-simple-import-sort": "^8.0.0",
         "eslint-plugin-sort-keys-fix": "^1.1.2",
         "eslint-plugin-testing-library": "^5.7.2",
-        "eslint-plugin-unicorn": "^44.0.2",
+        "eslint-plugin-unicorn": "^45.0.0",
         "eslint-plugin-you-dont-need-lodash-underscore": "^6.12.0",
         "eslint-plugin-you-dont-need-momentjs": "^1.6.0",
         "prettier": "^2.7.1",
-        "prisma": "4.6.1",
+        "prisma": "4.7.0",
         "read-pkg": "^7.1.0",
         "rimraf": "^3.0.2",
         "semantic-release": "^19.0.5",
         "tsup": "^6.2.3",
         "typescript": "^4.8.4",
-        "vitest": "^0.24.1"
+        "vitest": "^0.25.0"
     },
     "peerDependencies": {
         "@prisma/client": "3.* || 4.*",

package/src/index.ts

@@ -1,6 +0,0 @@
-export { default as transformDMMF } from "./transform-dmmf";
-export { default as getJSONSchemaProperty } from "./properties";
-
-export type {
-    DefinitionMap, PropertyMap, PropertyMetaData, TransformOptions, ModelMetaData,
-} from "./types.d";

package/src/model.ts

@@ -1,37 +0,0 @@
-import type { DMMF } from "@prisma/generator-helper";
-import type { JSONSchema7Definition } from "json-schema";
-
-import getJSONSchemaProperty from "./properties";
-import type { DefinitionMap, ModelMetaData, TransformOptions } from "./types.d";
-
-function getRelationScalarFields(model: DMMF.Model): string[] {
-    return model.fields.flatMap((field) => field.relationFromFields || []);
-}
-
-const getJSONSchemaModel = (modelMetaData: ModelMetaData, transformOptions: TransformOptions) => (model: DMMF.Model): DefinitionMap => {
-    const definitionPropertiesMap = model.fields.map(getJSONSchemaProperty(modelMetaData, transformOptions));
-
-    const propertiesMap = definitionPropertiesMap.map(([name, definition]) => [name, definition] as DefinitionMap);
-    const relationScalarFields = getRelationScalarFields(model);
-    const propertiesWithoutRelationScalars = propertiesMap.filter((property) => !relationScalarFields.includes(property[0]));
-
-    const properties = Object.fromEntries(transformOptions?.keepRelationScalarFields === "true" ? propertiesMap : propertiesWithoutRelationScalars);
-
-    const definition: JSONSchema7Definition = {
-        type: "object",
-        properties,
-    };
-
-    if (transformOptions.includeRequiredFields) {
-        definition.required = definitionPropertiesMap.reduce((filtered: string[], [name, , fieldMetaData]) => {
-            if (fieldMetaData.required && fieldMetaData.isScalar && !fieldMetaData.hasDefaultValue) {
-                filtered.push(name);
-            }
-            return filtered;
-        }, []);
-    }
-
-    return [model.name, definition];
-};
-
-export default getJSONSchemaModel;

package/src/properties.ts

@@ -1,194 +0,0 @@
-import type { DMMF } from "@prisma/generator-helper";
-import type { JSONSchema7, JSONSchema7TypeName } from "json-schema";
-import assert from "node:assert";
-
-import type {
-    ModelMetaData, PrismaPrimitive, PropertyMap, PropertyMetaData, TransformOptions,
-} from "./types.d";
-
-function isDefined<T>(value: T | undefined | null): value is T {
-    return value !== undefined && value !== null;
-}
-
-const getJSONSchemaScalar = (fieldType: PrismaPrimitive): JSONSchema7TypeName | Array<JSONSchema7TypeName> => {
-    switch (fieldType) {
-        case "Int":
-        case "BigInt": {
-            return "integer";
-        }
-        case "DateTime":
-        case "Bytes":
-        case "String": {
-            return "string";
-        }
-        case "Float":
-        case "Decimal": {
-            return "number";
-        }
-        case "Json": {
-            return ["number", "string", "boolean", "object", "array", "null"];
-        }
-        case "Boolean": {
-            return "boolean";
-        }
-        default: {
-            throw new Error(`Unhandled discriminated union member: ${JSON.stringify(fieldType)}`);
-        }
-    }
-};
-
-const getJSONSchemaType = (field: DMMF.Field): JSONSchema7["type"] => {
-    const {
-        isList, isRequired, kind, type,
-    } = field;
-
-    let scalarFieldType: JSONSchema7["type"] = "object";
-
-    if (kind === "scalar" && !isList) {
-        scalarFieldType = getJSONSchemaScalar(type as PrismaPrimitive);
-    } else if (isList) {
-        scalarFieldType = "array";
-    } else if (kind === "enum") {
-        scalarFieldType = "string";
-    }
-
-    if (isRequired || isList) {
-        return scalarFieldType;
-    }
-
-    const isFieldUnion = Array.isArray(scalarFieldType);
-
-    if (isFieldUnion) {
-        return [...new Set([...scalarFieldType, "null"])] as JSONSchema7["type"];
-    }
-
-    return [scalarFieldType as JSONSchema7TypeName, "null"];
-};
-
-const getDefaultValue = (field: DMMF.Field): JSONSchema7["default"] => {
-    const fieldDefault = field.default;
-
-    if (!field.hasDefaultValue) {
-        return null;
-    }
-
-    if (field.kind === "enum") {
-        return typeof fieldDefault === "string" ? fieldDefault : null;
-    }
-
-    if (field.kind !== "scalar") {
-        return null;
-    }
-
-    switch (field.type) {
-        case "String":
-        case "BigInt":
-        case "DateTime": {
-            return typeof fieldDefault === "string" ? fieldDefault : null;
-        }
-        case "Int":
-        case "Float":
-        case "Decimal": {
-            return typeof fieldDefault === "number" ? fieldDefault : null;
-        }
-        case "Boolean": {
-            return typeof fieldDefault === "boolean" ? fieldDefault : null;
-        }
-        case "Json":
-        case "Bytes": {
-            return null;
-        }
-        default: {
-            throw new Error(`Unhandled discriminated union member: ${JSON.stringify(field.type)}`);
-        }
-    }
-};
-
-const getFormatByDMMFType = (fieldType: DMMF.Field["type"]): string | undefined => {
-    if (fieldType === "DateTime") {
-        return "date-time";
-    }
-
-    return undefined;
-};
-
-const getJSONSchemaForPropertyReference = (field: DMMF.Field, { schemaId, persistOriginalType }: TransformOptions): JSONSchema7 => {
-    const notNullable = field.isRequired || field.isList;
-
-    assert.equal(typeof field.type, "string");
-
-    const typeReference = `#/definitions/${field.type}`;
-    const reference = { $ref: schemaId ? `${schemaId}${typeReference}` : typeReference };
-
-    return notNullable
-        ? reference
-        : {
-            anyOf: [reference, { type: "null" }],
-            ...(persistOriginalType && {
-                originalType: field.type,
-            }),
-        };
-};
-
-const getItemsByDMMFType = (field: DMMF.Field, transformOptions: TransformOptions): JSONSchema7["items"] => {
-    if ((field.kind === "scalar" && !field.isList) || field.kind === "enum") {
-        return undefined;
-    }
-
-    if (field.kind === "scalar" && field.isList) {
-        return { type: getJSONSchemaScalar(field.type as PrismaPrimitive) };
-    }
-
-    return getJSONSchemaForPropertyReference(field, transformOptions);
-};
-
-const isSingleReference = (field: DMMF.Field) => field.kind !== "scalar" && !field.isList && field.kind !== "enum";
-
-const getEnumListByDMMFType = (modelMetaData: ModelMetaData) => (field: DMMF.Field): string[] | undefined => {
-    const enumItem = modelMetaData.enums.find(({ name }) => name === field.type);
-
-    if (!enumItem) {
-        return undefined;
-    }
-
-    return enumItem.values.map((item) => item.name);
-};
-
-const getDescription = (field: DMMF.Field) => field.documentation;
-
-const getPropertyDefinition = (modelMetaData: ModelMetaData, transformOptions: TransformOptions, field: DMMF.Field) => {
-    const type = getJSONSchemaType(field);
-    const format = getFormatByDMMFType(field.type);
-    const items = getItemsByDMMFType(field, transformOptions);
-    const enumList = getEnumListByDMMFType(modelMetaData)(field);
-    const defaultValue = getDefaultValue(field);
-    const description = getDescription(field);
-
-    return {
-        type,
-        ...(transformOptions.persistOriginalType && {
-            originalType: field.type,
-        }),
-        ...(isDefined(defaultValue) && { default: defaultValue }),
-        ...(isDefined(format) && { format }),
-        ...(isDefined(items) && { items }),
-        ...(isDefined(enumList) && { enum: enumList }),
-        ...(isDefined(description) && { description }),
-    };
-};
-
-const getJSONSchemaProperty = (modelMetaData: ModelMetaData, transformOptions: TransformOptions) => (field: DMMF.Field): PropertyMap => {
-    const propertyMetaData: PropertyMetaData = {
-        required: field.isRequired,
-        hasDefaultValue: field.hasDefaultValue,
-        isScalar: field.kind === "scalar" || field.kind === "enum",
-    };
-
-    const property = isSingleReference(field)
-        ? getJSONSchemaForPropertyReference(field, transformOptions)
-        : getPropertyDefinition(modelMetaData, transformOptions, field);
-
-    return [field.name, property, propertyMetaData];
-};
-
-export default getJSONSchemaProperty;

package/src/transform-dmmf.ts

@@ -1,44 +0,0 @@
-import type { DMMF } from "@prisma/generator-helper";
-import type { JSONSchema7, JSONSchema7Definition } from "json-schema";
-
-import getJSONSchemaModel from "./model";
-import type { TransformOptions } from "./types.d";
-
-const toCamelCase = (name: string): string => name.slice(0, 1).toLowerCase() + name.slice(1);
-
-const getPropertyDefinition = ({ schemaId }: TransformOptions) => (model: DMMF.Model): [name: string, reference: JSONSchema7Definition] => {
-    const reference = `#/definitions/${model.name}`;
-
-    return [
-        toCamelCase(model.name),
-        {
-            $ref: schemaId ? `${schemaId}${reference}` : reference,
-        },
-    ];
-};
-
-const transformDmmf = (dmmf: DMMF.Document, transformOptions: TransformOptions = {}): JSONSchema7 => {
-    // TODO: Remove default values as soon as prisma version < 3.10.0 doesn't have to be supported anymore
-    const { models = [], enums = [], types = [] } = dmmf.datamodel;
-    const initialJSON = {
-        $schema: "http://json-schema.org/draft-07/schema#",
-        definitions: {},
-        type: "object",
-    } as JSONSchema7;
-    const { schemaId } = transformOptions;
-
-    const modelDefinitionsMap = models.map(getJSONSchemaModel({ enums }, transformOptions));
-    const typeDefinitionsMap = types.map(getJSONSchemaModel({ enums }, transformOptions));
-    const modelPropertyDefinitionsMap = models.map(getPropertyDefinition(transformOptions));
-    const definitions = Object.fromEntries([...modelDefinitionsMap, ...typeDefinitionsMap]);
-    const properties = Object.fromEntries(modelPropertyDefinitionsMap);
-
-    return {
-        ...(schemaId ? { $id: schemaId } : null),
-        ...initialJSON,
-        definitions,
-        properties,
-    };
-};
-
-export default transformDmmf;

package/src/types.d.ts

@@ -1,24 +0,0 @@
-import type { DMMF } from "@prisma/generator-helper";
-import type { JSONSchema7Definition } from "json-schema";
-
-export type PrismaPrimitive = "String" | "BigInt" | "Bytes" | "Decimal" | "Boolean" | "Int" | "Float" | "Json" | "DateTime";
-
-export interface PropertyMetaData {
-    required: boolean;
-    hasDefaultValue: boolean;
-    isScalar: boolean;
-}
-
-export interface ModelMetaData {
-    enums: DMMF.DatamodelEnum[];
-}
-
-export type DefinitionMap = [name: string, definition: JSONSchema7Definition];
-export type PropertyMap = [...DefinitionMap, PropertyMetaData];
-
-export interface TransformOptions {
-    keepRelationScalarFields?: "true" | "false";
-    schemaId?: string;
-    includeRequiredFields?: "true" | "false";
-    persistOriginalType?: "true" | "false";
-}