Merge pull request #79 from contentstack/fix/DX-2403

[DX-2403], Major version bump

Author: harshithad0703

.github/workflows/node.js.yml

@@ -23,7 +23,9 @@ jobs:
         uses: actions/setup-node@v3.7.0
         with:
           node-version: ${{ matrix.node-version }}
-      - run: npm ci
+      - run: | 
+          rm -rf node_modules package-lock.json
+          npm i
       - run: npm test
         env:
           TOKEN: ${{secrets.TOKEN}}

.talismanrc

@@ -3,7 +3,7 @@ fileignoreconfig:
   ignore_detectors:
     - filecontent
 - filename: package-lock.json
-  checksum: c855b257f787ae58c64f68315bfcffaad9910f67a0b797bb7d3b1b7c225aabb4
+  checksum: 5bdaa34571226c6201c3b6fe2ff213180f0ce06b1afbc9565cb89e0562fb74db
 - filename: .husky/pre-commit
   checksum: 5baabd7d2c391648163f9371f0e5e9484f8fb90fa2284cfc378732ec3192c193
 version: "1.0"

MIGRATION.md

@@ -0,0 +1,51 @@
+## Migrating from v2 to v3
+
+This changelog documents a breaking change to the `ISystemFields` interface, specifically related to the `publish_details` field.
+
+
+## What Changed
+
+The `publish_details` field is no longer an array of objects. It is now represented as a single `IPublishDetails` object.
+
+This update aligns the generated types with the actual [Contentstack API](https://www.contentstack.com/docs/developers/apis/content-delivery-api) response.
+
+
+## Before 
+
+```typescript
+export interface ISystemFields {
+  uid?: string;
+  created_at?: string;
+  updated_at?: string;
+  created_by?: string;
+  updated_by?: string;
+  _content_type_uid?: string;
+  tags?: string[];
+  ACL?: any[];
+  _version?: number;
+  _in_progress?: boolean;
+  locale?: string;
+  publish_details?: IPublishDetails[]; // Incorrect: Array of IPublishDetails
+  title?: string;
+}
+```
+
+
+## After 
+```typescript
+export interface ISystemFields {
+  uid?: string;
+  created_at?: string;
+  updated_at?: string;
+  created_by?: string;
+  updated_by?: string;
+  _content_type_uid?: string;
+  tags?: string[];
+  ACL?: any[];
+  _version?: number;
+  _in_progress?: boolean;
+  locale?: string;
+  publish_details?: IPublishDetails; // Corrected: Single IPublishDetails object
+  title?: string;
+}
+```

README.md

@@ -6,6 +6,11 @@ This library helps to generate TypeScript type definition for the content types
 
 `$ npm install @contentstack/types-generator`
 
+
+## Migration
+Refer to the [Migration Guide](https://github.com/contentstack/types-generator/blob/main/MIGRATION.md) version 3 if you are migrating from version 2 or older.
+
+
 ## Usage
 
 ### In NodeJs