Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mike4aday/SwiftlySalesforce

The Swift-est way to build native mobile apps that connect to Salesforce.
https://github.com/mike4aday/SwiftlySalesforce

api asynchronous combine ios ipados mobile oauth oauth2 reactive salesforce salesforce-developers salesforce-rest-api spm swift swiftpackagemanager swiftui

Last synced: 23 days ago
JSON representation

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

Awesome Lists containing this project

README 

        
 



# Swiftly Salesforce



"The Swift-est way to build native mobile apps that connect to [Salesforce](https://www.salesforce.com/products/platform/overview/)."



  



* Written entirely in [Swift](https://developer.apple.com/swift/).

* Very easy to install and update with [Swift Package Manager](https://developer.apple.com/documentation/swift_packages/adding_package_dependencies_to_your_app).

* Built with Apple's new [Swift concurrency](https://developer.apple.com/news/?id=2o3euotz) model to simplify complex, asynchronous calls to the [Salesforce REST API](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/).

* Designed for [SwiftUI](https://developer.apple.com/documentation/swiftui/), the modern, declarative way to build iOS apps.

* Manages the Salesforce [user authorization flows](https://help.salesforce.com/articleView?id=sf.remoteaccess_oauth_flows.htm&type=5) automatically.

* Pair with [Core Data](https://developer.apple.com/documentation/coredata) for a complete offline mobile solution.

* Simpler and lighter alternative to the Salesforce [Mobile SDK for iOS](https://github.com/forcedotcom/SalesforceMobileSDK-iOS).

* See [what's new](./CHANGELOG.md) in this release.



## 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](https://developer.salesforce.com/signup). 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](https://help.salesforce.com/articleView?id=sf.connected_app_create.htm&type=5) in your developer environment. [This screenshot](https://mike4aday.github.io/SwiftlySalesforce/images/ConnectedAppDefinition.png) 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](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app)) 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`](https://github.com/mike4aday/MySalesforceAccounts/blob/51cda01bc5c867643a9ef5085ede05e91151dfda/MySalesforceAccounts/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:

```json

{

    "consumerKey" : "",

    "callbackURL" : ""

}

```



5. **Connect to Salesforce:** Call [`Salesforce.connect()`](https://github.com/mike4aday/SwiftlySalesforce/blob/fa9b051a9c857b09ae17b091a5db7210fa1dedd4/Sources/SwiftlySalesforce/Salesforce.swift#L5) 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.



```swift

// MyApp.swift

import SwiftUI

import SwiftlySalesforce



@main

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`](https://github.com/mike4aday/SwiftlySalesforce/blob/fc9a5cfd659537cdde34059df35e6b5a1f8f229d/Sources/SwiftlySalesforce/Connection+API.swift) but if you require more, you could create your own implementation of [`DataService`](https://github.com/mike4aday/SwiftlySalesforce/blob/fc9a5cfd659537cdde34059df35e6b5a1f8f229d/Sources/SwiftlySalesforce/DataService.swift) and override just the relevant methods. See the source files in the `Sources/SwiftlySalesforce/Services` folder for examples of [`DataService`](https://github.com/mike4aday/SwiftlySalesforce/blob/fc9a5cfd659537cdde34059df35e6b5a1f8f229d/Sources/SwiftlySalesforce/DataService.swift) implementations that I created.



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



```swift

// ContentView.swift

import SwiftUI

import SwiftlySalesforce



//...

@EnvironmentObject var salesforce: Connection



//...

// Query the current user's accounts

let queryResults: QueryResult = 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](https://help.salesforce.com/articleView?id=sf.remoteaccess_oauth_flows.htm&type=5). 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](https://github.com/mike4aday/MySalesforceAccounts) for a complete, working app that uses [SwiftUI](https://developer.apple.com/documentation/swiftui/), [Swift concurrency](https://developer.apple.com/news/?id=2o3euotz) 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](https://github.com/mike4aday/MySalesforceAccounts/blob/51cda01bc5c867643a9ef5085ede05e91151dfda/MySalesforceAccounts/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

* Open a [GitHub issue](https://github.com/mike4aday/SwiftlySalesforce/issues/new)

* Send me a direct message on Twitter [@mike4aday](https://twitter.com/mike4aday)

* Send me a message on LinkedIn [in/mike4aday](https://www.linkedin.com/in/mike4aday)