@usync/oauth2 0.1.1 → 0.1.2

package/dist/common.d.ts

@@ -0,0 +1,7 @@
+export declare const OAUTH2_NEED_REFRESH = 1;
+export declare const OAUTH2_AUTH_ERROR = 2;
+export declare const OAUTH2_UNAUTHORIZED = 3;
+export declare class OAuth2Error extends Error {
+    code: number;
+    constructor(code: number, message?: string);
+}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import { OAuth2Authorizer } from "./providers";
+import type { IOAuth2Account, IOAuth2Options } from "./types";
+export * from "./common";
+export * from "./providers";
+export * from "./types";
+export declare function getAuthorizer(options: IOAuth2Options, auth: IOAuth2Account): import("./providers").DropboxAuthorizer | import("./providers").GoogleAuthorizer | import("./providers").MicrosoftAuthorizer;
+export declare function ensureAccessToken(authorizer: OAuth2Authorizer, handleOAuth2?: (url: string) => Promise<string>): Promise<string>;

package/dist/providers/base.d.ts

@@ -0,0 +1,28 @@
+import type { IOAuth2Options, TokenData } from "../types";
+export declare abstract class OAuth2Authorizer {
+    protected options: IOAuth2Options;
+    abstract buildAuthUrl(): Promise<string>;
+    abstract finishAuth(url: URL): Promise<string>;
+    abstract refreshToken(): Promise<string>;
+    protected _accessToken: TokenData | null;
+    protected _refreshToken: TokenData | null;
+    session: {
+        state: string;
+        codeVerifier: string;
+    } | undefined;
+    constructor(options: IOAuth2Options, initialData?: {
+        accessToken?: TokenData;
+        refreshToken?: TokenData;
+        session?: {
+            state: string;
+            codeVerifier: string;
+        };
+    });
+    protected _getValidToken(value?: TokenData | null): string | undefined;
+    protected _updateAccessToken(value: TokenData | null): void;
+    protected _updateRefreshToken(value: TokenData | null): void;
+    getAccessToken(): string;
+    getRefreshToken(): string;
+    setAccessToken(value?: TokenData | null): void;
+    setRefreshToken(value?: TokenData | null): void;
+}

package/dist/providers/dropbox.d.ts

@@ -0,0 +1,12 @@
+import { OAuth2Authorizer } from "./base.ts";
+export declare class DropboxAuthorizer extends OAuth2Authorizer {
+    /**
+     * Ref: https://www.dropbox.com/developers/documentation/http/documentation
+     */
+    static Scopes: {
+        account: string;
+    };
+    buildAuthUrl(): Promise<string>;
+    finishAuth(url: URL): Promise<string>;
+    refreshToken(): Promise<string>;
+}

package/dist/providers/google.d.ts

@@ -0,0 +1,17 @@
+import { OAuth2Authorizer } from "./base.ts";
+/**
+ * Ref: https://developers.google.com/identity/protocols/oauth2/web-server
+ */
+export declare class GoogleAuthorizer extends OAuth2Authorizer {
+    /**
+     * Ref: https://developers.google.com/identity/protocols/oauth2/scopes
+     */
+    static Scopes: {
+        account: string;
+        "drive.appdata": string;
+        imap: string;
+    };
+    buildAuthUrl(): Promise<string>;
+    finishAuth(url: URL): Promise<string>;
+    refreshToken(): Promise<string>;
+}

package/dist/providers/index.d.ts

@@ -0,0 +1,10 @@
+import { DropboxAuthorizer } from "./dropbox";
+import { GoogleAuthorizer } from "./google";
+import { MicrosoftAuthorizer } from "./microsoft";
+export * from "./base";
+export { DropboxAuthorizer, GoogleAuthorizer, MicrosoftAuthorizer };
+export declare const OAuth2Authorizers: {
+    dropbox: typeof DropboxAuthorizer;
+    google: typeof GoogleAuthorizer;
+    microsoft: typeof MicrosoftAuthorizer;
+};

package/dist/providers/microsoft.d.ts

@@ -0,0 +1,15 @@
+import { OAuth2Authorizer } from "./base.ts";
+/**
+ * Ref: https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-auth-code-flow
+ */
+export declare class MicrosoftAuthorizer extends OAuth2Authorizer {
+    static Scopes: {
+        /** Ref: https://learn.microsoft.com/en-us/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth */
+        imap: string;
+        onedrive: string;
+    };
+    private oauth2Url;
+    buildAuthUrl(): Promise<string>;
+    finishAuth(url: URL): Promise<string>;
+    refreshToken(): Promise<string>;
+}

package/dist/types.d.ts

@@ -0,0 +1,30 @@
+import { OAuth2Authorizers } from "./providers";
+export interface TokenData {
+    token: string;
+    expiresAt?: number;
+    scope?: string;
+}
+export interface IOAuth2Options {
+    clientId: string;
+    /** clientSecret may be absent for client-side apps. */
+    clientSecret?: string;
+    redirectUrl: string;
+    scope?: string;
+    provider?: {
+        microsoft?: {
+            /**
+             * Must match the account type of the application registered in https://portal.azure.com/.
+             * `common` for all accounts, `consumers` for personal accounts only.
+             *
+             * Default as `common`.
+             */
+            accountType?: "common" | "consumers";
+        };
+    };
+    onSetAccessToken?: (value: TokenData | null) => void;
+    onSetRefreshToken?: (value: TokenData | null) => void;
+}
+export interface IOAuth2Account {
+    provider: keyof typeof OAuth2Authorizers;
+    user: string;
+}

package/dist/util.d.ts

@@ -0,0 +1,13 @@
+export declare function getState(): string;
+/**
+ * Ref: https://datatracker.ietf.org/doc/html/rfc7636#section-4.1
+ * high-entropy cryptographic random STRING using the
+ * unreserved characters [A-Z] / [a-z] / [0-9] / "-" / "." / "_" / "~"
+ * from Section 2.3 of [RFC3986], with a minimum length of 43 characters
+ * and a maximum length of 128 characters.
+ */
+export declare function getCodeVerifier(): string;
+export declare function getCodeChallenge(codeVerifier: string): Promise<{
+    codeChallenge: string;
+    codeChallengeMethod: string;
+}>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usync/oauth2",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "files": [
     "dist"
   ],
@@ -23,6 +23,6 @@
     "clean": "del-cli dist tsconfig.tsbuildinfo",
     "build:types": "tsc",
     "build:js": "vite build",
-    "build": "pnpm clean && pnpm /^build:/"
+    "build": "pnpm clean && pnpm build:js && pnpm build:types"
   }
 }