@authly/sdk 1.0.2 → 1.1.0

package/dist/config.d.ts

@@ -1,2 +1,3 @@
 export declare const DEFAULT_JWKS_PATH = "/.well-known/jwks.json";
+export declare const DEFAULT_AUTHORIZE_PATH = "/v1/oauth/authorize";
 export declare const DEFAULT_ALGORITHMS: string[];

package/dist/config.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_ALGORITHMS = exports.DEFAULT_JWKS_PATH = void 0;
+exports.DEFAULT_ALGORITHMS = exports.DEFAULT_AUTHORIZE_PATH = exports.DEFAULT_JWKS_PATH = void 0;
 exports.DEFAULT_JWKS_PATH = "/.well-known/jwks.json";
+exports.DEFAULT_AUTHORIZE_PATH = "/v1/oauth/authorize";
 exports.DEFAULT_ALGORITHMS = ["RS256"];

package/dist/globals/clients/AuthlyClient.d.ts

@@ -19,22 +19,64 @@ export interface AuthlyClientOptions {
      * The path to the JWKS endpoint relative to the issuer. Defaults to "/.well-known/jwks.json".
      */
     jwksPath?: string;
+    /**
+     * The path to the authorize endpoint relative to the issuer. Defaults to "/v1/oauth/authorize".
+     */
+    authorizePath?: string;
     /**
      * A list of allowed signing algorithms. If omitted, defaults to ["RS256"].
      */
     algorithms?: string[];
 }
 /**
- * A client for verifying Authly JWT tokens.
+ * Options for generating an authorization URL.
+ */
+export interface AuthorizeUrlOptions {
+    /**
+     * The URI to redirect back to after authentication.
+     */
+    redirectUri: string;
+    /**
+     * A unique state string to prevent CSRF.
+     */
+    state: string;
+    /**
+     * The PKCE code challenge.
+     */
+    codeChallenge: string;
+    /**
+     * The PKCE code challenge method. Defaults to "S256".
+     */
+    codeChallengeMethod?: "S256" | "plain";
+    /**
+     * The requested scopes. Defaults to "openid profile email".
+     */
+    scope?: string;
+    /**
+     * The OAuth2 response type. Defaults to "code".
+     */
+    responseType?: string;
+}
+/**
+ * A client for interacting with Authly.
  *
  * This client handles the validation of tokens against a specific issuer and audience,
- * fetching the public keys (JWKS) automatically.
+ * fetching the public keys (JWKS) automatically, and provides utilities for
+ * starting the OAuth2 flow.
  */
 export declare class AuthlyClient {
     private readonly verifier;
     private readonly serviceId;
     private readonly issuer;
+    private readonly authorizePath;
     constructor(options: AuthlyClientOptions);
+    /**
+     * Generate the authorization URL to redirect the user to.
+     *
+     * @param options - Options for generating the URL.
+     * @returns The full authorization URL.
+     */
+    getAuthorizeUrl(options: AuthorizeUrlOptions): string;
     /**
      * Verify a JWT token and return its decoded claims.
      *

package/dist/globals/clients/AuthlyClient.js

@@ -4,19 +4,22 @@ exports.AuthlyClient = void 0;
 const config_1 = require("../../config");
 const JWTVerifier_1 = require("./internal/JWTVerifier");
 /**
- * A client for verifying Authly JWT tokens.
+ * A client for interacting with Authly.
  *
  * This client handles the validation of tokens against a specific issuer and audience,
- * fetching the public keys (JWKS) automatically.
+ * fetching the public keys (JWKS) automatically, and provides utilities for
+ * starting the OAuth2 flow.
  */
 class AuthlyClient {
     verifier;
     serviceId;
     issuer;
+    authorizePath;
     constructor(options) {
         this.issuer = options.issuer.replace(/\/$/, "");
         this.serviceId = options.serviceId;
         const jwksPath = options.jwksPath || config_1.DEFAULT_JWKS_PATH;
+        this.authorizePath = options.authorizePath || config_1.DEFAULT_AUTHORIZE_PATH;
         this.verifier = new JWTVerifier_1.JWTVerifier({
             issuer: this.issuer,
             audience: options.audience,
@@ -24,6 +27,23 @@ class AuthlyClient {
             algorithms: options.algorithms,
         });
     }
+    /**
+     * Generate the authorization URL to redirect the user to.
+     *
+     * @param options - Options for generating the URL.
+     * @returns The full authorization URL.
+     */
+    getAuthorizeUrl(options) {
+        const url = new URL(`${this.issuer}${this.authorizePath}`);
+        url.searchParams.set("client_id", this.serviceId);
+        url.searchParams.set("redirect_uri", options.redirectUri);
+        url.searchParams.set("response_type", options.responseType || "code");
+        url.searchParams.set("scope", options.scope || "openid profile email");
+        url.searchParams.set("state", options.state);
+        url.searchParams.set("code_challenge", options.codeChallenge);
+        url.searchParams.set("code_challenge_method", options.codeChallengeMethod || "S256");
+        return url.toString();
+    }
     /**
      * Verify a JWT token and return its decoded claims.
      *

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@authly/sdk",
     "description": "A library for building authentication systems using Authly.",
-    "version": "1.0.2",
+    "version": "1.1.0",
     "author": {
         "name": "Anvoria",
         "url": "https://github.com/Anvoria"