codegen typing issue

[michael-land]

I have a concern about the generated typing for the custom model.

Here’s the code defining the Employee model copied from b2b starter:

export const Employee = model.define('employee', {
  id: model.id({ prefix: 'emp' }).primaryKey(),
  spending_limit: model.bigNumber().default(0),
  is_admin: model.boolean().default(false),

  company: model.belongsTo(() => Company, {
    mappedBy: 'employees',
  }),
});

And the corresponding database DML:

CREATE TABLE public.employee
(
    id                 text                                   NOT NULL
        PRIMARY KEY,
    spending_limit     numeric                  DEFAULT 0     NOT NULL,
    is_admin           boolean                  DEFAULT FALSE NOT NULL,
    company_id         text                                   NOT NULL
        CONSTRAINT employee_company_id_foreign
            REFERENCES public.company
            ON UPDATE CASCADE,
    raw_spending_limit jsonb                                  NOT NULL,
    created_at         timestamp WITH TIME ZONE DEFAULT NOW() NOT NULL,
    updated_at         timestamp WITH TIME ZONE DEFAULT NOW() NOT NULL,
    deleted_at         timestamp WITH TIME ZONE
);

Here’s the auto-generated typing for this model (from .medusa/types/remote-query-entry-points.d.ts):

export type Employee = {
  __typename?: 'Employee';
  id: Scalars['ID']['output'];
  spending_limit: Scalars['String']['output'];
  is_admin: Scalars['Boolean']['output'];
  company: Company;
  raw_spending_limit: Scalars['JSON']['output'];
  created_at: Scalars['DateTime']['output'];
  updated_at: Scalars['DateTime']['output'];
  deleted_at: Maybe<Scalars['DateTime']['output']>;
  customer_link: Maybe<LinkCompanyEmployeeCustomerCustomer>;
};

As you can see, the generated type includes only company but not company_id. How can I adjust the model definition, so the generated typing to include a company_id field?

In the core model example with MikroORM, e.g. in the shipping-option model, both shipping_profile_id and shipping_profile were generated in type.

medusa/packages/modules/fulfillment/src/models/shipping-option.ts

Lines 99 to 127 in 376b9e8

	@ShippingProfileIdIndex.MikroORMIndex()
	shipping_profile_id: string | null
	@ManyToOne(() => FulfillmentProvider, {
	type: "text",
	fieldName: "provider_id",
	mapToPk: true,
	nullable: true,
	})
	@FulfillmentProviderIdIndex.MikroORMIndex()
	provider_id: string
	@Property({ columnType: "text", persist: false })
	@ShippingOptionTypeIdIndex.MikroORMIndex()
	shipping_option_type_id: string | null = null
	@Property({ columnType: "jsonb", nullable: true })
	data: Record<string, unknown> | null = null
	@Property({ columnType: "jsonb", nullable: true })
	metadata: Record<string, unknown> | null = null
	@ManyToOne(() => ServiceZone, { persist: false })
	service_zone: Rel<ServiceZone>
	@ManyToOne(() => ShippingProfile, {
	persist: false,
	})
	shipping_profile: Rel<ShippingProfile> | null

I’d like something similar for the company and company_id, so i can reference the column in the graph.query api

[michael-land]

The issue/feature request might be to expose Data Model Relationships' auto-generated column {relation_name}_id in the internal GraphQL API. It seems like the typing is generated using GraphQL Codegen against a GraphQL schema. Perhaps it would be helpful to also expose the {relation_name}_id in addition?