Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Forcifier Build Status

Forcifier is a node package that provides utility functions for dealing with Force.com fields to make them pretty and easier to work with. Since Force.com is case insensitive, REST calls may return JSON with keys such as Country_code_AND_City__c. The forcifier package will convert JSON keys and list of fields into something like country_code_and_city which makes life much easier when writing applications in Node.js.

This module is particularly useful when used in conjunction with the awesome nforce package.

Installation

$ npm install forcifier

Key Features

1 . 'Deforces' a list of field names so that "id,Name,Field1__c,field2__c" is converted to "id,name,field1,field2".

forcifier.deforceList('id,Name,Field1__c,field2__c');
=> id,name,field1,field2

2 . 'Enforces' a list of fields names so that "id,name,field1,field2" is converted to "id,name,field1__c,field2__c".

forcifier.enforceList('id,name,field1,field2');
=> id,name,field1__c,field2__c

3 . 'Deforces' JSON keys from Force.com so that all keys will be lowercase and will have "__c" removed. For example, the following JSON returned by nforce will look like:

{
  "totalSize": 2,
  "done": true,
  "records": [
    {
      "attributes": {
        "type": "Account",
        "url": "/services/data/v27.0/sobjects/Account/001K000000f9XMDIA2"
      },
      "Id": "001K000000f9XMDIA2",
      "Name": "ACME Corp Ltd.",
      "Logo__c": "logo-big.jpg"
    },
    {
      "attributes": {
        "type": "Account",
        "url": "/services/data/v27.0/sobjects/Account/001K000000f8R8aIAE"
      },
      "Id": "001K000000f8R8aIAE",
      "Name": "XYZ Corp",
      "Logo__c": "logo.png"
    }
  ]
}

Invoking forcifier.deforceJson(my_json) will remove the trailing '__c' from all keys and change them to lowercase:

{
  "totalsize": 2,
  "done": true,
  "records": {
    "0": {
      "attributes": {
        "type": "Account",
        "url": "/services/data/v27.0/sobjects/Account/001K000000f9XMDIA2"
      },
      "id": "001K000000f9XMDIA2",
      "name": "ACME Corp Ltd.",
      "logo": "logo-big.jpg"
    },
    "1": {
      "attributes": {
        "type": "Account",
        "url": "/services/data/v27.0/sobjects/Account/001K000000f8R8aIAE"
      },
      "id": "001K000000f8R8aIAE",
      "name": "XYZ Corp",
      "logo": "logo.png"
    }
  }
}

4 . 'Enforces' JSON keys so that all non-standard Force.com fields will be appended with "__c". This is useful when you want to POST or PUT data back to Force.com. Enforcing your JSON will add '__c' to fields where necessary.

{
  "totalsize": 2,
  "done": true,
  "records": {
    "0": {
      "attributes": {
        "type": "Account",
        "url": "/services/data/v27.0/sobjects/Account/001K000000f9XMDIA2"
      },
      "id": "001K000000f9XMDIA2",
      "name": "ACME Corp Ltd.",
      "logo": "logo-big.jpg"
    },
    "1": {
      "attributes": {
        "type": "Account",
        "url": "/services/data/v27.0/sobjects/Account/001K000000f8R8aIAE"
      },
      "id": "001K000000f8R8aIAE",
      "name": "XYZ Corp",
      "logo": "logo.png"
    }
  }
}

Invoking forcifier.enforceJson(my_json) will append '__c' to keys where required. It does not change the case of the keys as Force.com is case insensitive.

{
  "totalsize": 2,
  "done": true,
  "records": {
    "0": {
      "attributes": {
        "type": "Account",
        "url": "/services/data/v27.0/sobjects/Account/001K000000f9XMDIA2"
      },
      "id": "001K000000f9XMDIA2",
      "name": "ACME Corp Ltd.",
      "logo__c": "logo-big.jpg"
    },
    "1": {
      "attributes": {
        "type": "Account",
        "url": "/services/data/v27.0/sobjects/Account/001K000000f8R8aIAE"
      },
      "id": "001K000000f8R8aIAE",
      "name": "XYZ Corp",
      "logo__c": "logo.png"
    }
  }
}

Contributors

About

Forcifier is a Node.js package that provides utility functions for dealing with Force.com fields to make them pretty and easier to work with.

Resources

License

Releases

No releases published
You can’t perform that action at this time.