diff --git a/docs/sdk/core-kit/sfa-android/usage.mdx b/docs/sdk/core-kit/sfa-android/usage.mdx index d574ce4fc..7d2c8e843 100644 --- a/docs/sdk/core-kit/sfa-android/usage.mdx +++ b/docs/sdk/core-kit/sfa-android/usage.mdx @@ -14,7 +14,7 @@ users and obtain their private and public keys. :::tip NOTE -Web3Auth SFA iOS SDK only works for users who have **not enabled MFA**. For MFA enabled users, +Web3Auth SFA Android SDK only works for users who have **not enabled MFA**. For MFA enabled users, you'll see an Error message. ::: diff --git a/docs/sdk/core-kit/sfa-ios/authentication.mdx b/docs/sdk/core-kit/sfa-ios/authentication.mdx index ab4ccb645..0458f4973 100644 --- a/docs/sdk/core-kit/sfa-ios/authentication.mdx +++ b/docs/sdk/core-kit/sfa-ios/authentication.mdx @@ -1,8 +1,8 @@ --- -title: "Authentication in Core Kit SFA iOS SDK" +title: "Authentication in Core Kit SFA Swift SDK" sidebar_label: "Authentication" description: - "Web3Auth Core Kit Single Factor Auth iOS SDK - Authentication | Documentation - Web3Auth" + "Web3Auth Core Kit Single Factor Auth Swift SDK - Authentication | Documentation - Web3Auth" --- import AuthenticationInSFA from "@site/src/common/sdk/core-kit/sfa/_auth_in_core_kit_sfa.mdx"; diff --git a/docs/sdk/core-kit/sfa-ios/examples.mdx b/docs/sdk/core-kit/sfa-ios/examples.mdx index dc0dd0f61..c2ca762dd 100644 --- a/docs/sdk/core-kit/sfa-ios/examples.mdx +++ b/docs/sdk/core-kit/sfa-ios/examples.mdx @@ -1,7 +1,7 @@ --- -title: Examples - Core Kit SFA iOS SDK +title: Examples - Core Kit SFA Swift SDK sidebar_label: Examples -description: "Core Kit SFA iOS Examples | Documentation - Web3Auth" +description: "Core Kit SFA Swift Examples | Documentation - Web3Auth" hide_table_of_contents: true --- diff --git a/docs/sdk/core-kit/sfa-ios/initialize.mdx b/docs/sdk/core-kit/sfa-ios/initialize.mdx index 1e9168c5b..d011a57cf 100644 --- a/docs/sdk/core-kit/sfa-ios/initialize.mdx +++ b/docs/sdk/core-kit/sfa-ios/initialize.mdx @@ -1,7 +1,7 @@ --- -title: Initializing SFA iOS SDK +title: Initializing SFA Swift SDK sidebar_label: Initialize -description: "Web3Auth SFA iOS SDK - Initialization | Documentation - Web3Auth" +description: "Web3Auth SFA Swift SDK - Initialization | Documentation - Web3Auth" --- import Initialization from "@site/src/common/sdk/core-kit/sfa/ios/_sfa-ios-initialization.mdx"; diff --git a/docs/sdk/core-kit/sfa-ios/install.mdx b/docs/sdk/core-kit/sfa-ios/install.mdx index 39b883fed..94246d519 100644 --- a/docs/sdk/core-kit/sfa-ios/install.mdx +++ b/docs/sdk/core-kit/sfa-ios/install.mdx @@ -1,7 +1,7 @@ --- -title: "Installing SFA iOS SDK" +title: "Installing SFA Swift SDK" sidebar_label: "Install" -description: "Installing Web3Auth SFA iOS SDK | Documentation - Web3Auth" +description: "Installing Web3Auth SFA Swift SDK | Documentation - Web3Auth" --- import SPM from "@site/src/common/sdk/core-kit/sfa/ios/_sfa-ios-spm.mdx"; diff --git a/docs/sdk/core-kit/sfa-ios/sfa-ios.mdx b/docs/sdk/core-kit/sfa-ios/sfa-ios.mdx index 57b5bfda0..03b073219 100644 --- a/docs/sdk/core-kit/sfa-ios/sfa-ios.mdx +++ b/docs/sdk/core-kit/sfa-ios/sfa-ios.mdx @@ -1,26 +1,27 @@ --- -title: "Web3Auth Core Kit Single Factor Auth iOS SDK" +title: "Web3Auth Core Kit Single Factor Auth Swift SDK" sidebar_label: Overview -description: "Web3Auth Core Kit Single Factor Auth iOS SDK | Documentation - Web3Auth" +description: "Web3Auth Core Kit Single Factor Auth Swift SDK | Documentation - Web3Auth" --- You can use the Web3Auth -[Single Factor Auth iOS SDK](https://github.com/Web3Auth/single-factor-auth-swift) as a library for -your iOS app to authenticate users through Web3Auth. The SDK is written in Swift and allows for -native use of the One Key flow, which starts with just one share of the key. This means that users -can authenticate without redirection in a single key pair flow. +[Single Factor Auth Swift SDK](https://github.com/Web3Auth/single-factor-auth-swift) as a library +for your iOS, and macOS app to authenticate users through Web3Auth. The SDK is written in Swift and +allows for native use of the One Key flow, which starts with just one share of the key. This means +that users can authenticate without redirection in a single key pair flow. -Using the Web3Auth SFA iOS SDK, you can authenticate users and reconstruct their private keys +Using the Web3Auth SFA Swift SDK, you can authenticate users and reconstruct their private keys quickly and easily. Additionally, you can use the Web3Auth Plug and Play iOS SDK to redirect users to a Web3Auth-hosted screen (`https://auth.web3auth.io`), which is suitable for most use cases. However, if you want more control over the UI and UX of the authentication process, you can customize the authentication flow to avoid redirection. This is possible with the new Web3Auth SFA -iOS SDK, which allows you to use Web3Auth SFA iOS and prevent redirection to Openlogin-hosted +Swift SDK, which allows you to use Web3Auth SFA Swift and prevent redirection to Openlogin-hosted screens. ### Requirements - iOS 14+ +- macOS 11+ :::note diff --git a/docs/sdk/core-kit/sfa-ios/usage.mdx b/docs/sdk/core-kit/sfa-ios/usage.mdx index 29b813a90..d178f4a9e 100644 --- a/docs/sdk/core-kit/sfa-ios/usage.mdx +++ b/docs/sdk/core-kit/sfa-ios/usage.mdx @@ -1,7 +1,7 @@ --- -title: "Using Core Kit SFA iOS SDK" +title: "Using Core Kit SFA Swift SDK" sidebar_label: "Usage" -description: "Web3Auth Core Kit Single Factor Auth iOS SDK - Usage | Documentation - Web3Auth" +description: "Web3Auth Core Kit Single Factor Auth Swift SDK - Usage | Documentation - Web3Auth" --- import TabItem from "@theme/TabItem"; @@ -14,7 +14,7 @@ users and obtain their private and public keys. :::tip NOTE -Web3Auth SFA iOS SDK only works for users who have **not enabled MFA**. For MFA enabled users, +Web3Auth SFA Swift SDK only works for users who have **not enabled MFA**. For MFA enabled users, you'll see an Error message. ::: diff --git a/src/common/SDKOptions.ts b/src/common/SDKOptions.ts index a34be6ff0..eb7a2983b 100644 --- a/src/common/SDKOptions.ts +++ b/src/common/SDKOptions.ts @@ -5,6 +5,7 @@ export const nextjs = "Next JS"; export const web = "Web"; export const android = "Android"; export const ios = "iOS"; +export const macOS = "macOS"; export const reactnative = "React Native"; export const rnbare = "React Native Bare"; export const rnexpo = "React Native Expo"; @@ -45,7 +46,7 @@ export const tkeyios = "tKey iOS"; export const tkeyandroid = "tKey Android"; export const singlefactorauth = "SFA Web"; export const singlefactorauthandroid = "SFA Android"; -export const singlefactorauthios = "SFA iOS"; +export const singlefactorauthios = "SFA Swift"; export const singlefactorauthrn = "SFA React Native"; export const singlefactorauthflutter = "SFA Flutter"; export const corekitnodejs = "SFA Node.js"; @@ -59,7 +60,7 @@ export const corekitlist = [ { label: "SFA Web", value: singlefactorauth, platforms: [...weblist] }, { label: "SFA Node.js", value: corekitnodejs, platforms: [nodejs] }, { label: "SFA Android", value: singlefactorauthandroid, platforms: [android] }, - { label: "SFA iOS", value: singlefactorauthios, platforms: [ios] }, + { label: "SFA Swift", value: singlefactorauthios, platforms: [ios, macOS] }, { label: "SFA React Native", value: singlefactorauthrn, platforms: [...rnlist] }, { label: "SFA Flutter", value: singlefactorauthflutter, platforms: [flutter] }, ]; diff --git a/src/components/navDropdown/sdk.html b/src/components/navDropdown/sdk.html index 2895c2afd..bfea04252 100644 --- a/src/components/navDropdown/sdk.html +++ b/src/components/navDropdown/sdk.html @@ -290,8 +290,8 @@

SFA Android SDK

-

SFA iOS SDK

-

Single Factor Auth, implementing a single key pair flow in iOS App

+

SFA Swift SDK

+

Single Factor Auth, implementing a single key pair flow in iOS and macOS App

diff --git a/src/pages/quick-start/builder/core_kit/sfa/ios/stepContent/installation.mdx b/src/pages/quick-start/builder/core_kit/sfa/ios/stepContent/installation.mdx index ac6a5a2fb..99144d607 100644 --- a/src/pages/quick-start/builder/core_kit/sfa/ios/stepContent/installation.mdx +++ b/src/pages/quick-start/builder/core_kit/sfa/ios/stepContent/installation.mdx @@ -2,7 +2,7 @@ title: Install Web3Auth --- -Add the Web3Auth SFA iOS SDK to your project +Add the Web3Auth SFA Swift SDK to your project 1. In Xcode, with your app project open, navigate to **File > Add Packages**. @@ -15,10 +15,11 @@ Add the Web3Auth SFA iOS SDK to your project From the `Dependency Rule` dropdown, select `Exact Version` and enter the [latest version](https://github.com/Web3Auth/single-factor-auth-swift/releases). -1. When finished, Xcode will automatically begin resolving and downloading your dependencies in the background. +1. When finished, Xcode will automatically begin resolving and downloading your dependencies in the + background. :::tip SDK Reference -- [Installing Web3Auth SFA iOS](/sdk/core-kit/sfa-ios/install). +- [Installing Web3Auth SFA Swift](/sdk/core-kit/sfa-ios/install). :::