tauri-plugin-siwa-api 1.0.0

package/LICENSE

@@ -0,0 +1,8 @@
+Copyright 2024 Manaf Mhamdi Alaoui
+Modifications Copyright 2025 Gavyn Stanley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,140 @@
+# tauri-plugin-siwa
+
+Sign In with Apple for Tauri 2 — supports **iOS** and **macOS**.
+
+> **Attribution:** Based on [tauri-plugin-sign-in-with-apple](https://crates.io/crates/tauri-plugin-sign-in-with-apple) by [Manaf941](https://github.com/Manaf941), licensed under the [MIT License](./LICENSE). Modified by Gavyn Stanley to add macOS support.
+
+---
+
+## Platform Support
+
+| Platform | Supported |
+|----------|-----------|
+| iOS      | ✅        |
+| macOS    | ✅        |
+| Android  | ❌        |
+| Windows  | ❌        |
+| Linux    | ❌        |
+
+---
+
+## Installation
+
+Add the Rust crate to your `src-tauri/Cargo.toml`:
+
+```toml
+[dependencies]
+tauri-plugin-siwa = "1.0.0"
+```
+
+Install the JavaScript package:
+
+```bash
+npm install tauri-plugin-siwa-api
+```
+
+---
+
+## Setup
+
+### 1. Register the plugin
+
+In `src-tauri/src/main.rs` (or `lib.rs`):
+
+```rust
+fn main() {
+    tauri::Builder::default()
+        .plugin(tauri_plugin_siwa::init())
+        .run(tauri::generate_context!())
+        .expect("error while running tauri application");
+}
+```
+
+### 2. Add the capability permission
+
+In your capability file (e.g. `src-tauri/capabilities/default.json`):
+
+```json
+{
+  "permissions": [
+    "siwa:allow-get-apple-id-credential"
+  ]
+}
+```
+
+### 3. Apple Developer setup
+
+- Enable the **Sign In with Apple** capability in your Apple Developer account for your App ID.
+- Add the entitlement to your app. In `src-tauri/entitlements.plist`:
+
+```xml
+<key>com.apple.developer.applesignin</key>
+<array>
+    <string>Default</string>
+</array>
+```
+
+---
+
+## Usage
+
+```typescript
+import { getAppleIdCredential } from 'tauri-plugin-siwa-api';
+
+const response = await getAppleIdCredential({
+  scope: ['fullName', 'email'],
+});
+
+console.log(response.userIdentifier);  // Stable user ID — store this
+console.log(response.email);           // Only returned on first sign-in
+console.log(response.identityToken);   // JWT — verify on your server
+console.log(response.authorizationCode); // Short-lived code for server exchange
+```
+
+> **Note:** `email`, `givenName`, and `familyName` are only returned on the **first** sign-in. Store them immediately — Apple will not return them again.
+
+---
+
+## API
+
+### `getAppleIdCredential(request)`
+
+Presents the Sign In with Apple sheet and returns credentials.
+
+#### Request
+
+```typescript
+interface AppleIDAuthorizationRequest {
+  scope: ('fullName' | 'email')[];
+  nonce?: string;   // Recommended: associate with your server session
+  state?: string;   // Optional: passed back in the response unchanged
+}
+```
+
+#### Response
+
+```typescript
+interface AppleIDAuthorizationResponse {
+  userIdentifier: string | null;    // Stable, unique user ID
+  givenName: string | null;         // First sign-in only
+  familyName: string | null;        // First sign-in only
+  email: string | null;             // First sign-in only
+  authorizationCode: string;        // Short-lived server exchange code
+  identityToken: string | null;     // JWT — verify with Apple's public keys
+  state: string | null;             // Echoed from request
+}
+```
+
+#### Errors
+
+| Error | Cause |
+|-------|-------|
+| `Unsupported platform` | Called on a non-Apple platform |
+| `Failed to decode authorization code` | Apple returned malformed data |
+| `Sign In With Apple error: <msg>` | macOS ASAuthorization failure (e.g. user cancelled) |
+
+---
+
+## License
+
+MIT — see [LICENSE](./LICENSE).

package/dist-js/index.cjs

@@ -0,0 +1,11 @@
+'use strict';
+
+var core = require('@tauri-apps/api/core');
+
+async function getAppleIdCredential(request) {
+    return core.invoke('plugin:siwa|get_apple_id_credential', {
+        payload: request,
+    });
+}
+
+exports.getAppleIdCredential = getAppleIdCredential;

package/dist-js/index.d.ts

@@ -0,0 +1,16 @@
+export type Scope = 'fullName' | 'email';
+export interface AppleIDAuthorizationRequest {
+    scope: Scope[];
+    nonce?: string;
+    state?: string;
+}
+export interface AppleIDAuthorizationResponse {
+    userIdentifier: string | null;
+    givenName: string | null;
+    familyName: string | null;
+    email: string | null;
+    authorizationCode: string;
+    identityToken: string | null;
+    state: string | null;
+}
+export declare function getAppleIdCredential(request: AppleIDAuthorizationRequest): Promise<AppleIDAuthorizationResponse>;

package/dist-js/index.js

@@ -0,0 +1,9 @@
+import { invoke } from '@tauri-apps/api/core';
+
+async function getAppleIdCredential(request) {
+    return invoke('plugin:siwa|get_apple_id_credential', {
+        payload: request,
+    });
+}
+
+export { getAppleIdCredential };

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "tauri-plugin-siwa-api",
+  "version": "1.0.0",
+  "author": "GavynStanley",
+  "contributors": ["Manaf941"],
+  "description": "Sign In with Apple for Tauri 2 — supports iOS and macOS.",
+  "type": "module",
+  "license": "MIT",
+  "types": "./dist-js/index.d.ts",
+  "main": "./dist-js/index.cjs",
+  "module": "./dist-js/index.js",
+  "exports": {
+    "types": "./dist-js/index.d.ts",
+    "import": "./dist-js/index.js",
+    "require": "./dist-js/index.cjs"
+  },
+  "files": [
+    "dist-js",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "rollup -c",
+    "format": "prettier --write \"guest-js/**/*.ts\" && cargo fmt && swift-format format -i -r ios/Sources macos/Sources",
+    "prepublishOnly": "npm run build",
+    "pretest": "npm run build",
+    "publish:npm": "npm publish",
+    "publish:cargo": "cargo publish"
+  },
+  "dependencies": {
+    "@tauri-apps/api": ">=2.0.0-beta.6"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^11.1.6",
+    "prettier": "^3.0.0",
+    "rollup": "^4.9.6",
+    "tslib": "^2.6.2",
+    "typescript": "^5.3.3"
+  }
+}