Skip to content

Commit af2b74e

Browse files
infitoninfiton
authored
Merge pull request #677 from gadget-inc/typesafe-recursive-metadata
typesafe recursive metadata
2 parents dc5defb + 6cbefce commit af2b74e

36 files changed

+5832
-3358
lines changed

‎packages/react/cypress/component/auto/form/AutoFormFindByObjects.cy.tsx

+167
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,167 @@ describeForEachAutoAdapter("AutoForm - FindBy object parameters", ({ name, adapt
5151
const uniqueFieldsMainModelMetadata = {
5252
data: {
5353
gadgetMeta: {
54+
modelAndRelatedModels: [
55+
{
56+
name: "Main model",
57+
apiIdentifier: "mainModel",
58+
defaultRecord: {
59+
__typename: "UniqueFieldsMainModel",
60+
},
61+
fields: [
62+
{
63+
name: "Unique string",
64+
apiIdentifier: "uniqueString",
65+
fieldType: "String",
66+
requiredArgumentForInput: false,
67+
sortable: true,
68+
filterable: true,
69+
__typename: "GadgetModelField",
70+
configuration: {
71+
__typename: "GadgetGenericFieldConfig",
72+
fieldType: "String",
73+
validations: [
74+
{
75+
__typename: "GadgetGenericFieldValidation",
76+
name: "Uniqueness",
77+
specID: "gadget/validation/unique",
78+
},
79+
],
80+
},
81+
},
82+
{
83+
name: "Unique email",
84+
apiIdentifier: "uniqueEmail",
85+
fieldType: "Email",
86+
requiredArgumentForInput: false,
87+
sortable: true,
88+
filterable: true,
89+
__typename: "GadgetModelField",
90+
configuration: {
91+
__typename: "GadgetGenericFieldConfig",
92+
fieldType: "Email",
93+
validations: [
94+
{
95+
__typename: "GadgetGenericFieldValidation",
96+
name: "Uniqueness",
97+
specID: "gadget/validation/unique",
98+
},
99+
],
100+
},
101+
},
102+
{
103+
name: "Unique belongs to",
104+
apiIdentifier: "uniqueBelongsTo",
105+
fieldType: "BelongsTo",
106+
requiredArgumentForInput: false,
107+
sortable: false,
108+
filterable: true,
109+
__typename: "GadgetModelField",
110+
configuration: {
111+
__typename: "GadgetBelongsToConfig",
112+
fieldType: "BelongsTo",
113+
validations: [
114+
{
115+
__typename: "GadgetGenericFieldValidation",
116+
name: "Uniqueness",
117+
specID: "gadget/validation/unique",
118+
},
119+
],
120+
relatedModel: {
121+
key: "RK96To6wLTyn",
122+
apiIdentifier: "parentModel",
123+
namespace: ["uniqueFields"],
124+
defaultDisplayField: {
125+
name: "Parent unique string",
126+
apiIdentifier: "parentUniqueString",
127+
fieldType: "String",
128+
__typename: "GadgetModelField",
129+
},
130+
__typename: "GadgetModel",
131+
},
132+
},
133+
},
134+
{
135+
name: "Non unique string",
136+
apiIdentifier: "nonUniqueString",
137+
fieldType: "String",
138+
requiredArgumentForInput: false,
139+
sortable: true,
140+
filterable: true,
141+
__typename: "GadgetModelField",
142+
configuration: {
143+
__typename: "GadgetGenericFieldConfig",
144+
fieldType: "String",
145+
validations: [],
146+
},
147+
},
148+
{
149+
name: "Child model entries",
150+
apiIdentifier: "childModelEntries",
151+
fieldType: "HasMany",
152+
requiredArgumentForInput: false,
153+
sortable: false,
154+
filterable: false,
155+
__typename: "GadgetModelField",
156+
configuration: {
157+
__typename: "GadgetHasManyConfig",
158+
fieldType: "HasMany",
159+
validations: [],
160+
isJoinModelHasManyField: false,
161+
relatedModel: {
162+
key: "ZOw07DfjlSXQ",
163+
apiIdentifier: "childModel",
164+
namespace: ["uniqueFields"],
165+
defaultDisplayField: {
166+
name: "Alias",
167+
apiIdentifier: "alias",
168+
fieldType: "String",
169+
__typename: "GadgetModelField",
170+
},
171+
__typename: "GadgetModel",
172+
},
173+
inverseField: {
174+
apiIdentifier: "mainModelParent",
175+
__typename: "GadgetModelField",
176+
},
177+
},
178+
},
179+
],
180+
defaultDisplayField: {
181+
name: "Id",
182+
apiIdentifier: "id",
183+
fieldType: "ID",
184+
__typename: "GadgetModelField",
185+
},
186+
__typename: "GadgetModel",
187+
},
188+
{
189+
key: "RK96To6wLTyn",
190+
apiIdentifier: "parentModel",
191+
namespace: ["uniqueFields"],
192+
defaultDisplayField: {
193+
name: "Parent unique string",
194+
apiIdentifier: "parentUniqueString",
195+
fieldType: "String",
196+
__typename: "GadgetModelField",
197+
},
198+
fields: [],
199+
__typename: "GadgetModel",
200+
},
201+
{
202+
key: "ZOw07DfjlSXQ",
203+
apiIdentifier: "childModel",
204+
namespace: ["uniqueFields"],
205+
defaultDisplayField: {
206+
name: "Alias",
207+
apiIdentifier: "alias",
208+
fieldType: "String",
209+
__typename: "GadgetModelField",
210+
},
211+
fields: [],
212+
__typename: "GadgetModel",
213+
},
214+
],
54215
model: {
55216
name: "Main model",
56217
apiIdentifier: "mainModel",
@@ -216,6 +377,12 @@ const uniqueFieldsMainModelMetadata = {
216377
],
217378
__typename: "GadgetAction",
218379
},
380+
defaultDisplayField: {
381+
name: "Id",
382+
apiIdentifier: "id",
383+
fieldType: "ID",
384+
__typename: "GadgetModelField",
385+
},
219386
__typename: "GadgetModel",
220387
},
221388
__typename: "GadgetApplicationMeta",

‎packages/react/cypress/component/auto/form/AutoFormHasManyThrough.cy.tsx

+113
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,119 @@ describeForEachAutoAdapter("AutoForm - HasManyThrough fields", ({ name, adapter:
3737
const modelActionMetadataResponse = {
3838
data: {
3939
gadgetMeta: {
40+
modelAndRelatedModels: [
41+
{
42+
name: "Base model",
43+
apiIdentifier: "baseModel",
44+
defaultRecord: {
45+
__typename: "HasManyThroughBaseModel",
46+
},
47+
fields: [
48+
{
49+
name: "Base model name",
50+
apiIdentifier: "baseModelName",
51+
fieldType: "String",
52+
requiredArgumentForInput: false,
53+
sortable: true,
54+
filterable: true,
55+
__typename: "GadgetModelField",
56+
configuration: {
57+
__typename: "GadgetGenericFieldConfig",
58+
fieldType: "String",
59+
validations: [],
60+
},
61+
},
62+
{
63+
name: "Joiner models",
64+
apiIdentifier: "joinerModels",
65+
fieldType: "HasMany",
66+
requiredArgumentForInput: false,
67+
sortable: false,
68+
filterable: false,
69+
__typename: "GadgetModelField",
70+
configuration: {
71+
__typename: "GadgetHasManyConfig",
72+
fieldType: "HasMany",
73+
validations: [],
74+
isJoinModelHasManyField: true,
75+
relatedModel: {
76+
key: "tJDsf_FvYqsi",
77+
apiIdentifier: "joinerModel",
78+
namespace: ["hasManyThrough"],
79+
defaultDisplayField: {
80+
name: "Id",
81+
apiIdentifier: "id",
82+
fieldType: "ID",
83+
__typename: "GadgetModelField",
84+
},
85+
__typename: "GadgetModel",
86+
},
87+
inverseField: {
88+
apiIdentifier: "joinerBelongsToBase",
89+
__typename: "GadgetModelField",
90+
},
91+
},
92+
},
93+
{
94+
name: "Base model hmt field",
95+
apiIdentifier: "baseModelHmtField",
96+
fieldType: "HasManyThrough",
97+
requiredArgumentForInput: false,
98+
sortable: false,
99+
filterable: false,
100+
__typename: "GadgetModelField",
101+
configuration: {
102+
__typename: "GadgetHasManyThroughConfig",
103+
fieldType: "HasManyThrough",
104+
validations: [],
105+
relatedModel: {
106+
key: "Oss4sCDW-DJU",
107+
apiIdentifier: "siblingModel",
108+
namespace: ["hasManyThrough"],
109+
defaultDisplayField: {
110+
name: "Id",
111+
apiIdentifier: "id",
112+
fieldType: "ID",
113+
__typename: "GadgetModelField",
114+
},
115+
__typename: "GadgetModel",
116+
},
117+
inverseField: {
118+
apiIdentifier: "siblingModelHmtField",
119+
__typename: "GadgetModelField",
120+
},
121+
joinModel: {
122+
key: "tJDsf_FvYqsi",
123+
apiIdentifier: "joinerModel",
124+
namespace: ["hasManyThrough"],
125+
defaultDisplayField: {
126+
name: "Id",
127+
apiIdentifier: "id",
128+
fieldType: "ID",
129+
__typename: "GadgetModelField",
130+
},
131+
__typename: "GadgetModel",
132+
},
133+
inverseJoinModelField: {
134+
apiIdentifier: "joinerBelongsToBase",
135+
__typename: "GadgetModelField",
136+
},
137+
inverseRelatedModelField: {
138+
apiIdentifier: "joinerBelongsToSibling",
139+
__typename: "GadgetModelField",
140+
},
141+
},
142+
},
143+
],
144+
defaultDisplayField: {
145+
name: "Id",
146+
apiIdentifier: "id",
147+
fieldType: "ID",
148+
__typename: "GadgetModelField",
149+
},
150+
__typename: "GadgetModel",
151+
},
152+
],
40153
model: {
41154
name: "Base model",
42155
apiIdentifier: "baseModel",

‎packages/react/cypress/component/auto/form/AutoFormUpsertAction.cy.tsx

+79
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,85 @@ describeForEachAutoAdapter("AutoForm - Upsert Action", ({ name, adapter: { AutoF
190190
const upsertModelActionMetadataResponse = {
191191
data: {
192192
gadgetMeta: {
193+
modelAndRelatedModels: [
194+
{
195+
name: "Widget",
196+
apiIdentifier: "widget",
197+
defaultRecord: {
198+
name: "",
199+
description: {
200+
markdown: "",
201+
},
202+
category: [],
203+
__typename: "Widget",
204+
},
205+
fields: [
206+
{
207+
name: "Id",
208+
apiIdentifier: "id",
209+
fieldType: "ID",
210+
requiredArgumentForInput: false,
211+
sortable: true,
212+
filterable: true,
213+
__typename: "GadgetModelField",
214+
configuration: {
215+
__typename: "GadgetGenericFieldConfig",
216+
fieldType: "ID",
217+
validations: [],
218+
},
219+
},
220+
{
221+
name: "Name",
222+
apiIdentifier: "name",
223+
fieldType: "String",
224+
requiredArgumentForInput: true,
225+
sortable: true,
226+
filterable: true,
227+
__typename: "GadgetModelField",
228+
configuration: {
229+
__typename: "GadgetGenericFieldConfig",
230+
fieldType: "String",
231+
validations: [
232+
{
233+
__typename: "GadgetGenericFieldValidation",
234+
name: "Required",
235+
specID: "gadget/validation/required",
236+
},
237+
],
238+
},
239+
},
240+
{
241+
name: "Inventory count",
242+
apiIdentifier: "inventoryCount",
243+
fieldType: "Number",
244+
requiredArgumentForInput: true,
245+
sortable: true,
246+
filterable: true,
247+
__typename: "GadgetModelField",
248+
configuration: {
249+
__typename: "GadgetNumberConfig",
250+
fieldType: "Number",
251+
validations: [
252+
{
253+
__typename: "GadgetRangeFieldValidation",
254+
name: "Number range",
255+
specID: "gadget/validation/number-range",
256+
min: 0,
257+
max: null,
258+
},
259+
{
260+
__typename: "GadgetGenericFieldValidation",
261+
name: "Required",
262+
specID: "gadget/validation/required",
263+
},
264+
],
265+
decimals: null,
266+
},
267+
},
268+
],
269+
__typename: "GadgetModel",
270+
},
271+
],
193272
model: {
194273
name: "Widget",
195274
apiIdentifier: "widget",

0 commit comments

Comments
 (0)