feat: support custom Integration Fields data with catalog-specific types

[angeloashmore]

Types of changes

• Chore (a non-breaking change which is related to package maintenance)
• Bug fix (a non-breaking change which fixes an issue)
• New feature (a non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Description

This PR adds the ability to type Integration Fields fields with custom catalog-specific types.

For example, if you know the object type returned by a Shopify catalog, you can configure the output to include your custom type.

Custom types can be provided to generateTypes()'s fieldConfigs.integrationFields.catalogTypes option:

const model = prismicM.model.customType({
	seed: t.title,
	id: "foo",
	fields: {
		bar: prismicM.model.integrationFields({
			seed: t.title,
			catalog: "baz"
		}),
	},
});

const types = generateTypes({
	customTypeModels: [model],
	fieldConfigs: {
		integrationFields: {
			catalogTypes: {
				baz: "BazType",
			},
		},
	},
});

This will provide the following output (this is not the full output, only the relevant part):

interface FooDocumentData {
	bar: prismicT.IntegrationFields<BazType>;
}

If no provider-specific types are given, the field will be typed as prismicT.IntegrationFields.

Checklist:

• My change requires an update to the official documentation.
• All TSDoc comments are up-to-date and new ones have been added where necessary.
• All new and existing tests are passing.

🐤

[github-actions]

size-limit report 📦

Path	Size
dist/index.js	1.04 MB (+0.01% 🔺)
dist/index.cjs	1.04 MB (+0.01% 🔺)