@bonsae/node-red-salesforce 0.1.0

package/examples/5-dml-delete.json

@@ -0,0 +1,83 @@
+[
+  {
+    "id": "flow-delete",
+    "type": "tab",
+    "label": "DML Delete",
+    "disabled": false,
+    "info": "Find an account by name and delete it"
+  },
+  {
+    "id": "config-sf-4",
+    "type": "salesforce-connection",
+    "name": "Salesforce",
+    "loginUrl": "https://login.salesforce.com",
+    "clientId": "",
+    "apiVersion": "62.0",
+    "callbackUrl": "http://localhost:1880/salesforce/auth/callback",
+    "z": ""
+  },
+  {
+    "id": "inject-delete",
+    "type": "inject",
+    "z": "flow-delete",
+    "name": "Delete Account",
+    "props": [],
+    "repeat": "",
+    "once": false,
+    "x": 140,
+    "y": 80,
+    "wires": [["soql-find-delete"]]
+  },
+  {
+    "id": "soql-find-delete",
+    "type": "salesforce-soql",
+    "z": "flow-delete",
+    "name": "Find Account",
+    "connection": "config-sf-4",
+    "query": {
+      "type": "str",
+      "value": "SELECT Id FROM Account WHERE Name = 'Node-RED Test' LIMIT 1"
+    },
+    "x": 340,
+    "y": 80,
+    "wires": [["func-extract-id"]]
+  },
+  {
+    "id": "func-extract-id",
+    "type": "function",
+    "z": "flow-delete",
+    "name": "Extract ID",
+    "func": "if (msg.payload && msg.payload.length > 0) {\n    msg.payload = msg.payload[0].Id;\n    return msg;\n}\nnode.warn(\"No account found\");\nreturn null;",
+    "outputs": 1,
+    "x": 530,
+    "y": 80,
+    "wires": [["dml-delete"]]
+  },
+  {
+    "id": "dml-delete",
+    "type": "salesforce-dml",
+    "z": "flow-delete",
+    "name": "Delete Account",
+    "connection": "config-sf-4",
+    "operation": "delete",
+    "sObjectType": { "type": "str", "value": "Account" },
+    "record": { "type": "msg", "value": "payload" },
+    "externalIdField": "",
+    "x": 730,
+    "y": 80,
+    "wires": [["debug-delete"]]
+  },
+  {
+    "id": "debug-delete",
+    "type": "debug",
+    "z": "flow-delete",
+    "name": "Result",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "complete": "payload",
+    "x": 910,
+    "y": 80,
+    "wires": []
+  }
+]

package/examples/6-describe.json

@@ -0,0 +1,97 @@
+[
+  {
+    "id": "flow-describe",
+    "type": "tab",
+    "label": "Describe SObject",
+    "disabled": false,
+    "info": "Retrieve metadata for a Salesforce SObject"
+  },
+  {
+    "id": "config-sf-5",
+    "type": "salesforce-connection",
+    "name": "Salesforce",
+    "loginUrl": "https://login.salesforce.com",
+    "clientId": "",
+    "apiVersion": "62.0",
+    "callbackUrl": "http://localhost:1880/salesforce/auth/callback",
+    "z": ""
+  },
+  {
+    "id": "inject-describe-account",
+    "type": "inject",
+    "z": "flow-describe",
+    "name": "Describe Account",
+    "props": [],
+    "repeat": "",
+    "once": false,
+    "x": 150,
+    "y": 80,
+    "wires": [["describe-account"]]
+  },
+  {
+    "id": "describe-account",
+    "type": "salesforce-describe",
+    "z": "flow-describe",
+    "name": "Account Metadata",
+    "connection": "config-sf-5",
+    "sObjectType": { "type": "str", "value": "Account" },
+    "x": 380,
+    "y": 80,
+    "wires": [["debug-describe-1"]]
+  },
+  {
+    "id": "debug-describe-1",
+    "type": "debug",
+    "z": "flow-describe",
+    "name": "Metadata",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "complete": "payload",
+    "x": 570,
+    "y": 80,
+    "wires": []
+  },
+  {
+    "id": "inject-describe-dynamic",
+    "type": "inject",
+    "z": "flow-describe",
+    "name": "Describe Contact",
+    "props": [
+      {
+        "p": "sobject",
+        "v": "Contact",
+        "vt": "str"
+      }
+    ],
+    "repeat": "",
+    "once": false,
+    "x": 150,
+    "y": 180,
+    "wires": [["describe-dynamic"]]
+  },
+  {
+    "id": "describe-dynamic",
+    "type": "salesforce-describe",
+    "z": "flow-describe",
+    "name": "Dynamic Describe",
+    "connection": "config-sf-5",
+    "sObjectType": { "type": "msg", "value": "sobject" },
+    "x": 380,
+    "y": 180,
+    "wires": [["debug-describe-2"]]
+  },
+  {
+    "id": "debug-describe-2",
+    "type": "debug",
+    "z": "flow-describe",
+    "name": "Metadata",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "complete": "payload",
+    "x": 570,
+    "y": 180,
+    "wires": []
+  }
+]

package/examples/7-apex-rest.json

@@ -0,0 +1,99 @@
+[
+  {
+    "id": "flow-apex",
+    "type": "tab",
+    "label": "Apex REST",
+    "disabled": false,
+    "info": "Invoke custom Apex REST endpoints. Requires an @RestResource class deployed in your org."
+  },
+  {
+    "id": "config-sf-6",
+    "type": "salesforce-connection",
+    "name": "Salesforce",
+    "loginUrl": "https://login.salesforce.com",
+    "clientId": "",
+    "apiVersion": "62.0",
+    "callbackUrl": "http://localhost:1880/salesforce/auth/callback",
+    "z": ""
+  },
+  {
+    "id": "inject-apex-post",
+    "type": "inject",
+    "z": "flow-apex",
+    "name": "POST Request",
+    "props": [
+      {
+        "p": "payload",
+        "v": "{\"name\":\"Test\",\"action\":\"create\"}",
+        "vt": "json"
+      }
+    ],
+    "repeat": "",
+    "once": false,
+    "x": 140,
+    "y": 80,
+    "wires": [["apex-post"]]
+  },
+  {
+    "id": "apex-post",
+    "type": "salesforce-apex",
+    "z": "flow-apex",
+    "name": "POST /MyEndpoint",
+    "connection": "config-sf-6",
+    "method": "POST",
+    "path": { "type": "str", "value": "/MyEndpoint" },
+    "x": 360,
+    "y": 80,
+    "wires": [["debug-apex-post"]]
+  },
+  {
+    "id": "debug-apex-post",
+    "type": "debug",
+    "z": "flow-apex",
+    "name": "Response",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "complete": "payload",
+    "x": 560,
+    "y": 80,
+    "wires": []
+  },
+  {
+    "id": "inject-apex-get",
+    "type": "inject",
+    "z": "flow-apex",
+    "name": "GET Request",
+    "props": [],
+    "repeat": "",
+    "once": false,
+    "x": 140,
+    "y": 180,
+    "wires": [["apex-get"]]
+  },
+  {
+    "id": "apex-get",
+    "type": "salesforce-apex",
+    "z": "flow-apex",
+    "name": "GET /MyEndpoint",
+    "connection": "config-sf-6",
+    "method": "GET",
+    "path": { "type": "str", "value": "/MyEndpoint" },
+    "x": 360,
+    "y": 180,
+    "wires": [["debug-apex-get"]]
+  },
+  {
+    "id": "debug-apex-get",
+    "type": "debug",
+    "z": "flow-apex",
+    "name": "Response",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "complete": "payload",
+    "x": 560,
+    "y": 180,
+    "wires": []
+  }
+]

package/examples/8-bulk-insert.json

@@ -0,0 +1,63 @@
+[
+  {
+    "id": "flow-bulk-insert",
+    "type": "tab",
+    "label": "Bulk Insert",
+    "disabled": false,
+    "info": "Insert multiple records using Bulk API 2.0"
+  },
+  {
+    "id": "config-sf-7",
+    "type": "salesforce-connection",
+    "name": "Salesforce",
+    "loginUrl": "https://login.salesforce.com",
+    "clientId": "",
+    "apiVersion": "62.0",
+    "callbackUrl": "http://localhost:1880/salesforce/auth/callback",
+    "z": ""
+  },
+  {
+    "id": "inject-bulk-insert",
+    "type": "inject",
+    "z": "flow-bulk-insert",
+    "name": "Insert 3 Accounts",
+    "props": [
+      {
+        "p": "payload",
+        "v": "[{\"Name\":\"Bulk Account 1\"},{\"Name\":\"Bulk Account 2\"},{\"Name\":\"Bulk Account 3\"}]",
+        "vt": "json"
+      }
+    ],
+    "repeat": "",
+    "once": false,
+    "x": 160,
+    "y": 80,
+    "wires": [["bulk-insert"]]
+  },
+  {
+    "id": "bulk-insert",
+    "type": "salesforce-bulk",
+    "z": "flow-bulk-insert",
+    "name": "Bulk Insert",
+    "connection": "config-sf-7",
+    "operation": "insert",
+    "sObjectType": { "type": "str", "value": "Account" },
+    "externalIdField": "",
+    "x": 380,
+    "y": 80,
+    "wires": [["debug-bulk-insert"]]
+  },
+  {
+    "id": "debug-bulk-insert",
+    "type": "debug",
+    "z": "flow-bulk-insert",
+    "name": "Results",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "complete": "payload",
+    "x": 560,
+    "y": 80,
+    "wires": []
+  }
+]

package/examples/9-bulk-query.json

@@ -0,0 +1,63 @@
+[
+  {
+    "id": "flow-bulk-query",
+    "type": "tab",
+    "label": "Bulk Query",
+    "disabled": false,
+    "info": "Query large datasets using Bulk API 2.0"
+  },
+  {
+    "id": "config-sf-8",
+    "type": "salesforce-connection",
+    "name": "Salesforce",
+    "loginUrl": "https://login.salesforce.com",
+    "clientId": "",
+    "apiVersion": "62.0",
+    "callbackUrl": "http://localhost:1880/salesforce/auth/callback",
+    "z": ""
+  },
+  {
+    "id": "inject-bulk-query",
+    "type": "inject",
+    "z": "flow-bulk-query",
+    "name": "Bulk Query",
+    "props": [
+      {
+        "p": "payload",
+        "v": "SELECT Id, Name, Industry FROM Account",
+        "vt": "str"
+      }
+    ],
+    "repeat": "",
+    "once": false,
+    "x": 140,
+    "y": 80,
+    "wires": [["bulk-query"]]
+  },
+  {
+    "id": "bulk-query",
+    "type": "salesforce-bulk",
+    "z": "flow-bulk-query",
+    "name": "Bulk Query",
+    "connection": "config-sf-8",
+    "operation": "query",
+    "sObjectType": { "type": "str", "value": "Account" },
+    "externalIdField": "",
+    "x": 340,
+    "y": 80,
+    "wires": [["debug-bulk-query"]]
+  },
+  {
+    "id": "debug-bulk-query",
+    "type": "debug",
+    "z": "flow-bulk-query",
+    "name": "Results",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "complete": "true",
+    "x": 520,
+    "y": 80,
+    "wires": []
+  }
+]

package/index.d.ts

@@ -0,0 +1,268 @@
+import { ConfigNode } from '@bonsae/nrg/server';
+import { Connection } from 'jsforce';
+import { Infer } from '@bonsae/nrg/server';
+import { IONode } from '@bonsae/nrg/server';
+import { ModuleDefinition } from '@bonsae/nrg/server';
+import { RED } from '@bonsae/nrg/server';
+import { Schema } from '@bonsae/nrg/server';
+import { TAny } from '@bonsae/nrg/server';
+import { TArray } from '@bonsae/nrg/server';
+import { TBoolean } from '@bonsae/nrg/server';
+import { TLiteral } from '@bonsae/nrg/server';
+import { TNodeRef } from '@bonsae/nrg/server';
+import { TNumber } from '@bonsae/nrg/server';
+import { TObject } from '@bonsae/nrg/server';
+import { TOptional } from '@bonsae/nrg/server';
+import { TString } from '@bonsae/nrg/server';
+import { TTypedInput } from '@bonsae/nrg/server';
+import { TUnion } from '@bonsae/nrg/server';
+
+declare type Config = Infer<typeof SalesforceApexConfigSchema>;
+
+declare type Config_2 = Infer<typeof SalesforceConnectionConfigSchema>;
+
+declare type Config_3 = Infer<typeof SalesforceBulkConfigSchema>;
+
+declare type Config_4 = Infer<typeof SalesforceDescribeConfigSchema>;
+
+declare type Config_5 = Infer<typeof SalesforceDmlConfigSchema>;
+
+declare type Config_6 = Infer<typeof SalesforceSoqlConfigSchema>;
+
+declare type Config_7 = Infer<typeof SalesforceStreamingConfigSchema>;
+
+declare type Credentials = Infer<typeof SalesforceConnectionCredentialsSchema>;
+
+declare const _default: ModuleDefinition;
+export default _default;
+
+declare type Input = Infer<typeof SalesforceApexInputSchema>;
+
+declare type Input_2 = Infer<typeof SalesforceBulkInputSchema>;
+
+declare type Input_3 = Infer<typeof SalesforceDescribeInputSchema>;
+
+declare type Input_4 = Infer<typeof SalesforceDmlInputSchema>;
+
+declare type Input_5 = Infer<typeof SalesforceSoqlInputSchema>;
+
+declare type Output = Infer<typeof SalesforceApexOutputsSchema>;
+
+declare type Output_2 = Infer<typeof SalesforceDescribeOutputsSchema>;
+
+declare type Output_3 = Infer<typeof SalesforceDmlOutputsSchema>;
+
+declare type Output_4 = Infer<typeof SalesforceSoqlOutputsSchema>;
+
+declare type Output_5 = Infer<typeof SalesforceStreamingOutputsSchema>;
+
+export declare class SalesforceApex extends IONode<Config, any, Input, Output> {
+    static readonly type = "salesforce-apex";
+    static readonly category = "salesforce";
+    static readonly color: `#${string}`;
+    static readonly inputs = 1;
+    static readonly outputs = 1;
+    static readonly configSchema: Schema;
+    static readonly inputSchema: Schema;
+    static readonly outputsSchema: Schema;
+    input(msg: Input): Promise<void>;
+}
+
+export declare const SalesforceApexConfigSchema: Schema<    {
+name: TString;
+connection: TNodeRef<SalesforceConnection>;
+method: TUnion<[TLiteral<"GET">, TLiteral<"POST">, TLiteral<"PUT">, TLiteral<"PATCH">, TLiteral<"DELETE">]>;
+path: TTypedInput<string>;
+}>;
+
+export declare const SalesforceApexInputSchema: Schema<    {
+payload: TAny;
+}>;
+
+export declare const SalesforceApexOutputsSchema: Schema<    {
+payload: TAny;
+}>;
+
+export declare class SalesforceBulk extends IONode<Config_3> {
+    static readonly type = "salesforce-bulk";
+    static readonly category = "salesforce";
+    static readonly color: `#${string}`;
+    static readonly inputs = 1;
+    static readonly outputs = 2;
+    static readonly configSchema: Schema;
+    static readonly inputSchema: Schema;
+    private sendRecord;
+    private sendJobCreated;
+    private sendComplete;
+    input(msg: Input_2): Promise<void>;
+}
+
+export declare const SalesforceBulkConfigSchema: Schema<    {
+name: TString;
+connection: TNodeRef<SalesforceConnection>;
+operation: TUnion<[TLiteral<"insert">, TLiteral<"update">, TLiteral<"upsert">, TLiteral<"delete">, TLiteral<"query">]>;
+sObjectType: TTypedInput<string>;
+externalIdField: TOptional<TString>;
+assignmentRuleId: TOptional<TString>;
+columnDelimiter: TUnion<[TLiteral<"COMMA">, TLiteral<"TAB">, TLiteral<"PIPE">, TLiteral<"SEMICOLON">, TLiteral<"CARET">, TLiteral<"BACKQUOTE">]>;
+lineEnding: TUnion<[TLiteral<"LF">, TLiteral<"CRLF">]>;
+pollInterval: TNumber;
+pollTimeout: TNumber;
+emitJobCreated: TBoolean;
+outputs: TNumber;
+}>;
+
+export declare const SalesforceBulkInputSchema: Schema<    {
+payload: TAny;
+}>;
+
+export declare class SalesforceConnection extends ConfigNode<Config_2, Credentials> {
+    static readonly type = "salesforce-connection";
+    static readonly configSchema: Schema;
+    static readonly credentialsSchema: Schema;
+    private conn;
+    static registered(RED: RED): Promise<void>;
+    getConnection(): Promise<Connection>;
+    getAccessToken(): string | undefined;
+    getInstanceUrl(): string | undefined;
+    closed(): Promise<void>;
+}
+
+export declare const SalesforceConnectionConfigSchema: Schema<    {
+name: TString;
+loginUrl: TString;
+clientId: TString;
+apiVersion: TUnion<[TLiteral<"62.0">, TLiteral<"61.0">, TLiteral<"60.0">, TLiteral<"59.0">, TLiteral<"58.0">, TLiteral<"57.0">, TLiteral<"56.0">, TLiteral<"55.0">]>;
+callbackUrl: TOptional<TString>;
+}>;
+
+export declare const SalesforceConnectionCredentialsSchema: Schema<    {
+accessToken: TString;
+refreshToken: TString;
+instanceUrl: TString;
+}>;
+
+export declare class SalesforceDescribe extends IONode<Config_4, any, Input_3, Output_2> {
+    static readonly type = "salesforce-describe";
+    static readonly category = "salesforce";
+    static readonly color: `#${string}`;
+    static readonly inputs = 1;
+    static readonly outputs = 1;
+    static readonly configSchema: Schema;
+    static readonly inputSchema: Schema;
+    static readonly outputsSchema: Schema;
+    input(msg: Input_3): Promise<void>;
+}
+
+export declare const SalesforceDescribeConfigSchema: Schema<    {
+name: TString;
+connection: TNodeRef<SalesforceConnection>;
+sObjectType: TTypedInput<string>;
+}>;
+
+export declare const SalesforceDescribeInputSchema: Schema<    {
+payload: TAny;
+}>;
+
+export declare const SalesforceDescribeOutputsSchema: Schema<    {
+payload: TObject<    {
+name: TString;
+fields: TArray<TAny>;
+childRelationships: TArray<TAny>;
+recordTypeInfos: TArray<TAny>;
+}>;
+}>;
+
+export declare class SalesforceDml extends IONode<Config_5, any, Input_4, Output_3> {
+    static readonly type = "salesforce-dml";
+    static readonly category = "salesforce";
+    static readonly color: `#${string}`;
+    static readonly inputs = 1;
+    static readonly outputs = 1;
+    static readonly configSchema: Schema;
+    static readonly inputSchema: Schema;
+    static readonly outputsSchema: Schema;
+    input(msg: Input_4): Promise<void>;
+}
+
+export declare const SalesforceDmlConfigSchema: Schema<    {
+name: TString;
+connection: TNodeRef<SalesforceConnection>;
+operation: TUnion<[TLiteral<"create">, TLiteral<"read">, TLiteral<"update">, TLiteral<"delete">, TLiteral<"upsert">]>;
+sObjectType: TTypedInput<string>;
+record: TTypedInput<any>;
+externalIdField: TOptional<TString>;
+}>;
+
+export declare const SalesforceDmlInputSchema: Schema<    {
+payload: TAny;
+}>;
+
+export declare const SalesforceDmlOutputsSchema: Schema<    {
+payload: TAny;
+}>;
+
+export declare class SalesforceSoql extends IONode<Config_6, any, Input_5, Output_4> {
+    static readonly type = "salesforce-soql";
+    static readonly category = "salesforce";
+    static readonly color: `#${string}`;
+    static readonly inputs = 1;
+    static readonly outputs = 1;
+    static readonly configSchema: Schema;
+    static readonly inputSchema: Schema;
+    static readonly outputsSchema: Schema;
+    input(msg: Input_5): Promise<void>;
+}
+
+export declare const SalesforceSoqlConfigSchema: Schema<    {
+name: TString;
+connection: TNodeRef<SalesforceConnection>;
+query: TTypedInput<string>;
+}>;
+
+export declare const SalesforceSoqlInputSchema: Schema<    {
+payload: TAny;
+}>;
+
+export declare const SalesforceSoqlOutputsSchema: Schema<    {
+payload: TArray<TAny>;
+totalSize: TNumber;
+done: TBoolean;
+}>;
+
+export declare class SalesforceStreaming extends IONode<Config_7, any, any, Output_5> {
+    static readonly type = "salesforce-streaming";
+    static readonly category = "salesforce";
+    static readonly color: `#${string}`;
+    static readonly inputs = 0;
+    static readonly outputs = 1;
+    static readonly configSchema: Schema;
+    static readonly outputsSchema: Schema;
+    private client;
+    private reconnectAttempt;
+    private maxReconnectDelay;
+    created(): Promise<void>;
+    private subscribe;
+    private scheduleReconnect;
+    private cleanup;
+    input(): Promise<void>;
+    closed(): Promise<void>;
+}
+
+export declare const SalesforceStreamingConfigSchema: Schema<    {
+name: TString;
+connection: TNodeRef<SalesforceConnection>;
+channelName: TString;
+subscribeType: TUnion<[TLiteral<"LATEST">, TLiteral<"EARLIEST">, TLiteral<"CUSTOM">]>;
+replayId: TOptional<TString>;
+numRequested: TNumber;
+}>;
+
+export declare const SalesforceStreamingOutputsSchema: Schema<    {
+payload: TAny;
+replayId: TAny;
+channel: TString;
+topic: TString;
+}>;
+
+export { }

package/index.html

@@ -0,0 +1,2 @@
+
+<script type="module" src="resources/@bonsae/node-red-salesforce/index.CfTW8fjc.js" defer></script>