@synqauth/plugin-siws 0.0.0-stage → 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Aerosol
+
+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

@@ -1,3 +1,36 @@
-# Temporary Holding Version
+# @synqauth/plugin-siws
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A Synq plugin for Sign In With Solana from your own UI.
+
+Synq is customer identity for businesses: an OpenID Connect issuer for each of your brands, with Solana wallet, social, email and passkey sign-in. The documentation is at [docs.synq.build](https://docs.synq.build).
+
+This package is at 0.x and hasn't been published yet: its API can change in any release until Synq's first customer depends on it.
+
+## Usage
+
+With `@synqauth/nextjs`, for the brand's own apps. On the server:
+
+```ts
+import { siwsServerPlugin } from '@synqauth/plugin-siws/server'
+
+export const synq = synqAuth({ plugins: [siwsServerPlugin()] })
+```
+
+In the page:
+
+```tsx
+'use client'
+import { mountRequest } from '@synqauth/nextjs/client'
+import { siwsPlugin } from '@synqauth/plugin-siws'
+import { useSolanaWallets } from '@synqauth/solana/react'
+
+const siws = siwsPlugin().actions(mountRequest())
+const wallets = useSolanaWallets()
+const { error } = await siws.signIn(wallets[0], { returnTo: '/account' })
+```
+
+The wallet signs the issuer's own request on your page, and your server pushes the signature to Synq, which checks it. Your server verifies nothing.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,47 @@
+import { SynqError } from "@synqauth/js";
+import { Wallet, WalletAccount } from "@synqauth/solana";
+//#region src/index.d.ts
+/** The plugin's id: its server half's routes are under it, and its actions under it in `usePlugin`. */
+export declare const SIWS_PLUGIN_ID = "siws";
+/** A call's outcome: its data, or the `SynqError` it failed with. */
+export type SiwsResult<T> = {
+  readonly data: T;
+  readonly error: null;
+} | {
+  readonly data: null;
+  readonly error: SynqError;
+};
+/** Calls the app's route mount, from its own page: what @synqauth/react and @synqauth/nextjs/client hand a plugin. */
+export type MountRequest = (path: string, init?: RequestInit) => Promise<Response>;
+/** What `signIn` takes besides the wallet. */
+export interface SiwsSignInOptions {
+  /** Where on the app the person lands afterwards. */
+  returnTo?: string;
+  /** The account to sign with; the wallet's choice when left out. */
+  account?: WalletAccount;
+}
+/** The browser half's actions. */
+export interface SiwsActions {
+  /**
+   * Signs in with `wallet`: the issuer's request, the wallet's signature,
+   * then off to Synq and back to `returnTo`. Answers `{ data, error }`
+   * instead of navigating when something fails: `wallet_rejected` when the
+   * person declines.
+   */
+  signIn: (wallet: Wallet, options?: SiwsSignInOptions) => Promise<SiwsResult<null>>;
+}
+/** The SIWS plugin's browser half, in `SynqClientPlugin`'s shape: for `<SynqProvider plugins>` or `@synqauth/nextjs/client`. */
+export interface SiwsPlugin {
+  readonly id: typeof SIWS_PLUGIN_ID;
+  actions: (request: MountRequest) => SiwsActions;
+}
+/** What `siwsPlugin()` takes. */
+export interface SiwsPluginOptions {
+  /** Where the browser goes: `location.assign` by default. */
+  navigate?: (url: string) => void;
+  /** The `fetch` the page asks the issuer with: the global one by default. */
+  fetch?: typeof fetch;
+}
+/** The SIWS plugin's browser half: a wallet's sign-in from the app's own page, through the route mount. */
+export declare function siwsPlugin(options?: SiwsPluginOptions): SiwsPlugin;
+//#endregion

package/dist/index.js

@@ -0,0 +1,56 @@
+import { SynqError, problemError } from "@synqauth/js";
+import { encodeSiws, requestSignIn, signWithWallet } from "@synqauth/solana";
+//#region src/index.ts
+/** The plugin's id: its server half's routes are under it, and its actions under it in `usePlugin`. */
+const SIWS_PLUGIN_ID = "siws";
+async function mountJson(request, path, init) {
+	let response;
+	try {
+		response = await request(path, init);
+	} catch (error) {
+		throw new SynqError("network_error", `The app couldn't be reached: ${String(error)}`, { cause: error });
+	}
+	const json = await response.json().catch(() => void 0);
+	if (!response.ok) throw problemError(response.status, json !== null && typeof json === "object" ? json : {});
+	return json;
+}
+/** The SIWS plugin's browser half: a wallet's sign-in from the app's own page, through the route mount. */
+function siwsPlugin(options = {}) {
+	const navigate = options.navigate ?? ((url) => {
+		globalThis.location?.assign(url);
+	});
+	return {
+		id: SIWS_PLUGIN_ID,
+		actions: (request) => ({ signIn: async (wallet, signInOptions = {}) => {
+			try {
+				const { issuer, clientId } = await mountJson(request, `${SIWS_PLUGIN_ID}/config`);
+				const signInRequest = await requestSignIn({
+					issuer,
+					clientId,
+					fetch: options.fetch
+				});
+				const signed = await signWithWallet(wallet, signInRequest, signInOptions.account);
+				const { redirect } = await mountJson(request, "sign-in", {
+					method: "POST",
+					headers: { "content-type": "application/json" },
+					body: JSON.stringify({
+						siws: encodeSiws(signed),
+						returnTo: signInOptions.returnTo
+					})
+				});
+				navigate(redirect);
+				return {
+					data: null,
+					error: null
+				};
+			} catch (error) {
+				return {
+					data: null,
+					error: error instanceof SynqError ? error : new SynqError("network_error", String(error), { cause: error })
+				};
+			}
+		} })
+	};
+}
+//#endregion
+export { SIWS_PLUGIN_ID, siwsPlugin };

package/dist/server.d.ts

@@ -0,0 +1,16 @@
+//#region src/server.d.ts
+/** What a server plugin's route is handed: the part of @synqauth/nextjs's plugin context it reads. */
+export interface SiwsRouteContext {
+  readonly issuer: string;
+  readonly clientId: string;
+}
+/** The server half, in @synqauth/nextjs's `SynqPlugin` shape. */
+export interface SiwsServerPlugin {
+  readonly id: 'siws';
+  readonly routes: {
+    readonly 'GET /config': (context: SiwsRouteContext, request: Request) => Response;
+  };
+}
+/** The SIWS plugin's server half, for `synqAuth({ plugins })`: it tells the page which issuer and app to ask for a sign-in request. */
+export declare function siwsServerPlugin(): SiwsServerPlugin;
+//#endregion

package/dist/server.js

@@ -0,0 +1,13 @@
+//#region src/server.ts
+/** The SIWS plugin's server half, for `synqAuth({ plugins })`: it tells the page which issuer and app to ask for a sign-in request. */
+function siwsServerPlugin() {
+	return {
+		id: "siws",
+		routes: { "GET /config": (context) => Response.json({
+			issuer: context.issuer,
+			clientId: context.clientId
+		}, { headers: { "cache-control": "no-store" } }) }
+	};
+}
+//#endregion
+export { siwsServerPlugin };

package/package.json

@@ -1,6 +1,46 @@
 {
   "name": "@synqauth/plugin-siws",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.0",
+  "description": "A Synq plugin for Sign In With Solana from your own UI.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aerosol-build/synq.git",
+    "directory": "packages/plugin-siws"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./server": {
+      "types": "./dist/server.d.ts",
+      "default": "./dist/server.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@synqauth/js": "0.0.0",
+    "@synqauth/solana": "0.0.0"
+  },
+  "devDependencies": {
+    "vitest": "5.0.2"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "lint": "eslint .",
+    "typecheck": "tsc",
+    "test": "vitest run"
+  }
 }