@webda/core 4.0.0-beta.1 → 4.0.0-beta.3

package/lib/services/oauth.d.ts

@@ -1,7 +1,12 @@
-import { Core, Counter } from "../core.js";
-import { EventWithContext, OperationContext, RequestFilter, WebContext } from "../index.js";
-import { Authentication } from "./authentication.js";
-import { RegExpStringValidator, Service, ServiceParameters } from "./service.js";
+import type { Authentication } from "./authentication.service.js";
+import { Service } from "./service.js";
+import { RequestFilter } from "../rest/irest.js";
+import { WebContext } from "../contexts/webcontext.js";
+import { Counter } from "../metrics/metrics.js";
+import { RegExpStringValidator } from "@webda/utils";
+import { ServiceParameters } from "../services/serviceparameters.js";
+import { OperationContext } from "../contexts/operationcontext.js";
+import { EventWithContext } from "../events/events.js";
 export interface EventOAuthToken extends EventWithContext {
     /**
      * Provider from
@@ -24,20 +29,23 @@ export interface OAuthReturn {
     profile: any;
     identId: string;
 }
+/** Parameters for OAuth services including client credentials, scopes, and redirect URIs */
 export declare class OAuthServiceParameters extends ServiceParameters {
     /**
      * URL to use for expose
      *
      * The default value varying based on implementation
      * It should by default be the provider name in lowercase
+     *
+     * @SchemaOptional
      */
-    url?: string;
+    url: string;
     /**
      * Scope to request on OAuth flow
      *
      * @defaut ["email"]
      */
-    scope?: string[];
+    scope: string[];
     /**
      * If set to true it will add a ${url}/scope
      * So client can anticipate the requested scope
@@ -47,7 +55,7 @@ export declare class OAuthServiceParameters extends ServiceParameters {
      *
      * @default false
      */
-    exposeScope?: boolean;
+    exposeScope: boolean;
     /**
      * List of URIs authorized for redirect post authorization
      *
@@ -71,7 +79,12 @@ export declare class OAuthServiceParameters extends ServiceParameters {
      * @default Authentication
      */
     authenticationService: string;
-    constructor(params: any);
+    /**
+     * Load parameters with defaults for scopes, auth service, and URI settings
+     * @param params - the service parameters
+     * @returns the result
+     */
+    load(params: any): this;
 }
 export type OAuthEvents = {
     "OAuth.Callback": EventOAuthToken;
@@ -113,80 +126,93 @@ export declare abstract class OAuthService<T extends OAuthServiceParameters = OA
     authorized_uris: RegExpStringValidator;
     /**
      * Ensure default parameter url
+     * @param name - the service name
+     * @param params - the service parameters
      */
-    constructor(webda: Core, name: string, params?: any);
+    constructor(name: string, params?: any);
+    /** Initialize OAuth-specific metrics for tracking logins */
     initMetrics(): void;
-    /**
-     * Load parameters
-     *
-     * @param params
-     */
-    loadParameters(params: any): ServiceParameters;
     /**
      * Allow callback referer to access this url no matter what
-     * @param context
-     * @returns
+     * @param context - the execution context
+     * @returns true if the condition is met
      */
     checkRequest(context: WebContext): Promise<boolean>;
     /**
      * Resolve dynamic dependancy
+     * @returns this for chaining
      */
     resolve(): this;
     /**
      * Get OAuth callback query parameters
-     * @returns
+     * @returns the result
      */
     getCallbackQueryParams(): {
         name: string;
         required: boolean;
     }[];
     /**
-     * Add routes for the authentication
+     * Register callback + optional token/scope routes.
+     *
+     * `_redirect` is declared via `@Route` below. The callback query string
+     * depends on {@link getCallbackQueryParams} (subclass-overridable), and
+     * the token/scope routes are conditional on {@link hasToken} and
+     * `parameters.exposeScope`, so those three stay programmatic.
+     *
+     * @returns this for chaining
      */
-    initRoutes(): void;
+    init(): Promise<this>;
     /**
      * Expose the scope used by the authentication
-     * @param ctx
+     * @param ctx - the operation context
      */
     _scope(ctx: OperationContext): void;
     /**
      * Define if this provider allow authentication by tokens
-     * @returns
+     * @returns true if the condition is met
      */
     hasToken(): boolean;
     /**
      * Check if the url is authorized
-     * @param redirect
-     * @param context
-     * @returns
+     * @param redirect - the redirect URL
+     * @param context - the execution context
+     * @returns true if the condition is met
      */
     isAuthorizedUri(redirect: string, context: WebContext): boolean;
+    /**
+     * Inject the provider name into openapi template replacements so the
+     * `${name}` placeholders in `@Route` metadata resolve per-instance.
+     *
+     * @returns replacements map merged with defaults
+     */
+    getOpenApiReplacements(): any;
     /**
      * Redirect to the OAuth provider
      *
      * The calling url must be and authorized_uris if defined
-     * @param ctx
+     * @param ctx - the operation context
      */
     _redirect(ctx: WebContext): void;
     /**
      * Handle a token return
      *
      * This is private to avoid any override
-     * @param context
+     * @param context - the execution context
      */
     private _token;
     /**
      * Handle a standard url callback
      *
      * This is private to avoid any override
-     * @param ctx
+     * @param ctx - the operation context
      */
     private _callback;
     /**
      * Once approved by the OAuth provider this will do the common task
-     * @param ctx
-     * @param identId
-     * @param profile
+     * @param ctx - the operation context
+     * @param identId - the identity identifier
+     * @param profile - the user profile
+     * @param _tokens - the authentication tokens
      */
     handleReturn(ctx: WebContext, identId: string, profile: any, _tokens?: any): Promise<void>;
     /**
@@ -221,3 +247,4 @@ export declare abstract class OAuthService<T extends OAuthServiceParameters = OA
      */
     abstract handleCallback(ctx: WebContext): Promise<OAuthReturn>;
 }
+//# sourceMappingURL=oauth.d.ts.map

package/lib/services/oauth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"oauth.d.ts","sourceRoot":"","sources":["../../src/services/oauth.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAS,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAErE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACvD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,IAAI,EAAE,OAAO,GAAG,UAAU,CAAC;IAC3B;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,GAAG,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,4FAA4F;AAC5F,qBAAa,sBAAuB,SAAQ,iBAAiB;IAC3D;;;;;;;OAOG;IACK,GAAG,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB;;;;;;;;OAQG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;;;OAIG;IACH,IAAI,CAAC,MAAM,EAAE,GAAG,QAQf;CACF;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,gBAAgB,EAAE,eAAe,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE;QACN;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB;;WAEG;QACH,OAAO,CAAC,EAAE,GAAG,CAAC;KACf,CAAC;CACH;AAED;;;GAGG;AACH,8BAAsB,YAAY,CAChC,CAAC,SAAS,sBAAsB,GAAG,sBAAsB,EACzD,CAAC,SAAS,WAAW,GAAG,WAAW,CAEnC,SAAQ,OAAO,CAAC,CAAC,EAAE,CAAC,CACpB,YAAW,aAAa,CAAC,UAAU,CAAC;IAEpC,sBAAsB,EAAE,cAAc,CAAC;IAEvC;;OAEG;IACK,OAAO,EAAE;QACf,KAAK,EAAE,OAAO,CAAC;KAChB,CAAC;IACF,eAAe,EAAE,qBAAqB,CAAC;IAEvC;;;;OAIG;IACH,YAAY,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,EAGrC;IAED,4DAA4D;IAC5D,WAAW,IAAI,IAAI,CAOlB;IAED;;;;OAIG;IACG,YAAY,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,CAkBxD;IAED;;;OAGG;IACH,OAAO,IAAI,IAAI,CAgBd;IAED;;;OAGG;IACH,sBAAsB,IAAI;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAA;KAAE,EAAE,CAe9D;IAED;;;;;;;;;OASG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAkE1B;IAED;;;OAGG;IACH,MAAM,CAAC,GAAG,EAAE,gBAAgB,QAE3B;IAED;;;OAGG;IACH,QAAQ,IAAI,OAAO,CAElB;IAED;;;;;OAKG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAM9D;IAED;;;;;OAKG;IACH,sBAAsB,IAAI,GAAG,CAE5B;IAED;;;;;OAKG;IAYH,SAAS,CAAC,GAAG,EAAE,UAAU,QAgBxB;IAED;;;;;OAKG;YACW,MAAM;IAYpB;;;;;OAKG;YACW,SAAS;IAYvB;;;;;;OAMG;IACG,YAAY,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,GAAE,GAAe,iBA4B1F;IAED;;OAEG;IACH,QAAQ,CAAC,aAAa,IAAI,MAAM,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,kBAAkB,IAAI,MAAM,EAAE,CAAC;IAExC;;OAEG;IACH,QAAQ,CAAC,OAAO,IAAI,MAAM,CAAC;IAE3B;;;;;;OAMG;IACH,QAAQ,CAAC,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,OAAE;IAE/E;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAElE;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CAChE"}