@prismicio/mock 0.0.3 → 0.0.7

package/README.md

@@ -36,7 +36,9 @@ Whether you're helping us fix bugs, improve the docs, or spread the word, we'd l
 
 **Suggesting an improvement**: [Open an issue][repo-feature-request] explaining your improvement or feature so we can discuss and learn more.
 
-**Submitting code changes**: For small fixes, feel free to [open a PR][repo-pull-requests] with a description of your changes. For large changes, please first [open an issue][repo-feature-request] so we can discuss if and how the changes should be implemented.
+**Submitting code changes**: For small fixes, feel free to [open a pull request][repo-pull-requests] with a description of your changes. For large changes, please first [open an issue][repo-feature-request] so we can discuss if and how the changes should be implemented.
+
+For more clarity on this project and its structure you can also check out the detailed [CONTRIBUTING.md][contributing] document.
 
 ## License
 
@@ -64,6 +66,7 @@ Whether you're helping us fix bugs, improve the docs, or spread the word, we'd l
 
 [prismic-docs]: https://prismic.io/docs
 [changelog]: /CHANGELOG.md
+[contributing]: ./CONTRIBUTING.md
 
 <!-- TODO: Replace link with a more useful one if available -->
 

package/dist/api/index.cjs

@@ -0,0 +1,561 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const changeCase = require('change-case');
+const fakerLocaleEN = require('faker/lib/locales/en/index.js');
+const Faker = require('faker/lib/index.js');
+const prismicT = require('@prismicio/types');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+function _interopNamespace(e) {
+	if (e && e.__esModule) return e;
+	const n = Object.create(null);
+	if (e) {
+		for (const k in e) {
+			if (k !== 'default') {
+				const d = Object.getOwnPropertyDescriptor(e, k);
+				Object.defineProperty(n, k, d.get ? d : {
+					enumerable: true,
+					get: function () { return e[k]; }
+				});
+			}
+		}
+	}
+	n["default"] = e;
+	return Object.freeze(n);
+}
+
+const changeCase__namespace = /*#__PURE__*/_interopNamespace(changeCase);
+const fakerLocaleEN__namespace = /*#__PURE__*/_interopNamespace(fakerLocaleEN);
+const Faker__default = /*#__PURE__*/_interopDefaultLegacy(Faker);
+const prismicT__namespace = /*#__PURE__*/_interopNamespace(prismicT);
+
+const FAKER_SEED = 1984;
+
+const createFaker = (seed = FAKER_SEED) => {
+  let normalizedSeed;
+  if (typeof seed === "string") {
+    normalizedSeed = seed.split("").map((char) => char.charCodeAt(0));
+  } else {
+    normalizedSeed = seed;
+  }
+  const cacheKey = JSON.stringify(normalizedSeed);
+  if (createFaker.cache[cacheKey]) {
+    return createFaker.cache[cacheKey];
+  }
+  const fakerInstance = new Faker__default["default"]();
+  fakerInstance.locales["en"] = fakerLocaleEN__namespace;
+  fakerInstance.seed(normalizedSeed);
+  createFaker.cache[cacheKey] = fakerInstance;
+  return fakerInstance;
+};
+createFaker.cache = {};
+
+const generateTags = (config) => {
+  var _a, _b;
+  const faker = createFaker(config.seed);
+  return Array(faker.datatype.number({
+    min: (_a = config.min) != null ? _a : 0,
+    max: (_b = config.max) != null ? _b : 2
+  })).fill(void 0).map(() => changeCase__namespace.capitalCase(faker.lorem.words(faker.datatype.number({ min: 1, max: 3 }))));
+};
+
+const title = (config = {}) => {
+  const faker = createFaker(config.seed);
+  const single = faker.random.arrayElements([
+    "heading1",
+    "heading2",
+    "heading3",
+    "heading4",
+    "heading5",
+    "heading6"
+  ]).join(",");
+  return {
+    type: prismicT__namespace.CustomTypeModelFieldType.StructuredText,
+    config: {
+      label: changeCase__namespace.capitalCase(faker.company.bsNoun()),
+      placeholder: changeCase__namespace.sentenceCase(faker.lorem.words(3)),
+      single,
+      allowTargetBlank: faker.datatype.boolean() ? true : void 0
+    }
+  };
+};
+
+const timestamp = (config = {}) => {
+  const faker = createFaker(config.seed);
+  const after = config.after || faker.date.past(20, new Date("2021-03-07")).toISOString().split("T")[0];
+  const before = config.before || faker.date.future(20, new Date("2021-03-07")).toISOString().split("T")[0];
+  return config.state === "empty" ? null : faker.date.between(after, before).toISOString();
+};
+
+const buildEmbedField = (config) => {
+  const faker = createFaker(config.seed);
+  return {
+    type: faker.datatype.boolean() ? prismicT__namespace.EmbedType.Link : prismicT__namespace.EmbedType.Rich,
+    url: config.embedData.url,
+    html: config.embedData.html,
+    title: changeCase__namespace.capitalCase(faker.lorem.words(3)),
+    version: faker.datatype.number({ min: 1, max: 3, precision: 10 }).toString(),
+    cache_age: faker.datatype.number(),
+    embed_url: config.embedData.embed_url,
+    author_url: faker.internet.url(),
+    author_name: faker.company.companyName(),
+    provider_name: faker.company.companyName(),
+    thumbnail_width: config.embedData.thumbnail_width,
+    thumbnail_height: config.embedData.thumbnail_height,
+    thumbnail_url: config.embedData.thumbnail_url,
+    width: faker.datatype.number({ min: 200, max: 500 }),
+    height: faker.datatype.number({ min: 200, max: 500 })
+  };
+};
+
+const dataSet$1 = [
+  {
+    url: "https://www.youtube.com/watch?v=fiOwHYFkUz0",
+    embed_url: "https://www.youtube.com/embed/fiOwHYFkUz0",
+    thumbnail_url: "https://i.ytimg.com/vi/fiOwHYFkUz0/hqdefault.jpg",
+    thumbnail_height: 360,
+    thumbnail_width: 480,
+    html: '<iframe width="200" height="113" src="https://www.youtube.com/embed/fiOwHYFkUz0?feature=oembed" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>'
+  },
+  {
+    url: "https://www.youtube.com/watch?v=c-ATzcy6VkI",
+    embed_url: "https://www.youtube.com/embed/c-ATzcy6VkI",
+    thumbnail_url: "https://i.ytimg.com/vi/c-ATzcy6VkI/hqdefault.jpg",
+    thumbnail_height: 360,
+    thumbnail_width: 480,
+    html: '<iframe width="200" height="113" src="https://www.youtube.com/embed/c-ATzcy6VkI?feature=oembed" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>'
+  },
+  {
+    url: "https://www.youtube.com/watch?v=iewZXv94XGY",
+    embed_url: "https://www.youtube.com/watch?v=fiOwHYFkUz0",
+    thumbnail_url: "https://i.ytimg.com/vi/iewZXv94XGY/hqdefault.jpg",
+    thumbnail_height: 360,
+    thumbnail_width: 480,
+    html: '<iframe width="200" height="113" src="https://www.youtube.com/embed/iewZXv94XGY?feature=oembed" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>'
+  },
+  {
+    url: "https://twitter.com/prismicio/status/1356293316158095361",
+    embed_url: "https://www.youtube.com/watch?v=iewZXv94XGY",
+    thumbnail_url: null,
+    thumbnail_height: null,
+    thumbnail_width: null,
+    html: '<blockquote class="twitter-tweet"><p lang="en" dir="ltr">Gatsby is a popular choice for Prismic users and we work hard on delivering a CMS that plays to its strengths.<br><br>But, what makes <a href="https://twitter.com/GatsbyJS?ref_src=twsrc%5Etfw">@GatsbyJS</a> so popular?<br><br>Here are some of <a href="https://twitter.com/mxstbr?ref_src=twsrc%5Etfw">@mxstbr</a>&#39;s thoughts on Gatsby&#39;s success and how they&#39;re improving developer experience.<a href="https://t.co/ZjCPvsWWUD">https://t.co/ZjCPvsWWUD</a> <a href="https://t.co/EQqzJpeNKl">pic.twitter.com/EQqzJpeNKl</a></p>&mdash; Prismic (@prismicio) <a href="https://twitter.com/prismicio/status/1356293316158095361?ref_src=twsrc%5Etfw">February 1, 2021</a></blockquote>\n<script async src="https://platform.twitter.com/widgets.js" charset="utf-8"><\/script>\n'
+  },
+  {
+    url: "https://twitter.com/timbenniks/status/1304146886832594944",
+    thumbnail_url: null,
+    thumbnail_width: null,
+    thumbnail_height: null,
+    embed_url: "https://twitter.com/timbenniks/status/1304146886832594944",
+    html: '<blockquote class="twitter-tweet"><p lang="en" dir="ltr">I\u2019ve been diving deep on <a href="https://twitter.com/prismicio?ref_src=twsrc%5Etfw">@prismicio</a> <a href="https://twitter.com/hashtag/slicemachine?src=hash&amp;ref_src=twsrc%5Etfw">#slicemachine</a> today. I made all my own components and I used custom slices. It works like a charm with <a href="https://twitter.com/nuxt_js?ref_src=twsrc%5Etfw">@nuxt_js</a>. Also: I\u2019m coding with this view. <a href="https://t.co/F0I8X9gz39">pic.twitter.com/F0I8X9gz39</a></p>&mdash; Tim Benniks (@timbenniks) <a href="https://twitter.com/timbenniks/status/1304146886832594944?ref_src=twsrc%5Etfw">September 10, 2020</a></blockquote>\n<script async src="https://platform.twitter.com/widgets.js" charset="utf-8"><\/script>\n'
+  },
+  {
+    url: "https://twitter.com/prismicio/status/1354112310252630016",
+    thumbnail_url: null,
+    thumbnail_width: null,
+    thumbnail_height: null,
+    embed_url: "https://twitter.com/prismicio/status/1354112310252630016",
+    html: '<blockquote class="twitter-tweet"><p lang="en" dir="ltr">We&#39;re launching a new <a href="https://twitter.com/hashtag/SliceContest?src=hash&amp;ref_src=twsrc%5Etfw">#SliceContest</a> tomorrow along with Slice Machine upgrades.<br><br>Want to know more? Join us at tomorrow&#39;s Product Meet-up\u{1F447}<a href="https://t.co/prYSypiAvB">https://t.co/prYSypiAvB</a><br><br>We can&#39;t tell you any further details for now, but here&#39;s a sneak peek at the prizes\u{1F440} <a href="https://t.co/fV1eoGlEBh">pic.twitter.com/fV1eoGlEBh</a></p>&mdash; Prismic (@prismicio) <a href="https://twitter.com/prismicio/status/1354112310252630016?ref_src=twsrc%5Etfw">January 26, 2021</a></blockquote>\n<script async src="https://platform.twitter.com/widgets.js" charset="utf-8"><\/script>\n'
+  },
+  {
+    url: "https://twitter.com/prismicio/status/1354835716430319617",
+    thumbnail_url: null,
+    thumbnail_width: null,
+    thumbnail_height: null,
+    embed_url: "https://twitter.com/prismicio/status/1354835716430319617",
+    html: '<blockquote class="twitter-tweet"><p lang="en" dir="ltr">Does anyone want to create a wildly popular website for discussing &#39;Wall Street Bets&#39; using Prismic?<br><br>It may or may not have to look a lot like <a href="https://twitter.com/hashtag/reddit?src=hash&amp;ref_src=twsrc%5Etfw">#reddit</a> and we won&#39;t make it private.<br><br>Just asking for some friends...</p>&mdash; Prismic (@prismicio) <a href="https://twitter.com/prismicio/status/1354835716430319617?ref_src=twsrc%5Etfw">January 28, 2021</a></blockquote>\n<script async src="https://platform.twitter.com/widgets.js" charset="utf-8"><\/script>\n'
+  }
+];
+const getMockEmbedData = (config) => {
+  const faker = createFaker(config.seed);
+  return faker.random.arrayElement(dataSet$1);
+};
+
+const buildImageFieldImage = (config) => {
+  var _a, _b, _c, _d;
+  if (config.state === "empty") {
+    return {
+      url: null,
+      dimensions: null,
+      alt: null,
+      copyright: null
+    };
+  } else {
+    const faker = createFaker(config.seed);
+    const url = new URL(config.imageData.url);
+    const dimensions = {
+      width: (_b = (_a = config.constraint) == null ? void 0 : _a.width) != null ? _b : config.imageData.width,
+      height: (_d = (_c = config.constraint) == null ? void 0 : _c.height) != null ? _d : 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()
+    };
+  }
+};
+
+const dataSet = [
+  {
+    url: "https://images.unsplash.com/photo-1604537529428-15bcbeecfe4d",
+    width: 4240,
+    height: 2832
+  },
+  {
+    url: "https://images.unsplash.com/photo-1470071459604-3b5ec3a7fe05",
+    width: 7372,
+    height: 4392
+  },
+  {
+    url: "https://images.unsplash.com/photo-1441974231531-c6227db76b6e",
+    width: 2560,
+    height: 1705
+  },
+  {
+    url: "https://images.unsplash.com/photo-1418065460487-3e41a6c84dc5",
+    width: 2200,
+    height: 1467
+  },
+  {
+    url: "https://images.unsplash.com/photo-1426604966848-d7adac402bff",
+    width: 5616,
+    height: 3744
+  },
+  {
+    url: "https://images.unsplash.com/photo-1604537466608-109fa2f16c3b",
+    width: 4240,
+    height: 2832
+  },
+  {
+    url: "https://images.unsplash.com/photo-1497436072909-60f360e1d4b1",
+    width: 2560,
+    height: 1440
+  },
+  {
+    url: "https://images.unsplash.com/reserve/HgZuGu3gSD6db21T3lxm_San%20Zenone.jpg",
+    width: 6373,
+    height: 4253
+  },
+  {
+    url: "https://images.unsplash.com/photo-1504198266287-1659872e6590",
+    width: 4272,
+    height: 2848
+  },
+  {
+    url: "https://images.unsplash.com/photo-1470770903676-69b98201ea1c",
+    width: 4554,
+    height: 3036
+  },
+  {
+    url: "https://images.unsplash.com/photo-1587502537745-84b86da1204f",
+    width: 6550,
+    height: 4367
+  },
+  {
+    url: "https://images.unsplash.com/photo-1431794062232-2a99a5431c6c",
+    width: 6e3,
+    height: 4e3
+  },
+  {
+    url: "https://images.unsplash.com/photo-1446329813274-7c9036bd9a1f",
+    width: 6e3,
+    height: 4e3
+  },
+  {
+    url: "https://images.unsplash.com/photo-1504567961542-e24d9439a724",
+    width: 4608,
+    height: 3456
+  },
+  {
+    url: "https://images.unsplash.com/photo-1444464666168-49d633b86797",
+    width: 4844,
+    height: 3234
+  },
+  {
+    url: "https://images.unsplash.com/photo-1553531384-397c80973a0b",
+    width: 4335,
+    height: 6502
+  }
+];
+const getMockImageData = (config) => {
+  const faker = createFaker(config.seed);
+  return faker.random.arrayElement(dataSet);
+};
+
+const patterns$4 = {
+  short: {
+    minWords: 1,
+    maxWords: 3
+  },
+  medium: {
+    minWords: 3,
+    maxWords: 6
+  },
+  long: {
+    minWords: 6,
+    maxWords: 12
+  }
+};
+const heading = (config = {}) => {
+  const faker = createFaker(config.seed);
+  const model = config.model || title({ seed: config.seed });
+  const types = ("single" in model.config ? model.config.single : model.config.multi).split(",").filter((type2) => [
+    prismicT__namespace.RichTextNodeType.heading1,
+    prismicT__namespace.RichTextNodeType.heading2,
+    prismicT__namespace.RichTextNodeType.heading3,
+    prismicT__namespace.RichTextNodeType.heading4,
+    prismicT__namespace.RichTextNodeType.heading5,
+    prismicT__namespace.RichTextNodeType.heading6
+  ].includes(type2));
+  const type = faker.random.arrayElement(types);
+  if (type) {
+    const patternKey = config.pattern || faker.random.arrayElement(Object.keys(patterns$4));
+    const pattern = patterns$4[patternKey];
+    return {
+      type,
+      text: changeCase__namespace.capitalCase(faker.lorem.words(faker.datatype.number({
+        min: pattern.minWords,
+        max: pattern.maxWords
+      }))),
+      spans: []
+    };
+  } else {
+    return void 0;
+  }
+};
+
+const patterns$3 = {
+  short: {
+    sentenceCount: 2
+  },
+  medium: {
+    sentenceCount: 6
+  },
+  long: {
+    sentenceCount: 12
+  }
+};
+const paragraph = (config = {}) => {
+  const faker = createFaker(config.seed);
+  const patternKey = config.pattern || faker.random.arrayElement(Object.keys(patterns$3));
+  const pattern = patterns$3[patternKey];
+  return {
+    type: prismicT__namespace.RichTextNodeType.paragraph,
+    text: faker.lorem.paragraph(pattern.sentenceCount),
+    spans: []
+  };
+};
+
+const patterns$2 = {
+  short: {
+    sentenceCount: 2
+  },
+  medium: {
+    sentenceCount: 6
+  },
+  long: {
+    sentenceCount: 12
+  }
+};
+const preformatted = (config = {}) => {
+  const faker = createFaker(config.seed);
+  const patternKey = config.pattern || faker.random.arrayElement(Object.keys(patterns$2));
+  const pattern = patterns$2[patternKey];
+  return {
+    type: prismicT__namespace.RichTextNodeType.preformatted,
+    text: faker.lorem.paragraph(pattern.sentenceCount),
+    spans: []
+  };
+};
+
+const patterns$1 = {
+  short: {
+    minItems: 1,
+    maxItems: 3
+  },
+  medium: {
+    minItems: 3,
+    maxItems: 6
+  },
+  long: {
+    minItems: 6,
+    maxItems: 12
+  }
+};
+const list = (config = {}) => {
+  const faker = createFaker(config.seed);
+  const patternKey = config.pattern || faker.random.arrayElement(Object.keys(patterns$1));
+  const pattern = patterns$1[patternKey];
+  const itemsCount = faker.datatype.number({
+    min: pattern.minItems,
+    max: pattern.maxItems
+  });
+  return Array(itemsCount).fill(void 0).map(() => {
+    return {
+      type: prismicT__namespace.RichTextNodeType.listItem,
+      text: faker.lorem.sentence(),
+      spans: []
+    };
+  });
+};
+
+const patterns = {
+  short: {
+    minItems: 1,
+    maxItems: 3
+  },
+  medium: {
+    minItems: 3,
+    maxItems: 6
+  },
+  long: {
+    minItems: 6,
+    maxItems: 12
+  }
+};
+const oList = (config = {}) => {
+  const faker = createFaker(config.seed);
+  const patternKey = config.pattern || faker.random.arrayElement(Object.keys(patterns));
+  const pattern = patterns[patternKey];
+  const itemsCount = faker.datatype.number({
+    min: pattern.minItems,
+    max: pattern.maxItems
+  });
+  return Array(itemsCount).fill(void 0).map(() => {
+    return {
+      type: prismicT__namespace.RichTextNodeType.oListItem,
+      text: faker.lorem.sentence(),
+      spans: []
+    };
+  });
+};
+
+const image = (config = {}) => {
+  const imageData = getMockImageData({ seed: config.seed });
+  const imageField = buildImageFieldImage({
+    seed: config.seed,
+    imageData,
+    state: false
+  });
+  return {
+    type: prismicT__namespace.RichTextNodeType.image,
+    alt: imageField.alt,
+    url: imageField.url,
+    copyright: imageField.copyright,
+    dimensions: imageField.dimensions
+  };
+};
+
+const embed = (config = {}) => {
+  const embedData = getMockEmbedData({ seed: config.seed });
+  const embedField = buildEmbedField({ seed: config.seed, embedData });
+  return {
+    type: prismicT__namespace.RichTextNodeType.embed,
+    oembed: embedField
+  };
+};
+
+({
+  [prismicT__namespace.RichTextNodeType.heading1]: heading,
+  [prismicT__namespace.RichTextNodeType.heading2]: heading,
+  [prismicT__namespace.RichTextNodeType.heading3]: heading,
+  [prismicT__namespace.RichTextNodeType.heading4]: heading,
+  [prismicT__namespace.RichTextNodeType.heading5]: heading,
+  [prismicT__namespace.RichTextNodeType.heading6]: heading,
+  [prismicT__namespace.RichTextNodeType.paragraph]: paragraph,
+  [prismicT__namespace.RichTextNodeType.preformatted]: preformatted,
+  [prismicT__namespace.RichTextNodeType.listItem]: list,
+  [prismicT__namespace.RichTextNodeType.oListItem]: oList,
+  [prismicT__namespace.RichTextNodeType.image]: image,
+  [prismicT__namespace.RichTextNodeType.embed]: embed
+});
+
+const ref = (config = {}) => {
+  var _a;
+  const faker = createFaker(config.seed);
+  const value = {
+    id: faker.git.shortSha(),
+    ref: faker.git.shortSha(),
+    isMasterRef: (_a = config.isMasterRef) != null ? _a : false,
+    label: config.isMasterRef ? "Master" : changeCase__namespace.capitalCase(faker.company.bsNoun())
+  };
+  if (config.isScheduled) {
+    value.scheduledAt = timestamp({ seed: config.seed });
+  }
+  return value;
+};
+
+const repository = (config = {}) => {
+  const faker = createFaker(config.seed);
+  const types = (config.customTypeModels || []).reduce((acc, model) => {
+    acc[model.id] = model.label;
+    return acc;
+  }, {});
+  return {
+    refs: [
+      ref({ seed: config.seed, isMasterRef: true }),
+      ...config.withReleases ? [ref({ seed: config.seed }), ref({ seed: config.seed })] : []
+    ],
+    integrationFieldsRef: ref({ seed: config.seed }).ref,
+    types,
+    languages: [
+      {
+        id: faker.lorem.word(),
+        name: changeCase__namespace.capitalCase(faker.lorem.word())
+      }
+    ],
+    tags: generateTags({
+      seed: config.seed,
+      min: 1,
+      max: 10
+    }),
+    forms: {},
+    license: "All Rights Reserved",
+    version: faker.git.shortSha(),
+    bookmarks: {},
+    experiments: {},
+    oauth_token: faker.internet.url(),
+    oauth_initiate: faker.internet.url()
+  };
+};
+
+const query = (config = {}) => {
+  var _a, _b;
+  const faker = createFaker(config.seed);
+  const documents = config.documents || [];
+  const page = Math.max(1, (_a = config.page) != null ? _a : 1);
+  const pageSize = Math.min(100, Math.max(1, (_b = config.pageSize) != null ? _b : 100));
+  const totalPages = Math.ceil(documents.length / pageSize);
+  const results = documents.slice((page - 1) * pageSize, page * pageSize);
+  return {
+    page,
+    next_page: page < totalPages ? faker.internet.url() : null,
+    prev_page: page > 1 ? faker.internet.url() : null,
+    total_pages: totalPages,
+    results_size: results.length,
+    results_per_page: pageSize,
+    total_results_size: documents.length,
+    results
+  };
+};
+
+const tags = (config = {}) => {
+  return generateTags({
+    seed: config.seed,
+    min: 1,
+    max: 10
+  });
+};
+
+exports.query = query;
+exports.ref = ref;
+exports.repository = repository;
+exports.tags = tags;
+//# sourceMappingURL=index.cjs.map