Astro Info
Astro v5.1.8
Node v22.13.1
System macOS (arm64)
Package Manager bun
Output server
Adapter @astrojs/vercel
Integrations @astrojs/tailwind
@astrojs/sitemap
astro-typed-links
If this issue only occurs in one browser, which browser is a problem?
No response
Describe the Bug
When using the file loader, or a custom loader that results in the creation of a single json file, the resulting json schema is incorrectly typed as a 'object' instead of 'array'.
From the docs:
The file() loader creates entries from a single file that contains an array of objects with a unique id field, or an object with IDs as keys and entries as values.
- If you pass in a zod object as schema, the json schema definition is of type 'object'. This then makes the json file have invalid type inference because it expects an 'object', while it is an array of objects.
- If you pass in a zod array of objects, the json schema is an 'array', but the parser fails bc it is parsing each object in the array.
Example 1: using object schema
// src/content.config.ts
const dogsCollection = defineCollection({
loader: file('src/data/dogs.json'),
schema: z.object({
id: z.string(),
name: z.string()
})
})Resulting Error (VSCode)
Example 2: using array schema
// src/content.config.ts
const dogsCollection = defineCollection({
loader: file('src/data/dogs.json'),
schema: z.array(
z.object({
id: z.number(),
name: z.string(),
}),
),
})⚡ bun run sync
$ astro sync --force
12:39:40 [content] Syncing content
[InvalidContentEntryDataError] dogs → 1 data does not match collection schema.
Expected type `"array"`, received `"object"`
Hint:
See https://docs.astro.build/en/guides/content-collections/ for more information on content schemas.
Error reference:
https://docs.astro.build/en/reference/errors/invalid-content-entry-data-error/
Location:
/Users/divinelight/code/clients/provision-rpm/src/data/dogs.json:0:0
Stack trace:
at getEntryDataAndImages (file:///Users/divinelight/code/clients/provision-rpm/node_modules/astro/dist/content/utils.js:163:26)
at async syncData (/Users/divinelight/code/clients/provision-rpm/node_modules/astro/dist/content/loaders/file.js:49:28)
at async Promise.all (index 4)
at async file:///Users/divinelight/code/clients/provision-rpm/node_modules/p-queue/dist/index.js:230:36
error: script "sync" exited with code 1
What's the expected result?
If we pass in an object as schema, the loader should recognize that the file contains an array of this object type, and produce an json schema for an array of objects.
Link to Minimal Reproducible Example
https://stackblitz.com/edit/github-wuk59bem?file=.vscode%2Fsettings.json
Participation
Astro Info
If this issue only occurs in one browser, which browser is a problem?
No response
Describe the Bug
When using the file loader, or a custom loader that results in the creation of a single json file, the resulting json schema is incorrectly typed as a 'object' instead of 'array'.
From the docs:
Example 1: using object schema
Resulting Error (VSCode)
Example 2: using array schema
What's the expected result?
If we pass in an object as schema, the loader should recognize that the file contains an array of this object type, and produce an json schema for an array of objects.
{ "$ref": "#/definitions/dogs", "definitions": { "dogs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "$schema": "http://json-schema.org/draft-07/schema#" }Link to Minimal Reproducible Example
https://stackblitz.com/edit/github-wuk59bem?file=.vscode%2Fsettings.json
Participation