Merge fa into master (#167)

* Add migration guide [SDK-3393] (#127)

Add migration guide

* Remove license header from source files [SDK-3389] (#126)

Remove license header

* Update year in license file (#128)

* Add `.swiftpm` directory to `.gitignore` (#131)

Add `.swiftpm` to `.gitignore`

* Add CONTRIBUTING.md (#130)

* Drop old platform versions [SDK-3387] (#129)

* Drop old platform versions

* Remove preprocessor macros and compatibility code

* Remove obsolete preprocessor macros

* Use accesibility config when neither iOS nor macOS

* Remove unnecessary preprocessor macros

* Remove extra blank line at the end of the file

* Restore Touch ID case

* Remove leftover nested if

* Update README [SDK-3416] (#135)

* Remove deprecated method [SDK-3413] (#132)

* Remove deprecated method

* Add change to the migration guide

* Remove usage of deprecated properties [SDK-3414] (#133)

* Remove usage of deprecated APIs

* Remove enum cases

* Remove usage of enum cases

* Update V1_MIGRATION_GUIDE.md

Co-authored-by: Steve Hobbs <[email protected]>

Co-authored-by: Steve Hobbs <[email protected]>

* Add support policy [SDK-3420] (#138)

* Fix typo in property name (#137)

* Remove obsolete functionality [SDK-3419] (#136)

* [SDK-3434] Update issues templates (#140)

* [SDK-3434] Migrate GitHub issue templates

* Update config.yml

* Update config.yml

* Add note about the Responsible Disclosure Program to bug reports template.

* Remove "FAQ.md" reference, as there is no file

* Update .github/ISSUE_TEMPLATE/Bug Report.yml

* Update .github/ISSUE_TEMPLATE/Feature Request.yml

* Update .github/ISSUE_TEMPLATE/Bug Report.yml

* Update .github/ISSUE_TEMPLATE/Feature Request.yml

* Update .github/ISSUE_TEMPLATE/config.yml

* Update .github/ISSUE_TEMPLATE/config.yml

* Update checkbox grouping

* Update Pull Request template

Co-authored-by: Rita Zerrizuela <[email protected]>

* Migrate to Swift [SDK-3428] (#139)

* Migrate to Swift

* Add test case

* Integrate SwiftLint

* Add .swiftlint.yml

* Fix tests

* Add API docs

* Update migration guide

* Remove leftover comments

* Update library description

* Add snippets to the API docs

* Drop Xcode 12.x and its older simulators

* Add item to the migration guide

* Drop support for old Swift versions [SDK-3444] (#141)

* Add missing unit tests (#142)

* Add missing tests

* Remove extra whitespace

* Add missing import for SPM

* Apply recommended Xcode 14 settings (#143)

* [SDK-3450] API Documentation Generation (#144)

* Add generated API documentation to repo (#145)

* Add support for iCloud synchronization (#146)

* Add support for iCould synchronization

* Update API docs

* Add unit tests for queries (#147)

Test queries

* Improve API docs generation (#148)

* Fix typos in tests (#149)

* Make `context` parameter optional (#151)

* Re-generate API docs (#152)

* Complete README and Migration Guide [SDK-3397] (#150)

* Add support for custom attributes (#153)

* Replace OSX with macOS in schemes and targets (#154)

Replace OSX with macOS

* Release 1.0.0-fa.0 (#155)

* Add fa to Podspec version (#156)

* Fix 'access group' capitalization (#158)

* Update API docs (#159)

* Use Codecov orb (#161)

* Create .semgrepignore

* Add placeholders to issue forms (#162)

* Update README for GA [SDK-3500] (#163)

Update the README for GA

* Merge `master` into `fa` (#164)

Co-authored-by: Steve Hobbs <[email protected]>
Co-authored-by: Evan Sims <[email protected]>

Author: 3 people

.circleci/config.yml

@@ -1,5 +1,8 @@
 version: 2.1
 
+orbs:
+  codecov: codecov/codecov@3
+
 executors:
   macos-executor:
     parameters:
@@ -59,8 +62,10 @@ commands:
           name: Run iOS tests
           command: bundle exec fastlane ios ci
       - run:
-          name: Upload coverage report
-          command: bash <(curl -s https://codecov.io/bash) -J '<< parameters.scheme >>'
+          name: Generate coverage report
+          command: bundle exec slather coverage -x --output-directory output --arch x86_64 --scheme << parameters.scheme >>-iOS << parameters.scheme >>.xcodeproj
+      - codecov/upload:
+          file: output/cobertura.xml
       - run:
           name: Run pod lib lint
           command: bundle exec fastlane ios pod_lint
@@ -76,7 +81,7 @@ commands:
       - run:
           name: Run macOS tests
           command: |
-            xcodebuild test -scheme << parameters.scheme >>-OSX -destination 'platform=macOS,arch=x86_64' | xcpretty
+            xcodebuild test -scheme << parameters.scheme >>-macOS -destination 'platform=macOS,arch=x86_64' | xcpretty
             swift test
   test-tvos:
     parameters:
@@ -126,8 +131,8 @@ workflows:
   build:
     jobs:
       - build-and-test:
-          scheme: "SimpleKeychain"
+          scheme: SimpleKeychain
           matrix:
             parameters:
-              platform: ["ios", "macos", "tvos"]
-              xcode: ["13.0.0", "12.5.1"]
+              platform: [ios, macos, tvos]
+              xcode: ["13.0.0"]

.github/ISSUE_TEMPLATE/Bug Report.yml

@@ -0,0 +1,84 @@
+name: 🐞 Report a bug
+description: Have you found a bug or issue? Create a bug report for this library
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Please do not report security vulnerabilities here**. The [Responsible Disclosure Program](https://auth0.com/responsible-disclosure-policy) details the procedure for disclosing security issues.
+
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      options:
+        - label: I have looked into the [README](https://github.com/auth0/SimpleKeychain#readme) and have not found a suitable solution or answer.
+          required: true
+        - label: I have searched the [issues](https://github.com/auth0/SimpleKeychain/issues) and have not found a suitable solution or answer.
+          required: true
+        - label: I have searched the [Auth0 Community](https://community.auth0.com/tags/c/sdks/5/ios) forums and have not found a suitable solution or answer.
+          required: true
+        - label: I agree to the terms within the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md).
+          required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Provide a clear and concise description of the issue, including what you expected to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Reproduction
+      description: Detail the steps taken to reproduce this error, and whether this issue can be reproduced consistently or if it is intermittent.
+      placeholder: |
+        1. Step 1...
+        2. Step 2...
+        3. ...
+    validations:
+      required: true
+
+  - type: input
+    id: environment-version
+    attributes:
+      label: SimpleKeychain version
+    validations:
+      required: true
+
+  - type: dropdown
+    id: environment-platform
+    attributes:
+      label: Platform
+      multiple: true
+      options:
+        - iOS
+        - macOS
+        - tvOS
+        - watchOS
+    validations:
+      required: true
+
+  - type: input
+    id: environment-platform-version
+    attributes:
+      label: Platform version(s)
+    validations:
+      required: true
+
+  - type: input
+    id: environment-xcode-version
+    attributes:
+      label: Xcode version
+    validations:
+      required: true
+
+  - type: input
+    id: environment-package-manager
+    attributes:
+      label: Package manager
+      placeholder: SPM, Cocoapods, Carthage, etc.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/Feature Request.yml

@@ -0,0 +1,51 @@
+name: 🧩 Feature request
+description: Suggest an idea or a feature for this library
+labels: ["feature request"]
+
+body:
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      options:
+        - label: I have looked into the [README](https://github.com/auth0/SimpleKeychain#readme) and have not found a suitable solution or answer.
+          required: true
+        - label: I have searched the [issues](https://github.com/auth0/SimpleKeychain/issues) and have not found a suitable solution or answer.
+          required: true
+        - label: I have searched the [Auth0 Community](https://community.auth0.com/tags/c/sdks/5/ios) forums and have not found a suitable solution or answer.
+          required: true
+        - label: I agree to the terms within the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md).
+          required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the problem you'd like to have solved
+      description: A clear and concise description of what the problem is.
+      placeholder: I'm always frustrated when...
+    validations:
+      required: true
+
+  - type: textarea
+    id: ideal-solution
+    attributes:
+      label: Describe the ideal solution
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives-and-workarounds
+    attributes:
+      label: Alternatives and current workarounds
+      description: A clear and concise description of any alternatives you've considered or any workarounds that are currently in place.
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,11 @@
 blank_issues_enabled: false
 contact_links:
-  - name: Auth0 Community
+  - name: 🤔 Help & Questions
     url: https://community.auth0.com/tags/c/sdks/5/ios
-    about: Discuss this library in the Auth0 Community forums
+    about: Ask general support or usage questions in the Auth0 Community forums
+  - name: 🚀 Usage
+    url: https://github.com/auth0/SimpleKeychain#usage
+    about: Check the Usage section of the README to get up to speed with SimpleKeychain
+  - name: 📖 API Documentation
+    url: https://auth0.github.io/SimpleKeychain/
+    about: Check the public API documentation for in-depth overview of all the available features

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,34 +1,40 @@
-### Changes
+<!--
+❗ For general support or usage questions, use the Auth0 Community forums or raise a support ticket.
 
-Please describe both what is changing and why this is important. Include:
+By submitting a Pull Request to this repository, you agree to the terms within the Auth0 Code of Conduct: https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md.
+-->
 
-- Endpoints added, deleted, deprecated, or changed
-- Classes and methods added, deleted, deprecated, or changed
-- Screenshots of new or changed UI, if applicable
-- A summary of usage if this is a new feature or change to a public API (this should also be added to relevant documentation once released)
-- Any alternative designs or architectures considered
+- [ ] All new/changed/fixed functionality is covered by tests (or N/A)
+- [ ] I have added documentation for all new/changed functionality (or N/A)
 
-### References
+<!--
+❗ All the above items are required. Pull Requests with an incomplete or missing checklist will be unceremoniously closed.
+-->
 
-Please include relevant links supporting this change such as a:
+### 📋 Changes
 
-- support ticket
-- community post
-- StackOverflow post
-- support forum thread
+<!--
+Describe both what is changing and why this is important. Include:
 
-### Testing
+- Types and methods added, deleted, deprecated, or changed
+- A summary of usage if this is a new feature or a change to a public API
+-->
 
-Please describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If helpful, please include manual testing steps as well. 
+### 📎 References
 
-[ ] This change adds unit test coverage (or why not)
+<!--
+Add relevant links supporting this change, such as:
 
-[ ] This change has been tested on the latest version of the platform/language or why not
+- GitHub issue/PR number addressed or fixed
+- Auth0 Community post
+- StackOverflow answer
+- Related pull requests/issues from other repositories
 
-### Checklist
+If there are no references, simply delete this section.
+-->
 
-[ ] I have read the [Auth0 general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
+### 🎯 Testing
 
-[ ] I have read the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md)
-
-[ ] All existing and new tests complete without errors
+<!--
+Describe how this can be tested by reviewers. Be specific about anything not tested and why. Include any manual steps for testing end-to-end, or for testing functionality not covered by unit tests.
+-->

.github/ISSUE_TEMPLATE/report-a-bug.md

@@ -38,5 +38,9 @@ fastlane/report.xml
 fastlane/screenshots/
 
 #SwiftPM
-.build
-Package.resolved
+.swiftpm/
+.build/
+Package.resolved
+
+# DocC
+docs.archive/

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,2 @@
+docs/
+SimpleKeychainTests/

.gitignore

@@ -1,8 +1,8 @@
 {
-    "files": {
-        "SimpleKeychain/Info.plist": [],
-        "SimpleKeychain.podspec": []
-    },
-    "postbump": "bundle update",
-    "prefixVersion": false
+  "files": {
+    "SimpleKeychain/Info.plist": [],
+    "SimpleKeychain.podspec": []
+  },
+  "postbump": "bundle update && bundle exec fastlane ios build_docs",
+  "prefixVersion": false
 }

.semgrepignore

@@ -0,0 +1,23 @@
+opt_in_rules: # some rules are only opt-in
+  - empty_count
+  # Find all the available rules by running:
+  # swiftlint rules
+included: # paths to include during linting. `--path` is ignored if present.
+  - SimpleKeychain
+excluded: # paths to ignore during linting. Takes precedence over `included`.
+  - Carthage
+  - Pods
+# configurable rules can be customized from this configuration file
+# rules that have both warning and error levels, can set just the warning level
+# implicitly
+line_length: 500
+# they can set both implicitly with an array
+type_body_length:
+  - 300 # warning
+  - 400 # error
+type_name:
+  min_length: 3 # only warning
+identifier_name:
+  min_length: # only min_length
+    warning: 3 # only error
+reporter: "xcode" # reporter type (xcode, json, csv, checkstyle, junit)