Feat/plugin builder for rte

.github/workflows/issues-jira.yml

@@ -0,0 +1,31 @@
+name: Create Jira Ticket for Github Issue
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  issue-jira:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Login to Jira
+        uses: atlassian/gajira-login@master
+        env:
+          JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
+          JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
+          JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
+
+      - name: Create Jira Issue
+        id: create_jira
+        uses: atlassian/gajira-create@master
+        with:
+          project: ${{ secrets.JIRA_PROJECT }}
+          issuetype: ${{ secrets.JIRA_ISSUE_TYPE }}
+          summary: Github | Issue | ${{ github.event.repository.name }} | ${{ github.event.issue.title }}
+          description: |
+            *GitHub Issue:* ${{ github.event.issue.html_url }}
+
+            *Description:*
+            ${{ github.event.issue.body }}
+          fields: "${{ secrets.ISSUES_JIRA_FIELDS }}"

.github/workflows/policy-scan.yml

@@ -0,0 +1,46 @@
+name: Checks the security policy and configurations
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  security-policy:
+    if: github.event.repository.visibility == 'public'
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@master
+      - name: Checks for SECURITY.md policy file
+        run: |
+          if ! [[ -f "SECURITY.md" || -f ".github/SECURITY.md" ]]; then exit 1; fi
+  security-license:
+    if: github.event.repository.visibility == 'public'
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@master
+      - name: Checks for License file
+        run: |
+          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

@@ -0,0 +1,5 @@
+fileignoreconfig:
+- filename: .github/workflows/secrets-scan.yml
+  ignore_detectors:
+    - filecontent
+version: "1.0"

src/RTE/index.tsx

@@ -1,10 +1,10 @@
 import {
+    IConfig,
     IConfigCallback,
     IContainerMetaData,
     IOnFunction,
     IPluginMetaData,
     IRteParam,
-    IConfig,
 } from "./types";
 
 export class RTEPlugin {

src/RTE/types.tsx

@@ -1,15 +1,15 @@
 import React, { ReactElement } from "react";
 import {
+    Editor,
+    ElementEntry,
     Location,
+    Node,
     NodeEntry,
+    NodeMatch,
     Path,
     Point,
-    Node,
-    ElementEntry,
-    Transforms,
-    Editor,
     Span,
-    NodeMatch,
+    Transforms,
 } from "slate";
 
 import { RTEPlugin } from "./index";
@@ -199,7 +199,7 @@ export declare interface IRteElementType {
     children: Array<IRteElementType | IRteTextType>;
 }
 
-type IDynamicFunction = (
+export type IDynamicFunction = (
     element: IRteElementType
 ) =>
     | Exclude<IElementTypeOptions, "text">

src/index.ts

@@ -1,8 +1,11 @@
 import postRobot from "post-robot";
 
-import UiLocation from "./uiLocation";
 import { version } from "../package.json";
-import { InitializationData } from "./types";
+import { RTEPlugin } from "./RTE";
+import { IRteParam } from "./RTE/types";
+import { PluginDefinition, registerPlugins,PluginBuilder } from "./rtePlugin";
+import { InitializationData, IRTEInitData } from "./types";
+import UiLocation from "./uiLocation";
 
 postRobot.CONFIG.LOG_LEVEL = "error";
 
@@ -27,7 +30,6 @@ class ContentstackAppSDK {
      * A static variable that stores the instance of {@link UiLocation} class after initialization
      */
     static _uiLocation: UiLocation;
-
     /**
      * Initializes the App SDK and returns an instance of {@link UiLocation} class
      */
@@ -43,6 +45,28 @@ class ContentstackAppSDK {
             .catch((e: Error) => Promise.reject(e));
     }
 
+    /**
+     * Registers RTE plugins with the Contentstack platform.
+     * Contentstack platform loader, providing the `context` (initialization data) and
+     * the `rte` instance. When called, it materializes and returns a map of the
+     * registered `RTEPlugin` instances, keyed by their IDs.
+     */
+    static async registerRTEPlugins(
+        ...pluginDefinitions: PluginDefinition[]
+    ): Promise<{
+        __isPluginBuilder__: boolean;
+        version: string;
+        plugins: (context: IRTEInitData, rte: IRteParam) => Promise<{
+            [key: string]: RTEPlugin;
+        }>;
+    }> {
+        return {
+            __isPluginBuilder__: true,
+            version,
+            plugins: registerPlugins(...pluginDefinitions)
+        };
+    }
+
     /**
      * Version of Contentstack App SDK.
      */
@@ -52,4 +76,5 @@ class ContentstackAppSDK {
 }
 
 export default ContentstackAppSDK;
+export { PluginBuilder };
 module.exports = ContentstackAppSDK;