Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
485 lines
17 KiB
Plaintext
485 lines
17 KiB
Plaintext
import { describe, it, expect } from 'vitest';
|
|
import { sanitizeConfig } from '../config/sanitize.js';
|
|
import { configToJSONSchema } from './configToJSONSchema.js';
|
|
describe('configToJSONSchema', ()=>{
|
|
it('should handle optional arrays with required fields', async ()=>{
|
|
// @ts-expect-error
|
|
const config = {
|
|
collections: [
|
|
{
|
|
slug: 'test',
|
|
fields: [
|
|
{
|
|
name: 'someRequiredField',
|
|
type: 'array',
|
|
fields: [
|
|
{
|
|
name: 'someRequiredField',
|
|
type: 'text',
|
|
required: true
|
|
}
|
|
]
|
|
}
|
|
],
|
|
timestamps: false
|
|
}
|
|
]
|
|
};
|
|
const sanitizedConfig = await sanitizeConfig(config);
|
|
const schema = configToJSONSchema(sanitizedConfig, 'text');
|
|
expect(schema?.definitions?.test).toStrictEqual({
|
|
type: 'object',
|
|
additionalProperties: false,
|
|
properties: {
|
|
id: {
|
|
type: 'string'
|
|
},
|
|
someRequiredField: {
|
|
type: [
|
|
'array',
|
|
'null'
|
|
],
|
|
items: {
|
|
type: 'object',
|
|
additionalProperties: false,
|
|
properties: {
|
|
id: {
|
|
type: [
|
|
'string',
|
|
'null'
|
|
]
|
|
},
|
|
someRequiredField: {
|
|
type: 'string'
|
|
}
|
|
},
|
|
required: [
|
|
'someRequiredField'
|
|
]
|
|
}
|
|
}
|
|
},
|
|
required: [
|
|
'id'
|
|
],
|
|
title: 'Test'
|
|
});
|
|
});
|
|
it('should handle block fields with no blocks', async ()=>{
|
|
// @ts-expect-error
|
|
const config = {
|
|
collections: [
|
|
{
|
|
slug: 'test',
|
|
fields: [
|
|
{
|
|
name: 'blockField',
|
|
type: 'blocks',
|
|
blocks: []
|
|
},
|
|
{
|
|
name: 'blockFieldRequired',
|
|
type: 'blocks',
|
|
blocks: [],
|
|
required: true
|
|
},
|
|
{
|
|
name: 'blockFieldWithFields',
|
|
type: 'blocks',
|
|
blocks: [
|
|
{
|
|
slug: 'test',
|
|
fields: [
|
|
{
|
|
name: 'field',
|
|
type: 'text'
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
name: 'blockFieldWithFieldsRequired',
|
|
type: 'blocks',
|
|
blocks: [
|
|
{
|
|
slug: 'test',
|
|
fields: [
|
|
{
|
|
name: 'field',
|
|
type: 'text',
|
|
required: true
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
timestamps: false
|
|
}
|
|
]
|
|
};
|
|
const sanitizedConfig = await sanitizeConfig(config);
|
|
const schema = configToJSONSchema(sanitizedConfig, 'text');
|
|
expect(schema?.definitions?.test).toStrictEqual({
|
|
type: 'object',
|
|
additionalProperties: false,
|
|
properties: {
|
|
id: {
|
|
type: 'string'
|
|
},
|
|
blockField: {
|
|
type: [
|
|
'array',
|
|
'null'
|
|
],
|
|
items: {}
|
|
},
|
|
blockFieldRequired: {
|
|
type: 'array',
|
|
items: {}
|
|
},
|
|
blockFieldWithFields: {
|
|
type: [
|
|
'array',
|
|
'null'
|
|
],
|
|
items: {
|
|
oneOf: [
|
|
{
|
|
type: 'object',
|
|
additionalProperties: false,
|
|
properties: {
|
|
id: {
|
|
type: [
|
|
'string',
|
|
'null'
|
|
]
|
|
},
|
|
blockName: {
|
|
type: [
|
|
'string',
|
|
'null'
|
|
]
|
|
},
|
|
blockType: {
|
|
const: 'test'
|
|
},
|
|
field: {
|
|
type: [
|
|
'string',
|
|
'null'
|
|
]
|
|
}
|
|
},
|
|
required: [
|
|
'blockType'
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
blockFieldWithFieldsRequired: {
|
|
type: [
|
|
'array',
|
|
'null'
|
|
],
|
|
items: {
|
|
oneOf: [
|
|
{
|
|
type: 'object',
|
|
additionalProperties: false,
|
|
properties: {
|
|
id: {
|
|
type: [
|
|
'string',
|
|
'null'
|
|
]
|
|
},
|
|
blockName: {
|
|
type: [
|
|
'string',
|
|
'null'
|
|
]
|
|
},
|
|
blockType: {
|
|
const: 'test'
|
|
},
|
|
field: {
|
|
type: 'string'
|
|
}
|
|
},
|
|
required: [
|
|
'blockType',
|
|
'field'
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
required: [
|
|
'id',
|
|
'blockFieldRequired'
|
|
],
|
|
title: 'Test'
|
|
});
|
|
});
|
|
it('should handle tabs and named tabs with required fields', async ()=>{
|
|
// @ts-expect-error
|
|
const config = {
|
|
collections: [
|
|
{
|
|
slug: 'test',
|
|
fields: [
|
|
{
|
|
type: 'tabs',
|
|
tabs: [
|
|
{
|
|
fields: [
|
|
{
|
|
name: 'fieldInUnnamedTab',
|
|
type: 'text'
|
|
}
|
|
],
|
|
label: 'unnamedTab'
|
|
},
|
|
{
|
|
name: 'namedTab',
|
|
fields: [
|
|
{
|
|
name: 'fieldInNamedTab',
|
|
type: 'text'
|
|
}
|
|
],
|
|
label: 'namedTab'
|
|
},
|
|
{
|
|
name: 'namedTabWithRequired',
|
|
fields: [
|
|
{
|
|
name: 'fieldInNamedTab',
|
|
type: 'text',
|
|
required: true
|
|
}
|
|
],
|
|
label: 'namedTabWithRequired'
|
|
}
|
|
]
|
|
}
|
|
],
|
|
timestamps: false
|
|
}
|
|
]
|
|
};
|
|
const sanitizedConfig = await sanitizeConfig(config);
|
|
const schema = configToJSONSchema(sanitizedConfig, 'text');
|
|
expect(schema?.definitions?.test).toStrictEqual({
|
|
type: 'object',
|
|
additionalProperties: false,
|
|
properties: {
|
|
id: {
|
|
type: 'string'
|
|
},
|
|
fieldInUnnamedTab: {
|
|
type: [
|
|
'string',
|
|
'null'
|
|
]
|
|
},
|
|
namedTab: {
|
|
type: 'object',
|
|
additionalProperties: false,
|
|
properties: {
|
|
fieldInNamedTab: {
|
|
type: [
|
|
'string',
|
|
'null'
|
|
]
|
|
}
|
|
},
|
|
required: []
|
|
},
|
|
namedTabWithRequired: {
|
|
type: 'object',
|
|
additionalProperties: false,
|
|
properties: {
|
|
fieldInNamedTab: {
|
|
type: 'string'
|
|
}
|
|
},
|
|
required: [
|
|
'fieldInNamedTab'
|
|
]
|
|
}
|
|
},
|
|
required: [
|
|
'id',
|
|
'namedTabWithRequired'
|
|
],
|
|
title: 'Test'
|
|
});
|
|
});
|
|
it('should handle custom typescript schema and JSON field schema', async ()=>{
|
|
const customSchema = {
|
|
type: 'object',
|
|
properties: {
|
|
id: {
|
|
type: 'number'
|
|
},
|
|
required: [
|
|
'id'
|
|
]
|
|
}
|
|
};
|
|
const config = {
|
|
collections: [
|
|
{
|
|
slug: 'test',
|
|
fields: [
|
|
{
|
|
name: 'withCustom',
|
|
type: 'text',
|
|
typescriptSchema: [
|
|
()=>customSchema
|
|
]
|
|
},
|
|
{
|
|
name: 'jsonWithSchema',
|
|
type: 'json',
|
|
jsonSchema: {
|
|
fileMatch: [
|
|
'a://b/foo.json'
|
|
],
|
|
schema: customSchema,
|
|
uri: 'a://b/foo.json'
|
|
}
|
|
}
|
|
],
|
|
timestamps: false
|
|
}
|
|
]
|
|
};
|
|
const sanitizedConfig = await sanitizeConfig(config);
|
|
const schema = configToJSONSchema(sanitizedConfig, 'text');
|
|
expect(schema?.definitions?.test).toStrictEqual({
|
|
type: 'object',
|
|
additionalProperties: false,
|
|
properties: {
|
|
id: {
|
|
type: 'string'
|
|
},
|
|
jsonWithSchema: customSchema,
|
|
withCustom: customSchema
|
|
},
|
|
required: [
|
|
'id'
|
|
],
|
|
title: 'Test'
|
|
});
|
|
});
|
|
it('should handle same block object being referenced in both collection and config.blocks', async ()=>{
|
|
const sharedBlock = {
|
|
slug: 'sharedBlock',
|
|
interfaceName: 'SharedBlock',
|
|
fields: [
|
|
{
|
|
name: 'richText',
|
|
type: 'richText',
|
|
editor: ()=>{
|
|
// stub rich text editor
|
|
return {
|
|
CellComponent: '',
|
|
FieldComponent: '',
|
|
validate: ()=>true
|
|
};
|
|
}
|
|
}
|
|
]
|
|
};
|
|
// @ts-expect-error
|
|
const config = {
|
|
blocks: [
|
|
sharedBlock
|
|
],
|
|
collections: [
|
|
{
|
|
slug: 'test',
|
|
fields: [
|
|
{
|
|
name: 'someBlockField',
|
|
type: 'blocks',
|
|
blocks: [
|
|
sharedBlock
|
|
]
|
|
}
|
|
],
|
|
timestamps: false
|
|
}
|
|
]
|
|
};
|
|
// Ensure both rich text editor are sanitized
|
|
const sanitizedConfig = await sanitizeConfig(config);
|
|
expect(typeof sanitizedConfig?.blocks?.[0]?.fields?.[0]?.editor).toBe('object');
|
|
expect(typeof sanitizedConfig.collections[0].fields[0]?.blocks?.[0]?.fields?.[0]?.editor).toBe('object');
|
|
const schema = configToJSONSchema(sanitizedConfig, 'text');
|
|
expect(schema?.definitions?.test).toStrictEqual({
|
|
type: 'object',
|
|
additionalProperties: false,
|
|
title: 'Test',
|
|
properties: {
|
|
id: {
|
|
type: 'string'
|
|
},
|
|
someBlockField: {
|
|
type: [
|
|
'array',
|
|
'null'
|
|
],
|
|
items: {
|
|
oneOf: [
|
|
{
|
|
$ref: '#/definitions/SharedBlock'
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
required: [
|
|
'id'
|
|
]
|
|
});
|
|
expect(schema?.definitions?.SharedBlock).toBeDefined();
|
|
});
|
|
it('should allow overriding required to false', async ()=>{
|
|
// @ts-expect-error
|
|
const config = {
|
|
collections: [
|
|
{
|
|
slug: 'test',
|
|
fields: [
|
|
{
|
|
name: 'title',
|
|
type: 'text',
|
|
required: true,
|
|
defaultValue: 'test',
|
|
typescriptSchema: [
|
|
()=>({
|
|
type: 'string',
|
|
required: false
|
|
})
|
|
]
|
|
}
|
|
],
|
|
timestamps: false
|
|
}
|
|
]
|
|
};
|
|
const sanitizedConfig = await sanitizeConfig(config);
|
|
const schema = configToJSONSchema(sanitizedConfig, 'text');
|
|
// @ts-expect-error
|
|
expect(schema.definitions.test.properties.title.required).toStrictEqual(false);
|
|
});
|
|
});
|
|
|
|
//# sourceMappingURL=configToJSONSchema.spec.js.map |