@vqnguyen1/piece-icemortgage-encompass 0.0.4 → 0.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vqnguyen1/piece-icemortgage-encompass",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "license": "MIT",
   "main": "src/index.ts",
   "peerDependencies": {
@@ -8,7 +8,5 @@
     "@activepieces/pieces-common": "*",
     "@activepieces/shared": "*"
   },
-  "dependencies": {},
-  "types": "./src/index.d.ts",
-  "type": "commonjs"
-}
+  "dependencies": {}
+}

package/project.json

@@ -0,0 +1,22 @@
+{
+  "name": "pieces-icemortgage-encompass",
+  "$schema": "../../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/pieces/custom/icemortgage-encompass/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/packages/pieces/custom/icemortgage-encompass",
+        "main": "packages/pieces/custom/icemortgage-encompass/src/index.ts",
+        "tsConfig": "packages/pieces/custom/icemortgage-encompass/tsconfig.lib.json",
+        "assets": [
+          "packages/pieces/custom/icemortgage-encompass/*.md",
+          "packages/pieces/custom/icemortgage-encompass/*.png"
+        ]
+      }
+    }
+  },
+  "tags": []
+}

package/publish.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+# Script to build, version, and publish IceMortgage Encompass piece to npm
+# Usage: ./publish.sh [patch|minor|major]
+
+set -e  # Exit on error
+
+VERSION_TYPE="${1:-patch}"
+PIECE_NAME="icemortgage-encompass"
+ROOT_DIR="$(pwd)/../../../.."
+
+GREEN='\033[0;32m'
+BLUE='\033[0;34m'
+YELLOW='\033[1;33m'
+RED='\033[0;31m'
+NC='\033[0m'
+
+echo -e "${BLUE}Publishing: ${PIECE_NAME}${NC}"
+
+npm whoami &> /dev/null || { echo -e "${RED}Not logged in to npm${NC}"; exit 1; }
+
+CURRENT_VERSION=$(node -p "require('./package.json').version")
+echo -e "Current: ${YELLOW}${CURRENT_VERSION}${NC}"
+
+npm version $VERSION_TYPE --no-git-tag-version
+NEW_VERSION=$(node -p "require('./package.json').version")
+echo -e "New: ${GREEN}${NEW_VERSION}${NC}"
+
+cd "$ROOT_DIR" && bunx nx build "pieces-${PIECE_NAME}" --skip-nx-cache
+cd "${ROOT_DIR}/dist/packages/pieces/custom/${PIECE_NAME}"
+npm publish --access public
+
+echo -e "${GREEN}✓ Published @vqnguyen1/piece-${PIECE_NAME}@${NEW_VERSION}${NC}"

package/src/index.ts

@@ -0,0 +1,52 @@
+import { createPiece } from '@activepieces/pieces-framework';
+import { PieceCategory } from '@activepieces/shared';
+import { createCustomApiCallAction } from '@activepieces/pieces-common';
+import { icemortgageEncompassAuth } from './lib/common/auth';
+import { createLoan } from './lib/actions/create-loan';
+import { retrieveLoan } from './lib/actions/retrieve-loan';
+import { updateLoan } from './lib/actions/update-loan';
+import { deleteLoan } from './lib/actions/delete-loan';
+import { manageFieldLocks } from './lib/actions/manage-field-locks';
+import { createDocument } from './lib/actions/document-create';
+import { retrieveDocument } from './lib/actions/document-retrieve';
+import { listDocuments } from './lib/actions/document-list';
+import { updateDocument } from './lib/actions/document-update';
+import { addDocumentComments } from './lib/actions/document-add-comments';
+import { assignDocumentAttachments } from './lib/actions/document-assign-attachments';
+
+export const icemortgageEncompass = createPiece({
+  displayName: 'IceMortgage Encompass',
+  auth: icemortgageEncompassAuth,
+  minimumSupportedRelease: '0.20.0',
+  logoUrl: 'https://i.imgur.com/UqqkpPQ.png',
+  authors: ['vqnguyen1'],
+  categories: [PieceCategory.BUSINESS_INTELLIGENCE],
+  actions: [
+    createLoan,
+    retrieveLoan,
+    updateLoan,
+    deleteLoan,
+    manageFieldLocks,
+    createDocument,
+    retrieveDocument,
+    listDocuments,
+    updateDocument,
+    addDocumentComments,
+    assignDocumentAttachments,
+    createCustomApiCallAction({
+      baseUrl: (auth) => (auth as any).baseUrl || 'https://api.elliemae.com',
+      auth: icemortgageEncompassAuth,
+      authMapping: async (auth) => {
+        // Note: Encompass uses OAuth2, this is a simplified version
+        // In production, you'd need to handle token refresh
+        return {
+          'Authorization': `Bearer ${(auth as any).clientSecret}`,
+          'Content-Type': 'application/json',
+        };
+      },
+    }),
+  ],
+  triggers: [],
+});
+
+export { icemortgageEncompassAuth };

package/src/lib/actions/create-loan.ts

@@ -0,0 +1,99 @@
+import {
+  createAction,
+  Property,
+} from '@activepieces/pieces-framework';
+import { httpClient, HttpMethod } from '@activepieces/pieces-common';
+import { icemortgageEncompassAuth } from '../common/auth';
+import { getAccessToken } from '../common/helpers';
+
+export const createLoan = createAction({
+  name: 'loan_create',
+  auth: icemortgageEncompassAuth,
+  displayName: 'Loan - Create',
+  description: 'Create a new loan in Encompass',
+  props: {
+    loanData: Property.Json({
+      displayName: 'Loan Data',
+      description: 'The complete loan information as JSON object',
+      required: true,
+    }),
+    loanFolder: Property.ShortText({
+      displayName: 'Loan Folder',
+      description: 'The folder where the loan will be created (e.g., "My Pipeline")',
+      required: false,
+    }),
+    view: Property.StaticDropdown({
+      displayName: 'View',
+      description: 'The view to return in the response',
+      required: false,
+      options: {
+        options: [
+          { label: 'Entity', value: 'entity' },
+          { label: 'ID', value: 'id' },
+        ],
+      },
+      defaultValue: 'entity',
+    }),
+    templateType: Property.StaticDropdown({
+      displayName: 'Template Type',
+      description: 'Type of template to apply when creating the loan',
+      required: false,
+      options: {
+        options: [
+          { label: 'None', value: '' },
+          { label: 'Template Set', value: 'templateSet' },
+          { label: 'Loan Program', value: 'loanProgram' },
+          { label: 'Closing Cost', value: 'closingCost' },
+        ],
+      },
+    }),
+    templatePath: Property.ShortText({
+      displayName: 'Template Path',
+      description: 'Path to the template (e.g., "Public:\\Companywide\\Template Name")',
+      required: false,
+    }),
+  },
+  async run(context) {
+    const auth = context.auth as any;
+    const baseUrl = auth.baseUrl;
+    const { loanData, loanFolder, view, templateType, templatePath } = context.propsValue;
+
+    // Get access token
+    const accessToken = await getAccessToken(auth);
+
+    // Build query parameters
+    const queryParams = new URLSearchParams();
+    if (loanFolder) queryParams.append('loanFolder', loanFolder);
+    if (view) queryParams.append('view', view);
+    if (templateType) queryParams.append('templateType', templateType);
+    if (templatePath) queryParams.append('templatePath', templatePath);
+
+    const url = `${baseUrl}/encompass/v3/loans${queryParams.toString() ? '?' + queryParams.toString() : ''}`;
+
+    const response = await httpClient.sendRequest({
+      method: HttpMethod.POST,
+      url,
+      headers: {
+        'Content-Type': 'application/json',
+        'Authorization': `Bearer ${accessToken}`,
+      },
+      body: loanData,
+    });
+
+    // Extract loan ID from Location header if present
+    const locationHeader = response.headers?.['location'] as string;
+    let loanId = null;
+    if (locationHeader) {
+      const match = locationHeader.match(/\/loans\/([^\/]+)$/);
+      if (match) {
+        loanId = match[1];
+      }
+    }
+
+    return {
+      loanId,
+      loanData: response.body,
+      statusCode: response.status,
+    };
+  },
+});

package/src/lib/actions/delete-loan.ts

@@ -0,0 +1,43 @@
+import {
+  createAction,
+  Property,
+} from '@activepieces/pieces-framework';
+import { httpClient, HttpMethod } from '@activepieces/pieces-common';
+import { icemortgageEncompassAuth } from '../common/auth';
+import { getAccessToken } from '../common/helpers';
+
+export const deleteLoan = createAction({
+  name: 'loan_delete',
+  auth: icemortgageEncompassAuth,
+  displayName: 'Loan - Delete',
+  description: 'Delete a loan from Encompass',
+  props: {
+    loanId: Property.ShortText({
+      displayName: 'Loan ID',
+      description: 'The ID of the loan to delete',
+      required: true,
+    }),
+  },
+  async run(context) {
+    const auth = context.auth as any;
+    const baseUrl = auth.baseUrl;
+    const { loanId } = context.propsValue;
+
+    const accessToken = await getAccessToken(auth);
+
+    const response = await httpClient.sendRequest({
+      method: HttpMethod.DELETE,
+      url: `${baseUrl}/encompass/v3/loans/${loanId}`,
+      headers: {
+        'Content-Type': 'application/json',
+        'Authorization': `Bearer ${accessToken}`,
+      },
+    });
+
+    return {
+      success: true,
+      statusCode: response.status,
+      message: `Loan ${loanId} deleted successfully`,
+    };
+  },
+});

package/src/lib/actions/document-add-comments.ts

@@ -0,0 +1,66 @@
+import {
+  createAction,
+  Property,
+} from '@activepieces/pieces-framework';
+import { httpClient, HttpMethod } from '@activepieces/pieces-common';
+import { icemortgageEncompassAuth } from '../common/auth';
+import { getAccessToken } from '../common/helpers';
+
+export const addDocumentComments = createAction({
+  name: 'document_add_comments',
+  auth: icemortgageEncompassAuth,
+  displayName: 'Document - Add Comments',
+  description: 'Add comments to a document',
+  props: {
+    loanId: Property.ShortText({
+      displayName: 'Loan ID',
+      description: 'The ID of the loan',
+      required: true,
+    }),
+    documentId: Property.ShortText({
+      displayName: 'Document ID',
+      description: 'The ID of the document to add comments to',
+      required: true,
+    }),
+    comments: Property.Array({
+      displayName: 'Comments',
+      description: 'Array of comment objects to add',
+      required: true,
+    }),
+    view: Property.StaticDropdown({
+      displayName: 'View',
+      description: 'The view to return in the response',
+      required: false,
+      options: {
+        options: [
+          { label: 'Entity', value: 'entity' },
+          { label: 'ID', value: 'id' },
+        ],
+      },
+      defaultValue: 'entity',
+    }),
+  },
+  async run(context) {
+    const auth = context.auth as any;
+    const baseUrl = auth.baseUrl;
+    const { loanId, documentId, comments, view } = context.propsValue;
+
+    const accessToken = await getAccessToken(auth);
+
+    const queryParams = new URLSearchParams();
+    queryParams.append('action', 'add');
+    if (view) queryParams.append('view', view);
+
+    const response = await httpClient.sendRequest({
+      method: HttpMethod.PATCH,
+      url: `${baseUrl}/encompass/v3/loans/${loanId}/documents/${documentId}/comments?${queryParams.toString()}`,
+      headers: {
+        'Content-Type': 'application/json',
+        'Authorization': `Bearer ${accessToken}`,
+      },
+      body: comments,
+    });
+
+    return response.body;
+  },
+});

package/src/lib/actions/document-assign-attachments.ts

@@ -0,0 +1,53 @@
+import {
+  createAction,
+  Property,
+} from '@activepieces/pieces-framework';
+import { httpClient, HttpMethod } from '@activepieces/pieces-common';
+import { icemortgageEncompassAuth } from '../common/auth';
+import { getAccessToken } from '../common/helpers';
+
+export const assignDocumentAttachments = createAction({
+  name: 'document_assign_attachments',
+  auth: icemortgageEncompassAuth,
+  displayName: 'Document - Assign Attachments',
+  description: 'Assign attachments to a document',
+  props: {
+    loanId: Property.ShortText({
+      displayName: 'Loan ID',
+      description: 'The ID of the loan',
+      required: true,
+    }),
+    documentId: Property.ShortText({
+      displayName: 'Document ID',
+      description: 'The ID of the document to assign attachments to',
+      required: true,
+    }),
+    attachments: Property.Array({
+      displayName: 'Attachments',
+      description: 'Array of attachment objects (with entityId and entityType fields)',
+      required: true,
+    }),
+  },
+  async run(context) {
+    const auth = context.auth as any;
+    const baseUrl = auth.baseUrl;
+    const { loanId, documentId, attachments } = context.propsValue;
+
+    const accessToken = await getAccessToken(auth);
+
+    const queryParams = new URLSearchParams();
+    queryParams.append('action', 'add');
+
+    const response = await httpClient.sendRequest({
+      method: HttpMethod.PATCH,
+      url: `${baseUrl}/encompass/v3/loans/${loanId}/documents/${documentId}/attachments?${queryParams.toString()}`,
+      headers: {
+        'Content-Type': 'application/json',
+        'Authorization': `Bearer ${accessToken}`,
+      },
+      body: attachments,
+    });
+
+    return response.body;
+  },
+});

package/src/lib/actions/document-create.ts

@@ -0,0 +1,61 @@
+import {
+  createAction,
+  Property,
+} from '@activepieces/pieces-framework';
+import { httpClient, HttpMethod } from '@activepieces/pieces-common';
+import { icemortgageEncompassAuth } from '../common/auth';
+import { getAccessToken } from '../common/helpers';
+
+export const createDocument = createAction({
+  name: 'document_create',
+  auth: icemortgageEncompassAuth,
+  displayName: 'Document - Create',
+  description: 'Create a new document for a loan in Encompass',
+  props: {
+    loanId: Property.ShortText({
+      displayName: 'Loan ID',
+      description: 'The ID of the loan to create the document for',
+      required: true,
+    }),
+    documents: Property.Array({
+      displayName: 'Documents',
+      description: 'Array of document objects to create',
+      required: true,
+    }),
+    view: Property.StaticDropdown({
+      displayName: 'View',
+      description: 'The view to return in the response',
+      required: false,
+      options: {
+        options: [
+          { label: 'Entity', value: 'entity' },
+          { label: 'ID', value: 'id' },
+        ],
+      },
+      defaultValue: 'entity',
+    }),
+  },
+  async run(context) {
+    const auth = context.auth as any;
+    const baseUrl = auth.baseUrl;
+    const { loanId, documents, view } = context.propsValue;
+
+    const accessToken = await getAccessToken(auth);
+
+    const queryParams = new URLSearchParams();
+    queryParams.append('action', 'add');
+    if (view) queryParams.append('view', view);
+
+    const response = await httpClient.sendRequest({
+      method: HttpMethod.PATCH,
+      url: `${baseUrl}/encompass/v3/loans/${loanId}/documents?${queryParams.toString()}`,
+      headers: {
+        'Content-Type': 'application/json',
+        'Authorization': `Bearer ${accessToken}`,
+      },
+      body: documents,
+    });
+
+    return response.body;
+  },
+});

package/src/lib/actions/document-list.ts

@@ -0,0 +1,71 @@
+import {
+  createAction,
+  Property,
+} from '@activepieces/pieces-framework';
+import { httpClient, HttpMethod } from '@activepieces/pieces-common';
+import { icemortgageEncompassAuth } from '../common/auth';
+import { getAccessToken } from '../common/helpers';
+
+export const listDocuments = createAction({
+  name: 'document_list',
+  auth: icemortgageEncompassAuth,
+  displayName: 'Document - List',
+  description: 'Retrieve all documents for a loan',
+  props: {
+    loanId: Property.ShortText({
+      displayName: 'Loan ID',
+      description: 'The ID of the loan',
+      required: true,
+    }),
+    view: Property.StaticDropdown({
+      displayName: 'View',
+      description: 'The level of detail to return',
+      required: false,
+      options: {
+        options: [
+          { label: 'Detail (Default)', value: 'Detail' },
+          { label: 'Full', value: 'Full' },
+          { label: 'Summary', value: 'Summary' },
+        ],
+      },
+      defaultValue: 'Detail',
+    }),
+    includeRemoved: Property.Checkbox({
+      displayName: 'Include Removed Documents',
+      description: 'Whether to include removed documents in the results',
+      required: false,
+      defaultValue: false,
+    }),
+    requireActiveAttachments: Property.Checkbox({
+      displayName: 'Require Active Attachments',
+      description: 'Whether to only return documents with active attachments',
+      required: false,
+      defaultValue: false,
+    }),
+  },
+  async run(context) {
+    const auth = context.auth as any;
+    const baseUrl = auth.baseUrl;
+    const { loanId, view, includeRemoved, requireActiveAttachments } = context.propsValue;
+
+    const accessToken = await getAccessToken(auth);
+
+    const queryParams = new URLSearchParams();
+    if (view) queryParams.append('view', view);
+    if (includeRemoved) queryParams.append('includeRemoved', 'true');
+    if (requireActiveAttachments) queryParams.append('requireActiveAttachments', 'true');
+
+    const url = `${baseUrl}/encompass/v3/loans/${loanId}/documents${queryParams.toString() ? '?' + queryParams.toString() : ''}`;
+
+    const response = await httpClient.sendRequest({
+      method: HttpMethod.GET,
+      url,
+      headers: {
+        'Content-Type': 'application/json',
+        'Authorization': `Bearer ${accessToken}`,
+      },
+    });
+
+    return response.body;
+  },
+});

package/src/lib/actions/document-retrieve.ts

@@ -0,0 +1,44 @@
+import {
+  createAction,
+  Property,
+} from '@activepieces/pieces-framework';
+import { httpClient, HttpMethod } from '@activepieces/pieces-common';
+import { icemortgageEncompassAuth } from '../common/auth';
+import { getAccessToken } from '../common/helpers';
+
+export const retrieveDocument = createAction({
+  name: 'document_retrieve',
+  auth: icemortgageEncompassAuth,
+  displayName: 'Document - Retrieve',
+  description: 'Retrieve a single document from a loan',
+  props: {
+    loanId: Property.ShortText({
+      displayName: 'Loan ID',
+      description: 'The ID of the loan',
+      required: true,
+    }),
+    documentId: Property.ShortText({
+      displayName: 'Document ID',
+      description: 'The ID of the document to retrieve',
+      required: true,
+    }),
+  },
+  async run(context) {
+    const auth = context.auth as any;
+    const baseUrl = auth.baseUrl;
+    const { loanId, documentId } = context.propsValue;
+
+    const accessToken = await getAccessToken(auth);
+
+    const response = await httpClient.sendRequest({
+      method: HttpMethod.GET,
+      url: `${baseUrl}/encompass/v3/loans/${loanId}/documents/${documentId}`,
+      headers: {
+        'Content-Type': 'application/json',
+        'Authorization': `Bearer ${accessToken}`,
+      },
+    });
+
+    return response.body;
+  },
+});

package/src/lib/actions/document-update.ts

@@ -0,0 +1,61 @@
+import {
+  createAction,
+  Property,
+} from '@activepieces/pieces-framework';
+import { httpClient, HttpMethod } from '@activepieces/pieces-common';
+import { icemortgageEncompassAuth } from '../common/auth';
+import { getAccessToken } from '../common/helpers';
+
+export const updateDocument = createAction({
+  name: 'document_update',
+  auth: icemortgageEncompassAuth,
+  displayName: 'Document - Update',
+  description: 'Update an existing document on a loan',
+  props: {
+    loanId: Property.ShortText({
+      displayName: 'Loan ID',
+      description: 'The ID of the loan',
+      required: true,
+    }),
+    documents: Property.Array({
+      displayName: 'Documents',
+      description: 'Array of document objects to update (must include id field for each)',
+      required: true,
+    }),
+    view: Property.StaticDropdown({
+      displayName: 'View',
+      description: 'The view to return in the response',
+      required: false,
+      options: {
+        options: [
+          { label: 'Entity', value: 'entity' },
+          { label: 'ID', value: 'id' },
+        ],
+      },
+      defaultValue: 'entity',
+    }),
+  },
+  async run(context) {
+    const auth = context.auth as any;
+    const baseUrl = auth.baseUrl;
+    const { loanId, documents, view } = context.propsValue;
+
+    const accessToken = await getAccessToken(auth);
+
+    const queryParams = new URLSearchParams();
+    queryParams.append('action', 'update');
+    if (view) queryParams.append('view', view);
+
+    const response = await httpClient.sendRequest({
+      method: HttpMethod.PATCH,
+      url: `${baseUrl}/encompass/v3/loans/${loanId}/documents?${queryParams.toString()}`,
+      headers: {
+        'Content-Type': 'application/json',
+        'Authorization': `Bearer ${accessToken}`,
+      },
+      body: documents,
+    });
+
+    return response.body;
+  },
+});