VE-2647-merge-v2-v3

.eslintrc.js → .eslintrc.cjs

@@ -22,8 +22,10 @@ module.exports = {
         "@typescript-eslint/no-this-alias": 0,
         "@typescript-eslint/ban-ts-comment": 0,
         "prefer-rest-params": 0,
-        // warn for unused vars but not for unused funciton params prefixed with _
-        "@typescript-eslint/no-unused-vars": ["warn", { argsIgnorePattern: "^_" }],
+        "@typescript-eslint/no-unused-vars": [
+            "warn",
+            { argsIgnorePattern: "^_" },
+        ],
         "@typescript-eslint/no-empty-function": 0,
     },
-};
+};

.github/workflows/jira.yml

@@ -3,7 +3,7 @@ on:
   pull_request:
     types: [opened]
 jobs:
-  security:
+  security-jira:
     if: ${{ github.actor == 'dependabot[bot]' || github.actor == 'snyk-bot' || contains(github.event.pull_request.head.ref, 'snyk-fix-')  || contains(github.event.pull_request.head.ref, 'snyk-upgrade-')}}
     runs-on: ubuntu-latest
     steps:
@@ -26,3 +26,8 @@ jobs:
             PR: ${{ github.event.pull_request.html_url }}
 
           fields: "${{ secrets.JIRA_FIELDS }}"
+      - name: Transition issue
+        uses: atlassian/gajira-transition@v3
+        with:
+          issue: ${{ steps.create.outputs.issue }}
+          transition: ${{ secrets.JIRA_TRANSITION }}

.github/workflows/sast-scan.yml

@@ -0,0 +1,11 @@
+name: SAST Scan
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  security-sast:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Semgrep Scan
+        run: docker run -v /var/run/docker.sock:/var/run/docker.sock -v "${PWD}:/src" returntocorp/semgrep semgrep scan --config auto

.github/workflows/sca-scan.yml

@@ -3,7 +3,7 @@ on:
   pull_request:
     types: [opened, synchronize, reopened]
 jobs:
-  security:
+  security-sca:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@master

.husky/pre-commit

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-npx ts-node mustache.ts
+npx ts-node --esm mustache.ts
 git add .
-npx lint-staged
+npx lint-staged

.husky/pre-push

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-npm test
+npm test

.prettierrc.json

@@ -0,0 +1,8 @@
+{
+    "trailingComma": "es5",
+    "tabWidth": 4,
+    "semi": true,
+    "singleQuote": false,
+    "useTabs": false,
+    "bracketSpacing": true
+}

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021-2023 Contentstack
+Copyright (c) 2021-2024 Contentstack
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -15,8 +15,19 @@ npm install @contentstack/live-preview-utils
 Alternatively, if you want to include the package directly in your website HTML code, use the following command:
 
 ```html
-<script src="https://unpkg.com/@contentstack/[email protected]/dist/index.js"></script>
+<script type='module'>
+     import ContentstackLivePreview from 'https://esm.sh/@contentstack/[email protected]';
+
+     ContentstackLivePreview.init({
+        stackDetails: {
+            apiKey: "your-stack-api-key",
+        },
+    });
+</script>
 ```
+> [!NOTE]
+> This step involves incorporating the package into your HTML code and initializing it, eliminating the need for re-initialization in the subsequent step.
+
 
 # Initializing the SDK
 
@@ -35,33 +46,12 @@ ContentstackLivePreview.init({
 });
 ```
 
-Alternatively, if you want to initialize the SDK directly inside the HTML tag, use the ContentstackLivePreview.init() method as follows:
-
-```html
-<script>
-    ContentstackLivePreview.init({
-        stackDetails: {
-            apiKey: "your-stack-api-key",
-        },
-    });
-</script>
-```
-
-# [Live Editing](https://www.contentstack.com/docs/developers/set-up-live-preview/set-up-live-preview-for-your-website/#live-editing-for-entries-optional-)
-
-Live Preview provides edit tags that allow you to edit your content in real-time. Live edit tags are identified as the data-cslp attribute within the HTML tags. The styles for the live edit tags are available in the @contentstack/live-preview-utils/dist/main.css file.
-
-To use live edit tags within your stack, you need to include them in your main index.js file as follows:
-
-```javascript
-import "@contentstack/live-preview-utils/dist/main.css";
-```
 
 # License
 
 MIT License
 
-Copyright © 2021 [Contentstack](https://www.contentstack.com/). All Rights Reserved
+Copyright © 2024 [Contentstack](https://www.contentstack.com/). All Rights Reserved
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

jest.config.js → jest.config.cjs

@@ -1,20 +1,17 @@
 module.exports = {
+    testEnvironment: "jsdom",
     roots: ["<rootDir>/src"],
     testMatch: [
         "**/__tests__/**/*.+(ts|tsx|js)",
         "**/?(*.)+(spec|test).+(ts|tsx|js)",
     ],
     automock: false,
     setupFiles: ["<rootDir>/setupJest.ts"],
-    testEnvironment: "jsdom",
-    transform: {
-        "^.+\\.tsx$": "babel-jest",
-        "^.+\\.ts$": "ts-jest",
+    preset: "ts-jest",
+    moduleNameMapper: {
+        uuid: require.resolve("uuid"),
     },
     coveragePathIgnorePatterns: ["__test__/"],
     collectCoverage: true,
     coverageReporters: ["html"],
-    moduleNameMapper: {
-        "^lodash-es$": "lodash",
-    },
-};
+};

main.mustache

@@ -15,8 +15,19 @@ npm install @contentstack/live-preview-utils
 Alternatively, if you want to include the package directly in your website HTML code, use the following command:
 
 ```html
-<script src="https://unpkg.com/@contentstack/live-preview-utils@{{packageVersion}}/dist/index.js"></script>
+<script type='module'>
+     import ContentstackLivePreview from 'https://esm.sh/@contentstack/live-preview-utils@{{packageVersion}}';
+
+     ContentstackLivePreview.init({
+        stackDetails: {
+            apiKey: "your-stack-api-key",
+        },
+    });
+</script>
 ```
+> [!NOTE]
+> This step involves incorporating the package into your HTML code and initializing it, eliminating the need for re-initialization in the subsequent step.
+
 
 # Initializing the SDK
 
@@ -35,33 +46,12 @@ ContentstackLivePreview.init({
 });
 ```
 
-Alternatively, if you want to initialize the SDK directly inside the HTML tag, use the ContentstackLivePreview.init() method as follows:
-
-```html
-<script>
-    ContentstackLivePreview.init({
-        stackDetails: {
-            apiKey: "your-stack-api-key",
-        },
-    });
-</script>
-```
-
-# [Live Editing](https://www.contentstack.com/docs/developers/set-up-live-preview/set-up-live-preview-for-your-website/#live-editing-for-entries-optional-)
-
-Live Preview provides edit tags that allow you to edit your content in real-time. Live edit tags are identified as the data-cslp attribute within the HTML tags. The styles for the live edit tags are available in the @contentstack/live-preview-utils/dist/main.css file.
-
-To use live edit tags within your stack, you need to include them in your main index.js file as follows:
-
-```javascript
-import "@contentstack/live-preview-utils/dist/main.css";
-```
 
 # License
 
 MIT License
 
-Copyright © 2021 [Contentstack](https://www.contentstack.com/). All Rights Reserved
+Copyright © 2024 [Contentstack](https://www.contentstack.com/). All Rights Reserved
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

mustache.ts

@@ -1,8 +1,8 @@
 // index.js
 // import { render } from 'mustache';
-import {render} from 'mustache';
+import * as mustache from 'mustache';
 import { readFile, writeFileSync } from 'fs';
-import packageJson from "./package.json";
+import packageJson from "./package.json" assert { type: "json" };
 const MUSTACHE_MAIN_DIR = './main.mustache';
 /**
   * DATA is the object that contains all
@@ -15,7 +15,7 @@ const DATA = {
 function generateReadMe() {
   readFile(MUSTACHE_MAIN_DIR, (err, data) =>  {
     if (err) throw err;
-    const output = render(data.toString(), DATA);
+    const output = mustache.default.render(data.toString(), DATA);
     writeFileSync('README.md', output);
   });
 }