@jungvonmatt/contentful-fakes 4.1.1 → 5.0.0

package/package.json

@@ -1,57 +1,60 @@
 {
   "name": "@jungvonmatt/contentful-fakes",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Create fake data based on contentful data models",
-  "main": "./dist/index.js",
-  "type": "module",
-  "typings": "./dist/types.d.ts",
+  "keywords": [
+    "contentful",
+    "data",
+    "fake"
+  ],
+  "homepage": "https://github.com/jungvonmatt/contentful-ssg#readme",
+  "bugs": {
+    "url": "https://github.com/jungvonmatt/contentful-ssg/issues"
+  },
+  "license": "MIT",
+  "author": "Ben Zörb",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jungvonmatt/contentful-ssg.git"
+  },
   "bin": {
     "contentful-fakes": "./dist/cli.js"
   },
+  "files": [
+    "src",
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "typings": "./dist/types.d.ts",
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
     "clean": "rimraf ./dist",
-    "test": "jest",
-    "lint": "eslint --color src --fix --ext .ts",
+    "test": "vitest run",
+    "lint": "oxlint --type-aware --fix src",
     "precompile": "pnpm run clean",
     "compile": "tsc --build",
     "postcompile": "chmod +x ./dist/cli.js",
     "watch": "tsc --build --watch"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/jungvonmatt/contentful-ssg.git"
-  },
-  "files": [
-    "src",
-    "dist"
-  ],
-  "keywords": [
-    "fake",
-    "data",
-    "contentful"
-  ],
-  "author": "Ben Zörb",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/jungvonmatt/contentful-ssg/issues"
-  },
-  "homepage": "https://github.com/jungvonmatt/contentful-ssg#readme",
   "dependencies": {
     "@faker-js/faker": "^7.3.0",
-    "@jungvonmatt/contentful-config": "^4.1.1",
-    "@jungvonmatt/contentful-ssg": "^4.1.1",
+    "@jungvonmatt/contentful-config": "5.0.0",
+    "@jungvonmatt/contentful-ssg": "5.0.0",
     "casual": "^1.6.2",
     "chalk": "^5.3.0",
+    "commander": "^11.1.0",
     "exit-hook": "^4.0.0",
     "fs-extra": "^11.1.0",
     "randexp": "^0.5.3"
   },
   "devDependencies": {
     "@types/chance": "^1.1.3",
-    "contentful-management": "^11.54.4"
+    "@types/fs-extra": "^11.0.4",
+    "contentful-management": "^11.54.4",
+    "rimraf": "^5.0.5"
   },
-  "gitHead": "6bd147888d0d5b3750ef94319ce3ad186f9e5b39"
+  "gitHead": "dfbefe2c66877ed9411bdb242327e6915f58cf3e"
 }

package/src/index.test.ts

@@ -0,0 +1,70 @@
+import { vi } from 'vitest';
+import { createFakes } from './index.js';
+
+vi.mock('@jungvonmatt/contentful-config', () => ({
+  loadContentfulConfig: vi.fn().mockResolvedValue({
+    config: {
+      managementToken: 'mt',
+      environmentId: 'env',
+      spaceId: 'space',
+    },
+  }),
+}));
+
+vi.mock('@jungvonmatt/contentful-ssg/lib/contentful', async (importOriginal) => {
+  const actual = (await importOriginal()) as Record<string, unknown>;
+  return {
+    ...actual,
+    getEnvironment: vi.fn().mockResolvedValue({
+      getContentTypes: vi.fn().mockResolvedValue({
+        items: [
+          {
+            sys: { id: 'page' },
+            fields: [
+              { id: 'title', type: 'Symbol', required: true, validations: [] },
+              { id: 'body', type: 'Text', required: false, validations: [] },
+            ],
+          },
+          {
+            sys: { id: 'author' },
+            fields: [{ id: 'name', type: 'Symbol', required: true, validations: [] }],
+          },
+        ],
+      }),
+      getEditorInterfaces: vi.fn().mockResolvedValue({
+        items: [
+          {
+            sys: { contentType: { sys: { id: 'page' } } },
+            controls: [
+              { fieldId: 'title', widgetId: 'singleLine' },
+              { fieldId: 'body', widgetId: 'multipleLine' },
+            ],
+          },
+          {
+            sys: { contentType: { sys: { id: 'author' } } },
+            controls: [{ fieldId: 'name', widgetId: 'singleLine' }],
+          },
+        ],
+      }),
+    }),
+  };
+});
+
+describe('createFakes', () => {
+  test('returns fake + minimal data for all content types when no filter', async () => {
+    const result = await createFakes([]);
+    expect(Object.keys(result).toSorted()).toEqual(['author', 'page']);
+
+    const [pageFull, pageMin] = result.page;
+    expect(pageFull).toHaveProperty('title');
+    expect(pageFull).toHaveProperty('body');
+    // minimal only contains required fields
+    expect(pageMin).toHaveProperty('title');
+    expect(pageMin).not.toHaveProperty('body');
+  });
+
+  test('filters content types by id when ids are given', async () => {
+    const result = await createFakes(['page']);
+    expect(Object.keys(result)).toEqual(['page']);
+  });
+});

package/src/lib/faker.test.ts

@@ -35,7 +35,7 @@ import { ContentTypeFieldValidation } from 'contentful-management/types';
 const getFieldInfo = (
   id: string,
   validations: ContentTypeFieldValidation[] = [],
-  widgetId: string = 'singleLine'
+  widgetId: string = 'singleLine',
 ): FieldInfo => ({
   settings: { id, validations },
   interface: { fieldId: 'id', widgetId },
@@ -153,7 +153,7 @@ describe('contentful-fakes', () => {
   it('getSymbolFake (interface: urlEditor)', async () => {
     const result = await getSymbolFake(getFieldInfo('-', [], 'urlEditor'));
     expect(result).toMatch(
-      new RegExp('\\/\\/(\\w+:{0,1}\\w*@)?(\\S+)(:[0-9]+)?(\\/|\\/([\\w#!:.?+=&%@!\\-/]))?$')
+      new RegExp('\\/\\/(\\w+:{0,1}\\w*@)?(\\S+)(:[0-9]+)?(\\/|\\/([\\w#!:.?+=&%@!\\-/]))?$'),
     );
   });
 
@@ -166,8 +166,8 @@ describe('contentful-fakes', () => {
     const result = await getSymbolFake(getFieldInfo('id'));
     expect(result).toMatch(
       new RegExp(
-        '[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}'
-      )
+        '[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}',
+      ),
     );
   });
 
@@ -251,7 +251,7 @@ describe('contentful-fakes', () => {
 
   it('getRichtextFake min', async () => {
     const result = await getRichtextFake(
-      getFieldInfo('-', [{ enabledMarks: [], enabledNodeTypes: [] }])
+      getFieldInfo('-', [{ enabledMarks: [], enabledNodeTypes: [] }]),
     );
 
     expect(Object.keys(result)).toEqual(['node_type', 'data', 'content']);
@@ -261,7 +261,7 @@ describe('contentful-fakes', () => {
     const result = await getRichtextFake(
       getFieldInfo('-', [
         { enabledMarks: ['italic'], enabledNodeTypes: ['heading-1', 'heading-2'] },
-      ])
+      ]),
     );
 
     expect(Object.keys(result)).toEqual(['node_type', 'data', 'content']);