@jungvonmatt/contentful-typings 4.1.2 → 5.0.0

package/dist/renderer/context.js

@@ -1,6 +1,6 @@
 import { pascalCase } from 'change-case';
 import { createDefaultContext, createV10Context, } from 'cf-content-types-generator';
-export const moduleName = (name) => `${pascalCase(name)}`;
+export const moduleName = (name) => pascalCase(name);
 export const moduleFieldsName = (name) => `${moduleName(name)}Fields`;
 export const moduleSkeletonName = (name) => `${moduleName(name)}Skeleton`;
 export const context = {

package/dist/renderer/context.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/renderer/context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EACL,oBAAoB,EACpB,gBAAgB,GAEjB,MAAM,4BAA4B,CAAC;AAEpC,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;AAClE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC;AAC9E,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC;AAC1F,MAAM,CAAC,MAAM,OAAO,GAAkB;IACpC,GAAG,oBAAoB,EAAE;IACzB,UAAU;IACV,gBAAgB;IAChB,kBAAkB;CACnB,CAAC;AACF,MAAM,CAAC,MAAM,UAAU,GAAkB;IACvC,GAAG,gBAAgB,EAAE;IACrB,UAAU;IACV,gBAAgB;IAChB,kBAAkB;CACnB,CAAC"}
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/renderer/context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EACL,oBAAoB,EACpB,gBAAgB,GAEjB,MAAM,4BAA4B,CAAC;AAEpC,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AAC7D,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC;AAC9E,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC;AAC1F,MAAM,CAAC,MAAM,OAAO,GAAkB;IACpC,GAAG,oBAAoB,EAAE;IACzB,UAAU;IACV,gBAAgB;IAChB,kBAAkB;CACnB,CAAC;AACF,MAAM,CAAC,MAAM,UAAU,GAAkB;IACvC,GAAG,gBAAgB,EAAE;IACrB,UAAU;IACV,gBAAgB;IAChB,kBAAkB;CACnB,CAAC"}

package/package.json

@@ -1,46 +1,43 @@
 {
   "name": "@jungvonmatt/contentful-typings",
-  "version": "4.1.2",
-  "main": "./dist/index.js",
-  "type": "module",
-  "exports": "./dist/index.js",
+  "version": "5.0.0",
+  "homepage": "https://github.com/jungvonmatt/contentful-ssg#readme",
+  "bugs": {
+    "url": "https://github.com/jungvonmatt/contentful-ssg/issues"
+  },
+  "license": "MIT",
+  "author": "",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jungvonmatt/contentful-ssg.git"
+  },
   "bin": {
-    "contentful-typings": "./dist/cli.js",
-    "contentful-types": "./dist/cli.js"
+    "contentful-types": "./dist/cli.js",
+    "contentful-typings": "./dist/cli.js"
   },
   "files": [
     "src",
     "dist"
   ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "exports": "./dist/index.js",
   "publishConfig": {
     "access": "public"
   },
-  "engines": {
-    "node": ">=20"
-  },
   "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"
-  },
-  "author": "",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/jungvonmatt/contentful-ssg/issues"
-  },
-  "homepage": "https://github.com/jungvonmatt/contentful-ssg#readme",
   "dependencies": {
     "@faker-js/faker": "^8.3.1",
-    "@jungvonmatt/contentful-config": "4.1.2",
-    "@jungvonmatt/contentful-ssg": "4.1.2",
+    "@jungvonmatt/contentful-config": "5.0.0",
+    "@jungvonmatt/contentful-ssg": "5.0.0",
     "cf-content-types-generator": "^2.16.0",
     "change-case": "^5.4.2",
     "commander": "^11.1.0",
@@ -49,16 +46,17 @@
     "exit-hook": "^4.0.0",
     "fs-extra": "^11.1.0",
     "picocolors": "^1.0.0",
-    "prettier": "^3.2.4",
     "read-pkg-up": "^11.0.0",
     "semiver": "^1.1.0"
   },
   "devDependencies": {
     "@types/chance": "^1.1.6",
     "@types/fs-extra": "^11.0.4",
-    "eslint": "^8.56.0",
     "rimraf": "^5.0.5",
     "ts-morph": "^23.0.0"
   },
-  "gitHead": "03c3432540f82a9d81f05087d1ccc57b547e37a9"
+  "engines": {
+    "node": ">=22"
+  },
+  "gitHead": "dfbefe2c66877ed9411bdb242327e6915f58cf3e"
 }

package/src/index.test.ts

@@ -0,0 +1,75 @@
+import { vi } from 'vitest';
+import { generateTypings } from './index.js';
+
+vi.mock('@jungvonmatt/contentful-config', () => ({
+  loadContentfulConfig: vi.fn().mockResolvedValue({
+    config: {
+      managementToken: 'mt',
+      environmentId: 'master',
+      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({}),
+    pagedGet: vi.fn().mockResolvedValue({
+      items: [
+        {
+          sys: { id: 'page', type: 'ContentType' },
+          name: 'Page',
+          displayField: 'title',
+          description: '',
+          fields: [
+            {
+              id: 'title',
+              name: 'Title',
+              type: 'Symbol',
+              required: true,
+              localized: false,
+              omitted: false,
+              disabled: false,
+              validations: [],
+            },
+          ],
+        },
+      ],
+    }),
+  };
+});
+
+vi.mock('read-pkg-up', () => ({
+  readPackageUp: vi.fn().mockResolvedValue({
+    packageJson: { name: 'contentful', version: '10.5.0' },
+  }),
+}));
+
+describe('generateTypings', () => {
+  test('renders V10 skeleton types by default', async () => {
+    console.log = vi.fn();
+    const out = await generateTypings({});
+    expect(out).toContain('Page');
+    expect(out).toContain('Skeleton');
+  });
+
+  test('legacy: true forces DefaultContentTypeRenderer', async () => {
+    console.log = vi.fn();
+    const out = await generateTypings({ legacy: true });
+    expect(out).toContain('Page');
+  });
+
+  test('typeguard option emits guards', async () => {
+    console.log = vi.fn();
+    const out = await generateTypings({ typeguard: true });
+    expect(out).toContain('export function isPage');
+  });
+
+  test('jsdoc + localized options work together', async () => {
+    console.log = vi.fn();
+    const out = await generateTypings({ jsdoc: true, localized: true });
+    expect(out).toContain('Page');
+  });
+});

package/src/renderer/context.ts

@@ -5,7 +5,7 @@ import {
   type RenderContext,
 } from 'cf-content-types-generator';
 
-export const moduleName = (name: string) => `${pascalCase(name)}`;
+export const moduleName = (name: string) => pascalCase(name);
 export const moduleFieldsName = (name: string) => `${moduleName(name)}Fields`;
 export const moduleSkeletonName = (name: string): string => `${moduleName(name)}Skeleton`;
 export const context: RenderContext = {

package/src/renderer/renderer.test.ts

@@ -0,0 +1,102 @@
+import { CFDefinitionsBuilder, type CFContentType } from 'cf-content-types-generator';
+import { moduleName, moduleFieldsName, moduleSkeletonName } from './context.js';
+import { DefaultContentTypeRenderer, V10ContentTypeRenderer } from './contentTypeRenderer.js';
+import { JsDocRenderer } from './jsDocRenderer.js';
+import { LocalizedContentTypeRenderer } from './localizedContentRenderer.js';
+import { TypeGuardRenderer, V10TypeGuardRenderer } from './typeGuardRenderer.js';
+
+const contentType: CFContentType = {
+  sys: { id: 'page-block', type: 'ContentType' } as CFContentType['sys'],
+  name: 'Page Block',
+  displayField: 'title',
+  description: '',
+  fields: [
+    {
+      id: 'title',
+      name: 'Title',
+      type: 'Symbol',
+      required: true,
+      localized: false,
+      omitted: false,
+      disabled: false,
+      validations: [],
+    },
+  ],
+};
+
+describe('renderer/context', () => {
+  test('moduleName converts to pascal case', () => {
+    expect(moduleName('page-block')).toBe('PageBlock');
+    expect(moduleName('hero_section')).toBe('HeroSection');
+  });
+
+  test('moduleFieldsName appends Fields', () => {
+    expect(moduleFieldsName('page-block')).toBe('PageBlockFields');
+  });
+
+  test('moduleSkeletonName appends Skeleton', () => {
+    expect(moduleSkeletonName('page-block')).toBe('PageBlockSkeleton');
+  });
+});
+
+describe('renderer/contentTypeRenderer', () => {
+  test('DefaultContentTypeRenderer produces interfaces with PascalCase id', () => {
+    const builder = new CFDefinitionsBuilder([new DefaultContentTypeRenderer()]);
+    builder.appendType(contentType);
+    const out = builder.toString();
+    expect(out).toContain('PageBlock');
+  });
+
+  test('V10ContentTypeRenderer produces skeleton types', () => {
+    const builder = new CFDefinitionsBuilder([new V10ContentTypeRenderer()]);
+    builder.appendType(contentType);
+    const out = builder.toString();
+    expect(out).toContain('PageBlock');
+    expect(out).toContain('Skeleton');
+  });
+});
+
+describe('renderer/jsDocRenderer', () => {
+  test('emits JSDoc comments referencing Pascal cased name', () => {
+    const builder = new CFDefinitionsBuilder([new V10ContentTypeRenderer(), new JsDocRenderer()]);
+    builder.appendType(contentType);
+    const out = builder.toString();
+    expect(out).toMatch(/\/\*\*[\s\S]*PageBlock/);
+  });
+});
+
+describe('renderer/localizedContentRenderer', () => {
+  test('emits localized type when included', () => {
+    const builder = new CFDefinitionsBuilder([
+      new V10ContentTypeRenderer(),
+      new LocalizedContentTypeRenderer(),
+    ]);
+    builder.appendType(contentType);
+    const out = builder.toString();
+    expect(out).toContain('Localized');
+  });
+});
+
+describe('renderer/typeGuardRenderer', () => {
+  test('TypeGuardRenderer emits isPageBlock guard', () => {
+    const builder = new CFDefinitionsBuilder([
+      new DefaultContentTypeRenderer(),
+      new TypeGuardRenderer(),
+    ]);
+    builder.appendType(contentType);
+    const out = builder.toString();
+    expect(out).toContain('export function isPageBlock');
+    expect(out).toContain("entry.sys.contentType.sys.id === 'page-block'");
+  });
+
+  test('V10TypeGuardRenderer emits skeleton-aware guard', () => {
+    const builder = new CFDefinitionsBuilder([
+      new V10ContentTypeRenderer(),
+      new V10TypeGuardRenderer(),
+    ]);
+    builder.appendType(contentType);
+    const out = builder.toString();
+    expect(out).toContain('export function isPageBlock');
+    expect(out).toContain('ChainModifiers');
+  });
+});