[DX-2968], added support for CSLP tags

.talismanrc

@@ -6,4 +6,10 @@ fileignoreconfig:
     checksum: 7ca77c023135dd0b7cf06a754dac82689f5a024141e444eadc04c840169bb4d1
   - filename: .husky/pre-commit
     checksum: 5baabd7d2c391648163f9371f0e5e9484f8fb90fa2284cfc378732ec3192c193
+  - filename: src/generateTS/factory.ts
+    checksum: 0a693ed8cc35d373f3c88d2ca6b538648d2594e83c495e841546c161e419c8fe
+  - filename: tests/integration/generateTS/generateTS.test.ts
+    checksum: 328090da57e8cb2dd616091f3336b6da77a253f97ddfd47e3e1dd683260e58eb
+  - filename: src/generateTS/shared/cslp-helpers.ts
+    checksum: 55aa5c0c9ec0cd6c6139d4e9e4f1666abc7bc083313ccc2bf410c56935f35ef2
 version: "1.0"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/types-generator",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Contentstack type definition generation library",
   "private": false,
   "author": "Contentstack",

src/generateTS/factory.ts

@@ -2,13 +2,15 @@ import { DocumentationGenerator } from "./docgen/doc";
 import NullDocumentationGenerator from "./docgen/nulldoc";
 import * as ContentstackTypes from "../types/schema";
 import * as _ from "lodash";
+import { CSLP_HELPERS } from "./shared/cslp-helpers";
 
 export type TSGenOptions = {
   docgen: DocumentationGenerator;
   naming?: {
     prefix: string;
   };
   systemFields?: boolean;
+  isEditableTags?: boolean;
 };
 
 export type TSGenResult = {
@@ -60,6 +62,7 @@ const defaultOptions: TSGenOptions = {
     prefix: "",
   },
   systemFields: false,
+  isEditableTags: false,
 };
 
 export default function (userOptions: TSGenOptions) {
@@ -251,13 +254,30 @@ export default function (userOptions: TSGenOptions) {
   }
 
   function visit_fields(schema: ContentstackTypes.Schema) {
-    return schema
-      .map((v) => {
-        return [options.docgen.field(v.display_name), visit_field(v)]
-          .filter((v) => v)
-          .join("\n");
-      })
-      .join("\n");
+    const fieldLines: string[] = [];
+    const dollarKeys: string[] = [];
+
+    for (const field of schema) {
+      const line = [
+        options.docgen.field(field.display_name),
+        visit_field(field),
+      ]
+        .filter((v) => v)
+        .join("\n");
+
+      fieldLines.push(line);
+      dollarKeys.push(CSLP_HELPERS.createFieldMapping(field.uid));
+    }
+
+    // If editableTags is enabled, add the $ field
+    if (options.isEditableTags) {
+      fieldLines.push(
+        `\n${CSLP_HELPERS.FIELD_COMMENT}`,
+        CSLP_HELPERS.createMappingBlock(dollarKeys)
+      );
+    }
+
+    return fieldLines.join("\n");
   }
 
   function visit_content_type(