@prismicio/mock 0.0.3 → 0.0.7

package/src/value/sliceZone.ts

@@ -10,26 +10,11 @@ import * as modelGen from "../model";
 import { slice } from "./slice";
 import { sharedSlice } from "./sharedSlice";
 
-const patterns = {
-	short: {
-		minItems: 1,
-		maxItems: 3,
-	},
-	medium: {
-		minItems: 3,
-		maxItems: 6,
-	},
-	long: {
-		minItems: 6,
-		maxItems: 12,
-	},
-} as const;
-
 export type MockSliceZoneValueConfig<
 	Model extends prismicT.CustomTypeModelSliceZoneField = prismicT.CustomTypeModelSliceZoneField,
 > = {
 	sharedSliceModels?: prismicT.SharedSliceModel[];
-	pattern?: keyof typeof patterns;
+	itemsCount?: number;
 	primaryFieldConfigs?: ValueForModelMapConfigs;
 	itemsFieldConfigs?: ValueForModelMapConfigs;
 } & MockValueConfig<Model>;
@@ -43,57 +28,56 @@ export const sliceZone = <
 
 	const model = config.model || modelGen.sliceZone({ seed: config.seed });
 
-	const patternKey =
-		config.pattern ||
-		faker.random.arrayElement(
-			Object.keys(patterns) as (keyof typeof patterns)[],
-		);
-	const pattern = patterns[patternKey];
-
-	const itemsCount = faker.datatype.number({
-		min: pattern.minItems,
-		max: pattern.maxItems,
-	});
-
-	return Array(itemsCount)
-		.fill(undefined)
-		.map(() => {
-			const choices = Object.entries(model.config.choices);
-			const [choiceType, choiceModel] = faker.random.arrayElement(choices);
-
-			const choiceLabels = model.config.labels[choiceType] || [];
-			const choiceLabel = faker.random.arrayElement(choiceLabels);
+	if (Object.keys(model.config.choices).length > 0) {
+		const itemsCount =
+			config.itemsCount ??
+			faker.datatype.number({
+				min: 1,
+				max: 6,
+			});
 
-			switch (choiceModel.type) {
-				case prismicT.CustomTypeModelSliceType.Slice: {
-					return slice({
-						seed: config.seed,
-						model: choiceModel,
-						type: choiceType,
-						label: choiceLabel ? choiceLabel.name : null,
-						primaryFieldConfigs: config.primaryFieldConfigs,
-						itemsFieldConfigs: config.itemsFieldConfigs,
-					});
-				}
+		return Array(itemsCount)
+			.fill(undefined)
+			.map(() => {
+				const choices = Object.entries(model.config.choices);
+				const [choiceType, choiceModel] = faker.random.arrayElement(choices);
 
-				case prismicT.CustomTypeModelSliceType.SharedSlice: {
-					const sharedSliceModel = config.sharedSliceModels?.find(
-						(sharedSliceModel) => sharedSliceModel.id === choiceType,
-					);
+				const choiceLabels = model.config.labels[choiceType] || [];
+				const choiceLabel = faker.random.arrayElement(choiceLabels);
 
-					if (sharedSliceModel) {
-						return sharedSlice({
+				switch (choiceModel.type) {
+					case prismicT.CustomTypeModelSliceType.Slice: {
+						return slice({
 							seed: config.seed,
-							model: sharedSliceModel,
+							model: choiceModel,
+							type: choiceType,
+							label: choiceLabel ? choiceLabel.name : null,
 							primaryFieldConfigs: config.primaryFieldConfigs,
 							itemsFieldConfigs: config.itemsFieldConfigs,
 						});
 					}
+
+					case prismicT.CustomTypeModelSliceType.SharedSlice: {
+						const sharedSliceModel = config.sharedSliceModels?.find(
+							(sharedSliceModel) => sharedSliceModel.id === choiceType,
+						);
+
+						if (sharedSliceModel) {
+							return sharedSlice({
+								seed: config.seed,
+								model: sharedSliceModel,
+								primaryFieldConfigs: config.primaryFieldConfigs,
+								itemsFieldConfigs: config.itemsFieldConfigs,
+							});
+						}
+					}
 				}
-			}
-		})
-		.filter(
-			(slice): slice is prismicT.Slice | prismicT.SharedSlice =>
-				slice !== undefined,
-		) as ModelValue<Model>;
+			})
+			.filter(
+				(slice): slice is prismicT.Slice | prismicT.SharedSlice =>
+					slice !== undefined,
+			) as ModelValue<Model>;
+	} else {
+		return [] as unknown as ModelValue<Model>;
+	}
 };

package/src/value/timestamp.ts

@@ -2,18 +2,27 @@ import * as prismicT from "@prismicio/types";
 
 import { createFaker } from "../lib/createFaker";
 
-import { MockValueConfig } from "../types";
+import { MockValueStateConfig, MockValueConfig } from "../types";
 
 export type MockTimestampValueConfig<
 	Model extends prismicT.CustomTypeModelTimestampField = prismicT.CustomTypeModelTimestampField,
+	State extends prismicT.FieldState = prismicT.FieldState,
 > = {
 	after?: Date;
 	before?: Date;
-} & MockValueConfig<Model>;
+} & MockValueConfig<Model> &
+	MockValueStateConfig<State>;
 
-export const timestamp = (
-	config: MockTimestampValueConfig = {},
-): prismicT.TimestampField => {
+export type MockTimestampValue<
+	State extends prismicT.FieldState = prismicT.FieldState,
+> = prismicT.TimestampField<State>;
+
+export const timestamp = <
+	Model extends prismicT.CustomTypeModelTimestampField = prismicT.CustomTypeModelTimestampField,
+	State extends prismicT.FieldState = "filled",
+>(
+	config: MockTimestampValueConfig<Model, State> = {},
+): MockTimestampValue<State> => {
 	const faker = createFaker(config.seed);
 
 	// Faker seems to have problems accepting parameters for `faker.date.between`
@@ -26,5 +35,9 @@ export const timestamp = (
 		config.before ||
 		faker.date.future(20, new Date("2021-03-07")).toISOString().split("T")[0];
 
-	return faker.date.between(after, before).toISOString();
+	return (
+		config.state === "empty"
+			? null
+			: faker.date.between(after, before).toISOString()
+	) as MockTimestampValue<State>;
 };

package/src/value/title.ts

@@ -20,5 +20,5 @@ export const title = (
 			model: config.model,
 			pattern: config.pattern,
 		})!,
-	];
+	] as prismicT.TitleField;
 };

package/src/value/uid.ts

@@ -11,7 +11,7 @@ export type MockUIDValueConfig<
 
 export const uid = (
 	config: MockUIDValueConfig = {},
-): prismicT.PrismicDocument["uid"] => {
+): NonNullable<prismicT.PrismicDocument["uid"]> => {
 	const faker = createFaker(config.seed);
 
 	return changeCase.snakeCase(faker.lorem.words(2));

package/dist/model/index.mjs

@@ -1,448 +0,0 @@
-import * as prismicT from '@prismicio/types';
-import * as changeCase from 'change-case';
-import * as fakerLocaleEN from 'faker/lib/locales/en';
-import Faker from 'faker/lib';
-
-const FAKER_SEED = 1984;
-
-const createFaker = (seed = FAKER_SEED) => {
-  if (createFaker.cache[seed]) {
-    return createFaker.cache[seed];
-  }
-  const seededFaker = new Faker();
-  seededFaker.seed(seed);
-  seededFaker.locales["en"] = fakerLocaleEN;
-  createFaker.cache[seed] = seededFaker;
-  return seededFaker;
-};
-createFaker.cache = {};
-
-const boolean = (config = {}) => {
-  const faker = createFaker(config.seed);
-  return {
-    type: prismicT.CustomTypeModelFieldType.Boolean,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun())
-    }
-  };
-};
-
-const color = (config = {}) => {
-  const faker = createFaker(config.seed);
-  return {
-    type: prismicT.CustomTypeModelFieldType.Color,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun()),
-      placeholder: changeCase.sentenceCase(faker.lorem.words(3))
-    }
-  };
-};
-
-const generateCustomTypeId = (config) => {
-  const faker = createFaker(config.seed);
-  return changeCase.snakeCase(faker.company.bsNoun());
-};
-
-const contentRelationship = (config = {}) => {
-  const faker = createFaker(config.seed);
-  return {
-    type: prismicT.CustomTypeModelFieldType.Link,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun()),
-      placeholder: changeCase.sentenceCase(faker.lorem.words(3)),
-      select: prismicT.CustomTypeModelLinkSelectType.Document,
-      customtypes: config.constrainCustomTypes ? Array(faker.datatype.number({ min: 1, max: 3 })).fill(void 0).map(() => generateCustomTypeId({ seed: config.seed })) : void 0,
-      tags: config.constrainTags ? Array(faker.datatype.number({ min: 1, max: 3 })).fill(void 0).map(() => changeCase.capitalCase(faker.lorem.words(faker.datatype.number({ min: 1, max: 3 })))) : void 0
-    }
-  };
-};
-
-const date = (config = {}) => {
-  const faker = createFaker(config.seed);
-  return {
-    type: prismicT.CustomTypeModelFieldType.Date,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun()),
-      placeholder: changeCase.sentenceCase(faker.lorem.words(3))
-    }
-  };
-};
-
-const embed = (config = {}) => {
-  const faker = createFaker(config.seed);
-  return {
-    type: prismicT.CustomTypeModelFieldType.Embed,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun()),
-      placeholder: changeCase.sentenceCase(faker.lorem.words(3))
-    }
-  };
-};
-
-const geoPoint = (config = {}) => {
-  const faker = createFaker(config.seed);
-  return {
-    type: prismicT.CustomTypeModelFieldType.GeoPoint,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun())
-    }
-  };
-};
-
-const image = (config = {}) => {
-  var _a;
-  const faker = createFaker(config.seed);
-  const thumbnailsCount = (_a = config.thumbnailsCount) != null ? _a : faker.datatype.number(3);
-  return {
-    type: prismicT.CustomTypeModelFieldType.Image,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun()),
-      constraint: {
-        width: config.withConstraint ? faker.datatype.number({ min: 500, max: 2e3 }) : null,
-        height: config.withConstraint ? faker.datatype.number({ min: 500, max: 2e3 }) : null
-      },
-      thumbnails: Array(thumbnailsCount).fill(void 0).map(() => ({
-        name: changeCase.capitalCase(faker.company.bsNoun()),
-        width: faker.datatype.number({ min: 500, max: 2e3 }),
-        height: faker.datatype.number({ min: 500, max: 2e3 })
-      }))
-    }
-  };
-};
-
-const integrationFields = (config = {}) => {
-  const faker = createFaker(config.seed);
-  return {
-    type: prismicT.CustomTypeModelFieldType.IntegrationFields,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun()),
-      catalog: changeCase.snakeCase(faker.lorem.words(4))
-    }
-  };
-};
-
-const keyText = (config = {}) => {
-  const faker = createFaker(config.seed);
-  return {
-    type: prismicT.CustomTypeModelFieldType.Text,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun()),
-      placeholder: changeCase.sentenceCase(faker.lorem.words(3))
-    }
-  };
-};
-
-const link = (config = {}) => {
-  const faker = createFaker(config.seed);
-  return {
-    type: prismicT.CustomTypeModelFieldType.Link,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun()),
-      placeholder: changeCase.sentenceCase(faker.lorem.words(3)),
-      select: null,
-      allowTargetBlank: ("allowTargetBlank" in config ? config.allowTargetBlank : faker.datatype.boolean()) || void 0
-    }
-  };
-};
-
-const linkToMedia = (config = {}) => {
-  const faker = createFaker(config.seed);
-  return {
-    type: prismicT.CustomTypeModelFieldType.Link,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun()),
-      placeholder: changeCase.sentenceCase(faker.lorem.words(3)),
-      select: prismicT.CustomTypeModelLinkSelectType.Media
-    }
-  };
-};
-
-const number = (config = {}) => {
-  const faker = createFaker(config.seed);
-  return {
-    type: prismicT.CustomTypeModelFieldType.Number,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun()),
-      placeholder: changeCase.sentenceCase(faker.lorem.words(3))
-    }
-  };
-};
-
-const richText = (config = {}) => {
-  var _a;
-  const faker = createFaker(config.seed);
-  const blockTypes = faker.random.arrayElements([
-    prismicT.RichTextNodeType.heading1,
-    prismicT.RichTextNodeType.heading2,
-    prismicT.RichTextNodeType.heading3,
-    prismicT.RichTextNodeType.heading4,
-    prismicT.RichTextNodeType.heading5,
-    prismicT.RichTextNodeType.heading6,
-    prismicT.RichTextNodeType.paragraph,
-    prismicT.RichTextNodeType.preformatted,
-    prismicT.RichTextNodeType.strong,
-    prismicT.RichTextNodeType.em,
-    prismicT.RichTextNodeType.listItem,
-    prismicT.RichTextNodeType.oListItem,
-    prismicT.RichTextNodeType.image,
-    prismicT.RichTextNodeType.embed,
-    prismicT.RichTextNodeType.hyperlink
-  ]).join(",");
-  const blockTypeConfig = ((_a = config.withMultipleBlocks) != null ? _a : faker.datatype.boolean()) ? { multi: blockTypes } : { single: blockTypes };
-  return {
-    type: prismicT.CustomTypeModelFieldType.StructuredText,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun()),
-      placeholder: changeCase.sentenceCase(faker.lorem.words(3)),
-      allowTargetBlank: faker.datatype.boolean() ? true : void 0,
-      ...blockTypeConfig
-    }
-  };
-};
-
-const select = (config = {}) => {
-  var _a;
-  const faker = createFaker(config.seed);
-  const optionsCount = (_a = config.optionsCount) != null ? _a : faker.datatype.number({ min: 1, max: 5 });
-  const options = Array(optionsCount).fill(void 0).map(() => changeCase.capitalCase(faker.company.bsBuzz()));
-  return {
-    type: prismicT.CustomTypeModelFieldType.Select,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun()),
-      placeholder: changeCase.sentenceCase(faker.lorem.words(3)),
-      options,
-      default_value: config.withDefaultValue ? faker.random.arrayElement(options) : void 0
-    }
-  };
-};
-
-const timestamp = (config = {}) => {
-  const faker = createFaker(config.seed);
-  return {
-    type: prismicT.CustomTypeModelFieldType.Timestamp,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun()),
-      placeholder: changeCase.sentenceCase(faker.lorem.words(3))
-    }
-  };
-};
-
-const title = (config = {}) => {
-  const faker = createFaker(config.seed);
-  const single = faker.random.arrayElements([
-    "heading1",
-    "heading2",
-    "heading3",
-    "heading4",
-    "heading5",
-    "heading6"
-  ]).join(",");
-  return {
-    type: prismicT.CustomTypeModelFieldType.StructuredText,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun()),
-      placeholder: changeCase.sentenceCase(faker.lorem.words(3)),
-      single,
-      allowTargetBlank: faker.datatype.boolean() ? true : void 0
-    }
-  };
-};
-
-const generateFieldId = (config) => {
-  const faker = createFaker(config.seed);
-  return changeCase.snakeCase(faker.lorem.words(faker.datatype.number({ min: 1, max: 3 })));
-};
-
-const mockModelFns = {
-  boolean,
-  color,
-  contentRelationship,
-  date,
-  embed,
-  geoPoint,
-  image,
-  integrationFields,
-  keyText,
-  link,
-  linkToMedia,
-  number,
-  richText,
-  select,
-  timestamp,
-  title
-};
-const buildMockGroupFieldMap = (config = {}) => {
-  var _a;
-  const faker = createFaker(config.seed);
-  const configs = config.configs || {};
-  const fields = {};
-  for (const mockModelType in mockModelFns) {
-    const mockModelFn = mockModelFns[mockModelType];
-    const mockModelMapConfig = configs[mockModelType] || {};
-    const count = (_a = mockModelMapConfig.count) != null ? _a : faker.random.arrayElement([0, 0, 0, 1]);
-    for (let i = 0; i < count; i++) {
-      const fieldId = generateFieldId({ seed: config.seed });
-      fields[fieldId] = mockModelFn({
-        seed: config.seed,
-        ...mockModelMapConfig.config
-      });
-    }
-  }
-  return fields;
-};
-
-const uid = (config = {}) => {
-  const faker = createFaker(config.seed);
-  return {
-    type: prismicT.CustomTypeModelFieldType.UID,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun()),
-      placeholder: changeCase.sentenceCase(faker.lorem.words(3))
-    }
-  };
-};
-
-const sharedSliceChoice = () => {
-  return {
-    type: prismicT.CustomTypeModelSliceType.SharedSlice
-  };
-};
-
-const slice = (config = {}) => {
-  var _a, _b, _c, _d, _e, _f;
-  const faker = createFaker(config.seed);
-  return {
-    type: prismicT.CustomTypeModelSliceType.Slice,
-    icon: changeCase.snakeCase(faker.company.bsNoun()),
-    display: faker.datatype.boolean() ? prismicT.CustomTypeModelSliceDisplay.Grid : prismicT.CustomTypeModelSliceDisplay.List,
-    fieldset: changeCase.capitalCase(faker.lorem.words()),
-    description: faker.lorem.sentence(),
-    repeat: buildMockGroupFieldMap({
-      seed: (_b = (_a = config.repeatFieldConfig) == null ? void 0 : _a.seed) != null ? _b : config.seed,
-      configs: (_c = config.repeatFieldConfig) == null ? void 0 : _c.configs
-    }),
-    "non-repeat": buildMockGroupFieldMap({
-      seed: (_e = (_d = config.nonRepeatFieldConfig) == null ? void 0 : _d.seed) != null ? _e : config.seed,
-      configs: (_f = config.nonRepeatFieldConfig) == null ? void 0 : _f.configs
-    })
-  };
-};
-
-const sliceZone = (config = {}) => {
-  var _a;
-  const faker = createFaker(config.seed);
-  const choicesCount = (_a = config.choicesCount) != null ? _a : faker.datatype.number({ min: 2, max: 6 });
-  const choices = {};
-  for (let i = 0; i < choicesCount; i++) {
-    const choiceId = generateFieldId({ seed: config.seed });
-    choices[choiceId] = config.withSharedSlices ? sharedSliceChoice() : slice({ seed: config.seed });
-  }
-  const labels = {};
-  if (!config.withSharedSlices) {
-    for (const choiceId in choices) {
-      const labelsCount = faker.datatype.number({ min: 0, max: 3 });
-      labels[choiceId] = Array(labelsCount).fill(void 0).map(() => ({
-        name: changeCase.capitalCase(faker.company.bsNoun()),
-        display: faker.datatype.boolean() ? prismicT.CustomTypeModelSliceDisplay.Grid : prismicT.CustomTypeModelSliceDisplay.List
-      }));
-    }
-  }
-  return {
-    type: prismicT.CustomTypeModelFieldType.Slices,
-    fieldset: "Slice zone",
-    config: {
-      labels,
-      choices
-    }
-  };
-};
-
-const customType = (config = {}) => {
-  var _a;
-  const faker = createFaker(config.seed);
-  const tabsCount = (_a = config.tabsCount) != null ? _a : faker.datatype.number({ min: 1, max: 3 });
-  const json = {};
-  for (let i = 0; i < tabsCount; i++) {
-    const tabName = changeCase.capitalCase(faker.company.bsNoun());
-    const tabFields = buildMockGroupFieldMap({
-      seed: config.seed,
-      configs: config.configs
-    });
-    if (i === 0 && config.withUID) {
-      const fieldId = generateFieldId({ seed: config.seed });
-      tabFields[fieldId] = uid();
-    }
-    if (config.withSliceZones) {
-      const sliceZoneId = generateFieldId({ seed: config.seed });
-      tabFields[sliceZoneId] = sliceZone({
-        withSharedSlices: config.withSharedSlices
-      });
-    }
-    json[tabName] = tabFields;
-  }
-  const id = generateCustomTypeId({ seed: config.seed });
-  return {
-    id,
-    label: changeCase.capitalCase(id),
-    status: faker.datatype.boolean(),
-    repeatable: faker.datatype.boolean(),
-    json
-  };
-};
-
-const group = (config = {}) => {
-  const faker = createFaker(config.seed);
-  const fields = buildMockGroupFieldMap({
-    seed: config.seed,
-    configs: config.configs
-  });
-  return {
-    type: prismicT.CustomTypeModelFieldType.Group,
-    config: {
-      label: changeCase.capitalCase(faker.company.bsNoun()),
-      fields
-    }
-  };
-};
-
-const sharedSliceVariation = (config = {}) => {
-  var _a, _b, _c, _d, _e, _f;
-  const faker = createFaker(config.seed);
-  const name = changeCase.capitalCase(faker.company.bsNoun());
-  return {
-    id: changeCase.snakeCase(name),
-    name,
-    description: faker.lorem.sentence(),
-    docURL: faker.internet.url(),
-    version: faker.git.shortSha(),
-    primary: buildMockGroupFieldMap({
-      seed: (_b = (_a = config.primaryFieldConfig) == null ? void 0 : _a.seed) != null ? _b : config.seed,
-      configs: (_c = config.primaryFieldConfig) == null ? void 0 : _c.configs
-    }),
-    items: buildMockGroupFieldMap({
-      seed: (_e = (_d = config.itemsFieldConfig) == null ? void 0 : _d.seed) != null ? _e : config.seed,
-      configs: (_f = config.itemsFieldConfig) == null ? void 0 : _f.configs
-    })
-  };
-};
-
-const sharedSlice = (config = {}) => {
-  var _a;
-  const faker = createFaker(config.seed);
-  const variationsCount = (_a = config.variationsCount) != null ? _a : faker.datatype.number({ min: 1, max: 3 });
-  const name = changeCase.capitalCase(faker.company.bsNoun());
-  const variations = Array(variationsCount).fill(void 0).map(() => sharedSliceVariation({
-    seed: config.seed,
-    itemsFieldConfig: config.itemsFieldConfig,
-    primaryFieldConfig: config.primaryFieldConfig
-  }));
-  return {
-    type: prismicT.CustomTypeModelSliceType.SharedSlice,
-    id: changeCase.snakeCase(name),
-    name,
-    description: faker.lorem.sentence(),
-    variations
-  };
-};
-
-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 };

package/src/lib/buildImageField.ts

@@ -1,34 +0,0 @@
-import * as prismicT from "@prismicio/types";
-
-import { createFaker } from "../lib/createFaker";
-
-import { MockImageData, MockValueConfig } from "../types";
-
-type BuildImageFieldConfig = {
-	imageData: MockImageData;
-	constraint?: prismicT.CustomTypeModelImageField["config"]["constraint"];
-} & Pick<MockValueConfig, "seed">;
-
-export const buildImageField = (
-	config: BuildImageFieldConfig,
-): prismicT.ImageField => {
-	const faker = createFaker(config.seed);
-
-	const url = new URL(config.imageData.url);
-
-	const dimensions = {
-		width: config.constraint?.width ?? config.imageData.width,
-		height: config.constraint?.height ?? config.imageData.height,
-	};
-
-	url.searchParams.set("w", dimensions.width.toString());
-	url.searchParams.set("h", dimensions.height.toString());
-	url.searchParams.set("fit", "crop");
-
-	return {
-		url: url.toString(),
-		dimensions,
-		alt: faker.lorem.sentence(),
-		copyright: faker.lorem.sentence(),
-	};
-};