Swiftpack.co - mike4aday/SwiftlySalesforce as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by mike4aday.
mike4aday/SwiftlySalesforce v10.0.1
The Swift-est way to build native mobile apps that connect to Salesforce.
⭐️ 124
🕓 19 weeks ago
.package(url: "https://github.com/mike4aday/SwiftlySalesforce.git", from: "v10.0.1")

Swiftly Salesforce

"The Swift-est way to build native mobile apps that connect to Salesforce."


Minimum Requirements

  • iOS 15.0
  • Swift 5.5
  • Xcode 13

Quick Start

Get up and running in less than 5 minutes!

  1. Get a free Salesforce Developer Edition: You can sign up for a free developer environment (also called an "organization" or "org") here. It will never expire as long as you log in at least once every 6 months.

  2. Create a Salesforce Connected App: Create a new Connected App in your developer environment. This screenshot shows an example; you can copy the settings that I've entered. Be sure that "Require Secret for Refresh Token Flow" is not checked.

  3. Add Swiftly Salesforce to your project: Add the Swiftly Salesforce package to your Xcode project (instructions) with the URL https://github.com/mike4aday/SwiftlySalesforce.git.

  4. Create a configuration file: In your Xcode project, create an empty file named Salesforce.json and add the following JSON text, replacing the placeholder text with the actual values for your Connected App's consumer key and callback URL:

    "consumerKey" : "<Replace with the consumer key from your Connected App definition>",
    "callbackURL" : "<Replace with the callback URL from your Connected App definition>"
  1. Connect to Salesforce: Call Salesforce.connect() and you're ready to go! If you're using SwiftUI, you could call the following from your main application file and store the Salesforce connection in the environment. Swiftly Salesforce will automatically handle all the OAuth flows, authenticating users on their first use of your app and then silently refreshing their access tokens when required.
// MyApp.swift
import SwiftUI
import SwiftlySalesforce

struct MyApp: App {
    var body: some Scene {
        WindowGroup {
            ContentView().environmentObject(try! Salesforce.connect())

I expect that you'll find most of the methods you'll need in the file Connection+API.swift but if you require more, you could create your own implementation of DataService and override just the relevant methods. See the source files in the Sources/SwiftlySalesforce/Services folder for examples of DataService implementations that I created.

Here are some examples of using the Connection class' convenience methods:

// ContentView.swift
import SwiftUI
import SwiftlySalesforce

@EnvironmentObject var salesforce: Connection

// Query the current user's accounts
let queryResults: QueryResult<Record> = try await salesforce.myRecords(type: "Account")

// Search for a string in Salesforce records
let searchResults: [Record] = try await salesforce.search(sosl: "FIND {Joe Smith}")

// Get info about the current user
let userInfo: Identity = try await salesforce.identity()

// Retrieve all fields of an Account record
let account: Record = try await salesforce.read(type: "Account", id: "0011Y00003HVMu4QAH")

// Retrieve all fields of an Account record and decode them into your own, custom Decodable instance
let account2: CustomAccount = try await salesforce.read(type: "Account", id: "0011Y00003HVMu4QAH") 

// Insert a new record
let recordID: String = try await salesforce.create(type: "Account", fields: ["Name": "Acme Corp."]

// Update a record
try await salesforce.update(type: "Account", id: "0011Y00003HVMu4QAH", fields: ["BillingCity": "Austin"])

// Get metadata about any Salesforce object, including custom fields, labels, validation rules, etc.
let accountMetadata = try await salesforce.describe("Account")

User Authorization

Swiftly Salesforce will automatically manage all required Salesforce authorization flows. If Swiftly Salesforce already has a valid access token in its secure store, it will include that token in the header of every API request. If the token has expired and Salesforce rejects the request, then Swiftly Salesforce will attempt to refresh the access token without bothering the user to re-enter the username and password. If Swiftly Salesforce doesn't have a valid access token, or is unable to refresh it, then Swiftly Salesforce will direct the user to the Salesforce-hosted login form.

Sample App

Check out MySalesforceAccounts for a complete, working app that uses SwiftUI, Swift concurrency and Swiftly Salesforce to display the user's Salesforce account records. Though it's a relatively-trival app, it illustrates how to configure an app and quickly connect it to Salesforce.

Before you run the sample app, edit Salesforce.json and replace the temporary values for the consumer key and callback URL with those of your own Connected App.

Questions, Suggestions & Bug Reports


Stars: 124
Last commit: 3 days ago
jonrohan Something's broken? Yell at me @ptrpavlik. Praise and feedback (and money) is also welcome.

Release Notes

19 weeks ago

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics