@felipechavaa/pulse-mcp-server 1.0.0

package/dist/tools/pulse-api/hospitality/update-transaction-item-status-hospitality.js

@@ -0,0 +1,56 @@
+import { z } from "zod";
+export const updateTransactionItemStatusHospitalityTool = [
+    "pulse-api-update-transaction-item-status-hospitality",
+    "This is the update transaction item status API contract Protect Group Pulse API in hospitality vertical." +
+        "Use the tool to implements services in any programming language that can make HTTP requests." +
+        "Follow this API contract to create the services.",
+    {
+        saleId: z.string().describe("The ID of the sale"),
+        reference: z.string().describe("The reference of the item to update the status for"),
+        status: z.string().describe("The new status of the item (e.g. 'NotAttended')"),
+        member: z.string().describe("Your client ID or the client ID of the client being represented")
+    },
+    async ({ saleId, reference, status, member }) => {
+        const baseUrl = 'https://api.protectgroup.com/test/dynamic/sale';
+        const clientId = ''; // will be provided by the user
+        const clientSecret = ''; // will be provided by the user
+        const body = {
+            status,
+            member
+        };
+        try {
+            const url = `${baseUrl}/${saleId}/item/${reference}/status`;
+            const response = await fetch(url, {
+                method: 'PUT',
+                headers: {
+                    'x-pg-client-id': clientId,
+                    'x-pg-client-secret': clientSecret,
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify(body)
+            });
+            if (!response.ok) {
+                const errorData = await response.json();
+                throw new Error(JSON.stringify(errorData));
+            }
+            const data = await response.json();
+            const toolResponse = {
+                content: [{
+                        type: "text",
+                        text: JSON.stringify(data, null, 2)
+                    }]
+            };
+            return toolResponse;
+        }
+        catch (error) {
+            console.error('Error updating transaction item status:', error);
+            const toolResponse = {
+                content: [{
+                        type: "text",
+                        text: `Error updating transaction item status: ${error instanceof Error ? error.message : JSON.stringify(error)}`
+                    }]
+            };
+            return toolResponse;
+        }
+    }
+];

package/dist/tools/pulse-api/hospitality/update-transaction-items-hospitality.js

@@ -0,0 +1,56 @@
+import { z } from "zod";
+export const updateTransactionItemsHospitalityTool = [
+    "pulse-api-update-transaction-items-hospitality",
+    "This is the update transaction items API contract Protect Group Pulse API in hospitality vertical." +
+        "Use the tool to implements services in any programming language that can make HTTP requests." +
+        "Follow this API contract to create the services.",
+    {
+        saleId: z.string().describe("The ID of the sale to update items for"),
+        member: z.string().describe("Your client ID or the client ID of the client being represented"),
+        items: z.array(z.object({
+            customerName: z.string().describe("Name of the customer associated with the item"),
+            oldReference: z.string().describe("The current reference of the item to be updated"),
+            reference: z.string().describe("The new reference to assign to the item")
+        })).describe("Array of items to update")
+    },
+    async ({ saleId, member, items }) => {
+        const baseUrl = 'https://api.protectgroup.com/test/dynamic/sale';
+        const clientId = ''; // will be provided by the user
+        const clientSecret = ''; // will be provided by the user
+        const body = { member, items };
+        try {
+            const url = `${baseUrl}/${saleId}/items`;
+            const response = await fetch(url, {
+                method: 'PUT',
+                headers: {
+                    'x-pg-client-id': clientId,
+                    'x-pg-client-secret': clientSecret,
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify(body)
+            });
+            if (!response.ok) {
+                const errorData = await response.json();
+                throw new Error(JSON.stringify(errorData));
+            }
+            const data = await response.json();
+            const toolResponse = {
+                content: [{
+                        type: "text",
+                        text: JSON.stringify(data, null, 2)
+                    }]
+            };
+            return toolResponse;
+        }
+        catch (error) {
+            console.error('Error updating transaction items:', error);
+            const toolResponse = {
+                content: [{
+                        type: "text",
+                        text: `Error updating transaction items: ${error instanceof Error ? error.message : JSON.stringify(error)}`
+                    }]
+            };
+            return toolResponse;
+        }
+    }
+];

package/dist/tools/pulse-api/hospitality/update-transaction-status-hospitality.js

@@ -0,0 +1,55 @@
+import { z } from "zod";
+export const updateTransactionStatusHospitalityTool = [
+    "pulse-api-update-transaction-status-hospitality",
+    "This is the update transaction status API contract Protect Group Pulse API in hospitality vertical." +
+        "Use the tool to implements services in any programming language that can make HTTP requests." +
+        "Follow this API contract to create the services.",
+    {
+        saleId: z.string().describe("The ID of the sale to update the status for"),
+        status: z.string().describe("The new status of the transaction (e.g. 'NotAttended')"),
+        member: z.string().describe("Your client ID or the client ID of the client being represented")
+    },
+    async ({ saleId, status, member }) => {
+        const baseUrl = 'https://api.protectgroup.com/test/dynamic/sale';
+        const clientId = ''; // will be provided by the user
+        const clientSecret = ''; // will be provided by the user
+        const body = {
+            status,
+            member
+        };
+        try {
+            const url = `${baseUrl}/${saleId}/status`;
+            const response = await fetch(url, {
+                method: 'PUT',
+                headers: {
+                    'x-pg-client-id': clientId,
+                    'x-pg-client-secret': clientSecret,
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify(body)
+            });
+            if (!response.ok) {
+                const errorData = await response.json();
+                throw new Error(JSON.stringify(errorData));
+            }
+            const data = await response.json();
+            const toolResponse = {
+                content: [{
+                        type: "text",
+                        text: JSON.stringify(data, null, 2)
+                    }]
+            };
+            return toolResponse;
+        }
+        catch (error) {
+            console.error('Error updating transaction status:', error);
+            const toolResponse = {
+                content: [{
+                        type: "text",
+                        text: `Error updating transaction status: ${error instanceof Error ? error.message : JSON.stringify(error)}`
+                    }]
+            };
+            return toolResponse;
+        }
+    }
+];

package/dist/tools/pulse-react/pulse-react.content.js

@@ -0,0 +1,48 @@
+export const pulseReactContentTool = [
+    "pulse-react-content-render",
+    "Place the RefundableContent component wherever you want the Refundable Booking content to appear. This will render the predefined UI from the Pulse component.",
+    async () => {
+        const reactCode = `
+1. **Render RefundableContent**:
+After setting up the \`RefundableProvider\`, you can use the \`RefundableContent\` component to display the refundable booking options in your checkout or booking component.:
+
+\`\`\`jsx
+import {
+    ApiRequestFailedEventArgs,
+    RefundableContent,
+    useChangeEventArgs
+} from 'protect-group-pulse-react'
+
+function MyCheckoutPage() {
+    const args = useChangeEventArgs()
+
+    useEffect(() => {
+        // Handle protection change event and quoteId in args.quoteId
+        console.log(args);
+    }, [args])
+
+    const handleApiError = (args: ApiRequestFailedEventArgs) => {
+        // Maybe some invalid data was supplied?
+    }
+
+    return (
+        <MyPageWrapper>
+            //some components
+            <RefundableContent onApiError={handleApiError} />
+            //some components
+        </MyPageWrapper>
+    )
+}
+\`\`\`
+`.trim();
+        const toolResponse = {
+            content: [
+                {
+                    type: "text",
+                    text: reactCode
+                }
+            ]
+        };
+        return toolResponse;
+    }
+];

package/dist/tools/pulse-react/pulse-react.install.js

@@ -0,0 +1,56 @@
+import { z } from "zod";
+export const pulseReactInstallationTool = [
+    "pulse-react-installation",
+    "Install pulse react NPM script and configure RefundableProvider at the root level of the project using RefundableOptions below" +
+        " wrapper to provide context to all child components and TheRestOfYourApp is the existing app component",
+    {
+        VendorCode: z.string().describe("Vendor code (member ID)")
+    },
+    async ({ VendorCode }) => {
+        const reactCode = `
+1. **Installation**:
+\`\`\`
+npm i --save protect-group-pulse-react
+\`\`\`
+
+2. **Usage**:
+Once the package is installed, use the following React code to render the widget:
+
+\`\`\`jsx
+import {
+    RefundableOptions,
+    RefundableProvider
+} from 'protect-group-pulse-react';
+
+function MyApp() {
+    const options: RefundableOptions = {
+        containerSize: 'medium', // 'small', 'medium', 'large' (default)
+        currencyCode: 'USD',
+        environment: 'test',
+        eventDateFormat: 'DD/MM/YYYY', // Optional – The format must match a valid moment.js date format and the date must be in UTC
+        languageCode: 'en',
+        nonce: '[nonce code for the inline script, if you have a CSP set up on your site]', // optional
+        salesTax: 10, // optional, apply sales tax to the refundable booking cost
+        useSaleAction: true, // optional, set this to false if you intend to call our sale endpoint manually
+        vendorCode: '${VendorCode}'
+    };
+
+    return (
+        <RefundableProvider options={options}>
+            <TheRestOfYourApp/>
+        </RefundableProvider>
+    );
+}
+\`\`\`
+`.trim();
+        const toolResponse = {
+            content: [
+                {
+                    type: "text",
+                    text: reactCode
+                }
+            ]
+        };
+        return toolResponse;
+    }
+];

package/dist/tools/pulse-react/pulse-react.quote.js

@@ -0,0 +1,46 @@
+export const pulseReactUpdateQuoteTool = [
+    "pulse-react-update-quote",
+    "React code to update quote data when internal state changes in your application",
+    async () => {
+        const reactCode = `
+1. **Implement updateQuoteData**:
+After setting up the \`RefundableContent\`, you can use the \`useRefundableActions\` hook to update the quote data whenever your internal state changes. This is particularly useful if the booking cost, number of tickets, or event date changes based on user input or other application logic.
+
+\`\`\`jsx
+import {useRefundableActions} from 'protect-group-pulse-react'
+
+function MyCheckoutPage() {
+    const {updateQuoteData} = useRefundableActions()
+    const {myInternalState} = useMyInternalStateContext() // Assume this context provides your app's internal state
+
+    useEffect(() => {
+    const {bookingCost, numberOfTickets, eventDate} = myInternalState
+
+    updateQuoteData({
+      totalValue: bookingCost, 
+      numberOfTickets, 
+      eventTravelDateTime: eventDate // in 'DD/MM/YYYY' format   
+    })
+  }, [myInternalState])
+
+    return (
+        <MyPageWrapper>
+            {/* some components */}
+            <RefundableContent />
+            {/* some components */}
+        </MyPageWrapper>
+    )
+}
+\`\`\`
+`.trim();
+        const toolResponse = {
+            content: [
+                {
+                    type: "text",
+                    text: reactCode
+                }
+            ]
+        };
+        return toolResponse;
+    }
+];

package/dist/tools/pulse-react/pulse-react.sale.js

@@ -0,0 +1,73 @@
+import { z } from "zod";
+export const pulseReactSaleTool = [
+    "pulse-react-sale",
+    "React code to write sale using writeSale from useRefundableActions hook",
+    {
+        BookingReference: z.string().describe("Booking reference")
+    },
+    async ({ BookingReference }) => {
+        const reactCode = `
+1. **Implement writeSale**:
+After setting up the \`RefundableContent\`, you can use the \`useRefundableActions\` hook to write the sale data using the booking reference from the sale.
+
+\`\`\`jsx
+import {useRefundableActions, SaleData} from 'protect-group-pulse-react'
+
+function MyCheckoutPage() {
+    const {writeSale} = useRefundableActions()
+
+    const handleMakePayment = async () => {
+        // Do your sale thing
+
+        const request: SaleData = {
+            bookingReference: ${BookingReference},
+            customers: [
+                {
+                    email: 'test@test.com',
+                    firstName: 'Test',
+                    lastName: 'Test',
+                    telephone: "+598 12345678" // Should be in the format +(prefix) (number)
+                }
+            ],
+            flights: [
+                {
+                    arrivalCode: 'LHR',
+                    departureCode: 'LBA',
+                    departureDate: '01/01/2000', // the configured date format
+                    flightNumber: 'PP1'
+                    terminal: 'Terminal 1',
+                    class: 'Economy'
+                }
+            ]
+        }
+
+        try {
+            const response = await writeSale(request)
+            // Do something with the response
+        } catch (e: any) {
+            const {data: {error}} = e
+            // Something went wrong
+        }
+    }
+
+    return (
+        <MyPageWrapper>
+            {/* some components */}
+            <RefundableContent />
+            {/* some components */}
+        </MyPageWrapper>
+    )
+}
+\`\`\`
+`.trim();
+        const toolResponse = {
+            content: [
+                {
+                    type: "text",
+                    text: reactCode
+                }
+            ]
+        };
+        return toolResponse;
+    }
+];

package/dist/tools/pulse-widget/pulse-widget-installation.js

@@ -0,0 +1,40 @@
+import { z } from "zod";
+export const pulseWidgetInstallation = [
+    "pulse-widget-installation",
+    "Install Pulse javascript widget, this should be created once in the source code. Insert the code returned as an script",
+    {
+        VendorCode: z.string().describe("Vendor code (member ID)"),
+    },
+    async ({ VendorCode }) => {
+        const widgetScript = `
+<script>
+(function (P, R, O, t, E, C, T) {
+  P[t] = P[t] || function () { (P[t].q = P[t].q || []).push(arguments) };
+  C = R.createElement(O), T = R.getElementsByTagName(O)[0];
+  C.id = t; C.src = E; C.async = 1; T.parentNode.insertBefore(C, T);
+  }(window, document, 'script', '_pgr', 'https://test.widget.protectgroup.com/pulse.js'))
+
+window._pgr('init', {
+    containerSize: 'large', // 'small', 'medium', 'large' (default)
+    currencyCode: 'USD',
+    debug: true,
+    environment: 'test', // default is 'prod' --> set to 'test' for sandbox
+    eventDateFormat: 'DD/MM/YYYY', // Optional – The format must match a valid moment.js date format and the date must be in UTC
+    languageCode: 'en',
+    resetOnUnload: false, // Reset the widget when the page is unloaded (set to true to enable auto-reset)
+    useSaleAction: false, // Optional, set this to false if you intend to call our sale endpoint manually
+    vendorCode: '${VendorCode}',
+})
+</script>
+    `.trim();
+        const toolResponse = {
+            content: [
+                {
+                    type: "text",
+                    text: widgetScript
+                }
+            ]
+        };
+        return toolResponse;
+    }
+];

package/dist/tools/pulse-widget/pulse-widget-render.js

@@ -0,0 +1,36 @@
+import { z } from "zod";
+export const pulseWidgetRender = [
+    "pulse-widget-render",
+    "This is the code to render the Pulse javascript widget once its installed. Add the div with pgr-payment-container and call updateQuoteData action.",
+    {
+        TotalValue: z.number().describe("The total value of the booking"),
+        NumberOfTickets: z.number().describe("The number of tickets"),
+        EventTravelDateTime: z.string().describe("Event travel date time in ISO format")
+    },
+    async ({ TotalValue, NumberOfTickets, EventTravelDateTime }) => {
+        const widgetRenderScript = `
+<script>
+document.addEventListener('pg-widget-loaded', function() {
+    const data = {
+        totalValue: ${TotalValue},
+        numberOfTickets: ${NumberOfTickets},
+        eventTravelDateTime: '${EventTravelDateTime}' // in 'DD/MM/YYYY' format
+    };
+    window._pgr('action', 'updateQuoteData', data);
+});
+</script>
+
+<div id="pgr-payment-container"></div>
+<div id='pgr-product-container'></div>
+    `.trim();
+        const toolResponse = {
+            content: [
+                {
+                    type: "text",
+                    text: widgetRenderScript
+                }
+            ]
+        };
+        return toolResponse;
+    }
+];

package/dist/types/toolResponse.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@felipechavaa/pulse-mcp-server",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "Pulse Model Context Protocol Server in TypeScript",
+  "main": "dist/index.js",
+  "bin": {
+    "pulse-mcp-server": "dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc && shx chmod +x dist/*.js",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run build"
+  },
+  "author": "Protect Group Tech Team",
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "pulse",
+    "refund-protect",
+    "protect-group",
+    "ai-tools"
+  ], 
+  "license": "MIT",
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "1.19.1",
+    "node-fetch": "^3.3.2",
+    "zod": "^3.24.3"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.0",
+    "ts-node": "^10.9.2",
+    "shx": "^0.3.4",
+    "typescript": "^5.3.3"
+  }
+}