@tsed/oidc-provider 7.20.0 → 7.21.0

package/lib/types/domain/OidcAccountsMethods.d.ts

@@ -1,10 +1,5 @@
-import type { default as Provider, Account } from "oidc-provider";
-export type AuthorizationCode = InstanceType<Provider["AuthorizationCode"]>;
-export type AccessToken = InstanceType<Provider["AccessToken"]>;
-export type DeviceCode = InstanceType<Provider["DeviceCode"]>;
-export type RefreshToken = InstanceType<Provider["RefreshToken"]>;
-export type Client = InstanceType<Provider["Client"]>;
-export type BackchannelAuthenticationRequest = InstanceType<Provider["BackchannelAuthenticationRequest"]>;
+import type { Account } from "oidc-provider";
+import { AccessToken, AuthorizationCode, BackchannelAuthenticationRequest, DeviceCode } from "./interfaces";
 export interface OidcAccountsMethods {
     findAccount(id: string, token: AuthorizationCode | AccessToken | DeviceCode | BackchannelAuthenticationRequest | undefined): Promise<Account | undefined>;
 }

package/lib/types/domain/OidcSettings.d.ts

@@ -48,9 +48,12 @@ export interface OidcSettings extends Configuration {
      * Use the connection name for the OIDCRedisAdapter.
      */
     connectionName?: string;
+    plugins?: TsED.OIDCPluginSettings;
 }
 declare global {
     namespace TsED {
+        interface OIDCPluginSettings {
+        }
         interface Configuration {
             oidc: OidcSettings;
         }

package/lib/types/domain/interfaces.d.ts

@@ -1,3 +1,11 @@
 import type { interactionPolicy, default as Provider } from "oidc-provider";
+export type OIDCContext = InstanceType<Provider["OIDCContext"]>;
 export type OidcClient = InstanceType<Provider["Client"]>;
 export type DefaultPolicy = interactionPolicy.DefaultPolicy;
+export type AuthorizationCode = InstanceType<Provider["AuthorizationCode"]>;
+export type AccessToken = InstanceType<Provider["AccessToken"]>;
+export type DeviceCode = InstanceType<Provider["DeviceCode"]>;
+export type RefreshToken = InstanceType<Provider["RefreshToken"]>;
+export type BackchannelAuthenticationRequest = InstanceType<Provider["BackchannelAuthenticationRequest"]>;
+export type Grant = InstanceType<Provider["Grant"]>;
+export type OidcInteraction = InstanceType<Provider["Interaction"]>;

package/lib/types/index.d.ts

@@ -15,7 +15,6 @@ export * from "./decorators/uid";
 export * from "./domain/InteractionMethods";
 export * from "./domain/OidcAccountsMethods";
 export * from "./domain/OidcBadInteractionName";
-export * from "./domain/OidcInteraction";
 export * from "./domain/OidcInteractionMethods";
 export * from "./domain/OidcInteractionOptions";
 export * from "./domain/OidcInteractionPromptProps";
@@ -28,6 +27,8 @@ export * from "./services/OidcAdapters";
 export * from "./services/OidcInteractionContext";
 export * from "./services/OidcInteractions";
 export * from "./services/OidcJwks";
+export * from "./services/OidcPolicy";
 export * from "./services/OidcProvider";
+export * from "./services/OidcProviderNodeModule";
 export * from "./utils/debug";
 export * from "./utils/events";

package/lib/types/services/OidcInteractionContext.d.ts

@@ -2,8 +2,7 @@ import { PlatformContext } from "@tsed/common";
 import { Env } from "@tsed/core";
 import type { Account, InteractionResults, PromptDetail, default as Provider } from "oidc-provider";
 import { OidcSession } from "../decorators/oidcSession";
-import { OidcClient } from "../domain/interfaces";
-import { OidcInteraction } from "../domain/OidcInteraction";
+import { OidcClient, OidcInteraction } from "../domain/interfaces";
 import { OidcInteractionPromptProps } from "../domain/OidcInteractionPromptProps";
 import { OidcInteractions } from "./OidcInteractions";
 import { OidcProvider } from "./OidcProvider";

package/lib/types/services/OidcInteractions.d.ts

@@ -3,9 +3,9 @@ import { Env } from "@tsed/core";
 import { InjectorService } from "@tsed/di";
 import { OidcSettings } from "../domain/OidcSettings";
 export declare class OidcInteractions {
-    injector: InjectorService;
-    env: Env;
-    oidcSettings: OidcSettings;
+    protected injector: InjectorService;
+    protected env: Env;
+    protected oidcSettings: OidcSettings;
     protected interactions: Map<string, Provider>;
     $onInit(): void;
     getInteractions(): Provider[];

package/lib/types/services/OidcPolicy.d.ts

@@ -0,0 +1,16 @@
+import { InjectorService } from "@tsed/di";
+import { interactionPolicy } from "oidc-provider";
+import { InteractionMethods } from "../domain/InteractionMethods";
+import { OidcInteractionOptions } from "../domain/OidcInteractionOptions";
+import { OidcInteractions } from "./OidcInteractions";
+import { OIDC_PROVIDER_NODE_MODULE } from "./OidcProviderNodeModule";
+import Prompt = interactionPolicy.Prompt;
+export declare class OidcPolicy {
+    protected module: OIDC_PROVIDER_NODE_MODULE;
+    protected injector: InjectorService;
+    protected oidcInteractions: OidcInteractions;
+    constructor(module: OIDC_PROVIDER_NODE_MODULE);
+    getPolicy(): any;
+    createPrompt(instance: InteractionMethods, options: OidcInteractionOptions): Prompt;
+    private getInteractions;
+}

package/lib/types/services/OidcProvider.d.ts

@@ -1,15 +1,16 @@
 import { PlatformApplication, PlatformContext } from "@tsed/common";
 import { Env } from "@tsed/core";
 import { InjectorService } from "@tsed/di";
-import type { Configuration, interactionPolicy, default as OIDCProvider } from "oidc-provider";
-import { InteractionMethods } from "../domain/InteractionMethods";
-import { OidcInteractionOptions } from "../domain/OidcInteractionOptions";
+import type { Configuration } from "oidc-provider";
 import { OidcSettings } from "../domain/OidcSettings";
 import { OidcAdapters } from "./OidcAdapters";
 import { OidcInteractions } from "./OidcInteractions";
 import { OidcJwks } from "./OidcJwks";
+import { OidcPolicy } from "./OidcPolicy";
+import { OIDC_PROVIDER_NODE_MODULE, Provider } from "./OidcProviderNodeModule";
 export declare class OidcProvider {
-    raw: OIDCProvider;
+    protected module: OIDC_PROVIDER_NODE_MODULE;
+    raw: Provider;
     protected env: Env;
     protected httpPort: number | string;
     protected httpsPort: number | string;
@@ -18,22 +19,22 @@ export declare class OidcProvider {
     protected platformName: string;
     protected oidcJwks: OidcJwks;
     protected oidcInteractions: OidcInteractions;
+    protected oidcPolicy: OidcPolicy;
     protected adapters: OidcAdapters;
     protected injector: InjectorService;
     protected app: PlatformApplication;
     protected $ctx?: PlatformContext;
+    constructor(module: OIDC_PROVIDER_NODE_MODULE);
     get logger(): import("@tsed/common").DILogger;
     hasConfiguration(): boolean;
     getConfiguration(): Promise<Configuration>;
     getIssuer(): string;
-    get(): OIDCProvider;
+    get(): Provider;
     /**
      * Create a new instance of OidcProvider
      */
-    create(): Promise<void | OIDCProvider>;
-    createPrompt(instance: InteractionMethods, options: OidcInteractionOptions): Promise<interactionPolicy.Prompt>;
+    create(): Promise<void | Provider>;
     private createErrorHandler;
     private getInteractionsUrl;
     private allowHttpLocalhost;
-    private getPolicy;
 }

package/lib/types/services/OidcProviderNodeModule.d.ts

@@ -0,0 +1,7 @@
+import { Type } from "@tsed/core";
+import type Provider from "oidc-provider";
+export declare const OIDC_PROVIDER_NODE_MODULE: unique symbol;
+export type OIDC_PROVIDER_NODE_MODULE = {
+    Provider: Type<Provider>;
+} & typeof import("oidc-provider");
+export { Provider };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/oidc-provider",
-  "version": "7.20.0",
+  "version": "7.21.0",
   "description": "OIDC provider package for Ts.ED framework",
   "private": false,
   "source": "./src/index.ts",
@@ -23,7 +23,7 @@
     "lint:fix": "eslint '**/*.{ts,js}' --fix"
   },
   "dependencies": {
-    "@tsed/adapters": "7.20.0",
+    "@tsed/adapters": "7.21.0",
     "express-urlrewrite": "^1.4.0",
     "jose2": "npm:jose@^2.0.4",
     "koa-mount": "^4.0.0",
@@ -32,13 +32,13 @@
     "uuid": "8.3.2"
   },
   "devDependencies": {
-    "@tsed/common": "7.20.0",
-    "@tsed/core": "7.20.0",
-    "@tsed/di": "7.20.0",
-    "@tsed/eslint": "7.20.0",
-    "@tsed/exceptions": "7.20.0",
-    "@tsed/jwks": "7.20.0",
-    "@tsed/typescript": "7.20.0",
+    "@tsed/common": "7.21.0",
+    "@tsed/core": "7.21.0",
+    "@tsed/di": "7.21.0",
+    "@tsed/eslint": "7.21.0",
+    "@tsed/exceptions": "7.21.0",
+    "@tsed/jwks": "7.21.0",
+    "@tsed/typescript": "7.21.0",
     "@types/lowdb": "1.0.11",
     "@types/oidc-provider": "8.1.1",
     "@types/uuid": "8.3.4",
@@ -47,13 +47,13 @@
     "oidc-provider": "8.1.1"
   },
   "peerDependencies": {
-    "@tsed/ajv": "^7.20.0",
-    "@tsed/common": "^7.20.0",
-    "@tsed/core": "^7.20.0",
-    "@tsed/di": "^7.20.0",
-    "@tsed/json-mapper": "^7.20.0",
-    "@tsed/schema": "^7.20.0",
-    "oidc-provider": ">=7.3.0"
+    "@tsed/ajv": "^7.21.0",
+    "@tsed/common": "^7.21.0",
+    "@tsed/core": "^7.21.0",
+    "@tsed/di": "^7.21.0",
+    "@tsed/json-mapper": "^7.21.0",
+    "@tsed/schema": "^7.21.0",
+    "oidc-provider": ">=8.0.0"
   },
   "peerDependenciesMeta": {
     "@tsed/common": {

package/readme.md

@@ -30,6 +30,14 @@
 
 A package of Ts.ED framework. See website: https://tsed.io/tutorials/oidc-provider
 
+## OIDC compatibility
+
+- For OIDC v7, use @tsed/oidc-provider v7.19 and under
+- For OIDC v8, use @tsed/oidc-provider v7.20 and higher
+
+Since the v8, have changed the exported Provider (named by default) and the entire is under ESM convention, Ts.ED isn't
+able to maintain the v7 and v8 at the same time.
+
 ## Feature
 
 Currently, `@tsed/oidc-provider` allows you:

package/lib/cjs/domain/OidcInteraction.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=OidcInteraction.js.map

package/lib/cjs/domain/OidcInteraction.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"OidcInteraction.js","sourceRoot":"","sources":["../../../src/domain/OidcInteraction.ts"],"names":[],"mappings":""}

package/lib/esm/domain/OidcInteraction.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=OidcInteraction.js.map

package/lib/esm/domain/OidcInteraction.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"OidcInteraction.js","sourceRoot":"","sources":["../../../src/domain/OidcInteraction.ts"],"names":[],"mappings":""}

package/lib/types/domain/OidcInteraction.d.ts

@@ -1,2 +0,0 @@
-import type { default as OidcProvider } from "oidc-provider";
-export type OidcInteraction = InstanceType<OidcProvider["Interaction"]>;