@prismicio/mock 0.1.1 → 0.3.0

package/dist/value/uid.js

@@ -0,0 +1,10 @@
+import * as changeCase from "change-case";
+import { createFaker } from "../lib/createFaker.js";
+const uid = (config) => {
+  const faker = config.faker || createFaker(config.seed);
+  return changeCase.snakeCase(faker.words(faker.range(1, 3)));
+};
+export {
+  uid
+};
+//# sourceMappingURL=uid.js.map

package/dist/value/uid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uid.js","sources":["../../../src/value/uid.ts"],"sourcesContent":["import * as prismic from \"@prismicio/client\";\nimport * as changeCase from \"change-case\";\n\nimport { createFaker } from \"../lib/createFaker\";\n\nimport { MockValueConfig } from \"../types\";\n\nexport type MockUIDValueConfig<\n\tModel extends prismic.CustomTypeModelUIDField = prismic.CustomTypeModelUIDField,\n> = MockValueConfig<Model>;\n\nexport const uid = <\n\tModel extends prismic.CustomTypeModelUIDField = prismic.CustomTypeModelUIDField,\n>(\n\tconfig: MockUIDValueConfig<Model>,\n): NonNullable<prismic.PrismicDocument[\"uid\"]> => {\n\tconst faker = config.faker || createFaker(config.seed);\n\n\treturn changeCase.snakeCase(faker.words(faker.range(1, 3)));\n};\n"],"names":[],"mappings":";;AAWa,MAAA,MAAM,CAGlB,WACgD;AAChD,QAAM,QAAQ,OAAO,SAAS,YAAY,OAAO,IAAI;AAE9C,SAAA,WAAW,UAAU,MAAM,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,CAAC;AAC3D;"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/mock",
-	"version": "0.1.1",
+	"version": "0.3.0",
 	"description": "Generate mock Prismic documents, fields, Slices, and models for development and testing environments",
 	"keywords": [
 		"typescript",
@@ -43,8 +43,8 @@
 		"src"
 	],
 	"scripts": {
-		"build": "siroc build",
-		"dev": "siroc build --watch",
+		"build": "vite build",
+		"dev": "vite build --watch",
 		"format": "prettier --write .",
 		"lint": "eslint --ext .js,.ts .",
 		"prepare": "npm run build",
@@ -57,28 +57,31 @@
 		"unit": "nyc --reporter=lcovonly --reporter=text --exclude-after-remap=false ava"
 	},
 	"dependencies": {
-		"@prismicio/types": "^0.2.0",
-		"change-case": "^4.1.2",
-		"rand-seed": "^1.0.1"
+		"change-case": "^4.1.2"
 	},
 	"devDependencies": {
-		"@size-limit/preset-small-lib": "^7.0.8",
-		"@typescript-eslint/eslint-plugin": "^5.30.5",
-		"@typescript-eslint/parser": "^5.30.5",
-		"ava": "^4.3.0",
-		"esbuild": "^0.14.48",
-		"esbuild-register": "^3.3.3",
-		"eslint": "^8.19.0",
-		"eslint-config-prettier": "^8.5.0",
+		"@prismicio/client": "^7.0.1",
+		"@size-limit/preset-small-lib": "^8.2.4",
+		"@typescript-eslint/eslint-plugin": "^5.59.8",
+		"@typescript-eslint/parser": "^5.59.8",
+		"ava": "^5.3.0",
+		"esbuild": "^0.17.19",
+		"esbuild-register": "^3.4.2",
+		"eslint": "^8.41.0",
+		"eslint-config-prettier": "^8.8.0",
 		"eslint-plugin-prettier": "^4.2.1",
-		"eslint-plugin-tsdoc": "^0.2.16",
+		"eslint-plugin-tsdoc": "^0.2.17",
 		"nyc": "^15.1.0",
-		"prettier": "^2.7.1",
-		"prettier-plugin-jsdoc": "^0.3.38",
-		"siroc": "^0.16.0",
-		"size-limit": "^7.0.8",
+		"prettier": "^2.8.8",
+		"prettier-plugin-jsdoc": "^0.4.2",
+		"size-limit": "^8.2.4",
 		"standard-version": "^9.5.0",
-		"typescript": "^4.7.4"
+		"typescript": "^5.0.4",
+		"vite": "^4.3.9",
+		"vite-plugin-sdk": "^0.1.1"
+	},
+	"peerDependencies": {
+		"@prismicio/client": "^7"
 	},
 	"engines": {
 		"node": ">=12.7.0"

package/src/api/createAPIMockFactory.ts

@@ -1,4 +1,4 @@
-import * as prismicT from "@prismicio/types";
+import * as prismic from "@prismicio/client";
 
 import { createFaker, Faker } from "../lib/createFaker";
 
@@ -34,7 +34,7 @@ export class APIMockFactory {
 		return this.faker.seed;
 	}
 
-	query<Document extends prismicT.PrismicDocument = prismicT.PrismicDocument>(
+	query<Document extends prismic.PrismicDocument = prismic.PrismicDocument>(
 		config?: WithoutFakerConfig<MockRestApiQueryConfig<Document>>,
 	) {
 		return query({ ...config, faker: this.faker });

package/src/api/query.ts

@@ -1,11 +1,11 @@
-import * as prismicT from "@prismicio/types";
+import * as prismic from "@prismicio/client";
 
 import { createFaker } from "../lib/createFaker";
 
 import { MockRestApiConfig } from "../types";
 
 export type MockRestApiQueryConfig<
-	Document extends prismicT.PrismicDocument = prismicT.PrismicDocument,
+	Document extends prismic.PrismicDocument = prismic.PrismicDocument,
 > = {
 	documents?: Document[];
 	page?: number;
@@ -13,10 +13,10 @@ export type MockRestApiQueryConfig<
 } & MockRestApiConfig;
 
 export const query = <
-	Document extends prismicT.PrismicDocument = prismicT.PrismicDocument,
+	Document extends prismic.PrismicDocument = prismic.PrismicDocument,
 >(
 	config: MockRestApiQueryConfig<Document>,
-): prismicT.Query<Document> => {
+): prismic.Query<Document> => {
 	const faker = config.faker || createFaker(config.seed);
 
 	const documents = config.documents || [];

package/src/api/ref.ts

@@ -1,4 +1,4 @@
-import * as prismicT from "@prismicio/types";
+import * as prismic from "@prismicio/client";
 import * as changeCase from "change-case";
 
 import { createFaker } from "../lib/createFaker";
@@ -11,7 +11,7 @@ export type MockRestApiRefConfig<IsScheduled extends boolean = false> = {
 } & MockRestApiConfig;
 
 export type MockRestApiRefValue<IsScheduled extends boolean = false> = Omit<
-	prismicT.Ref,
+	prismic.Ref,
 	"scheduledAt"
 > &
 	(IsScheduled extends true
@@ -23,7 +23,7 @@ export const ref = <IsScheduled extends boolean = false>(
 ): MockRestApiRefValue<IsScheduled> => {
 	const faker = config.faker || createFaker(config.seed);
 
-	const value: prismicT.Ref = {
+	const value: prismic.Ref = {
 		id: faker.hash(16),
 		ref: faker.hash(16),
 		isMasterRef: config.isMasterRef ?? false,

package/src/api/repository.ts

@@ -1,4 +1,4 @@
-import * as prismicT from "@prismicio/types";
+import * as prismic from "@prismicio/client";
 import * as changeCase from "change-case";
 
 import { createFaker } from "../lib/createFaker";
@@ -8,20 +8,20 @@ import { MockRestApiConfig } from "../types";
 import { ref } from "./ref";
 
 export type MockRestApiRepositoryConfig = {
-	customTypeModels?: prismicT.CustomTypeModel[];
+	customTypeModels?: prismic.CustomTypeModel[];
 	withReleases?: boolean;
 } & MockRestApiConfig;
 
 export const repository = (
 	config: MockRestApiRepositoryConfig,
-): prismicT.Repository => {
+): prismic.Repository => {
 	const faker = config.faker || createFaker(config.seed);
 
 	const types = (config.customTypeModels || []).reduce((acc, model) => {
 		acc[model.id] = model.label || model.id;
 
 		return acc;
-	}, {} as prismicT.Repository["types"]);
+	}, {} as prismic.Repository["types"]);
 
 	return {
 		refs: [

package/src/api/tags.ts

@@ -1,4 +1,4 @@
-import * as prismicT from "@prismicio/types";
+import * as prismic from "@prismicio/client";
 
 import { createFaker } from "../lib/createFaker";
 import { generateTags } from "../lib/generateTags";
@@ -7,7 +7,7 @@ import { MockRestApiConfig } from "../types";
 
 export type MockRestApiTagsConfig = MockRestApiConfig;
 
-export const tags = (config: MockRestApiTagsConfig): prismicT.Tags => {
+export const tags = (config: MockRestApiTagsConfig): prismic.Tags => {
 	const faker = config.faker || createFaker(config.seed);
 
 	return generateTags({

package/src/lib/PRNG.ts

@@ -0,0 +1,88 @@
+/**
+ * The following code is a modified version of Prando from `zeh/prando` on
+ * GitHub.
+ *
+ * Source:
+ * https://github.com/zeh/prando/blob/acc2a3c09df12a41b5c82fbf44e49e070e6f60ac/src/Prando.ts
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016 Zeh Fernando
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+const MIN = -2147483648; // Int32 min
+const MAX = 2147483647; // Int32 max
+
+const xorshift = (value: number): number => {
+	// Xorshift*32
+	// Based on George Marsaglia's work: http://www.jstatsoft.org/v08/i14/paper
+	value ^= value << 13;
+	value ^= value >> 17;
+	value ^= value << 5;
+
+	return value;
+};
+
+/**
+ * Pseudorandom number generator.
+ */
+export class PRNG {
+	private _value: number;
+
+	/**
+	 * Generate a new pseudo-random number generator.
+	 *
+	 * @param seed - A number or string seed that determines which pseudo-random
+	 *   number sequence will be created.
+	 */
+	constructor(seed: number | string) {
+		if (typeof seed === "string") {
+			let hash = 0;
+			if (seed) {
+				const l = seed.length;
+				for (let i = 0; i < l; i++) {
+					hash = (hash << 5) - hash + seed.charCodeAt(i);
+					hash |= 0;
+					hash = xorshift(hash);
+				}
+			}
+
+			this._value = hash;
+		} else {
+			this._value = seed;
+		}
+
+		if (this._value === 0) {
+			this._value = 1;
+		}
+	}
+
+	/**
+	 * Generates a pseudo-random number.
+	 *
+	 * @returns The generated pseudo-random number.
+	 */
+	public next(): number {
+		this._value = xorshift(this._value);
+
+		return (this._value - MIN) / (MAX - MIN);
+	}
+}

package/src/lib/buildAlternativeLanguage.ts

@@ -1,14 +1,14 @@
-import * as prismicT from "@prismicio/types";
+import * as prismic from "@prismicio/client";
 
-type BuildEmbedFieldConfig<Document extends prismicT.PrismicDocument> = {
+type BuildEmbedFieldConfig<Document extends prismic.PrismicDocument> = {
 	document: Document;
 };
 
 export const buildAlternativeLanguage = <
-	Document extends prismicT.PrismicDocument,
+	Document extends prismic.PrismicDocument,
 >(
 	config: BuildEmbedFieldConfig<Document>,
-): prismicT.AlternateLanguage<Document["type"], Document["lang"]> => {
+): prismic.AlternateLanguage<Document["type"], Document["lang"]> => {
 	return {
 		id: config.document.id,
 		type: config.document.type,

package/src/lib/buildContentRelationshipField.ts

@@ -1,21 +1,21 @@
-import * as prismicT from "@prismicio/types";
+import * as prismic from "@prismicio/client";
 
-type BuildEmbedFieldConfig<Document extends prismicT.PrismicDocument> = {
+type BuildEmbedFieldConfig<Document extends prismic.PrismicDocument> = {
 	document: Document;
 };
 
 export const buildContentRelationshipField = <
-	Document extends prismicT.PrismicDocument,
+	Document extends prismic.PrismicDocument,
 >(
 	config: BuildEmbedFieldConfig<Document>,
-): prismicT.RelationField<
+): prismic.ContentRelationshipField<
 	Document["type"],
 	Document["lang"],
 	never,
 	"filled"
 > => {
 	return {
-		link_type: prismicT.LinkType.Document,
+		link_type: prismic.LinkType.Document,
 		id: config.document.id,
 		uid: config.document.uid || undefined,
 		type: config.document.type,

package/src/lib/buildEmbedField.ts

@@ -1,36 +1,35 @@
-import * as prismicT from "@prismicio/types";
+import * as prismic from "@prismicio/client";
 
 import { createFaker, Faker } from "../lib/createFaker";
 
 import { Seed } from "../types";
 
-type BuildEmbedFieldConfig<
-	Data extends prismicT.AnyOEmbed = prismicT.AnyOEmbed,
-> = {
-	url?: string;
-	html?: string;
-	data: Data;
-} & (
-	| {
-			seed: Seed;
-			faker?: never;
-	  }
-	| {
-			faker: Faker;
-			seed?: never;
-	  }
-);
+type BuildEmbedFieldConfig<Data extends prismic.AnyOEmbed = prismic.AnyOEmbed> =
+	{
+		url?: string;
+		html?: string;
+		data: Data;
+	} & (
+		| {
+				seed: Seed;
+				faker?: never;
+		  }
+		| {
+				faker: Faker;
+				seed?: never;
+		  }
+	);
 
 export const buildEmbedField = <
-	Data extends prismicT.AnyOEmbed = prismicT.AnyOEmbed,
+	Data extends prismic.AnyOEmbed = prismic.AnyOEmbed,
 >(
 	config: BuildEmbedFieldConfig<Data>,
-): prismicT.EmbedField<Data, "filled"> => {
+): prismic.EmbedField<Data, "filled"> => {
 	const faker = config.faker || createFaker(config.seed);
 
 	return {
 		embed_url: config.url ?? faker.url(),
 		html: `<div>embed html</div>`,
 		...config.data,
-	} as prismicT.EmbedField<Data, "filled">;
+	} as prismic.EmbedField<Data, "filled">;
 };

package/src/lib/buildImageFieldImage.ts

@@ -1,4 +1,4 @@
-import * as prismicT from "@prismicio/types";
+import * as prismic from "@prismicio/client";
 import * as changeCase from "change-case";
 
 import { createFaker, Faker } from "../lib/createFaker";
@@ -6,11 +6,11 @@ import { createFaker, Faker } from "../lib/createFaker";
 import { MockValueStateConfig, MockImageData, Seed } from "../types";
 
 type BuildImageFieldConfig<
-	State extends prismicT.FieldState = prismicT.FieldState,
+	State extends prismic.FieldState = prismic.FieldState,
 > = {
 	imageData: MockImageData;
 	constraint?: NonNullable<
-		prismicT.CustomTypeModelImageField["config"]
+		prismic.CustomTypeModelImageField["config"]
 	>["constraint"];
 } & (
 	| {
@@ -25,17 +25,17 @@ type BuildImageFieldConfig<
 	Pick<MockValueStateConfig<State>, "state">;
 
 export const buildImageFieldImage = <
-	State extends prismicT.FieldState = prismicT.FieldState,
+	State extends prismic.FieldState = prismic.FieldState,
 >(
 	config: BuildImageFieldConfig<State>,
-): prismicT.ImageFieldImage<State> => {
+): prismic.ImageFieldImage<State> => {
 	if (config.state === "empty") {
 		return {
 			url: null,
 			dimensions: null,
 			alt: null,
 			copyright: null,
-		} as prismicT.ImageFieldImage<State>;
+		} as prismic.ImageFieldImage<State>;
 	} else {
 		const faker = config.faker || createFaker(config.seed);
 
@@ -55,6 +55,6 @@ export const buildImageFieldImage = <
 			dimensions,
 			alt: changeCase.sentenceCase(faker.words(faker.range(5, 15))),
 			copyright: changeCase.sentenceCase(faker.words(faker.range(5, 15))),
-		} as prismicT.ImageFieldImage<State>;
+		} as prismic.ImageFieldImage<State>;
 	}
 };

package/src/lib/createFaker.ts

@@ -1,8 +1,7 @@
-import Rand from "rand-seed";
-
 import { Seed } from "../types";
 
 import { lorem, loremWords } from "./lorem";
+import { PRNG } from "./PRNG";
 
 export const createFaker = (seed: Seed): Faker => {
 	return new Faker(seed);
@@ -15,20 +14,20 @@ const YEAR_2022_MS = 52 * (YEAR_MS + DAY_MS / 4);
 export class Faker {
 	seed: Seed;
 
-	private rand: Rand;
+	private prng: PRNG;
 
 	constructor(seed: Seed) {
 		this.seed = seed;
 
-		this.rand = new Rand(seed.toString());
+		this.prng = new PRNG(seed.toString());
 	}
 
-	boolean(): boolean {
-		return this.random() >= 0.5;
+	random(): number {
+		return this.prng.next();
 	}
 
-	random(): number {
-		return this.rand.next();
+	boolean(): boolean {
+		return this.random() >= 0.5;
 	}
 
 	randomElement<T>(elements: readonly T[]): T {

package/src/lib/lorem.ts

@@ -88,8 +88,7 @@ export const lorem = (length: `${number}w` | `${number}c`, wordOffset = 0) => {
 			) {
 				sentence += wordsString.substring(startSpaceIndex + 1) + " ";
 
-				const wraparoundCounts =
-					Math.floor(count / lorem.spaceIndices.length) - 1;
+				const wraparoundCounts = Math.floor(count / lorem.spaceIndices.length);
 				for (let i = 0; i < wraparoundCounts; i++) {
 					sentence += wordsString + " ";
 				}