prototypey.org - atproto lexicon typescript toolkit - mirror https://github.com/tylersayshi/prototypey
Add support for object-level descriptions in lx.object()
authored by
Miguel Batres
and committed by
tyler
a7e332d3
8174da97
+97
-10
+23
-9
packages/prototypey/core/lib.ts
+23
-9
packages/prototypey/core/lib.ts
···
205
205
}
206
206
>;
207
207
208
+
/**
209
+
* Object-level options (not property-level).
210
+
* @see https://atproto.com/specs/lexicon#object
211
+
*/
212
+
type ObjectOptions = {
213
+
/** Human-readable description of the object */
214
+
description?: string;
215
+
};
216
+
208
217
type RequiredKeys<T> = {
209
218
[K in keyof T]: T[K] extends { required: true } ? K : never;
210
219
}[keyof T];
···
217
226
* Resulting object schema with required and nullable fields extracted.
218
227
* @see https://atproto.com/specs/lexicon#object
219
228
*/
220
-
type ObjectResult<T extends ObjectProperties> = {
229
+
type ObjectResult<T extends ObjectProperties, O extends ObjectOptions = {}> = {
221
230
type: "object";
222
231
/** Property definitions */
223
232
properties: {
···
230
239
: { required: UnionToTuple<RequiredKeys<T>> }) &
231
240
([NullableKeys<T>] extends [never]
232
241
? {}
233
-
: { nullable: UnionToTuple<NullableKeys<T>> });
242
+
: { nullable: UnionToTuple<NullableKeys<T>> }) &
243
+
O;
234
244
235
245
/**
236
246
* Map of parameter names to their lexicon item definitions.
···
529
539
* Creates an object type with defined properties.
530
540
* @see https://atproto.com/specs/lexicon#object
531
541
*/
532
-
object<T extends ObjectProperties>(options: T): ObjectResult<T> {
533
-
const required = Object.keys(options).filter(
534
-
(key) => "required" in options[key] && options[key].required,
542
+
object<T extends ObjectProperties, O extends ObjectOptions>(
543
+
properties: T,
544
+
options?: O,
545
+
): ObjectResult<T, O> {
546
+
const required = Object.keys(properties).filter(
547
+
(key) => "required" in properties[key] && properties[key].required,
535
548
);
536
-
const nullable = Object.keys(options).filter(
537
-
(key) => "nullable" in options[key] && options[key].nullable,
549
+
const nullable = Object.keys(properties).filter(
550
+
(key) => "nullable" in properties[key] && properties[key].nullable,
538
551
);
539
552
const result: Record<string, unknown> = {
540
553
type: "object",
541
-
properties: options,
554
+
properties,
555
+
...options,
542
556
};
543
557
if (required.length > 0) {
544
558
result.required = required;
···
546
560
if (nullable.length > 0) {
547
561
result.nullable = nullable;
548
562
}
549
-
return result as ObjectResult<T>;
563
+
return result as ObjectResult<T, O>;
550
564
},
551
565
/**
552
566
* Creates a params type for query string parameters.
+1
-1
packages/prototypey/core/tests/from-json-infer.test.ts
+1
-1
packages/prototypey/core/tests/from-json-infer.test.ts
+73
packages/prototypey/core/tests/primitives.test.ts
+73
packages/prototypey/core/tests/primitives.test.ts
···
183
183
});
184
184
});
185
185
186
+
test("lx.object() basic", () => {
187
+
const result = lx.object({
188
+
name: lx.string(),
189
+
});
190
+
expect(result).toEqual({
191
+
type: "object",
192
+
properties: {
193
+
name: { type: "string" },
194
+
},
195
+
});
196
+
});
197
+
198
+
test("lx.object() with description", () => {
199
+
const result = lx.object(
200
+
{
201
+
enabled: lx.boolean({
202
+
default: true,
203
+
description: "Whether this feature is enabled.",
204
+
}),
205
+
},
206
+
{
207
+
description: "Configuration options for the feature.",
208
+
},
209
+
);
210
+
expect(result).toEqual({
211
+
type: "object",
212
+
description: "Configuration options for the feature.",
213
+
properties: {
214
+
enabled: {
215
+
type: "boolean",
216
+
default: true,
217
+
description: "Whether this feature is enabled.",
218
+
},
219
+
},
220
+
});
221
+
});
222
+
223
+
test("lx.object() with required and description", () => {
224
+
const result = lx.object(
225
+
{
226
+
id: lx.string({ required: true }),
227
+
name: lx.string(),
228
+
},
229
+
{ description: "User profile object" },
230
+
);
231
+
expect(result).toEqual({
232
+
type: "object",
233
+
description: "User profile object",
234
+
properties: {
235
+
id: { type: "string", required: true },
236
+
name: { type: "string" },
237
+
},
238
+
required: ["id"],
239
+
});
240
+
});
241
+
242
+
test("lx.object() with nullable and description", () => {
243
+
const result = lx.object(
244
+
{
245
+
bio: lx.string({ nullable: true }),
246
+
},
247
+
{ description: "Optional profile fields" },
248
+
);
249
+
expect(result).toEqual({
250
+
type: "object",
251
+
description: "Optional profile fields",
252
+
properties: {
253
+
bio: { type: "string", nullable: true },
254
+
},
255
+
nullable: ["bio"],
256
+
});
257
+
});
258
+
186
259
test("lx.token() with interaction event", () => {
187
260
const result = lx.token(
188
261
"Request that less content like the given feed item be shown in the feed",