The nestjs-jsforce from ntegral

nestjs-jsforce's Introduction

@ntegral/nestjs-jsforce

Provides an injectable jsforce client to provide features to the Salesforce API for your nestjs projects

About
Installation
Getting Started
Contributing
License
Acknowledgements

NestJS 8+ Support

Version 2.x.x will support NestJS 8+. If you need support for NestJS 7 or below please continue to use Version 1.x.x. Thanks for you support!

About

@ntegral/nestjs-force implements a module, JsForceModule, which when imported into your nestjs project provides a Salesforce Api client to any class that injects it. This lets Salesforce be worked into your dependency injection workflow without having to do any extra work outside of the initial setup.

Installation

npm install --save @ntegral/nestjs-force jsforce

Getting Started

The simplest way to use @ntegral/nestjs-force is to use JsForceModule.forRoot

import { Module } from '@nestjs-common';
import { JsForceModule } from '@ntegral/nestjs-force';

@Module({
  imports: [
    JsForceModule.forRoot({
      username: '[email protected]',
      password: 'account_password',
      security_token: 'token_value',
      options: {
          loginUrl: 'https://salesforce-env--sb01.my.salesforce.com/'
      }
    }),
  ],
})
export class AppModule {}

You can then inject the JsForce client into any of your injectables by using a custom decorator

import { Injectable } from '@nestjs/common';
import { InjectJsForce } from '@ntegral/nestjs-force';
import { Client } from '@ntegral/nestjs-force';

@Injectable()
export class AppService {
  public constructor(@InjectJsForce private readonly client: Client) {}

  listContacts() {
    let contacts = any[];
    this.client.conn.sobject("Contact").select().exec(undefined,(err, result) => {
        if (err) { return console.error(err); }
        console.log('results', result);
        contacts = result;
    });
    return contacts;
  }
}

Asynchronous setup is also supported

import { Module } from '@nestjs-common';
import { ConfigModule } from '../common/config/config.module';
import { ConfigService } from '../common/config/config.service';
import { JsForceModule } from '@ntegral/nestjs-force';

@Module({
  imports: [
    JsForceModule.forRootAsync({
      imports: [ConfigModule],  
      inject: [ConfigService],
      useFactory: (cfg: ConfigService) => ({
        username: '[email protected]',
        password: 'account_password',
        security_token: 'token_value',
        options: {
            loginUrl: 'https://salesforce-env--sb01.my.salesforce.com/'
        }
      }),
    }),
  ],
})
export class AppModule {}

Contributing

I would greatly appreciate any contributions to make this project better. Please make sure to follow the below guidelines before getting your hands dirty.

Fork the repository
Create your branch (git checkout -b my-branch)
Commit any changes to your branch
Push your changes to your remote branch
Open a pull request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

nestjs-jsforce's People

Contributors

Stargazers

Watchers

nestjs-jsforce's Issues

JSForce 2.0

I was looking over the "callback hell" that JSforce necessitates, from the look of things JSforce 2 uses the much better await/async pattern. Do you anticipate much trouble in updating your wrapper to the new version?

(not pressing, I'm really just asking as an excuse to say THANK YOU for making this wrapper, it works fantastically so far)

Connect to Service seems to have stopped working

When calling query function within a service file, nothing appears to happen.

Within app.module.ts

imports: [ JsForceModule.forRoot({ username: "[email protected]", password: "xxxxx", security_token: "xxxxxxxxxxxxxxxxxxxxx", options: { loginUrl: "xxxxxxxxxx.com" } }), ]

Within service file
`
constructor(
@InjectJsForce() private readonly client: Client
) {
}

async querySalesforce() {
const memberId = xxxxxxxxxxx;
await this.client.conn.query(SELECT Person_Code__c, Id FROM Contact WHERE Member_id__c='${memberId}', async (err, result) => {
if (err) {
console.log(err)
}
if (result) {
console.log(result)
}
})
}

Recommend Projects

ntegral / nestjs-jsforce Goto Github PK