Generate d.ts file of typebox so big and repetitive #992

fortezhuo · 2024-09-13T11:04:44Z

fortezhuo
Sep 13, 2024

I have schema that generated from prismabox, and while I using the schema and build d.ts. All type written repetitively instead using @import and cause error The inferred type of this node exceeds the maximum length the compiler will serialize. An explicit type annotation is needed in large app.

How to solve this problem ?

Person.ts

import { Type } from "@sinclair/typebox";

export const PersonWhere = Type.Partial(
  Type.Object({
    id: Type.String(),
    name: Type.String(),
    statusId: Type.String(),
    blacklist: Type.String(),
    positionId: Type.String(),
    departmentId: Type.String(),
    groupId: Type.String(),
    subGroupId: Type.String(),
    areaId: Type.String(),
    subAreaId: Type.String(),
    barcodeId: Type.String(),
  }),
  { additionalProperties: false }
);

export const Person = Type.Object({
  id: Type.String({ additionalProperties: false }),
  name: Type.String({ additionalProperties: false }),
  statusId: Type.String({ additionalProperties: false }),
  blacklist: Type.String({ additionalProperties: false }),
  positionId: Type.String({ additionalProperties: false }),
  departmentId: Type.String({ additionalProperties: false }),
  groupId: Type.String({ additionalProperties: false }),
  subGroupId: Type.String({ additionalProperties: false }),
  areaId: Type.String({ additionalProperties: false }),
  subAreaId: Type.String({ additionalProperties: false }),
  barcodeId: Type.String({ additionalProperties: false }),
  firstName: Type.String({ additionalProperties: false }),
  lastName: Type.String({ additionalProperties: false }),
});

export const PersonInputSelect = Type.Object({
  id: Type.String({ additionalProperties: false }),
  name: Type.String({ additionalProperties: false }),
  statusId: Type.String({ additionalProperties: false }),
});

export const PersonInputOrderBy = Type.Object({
  id: Type.String({ additionalProperties: false }),
  departmentId: Type.String({ additionalProperties: false }),
  groupId: Type.String({ additionalProperties: false }),
  statusId: Type.String({ additionalProperties: false }),
});

export const PersonInputInclude = Type.Object({
  id: Type.String({ additionalProperties: false }),
  name: Type.String({ additionalProperties: false }),
  barcodeId: Type.String({ additionalProperties: false }),
  firstName: Type.String({ additionalProperties: false }),
  lastName: Type.String({ additionalProperties: false }),
  statusId: Type.String({ additionalProperties: false }),
});

index.ts

import { Type } from "@sinclair/typebox";
import {
  Person,
  PersonInputSelect,
  PersonInputInclude,
  PersonInputOrderBy,
  PersonWhere,
} from "./Person";

export const schemas = {
  person: {
    name: "person",
    model: Person,
    select: PersonInputSelect,
    include: PersonInputInclude,
    where: PersonWhere,
    orderBy: PersonInputOrderBy,
  },
};

export const typeSchema = Type.Object({
  person: Type.Object({
    name: Type.Literal("person"),
    model: Person,
    select: PersonInputSelect,
    include: PersonInputInclude,
    where: PersonWhere,
    orderBy: PersonInputOrderBy,
  }),
});

tsconfig.json

{
  "compilerOptions": {
    "module": "ESNext",
    "disableSizeLimit": true,
    "preserveSymlinks": true,
    "moduleResolution": "Node",
    "declaration": true,
    "declarationDir": "./build",
    "skipLibCheck": true,
    "emitDeclarationOnly": true,
    "noEmit": null
  },
  "include": ["src/index.ts"]
}

Generated file so big and repetitive

person.d.ts

export declare const PersonWhere: import("@sinclair/typebox").TObject<{
    id: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
    name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
    statusId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
    blacklist: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
    positionId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
    departmentId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
    groupId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
    subGroupId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
    areaId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
    subAreaId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
    barcodeId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
}>;
export declare const Person: import("@sinclair/typebox").TObject<{
    id: import("@sinclair/typebox").TString;
    name: import("@sinclair/typebox").TString;
    statusId: import("@sinclair/typebox").TString;
    blacklist: import("@sinclair/typebox").TString;
    positionId: import("@sinclair/typebox").TString;
    departmentId: import("@sinclair/typebox").TString;
    groupId: import("@sinclair/typebox").TString;
    subGroupId: import("@sinclair/typebox").TString;
    areaId: import("@sinclair/typebox").TString;
    subAreaId: import("@sinclair/typebox").TString;
    barcodeId: import("@sinclair/typebox").TString;
    firstName: import("@sinclair/typebox").TString;
    lastName: import("@sinclair/typebox").TString;
}>;
export declare const PersonInputSelect: import("@sinclair/typebox").TObject<{
    id: import("@sinclair/typebox").TString;
    name: import("@sinclair/typebox").TString;
    statusId: import("@sinclair/typebox").TString;
}>;
export declare const PersonInputOrderBy: import("@sinclair/typebox").TObject<{
    id: import("@sinclair/typebox").TString;
    departmentId: import("@sinclair/typebox").TString;
    groupId: import("@sinclair/typebox").TString;
    statusId: import("@sinclair/typebox").TString;
}>;
export declare const PersonInputInclude: import("@sinclair/typebox").TObject<{
    id: import("@sinclair/typebox").TString;
    name: import("@sinclair/typebox").TString;
    barcodeId: import("@sinclair/typebox").TString;
    firstName: import("@sinclair/typebox").TString;
    lastName: import("@sinclair/typebox").TString;
    statusId: import("@sinclair/typebox").TString;
}>;

index.d.t.s

export declare const schemas: {
    person: {
        name: string;
        model: import("@sinclair/typebox").TObject<{
            id: import("@sinclair/typebox").TString;
            name: import("@sinclair/typebox").TString;
            statusId: import("@sinclair/typebox").TString;
            blacklist: import("@sinclair/typebox").TString;
            positionId: import("@sinclair/typebox").TString;
            departmentId: import("@sinclair/typebox").TString;
            groupId: import("@sinclair/typebox").TString;
            subGroupId: import("@sinclair/typebox").TString;
            areaId: import("@sinclair/typebox").TString;
            subAreaId: import("@sinclair/typebox").TString;
            barcodeId: import("@sinclair/typebox").TString;
            firstName: import("@sinclair/typebox").TString;
            lastName: import("@sinclair/typebox").TString;
        }>;
        select: import("@sinclair/typebox").TObject<{
            id: import("@sinclair/typebox").TString;
            name: import("@sinclair/typebox").TString;
            statusId: import("@sinclair/typebox").TString;
        }>;
        include: import("@sinclair/typebox").TObject<{
            id: import("@sinclair/typebox").TString;
            name: import("@sinclair/typebox").TString;
            barcodeId: import("@sinclair/typebox").TString;
            firstName: import("@sinclair/typebox").TString;
            lastName: import("@sinclair/typebox").TString;
            statusId: import("@sinclair/typebox").TString;
        }>;
        where: import("@sinclair/typebox").TObject<{
            id: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            statusId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            blacklist: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            positionId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            departmentId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            groupId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            subGroupId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            areaId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            subAreaId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            barcodeId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
        }>;
        orderBy: import("@sinclair/typebox").TObject<{
            id: import("@sinclair/typebox").TString;
            departmentId: import("@sinclair/typebox").TString;
            groupId: import("@sinclair/typebox").TString;
            statusId: import("@sinclair/typebox").TString;
        }>;
    };
};
export declare const typeSchema: import("@sinclair/typebox").TObject<{
    person: import("@sinclair/typebox").TObject<{
        name: import("@sinclair/typebox").TLiteral<"person">;
        model: import("@sinclair/typebox").TObject<{
            id: import("@sinclair/typebox").TString;
            name: import("@sinclair/typebox").TString;
            statusId: import("@sinclair/typebox").TString;
            blacklist: import("@sinclair/typebox").TString;
            positionId: import("@sinclair/typebox").TString;
            departmentId: import("@sinclair/typebox").TString;
            groupId: import("@sinclair/typebox").TString;
            subGroupId: import("@sinclair/typebox").TString;
            areaId: import("@sinclair/typebox").TString;
            subAreaId: import("@sinclair/typebox").TString;
            barcodeId: import("@sinclair/typebox").TString;
            firstName: import("@sinclair/typebox").TString;
            lastName: import("@sinclair/typebox").TString;
        }>;
        select: import("@sinclair/typebox").TObject<{
            id: import("@sinclair/typebox").TString;
            name: import("@sinclair/typebox").TString;
            statusId: import("@sinclair/typebox").TString;
        }>;
        include: import("@sinclair/typebox").TObject<{
            id: import("@sinclair/typebox").TString;
            name: import("@sinclair/typebox").TString;
            barcodeId: import("@sinclair/typebox").TString;
            firstName: import("@sinclair/typebox").TString;
            lastName: import("@sinclair/typebox").TString;
            statusId: import("@sinclair/typebox").TString;
        }>;
        where: import("@sinclair/typebox").TObject<{
            id: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            statusId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            blacklist: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            positionId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            departmentId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            groupId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            subGroupId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            areaId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            subAreaId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
            barcodeId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
        }>;
        orderBy: import("@sinclair/typebox").TObject<{
            id: import("@sinclair/typebox").TString;
            departmentId: import("@sinclair/typebox").TString;
            groupId: import("@sinclair/typebox").TString;
            statusId: import("@sinclair/typebox").TString;
        }>;
    }>;
}>;

Expected result

import { Person } from "./person"
export declare const schemas: {
    person: {
        name: string;
        model: import("./person").Person;
        select: import("./person"").InputSelect;
.....
    };
};
....

Repo : https://github.com/fortezhuo/sample

Answered by ehaynes99

Sep 14, 2024

I'm sharing literally thousands of schemas between projects in a monorepo that get MUCH larger than those in the definition files, and I've never run into this. The largest .d.ts I have is 423k, and there are a lot of complicated unions/intersections. I also don't get it with the sample you supplied. If this is an excerpt from a larger project, are you sure that none of the problematic definitions has recursion in it? It's going to get really tedious double-declaring everything like that.

Also, unrelated but there is no need for additionalProperties: false with primitive types like Type.String.

View full answer

fortezhuo · 2024-09-14T00:59:34Z

fortezhuo
Sep 14, 2024
Author

I have found solution. We need to write define type by ourself like this

Person.ts
import { TObject, TString, Type } from "@sinclair/typebox";

export type TPerson = TObject<{
  id: TString;
  name: TString;
  statusId: TString;
  blacklist: TString;
  positionId: TString;
  departmentId: TString;
  groupId: TString;
  subGroupId: TString;
  areaId: TString;
  subAreaId: TString;
  barcodeId: TString;
  firstName: TString;
  lastName: TString;
}>;

export const Person: TPerson = Type.Object({
  id: Type.String({ additionalProperties: false }),
  name: Type.String({ additionalProperties: false }),
  statusId: Type.String({ additionalProperties: false }),
  blacklist: Type.String({ additionalProperties: false }),
  positionId: Type.String({ additionalProperties: false }),
  departmentId: Type.String({ additionalProperties: false }),
  groupId: Type.String({ additionalProperties: false }),
  subGroupId: Type.String({ additionalProperties: false }),
  areaId: Type.String({ additionalProperties: false }),
  subAreaId: Type.String({ additionalProperties: false }),
  barcodeId: Type.String({ additionalProperties: false }),
  firstName: Type.String({ additionalProperties: false }),
  lastName: Type.String({ additionalProperties: false }),
});

import { Type } from "@sinclair/typebox";
import { Person } from "./Person";

index.ts

export const schemas = {
  person: {
    name: "person",
    model: Person,
  },
};

export const typeSchema = Type.Object({
  person: Type.Object({
    name: Type.Literal("person"),
    model: Person,
  }),
});

And the result

import { TObject, TString } from "@sinclair/typebox";
export type TPerson = TObject<{
    id: TString;
    name: TString;
    statusId: TString;
    blacklist: TString;
    positionId: TString;
    departmentId: TString;
    groupId: TString;
    subGroupId: TString;
    areaId: TString;
    subAreaId: TString;
    barcodeId: TString;
    firstName: TString;
    lastName: TString;
}>;
export declare const Person: TPerson;


export declare const schemas: {
    person: {
        name: string;
        model: import("./Person").TPerson;
    };
};
export declare const typeSchema: import("@sinclair/typebox").TObject<{
    person: import("@sinclair/typebox").TObject<{
        name: import("@sinclair/typebox").TLiteral<"person">;
        model: import("./Person").TPerson;
    }>;
}>;

2 replies

ehaynes99 Sep 14, 2024

I'm sharing literally thousands of schemas between projects in a monorepo that get MUCH larger than those in the definition files, and I've never run into this. The largest .d.ts I have is 423k, and there are a lot of complicated unions/intersections. I also don't get it with the sample you supplied. If this is an excerpt from a larger project, are you sure that none of the problematic definitions has recursion in it? It's going to get really tedious double-declaring everything like that.

Also, unrelated but there is no need for additionalProperties: false with primitive types like Type.String.

Answer selected by fortezhuo

fortezhuo Sep 14, 2024
Author

Yes. You are right. I have checked my code again, and found recursion. I refactor the code to remove the recursion, and now d.ts can be compiled

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate d.ts file of typebox so big and repetitive #992

{{title}}

Replies: 1 comment 2 replies

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Select a reply

Generate d.ts file of typebox so big and repetitive #992

fortezhuo Sep 13, 2024

Replies: 1 comment · 2 replies

fortezhuo Sep 14, 2024 Author

ehaynes99 Sep 14, 2024

fortezhuo Sep 14, 2024 Author

fortezhuo
Sep 13, 2024

Replies: 1 comment 2 replies

fortezhuo
Sep 14, 2024
Author

fortezhuo Sep 14, 2024
Author