nest-prisma_doc-gen 1.0.0

package/src/types.ts

@@ -0,0 +1,109 @@
+export type FieldKind = "scalar" | "object" | "enum";
+type FieldDefaultName = "now" | "autoincrement" | "cuid";
+
+export type FieldType = "entity" | "dto";
+
+export type DbName = string | null;
+
+export type Scalar = "String" | "Int" | "BigInt" | "Float" | "Decimal" | "Boolean" | "DateTime" | "Json" | "Bytes";
+
+export type Field = {
+  name: string;
+  dbName: string;
+  kind: FieldKind;
+  isList: boolean;
+  isRequired: boolean;
+  isUnique: boolean;
+  isId: boolean;
+  isReadOnly: boolean;
+  hasDefaultValue: boolean;
+  type: Scalar;
+
+  isGenerated: boolean;
+  isUpdatedAt: boolean;
+
+  nativeType: any;
+  default?: FieldDefault | string;
+};
+
+export interface FieldDefault {
+  name: FieldDefaultName;
+  args: number[];
+}
+
+export type DocGenModel = {
+  name: string | null;
+  dbName: string | null;
+  schema: string | null;
+  readonly fields: Field[];
+
+  uniqueFields: string[][];
+  uniqueIndexes: ModelUniqueIndexes[];
+  primaryKey: null;
+
+  documentation?: string;
+  isGenerated?: boolean;
+};
+
+export type ModelUniqueIndexes = {
+  name: string | null;
+  fields: any[];
+};
+
+export class ValidatorBuilder {
+  decorator: ValidatorFactory | PropertyDecorator;
+  fields: string[];
+
+  constructor(decorator: PropertyDecorator, fields: string[]) {
+    this.decorator = decorator;
+    this.fields = fields;
+  }
+}
+
+export class ApiExampleBuilder {
+  fields: string[];
+  example: string | boolean | number;
+
+  constructor(fields: string[], example: string | boolean | number) {
+    this.fields = fields;
+    this.example = example;
+  }
+}
+
+export type Rules = {
+  ignore: string[];
+  examples: ApiExampleBuilder[];
+  validators: ValidatorBuilder[];
+};
+
+type ValidatorFactory = (...args: any[]) => PropertyDecorator;
+
+export type Model = {
+  name: string;
+  dbName: string | null;
+  schema: string | null;
+  readonly fields: Field[];
+
+  uniqueFields: string[][];
+  uniqueIndexes: ModelUniqueIndexes[];
+  primaryKey: null;
+
+  documentation?: string;
+  isGenerated?: boolean;
+};
+
+export type ModelParams = { model: Model; examples: Map<string, ApiExampleBuilder>; validators: Map<string, string[]> };
+export type FieldParams = {
+  examples: Map<string, ApiExampleBuilder>;
+  validators: Map<string, string[]>;
+  field: Field;
+  fieldType: FieldType;
+};
+
+export type DocGenParams = {
+  ignore: string[];
+  examples: ApiExampleBuilder[];
+  validators: ValidatorBuilder[];
+};
+
+// field: Field, fieldType: FieldType

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*.ts", "src/types/**/*.d.ts"],
+  "exclude": ["node_modules", "dist"]
+}