@logto/capacitor 1.1.1 → 1.1.3

package/lib/index.cjs

@@ -44,38 +44,10 @@ class CapacitorLogtoClient extends LogtoBaseClient__default.default {
             },
         };
     }
-    /**
-     * Start the sign-in flow with the specified redirect URI. The URI must be
-     * registered in the Logto Console.
-     *
-     * Remember to configure the correct [scheme or universal links](https://capacitorjs.com/docs/guides/deep-links)
-     * to ensure the app can be opened from the redirect URI.
-     *
-     * @param redirectUri The redirect URI that the user will be redirected to after the sign-in flow is completed.
-     * @param interactionMode The interaction mode to be used for the authorization request. Note it's not
-     * a part of the OIDC standard, but a Logto-specific extension. Defaults to `signIn`.
-     * @throws {@link LogtoClientError} If error happens during the sign-in flow or the user cancels the sign-in.
-     *
-     * @example
-     * ```ts
-     * const client = new CapacitorLogtoClient({
-     *   endpoint: 'https://your.logto.endpoint',
-     *   appId: 'your-app-id',
-     * });
-     *
-     * await client.signIn('io.logto.example://callback'); // throws if error happens
-     * console.log(await client.getIdTokenClaims()); // { sub: '123', ... }
-     * ```
-     *
-     * @remarks
-     * The user will be redirected to that URI after the sign-in flow is completed,
-     * and the client will be able to get the authorization code from the URI.
-     * {@link handleSignInCallback} will be called after the user is redirected.
-     *
-     * @see {@link https://docs.logto.io/docs/recipes/integrate-logto/vanilla-js/#sign-in | Sign in} for more information.
-     * @see {@link InteractionMode}
-     */
     async signIn(redirectUri, interactionMode) {
+        if (typeof redirectUri === 'object' && !(redirectUri instanceof URL)) {
+            throw new TypeError('The first argument must be a string or a URL.');
+        }
         return new Promise((resolve, reject) => {
             const run = async () => {
                 const [browserHandle, appHandle] = await Promise.all([
@@ -87,7 +59,7 @@ class CapacitorLogtoClient extends LogtoBaseClient__default.default {
                     // Handle the case where the user completes the sign-in and is redirected
                     // back to the app.
                     app.App.addListener('appUrlOpen', async ({ url }) => {
-                        if (!url.startsWith(redirectUri)) {
+                        if (!url.startsWith(redirectUri.toString())) {
                             return;
                         }
                         await Promise.all([
@@ -152,51 +124,51 @@ class CapacitorLogtoClient extends LogtoBaseClient__default.default {
     }
 }
 
-Object.defineProperty(exports, 'LogtoClientError', {
+Object.defineProperty(exports, "LogtoClientError", {
     enumerable: true,
     get: function () { return LogtoBaseClient.LogtoClientError; }
 });
-Object.defineProperty(exports, 'LogtoError', {
+Object.defineProperty(exports, "LogtoError", {
     enumerable: true,
     get: function () { return LogtoBaseClient.LogtoError; }
 });
-Object.defineProperty(exports, 'LogtoRequestError', {
+Object.defineProperty(exports, "LogtoRequestError", {
     enumerable: true,
     get: function () { return LogtoBaseClient.LogtoRequestError; }
 });
-Object.defineProperty(exports, 'OidcError', {
+Object.defineProperty(exports, "OidcError", {
     enumerable: true,
     get: function () { return LogtoBaseClient.OidcError; }
 });
-Object.defineProperty(exports, 'PersistKey', {
+Object.defineProperty(exports, "PersistKey", {
     enumerable: true,
     get: function () { return LogtoBaseClient.PersistKey; }
 });
-Object.defineProperty(exports, 'Prompt', {
+Object.defineProperty(exports, "Prompt", {
     enumerable: true,
     get: function () { return LogtoBaseClient.Prompt; }
 });
-Object.defineProperty(exports, 'ReservedResource', {
+Object.defineProperty(exports, "ReservedResource", {
     enumerable: true,
     get: function () { return LogtoBaseClient.ReservedResource; }
 });
-Object.defineProperty(exports, 'ReservedScope', {
+Object.defineProperty(exports, "ReservedScope", {
     enumerable: true,
     get: function () { return LogtoBaseClient.ReservedScope; }
 });
-Object.defineProperty(exports, 'UserScope', {
+Object.defineProperty(exports, "UserScope", {
     enumerable: true,
     get: function () { return LogtoBaseClient.UserScope; }
 });
-Object.defineProperty(exports, 'buildOrganizationUrn', {
+Object.defineProperty(exports, "buildOrganizationUrn", {
     enumerable: true,
     get: function () { return LogtoBaseClient.buildOrganizationUrn; }
 });
-Object.defineProperty(exports, 'getOrganizationIdFromUrn', {
+Object.defineProperty(exports, "getOrganizationIdFromUrn", {
     enumerable: true,
     get: function () { return LogtoBaseClient.getOrganizationIdFromUrn; }
 });
-Object.defineProperty(exports, 'organizationUrnPrefix', {
+Object.defineProperty(exports, "organizationUrnPrefix", {
     enumerable: true,
     get: function () { return LogtoBaseClient.organizationUrnPrefix; }
 });

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 import { type OpenOptions } from '@capacitor/browser';
-import LogtoBaseClient, { type InteractionMode, type LogtoConfig } from '@logto/browser';
+import LogtoBaseClient, { type InteractionMode, type LogtoConfig, type SignInOptions } from '@logto/browser';
 export { LogtoError, LogtoRequestError, LogtoClientError, OidcError, Prompt, ReservedScope, ReservedResource, UserScope, organizationUrnPrefix, buildOrganizationUrn, getOrganizationIdFromUrn, PersistKey, } from '@logto/browser';
 export type CapacitorConfig = {
     /**
@@ -10,6 +10,10 @@ export type CapacitorConfig = {
 };
 export default class CapacitorLogtoClient extends LogtoBaseClient {
     constructor(config: LogtoConfig, capacitorConfig?: CapacitorConfig);
+    /**
+     * **NOTE: Capacitor does not support this method signature, use the other overloads.**
+     */
+    signIn(options: SignInOptions): Promise<void>;
     /**
      * Start the sign-in flow with the specified redirect URI. The URI must be
      * registered in the Logto Console.
@@ -20,7 +24,7 @@ export default class CapacitorLogtoClient extends LogtoBaseClient {
      * @param redirectUri The redirect URI that the user will be redirected to after the sign-in flow is completed.
      * @param interactionMode The interaction mode to be used for the authorization request. Note it's not
      * a part of the OIDC standard, but a Logto-specific extension. Defaults to `signIn`.
-     * @throws {@link LogtoClientError} If error happens during the sign-in flow or the user cancels the sign-in.
+     * @throws `LogtoClientError` If error happens during the sign-in flow or the user cancels the sign-in.
      *
      * @example
      * ```ts

package/lib/index.js

@@ -37,38 +37,10 @@ class CapacitorLogtoClient extends LogtoBaseClient {
             },
         };
     }
-    /**
-     * Start the sign-in flow with the specified redirect URI. The URI must be
-     * registered in the Logto Console.
-     *
-     * Remember to configure the correct [scheme or universal links](https://capacitorjs.com/docs/guides/deep-links)
-     * to ensure the app can be opened from the redirect URI.
-     *
-     * @param redirectUri The redirect URI that the user will be redirected to after the sign-in flow is completed.
-     * @param interactionMode The interaction mode to be used for the authorization request. Note it's not
-     * a part of the OIDC standard, but a Logto-specific extension. Defaults to `signIn`.
-     * @throws {@link LogtoClientError} If error happens during the sign-in flow or the user cancels the sign-in.
-     *
-     * @example
-     * ```ts
-     * const client = new CapacitorLogtoClient({
-     *   endpoint: 'https://your.logto.endpoint',
-     *   appId: 'your-app-id',
-     * });
-     *
-     * await client.signIn('io.logto.example://callback'); // throws if error happens
-     * console.log(await client.getIdTokenClaims()); // { sub: '123', ... }
-     * ```
-     *
-     * @remarks
-     * The user will be redirected to that URI after the sign-in flow is completed,
-     * and the client will be able to get the authorization code from the URI.
-     * {@link handleSignInCallback} will be called after the user is redirected.
-     *
-     * @see {@link https://docs.logto.io/docs/recipes/integrate-logto/vanilla-js/#sign-in | Sign in} for more information.
-     * @see {@link InteractionMode}
-     */
     async signIn(redirectUri, interactionMode) {
+        if (typeof redirectUri === 'object' && !(redirectUri instanceof URL)) {
+            throw new TypeError('The first argument must be a string or a URL.');
+        }
         return new Promise((resolve, reject) => {
             const run = async () => {
                 const [browserHandle, appHandle] = await Promise.all([
@@ -80,7 +52,7 @@ class CapacitorLogtoClient extends LogtoBaseClient {
                     // Handle the case where the user completes the sign-in and is redirected
                     // back to the app.
                     App.addListener('appUrlOpen', async ({ url }) => {
-                        if (!url.startsWith(redirectUri)) {
+                        if (!url.startsWith(redirectUri.toString())) {
                             return;
                         }
                         await Promise.all([

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/capacitor",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "type": "module",
   "main": "./lib/index.cjs",
   "module": "./lib/index.js",
@@ -21,14 +21,14 @@
     "directory": "packages/capacitor"
   },
   "dependencies": {
-    "@logto/browser": "^2.2.1"
+    "@logto/browser": "^2.2.4"
   },
   "devDependencies": {
     "@capacitor/app": "^5.0.6",
     "@capacitor/browser": "^5.0.6",
     "@capacitor/preferences": "^5.0.6",
-    "@silverhand/eslint-config": "^4.0.1",
-    "@silverhand/ts-config": "^4.0.0",
+    "@silverhand/eslint-config": "^5.0.0",
+    "@silverhand/ts-config": "^5.0.0",
     "@swc/core": "^1.3.50",
     "@swc/jest": "^0.2.24",
     "@types/jest": "^29.5.0",
@@ -39,7 +39,7 @@
     "lint-staged": "^15.0.0",
     "prettier": "^3.0.0",
     "text-encoder": "^0.0.4",
-    "typescript": "^5.0.0"
+    "typescript": "^5.3.3"
   },
   "eslintConfig": {
     "extends": "@silverhand"