@prismicio/mock - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

dist/index.d.ts

@@ -29,2 +29,3 @@ import * as prismicT from '@prismicio/types';
 declare type MockCustomTypeValueConfig<Model extends prismicT.CustomTypeModel = prismicT.CustomTypeModel> = {
+    withURL?: boolean;
     sharedSliceModels?: prismicT.SharedSliceModel[];
@@ -242,74 +243,74 @@ configs?: ValueForModelMapConfigs;
 
-type index$1_MockBooleanValueConfig<_0> = MockBooleanValueConfig<_0>;
-type index$1_MockCustomTypeValueConfig<_0> = MockCustomTypeValueConfig<_0>;
-type index$1_MockColorValueConfig<_0> = MockColorValueConfig<_0>;
-type index$1_MockContentRelationshipValueConfig<_0, _1> = MockContentRelationshipValueConfig<_0, _1>;
-type index$1_MockDateValueConfig<_0> = MockDateValueConfig<_0>;
-type index$1_MockEmbedValueConfig<_0> = MockEmbedValueConfig<_0>;
-type index$1_MockGeoPointValueConfig<_0> = MockGeoPointValueConfig<_0>;
-type index$1_MockGroupValueConfig<_0> = MockGroupValueConfig<_0>;
-type index$1_MockImageValueConfig<_0> = MockImageValueConfig<_0>;
-type index$1_MockIntegrationFieldsValueConfig<_0, _1> = MockIntegrationFieldsValueConfig<_0, _1>;
-type index$1_MockKeyTextValueConfig<_0> = MockKeyTextValueConfig<_0>;
-type index$1_MockLinkValueConfig<_0, _1, _2> = MockLinkValueConfig<_0, _1, _2>;
-type index$1_MockLinkToMediaValueConfig<_0, _1> = MockLinkToMediaValueConfig<_0, _1>;
-type index$1_MockNumberValueConfig<_0> = MockNumberValueConfig<_0>;
-type index$1_MockSelectValueConfig<_0> = MockSelectValueConfig<_0>;
-type index$1_MockSliceValueConfig<_0> = MockSliceValueConfig<_0>;
-type index$1_MockSliceZoneValueConfig<_0> = MockSliceZoneValueConfig<_0>;
-type index$1_MockSharedSliceValueConfig<_0> = MockSharedSliceValueConfig<_0>;
-type index$1_MockSharedSliceVariationValueConfig<_0> = MockSharedSliceVariationValueConfig<_0>;
-type index$1_MockTimestampValueConfig<_0> = MockTimestampValueConfig<_0>;
-type index$1_MockTitleValueConfig<_0> = MockTitleValueConfig<_0>;
-type index$1_MockUIDValueConfig<_0> = MockUIDValueConfig<_0>;
-declare namespace index$1 {
+type index$2_MockBooleanValueConfig<_0> = MockBooleanValueConfig<_0>;
+type index$2_MockCustomTypeValueConfig<_0> = MockCustomTypeValueConfig<_0>;
+type index$2_MockColorValueConfig<_0> = MockColorValueConfig<_0>;
+type index$2_MockContentRelationshipValueConfig<_0, _1> = MockContentRelationshipValueConfig<_0, _1>;
+type index$2_MockDateValueConfig<_0> = MockDateValueConfig<_0>;
+type index$2_MockEmbedValueConfig<_0> = MockEmbedValueConfig<_0>;
+type index$2_MockGeoPointValueConfig<_0> = MockGeoPointValueConfig<_0>;
+type index$2_MockGroupValueConfig<_0> = MockGroupValueConfig<_0>;
+type index$2_MockImageValueConfig<_0> = MockImageValueConfig<_0>;
+type index$2_MockIntegrationFieldsValueConfig<_0, _1> = MockIntegrationFieldsValueConfig<_0, _1>;
+type index$2_MockKeyTextValueConfig<_0> = MockKeyTextValueConfig<_0>;
+type index$2_MockLinkValueConfig<_0, _1, _2> = MockLinkValueConfig<_0, _1, _2>;
+type index$2_MockLinkToMediaValueConfig<_0, _1> = MockLinkToMediaValueConfig<_0, _1>;
+type index$2_MockNumberValueConfig<_0> = MockNumberValueConfig<_0>;
+type index$2_MockSelectValueConfig<_0> = MockSelectValueConfig<_0>;
+type index$2_MockSliceValueConfig<_0> = MockSliceValueConfig<_0>;
+type index$2_MockSliceZoneValueConfig<_0> = MockSliceZoneValueConfig<_0>;
+type index$2_MockSharedSliceValueConfig<_0> = MockSharedSliceValueConfig<_0>;
+type index$2_MockSharedSliceVariationValueConfig<_0> = MockSharedSliceVariationValueConfig<_0>;
+type index$2_MockTimestampValueConfig<_0> = MockTimestampValueConfig<_0>;
+type index$2_MockTitleValueConfig<_0> = MockTitleValueConfig<_0>;
+type index$2_MockUIDValueConfig<_0> = MockUIDValueConfig<_0>;
+declare namespace index$2 {
   export {
     boolean$1 as boolean,
-    index$1_MockBooleanValueConfig as MockBooleanValueConfig,
+    index$2_MockBooleanValueConfig as MockBooleanValueConfig,
     customType$1 as customType,
-    index$1_MockCustomTypeValueConfig as MockCustomTypeValueConfig,
+    index$2_MockCustomTypeValueConfig as MockCustomTypeValueConfig,
     color$1 as color,
-    index$1_MockColorValueConfig as MockColorValueConfig,
+    index$2_MockColorValueConfig as MockColorValueConfig,
     contentRelationship$1 as contentRelationship,
-    index$1_MockContentRelationshipValueConfig as MockContentRelationshipValueConfig,
+    index$2_MockContentRelationshipValueConfig as MockContentRelationshipValueConfig,
     customType$1 as document,
     MockCustomTypeValueConfig as MockDocumentValueConfig,
     date$1 as date,
-    index$1_MockDateValueConfig as MockDateValueConfig,
+    index$2_MockDateValueConfig as MockDateValueConfig,
     embed$1 as embed,
-    index$1_MockEmbedValueConfig as MockEmbedValueConfig,
+    index$2_MockEmbedValueConfig as MockEmbedValueConfig,
     geoPoint$1 as geoPoint,
-    index$1_MockGeoPointValueConfig as MockGeoPointValueConfig,
+    index$2_MockGeoPointValueConfig as MockGeoPointValueConfig,
     group$1 as group,
-    index$1_MockGroupValueConfig as MockGroupValueConfig,
+    index$2_MockGroupValueConfig as MockGroupValueConfig,
     image$1 as image,
-    index$1_MockImageValueConfig as MockImageValueConfig,
+    index$2_MockImageValueConfig as MockImageValueConfig,
     integrationFields$1 as integrationFields,
-    index$1_MockIntegrationFieldsValueConfig as MockIntegrationFieldsValueConfig,
+    index$2_MockIntegrationFieldsValueConfig as MockIntegrationFieldsValueConfig,
     keyText$1 as keyText,
-    index$1_MockKeyTextValueConfig as MockKeyTextValueConfig,
+    index$2_MockKeyTextValueConfig as MockKeyTextValueConfig,
     link$1 as link,
-    index$1_MockLinkValueConfig as MockLinkValueConfig,
+    index$2_MockLinkValueConfig as MockLinkValueConfig,
     linkToMedia$1 as linkToMedia,
-    index$1_MockLinkToMediaValueConfig as MockLinkToMediaValueConfig,
+    index$2_MockLinkToMediaValueConfig as MockLinkToMediaValueConfig,
     number$1 as number,
-    index$1_MockNumberValueConfig as MockNumberValueConfig,
+    index$2_MockNumberValueConfig as MockNumberValueConfig,
     richText$1 as richText,
     MockRichTextValueConfig$1 as MockRichTextValueConfig,
     select$1 as select,
-    index$1_MockSelectValueConfig as MockSelectValueConfig,
+    index$2_MockSelectValueConfig as MockSelectValueConfig,
     slice$1 as slice,
-    index$1_MockSliceValueConfig as MockSliceValueConfig,
+    index$2_MockSliceValueConfig as MockSliceValueConfig,
     sliceZone$1 as sliceZone,
-    index$1_MockSliceZoneValueConfig as MockSliceZoneValueConfig,
+    index$2_MockSliceZoneValueConfig as MockSliceZoneValueConfig,
     sharedSlice$1 as sharedSlice,
-    index$1_MockSharedSliceValueConfig as MockSharedSliceValueConfig,
+    index$2_MockSharedSliceValueConfig as MockSharedSliceValueConfig,
     sharedSliceVariation$1 as sharedSliceVariation,
-    index$1_MockSharedSliceVariationValueConfig as MockSharedSliceVariationValueConfig,
+    index$2_MockSharedSliceVariationValueConfig as MockSharedSliceVariationValueConfig,
     timestamp$1 as timestamp,
-    index$1_MockTimestampValueConfig as MockTimestampValueConfig,
+    index$2_MockTimestampValueConfig as MockTimestampValueConfig,
     title$1 as title,
-    index$1_MockTitleValueConfig as MockTitleValueConfig,
+    index$2_MockTitleValueConfig as MockTitleValueConfig,
     uid$1 as uid,
-    index$1_MockUIDValueConfig as MockUIDValueConfig,
+    index$2_MockUIDValueConfig as MockUIDValueConfig,
   };
@@ -320,2 +321,5 @@ }
 declare type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof ObjectType> = ObjectType[ValueType];
+declare type MockRestApiConfig = {
+    seed?: number;
+};
 declare type MockModelConfig = {
@@ -345,2 +349,52 @@ seed?: number;
 
+declare type MockRestApiRepositoryConfig = {
+    customTypeModels?: prismicT.CustomTypeModel[];
+    withReleases?: boolean;
+} & MockRestApiConfig;
+declare const repository: (config?: MockRestApiRepositoryConfig) => prismicT.Repository;
+
+declare type MockRestApiRefConfig<IsScheduled extends boolean = false> = {
+    isMasterRef?: boolean;
+    isScheduled?: IsScheduled;
+} & MockRestApiConfig;
+declare type MockRestApiRefValue<IsScheduled extends boolean = false> = Omit<prismicT.Ref, "scheduledAt"> & (IsScheduled extends true ? {
+    scheduledAt: string;
+} : {
+    scheduledAt?: never;
+});
+declare const ref: <IsScheduled extends boolean = false>(config?: MockRestApiRefConfig<IsScheduled>) => MockRestApiRefValue<IsScheduled>;
+
+declare type MockRestApiQueryConfig<Document extends prismicT.PrismicDocument = prismicT.PrismicDocument> = {
+    documents?: Document[];
+    page?: number;
+    pageSize?: number;
+} & MockRestApiConfig;
+declare const query: <Document_1 extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string> = prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(config?: MockRestApiQueryConfig<Document_1>) => prismicT.Query<Document_1>;
+
+declare type MockRestApiTagsConfig = MockRestApiConfig;
+declare const tags: (config?: MockRestApiTagsConfig) => prismicT.Tags<string>;
+
+declare const index$1_repository: typeof repository;
+type index$1_MockRestApiRepositoryConfig = MockRestApiRepositoryConfig;
+declare const index$1_ref: typeof ref;
+type index$1_MockRestApiRefConfig<_0> = MockRestApiRefConfig<_0>;
+type index$1_MockRestApiRefValue<_0> = MockRestApiRefValue<_0>;
+declare const index$1_query: typeof query;
+type index$1_MockRestApiQueryConfig<_0> = MockRestApiQueryConfig<_0>;
+declare const index$1_tags: typeof tags;
+type index$1_MockRestApiTagsConfig = MockRestApiTagsConfig;
+declare namespace index$1 {
+  export {
+    index$1_repository as repository,
+    index$1_MockRestApiRepositoryConfig as MockRestApiRepositoryConfig,
+    index$1_ref as ref,
+    index$1_MockRestApiRefConfig as MockRestApiRefConfig,
+    index$1_MockRestApiRefValue as MockRestApiRefValue,
+    index$1_query as query,
+    index$1_MockRestApiQueryConfig as MockRestApiQueryConfig,
+    index$1_tags as tags,
+    index$1_MockRestApiTagsConfig as MockRestApiTagsConfig,
+  };
+}
+
 declare type MockBooleanModelConfig = MockModelConfig;
@@ -550,2 +604,2 @@ declare const boolean: (config?: MockBooleanModelConfig) => prismicT.CustomTypeModelBooleanField;
 
-export { index as model, index$1 as value };
+export { index$1 as api, index as model, index$2 as value };

dist/value/index.d.ts

@@ -52,2 +52,3 @@ import * as prismicT from '@prismicio/types';
 declare type MockCustomTypeValueConfig<Model extends prismicT.CustomTypeModel = prismicT.CustomTypeModel> = {
+    withURL?: boolean;
     sharedSliceModels?: prismicT.SharedSliceModel[];
@@ -54,0 +55,0 @@ configs?: ValueForModelMapConfigs;

package.json

 {
 	"name": "@prismicio/mock",
-	"version": "0.0.3",
+	"version": "0.0.4",
 	"description": "Generate mock Prismic documents, fields, Slices, and models for development and testing environments",
@@ -18,2 +18,3 @@ "keywords": [
 	"author": "Prismic <[e-mail]> (https://prismic.io)",
+	"sideEffects": false,
 	"type": "module",
@@ -25,2 +26,6 @@ "exports": {
 		},
+		"./api": {
+			"require": "./dist/api/index.cjs",
+			"import": "./dist/api/index.mjs"
+		},
 		"./model": {
@@ -27,0 +32,0 @@ "require": "./dist/model/index.cjs",

src/index.ts

@@ -0,2 +1,3 @@
+export * as api from "./api";
 export * as model from "./model";
 export * as value from "./value";

src/lib/generateTags.ts

@@ -7,3 +7,6 @@ import * as changeCase from "change-case";
 
-type GenerateTagsConfig = Pick<MockValueConfig, "seed">;
+type GenerateTagsConfig = {
+	min?: number;
+	max?: number;
+} & Pick<MockValueConfig, "seed">;
 
@@ -13,3 +16,8 @@ export const generateTags = (config: GenerateTagsConfig): string[] => {
 
-	return Array(faker.datatype.number(2))
+	return Array(
+		faker.datatype.number({
+			min: config.min ?? 0,
+			max: config.max ?? 2,
+		}),
+	)
 		.fill(undefined)
@@ -16,0 +24,0 @@ .map(() =>

src/types.ts

@@ -45,2 +45,6 @@ import * as prismicT from "@prismicio/types";
 
+export type MockRestApiConfig = {
+	seed?: number;
+};
+
 export type MockModelConfig = {
@@ -47,0 +51,0 @@ seed?: number;

src/value/customType.ts

@@ -20,2 +20,3 @@ import * as prismicT from "@prismicio/types";
 > = {
+	withURL?: boolean;
 	sharedSliceModels?: prismicT.SharedSliceModel[];
@@ -38,2 +39,3 @@ configs?: ValueForModelMapConfigs;
 	) as prismicT.CustomTypeModelTab;
+
 	const hasUID = Object.values(fieldModelsMap).some(
@@ -43,2 +45,4 @@ (fieldModel) => fieldModel.type === prismicT.CustomTypeModelFieldType.UID,
 
+	const withURL = config.withURL ?? true;
+
 	return {
@@ -48,3 +52,3 @@ type: model.id,
 		uid: hasUID ? changeCase.snakeCase(faker.lorem.words(2)) : null,
-		url: faker.internet.url(),
+		url: withURL ? faker.internet.url() : null,
 		href: faker.internet.url(),
@@ -51,0 +55,0 @@ lang: faker.lorem.word(),

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

453244

increased by13.12%

Number of package files

92

increased by9.52%

Lines of code

11926

increased by13.67%

No dependency changes