Merge branch 'staging' into fix/upgrade-types-gen-package

Author: harshithad0703

.github/workflows/policy-scan.yml

@@ -24,4 +24,23 @@ jobs:
       - uses: actions/checkout@master
       - name: Checks for License file
         run: |
-          if ! [[ -f "LICENSE" || -f "License.txt" || -f "LICENSE.md" ]]; then exit 1; fi
+          expected_license_files=("LICENSE" "LICENSE.txt" "LICENSE.md" "License.txt")
+          license_file_found=false
+          current_year=$(date +"%Y")
+
+          for license_file in "${expected_license_files[@]}"; do
+              if  [ -f "$license_file" ]; then
+                 license_file_found=true
+                 # check the license file for the current year, if not exists, exit with error
+                  if  ! grep -q "$current_year" "$license_file"; then
+                      echo "License file $license_file does not contain the current year."
+                      exit 2
+                  fi
+                  break
+              fi        
+          done
+
+          if [ "$license_file_found" = false ]; then
+              echo "No license file found. Please add a license file to the repository."
+              exit 1
+          fi

.github/workflows/secrets-scan.yml

@@ -0,0 +1,29 @@
+name: Secrets Scan
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  security-secrets:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: '2'
+          ref: '${{ github.event.pull_request.head.ref }}'
+      - run: |
+          git reset --soft HEAD~1
+      - name: Install Talisman
+        run: |
+          # Download Talisman
+          wget https://github.com/thoughtworks/talisman/releases/download/v1.37.0/talisman_linux_amd64 -O talisman
+
+          # Checksum verification
+          checksum=$(sha256sum ./talisman | awk '{print $1}')
+          if [ "$checksum" != "8e0ae8bb7b160bf10c4fa1448beb04a32a35e63505b3dddff74a092bccaaa7e4" ]; then exit 1; fi  
+
+          # Make it executable
+          chmod +x talisman
+      - name: Run talisman
+        run: |
+          # Run Talisman with the pre-commit hook
+          ./talisman --githook pre-commit

.talismanrc

@@ -1,6 +1,9 @@
 fileignoreconfig:
-- filename: lib/commands/tsgen.js
-  checksum: 02bab20fef5508565dbf38b5c12192c48ec27249b89d48c70303abaae17984ce
-- filename: package-lock.json
-  checksum: f69fb633369ac69c08b707b17c96fffb89198944fae8d6f6bcf590bda960f26a
+  - filename: .github/workflows/secrets-scan.yml
+    ignore_detectors:
+      - filecontent
+  - filename: lib/commands/tsgen.js
+    checksum: 02bab20fef5508565dbf38b5c12192c48ec27249b89d48c70303abaae17984ce
+  - filename: package-lock.json
+    checksum: e7ea94799c4afab6e55935c79ac40d3cac38e2ce6e9882dbd4c2e5a3c551e087
 version: "1.0"

MIGRATION.md

@@ -1,7 +1,61 @@
+## Migrating from v3 to v4
+
+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;
+}
+```
+
+---
+
 ## Migrating from v2 to v3
+
 This document outlines the necessary changes to separate nested modular blocks into distinct interfaces. This update will affect how modular blocks are structured and used throughout the codebase.
 
-## Before 
+## Before
+
 ```typescript
 export interface Test {
   /** Version */
@@ -27,8 +81,8 @@ export interface Test {
 }
 ```
 
-
 ## After
+
 ```typescript
 export interface Test {
   /** Version */
@@ -39,7 +93,6 @@ export interface Test {
   modular_blocks?: ModularBlocks[];
 }
 
-
 export interface ModularBlocks {
   /** Multi Line Textbox */
   multi_line?: string;
@@ -53,4 +106,4 @@ export interface ModularBlocks1 {
   /** Multi Line Textbox */
   multi_line?: string;
 }
-```
+```