Merge pull request #47 from Contentstack-Solutions/staging

Merge staging to master

Author: antonyagustine

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "contentstack-cli-tsgen",
   "description": "Generate TypeScript typings from a Stack.",
-  "version": "2.1.6",
+  "version": "2.1.7",
   "author": "Michael Davis",
   "bugs": "https://github.com/Contentstack-Solutions/contentstack-cli-tsgen/issues",
   "dependencies": {
@@ -58,5 +58,10 @@
     "prepack": "rm -rf lib && tsc -b && oclif manifest && oclif readme",
     "test": "jest",
     "version": "oclif readme && git add README.md"
+  },
+  "csdxConfig": {
+    "shortCommandName": {
+      "tsgen": "TSGEN"
+    }
   }
 }

package.json

@@ -27,6 +27,7 @@ export type Block = {
 export type GlobalField = {
   reference_to: string;
   schema: Schema;
+  _version?: number
 } & FieldOptions;
 
 export type ReferenceField = {

src/lib/stack/schema.ts

@@ -228,6 +228,8 @@ export default function (userOptions: TSGenOptions) {
       options.docgen.interface(contentType.description),
       define_interface(contentType),
       '{',
+      ['/**', "Version", '*/'].join(' '),
+      [`version: `,contentType._version,';'].join(' '),
       visit_fields(contentType.schema),
       '}',
     ]

src/lib/tsgen/factory.ts

@@ -24,6 +24,8 @@ describe('builtin boolean field', () => {
     expect(result.definition).toMatchInlineSnapshot(`
       "export interface IBoolean
       {
+      /** Version */
+      version:  2 ;
       title: string;
       boolean?: boolean;
       }"

tests/tsgen/boolean.test.ts

@@ -17,6 +17,8 @@ describe('default single content block', () => {
     expect(result.definition).toMatchInlineSnapshot(`
       "export interface IMetadataSingleContentBlock
       {
+      /** Version */
+      version:  2 ;
       title: string;
       }"
     `)
@@ -41,6 +43,8 @@ describe('default single webpage', () => {
     expect(result.definition).toMatchInlineSnapshot(`
       "export interface IMetadataSingleWebpage
       {
+      /** Version */
+      version:  2 ;
       title: string;
       url: string;
       }"

tests/tsgen/defaults.test.ts

@@ -24,6 +24,8 @@ describe('global fields', () => {
     expect(globalField.definition).toMatchInlineSnapshot(`
       "export interface ISeo
       {
+      /** Version */
+      version:   ;
       keywords?: string;
       description?: string;
       }"
@@ -34,6 +36,8 @@ describe('global fields', () => {
     expect(result.definition).toMatchInlineSnapshot(`
       "export interface IGlobalFields
       {
+      /** Version */
+      version:  2 ;
       title: string;
       seo?: ISeo;
       }"

tests/tsgen/global.fields.test.ts

@@ -23,6 +23,8 @@ describe('group', () => {
     expect(result.definition).toMatchInlineSnapshot(`
       "export interface Group
       {
+      /** Version */
+      version:  3 ;
       title: string;
       multiple_group_max_limit?: [{
       number?: number;

tests/tsgen/group.test.ts

@@ -24,6 +24,8 @@ describe('builtin isodate field', () => {
     expect(result.definition).toMatchInlineSnapshot(`
       "export interface Isodate
       {
+      /** Version */
+      version:  2 ;
       title: string;
       date?: string;
       date_required: string;

tests/tsgen/isodate.test.ts

@@ -15,6 +15,8 @@ describe('jsdoc', () => {
       "/** Content Type Description */
       export interface Jsdoc
       {
+      /** Version */
+      version:  3 ;
       /** Name */
       title: string;
       /** Age */