Skip to content
This repository was archived by the owner on Mar 1, 2026. It is now read-only.

Commit 4391157

Browse files
lsmith77lsmith77
committed
make it optionally possible to define externalIdMapping using an array of columns and not a unique key name
1 parent d150edb commit 4391157

3 files changed

Lines changed: 104 additions & 29 deletions

File tree

‎packages/server/src/api/rest/index.ts‎

Lines changed: 38 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,10 @@ export type RestApiHandlerOptions<Schema extends SchemaDef = SchemaDef> = {
6363
/**
6464
* Mapping from model names to unique field name to be used as resource's ID.
6565
*/
66-
externalIdMapping?: Record<string, string>;
66+
/**
67+
* Mapping from model names to unique key name or array of column names to be used as resource's ID.
68+
*/
69+
externalIdMapping?: Record<string, string | string[]>;
6770
};
6871

6972
type RelationshipInfo = {
@@ -260,7 +263,7 @@ export class RestApiHandler<Schema extends SchemaDef = SchemaDef> implements Api
260263
private urlPatternMap: Record<UrlPatterns, UrlPattern>;
261264
private modelNameMapping: Record<string, string>;
262265
private reverseModelNameMapping: Record<string, string>;
263-
private externalIdMapping: Record<string, string>;
266+
private externalIdMapping: Record<string, string | string[]>;
264267

265268
constructor(private readonly options: RestApiHandlerOptions<Schema>) {
266269
this.validateOptions(options);
@@ -296,7 +299,7 @@ export class RestApiHandler<Schema extends SchemaDef = SchemaDef> implements Api
296299
idDivider: z.string().min(1).optional(),
297300
urlSegmentCharset: z.string().min(1).optional(),
298301
modelNameMapping: z.record(z.string(), z.string()).optional(),
299-
externalIdMapping: z.record(z.string(), z.string()).optional(),
302+
externalIdMapping: z.record(z.string(), z.union([z.string(), z.array(z.string()).min(1)])).optional(),
300303
});
301304
const parseResult = schema.safeParse(options);
302305
if (!parseResult.success) {
@@ -1334,24 +1337,37 @@ export class RestApiHandler<Schema extends SchemaDef = SchemaDef> implements Api
13341337
const modelDef = this.requireModel(model);
13351338
const modelLower = lowerCaseFirst(model);
13361339
if (!(modelLower in this.externalIdMapping)) {
1337-
return Object.values(modelDef.fields).filter((f) => modelDef.idFields.includes(f.name));
1338-
}
1339-
1340-
// map external ID name to unique constraint field
1341-
const externalIdName = this.externalIdMapping[modelLower];
1342-
for (const [name, info] of Object.entries(modelDef.uniqueFields)) {
1343-
if (name === externalIdName) {
1344-
if (typeof info.type === 'string') {
1345-
// single unique field
1346-
return [this.requireField(model, info.type)];
1347-
} else {
1348-
// compound unique fields
1349-
return Object.keys(info).map((f) => this.requireField(model, f));
1340+
return Object.values(modelDef.fields).filter(
1341+
(f) => (f as FieldDef).name && modelDef.idFields.includes((f as FieldDef).name),
1342+
) as FieldDef[];
1343+
}
1344+
1345+
// map external ID name or columns to unique constraint field(s)
1346+
const externalId = this.externalIdMapping[modelLower];
1347+
if (typeof externalId === 'string') {
1348+
// Try to match unique key name first
1349+
for (const [name, info] of Object.entries(modelDef.uniqueFields as Record<string, unknown>)) {
1350+
const infoTyped = info as any;
1351+
if (name === externalId) {
1352+
if (typeof infoTyped.type === 'string') {
1353+
// single unique field
1354+
return [this.requireField(model, infoTyped.type)];
1355+
} else {
1356+
// compound unique fields
1357+
return Object.keys(infoTyped).map((f) => this.requireField(model, f));
1358+
}
13501359
}
13511360
}
1361+
// If not found, treat as a single column name (for single-column unique index with underscores)
1362+
if (modelDef.fields[externalId]) {
1363+
return [this.requireField(model, externalId)];
1364+
}
1365+
throw new Error(`Model ${model} does not have unique key or field ${externalId}`);
1366+
} else if (Array.isArray(externalId)) {
1367+
// Array of column names (for compound or single unique index)
1368+
return externalId.map((col) => this.requireField(model, col));
13521369
}
1353-
1354-
throw new Error(`Model ${model} does not have unique key ${externalIdName}`);
1370+
throw new Error(`Invalid externalIdMapping for model ${model}`);
13551371
}
13561372

13571373
private requireField(model: string, field: string): FieldDef {
@@ -1365,7 +1381,8 @@ export class RestApiHandler<Schema extends SchemaDef = SchemaDef> implements Api
13651381

13661382
private buildTypeMap() {
13671383
this.typeMap = {};
1368-
for (const [model, { fields }] of Object.entries(this.schema.models)) {
1384+
for (const [model, modelVal] of Object.entries(this.schema.models as Record<string, unknown>)) {
1385+
const fields = (modelVal as any).fields as Record<string, FieldDef>;
13691386
const idFields = this.getIdFields(model);
13701387
if (idFields.length === 0) {
13711388
log(this.options.log, 'warn', `Not including model ${model} in the API because it has no ID field`);
@@ -1379,7 +1396,8 @@ export class RestApiHandler<Schema extends SchemaDef = SchemaDef> implements Api
13791396
fields,
13801397
});
13811398

1382-
for (const [field, fieldInfo] of Object.entries(fields)) {
1399+
for (const [field, fieldInfoRaw] of Object.entries(fields)) {
1400+
const fieldInfo = fieldInfoRaw as any;
13831401
if (!fieldInfo.relation) {
13841402
continue;
13851403
}

‎packages/server/test/api/options-validation.test.ts‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ describe('API Handler Options Validation', () => {
192192
}).toThrow('Invalid options');
193193
});
194194

195-
it('should throw error when externalIdMapping values are not strings', () => {
195+
it('should throw error when externalIdMapping values are not string or string[]', () => {
196196
expect(() => {
197197
new RestApiHandler({
198198
schema: client.$schema,
@@ -202,6 +202,16 @@ describe('API Handler Options Validation', () => {
202202
}).toThrow('Invalid options');
203203
});
204204

205+
it('should accept externalIdMapping as string[]', () => {
206+
expect(() => {
207+
new RestApiHandler({
208+
schema: client.$schema,
209+
endpoint: 'http://localhost/api',
210+
externalIdMapping: { User: ['email'] },
211+
});
212+
}).not.toThrow();
213+
});
214+
205215
it('should throw error when log is invalid type', () => {
206216
expect(() => {
207217
new RestApiHandler({

‎packages/server/test/api/rest.test.ts‎

Lines changed: 55 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3092,6 +3092,8 @@ describe('REST server tests', () => {
30923092
posts Post[]
30933093
30943094
@@unique([name, source])
3095+
@@unique([email_with_underscore])
3096+
email_with_underscore String @unique
30953097
}
30963098
30973099
model Post {
@@ -3101,9 +3103,8 @@ describe('REST server tests', () => {
31013103
authorId Int?
31023104
}
31033105
`;
3104-
beforeEach(async () => {
3106+
it('works with id mapping (unique key name as string)', async () => {
31053107
client = await createTestClient(schema);
3106-
31073108
const _handler = new RestApiHandler({
31083109
schema: client.$schema,
31093110
endpoint: 'http://localhost/api',
@@ -3112,11 +3113,9 @@ describe('REST server tests', () => {
31123113
},
31133114
});
31143115
handler = (args) => _handler.handleRequest({ ...args, url: new URL(`http://localhost/${args.path}`) });
3115-
});
31163116

3117-
it('works with id mapping', async () => {
31183117
await client.user.create({
3119-
data: { id: 1, name: 'User1', source: 'a' },
3118+
data: { id: 1, name: 'User1', source: 'a', email_with_underscore: 'e1' },
31203119
});
31213120

31223121
// user is no longer exposed using the `id` field
@@ -3126,7 +3125,6 @@ describe('REST server tests', () => {
31263125
query: {},
31273126
client,
31283127
});
3129-
31303128
expect(r.status).toBe(422);
31313129
expect(r.body.errors[0].code).toBe('validation-error');
31323130

@@ -3137,7 +3135,6 @@ describe('REST server tests', () => {
31373135
query: {},
31383136
client,
31393137
});
3140-
31413138
expect(r.status).toBe(200);
31423139
expect(r.body.data.attributes.source).toBe('a');
31433140
expect(r.body.data.attributes.name).toBe('User1');
@@ -3153,7 +3150,6 @@ describe('REST server tests', () => {
31533150
query: { include: 'author' },
31543151
client,
31553152
});
3156-
31573153
expect(r.status).toBe(200);
31583154
expect(r.body.data.attributes.title).toBe('Title1');
31593155
// Verify author relationship contains the external ID
@@ -3162,6 +3158,57 @@ describe('REST server tests', () => {
31623158
id: 'User1_a',
31633159
});
31643160
});
3161+
3162+
it('works with id mapping (array of columns)', async () => {
3163+
client = await createTestClient(schema);
3164+
const _handler = new RestApiHandler({
3165+
schema: client.$schema,
3166+
endpoint: 'http://localhost/api',
3167+
externalIdMapping: {
3168+
User: ['name', 'source'],
3169+
},
3170+
});
3171+
handler = (args) => _handler.handleRequest({ ...args, url: new URL(`http://localhost/${args.path}`) });
3172+
3173+
await client.user.create({
3174+
data: { id: 2, name: 'User2', source: 'b', email_with_underscore: 'e2' },
3175+
});
3176+
3177+
let r = await handler({
3178+
method: 'get',
3179+
path: '/user/User2_b',
3180+
query: {},
3181+
client,
3182+
});
3183+
expect(r.status).toBe(200);
3184+
expect(r.body.data.attributes.source).toBe('b');
3185+
expect(r.body.data.attributes.name).toBe('User2');
3186+
});
3187+
3188+
it('works with id mapping (single column with underscore)', async () => {
3189+
client = await createTestClient(schema);
3190+
const _handler = new RestApiHandler({
3191+
schema: client.$schema,
3192+
endpoint: 'http://localhost/api',
3193+
externalIdMapping: {
3194+
User: ['email_with_underscore'],
3195+
},
3196+
});
3197+
handler = (args) => _handler.handleRequest({ ...args, url: new URL(`http://localhost/${args.path}`) });
3198+
3199+
await client.user.create({
3200+
data: { id: 3, name: 'User3', source: 'c', email_with_underscore: 'e3' },
3201+
});
3202+
3203+
let r = await handler({
3204+
method: 'get',
3205+
path: '/user/e3',
3206+
query: {},
3207+
client,
3208+
});
3209+
expect(r.status).toBe(200);
3210+
expect(r.body.data.attributes.email_with_underscore).toBe('e3');
3211+
});
31653212
});
31663213

31673214
describe('REST server tests - procedures', () => {

0 commit comments

Comments
 (0)