Skip to content

Commit 7d4cb50

Browse files
committed
feat: DataPoint iOS SDK v1.0.1
- Initialize SDK with API key - Present micro-tasks to users - Reward callbacks and listener support - User ID and attributes management - Swift Package Manager support - Production-ready URLs Apache License 2.0
1 parent f7ea08f commit 7d4cb50

19 files changed

Lines changed: 2284 additions & 7 deletions

LICENSE

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to the Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
Copyright 2025 DataPoint
179+
180+
Licensed under the Apache License, Version 2.0 (the "License");
181+
you may not use this file except in compliance with the License.
182+
You may obtain a copy of the License at
183+
184+
http://www.apache.org/licenses/LICENSE-2.0
185+
186+
Unless required by applicable law or agreed to in writing, software
187+
distributed under the License is distributed on an "AS IS" BASIS,
188+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189+
See the License for the specific language governing permissions and
190+
limitations under the License.

Package.swift

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// swift-tools-version: 5.9
2+
// The swift-tools-version declares the minimum version of Swift required to build this package.
3+
4+
import PackageDescription
5+
6+
let package = Package(
7+
name: "DataPointSDK",
8+
platforms: [
9+
.iOS(.v13)
10+
],
11+
products: [
12+
.library(
13+
name: "DataPointSDK",
14+
targets: ["DataPointSDK"]
15+
),
16+
],
17+
targets: [
18+
.target(
19+
name: "DataPointSDK",
20+
path: "datapoint"
21+
),
22+
]
23+
)

README.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# DataPoint iOS SDK
2+
3+
Monetize your app with micro-tasks via the DataPoint iOS SDK.
4+
5+
## Installation
6+
7+
### Swift Package Manager (Recommended)
8+
9+
Add the following to your `Package.swift`:
10+
11+
```swift
12+
dependencies: [
13+
.package(url: "https://github.com/trydatapoint/datapoint-ios-sdk.git", from: "1.0.1")
14+
]
15+
```
16+
17+
Or in Xcode: **File → Add Package Dependencies** → Enter the repository URL.
18+
19+
## Usage
20+
21+
### Initialize the SDK
22+
23+
```swift
24+
import DataPointSDK
25+
26+
DataPoint.initialize(apiKey: "YOUR_API_KEY") { result in
27+
switch result {
28+
case .success:
29+
print("SDK initialized")
30+
case .failure(let error):
31+
print("Failed: \(error)")
32+
}
33+
}
34+
```
35+
36+
### Set User ID (Optional)
37+
38+
```swift
39+
DataPoint.setAppUserId("user123") { result in
40+
// Handle result
41+
}
42+
```
43+
44+
### Show Tasks
45+
46+
```swift
47+
DataPoint.setListener(self)
48+
DataPoint.showTasks(from: viewController)
49+
```
50+
51+
### Implement DataPointListener
52+
53+
```swift
54+
extension YourClass: DataPointListener {
55+
func onTaskCompleted(_ payload: String?) {
56+
// User completed a task
57+
}
58+
59+
func onAdRequested() {
60+
// Show an ad
61+
}
62+
63+
func noTaskAvailable() {
64+
// No tasks available
65+
}
66+
67+
func onClosed() {
68+
// Task screen closed
69+
}
70+
71+
func onError(message: String, code: Int) {
72+
// Handle error
73+
}
74+
}
75+
```
76+
77+
## Requirements
78+
79+
- iOS 13.0+
80+
- Swift 5.9+
81+
82+
## License
83+
84+
Apache License 2.0 - see [LICENSE](LICENSE) for details.

datapoint/DataPointCallback.swift

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import Foundation
2+
3+
/// Callback for asynchronous SDK operations such as user attributes.
4+
public protocol DataPointCallback: AnyObject {
5+
func onSuccess()
6+
func onError(message: String, code: Int)
7+
}

datapoint/DataPointListener.swift

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
import Foundation
2+
3+
/// Callback interface for task-related events. Set via `DataPoint.setListener`.
4+
public protocol DataPointListener: AnyObject {
5+
/// A task was completed. `payload` is the raw JSON string from the WebView, or `nil`.
6+
func onTaskCompleted(_ payload: String?)
7+
8+
/// The WebView requested that the host app show an ad. The task screen is closed before this fires.
9+
func onAdRequested()
10+
11+
/// No tasks are currently available; the task screen is closed before this fires.
12+
func noTaskAvailable()
13+
14+
/// The task screen was dismissed (user, WebView, or `closeTasks()`).
15+
func onClosed()
16+
17+
/// An error occurred.
18+
func onError(message: String, code: Int)
19+
}

datapoint/Environment.swift

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
import Foundation
2+
3+
/// SDK environment configuration.
4+
///
5+
/// - `production` — Connects to the live backend; performs real validation.
6+
/// - `sandbox` — Uses mock session data; skips network during initialization.
7+
public enum Environment: String, Sendable {
8+
case production = "production"
9+
case sandbox = "sandbox"
10+
}

datapoint/ErrorCode.swift

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
import Foundation
2+
3+
/// Error codes returned by SDK callbacks (aligned with Android).
4+
public enum ErrorCode: Int, Sendable {
5+
/// `DataPoint.initialize` has not been called or has not completed.
6+
case sdkNotInitialized = 1001
7+
/// The initialization network request failed.
8+
case initializationFailed = 1002
9+
/// The session token expired and automatic re-initialization failed.
10+
case sessionExpired = 1003
11+
/// Invalid parameters passed to the SDK (e.g. blank apiKey).
12+
case invalidConfiguration = 1004
13+
/// `showTasks` was called while the task screen is already visible.
14+
case taskAlreadyShowing = 1005
15+
/// A generic network error (no connectivity, timeout, etc.).
16+
case networkError = 1007
17+
/// Invalid request parameters sent to the server (HTTP 400).
18+
case invalidRequest = 1008
19+
/// The API key is invalid or unauthorized (HTTP 401).
20+
case invalidApiKey = 1009
21+
/// The server encountered an internal error (HTTP 5xx).
22+
case serverError = 1012
23+
}

datapoint/InitCallback.swift

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import Foundation
2+
3+
/// Optional callback for `DataPoint.initialize`.
4+
public protocol InitCallback: AnyObject {
5+
func onSuccess()
6+
func onError(message: String, code: Int)
7+
}

0 commit comments

Comments
 (0)