flag based approach for referenced entries

jest.config.js

@@ -1,12 +1,9 @@
 module.exports = {
-  "roots": [
-    "<rootDir>"
-  ],
-  "testMatch": [
-    "**/tests/**/*.+(ts|tsx)",
-    "**/?(*.)+(spec|test).+(ts|tsx)"
-  ],
-  "transform": {
-    "^.+\\.(ts|tsx)$": "ts-jest"
+  preset: "ts-jest",
+  testEnvironment: "node",
+  roots: ["<rootDir>"],
+  testMatch: ["**/tests/**/*.+(ts|tsx)", "**/?(*.)+(spec|test).+(ts|tsx)"],
+  transform: {
+    "^.+\\.(ts|tsx)$": "ts-jest",
   },
-}
+};

package.json

@@ -1,7 +1,7 @@
 {
   "name": "contentstack-cli-tsgen",
   "description": "Generate TypeScript typings from a Stack.",
-  "version": "4.4.0",
+  "version": "4.5.0",
   "author": "Michael Davis",
   "bugs": "https://github.com/Contentstack-Solutions/contentstack-cli-tsgen/issues",
   "dependencies": {
@@ -14,7 +14,7 @@
     "@oclif/plugin-help": "^6.2.27",
     "@oclif/test": "^4.1.12",
     "@types/jest": "^29.5.14",
-    "@types/node": "^22.14.0",
+    "@types/node": "^22.17.1",
     "@typescript-eslint/eslint-plugin": "^8.29.1",
     "@typescript-eslint/parser": "^8.29.1",
     "eslint": "^8.57.0",

src/commands/tsgen.ts

@@ -25,6 +25,7 @@
     '$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts"',
     '$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" -p "I"',
     '$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" --no-doc',
+    '$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" --include-referenced-entry',
     '$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" --api-type graphql',
     '$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" --api-type graphql --namespace "GraphQL" ',
   ];
@@ -92,6 +93,13 @@
       default: false,
     }),
 
+    "include-referenced-entry": flags.boolean({
+      description:
+        "Includes the ReferencedEntry interface in generated types. Use this option to add a generic interface for handling referenced entries when the exact content type is unknown or when you need a flexible reference type",
+      default: false,
+      allowNo: true,
+    }),
+
     "api-type": flags.string({
       default: "rest",
       multiple: false,
@@ -117,6 +125,7 @@
       const branch = flags.branch;
       const includeSystemFields = flags["include-system-fields"];
       const includeEditableTags = flags["include-editable-tags"];
+      const includeReferencedEntry = flags["include-referenced-entry"];
       const namespace = flags.namespace;
 
       const outputPath = createOutputPath(filePath);
@@ -200,6 +209,7 @@
             prefix,
             systemFields: includeSystemFields,
             isEditableTags: includeEditableTags,
+            includeReferencedEntry,
           });
 
           fs.writeFileSync(outputPath, result || "");

tsconfig.json

@@ -3,14 +3,16 @@
     "declaration": true,
     "importHelpers": true,
     "module": "commonjs",
+    "moduleResolution": "node",
     "outDir": "lib",
-    "rootDir": "src",
     "strict": true,
     "target": "es2017",
     "skipLibCheck": true,
     "resolveJsonModule": true,
+    "types": ["node", "jest"]
   },
   "include": [
-    "src/**/*"
+    "src/**/*",
+    "tests/**/*"
   ]
 }