@logto/chrome-extension 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Silverhand
+
+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,37 @@
+# Logto Chrome extension SDK
+
+[![Version](https://img.shields.io/npm/v/@logto/chrome-extension)](https://www.npmjs.com/package/@logto/browser)
+[![Build Status](https://github.com/logto-io/js/actions/workflows/main.yml/badge.svg)](https://github.com/logto-io/js/actions/workflows/main.yml)
+
+The Logto Chrome extension SDK written in TypeScript.
+
+Check out our [docs](https://docs.logto.io/sdk/chrome-extension/) for more information; a sample project can be found at [here](../chrome-extension-sample/).
+
+> [!Note]
+> This package is ESM-only.
+
+## Installation
+
+### Using npm
+
+```bash
+npm install @logto/chrome-extension
+```
+
+### Using yarn
+
+```bash
+yarn add @logto/chrome-extension
+```
+
+### Using pnpm
+
+```bash
+pnpm add @logto/chrome-extension
+```
+
+## Resources
+
+[![Website](https://img.shields.io/badge/website-logto.io-8262F8.svg)](https://logto.io/)
+[![Docs](https://img.shields.io/badge/docs-logto.io-green.svg)](https://docs.logto.io/)
+[![Discord](https://img.shields.io/discord/965845662535147551?logo=discord&logoColor=ffffff&color=7389D8&cacheSeconds=600)](https://discord.gg/UEPaF3j5e6)

package/lib/index.d.ts

@@ -0,0 +1,9 @@
+import { BaseClient, type LogtoConfig } from '@logto/browser';
+export * from '@logto/browser';
+export { ChromeExtensionStorage } from './storage';
+export default class LogtoClient extends BaseClient {
+    /**
+     * @param config The configuration object for the client.
+     */
+    constructor(config: LogtoConfig);
+}

package/lib/index.js

@@ -0,0 +1,45 @@
+import { BaseClient, LogtoClientError, createRequester, generateCodeChallenge, generateCodeVerifier, generateState, } from '@logto/browser';
+import { ChromeExtensionStorage } from './storage';
+export * from '@logto/browser';
+export { ChromeExtensionStorage } from './storage';
+export default class LogtoClient extends BaseClient {
+    /**
+     * @param config The configuration object for the client.
+     */
+    constructor(config) {
+        const requester = createRequester(fetch);
+        // eslint-disable-next-line unicorn/consistent-function-scoping -- we use `this` in the function
+        const navigate = async (url, params) => {
+            switch (params.for) {
+                case 'sign-in': {
+                    const responseUrl = await chrome.identity.launchWebAuthFlow({ url, interactive: true });
+                    if (!responseUrl) {
+                        throw new LogtoClientError('user_cancelled');
+                    }
+                    await this.handleSignInCallback(responseUrl);
+                    break;
+                }
+                case 'sign-out': {
+                    await chrome.identity.launchWebAuthFlow({
+                        url,
+                        interactive: false,
+                        abortOnLoadForNonInteractive: false,
+                        timeoutMsForNonInteractive: 10_000,
+                    });
+                    break;
+                }
+                default: {
+                    throw new Error(`Unsupported navigation for ${params.for}`);
+                }
+            }
+        };
+        super(config, {
+            requester,
+            navigate,
+            storage: new ChromeExtensionStorage(config.appId),
+            generateCodeChallenge,
+            generateCodeVerifier,
+            generateState,
+        });
+    }
+}

package/lib/storage.d.ts

@@ -0,0 +1,9 @@
+import { type PersistKey, type Storage } from '@logto/browser';
+export declare class ChromeExtensionStorage implements Storage<PersistKey> {
+    readonly appId: string;
+    constructor(appId: string);
+    getKey(item?: string): string;
+    getItem(key: PersistKey): Promise<string | null>;
+    setItem(key: PersistKey, value: string): Promise<void>;
+    removeItem(key: PersistKey): Promise<void>;
+}

package/lib/storage.js

@@ -0,0 +1,24 @@
+const keyPrefix = `logto`;
+export class ChromeExtensionStorage {
+    constructor(appId) {
+        this.appId = appId;
+    }
+    getKey(item) {
+        if (item === undefined) {
+            return `${keyPrefix}:${this.appId}`;
+        }
+        return `${keyPrefix}:${this.appId}:${item}`;
+    }
+    // eslint-disable-next-line @typescript-eslint/ban-types
+    async getItem(key) {
+        const storageKey = this.getKey(key);
+        const object = await chrome.storage.local.get(storageKey);
+        return object[storageKey] ? String(object[storageKey]) : null;
+    }
+    async setItem(key, value) {
+        await chrome.storage.local.set({ [this.getKey(key)]: value });
+    }
+    async removeItem(key) {
+        await chrome.storage.local.remove(this.getKey(key));
+    }
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@logto/chrome-extension",
+  "version": "0.1.0",
+  "description": "Logto Chrome extension SDK",
+  "type": "module",
+  "files": [
+    "lib"
+  ],
+  "module": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./lib/index.js",
+      "default": "./lib/index.js",
+      "types": "./lib/index.d.ts"
+    }
+  },
+  "keywords": [],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/logto-io/js.git",
+    "directory": "packages/chrome-extension-sample"
+  },
+  "dependencies": {
+    "@logto/browser": "^2.2.6"
+  },
+  "devDependencies": {
+    "@silverhand/eslint-config": "^5.0.0",
+    "@silverhand/ts-config": "^5.0.0",
+    "chrome-types": "^0.1.276",
+    "eslint": "^8.57.0",
+    "lint-staged": "^15.0.0",
+    "prettier": "^3.0.0",
+    "typescript": "^5.3.3"
+  },
+  "eslintConfig": {
+    "extends": "@silverhand/react"
+  },
+  "prettier": "@silverhand/eslint-config/.prettierrc",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "precommit": "lint-staged",
+    "build": "rm -rf lib && tsc",
+    "lint": "eslint --ext .ts --ext .tsx src"
+  }
+}