@cplace/test-mcp-server 1.0.0 → 1.1.0

package/dist/widget-specifications/index.js

@@ -0,0 +1,55 @@
+import { readFileSync, readdirSync } from 'fs';
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+function loadWidgetSpecifications() {
+    const specs = {};
+    try {
+        const entries = readdirSync(__dirname, { withFileTypes: true });
+        const widgetKindDirs = entries.filter(d => d.isDirectory());
+        for (const dir of widgetKindDirs) {
+            const widgetKind = dir.name;
+            const widgetDir = join(__dirname, widgetKind);
+            specs[widgetKind] = {};
+            const files = readdirSync(widgetDir);
+            const mdFiles = files.filter(f => f.endsWith('.md'));
+            for (const mdFile of mdFiles) {
+                const attrShortName = mdFile.replace('.md', '');
+                try {
+                    const content = readFileSync(join(widgetDir, mdFile), 'utf8');
+                    if (attrShortName === '_summary') {
+                        specs[widgetKind]['_summary'] = content;
+                    }
+                    else if (attrShortName === '_overview') {
+                        specs[widgetKind]['_overview'] = content;
+                    }
+                    else if (attrShortName === '_implementation') {
+                        specs[widgetKind]['_implementation'] = content;
+                    }
+                    else {
+                        const fullAttrName = `${widgetKind}.${attrShortName}`;
+                        specs[widgetKind][fullAttrName] = content;
+                    }
+                }
+                catch (error) {
+                    console.error(`Warning: Could not read widget specification ${widgetDir}/${mdFile}:`, error);
+                }
+            }
+            const metaPath = join(widgetDir, '_meta.json');
+            try {
+                const metaContent = readFileSync(metaPath, 'utf8');
+                const metaData = JSON.parse(metaContent);
+                specs[widgetKind]['_meta'] = metaData;
+            }
+            catch {
+            }
+        }
+    }
+    catch (error) {
+        console.error('Warning: Could not load widget specifications:', error);
+    }
+    return specs;
+}
+export const WIDGET_SPECIFICATIONS = loadWidgetSpecifications();
+//# sourceMappingURL=index.js.map

package/dist/widget-specifications/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/widget-specifications/index.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAErC,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AA6BtC,SAAS,wBAAwB;IAC/B,MAAM,KAAK,GAAyB,EAAE,CAAC;IAEvC,IAAI,CAAC;QAEH,MAAM,OAAO,GAAG,WAAW,CAAC,SAAS,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QAChE,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAE5D,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;YACjC,MAAM,UAAU,GAAG,GAAG,CAAC,IAAI,CAAC;YAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAC9C,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;YAGvB,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;YACrC,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;YAErD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBAEhD,IAAI,CAAC;oBACH,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;oBAG9D,IAAI,aAAa,KAAK,UAAU,EAAE,CAAC;wBAEjC,KAAK,CAAC,UAAU,CAAC,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;oBAC1C,CAAC;yBAAM,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;wBAEzC,KAAK,CAAC,UAAU,CAAC,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC;oBAC3C,CAAC;yBAAM,IAAI,aAAa,KAAK,iBAAiB,EAAE,CAAC;wBAE/C,KAAK,CAAC,UAAU,CAAC,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC;oBACjD,CAAC;yBAAM,CAAC;wBAEN,MAAM,YAAY,GAAG,GAAG,UAAU,IAAI,aAAa,EAAE,CAAC;wBACtD,KAAK,CAAC,UAAU,CAAC,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC;oBAC5C,CAAC;gBACH,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,OAAO,CAAC,KAAK,CAAC,gDAAgD,SAAS,IAAI,MAAM,GAAG,EAAE,KAAK,CAAC,CAAC;gBAC/F,CAAC;YACH,CAAC;YAGD,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;YAC/C,IAAI,CAAC;gBACH,MAAM,WAAW,GAAG,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;gBACnD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;gBACzC,KAAK,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC;YACxC,CAAC;YAAC,MAAM,CAAC;YAET,CAAC;QACH,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,gDAAgD,EAAE,KAAK,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAGD,MAAM,CAAC,MAAM,qBAAqB,GAAG,wBAAwB,EAAE,CAAC"}

package/dist/widget-specifications/msg.scripts.imagegallery.basic/_catalog-data.json

@@ -0,0 +1,12 @@
+{
+  "Widget": "msg.scripts.imagegallery.basic",
+  "Description": "{\"en\":\"Gallery for displaying PDF documents and web graphic files of a page.\",\"de\":\"Galerie zur Anzeige von PDF-Dokumenten und Web-Grafikdateien einer Seite.\"}",
+  "Localized Name": "{\"en\":\"Document Gallery\",\"de\":\"Dokumentengalerie\"}",
+  "Icon": "cf-widget",
+  "Plugin": "com.msgsystems.cplace.imagegallery",
+  "App": "cf.cplace.platform",
+  "Localized App Name": "{\"en\":\"cplace Basis\",\"de\":\"cplace Basis\"}",
+  "Repository": "cplace-paw",
+  "* Details DE": null,
+  "* Details EN": "<p><strong>More Details</strong></p><p>The 'Document Gallery' widget can be used to display a gallery of PDF documents and web graphic files on a page.</p><p><strong>Settings</strong></p><p>// * Title: Bilingual text.</p><p>// * Page:</p><p>// * Height:</p><p>// * Ratio (e.g. \"4/3\"):</p><p>// * Show widget frame*: True/false.</p>"
+}

package/dist/widget-specifications/msg.scripts.imagegallery.basic/_meta.json

@@ -0,0 +1,10 @@
+{
+  "tags": [
+    "files",
+    "media",
+    "gallery",
+    "read-only",
+    "detail-view"
+  ],
+  "requiredApp": null
+}

package/dist/widget-specifications/msg.scripts.imagegallery.basic/_overview.md

@@ -0,0 +1,55 @@
+## Overview
+
+The Document Gallery widget provides a gallery for displaying PDF documents and web graphic files of a page. It transforms document attachments into a visual browsing experience, automatically collecting all viewable documents from a page, organizing them into a slideshow format, and providing intuitive navigation through thumbnails or direct clicking. Rather than displaying documents as a simple list, it presents them in a full-featured gallery/carousel interface powered by the Fotorama library.
+
+The widget handles multiple media types seamlessly:
+- **Images** (JPG, JPEG, BMP, GIF, TIFF, SVG, PNG) display directly
+- **Documents** (PDF, ODP presentations) render via an embedded viewer (ViewerJS)
+- **Videos** (MP4, MOV) play with native HTML5 controls
+
+## Use Cases
+
+### Project Photo Documentation
+When a project page has multiple photos documenting progress, milestones, or deliverables, this widget allows stakeholders to browse through all images in a polished gallery format rather than viewing them individually.
+
+### Product/Asset Image Showcase
+For pages representing products, assets, or inventory items that have multiple associated images, this widget enables users to see all product views in an engaging slideshow format.
+
+### Presentation Viewing
+When ODP or PDF presentations are attached to a page, users can view them directly within the widget without downloading, making it easy to share slide decks or reports.
+
+### Video Collection Display
+For pages with attached video content (MP4, MOV), the widget provides an integrated video player experience, useful for training materials, recorded meetings, or media assets.
+
+### Document Hub Pages
+A page can be configured to display documents from another page (via the BASEPAGE configuration), allowing creation of document "hub" views that aggregate content from different sources.
+
+## Design Considerations
+
+### When to Use This Pattern
+- When documents are primarily visual (images, presentations, videos)
+- When users need to browse through multiple related documents
+- When a polished, magazine-style presentation is desired
+- When documents should be viewable without downloading
+
+### Display Configuration
+The widget offers flexible sizing options:
+- **Height**: Set a fixed pixel height (default: 600px)
+- **Ratio**: Override height with an aspect ratio (e.g., "4/3") for responsive layouts
+- **Width**: Always 100% of the container width
+
+### Navigation Options
+- **"When required"** (default): Shows thumbnail navigation when multiple documents exist
+- **"Never"**: Hides navigation completely; users navigate by clicking or swiping
+
+### Source Flexibility
+By default, the widget displays documents from the current page. Optionally, configure the "Page" (basePage) parameter to reference documents from a different page, useful for creating document hubs or aggregated views.
+
+## Related Patterns
+
+### Alternative Widgets
+- **cf.cplace.pdfPreview** - Specialized for PDF preview only, without carousel features
+- **cf.cplace.dragAndDropImageView** - Image-focused widget with drag-and-drop positioning capabilities
+
+### When to Choose Document Gallery
+Choose this widget when you need a unified gallery experience for multiple media types. For single-document PDF viewing, cf.cplace.pdfPreview may be more appropriate. For advanced image positioning needs, cf.cplace.dragAndDropImageView offers more control.

package/dist/widget-specifications/msg.scripts.imagegallery.basic/_summary.md

@@ -0,0 +1 @@
+Gallery for displaying PDF documents and web graphic files of a page in an interactive carousel with configurable navigation and sizing options.

package/dist/widget-specifications/tag-registry.json

@@ -0,0 +1,63 @@
+{
+  "dimensions": {
+    "dataContentType": {
+      "description": "What the widget works with",
+      "tags": {
+        "attributes": "Works with page attributes/properties",
+        "files": "Handles file attachments/documents",
+        "rich-text": "Formatted text content (HTML, Wiki)",
+        "media": "Images, video, visual content",
+        "comments": "Discussion threads, feedback",
+        "references": "Page relationships, links between pages",
+        "metadata": "System info (versions, timestamps, tags)",
+        "time-series": "Date-based, time-phased data"
+      }
+    },
+    "displayFormat": {
+      "description": "How data is presented visually",
+      "tags": {
+        "chart": "Graphical visualization (bar, pie, line)",
+        "table": "Tabular rows and columns",
+        "list": "Simple sequential display",
+        "board": "Card-based layout (Kanban-style)",
+        "timeline": "Gantt, roadmap, schedule visualization",
+        "tree": "Hierarchical/nested structure",
+        "matrix": "Two-dimensional grid",
+        "form": "Input fields layout",
+        "gallery": "Visual thumbnail grid"
+      }
+    },
+    "interaction": {
+      "description": "What users can do with the widget",
+      "tags": {
+        "read-only": "Display only, no editing",
+        "inline-edit": "Edit values in place",
+        "filterable": "User can filter displayed data",
+        "sortable": "User can reorder/sort data",
+        "searchable": "Content driven by search queries",
+        "drag-drop": "Supports drag and drop interaction",
+        "selectable": "Items can be selected (for master-detail)"
+      }
+    },
+    "purposeContext": {
+      "description": "Why you'd use this widget",
+      "tags": {
+        "dashboard": "Aggregated overview, KPIs",
+        "kpi": "Simple number/metric display (prefer over charts)",
+        "detail-view": "Single page/item details",
+        "navigation": "Browsing, finding pages",
+        "collaboration": "Team communication",
+        "reporting": "Export, report generation",
+        "scheduling": "Time/resource planning"
+      }
+    },
+    "technical": {
+      "description": "Implementation considerations",
+      "tags": {
+        "low-code": "Requires cplaceJS scripting",
+        "connected": "Links to other widgets (master-detail)",
+        "container": "Holds other widgets/layouts"
+      }
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cplace/test-mcp-server",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "MCP server that provides Claude Desktop with tools to interact with cplace APIs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,7 +9,8 @@
     "cplace-test-mcp-server": "dist/index.js"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && npm run copy-widget-specs",
+    "copy-widget-specs": "cp -r src/widget-specifications dist/ && find dist/widget-specifications -name '*.ts' -delete",
     "start": "node dist/index.js",
     "start:dev": "node dist/index.js --remote",
     "test": "vitest",