Added sample for Selective Tools Registration in TS DOCX Editor WebMCP

Author: suriyaprakasamr

webmcp/selective-tools-registration/.gitignore

@@ -0,0 +1,2 @@
+dist/
+node_modules/

webmcp/selective-tools-registration/e2e/index.spec.js

@@ -0,0 +1,21 @@
+exports.config = {
+
+    allScriptsTimeout: 11000,
+
+    capabilities: {
+        'browserName': 'chrome'
+    },
+
+    framework: 'jasmine',
+
+    jasmineNodeOpts: {
+        defaultTimeoutInterval: 10000
+    },
+    directConnect: true,
+
+    onPrepare: function() {
+        browser.waitForAngularEnabled(false);
+    },
+
+    specs: ['./*.spec.js']
+};

webmcp/selective-tools-registration/e2e/protractor.conf.js

@@ -0,0 +1,62 @@
+'use strict';
+
+var gulp = require('gulp');
+
+/** 
+ * Compile TypeScript to JS
+ */
+gulp.task('compile', function (done) {
+    var webpack = require('webpack');
+    var webpackStream = require('webpack-stream');
+    gulp.src(['./src/app/app.ts']).pipe(webpackStream({
+        config: require('./webpack.config.js')
+    }, webpack))
+        .pipe(gulp.dest('./dist'))
+        .on('end', function () {
+            done();
+        });
+});
+
+/**
+ * Testing spec files
+ */
+var protractor = require('gulp-protractor').protractor;
+var webdriver_standalone = require('gulp-protractor').webdriver_standalone;
+var webdriver_update = require('gulp-protractor').webdriver_update_specific;
+
+gulp.task('e2e-serve', webdriver_standalone);
+
+gulp.task('e2e-webdriver-update', webdriver_update({
+    webdriverManagerArgs: ['--ie', '--edge']
+}));
+
+gulp.task('e2e-test', gulp.series('compile', function (done) {
+    var browserSync = require('browser-sync');
+    var bs = browserSync.create('Essential JS 2');
+    var options = {
+        server: {
+            baseDir: [
+                './dist/',
+            ],
+            directory: true
+        },
+        ui: false,
+        open: false,
+        notify: false
+    };
+    bs.init(options, function () {
+        gulp.src(['./spec/**/*.spec.js'])
+            .pipe(protractor({
+                configFile: 'e2e/protractor.conf.js'
+            }))
+            .on('error', function (e) {
+                console.error('Error: ' + e.message);
+                done();
+                process.exit(1);
+            })
+            .on('end', function () {
+                done();
+                process.exit(0);
+            });
+    });
+}));

webmcp/selective-tools-registration/gulpfile.js

@@ -0,0 +1,10 @@
+Essential JS 2 library is available under the Syncfusion Essential Studio program,  and can be licensed either under the Syncfusion Community License Program or the Syncfusion commercial license.
+
+To be qualified for the Syncfusion Community License Program you must have a gross revenue of less than one (1) million U.S. dollars ($1,000,000.00 USD) per year and have less than five (5) developers in your organization, and agree to be bound by Syncfusion’s terms and conditions. 
+
+Customers who do not qualify for the community license can contact sales@syncfusion.com for commercial licensing options.
+
+Under no circumstances can you use this product without (1) either a Community License or a commercial license and (2) without agreeing and abiding by Syncfusion’s license containing all terms and conditions. 
+
+The Syncfusion license that contains the terms and conditions can be found at 
+https://www.syncfusion.com/content/downloads/syncfusion_license.pdf

webmcp/selective-tools-registration/license

@@ -0,0 +1,41 @@
+{
+  "name": "ej2-quickstart",
+  "version": "0.0.1",
+  "description": "Essential JS 2 typescript quick start application",
+  "author": "Syncfusion Inc.",
+  "license": "SEE LICENSE IN license",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/syncfusion/ej2-quickstart.git"
+  },
+  "scripts": {
+    "start": "webpack serve --mode development",
+    "build": "webpack --mode production",
+    "serve": "gulp e2e-serve",
+    "test": "gulp e2e-test",
+    "update-webdriver": "gulp e2e-webdriver-update"
+  },
+  "devDependencies": {
+    "ajv": "^8.11.2",
+    "browser-sync": "^2.18.12",
+    "css-loader": "^6.7.2",
+    "esbuild": "^0.28.1",
+    "esbuild-loader": "^4.5.0",
+    "gulp": "*",
+    "gulp-protractor": "*",
+    "gulp-typescript": "*",
+    "html-webpack-plugin": "^5.5.0",
+    "jasmine": "^2.6.0",
+    "mini-css-extract-plugin": "^2.7.0",
+    "typescript": "*",
+    "webpack": "^5.75.0",
+    "webpack-cli": "^5.0.0",
+    "webpack-dev-server": "^5.2.1",
+    "webpack-stream": "^7.0.0"
+  },
+  "dependencies": {
+    "@syncfusion/ej2": "*",
+    "@syncfusion/ej2-documenteditor": "*",
+    "@syncfusion/ej2-tailwind3-theme": "*"
+  }
+}

webmcp/selective-tools-registration/package.json

@@ -0,0 +1,26 @@
+import { DocumentEditorContainer, Toolbar, Ribbon, WebMcpDocumentEditor } from '@syncfusion/ej2-documenteditor';
+
+// Inject required modules
+DocumentEditorContainer.Inject(Toolbar, Ribbon, WebMcpDocumentEditor);
+
+// Initialize DocumentEditorContainer with WebMCP enabled
+let webMcpSettings: any = {
+        name: 'container',
+        tools: [ 'getDocumentBookmarks', 'getSelectionText', 'find', 'findAll', 'goToPage' ] //Register only with needed tools
+    };
+
+let container: DocumentEditorContainer = new DocumentEditorContainer({
+    height: '590px',
+    enableWebMcp: true,
+    webMcpSettings: webMcpSettings, // Enable WebMCP tools
+    toolbarMode: 'Ribbon'
+});
+
+// Set service URL for document operations
+container.serviceUrl = 'https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/';
+
+// Append to container element
+container.appendTo('#container');
+
+// Update document title
+document.title = 'WebMCP Tool Demo - DocumentEditorContainer';

webmcp/selective-tools-registration/src/app/app.ts

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <title>DOCXEditor_WebMcp</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no" />
+    <meta name="description" content="Essential JS 2" />
+    <meta name="author" content="Syncfusion" />
+    <link rel="shortcut icon" href="resources/favicon.ico" />
+    <link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
+</head>
+
+<body>
+    <div id="container"></div>
+</body>
+
+</html>

webmcp/selective-tools-registration/src/index.html

@@ -0,0 +1,2 @@
+@import "../../node_modules/@syncfusion/ej2-tailwind3-theme/styles/document-editor/index.css";
+@import "../../node_modules/@syncfusion/ej2-tailwind3-theme/styles/document-editor-container/index.css";