Tag: node-fetch

Download a Salesforce ContentVersion file using node-fetch

January 29th, 2023

Reading Time: < 1 minute

Salesforce content management allows users to store information such as documents, images, audio, and video files in their Salesforce org. On occasion, users may require to quickly and easily download certain content items from the Salesforce org using their own custom code.

Node-fetch is a popular Node.js library used by developers to create applications with the help of middleware, through a programming interface. Node-fetch is especially suitable for downloading Salesforce ContentVersion files.

Let’s download a file (ContentVersion) from Salesforce using node-fetch

The way to do it is to make a request to:

https://myinstance-dev-ed.my.salesforce.com/services/data/v52.0/sobjects/ContentVersion/0688J000000Di2xTBA/VersionData

First, let’s have a method to get the access token

      
const getJsForceConnection = async () => {
    const username = "******";
    const password = "******";
    const securityToken = "******";

    const salesforceUrl = "https://myinstance-dev-ed.my.salesforce.com";
    const salesforceApiVersion = "52.0";

    const options = {instanceUrl: salesforceUrl, loginUrl: salesforceUrl, version: salesforceApiVersion};
   
    const conn = new jsForce.Connection(options);
    await conn.login(username, password + securityToken);

    return conn;
}

And then let’s make a request to download the file using node-fetch

      
const downloadFile = async (conn, salesforceApiVersion, fileId) => {
    const url = `${conn.instanceUrl}/services/data/v${salesforceApiVersion}/sobjects/ContentVersion/${fileId}/VersionData`;
    const ops = {
        method: 'GET',
        headers: {
            'Content-Type': 'application/octet-stream',
            'Authorization': 'OAuth '+conn.accessToken
        }
    };

    const fileFullPath = `${os.tmpdir()}/file.txt`; // probably you will need a random file here and also to know the file extension
    const res = await fetch(url, ops);
    const fileStream = fs.createWriteStream(fileFullPath);

    if(!res.ok) throw new Error(`error downloading file from ${url} status code: ${res.status} status message ${res.statusText}`);

    await new Promise((resolve, reject) => {
        res.body.pipe(fileStream);
        res.body.on("error", reject);
        fileStream.on("finish", resolve);
    });
}

If you want to download the file without using node-fetch see
https://www.javaniceday.com/post/salesforce-rest-api-download-contentversion

Photo by kaleb tapp on Unsplash

Mock node-fetch in node.js with different scenarios

July 11th, 2022

Reading Time: < 1 minute

      
const getWithNodeFetch = async () => {
    const ops = {
        method: 'GET',
        headers: {
            'Content-Type': 'application/json',
            'Authorization': 'OAuth [some access token]'
        }
    };
    const res = await fetch('https://example.com', ops);
    if(!res.ok) throw new Error(`error doing GET status code: ${res.status} status message ${res.statusText}`);
    return res.json();
}

      
const getFileWithNodeFetch = async () => {
    const ops = {
        method: 'GET',
        headers: {
            'Content-Type': 'application/octet-stream',
            'Authorization': 'OAuth [some access token]'
        }
    };

    const fileFullPath = `${os.tmpdir()}/file.txt`;
    const res = await fetch('https://example.com/file.txt', ops);
    const fileStream = fs.createWriteStream(fileFullPath);

    if(!res.ok) throw new Error(`error downloading file. status code: ${res.status} status message ${res.statusText}`);

    await new Promise((resolve, reject) => {
        res.body.pipe(fileStream);
        res.body.on("error", reject);
        fileStream.on("finish", resolve);
    });
    return  {filePath: fileFullPath};

}

      
const fetch = require("node-fetch");
jest.mock('node-fetch');

      
fetch.mockReset();
fetch.mockImplementation((url, options) => {
  if (options.headers["Content-Type"] == "application/json") {
    return Promise.resolve({
      ok: true,
      status: 200,
      statusText: "ok",
      json: () => {
        return {
          name: "test",
          fileExtension: "txt",
        };
      },
    });
  } else {
    return Promise.resolve({
      ok: false,
      status: 500,
      statusText: "some error",
    });
  }
});

      
fetch.mockReset();
fetch.mockReturnValue({
    status: 500,
    statusText: "error",
    json: () => ({})
});

      
fetch.mockReset();
fetch.mockReturnValue({
    status: 404,
    statusText: "File not found",
    json: () => ({})
});

      
fetch.mockReset();
fetch.mockReturnValue({
    ok: true,
    status: 200,
    statusText: "ok",
    body: {
        pipe: () => ({}),
        on: () => ({})
    },
    json: () => {
        return {
            name: "test",
            fileExtension: "txt"
        }
    }
});

Photo by Francesco Gallarotti on Unsplash

Get Salesforce ContentVersion file info using node-fetch

July 7th, 2022
Reading Time: 2 minutes
Salesforce ContentVersion is a standard Salesforce object that represents a specific version of a file or document in Salesforce. It is used to store and manage various types of content, such as attachments, files, or document versions. Each ContentVersion record contains information about the file, including its title, file name, file extension, and other metadata. ContentVersion records can be associated with specific records in Salesforce, such as accounts, opportunities, or custom objects, allowing users to easily access and manage the related files.

Node-fetch is a JavaScript library that provides an easy and convenient way to make HTTP requests in a Node.js environment. It allows you to send HTTP requests to remote servers and receive responses, making it useful for tasks such as fetching data from APIs or downloading files. Node-fetch simplifies the process of making HTTP requests by providing a simple and intuitive API.

Let’s say you want to get the file info without downloading it. For example, you want to know the file name and extension. The way to do it is to make a request to:
```
https://myinstance-dev-ed.my.salesforce.com/services/data/v52.0/sobjects/ContentVersion/0688J000000Di2xTBA
```
First, let’s have a method to get the access token
```
const getJsForceConnection = async () => {
    const username = "******";
    const password = "******";
    const securityToken = "******";

    const salesforceUrl = "https://myinstance-dev-ed.my.salesforce.com";
    const salesforceApiVersion = "52.0";

    const options = {instanceUrl: salesforceUrl, loginUrl: salesforceUrl, version: salesforceApiVersion};
   
    const conn = new jsForce.Connection(options);
    await conn.login(username, password + securityToken);

    return conn;
}
      
```
And then let’s make a request to get the file info with node-fetch
```
const getFileInfo = async (conn, salesforceFileId, salesforceApiVersion) => {
    const url = `${conn.instanceUrl}/services/data/v${salesforceApiVersion}/sobjects/ContentVersion/${salesforceFileId}`;
    const ops = {
        method: 'GET',
        headers: {
            'Content-Type': 'application/json',
            'Authorization': 'OAuth '+conn.accessToken
        }
    };
    const res = await fetch(url, ops);

    if(!res.ok) throw new Error(`error getting file info from ${url} status code: ${res.status} status message ${res.statusText}`);

    const json = await res.json();
    return {
        fileTitle: json.Title,
        fileName: `${json.Title}.${json.FileExtension}`,
        fileExtension: json.FileExtension,
        fileId: salesforceFileId,
    };
}
      
```
If you want to download the file without using node-fetch see
https://www.javaniceday.com/post/salesforce-rest-api-download-contentversion

November 15, 2023Salesforce Flows have this little big drawback
November 10, 2023How to publish Salesforce platform events from Salesforce API from Node.js
November 7, 2023How to generate Database.SaveResult mocks in Salesforce
October 19, 2023How to disable parallel tests in Salesforce
October 3, 2023SFDX CLI Error: default level:TRACE must be included in custom levels
September 23, 2023What is Dreamforce?
September 21, 2023Example of Apex HttpCalloutMock
September 20, 2023How to mock callouts in Salesforce Apex

How to send a pushengage notification with node-fetch

January 15th, 2022

Reading Time: < 1 minute

Context

Sending push notifications from pushengage.com dashboard is pretty easy but what about f we want to automate some process in our web site? For instance, let say we want to send a push notification every time you create a blog post

The code

      

  const baseUrl = 'https://api.pushengage.com/apiv1/notifications';
  const params = {
    title: '[notification title here]',
    message: '[notification message here]',
    url: '[notification url here]',
    imageUrl: '[your image url here]',
  };
  const requestParams = `notification_type=draft&notification_title=${params.title}&notification_message=${params.message}&notification_url=${params.url}&image_url=${params.imageUrl}`;
  const url = baseUrl;
  const res = await fetch(url,
    {
      method: 'POST',
      headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        api_key: [your_api_key_here],
      },
      body: requestParams,
    });
  const body = await res.text();
  console.info(res.status);
  console.info(body);

Note: have in mind we are sending the notification as a draft: notification_type=draft. Once ready, remove that parameter to send the real notification

Output

The first console log will print 200 status code and the second one the operation result as json

      
200
{"success":true,"notification_id":13623215772}

Photo by Andres Canavesi on Unsplash

Tag: node-fetch

Download a Salesforce ContentVersion file using node-fetch

Mock node-fetch in node.js with different scenarios

Get Salesforce ContentVersion file info using node-fetch

How to send a pushengage notification with node-fetch

Context

The code

Output