@prismicio/mock - npm Package Compare versions

Comparing version 0.3.9 to 0.4.0

dist/lib/buildContentRelationshipField.d.ts

 import * as prismic from "@prismicio/client";
-type BuildEmbedFieldConfig<Document extends prismic.PrismicDocument> = {
+type BuildContentRelationshipFieldConfig<Document extends prismic.PrismicDocument> = {
     document: Document;
 };
-export declare const buildContentRelationshipField: <Document extends prismic.PrismicDocument<Record<string, any>, string, string>>(config: BuildEmbedFieldConfig<Document>) => prismic.ContentRelationshipField<Document["type"], Document["lang"], never, "filled">;
+export declare const buildContentRelationshipField: <Document extends prismic.PrismicDocument<Record<string, any>, string, string>>(config: BuildContentRelationshipFieldConfig<Document>) => prismic.ContentRelationshipField<Document["type"], Document["lang"], never, "filled">;
 export {};

dist/model/createModelMockFactory.d.ts

@@ -52,4 +52,22 @@ import * as prismic from "@prismicio/client";
     keyText(config?: WithoutFakerConfig<MockKeyTextModelConfig>): prismic.CustomTypeModelKeyTextField;
-    link<AllowTargetBlank extends boolean = boolean>(config?: WithoutFakerConfig<MockLinkModelConfig<AllowTargetBlank>>): import("./link").MockLinkModel<AllowTargetBlank>;
-    linkToMedia(config?: WithoutFakerConfig<MockLinkToMediaModelConfig>): prismic.CustomTypeModelLinkToMediaField;
+    link<AllowTargetBlank extends boolean = boolean>(config?: WithoutFakerConfig<MockLinkModelConfig<AllowTargetBlank>>): prismic.CustomTypeModelLinkField & {
+        config: AllowTargetBlank extends true ? {
+            allowTargetBlank: true;
+        } : {
+            allowTargetBlank?: undefined;
+        };
+    } & {
+        config: {
+            allowText: true;
+        } | {
+            allowText?: undefined;
+        };
+    };
+    linkToMedia(config?: WithoutFakerConfig<MockLinkToMediaModelConfig>): prismic.CustomTypeModelLinkToMediaField & {
+        config: {
+            allowText: true;
+        } | {
+            allowText?: undefined;
+        };
+    };
     number(config?: WithoutFakerConfig<MockNumberModelConfig>): prismic.CustomTypeModelNumberField;
@@ -56,0 +74,0 @@ richText<WithMultipleBlocks extends boolean = boolean>(config?: WithoutFakerConfig<MockRichTextModelConfig<WithMultipleBlocks>>): WithMultipleBlocks extends true ? prismic.CustomTypeModelRichTextMultiField : prismic.CustomTypeModelRichTextSingleField;

dist/model/link.d.ts

 import * as prismic from "@prismicio/client";
 import { MockModelConfig } from "../types";
-export type MockLinkModel<AllowTargetBlank extends boolean = boolean> = prismic.CustomTypeModelLinkField & {
+type MockLinkModel<AllowTargetBlank extends boolean = boolean, AllowText extends boolean = boolean> = prismic.CustomTypeModelLinkField & {
     config: AllowTargetBlank extends true ? {
@@ -9,6 +9,14 @@ allowTargetBlank: true;
     };
+} & {
+    config: AllowText extends true ? {
+        allowText: true;
+    } : {
+        allowText?: undefined;
+    };
 };
-export type MockLinkModelConfig<AllowTargetBlank extends boolean = boolean> = {
+export type MockLinkModelConfig<AllowTargetBlank extends boolean = boolean, AllowText extends boolean = boolean> = {
     allowTargetBlank?: AllowTargetBlank;
+    allowText?: AllowText;
 } & MockModelConfig;
-export declare const link: <AllowTargetBlank extends boolean = boolean>(config: MockLinkModelConfig<AllowTargetBlank>) => MockLinkModel<AllowTargetBlank>;
+export declare const link: <AllowTargetBlank extends boolean = boolean, AllowText extends boolean = boolean>(config: MockLinkModelConfig<AllowTargetBlank, AllowText>) => MockLinkModel<AllowTargetBlank, AllowText>;
+export {};

dist/model/link.js

@@ -12,3 +12,4 @@ import * as prismic from "@prismicio/client";
       select: null,
-      allowTargetBlank: ("allowTargetBlank" in config ? config.allowTargetBlank : faker.boolean()) || void 0
+      allowTargetBlank: ("allowTargetBlank" in config ? config.allowTargetBlank : faker.boolean()) || void 0,
+      allowText: ("allowText" in config ? config.allowText : faker.boolean()) || void 0
     }
@@ -15,0 +16,0 @@ };

dist/model/linkToMedia.d.ts

 import * as prismic from "@prismicio/client";
 import { MockModelConfig } from "../types";
-export type MockLinkToMediaModelConfig = MockModelConfig;
-export declare const linkToMedia: (config: MockLinkToMediaModelConfig) => prismic.CustomTypeModelLinkToMediaField;
+type MockLinkToMediaModel<AllowText extends boolean = boolean> = prismic.CustomTypeModelLinkToMediaField & {
+    config: AllowText extends true ? {
+        allowText: true;
+    } : {
+        allowText?: undefined;
+    };
+};
+export type MockLinkToMediaModelConfig<AllowText extends boolean = boolean> = {
+    allowText?: AllowText;
+} & MockModelConfig;
+export declare const linkToMedia: <AllowText extends boolean = boolean>(config: MockLinkToMediaModelConfig<AllowText>) => MockLinkToMediaModel<AllowText>;
+export {};

dist/model/linkToMedia.js

@@ -11,3 +11,4 @@ import * as prismic from "@prismicio/client";
       placeholder: sentenceCase(faker.words(3)),
-      select: prismic.CustomTypeModelLinkSelectType.Media
+      select: prismic.CustomTypeModelLinkSelectType.Media,
+      allowText: ("allowText" in config ? config.allowText : faker.boolean()) || void 0
     }
@@ -14,0 +15,0 @@ };

dist/value/link.d.ts

@@ -6,2 +6,3 @@ import * as prismic from "@prismicio/client";
     withTargetBlank?: NonNullable<Model["config"]>["allowTargetBlank"] extends undefined ? false : boolean;
+    withText?: NonNullable<Model["config"]>["allowText"] extends undefined ? false : boolean;
     /**
@@ -8,0 +9,0 @@ * A list of potential documents to which the field can be linked.

dist/value/link.js

 import * as prismic from "@prismicio/client";
+import { sentenceCase } from './../_node_modules/change-case/dist/index.js';
 import { createFaker } from "../lib/createFaker.js";
@@ -7,3 +8,3 @@ import { contentRelationship } from "./contentRelationship.js";
 const link = (config) => {
-  var _a;
+  var _a, _b;
   const faker = config.faker || createFaker(config.seed);
@@ -31,3 +32,4 @@ const type = config.type || faker.randomElement([
           faker,
-          state: config.state
+          state: config.state,
+          withText: config.withText
         });
@@ -41,3 +43,4 @@ }
           url: faker.url(),
-          target: config.withTargetBlank ?? (((_a = model.config) == null ? void 0 : _a.allowTargetBlank) && faker.boolean()) ? "_blank" : void 0
+          target: config.withTargetBlank ?? (((_a = model.config) == null ? void 0 : _a.allowTargetBlank) && faker.boolean()) ? "_blank" : void 0,
+          text: config.withText ?? (((_b = model.config) == null ? void 0 : _b.allowText) && faker.boolean()) ? sentenceCase(faker.words(2)) : void 0
         };
@@ -44,0 +47,0 @@ }

dist/value/linkToMedia.d.ts

 import * as prismic from "@prismicio/client";
 import { MockValueStateConfig, MockValueConfig } from "../types";
-export type MockLinkToMediaValueConfig<Model extends prismic.CustomTypeModelLinkToMediaField = prismic.CustomTypeModelLinkToMediaField, State extends prismic.FieldState = prismic.FieldState> = MockValueConfig<Model> & MockValueStateConfig<State>;
+export type MockLinkToMediaValueConfig<Model extends prismic.CustomTypeModelLinkToMediaField = prismic.CustomTypeModelLinkToMediaField, State extends prismic.FieldState = prismic.FieldState> = {
+    withText?: NonNullable<Model["config"]>["allowText"] extends undefined ? false : boolean;
+} & MockValueConfig<Model> & MockValueStateConfig<State>;
 type MockLinkToMediaValue<State extends prismic.FieldState = prismic.FieldState> = prismic.LinkToMediaField<State>;
 export declare const linkToMedia: <Model extends prismic.CustomTypeModelLinkToMediaField = prismic.CustomTypeModelLinkToMediaField, State extends prismic.FieldState = "filled">(config: MockLinkToMediaValueConfig<Model, State>) => MockLinkToMediaValue<State>;
 export {};

dist/value/linkToMedia.js

 import * as prismic from "@prismicio/client";
-import { snakeCase } from './../_node_modules/change-case/dist/index.js';
+import { snakeCase, sentenceCase } from './../_node_modules/change-case/dist/index.js';
 import { createFaker } from "../lib/createFaker.js";
+import { link } from "../model/link.js";
 const linkToMedia = (config) => {
+  var _a;
   const faker = config.faker || createFaker(config.seed);
@@ -11,2 +13,3 @@ if (config.state === "empty") {
   } else {
+    const model = config.model || link({ faker });
     return {
@@ -20,3 +23,4 @@ link_type: prismic.LinkType.Media,
       height: faker.range(500, 3e3).toString(),
-      width: faker.range(500, 3e3).toString()
+      width: faker.range(500, 3e3).toString(),
+      text: config.withText ?? (((_a = model.config) == null ? void 0 : _a.allowText) && faker.boolean()) ? sentenceCase(faker.words(2)) : void 0
     };
@@ -23,0 +27,0 @@ }

package.json

 {
 	"name": "@prismicio/mock",
-	"version": "0.3.9",
+	"version": "0.4.0",
 	"description": "Generate mock Prismic documents, fields, Slices, and models for development and testing environments",
@@ -58,3 +58,4 @@ "keywords": [
 		"types": "tsc --noEmit",
-		"unit": "nyc --reporter=lcovonly --reporter=text --exclude-after-remap=false ava"
+		"unit": "nyc --reporter=lcovonly --reporter=text --exclude-after-remap=false ava",
+		"unit:watch": "npm run unit -- --watch"
 	},
@@ -65,3 +66,3 @@ "dependencies": {
 	"devDependencies": {
-		"@prismicio/client": "^7.8.1",
+		"@prismicio/client": "7.11.0",
 		"@size-limit/preset-small-lib": "^11.1.2",
@@ -68,0 +69,0 @@ "@types/node": "^20.12.7",

src/lib/buildContentRelationshipField.ts

 import * as prismic from "@prismicio/client";
 
-type BuildEmbedFieldConfig<Document extends prismic.PrismicDocument> = {
+type BuildContentRelationshipFieldConfig<
+	Document extends prismic.PrismicDocument,
+> = {
 	document: Document;
@@ -10,3 +12,3 @@ };
 >(
-	config: BuildEmbedFieldConfig<Document>,
+	config: BuildContentRelationshipFieldConfig<Document>,
 ): prismic.ContentRelationshipField<
@@ -13,0 +15,0 @@ Document["type"],

src/model/link.ts

@@ -8,20 +8,29 @@ import * as prismic from "@prismicio/client";
 
-export type MockLinkModel<AllowTargetBlank extends boolean = boolean> =
-	prismic.CustomTypeModelLinkField & {
-		config: AllowTargetBlank extends true
-			? {
-					allowTargetBlank: true;
-				}
-			: {
-					allowTargetBlank?: undefined;
-				};
-	};
+type MockLinkModel<
+	AllowTargetBlank extends boolean = boolean,
+	AllowText extends boolean = boolean,
+> = prismic.CustomTypeModelLinkField & {
+	config: AllowTargetBlank extends true
+		? { allowTargetBlank: true }
+		: { allowTargetBlank?: undefined };
+} & {
+	config: AllowText extends true
+		? { allowText: true }
+		: { allowText?: undefined };
+};
 
-export type MockLinkModelConfig<AllowTargetBlank extends boolean = boolean> = {
+export type MockLinkModelConfig<
+	AllowTargetBlank extends boolean = boolean,
+	AllowText extends boolean = boolean,
+> = {
 	allowTargetBlank?: AllowTargetBlank;
+	allowText?: AllowText;
 } & MockModelConfig;
 
-export const link = <AllowTargetBlank extends boolean = boolean>(
-	config: MockLinkModelConfig<AllowTargetBlank>,
-): MockLinkModel<AllowTargetBlank> => {
+export const link = <
+	AllowTargetBlank extends boolean = boolean,
+	AllowText extends boolean = boolean,
+>(
+	config: MockLinkModelConfig<AllowTargetBlank, AllowText>,
+): MockLinkModel<AllowTargetBlank, AllowText> => {
 	const faker = config.faker || createFaker(config.seed);
@@ -39,4 +48,7 @@
 					: faker.boolean()) || undefined,
+			allowText:
+				("allowText" in config ? config.allowText : faker.boolean()) ||
+				undefined,
 		},
-	} as MockLinkModel<AllowTargetBlank>;
+	} as MockLinkModel<AllowTargetBlank, AllowText>;
 };

src/model/linkToMedia.ts

@@ -8,7 +8,16 @@ import * as prismic from "@prismicio/client";
 
-export type MockLinkToMediaModelConfig = MockModelConfig;
+type MockLinkToMediaModel<AllowText extends boolean = boolean> =
+	prismic.CustomTypeModelLinkToMediaField & {
+		config: AllowText extends true
+			? { allowText: true }
+			: { allowText?: undefined };
+	};
 
-export const linkToMedia = (
-	config: MockLinkToMediaModelConfig,
-): prismic.CustomTypeModelLinkToMediaField => {
+export type MockLinkToMediaModelConfig<AllowText extends boolean = boolean> = {
+	allowText?: AllowText;
+} & MockModelConfig;
+
+export const linkToMedia = <AllowText extends boolean = boolean>(
+	config: MockLinkToMediaModelConfig<AllowText>,
+): MockLinkToMediaModel<AllowText> => {
 	const faker = config.faker || createFaker(config.seed);
@@ -22,4 +31,7 @@
 			select: prismic.CustomTypeModelLinkSelectType.Media,
+			allowText:
+				("allowText" in config ? config.allowText : faker.boolean()) ||
+				undefined,
 		},
-	};
+	} as MockLinkToMediaModel<AllowText>;
 };

src/value/link.ts

 import * as prismic from "@prismicio/client";
+import * as changeCase from "change-case";
 
@@ -25,2 +26,5 @@ import { createFaker } from "../lib/createFaker";
 		: boolean;
+	withText?: NonNullable<Model["config"]>["allowText"] extends undefined
+		? false
+		: boolean;
 	/**
@@ -86,2 +90,3 @@ * A list of potential documents to which the field can be linked.
 					state: config.state,
+					withText: config.withText,
 				}) as MockLinkValue<LinkType, State>;
@@ -102,2 +107,6 @@ }
 							: undefined,
+					text:
+						config.withText ?? (model.config?.allowText && faker.boolean())
+							? changeCase.sentenceCase(faker.words(2))
+							: undefined,
 				} as MockLinkValue<LinkType, State>;
@@ -104,0 +113,0 @@ }

src/value/linkToMedia.ts

@@ -8,2 +8,4 @@ import * as prismic from "@prismicio/client";
 
+import * as modelGen from "../model";
+
 export type MockLinkToMediaValueConfig<
@@ -13,3 +15,8 @@ Model extends
 	State extends prismic.FieldState = prismic.FieldState,
-> = MockValueConfig<Model> & MockValueStateConfig<State>;
+> = {
+	withText?: NonNullable<Model["config"]>["allowText"] extends undefined
+		? false
+		: boolean;
+} & MockValueConfig<Model> &
+	MockValueStateConfig<State>;
 
@@ -34,2 +41,4 @@ type MockLinkToMediaValue<
 	} else {
+		const model = config.model || modelGen.link({ faker });
+
 		return {
@@ -44,4 +53,8 @@ link_type: prismic.LinkType.Media,
 			width: faker.range(500, 3000).toString(),
+			text:
+				config.withText ?? (model.config?.allowText && faker.boolean())
+					? changeCase.sentenceCase(faker.words(2))
+					: undefined,
 		} as MockLinkToMediaValue<State>;
 	}
 };

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

Unstable ownership

Supply chain risk

A new collaborator has begun publishing package versions. Package stability and security risk may be elevated.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

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

887259

increased by0.94%

Lines of code

11504

increased by0.9%

Worsened metrics

Number of high supply chain risk alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes