@prismicio/mock - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

dist/index.d.ts

@@ -6,6 +6,29 @@ import * as prismicT from '@prismicio/types';
 
+declare type ValueForModelMapConfigs = {
+    boolean?: MockBooleanValueConfig;
+    color?: MockColorValueConfig;
+    contentRelationship?: MockContentRelationshipValueConfig;
+    date?: MockDateValueConfig;
+    embed?: MockEmbedValueConfig;
+    geoPoint?: MockGeoPointValueConfig;
+    group?: MockGroupValueConfig;
+    image?: MockImageValueConfig;
+    integrationFields?: MockIntegrationFieldsValueConfig;
+    keyText?: MockKeyTextValueConfig;
+    link?: MockLinkValueConfig;
+    linkToMedia?: MockLinkToMediaValueConfig;
+    number?: MockNumberValueConfig;
+    richText?: MockRichTextValueConfig$1;
+    select?: MockSelectValueConfig;
+    slices?: MockSliceZoneValueConfig;
+    timestamp?: MockTimestampValueConfig;
+    title?: MockTitleValueConfig;
+    uid?: MockUIDValueConfig;
+};
+
 declare type MockCustomTypeValueConfig<Model extends prismicT.CustomTypeModel = prismicT.CustomTypeModel> = {
     sharedSliceModels?: prismicT.SharedSliceModel[];
+    configs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
-declare const customType$1: <Model extends prismicT.CustomTypeModel<string, prismicT.CustomTypeModelDefinition<string>> = prismicT.CustomTypeModel<string, prismicT.CustomTypeModelDefinition<string>>>(config?: MockCustomTypeValueConfig) => ModelValue<Model>;
+declare const customType$1: <Model extends prismicT.CustomTypeModel<string, prismicT.CustomTypeModelDefinition<string>> = prismicT.CustomTypeModel<string, prismicT.CustomTypeModelDefinition<string>>>(config?: MockCustomTypeValueConfig<Model>) => ModelValue<Model>;
 
@@ -15,6 +38,10 @@ declare type MockColorValueConfig<Model extends prismicT.CustomTypeModelColorField = prismicT.CustomTypeModelColorField> = MockValueConfig<Model>;
 
-declare type MockContentRelationshipValueConfig<IsFilled extends boolean = true, Model extends prismicT.CustomTypeModelContentRelationshipField = prismicT.CustomTypeModelContentRelationshipField> = {
+declare type MockContentRelationshipValueConfig<IsFilled extends boolean = boolean, Model extends prismicT.CustomTypeModelContentRelationshipField = prismicT.CustomTypeModelContentRelationshipField> = {
     isFilled?: IsFilled;
+    /**
+     * A list of potential documents to which the field can be linked.
+     */
+    linkableDocuments?: prismicT.PrismicDocument[];
 } & MockValueConfig<Model>;
-declare type MockContentRelationshipValue<IsFilled extends boolean = true> = IsFilled extends true ? prismicT.FilledLinkToDocumentField : prismicT.EmptyLinkField<prismicT.LinkType.Document>;
+declare type MockContentRelationshipValue<IsFilled extends boolean = boolean> = IsFilled extends true ? prismicT.FilledLinkToDocumentField : prismicT.EmptyLinkField<prismicT.LinkType.Document>;
 declare const contentRelationship$1: <IsFilled extends boolean = true, Model extends prismicT.CustomTypeModelContentRelationshipField = prismicT.CustomTypeModelContentRelationshipField>(config?: MockContentRelationshipValueConfig<IsFilled, Model>) => MockContentRelationshipValue<IsFilled>;
@@ -53,2 +80,3 @@
     pattern?: keyof typeof patterns$5;
+    configs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
@@ -60,2 +88,7 @@ declare const group$1: <Model extends prismicT.CustomTypeModelGroupField<Record<string, prismicT.CustomTypeModelFieldForGroup>> = prismicT.CustomTypeModelGroupField<Record<string, prismicT.CustomTypeModelFieldForGroup>>>(config?: MockGroupValueConfig<Model>) => ModelValue<Model>;
 
+declare type MockIntegrationFieldsValueConfig<Model extends prismicT.CustomTypeModelIntegrationFieldsField = prismicT.CustomTypeModelIntegrationFieldsField, Blob extends unknown = unknown> = {
+    data?: Blob;
+} & MockValueConfig<Model>;
+declare const integrationFields$1: <Model extends prismicT.CustomTypeModelIntegrationFieldsField = prismicT.CustomTypeModelIntegrationFieldsField, Blob_1 extends unknown = unknown>(config?: MockIntegrationFieldsValueConfig<Model, Blob_1>) => prismicT.IntegrationFields<Blob_1>;
+
 declare type MockKeyTextValueConfig<Model extends prismicT.CustomTypeModelKeyTextField = prismicT.CustomTypeModelKeyTextField> = MockValueConfig<Model>;
@@ -68,2 +101,6 @@ declare const keyText$1: (config?: MockKeyTextValueConfig) => prismicT.KeyTextField;
     withTargetBlank?: Model["config"]["allowTargetBlank"] extends undefined ? false : boolean;
+    /**
+     * A list of potential documents to which the field can be linked.
+     */
+    linkableDocuments?: LinkType extends prismicT.LinkType.Document ? prismicT.PrismicDocument[] : never;
 } & MockValueConfig<Model>;
@@ -126,2 +163,4 @@ declare type MockLinkValue<LinkType extends prismicT.LinkType = prismicT.LinkType, IsFilled extends boolean = true> = IsFilled extends true ? LinkType extends prismicT.LinkType.Web ? prismicT.FilledLinkToWebField : LinkType extends prismicT.LinkType.Media ? prismicT.FilledLinkToMediaField : LinkType extends prismicT.LinkType.Document ? prismicT.FilledLinkToDocumentField : never : prismicT.EmptyLinkField<LinkType>;
     pattern?: keyof typeof patterns$3;
+    primaryFieldConfigs?: ValueForModelMapConfigs;
+    itemsFieldConfigs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
@@ -147,2 +186,4 @@ declare const slice$1: <Model extends prismicT.CustomTypeModelSlice<Record<string, prismicT.CustomTypeModelFieldForGroup>, Record<string, prismicT.CustomTypeModelFieldForGroup>> = prismicT.CustomTypeModelSlice<Record<string, prismicT.CustomTypeModelFieldForGroup>, Record<string, prismicT.CustomTypeModelFieldForGroup>>>(config?: MockSliceValueConfig<Model>) => ModelValue<Model>;
     pattern?: keyof typeof patterns$2;
+    primaryFieldConfigs?: ValueForModelMapConfigs;
+    itemsFieldConfigs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
@@ -173,6 +214,8 @@ declare const sliceZone$1: <Model extends prismicT.CustomTypeModelSliceZoneField<Record<string, prismicT.CustomTypeModelSlice<Record<string, prismicT.CustomTypeModelFieldForGroup>, Record<string, prismicT.CustomTypeModelFieldForGroup>> | prismicT.CustomTypeModelSharedSlice>> = prismicT.CustomTypeModelSliceZoneField<Record<string, prismicT.CustomTypeModelSlice<Record<string, prismicT.CustomTypeModelFieldForGroup>, Record<string, prismicT.CustomTypeModelFieldForGroup>> | prismicT.CustomTypeModelSharedSlice>>>(config?: MockSliceZoneValueConfig<Model>) => ModelValue<Model>;
     pattern?: keyof typeof patterns$1;
+    primaryFieldConfigs?: ValueForModelMapConfigs;
+    itemsFieldConfigs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
 declare const sharedSliceVariation$1: <Model extends prismicT.SharedSliceModelVariation<Record<string, prismicT.CustomTypeModelFieldForGroup>, Record<string, prismicT.CustomTypeModelFieldForGroup>> = prismicT.SharedSliceModelVariation<Record<string, prismicT.CustomTypeModelFieldForGroup>, Record<string, prismicT.CustomTypeModelFieldForGroup>>>(config?: MockSharedSliceVariationValueConfig<Model>) => ModelValue<Model>;
 
-declare type MockSharedSliceValueConfig<Model extends prismicT.SharedSliceModel = prismicT.SharedSliceModel> = Pick<MockSharedSliceVariationValueConfig, "pattern"> & MockValueConfig<Model>;
+declare type MockSharedSliceValueConfig<Model extends prismicT.SharedSliceModel = prismicT.SharedSliceModel> = Pick<MockSharedSliceVariationValueConfig, "pattern" | "primaryFieldConfigs" | "itemsFieldConfigs"> & MockValueConfig<Model>;
 declare const sharedSlice$1: <Model extends prismicT.SharedSliceModel<string, prismicT.SharedSliceModelVariation<Record<string, prismicT.CustomTypeModelFieldForGroup>, Record<string, prismicT.CustomTypeModelFieldForGroup>>> = prismicT.SharedSliceModel<string, prismicT.SharedSliceModelVariation<Record<string, prismicT.CustomTypeModelFieldForGroup>, Record<string, prismicT.CustomTypeModelFieldForGroup>>>>(config?: MockSharedSliceValueConfig<Model>) => ModelValue<Model>;
@@ -215,2 +258,3 @@
 type index$1_MockImageValueConfig<_0> = MockImageValueConfig<_0>;
+type index$1_MockIntegrationFieldsValueConfig<_0, _1> = MockIntegrationFieldsValueConfig<_0, _1>;
 type index$1_MockKeyTextValueConfig<_0> = MockKeyTextValueConfig<_0>;
@@ -250,2 +294,4 @@ type index$1_MockLinkValueConfig<_0, _1, _2> = MockLinkValueConfig<_0, _1, _2>;
     index$1_MockImageValueConfig as MockImageValueConfig,
+    integrationFields$1 as integrationFields,
+    index$1_MockIntegrationFieldsValueConfig as MockIntegrationFieldsValueConfig,
     keyText$1 as keyText,
@@ -300,3 +346,3 @@ index$1_MockKeyTextValueConfig as MockKeyTextValueConfig,
 declare type CustomTypeModelValue<T extends prismicT.CustomTypeModel> = prismicT.PrismicDocument<ModelValueMap<ValueOf<T["json"]>>>;
-declare type CustomTypeModelFieldForGroupValue<T extends prismicT.CustomTypeModelFieldForGroup> = T extends prismicT.CustomTypeModelBooleanField ? prismicT.BooleanField : T extends prismicT.CustomTypeModelColorField ? prismicT.ColorField : T extends prismicT.CustomTypeModelTitleField ? prismicT.TitleField : T extends prismicT.CustomTypeModelRichTextField ? prismicT.RichTextField : T extends prismicT.CustomTypeModelImageField ? prismicT.ImageField : T extends prismicT.CustomTypeModelLinkField ? prismicT.LinkField : T extends prismicT.CustomTypeModelLinkToMediaField ? prismicT.LinkToMediaField : T extends prismicT.CustomTypeModelContentRelationshipField ? prismicT.RelationField : T extends prismicT.CustomTypeModelDateField ? prismicT.DateField : T extends prismicT.CustomTypeModelTimestampField ? prismicT.TimestampField : T extends prismicT.CustomTypeModelNumberField ? prismicT.NumberField : T extends prismicT.CustomTypeModelKeyTextField ? prismicT.KeyTextField : T extends prismicT.CustomTypeModelSelectField ? prismicT.SelectField : T extends prismicT.CustomTypeModelEmbedField ? prismicT.EmbedField : T extends prismicT.CustomTypeModelGeoPointField ? prismicT.GeoPointField : T extends prismicT.CustomTypeModelIntegrationField ? prismicT.IntegrationField : never;
+declare type CustomTypeModelFieldForGroupValue<T extends prismicT.CustomTypeModelFieldForGroup> = T extends prismicT.CustomTypeModelBooleanField ? prismicT.BooleanField : T extends prismicT.CustomTypeModelColorField ? prismicT.ColorField : T extends prismicT.CustomTypeModelTitleField ? prismicT.TitleField : T extends prismicT.CustomTypeModelRichTextField ? prismicT.RichTextField : T extends prismicT.CustomTypeModelImageField ? prismicT.ImageField : T extends prismicT.CustomTypeModelLinkField ? prismicT.LinkField : T extends prismicT.CustomTypeModelLinkToMediaField ? prismicT.LinkToMediaField : T extends prismicT.CustomTypeModelContentRelationshipField ? prismicT.RelationField : T extends prismicT.CustomTypeModelDateField ? prismicT.DateField : T extends prismicT.CustomTypeModelTimestampField ? prismicT.TimestampField : T extends prismicT.CustomTypeModelNumberField ? prismicT.NumberField : T extends prismicT.CustomTypeModelKeyTextField ? prismicT.KeyTextField : T extends prismicT.CustomTypeModelSelectField ? prismicT.SelectField : T extends prismicT.CustomTypeModelEmbedField ? prismicT.EmbedField : T extends prismicT.CustomTypeModelGeoPointField ? prismicT.GeoPointField : T extends prismicT.CustomTypeModelIntegrationFieldsField ? prismicT.IntegrationFields : never;
 declare type CustomTypeModelGroupFieldValue<T extends prismicT.CustomTypeModelGroupField> = prismicT.GroupField<ModelValueMap<T["config"]["fields"]>>;
@@ -319,22 +365,2 @@ declare type CustomTypeModelSliceValue<T extends prismicT.CustomTypeModelSlice> = prismicT.Slice<string, ModelValueMap<T["non-repeat"]>, ModelValueMap<T["repeat"]>>;
 
-declare type MockCustomTypeModelConfig = {
-    tabsCount?: number;
-    withUID?: boolean;
-} & ({
-    withSliceZones?: false;
-} | {
-    withSliceZones: true;
-    withSharedSlices?: boolean;
-}) & MockModelConfig;
-declare const customType: (config?: MockCustomTypeModelConfig) => prismicT.CustomTypeModel;
-
-declare type MockDateModelConfig = MockModelConfig;
-declare const date: (config?: MockDateModelConfig) => prismicT.CustomTypeModelDateField;
-
-declare type MockEmbedModelConfig = MockModelConfig;
-declare const embed: (config?: MockEmbedModelConfig) => prismicT.CustomTypeModelEmbedField;
-
-declare type MockGeoPointModelConfig = MockModelConfig;
-declare const geoPoint: (config?: MockGeoPointModelConfig) => prismicT.CustomTypeModelGeoPointField;
-
 declare type MockRichTextModelConfig<WithMultipleBlocks extends boolean = boolean> = {
@@ -368,2 +394,3 @@ withMultipleBlocks?: WithMultipleBlocks;
     } & MockModelConfig) => prismicT.CustomTypeModelImageField;
+    readonly integrationFields: (config?: MockModelConfig) => prismicT.CustomTypeModelIntegrationFieldsField;
     readonly keyText: (config?: MockModelConfig) => prismicT.CustomTypeModelKeyTextField;
@@ -397,2 +424,23 @@ readonly link: <AllowTargetBlank extends boolean = boolean>(config?: MockLinkModelConfig<AllowTargetBlank>) => prismicT.CustomTypeModelLinkField & {
 
+declare type MockCustomTypeModelConfig = {
+    tabsCount?: number;
+    withUID?: boolean;
+    configs?: BuildMockGroupFieldMapConfig["configs"];
+} & ({
+    withSliceZones?: false;
+} | {
+    withSliceZones: true;
+    withSharedSlices?: boolean;
+}) & MockModelConfig;
+declare const customType: (config?: MockCustomTypeModelConfig) => prismicT.CustomTypeModel;
+
+declare type MockDateModelConfig = MockModelConfig;
+declare const date: (config?: MockDateModelConfig) => prismicT.CustomTypeModelDateField;
+
+declare type MockEmbedModelConfig = MockModelConfig;
+declare const embed: (config?: MockEmbedModelConfig) => prismicT.CustomTypeModelEmbedField;
+
+declare type MockGeoPointModelConfig = MockModelConfig;
+declare const geoPoint: (config?: MockGeoPointModelConfig) => prismicT.CustomTypeModelGeoPointField;
+
 declare type MockGroupModelConfig = BuildMockGroupFieldMapConfig & MockModelConfig;
@@ -407,2 +455,5 @@ declare const group: (config?: MockGroupModelConfig) => prismicT.CustomTypeModelGroupField;
 
+declare type MockIntegrationFieldsModelConfig = MockModelConfig;
+declare const integrationFields: (config?: MockIntegrationFieldsModelConfig) => prismicT.CustomTypeModelIntegrationFieldsField;
+
 declare type MockKeyTextModelConfig = MockModelConfig;
@@ -466,2 +517,3 @@ declare const keyText: (config?: MockKeyTextModelConfig) => prismicT.CustomTypeModelKeyTextField;
 declare const index_image: typeof image;
+declare const index_integrationFields: typeof integrationFields;
 declare const index_keyText: typeof keyText;
@@ -492,2 +544,3 @@ declare const index_link: typeof link;
     index_image as image,
+    index_integrationFields as integrationFields,
     index_keyText as keyText,
@@ -494,0 +547,0 @@ index_link as link,

dist/model/index.d.ts

@@ -19,22 +19,2 @@ import * as prismicT from '@prismicio/types';
 
-declare type MockCustomTypeModelConfig = {
-    tabsCount?: number;
-    withUID?: boolean;
-} & ({
-    withSliceZones?: false;
-} | {
-    withSliceZones: true;
-    withSharedSlices?: boolean;
-}) & MockModelConfig;
-declare const customType: (config?: MockCustomTypeModelConfig) => prismicT.CustomTypeModel;
-
-declare type MockDateModelConfig = MockModelConfig;
-declare const date: (config?: MockDateModelConfig) => prismicT.CustomTypeModelDateField;
-
-declare type MockEmbedModelConfig = MockModelConfig;
-declare const embed: (config?: MockEmbedModelConfig) => prismicT.CustomTypeModelEmbedField;
-
-declare type MockGeoPointModelConfig = MockModelConfig;
-declare const geoPoint: (config?: MockGeoPointModelConfig) => prismicT.CustomTypeModelGeoPointField;
-
 declare type MockRichTextModelConfig<WithMultipleBlocks extends boolean = boolean> = {
@@ -68,2 +48,3 @@ withMultipleBlocks?: WithMultipleBlocks;
     } & MockModelConfig) => prismicT.CustomTypeModelImageField;
+    readonly integrationFields: (config?: MockModelConfig) => prismicT.CustomTypeModelIntegrationFieldsField;
     readonly keyText: (config?: MockModelConfig) => prismicT.CustomTypeModelKeyTextField;
@@ -97,2 +78,23 @@ readonly link: <AllowTargetBlank extends boolean = boolean>(config?: MockLinkModelConfig<AllowTargetBlank>) => prismicT.CustomTypeModelLinkField & {
 
+declare type MockCustomTypeModelConfig = {
+    tabsCount?: number;
+    withUID?: boolean;
+    configs?: BuildMockGroupFieldMapConfig["configs"];
+} & ({
+    withSliceZones?: false;
+} | {
+    withSliceZones: true;
+    withSharedSlices?: boolean;
+}) & MockModelConfig;
+declare const customType: (config?: MockCustomTypeModelConfig) => prismicT.CustomTypeModel;
+
+declare type MockDateModelConfig = MockModelConfig;
+declare const date: (config?: MockDateModelConfig) => prismicT.CustomTypeModelDateField;
+
+declare type MockEmbedModelConfig = MockModelConfig;
+declare const embed: (config?: MockEmbedModelConfig) => prismicT.CustomTypeModelEmbedField;
+
+declare type MockGeoPointModelConfig = MockModelConfig;
+declare const geoPoint: (config?: MockGeoPointModelConfig) => prismicT.CustomTypeModelGeoPointField;
+
 declare type MockGroupModelConfig = BuildMockGroupFieldMapConfig & MockModelConfig;
@@ -107,2 +109,5 @@ declare const group: (config?: MockGroupModelConfig) => prismicT.CustomTypeModelGroupField;
 
+declare type MockIntegrationFieldsModelConfig = MockModelConfig;
+declare const integrationFields: (config?: MockIntegrationFieldsModelConfig) => prismicT.CustomTypeModelIntegrationFieldsField;
+
 declare type MockKeyTextModelConfig = MockModelConfig;
@@ -157,2 +162,2 @@ declare const keyText: (config?: MockKeyTextModelConfig) => prismicT.CustomTypeModelKeyTextField;
 
-export { boolean, color, contentRelationship, customType, date, embed, geoPoint, group, image, keyText, link, linkToMedia, number, richText, select, sharedSlice, sharedSliceChoice, sharedSliceVariation, slice, sliceZone, timestamp, title, uid };
+export { boolean, color, contentRelationship, customType, date, embed, geoPoint, group, image, integrationFields, keyText, link, linkToMedia, number, richText, select, sharedSlice, sharedSliceChoice, sharedSliceVariation, slice, sliceZone, timestamp, title, uid };

dist/value/index.d.ts

@@ -20,3 +20,3 @@ import * as prismicT from '@prismicio/types';
 declare type CustomTypeModelValue<T extends prismicT.CustomTypeModel> = prismicT.PrismicDocument<ModelValueMap<ValueOf<T["json"]>>>;
-declare type CustomTypeModelFieldForGroupValue<T extends prismicT.CustomTypeModelFieldForGroup> = T extends prismicT.CustomTypeModelBooleanField ? prismicT.BooleanField : T extends prismicT.CustomTypeModelColorField ? prismicT.ColorField : T extends prismicT.CustomTypeModelTitleField ? prismicT.TitleField : T extends prismicT.CustomTypeModelRichTextField ? prismicT.RichTextField : T extends prismicT.CustomTypeModelImageField ? prismicT.ImageField : T extends prismicT.CustomTypeModelLinkField ? prismicT.LinkField : T extends prismicT.CustomTypeModelLinkToMediaField ? prismicT.LinkToMediaField : T extends prismicT.CustomTypeModelContentRelationshipField ? prismicT.RelationField : T extends prismicT.CustomTypeModelDateField ? prismicT.DateField : T extends prismicT.CustomTypeModelTimestampField ? prismicT.TimestampField : T extends prismicT.CustomTypeModelNumberField ? prismicT.NumberField : T extends prismicT.CustomTypeModelKeyTextField ? prismicT.KeyTextField : T extends prismicT.CustomTypeModelSelectField ? prismicT.SelectField : T extends prismicT.CustomTypeModelEmbedField ? prismicT.EmbedField : T extends prismicT.CustomTypeModelGeoPointField ? prismicT.GeoPointField : T extends prismicT.CustomTypeModelIntegrationField ? prismicT.IntegrationField : never;
+declare type CustomTypeModelFieldForGroupValue<T extends prismicT.CustomTypeModelFieldForGroup> = T extends prismicT.CustomTypeModelBooleanField ? prismicT.BooleanField : T extends prismicT.CustomTypeModelColorField ? prismicT.ColorField : T extends prismicT.CustomTypeModelTitleField ? prismicT.TitleField : T extends prismicT.CustomTypeModelRichTextField ? prismicT.RichTextField : T extends prismicT.CustomTypeModelImageField ? prismicT.ImageField : T extends prismicT.CustomTypeModelLinkField ? prismicT.LinkField : T extends prismicT.CustomTypeModelLinkToMediaField ? prismicT.LinkToMediaField : T extends prismicT.CustomTypeModelContentRelationshipField ? prismicT.RelationField : T extends prismicT.CustomTypeModelDateField ? prismicT.DateField : T extends prismicT.CustomTypeModelTimestampField ? prismicT.TimestampField : T extends prismicT.CustomTypeModelNumberField ? prismicT.NumberField : T extends prismicT.CustomTypeModelKeyTextField ? prismicT.KeyTextField : T extends prismicT.CustomTypeModelSelectField ? prismicT.SelectField : T extends prismicT.CustomTypeModelEmbedField ? prismicT.EmbedField : T extends prismicT.CustomTypeModelGeoPointField ? prismicT.GeoPointField : T extends prismicT.CustomTypeModelIntegrationFieldsField ? prismicT.IntegrationFields : never;
 declare type CustomTypeModelGroupFieldValue<T extends prismicT.CustomTypeModelGroupField> = prismicT.GroupField<ModelValueMap<T["config"]["fields"]>>;
@@ -30,6 +30,29 @@ declare type CustomTypeModelSliceValue<T extends prismicT.CustomTypeModelSlice> = prismicT.Slice<string, ModelValueMap<T["non-repeat"]>, ModelValueMap<T["repeat"]>>;
 
+declare type ValueForModelMapConfigs = {
+    boolean?: MockBooleanValueConfig;
+    color?: MockColorValueConfig;
+    contentRelationship?: MockContentRelationshipValueConfig;
+    date?: MockDateValueConfig;
+    embed?: MockEmbedValueConfig;
+    geoPoint?: MockGeoPointValueConfig;
+    group?: MockGroupValueConfig;
+    image?: MockImageValueConfig;
+    integrationFields?: MockIntegrationFieldsValueConfig;
+    keyText?: MockKeyTextValueConfig;
+    link?: MockLinkValueConfig;
+    linkToMedia?: MockLinkToMediaValueConfig;
+    number?: MockNumberValueConfig;
+    richText?: MockRichTextValueConfig;
+    select?: MockSelectValueConfig;
+    slices?: MockSliceZoneValueConfig;
+    timestamp?: MockTimestampValueConfig;
+    title?: MockTitleValueConfig;
+    uid?: MockUIDValueConfig;
+};
+
 declare type MockCustomTypeValueConfig<Model extends prismicT.CustomTypeModel = prismicT.CustomTypeModel> = {
     sharedSliceModels?: prismicT.SharedSliceModel[];
+    configs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
-declare const customType: <Model extends prismicT.CustomTypeModel<string, prismicT.CustomTypeModelDefinition<string>> = prismicT.CustomTypeModel<string, prismicT.CustomTypeModelDefinition<string>>>(config?: MockCustomTypeValueConfig) => ModelValue<Model>;
+declare const customType: <Model extends prismicT.CustomTypeModel<string, prismicT.CustomTypeModelDefinition<string>> = prismicT.CustomTypeModel<string, prismicT.CustomTypeModelDefinition<string>>>(config?: MockCustomTypeValueConfig<Model>) => ModelValue<Model>;
 
@@ -39,6 +62,10 @@ declare type MockColorValueConfig<Model extends prismicT.CustomTypeModelColorField = prismicT.CustomTypeModelColorField> = MockValueConfig<Model>;
 
-declare type MockContentRelationshipValueConfig<IsFilled extends boolean = true, Model extends prismicT.CustomTypeModelContentRelationshipField = prismicT.CustomTypeModelContentRelationshipField> = {
+declare type MockContentRelationshipValueConfig<IsFilled extends boolean = boolean, Model extends prismicT.CustomTypeModelContentRelationshipField = prismicT.CustomTypeModelContentRelationshipField> = {
     isFilled?: IsFilled;
+    /**
+     * A list of potential documents to which the field can be linked.
+     */
+    linkableDocuments?: prismicT.PrismicDocument[];
 } & MockValueConfig<Model>;
-declare type MockContentRelationshipValue<IsFilled extends boolean = true> = IsFilled extends true ? prismicT.FilledLinkToDocumentField : prismicT.EmptyLinkField<prismicT.LinkType.Document>;
+declare type MockContentRelationshipValue<IsFilled extends boolean = boolean> = IsFilled extends true ? prismicT.FilledLinkToDocumentField : prismicT.EmptyLinkField<prismicT.LinkType.Document>;
 declare const contentRelationship: <IsFilled extends boolean = true, Model extends prismicT.CustomTypeModelContentRelationshipField = prismicT.CustomTypeModelContentRelationshipField>(config?: MockContentRelationshipValueConfig<IsFilled, Model>) => MockContentRelationshipValue<IsFilled>;
@@ -77,2 +104,3 @@
     pattern?: keyof typeof patterns$5;
+    configs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
@@ -84,2 +112,7 @@ declare const group: <Model extends prismicT.CustomTypeModelGroupField<Record<string, prismicT.CustomTypeModelFieldForGroup>> = prismicT.CustomTypeModelGroupField<Record<string, prismicT.CustomTypeModelFieldForGroup>>>(config?: MockGroupValueConfig<Model>) => ModelValue<Model>;
 
+declare type MockIntegrationFieldsValueConfig<Model extends prismicT.CustomTypeModelIntegrationFieldsField = prismicT.CustomTypeModelIntegrationFieldsField, Blob extends unknown = unknown> = {
+    data?: Blob;
+} & MockValueConfig<Model>;
+declare const integrationFields: <Model extends prismicT.CustomTypeModelIntegrationFieldsField = prismicT.CustomTypeModelIntegrationFieldsField, Blob_1 extends unknown = unknown>(config?: MockIntegrationFieldsValueConfig<Model, Blob_1>) => prismicT.IntegrationFields<Blob_1>;
+
 declare type MockKeyTextValueConfig<Model extends prismicT.CustomTypeModelKeyTextField = prismicT.CustomTypeModelKeyTextField> = MockValueConfig<Model>;
@@ -92,2 +125,6 @@ declare const keyText: (config?: MockKeyTextValueConfig) => prismicT.KeyTextField;
     withTargetBlank?: Model["config"]["allowTargetBlank"] extends undefined ? false : boolean;
+    /**
+     * A list of potential documents to which the field can be linked.
+     */
+    linkableDocuments?: LinkType extends prismicT.LinkType.Document ? prismicT.PrismicDocument[] : never;
 } & MockValueConfig<Model>;
@@ -150,2 +187,4 @@ declare type MockLinkValue<LinkType extends prismicT.LinkType = prismicT.LinkType, IsFilled extends boolean = true> = IsFilled extends true ? LinkType extends prismicT.LinkType.Web ? prismicT.FilledLinkToWebField : LinkType extends prismicT.LinkType.Media ? prismicT.FilledLinkToMediaField : LinkType extends prismicT.LinkType.Document ? prismicT.FilledLinkToDocumentField : never : prismicT.EmptyLinkField<LinkType>;
     pattern?: keyof typeof patterns$3;
+    primaryFieldConfigs?: ValueForModelMapConfigs;
+    itemsFieldConfigs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
@@ -171,2 +210,4 @@ declare const slice: <Model extends prismicT.CustomTypeModelSlice<Record<string, prismicT.CustomTypeModelFieldForGroup>, Record<string, prismicT.CustomTypeModelFieldForGroup>> = prismicT.CustomTypeModelSlice<Record<string, prismicT.CustomTypeModelFieldForGroup>, Record<string, prismicT.CustomTypeModelFieldForGroup>>>(config?: MockSliceValueConfig<Model>) => ModelValue<Model>;
     pattern?: keyof typeof patterns$2;
+    primaryFieldConfigs?: ValueForModelMapConfigs;
+    itemsFieldConfigs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
@@ -197,6 +238,8 @@ declare const sliceZone: <Model extends prismicT.CustomTypeModelSliceZoneField<Record<string, prismicT.CustomTypeModelSlice<Record<string, prismicT.CustomTypeModelFieldForGroup>, Record<string, prismicT.CustomTypeModelFieldForGroup>> | prismicT.CustomTypeModelSharedSlice>> = prismicT.CustomTypeModelSliceZoneField<Record<string, prismicT.CustomTypeModelSlice<Record<string, prismicT.CustomTypeModelFieldForGroup>, Record<string, prismicT.CustomTypeModelFieldForGroup>> | prismicT.CustomTypeModelSharedSlice>>>(config?: MockSliceZoneValueConfig<Model>) => ModelValue<Model>;
     pattern?: keyof typeof patterns$1;
+    primaryFieldConfigs?: ValueForModelMapConfigs;
+    itemsFieldConfigs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
 declare const sharedSliceVariation: <Model extends prismicT.SharedSliceModelVariation<Record<string, prismicT.CustomTypeModelFieldForGroup>, Record<string, prismicT.CustomTypeModelFieldForGroup>> = prismicT.SharedSliceModelVariation<Record<string, prismicT.CustomTypeModelFieldForGroup>, Record<string, prismicT.CustomTypeModelFieldForGroup>>>(config?: MockSharedSliceVariationValueConfig<Model>) => ModelValue<Model>;
 
-declare type MockSharedSliceValueConfig<Model extends prismicT.SharedSliceModel = prismicT.SharedSliceModel> = Pick<MockSharedSliceVariationValueConfig, "pattern"> & MockValueConfig<Model>;
+declare type MockSharedSliceValueConfig<Model extends prismicT.SharedSliceModel = prismicT.SharedSliceModel> = Pick<MockSharedSliceVariationValueConfig, "pattern" | "primaryFieldConfigs" | "itemsFieldConfigs"> & MockValueConfig<Model>;
 declare const sharedSlice: <Model extends prismicT.SharedSliceModel<string, prismicT.SharedSliceModelVariation<Record<string, prismicT.CustomTypeModelFieldForGroup>, Record<string, prismicT.CustomTypeModelFieldForGroup>>> = prismicT.SharedSliceModel<string, prismicT.SharedSliceModelVariation<Record<string, prismicT.CustomTypeModelFieldForGroup>, Record<string, prismicT.CustomTypeModelFieldForGroup>>>>(config?: MockSharedSliceValueConfig<Model>) => ModelValue<Model>;
@@ -230,2 +273,2 @@
 
-export { MockBooleanValueConfig, MockColorValueConfig, MockContentRelationshipValueConfig, MockCustomTypeValueConfig, MockDateValueConfig, MockCustomTypeValueConfig as MockDocumentValueConfig, MockEmbedValueConfig, MockGeoPointValueConfig, MockGroupValueConfig, MockImageValueConfig, MockKeyTextValueConfig, MockLinkToMediaValueConfig, MockLinkValueConfig, MockNumberValueConfig, MockRichTextValueConfig, MockSelectValueConfig, MockSharedSliceValueConfig, MockSharedSliceVariationValueConfig, MockSliceValueConfig, MockSliceZoneValueConfig, MockTimestampValueConfig, MockTitleValueConfig, MockUIDValueConfig, boolean, color, contentRelationship, customType, date, customType as document, embed, geoPoint, group, image, keyText, link, linkToMedia, number, richText, select, sharedSlice, sharedSliceVariation, slice, sliceZone, timestamp, title, uid };
+export { MockBooleanValueConfig, MockColorValueConfig, MockContentRelationshipValueConfig, MockCustomTypeValueConfig, MockDateValueConfig, MockCustomTypeValueConfig as MockDocumentValueConfig, MockEmbedValueConfig, MockGeoPointValueConfig, MockGroupValueConfig, MockImageValueConfig, MockIntegrationFieldsValueConfig, MockKeyTextValueConfig, MockLinkToMediaValueConfig, MockLinkValueConfig, MockNumberValueConfig, MockRichTextValueConfig, MockSelectValueConfig, MockSharedSliceValueConfig, MockSharedSliceVariationValueConfig, MockSliceValueConfig, MockSliceZoneValueConfig, MockTimestampValueConfig, MockTitleValueConfig, MockUIDValueConfig, boolean, color, contentRelationship, customType, date, customType as document, embed, geoPoint, group, image, integrationFields, keyText, link, linkToMedia, number, richText, select, sharedSlice, sharedSliceVariation, slice, sliceZone, timestamp, title, uid };

package.json

 {
 	"name": "@prismicio/mock",
-	"version": "0.0.2",
+	"version": "0.0.3",
 	"description": "Generate mock Prismic documents, fields, Slices, and models for development and testing environments",
@@ -67,4 +67,6 @@ "keywords": [
 		"eslint-plugin-prettier": "^3.4.0",
+		"eslint-plugin-tsdoc": "^0.2.14",
 		"nyc": "^15.1.0",
 		"prettier": "^2.3.2",
+		"prettier-plugin-jsdoc": "^0.3.23",
 		"siroc": "^0.15.0",
@@ -71,0 +73,0 @@ "standard-version": "^9.3.1",

README.md

@@ -25,2 +25,4 @@ # @prismicio/mock
 
+> ⚠ Official documentation on the Prismic site is not yet available while the project is developed. Check the integrated [TSDoc](https://tsdoc.org/) for API documentation.
+
 To discover what's new on this package check out [the changelog][changelog]. For full documentation, visit the [official Prismic documentation][prismic-docs].
@@ -27,0 +29,0 @@

src/lib/buildMockGroupFieldMap.ts

@@ -12,2 +12,3 @@ import * as prismicT from "@prismicio/types";
 import { image } from "../model/image";
+import { integrationFields } from "../model/integrationFields";
 import { keyText } from "../model/keyText";
@@ -33,2 +34,3 @@ import { link } from "../model/link";
 	image,
+	integrationFields,
 	keyText,
@@ -35,0 +37,0 @@ link,

src/lib/valueForModel.ts

@@ -131,3 +131,24 @@ import * as prismicT from "@prismicio/types";
 		case prismicT.CustomTypeModelFieldType.StructuredText: {
-			return value.richText({
+			if (
+				"single" in model.config &&
+				model.config.single
+					.split(",")
+					.every((element) => /heading[1-6]/.test(element.trim()))
+			) {
+				return value.title({
+					seed: config.seed,
+					model: model as prismicT.CustomTypeModelTitleField,
+					...config.config,
+				}) as ModelValue<Model>;
+			} else {
+				return value.richText({
+					seed: config.seed,
+					model,
+					...config.config,
+				}) as ModelValue<Model>;
+			}
+		}
+
+		case prismicT.CustomTypeModelFieldType.IntegrationFields: {
+			return value.integrationFields({
 				seed: config.seed,
@@ -139,7 +160,2 @@ model,
 
-		case prismicT.CustomTypeModelFieldType.IntegrationFields: {
-			// TODO: Should this be something else?
-			return {} as ModelValue<Model>;
-		}
-
 		case prismicT.CustomTypeModelFieldType.UID: {
@@ -146,0 +162,0 @@ return value.uid({

src/lib/valueForModelMap.ts

 import * as prismicT from "@prismicio/types";
 
-import { MockValueConfig, ModelValueMap } from "../types";
+import { MockValueConfig, ModelValue, ModelValueMap } from "../types";
+import {
+	MockBooleanValueConfig,
+	MockColorValueConfig,
+	MockContentRelationshipValueConfig,
+	MockDateValueConfig,
+	MockEmbedValueConfig,
+	MockGeoPointValueConfig,
+	MockGroupValueConfig,
+	MockImageValueConfig,
+	MockIntegrationFieldsValueConfig,
+	MockKeyTextValueConfig,
+	MockLinkToMediaValueConfig,
+	MockLinkValueConfig,
+	MockNumberValueConfig,
+	MockRichTextValueConfig,
+	MockSelectValueConfig,
+	MockSliceZoneValueConfig,
+	MockTimestampValueConfig,
+	MockTitleValueConfig,
+	MockUIDValueConfig,
+} from "../value";
 
 import { valueForModel } from "./valueForModel";
 
-type FieldForGroupModelValueMapConfig<
+const getValueConfigType = <Model extends prismicT.CustomTypeModelField>(
+	model: Model,
+): keyof ValueForModelMapConfigs => {
+	switch (model.type) {
+		case prismicT.CustomTypeModelFieldType.Boolean:
+			return "boolean";
+
+		case prismicT.CustomTypeModelFieldType.Color:
+			return "color";
+
+		case prismicT.CustomTypeModelFieldType.Date:
+			return "date";
+
+		case prismicT.CustomTypeModelFieldType.Embed:
+			return "embed";
+
+		case prismicT.CustomTypeModelFieldType.GeoPoint:
+			return "geoPoint";
+
+		case prismicT.CustomTypeModelFieldType.Group:
+			return "group";
+
+		case prismicT.CustomTypeModelFieldType.Image:
+			return "image";
+
+		case prismicT.CustomTypeModelFieldType.Link: {
+			switch (model.config.select) {
+				case prismicT.CustomTypeModelLinkSelectType.Document:
+					return "contentRelationship";
+				case prismicT.CustomTypeModelLinkSelectType.Media:
+					return "linkToMedia";
+				default:
+					return "link";
+			}
+		}
+
+		case prismicT.CustomTypeModelFieldType.Number:
+			return "number";
+
+		case prismicT.CustomTypeModelFieldType.Select:
+			return "select";
+
+		case prismicT.CustomTypeModelFieldType.StructuredText: {
+			if (
+				"single" in model.config &&
+				model.config.single
+					.split(",")
+					.every((element) => /heading{1,6}/.test(element.trim()))
+			) {
+				return "title";
+			} else {
+				return "richText";
+			}
+		}
+
+		case prismicT.CustomTypeModelFieldType.Text:
+			return "keyText";
+
+		case prismicT.CustomTypeModelFieldType.Timestamp:
+			return "timestamp";
+
+		case prismicT.CustomTypeModelFieldType.UID:
+			return "uid";
+
+		case prismicT.CustomTypeModelFieldType.IntegrationFields:
+			return "integrationFields";
+
+		case prismicT.CustomTypeModelFieldType.Slices:
+			return "slices";
+	}
+};
+
+export type ValueForModelMapConfigs = {
+	boolean?: MockBooleanValueConfig;
+	color?: MockColorValueConfig;
+	contentRelationship?: MockContentRelationshipValueConfig;
+	date?: MockDateValueConfig;
+	embed?: MockEmbedValueConfig;
+	geoPoint?: MockGeoPointValueConfig;
+	group?: MockGroupValueConfig;
+	image?: MockImageValueConfig;
+	integrationFields?: MockIntegrationFieldsValueConfig;
+	keyText?: MockKeyTextValueConfig;
+	link?: MockLinkValueConfig;
+	linkToMedia?: MockLinkToMediaValueConfig;
+	number?: MockNumberValueConfig;
+	richText?: MockRichTextValueConfig;
+	select?: MockSelectValueConfig;
+	slices?: MockSliceZoneValueConfig;
+	timestamp?: MockTimestampValueConfig;
+	title?: MockTitleValueConfig;
+	uid?: MockUIDValueConfig;
+};
+
+type ValueForModelMapConfig<
 	ModelMap extends Record<string, prismicT.CustomTypeModelField>,
 > = {
 	map: ModelMap;
+	configs?: ValueForModelMapConfigs;
 } & Omit<MockValueConfig, "model">;
@@ -16,3 +132,3 @@
 >(
-	config: FieldForGroupModelValueMapConfig<ModelMap>,
+	config: ValueForModelMapConfig<ModelMap>,
 ): ModelValueMap<ModelMap> => {
@@ -22,6 +138,11 @@ const result = {} as ModelValueMap<ModelMap>;
 	for (const fieldId in config.map) {
+		const fieldModel = config.map[fieldId];
+		const fieldConfigType = getValueConfigType(fieldModel);
+		const fieldConfig = config.configs?.[fieldConfigType];
+
 		result[fieldId] = valueForModel({
 			seed: config.seed,
-			model: config.map[fieldId],
-		});
+			model: fieldModel as prismicT.CustomTypeModelField,
+			config: fieldConfig,
+		}) as ModelValue<typeof fieldModel>;
 	}
@@ -28,0 +149,0 @@

src/model/customType.ts

 import * as prismicT from "@prismicio/types";
 import * as changeCase from "change-case";
 
-import { buildMockGroupFieldMap } from "../lib/buildMockGroupFieldMap";
+import {
+	buildMockGroupFieldMap,
+	BuildMockGroupFieldMapConfig,
+} from "../lib/buildMockGroupFieldMap";
 import { createFaker } from "../lib/createFaker";
@@ -17,2 +20,3 @@ import { generateCustomTypeId } from "../lib/generateCustomTypeId";
 	withUID?: boolean;
+	configs?: BuildMockGroupFieldMapConfig["configs"];
 } & (
@@ -39,4 +43,7 @@ | {
 	for (let i = 0; i < tabsCount; i++) {
-		const tabName = generateFieldId({ seed: config.seed });
-		const tabFields: prismicT.CustomTypeModelTab = buildMockGroupFieldMap();
+		const tabName = changeCase.capitalCase(faker.company.bsNoun());
+		const tabFields: prismicT.CustomTypeModelTab = buildMockGroupFieldMap({
+			seed: config.seed,
+			configs: config.configs,
+		});
 
@@ -43,0 +50,0 @@ if (i === 0 && config.withUID) {

src/model/index.ts

@@ -10,2 +10,3 @@ export { boolean } from "./boolean";
 export { image } from "./image";
+export { integrationFields } from "./integrationFields";
 export { keyText } from "./keyText";
@@ -12,0 +13,0 @@ export { link } from "./link";

src/types.ts

@@ -171,4 +171,4 @@ import * as prismicT from "@prismicio/types";
 	? prismicT.GeoPointField
-	: T extends prismicT.CustomTypeModelIntegrationField
-	? prismicT.IntegrationField
+	: T extends prismicT.CustomTypeModelIntegrationFieldsField
+	? prismicT.IntegrationFields
 	: never;
@@ -175,0 +175,0 @@

src/value/contentRelationship.ts

 import * as prismicT from "@prismicio/types";
-import * as changeCase from "change-case";
 
 import { createFaker } from "../lib/createFaker";
-import { generateCustomTypeId } from "../lib/generateCustomTypeId";
-import { generateFieldId } from "../lib/generateFieldId";
-import { generateTags } from "../lib/generateTags";
 
@@ -12,11 +8,19 @@ import { MockValueConfig } from "../types";
 import * as modelGen from "../model";
+import { document as documentGen } from "./document";
+import { buildContentRelationshipField } from "../lib/buildContentRelationshipField";
+import { generateCustomTypeId } from "../lib/generateCustomTypeId";
+import { generateTags } from "../lib/generateTags";
 
 export type MockContentRelationshipValueConfig<
-	IsFilled extends boolean = true,
+	IsFilled extends boolean = boolean,
 	Model extends prismicT.CustomTypeModelContentRelationshipField = prismicT.CustomTypeModelContentRelationshipField,
 > = {
 	isFilled?: IsFilled;
+	/**
+	 * A list of potential documents to which the field can be linked.
+	 */
+	linkableDocuments?: prismicT.PrismicDocument[];
 } & MockValueConfig<Model>;
 
-type MockContentRelationshipValue<IsFilled extends boolean = true> =
+type MockContentRelationshipValue<IsFilled extends boolean = boolean> =
 	IsFilled extends true
@@ -40,23 +44,38 @@ ? prismicT.FilledLinkToDocumentField
 
-		const type = model.config.customtypes
-			? faker.random.arrayElement(model.config.customtypes)
-			: generateCustomTypeId({ seed: config.seed });
+		const linkableDocuments = config.linkableDocuments
+			? config.linkableDocuments.filter((document) => {
+					let shouldKeep = true;
 
-		const tags = model.config.tags
-			? faker.random.arrayElements(model.config.tags)
-			: generateTags({ seed: config.seed });
+					if (model.config.customtypes) {
+						shouldKeep =
+							shouldKeep && model.config.customtypes.includes(document.type);
+					}
 
-		return {
-			link_type: prismicT.LinkType.Document,
-			id: faker.git.shortSha(),
-			uid: faker.datatype.boolean()
-				? changeCase.snakeCase(faker.lorem.words(2))
-				: undefined,
-			type,
-			tags,
-			lang: faker.lorem.word(),
-			url: faker.internet.url(),
-			slug: generateFieldId({ seed: config.seed }),
-			isBroken: faker.datatype.boolean(),
-		} as prismicT.FilledLinkToDocumentField;
+					if (model.config.tags) {
+						shouldKeep =
+							shouldKeep &&
+							model.config.tags.some((tag) => document.tags.includes(tag));
+					}
+
+					return shouldKeep;
+			  })
+			: [
+					{
+						...documentGen({ seed: config.seed }),
+						type: model.config.customtypes
+							? faker.random.arrayElement(model.config.customtypes)
+							: generateCustomTypeId({ seed: config.seed }),
+						tags: model.config.tags
+							? faker.random.arrayElements(model.config.tags)
+							: generateTags({ seed: config.seed }),
+					},
+			  ];
+
+		const document = faker.random.arrayElement(linkableDocuments);
+
+		if (!document) {
+			throw new Error("A linkable document could not be found.");
+		}
+
+		return buildContentRelationshipField({ document });
 	} else {
@@ -63,0 +82,0 @@ return {

src/value/customType.ts

@@ -6,3 +6,6 @@ import * as prismicT from "@prismicio/types";
 import { generateTags } from "../lib/generateTags";
-import { valueForModelMap } from "../lib/valueForModelMap";
+import {
+	valueForModelMap,
+	ValueForModelMapConfigs,
+} from "../lib/valueForModelMap";
 
@@ -19,2 +22,3 @@ import { MockValueConfig, ModelValue } from "../types";
 	sharedSliceModels?: prismicT.SharedSliceModel[];
+	configs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
@@ -25,3 +29,3 @@
 >(
-	config: MockCustomTypeValueConfig = {},
+	config: MockCustomTypeValueConfig<Model> = {},
 ): ModelValue<Model> => {
@@ -43,3 +47,3 @@ const faker = createFaker(config.seed);
 		id: faker.git.shortSha(),
-		uid: hasUID ? changeCase.snakeCase(faker.lorem.words(2)) : undefined,
+		uid: hasUID ? changeCase.snakeCase(faker.lorem.words(2)) : null,
 		url: faker.internet.url(),
@@ -49,5 +53,5 @@ href: faker.internet.url(),
 		tags: generateTags({ seed: config.seed }),
-		slugs: [],
-		linked_documents: [],
-		alternate_languages: [],
+		slugs: [] as prismicT.PrismicDocument["slugs"],
+		linked_documents: [] as prismicT.PrismicDocument["linked_documents"],
+		alternate_languages: [] as prismicT.PrismicDocument["alternate_languages"],
 		first_publication_date: timestamp({ seed: config.seed }),
@@ -58,4 +62,5 @@ last_publication_date: timestamp({ seed: config.seed }),
 			map: fieldModelsMap,
+			configs: config.configs,
 		}),
 	} as ModelValue<Model>;
 };

src/value/group.ts

 import * as prismicT from "@prismicio/types";
 
 import { createFaker } from "../lib/createFaker";
-import { valueForModelMap } from "../lib/valueForModelMap";
+import {
+	valueForModelMap,
+	ValueForModelMapConfigs,
+} from "../lib/valueForModelMap";
 
@@ -29,2 +32,3 @@ import { MockValueConfig, ModelValue } from "../types";
 	pattern?: keyof typeof patterns;
+	configs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
@@ -59,4 +63,5 @@
 				map: model.config.fields,
+				configs: config.configs,
 			});
 		}) as ModelValue<Model>;
 };

src/value/index.ts

@@ -31,2 +31,5 @@ export { boolean } from "./boolean";
 
+export { integrationFields } from "./integrationFields";
+export type { MockIntegrationFieldsValueConfig } from "./integrationFields";
+
 export { keyText } from "./keyText";
@@ -33,0 +36,0 @@ export type { MockKeyTextValueConfig } from "./keyText";

src/value/link.ts

@@ -22,2 +22,8 @@ import * as prismicT from "@prismicio/types";
 		: boolean;
+	/**
+	 * A list of potential documents to which the field can be linked.
+	 */
+	linkableDocuments?: LinkType extends prismicT.LinkType.Document
+		? prismicT.PrismicDocument[]
+		: never;
 } & MockValueConfig<Model>;
@@ -63,2 +69,3 @@
 					isFilled,
+					linkableDocuments: config.linkableDocuments,
 				}) as MockLinkValue<LinkType, IsFilled>;
@@ -65,0 +72,0 @@ }

src/value/sharedSlice.ts

@@ -15,3 +15,6 @@ import * as prismicT from "@prismicio/types";
 	Model extends prismicT.SharedSliceModel = prismicT.SharedSliceModel,
-> = Pick<MockSharedSliceVariationValueConfig, "pattern"> &
+> = Pick<
+	MockSharedSliceVariationValueConfig,
+	"pattern" | "primaryFieldConfigs" | "itemsFieldConfigs"
+> &
 	MockValueConfig<Model>;
@@ -34,3 +37,5 @@
 		type: model.id,
+		primaryFieldConfigs: config.primaryFieldConfigs,
+		itemsFieldConfigs: config.itemsFieldConfigs,
 	}) as ModelValue<Model>;
 };

src/value/sharedSliceVariation.ts

@@ -8,3 +8,6 @@ import * as prismicT from "@prismicio/types";
 import { generateFieldId } from "../lib/generateFieldId";
-import { valueForModelMap } from "../lib/valueForModelMap";
+import {
+	valueForModelMap,
+	ValueForModelMapConfigs,
+} from "../lib/valueForModelMap";
 
@@ -38,2 +41,4 @@ import * as modelGen from "../model";
 	pattern?: keyof typeof patterns;
+	primaryFieldConfigs?: ValueForModelMapConfigs;
+	itemsFieldConfigs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
@@ -78,2 +83,3 @@
 			map: model.primary,
+			configs: config.primaryFieldConfigs,
 		}),
@@ -86,2 +92,3 @@ items: Array(itemsCount)
 					map: model.items,
+					configs: config.itemsFieldConfigs,
 				});
@@ -88,0 +95,0 @@ }),

src/value/slice.ts

@@ -8,3 +8,6 @@ import * as prismicT from "@prismicio/types";
 import { generateFieldId } from "../lib/generateFieldId";
-import { valueForModelMap } from "../lib/valueForModelMap";
+import {
+	valueForModelMap,
+	ValueForModelMapConfigs,
+} from "../lib/valueForModelMap";
 
@@ -38,2 +41,4 @@ import * as modelGen from "../model";
 	pattern?: keyof typeof patterns;
+	primaryFieldConfigs?: ValueForModelMapConfigs;
+	itemsFieldConfigs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
@@ -77,2 +82,3 @@
 			map: model["non-repeat"],
+			configs: config.primaryFieldConfigs,
 		}),
@@ -85,2 +91,3 @@ items: Array(itemsCount)
 					map: model.repeat,
+					configs: config.itemsFieldConfigs,
 				});
@@ -87,0 +94,0 @@ }),

src/value/sliceZone.ts

 import * as prismicT from "@prismicio/types";
 
 import { createFaker } from "../lib/createFaker";
+import { ValueForModelMapConfigs } from "../lib/valueForModelMap";
 
@@ -32,2 +33,4 @@ import { MockValueConfig, ModelValue } from "../types";
 	pattern?: keyof typeof patterns;
+	primaryFieldConfigs?: ValueForModelMapConfigs;
+	itemsFieldConfigs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
@@ -72,2 +75,4 @@
 						label: choiceLabel ? choiceLabel.name : null,
+						primaryFieldConfigs: config.primaryFieldConfigs,
+						itemsFieldConfigs: config.itemsFieldConfigs,
 					});
@@ -85,2 +90,4 @@ }
 							model: sharedSliceModel,
+							primaryFieldConfigs: config.primaryFieldConfigs,
+							itemsFieldConfigs: config.itemsFieldConfigs,
 						});
@@ -87,0 +94,0 @@ }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

400687

increased by9.13%

Number of package files

84

increased by3.7%

Lines of code

10492

increased by9.26%

Number of lines in readme file

89

increased by2.3%

Worsened metrics

Dev dependency count

15

increased by15.38%

No dependency changes