@vqnguyen1/piece-icemortgage-encompass 0.0.1 → 0.0.2

package/IMPLEMENTATION_SUMMARY.md

@@ -0,0 +1,160 @@
+# IceMortgage Encompass Piece - Implementation Summary
+
+## Overview
+Successfully created an Activepieces custom piece for **IceMortgage Encompass** (formerly Ellie Mae) following the guidelines in `BUILDING_CUSTOM_PIECES.md`.
+
+## Piece Name
+**IceMortgage Encompass**
+
+## Package Details
+- **Package Name**: `@vqnguyen1/piece-icemortgage-encompass`
+- **Version**: 0.0.1
+- **License**: MIT
+- **Author**: vqnguyen1
+
+## Structure Created
+
+```
+packages/pieces/custom/icemortgage-encompass/
+├── package.json                      # With correct peerDependencies (*)
+├── project.json                      # Nx build configuration
+├── tsconfig.json                     # TypeScript config
+├── tsconfig.lib.json                 # Library-specific TS config
+├── README.md                         # Documentation
+└── src/
+    ├── index.ts                      # Main piece export
+    └── lib/
+        ├── common/
+        │   ├── auth.ts               # Authentication configuration
+        │   └── helpers.ts            # OAuth2 token helper
+        └── actions/
+            ├── create-loan.ts        # Create Loan action
+            ├── retrieve-loan.ts      # Retrieve Loan action
+            ├── update-loan.ts        # Update Loan action
+            ├── delete-loan.ts        # Delete Loan action
+            └── manage-field-locks.ts # Manage Field Locks action
+```
+
+## Authentication
+Uses **OAuth2 Client Credentials** flow with the following properties:
+- Base URL
+- Client ID
+- Client Secret
+- Instance ID
+
+## Actions Implemented
+
+### 1. Create Loan
+- Create new loans with full data or using templates
+- Supports template types: templateSet, loanProgram, closingCost
+- Returns loan ID and full loan data
+
+### 2. Retrieve Loan
+- Get complete loan information by loan ID
+- Simple GET operation
+
+### 3. Update Loan
+- Update existing loan fields
+- Supports applying templates during update
+- Configurable template options
+
+### 4. Delete Loan
+- Permanently remove a loan
+- Returns success confirmation
+
+### 5. Manage Field Locks
+- **Add**: Lock additional fields
+- **Remove**: Unlock specific fields
+- **Replace**: Replace all locked fields
+- Separate PATCH operations as requested
+
+## API Endpoints Covered
+
+Based on the Postman collection analysis:
+
+✅ **CREATE Operations**
+- POST `/encompass/v3/loans` (standard, with template set, TPO)
+
+✅ **RETRIEVE Operations**
+- GET `/encompass/v3/loans/{loanId}`
+
+✅ **UPDATE Operations**
+- PATCH `/encompass/v3/loans/{loanId}` (standard)
+- PATCH `/encompass/v3/loans/{loanId}/urlaVersion`
+- PATCH with templates (templateSet, loanProgram, closingCost)
+
+✅ **DELETE Operations**
+- DELETE `/encompass/v3/loans/{loanId}`
+
+✅ **FIELD LOCK Operations** (Kept Separate)
+- PATCH `/encompass/v3/loans/{loanId}/fieldLockData?action=add`
+- PATCH `/encompass/v3/loans/{loanId}/fieldLockData?action=remove`
+- PATCH `/encompass/v3/loans/{loanId}/fieldLockData?action=replace`
+
+## Build Status
+✅ **Successfully Built** with Nx
+
+Build output location:
+```
+dist/packages/pieces/custom/icemortgage-encompass/
+```
+
+Compiled files include:
+- JavaScript files (.js)
+- Type definitions (.d.ts)
+- Source maps (.js.map)
+- Transformed package.json
+- README.md
+
+## Compliance with BUILDING_CUSTOM_PIECES.md
+
+✅ Used `peerDependencies` with wildcard `"*"` versions
+✅ Imported `httpClient` from `@activepieces/pieces-common`
+✅ No file extensions in relative imports
+✅ Cast `context.auth` to `any` for property access
+✅ Source package.json points to TypeScript files
+✅ Built package.json correctly transformed to point to `.js` files
+✅ Added proper `type: "commonjs"` to package.json
+✅ Added `types` field to package.json
+
+## Next Steps
+
+To publish this piece:
+
+```bash
+# Navigate to built output
+cd dist/packages/pieces/custom/icemortgage-encompass
+
+# Verify the build
+ls -la src/  # Should see .js, .d.ts, .js.map files
+
+# Create tarball (optional)
+npm pack
+
+# Publish to npm
+npm publish --access public
+```
+
+To install in Activepieces:
+
+```bash
+curl -X POST http://localhost/api/v1/pieces \
+  -H "Content-Type: application/json" \
+  -d '{
+    "packageType": "REGISTRY",
+    "pieceName": "@vqnguyen1/piece-icemortgage-encompass",
+    "pieceVersion": "0.0.1"
+  }'
+```
+
+## API Reference Document
+Created comprehensive API reference at:
+`tmp/packages/shared/Encompass_V3_Manage_Loan_API_Consolidated.md`
+
+This document consolidates all API calls from the Postman collection with:
+- Request methods
+- Endpoints
+- Query parameters
+- Headers
+- Request bodies
+- Response details

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vqnguyen1/piece-icemortgage-encompass",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "license": "MIT",
   "main": "./src/index.js",
   "peerDependencies": {

package/src/index.js

@@ -14,7 +14,7 @@ exports.icemortgageEncompass = (0, pieces_framework_1.createPiece)({
     displayName: 'IceMortgage Encompass',
     auth: auth_1.icemortgageEncompassAuth,
     minimumSupportedRelease: '0.20.0',
-    logoUrl: 'https://cdn.activepieces.com/pieces/icemortgage-encompass.png',
+    logoUrl: 'logo.png',
     authors: ['vqnguyen1'],
     categories: [shared_1.PieceCategory.BUSINESS_INTELLIGENCE],
     actions: [

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/pieces/custom/icemortgage-encompass/src/index.ts"],"names":[],"mappings":";;;AAAA,qEAA6D;AAC7D,iDAAqD;AACrD,4CAA6D;AAwBpD,yGAxBA,+BAAwB,OAwBA;AAvBjC,2DAAuD;AACvD,+DAA2D;AAC3D,2DAAuD;AACvD,2DAAuD;AACvD,yEAAoE;AAEvD,QAAA,oBAAoB,GAAG,IAAA,8BAAW,EAAC;IAC9C,WAAW,EAAE,uBAAuB;IACpC,IAAI,EAAE,+BAAwB;IAC9B,uBAAuB,EAAE,QAAQ;IACjC,OAAO,EAAE,+DAA+D;IACxE,OAAO,EAAE,CAAC,WAAW,CAAC;IACtB,UAAU,EAAE,CAAC,sBAAa,CAAC,qBAAqB,CAAC;IACjD,OAAO,EAAE;QACP,wBAAU;QACV,4BAAY;QACZ,wBAAU;QACV,wBAAU;QACV,qCAAgB;KACjB;IACD,QAAQ,EAAE,EAAE;CACb,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/pieces/custom/icemortgage-encompass/src/index.ts"],"names":[],"mappings":";;;AAAA,qEAA6D;AAC7D,iDAAqD;AACrD,4CAA6D;AAwBpD,yGAxBA,+BAAwB,OAwBA;AAvBjC,2DAAuD;AACvD,+DAA2D;AAC3D,2DAAuD;AACvD,2DAAuD;AACvD,yEAAoE;AAEvD,QAAA,oBAAoB,GAAG,IAAA,8BAAW,EAAC;IAC9C,WAAW,EAAE,uBAAuB;IACpC,IAAI,EAAE,+BAAwB;IAC9B,uBAAuB,EAAE,QAAQ;IACjC,OAAO,EAAE,UAAU;IACnB,OAAO,EAAE,CAAC,WAAW,CAAC;IACtB,UAAU,EAAE,CAAC,sBAAa,CAAC,qBAAqB,CAAC;IACjD,OAAO,EAAE;QACP,wBAAU;QACV,4BAAY;QACZ,wBAAU;QACV,wBAAU;QACV,qCAAgB;KACjB;IACD,QAAQ,EAAE,EAAE;CACb,CAAC,CAAC"}