Skip to content

Commit 20dd0c2

Browse files
ritz078ritz078
committed
Add Salesforce example for PSPDFKit integration
- Created a new Salesforce example project demonstrating the integration of PSPDFKit. - Added essential files including package.json, README.md, and configuration files for Salesforce setup. - Implemented a Lightning Web Component (LWC) for file upload and PDF viewing functionality. - Included Apex classes for handling file attachments and base64 data retrieval. - Added necessary ESLint and Prettier configurations for code quality. - Introduced .forceignore and .gitignore files to exclude unnecessary files and directories. - Provided detailed instructions in the README for getting started and deploying the example.
1 parent 17117e0 commit 20dd0c2

38 files changed

+11250
-1
lines changed

‎examples/salesforce/.forceignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
**/jsconfig.json
2+
3+
**/.eslintrc.json

‎examples/salesforce/.github/ISSUE_TEMPLATE/GENERAL.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: "🕷️ Issue"
3+
about: "Regular issue following our issue standard."
4+
assignees: ""
5+
---
6+
7+
## Details
8+
9+
### Note
10+
11+
When you modify the code, check and update the code snippets in the [Salesforce guides](https://www.nutrient.io/guides/web/salesforce/).

‎examples/salesforce/.gitignore

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
node_modules
2+
force-app/main/default/staticresources/PSPDFKit_lib
3+
force-app/main/default/staticresources/PSPDFKit_lib.zip
4+
force-app/main/default/staticresources/PSPDFKit_core
5+
force-app/main/default/staticresources/PSPDFKit_core.zip
6+
force-app/main/default/staticresources/PSPDFKit.js
7+
.DS_Store

‎examples/salesforce/README.md

+126
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# PSPDFKit for Salesforce Integration
2+
3+
## Integrate into a New Salesforce Project as a Lightning Web Component
4+
5+
PSPDFKit for Salesforce enables you to open PDF, JPG, PNG, and TIFF files inside Salesforce. This unlocks the full functionality of PSPDFKit in Salesforce, including PDF generation, redaction, and signatures.
6+
7+
This README explains how to integrate PSPDFKit into a new Salesforce project. The integration works as a [Lightning web component (LWC)][lwc] that you can add to any Salesforce organization.
8+
9+
For more information on integrating PSPDFKit into an existing Salesforce project, see the [PSPDFKit for Salesforce documentation][salesforce docs].
10+
11+
PSPDFKit for Salesforce shares the same APIs as Nutrient Web SDK Standalone. For more information on customizing your Salesforce application, see the [Nutrient Web SDK Standalone documentation][web docs].
12+
13+
## Requirements
14+
15+
Before continuing, perform all of the following actions:
16+
17+
- Set up a [Salesforce Developer Edition account][developer].
18+
- Install the [Salesforce CLI][].
19+
- Install the [latest stable version of Node.js][node.js].
20+
- Install a package manager compatible with [npm][about-npm]. This README contains usage examples for the [npm client][npm-client], which is installed with Node.js by default.
21+
22+
## Deploying the Package
23+
24+
To deploy the PSPDFKit package to your Salesforce organization, follow these steps.
25+
26+
1. Download the [PSPDFKit for Salesforce project][zip] from GitHub, and then unpack the ZIP file.
27+
28+
Alternatively, run the following terminal command to clone the [PSPDFKit for Salesforce repository][repo] from GitHub:
29+
30+
```bash
31+
git clone https://github.com/PSPDFKit/salesforce.git
32+
```
33+
34+
2. In the terminal, go to the PSPDFKit for Salesforce project folder and run the following command to install the PSPDFKit npm module.
35+
36+
Use the following code for npm:
37+
38+
```npm
39+
npm install
40+
```
41+
42+
Use the following code for Yarn:
43+
44+
```yarn
45+
yarn install
46+
```
47+
48+
3. The PSPDFKit for Salesforce integration example now makes use of the PSPDFKit version available from our CDN at https://cdn.cloud.www.nutrient.io/pspdfkit-web, which means it's no longer limited by Salesforce's upload assets size 5MB limit.
49+
50+
In order to set the PSPDFKit version you want to use, open `./force-app/main/default/pages/PSPDFKit_InitPSPDFKit.page` and edit the line 7 to reflect the PSPDFKit version. For example, in order to use version 2024.4.0, you should change the URL pointing to the CDN to:
51+
52+
```html
53+
<script src="https://cdn.cloud.www.nutrient.io/[email protected]/pspdfkit.js" type="text/javascript"></script>
54+
```
55+
56+
You can find the latest version of Nutrient Web SDK in the [PSPDFKit changelog](https://www.nutrient.io/changelog/web/).
57+
58+
4. Run the following command in the terminal to start the Salesforce authentication process:
59+
60+
```bash
61+
sfdx force:auth:web:login --setalias mySalesforceOrg --instanceurl https://login.salesforce.com --setdefaultusername
62+
```
63+
64+
5. In the browser window that opens, log in to your Salesforce organization and authorize the Salesforce CLI.
65+
66+
6. In the terminal, run the following command from the PSPDFKit for Salesforce project’s root folder:
67+
68+
```bash
69+
sfdx force:source:deploy -x manifest/package.xml
70+
```
71+
72+
## Enabling Users to Use PSPDFKit
73+
74+
To enable users of your Salesforce organization to use PSPDFKit, follow these steps.
75+
76+
1. In Salesforce, go to **Users** > **Permission Sets**.
77+
78+
2. Find **PSPDFKit Admin Access** in the list and click it.
79+
80+
3. Click **Manage Assignments**.
81+
82+
4. Click **Add Assignment**.
83+
84+
5. Select the users you want to authorize to use PSPDFKit.
85+
86+
6. Click **Next**, and then click **Assign**.
87+
88+
## Changing the Security Settings
89+
90+
PSPDFKit for Salesforce requires Lightning Locker to protect Lightning web components, but Salesforce uses Lightning Web Security by default. To change the default security settings, follow these steps.
91+
92+
1. In Salesforce, go to **Security** > **Session Settings**.
93+
94+
2. Deselect **Use Lightning Web Security for Lightning web components**.
95+
96+
3. Scroll down and click **Save**.
97+
98+
## Using the PSPDFKit for Salesforce Integration
99+
100+
To use PSPDFKit in your Salesforce organization, follow these steps.
101+
102+
1. Ensure you’re logged in as a user authorized to use PSPDFKit.
103+
104+
2. In the top-right corner, open the App Launcher.
105+
106+
3. Search for and select **PSPDFKit**.
107+
108+
4. Click **browse** to upload local PDF files, or open a file from Salesforce.
109+
110+
## Next Steps
111+
112+
- [Open documents from Salesforce][]
113+
- [Save files back to Salesforce][]
114+
115+
[web docs]: https://www.nutrient.io/guides/web/
116+
[salesforce docs]: https://www.nutrient.io/getting-started/web-integrations/?product=salesforce&project=existing-project
117+
[lwc]: https://developer.salesforce.com/docs/component-library/documentation/en/lwc
118+
[developer]: https://developer.salesforce.com/signup
119+
[salesforce cli]: https://developer.salesforce.com/tools/sfdxcli
120+
[node.js]: https://nodejs.org/en/download/
121+
[about-npm]: https://docs.npmjs.com/about-npm
122+
[npm-client]: https://docs.npmjs.com/cli/v7/commands/npm
123+
[open documents from salesforce]: https://www.nutrient.io/guides/web/open-a-document/from-salesforce/
124+
[save files back to salesforce]: https://www.nutrient.io/guides/web/save-a-document/to-salesforce/
125+
[zip]: https://github.com/PSPDFKit/salesforce/archive/refs/heads/master.zip
126+
[repo]: https://github.com/PSPDFKit/salesforce/

‎examples/salesforce/config/project-scratch-def.json

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"orgName": "Demo company",
3+
"edition": "Developer",
4+
"features": ["EnableSetPasswordInApi"],
5+
"settings": {
6+
"lightningExperienceSettings": {
7+
"enableS1DesktopEnabled": true
8+
},
9+
"mobileSettings": {
10+
"enableS1EncryptedStoragePref2": false
11+
}
12+
}
13+
}

‎examples/salesforce/force-app/main/default/aura/.eslintrc.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"plugins": ["@salesforce/eslint-plugin-aura"],
3+
"extends": ["plugin:@salesforce/eslint-plugin-aura/recommended"],
4+
"rules": {
5+
"vars-on-top": "off",
6+
"no-unused-expressions": "off"
7+
}
8+
}

‎examples/salesforce/force-app/main/default/classes/PSPDFKitController.cls

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
global with sharing class PSPDFKitController {
2+
public static contentVersion contVersion{get;set;}
3+
public static String conbase{get;set;}
4+
5+
@AuraEnabled
6+
public static list<ContentDocument> getAttachmentDetails(string record_Id){
7+
if(record_Id == null || record_Id == ''){
8+
return [SELECT Title, FileExtension, OwnerId FROM ContentDocument];
9+
}else{
10+
list<ContentDocumentLink> doccontList = [SELECT contentDocumentId FROM ContentDocumentLink where LinkedEntityId=:record_Id];
11+
set<Id> idSet = new set<Id>();
12+
for(ContentDocumentLink cd :doccontList ){
13+
idSet.add(cd.contentDocumentId);
14+
}
15+
list<ContentDocument> contentDocList = [SELECT Title, FileExtension, OwnerId FROM ContentDocument where id in:idSet];
16+
return contentDocList;
17+
}
18+
}
19+
20+
public string getFileDetail(){
21+
try {
22+
String recId = ApexPages.currentPage().getParameters().get('id');
23+
Map<String,String> filedNameVsValue = new Map<String,String>();
24+
if(recId != null){
25+
contVersion = [SELECT Id, Title, contentDocumentId, PathOnClient, FileExtension, VersionData, IsMajorVersion FROM contentVersion WHERE IsLatest = true AND contentDocumentId =: ApexPages.currentPage().getParameters().get('id')];
26+
conbase = EncodingUtil.Base64Encode(contVersion.VersionData);
27+
return 'Success';
28+
}else{
29+
return null;
30+
}
31+
} catch (Exception e) {
32+
throw new AuraHandledException(e.getMessage());
33+
}
34+
}
35+
36+
@AuraEnabled
37+
public static Map<String,String> getbase64Data(String strId){
38+
try {
39+
Map<String,String> filedNameVsValue = new Map<String,String>();
40+
ContentVersion newList = [SELECT Id, VersionData, FileType, Title, FileExtension, ContentDocumentId, PathOnClient FROM ContentVersion WHERE ContentDocumentId = :strId AND IsLatest = true];
41+
filedNameVsValue.put('ContentDocumentId',newList.ContentDocumentId);
42+
filedNameVsValue.put('PathOnClient',newList.PathOnClient);
43+
filedNameVsValue.put('VersionData',EncodingUtil.Base64Encode(newList.VersionData));
44+
return filedNameVsValue;
45+
} catch (Exception e) {
46+
throw new AuraHandledException(e.getMessage());
47+
}
48+
}
49+
50+
}

‎examples/salesforce/force-app/main/default/classes/PSPDFKitController.cls-meta.xml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>54.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

‎examples/salesforce/force-app/main/default/classes/PSPDFKitControllerTest.cls

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
@IsTest
2+
public class PSPDFKitControllerTest {
3+
4+
@testSetup static void setup() {
5+
Account testAccts = new Account(Name = 'TestAcct');
6+
insert testAccts;
7+
8+
string textFile = 'This is a test data';
9+
ContentVersion docVer = New ContentVersion();
10+
docVer.ContentLocation = 'S';
11+
docVer.PathOnClient = 'Test.txt';
12+
docVer.Title = 'Test.txt';
13+
Blob textData = Blob.valueOf(textFile);
14+
docVer.VersionData = textData;
15+
insert docVer;
16+
17+
string verId = [SELECT contentDocumentId FROM contentVersion where id =: docVer.id].contentDocumentId;
18+
ContentDocumentLink docLink = new ContentDocumentLink();
19+
docLink.ContentDocumentId = verId;
20+
docLink.LinkedEntityId = testAccts.Id;
21+
docLink.sharetype = 'I';
22+
docLink.Visibility = 'AllUsers';
23+
insert docLink;
24+
}
25+
26+
@isTest
27+
static void testGetAttacmentDetails() {
28+
Account act = [SELECT id FROM Account];
29+
Test.startTest();
30+
List <ContentDocument> conDocList = PSPDFKitController.getAttachmentDetails(act.Id);
31+
Test.stopTest();
32+
System.assertEquals(1,conDocList.size());
33+
}
34+
35+
@isTest
36+
static void testGetbase64Data() {
37+
Account act = [SELECT id FROM Account];
38+
ContentDocumentLink docLink = [SELECT contentDocumentId From ContentDocumentLink where LinkedEntityId=:act.Id];
39+
Test.startTest();
40+
Map<String,String> base64Data = PSPDFKitController.getbase64Data(docLink.contentDocumentId);
41+
Test.stopTest();
42+
System.assertEquals(3,base64Data.size());
43+
}
44+
45+
@isTest
46+
static void testGetFileDetail() {
47+
Account act = [SELECT id FROM Account];
48+
ContentDocumentLink docLink = [SELECT contentDocumentId From ContentDocumentLink where LinkedEntityId=:act.Id];
49+
Test.StartTest();
50+
ApexPages.StandardController sc = new ApexPages.StandardController(docLink);
51+
PSPDFKitController testAccPlan = new PSPDFKitController();
52+
53+
PageReference pageRef = Page.PSPDFKit_InitPSPDFKit;
54+
pageRef.getParameters().put('id', String.valueOf(docLink.contentDocumentId));
55+
Test.setCurrentPage(pageRef);
56+
57+
testAccPlan.getFileDetail();
58+
Test.StopTest();
59+
}
60+
}

‎examples/salesforce/force-app/main/default/classes/PSPDFKitControllerTest.cls-meta.xml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>54.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

‎examples/salesforce/force-app/main/default/labels/CustomLabels.labels-meta.xml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<CustomLabels xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<labels>
4+
<fullName>Button_label</fullName>
5+
<language>en_US</language>
6+
<protected>true</protected>
7+
<shortDescription>Button label</shortDescription>
8+
<value>Edit File with PSPDFKit</value>
9+
</labels>
10+
</CustomLabels>

‎examples/salesforce/force-app/main/default/lwc/.eslintrc.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"extends": ["@salesforce/eslint-config-lwc/recommended"],
3+
"overrides": [
4+
{
5+
"files": ["*.test.js"],
6+
"rules": {
7+
"@lwc/lwc/no-unexpected-wire-adapter-usages": "off"
8+
},
9+
"env": {
10+
"node": true
11+
}
12+
}
13+
]
14+
}

‎examples/salesforce/force-app/main/default/lwc/jsconfig.json

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"compilerOptions": {
3+
"experimentalDecorators": true
4+
},
5+
"include": ["**/*", "../../../../.sfdx/typings/lwc/**/*.d.ts"],
6+
"paths": {
7+
"c/*": ["*"]
8+
},
9+
"typeAcquisition": {
10+
"include": ["jest"]
11+
}
12+
}

‎examples/salesforce/force-app/main/default/lwc/pspdfkitEditButtonSolution/pspdfkitEditButtonSolution.html

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<template>
2+
<div class="slds-grid slds-wrap">
3+
<div class="slds-col slds-size_1-of-1 slds-p-horizontal_x-small slds-align_absolute-center">
4+
<button class="slds-button slds-button_brand slds-size_1-of-1" onclick={openFileInNewTab}>{btnLabel}</button>
5+
</div>
6+
</div>
7+
</template>

‎examples/salesforce/force-app/main/default/lwc/pspdfkitEditButtonSolution/pspdfkitEditButtonSolution.js

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
import Button_label from "@salesforce/label/c.Button_label";
2+
import { LightningElement, api, track } from "lwc";
3+
export default class PSPDFKitEditButtonSolution extends LightningElement {
4+
@api recordId;
5+
@api btnColor;
6+
@api newTab = false;
7+
@track newWindow;
8+
@track btnLabel = Button_label;
9+
10+
renderedCallback() {
11+
this.template.querySelector("button").style =
12+
`background-color:${this.btnColor}`;
13+
}
14+
15+
openFileInNewTab() {
16+
if (this.newTab === true) {
17+
this.newWindow = window.open(
18+
`/apex/PSPDFKit_InitPSPDFKit?id=${this.recordId}`,
19+
"_blank",
20+
);
21+
} else {
22+
this.newWindow = window.open(
23+
`/apex/PSPDFKit_InitPSPDFKit?id=${this.recordId}`,
24+
"_self",
25+
);
26+
}
27+
}
28+
}

‎examples/salesforce/force-app/main/default/lwc/pspdfkitEditButtonSolution/pspdfkitEditButtonSolution.js-meta.xml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>55.0</apiVersion>
4+
<isExposed>true</isExposed>
5+
<targets>
6+
<target>lightning__RecordPage</target>
7+
</targets>
8+
<targetConfigs>
9+
<targetConfig targets="lightning__RecordPage">
10+
<property name="newTab" type="Boolean" default="false" label="Open edit mode in new tab"/>
11+
<property name="btnColor" type="String" default="#0059b3" placeholder="eg- #0059b3 or red" label="Enter the color of Button"/>
12+
</targetConfig>
13+
</targetConfigs>
14+
</LightningComponentBundle>

0 commit comments

Comments
 (0)