@tsed/cli-plugin-oidc-provider 4.0.1 → 4.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/cli-plugin-oidc-provider",
-  "version": "4.0.1",
+  "version": "4.2.0",
   "description": "Ts.ED CLI plugin. Add OIDC Provider",
   "source": "./src/index.ts",
   "main": "./lib/cjs/index.js",
@@ -25,12 +25,12 @@
     "tslib": "2.3.1"
   },
   "devDependencies": {
-    "@tsed/cli": "4.0.1",
-    "@tsed/cli-core": "4.0.1"
+    "@tsed/cli": "4.2.0",
+    "@tsed/cli-core": "4.2.0"
   },
   "peerDependencies": {
-    "@tsed/cli": "^4.0.1",
-    "@tsed/cli-core": "^4.0.1"
+    "@tsed/cli": "^4.2.0",
+    "@tsed/cli-core": "^4.2.0"
   },
   "repository": "https://github.com/tsedio/tsed-cli",
   "bugs": {

package/templates/init/src/controllers/oidc/InteractionsController.spec.ts

@@ -12,9 +12,9 @@ describe("InteractionsController", () => {
       const oidcContext = getOidcContextFixture();
       const controller = await PlatformTest.invoke<InteractionsController>(InteractionsController);
 
-      await controller.promptInteraction(oidcContext);
+      await controller.promptInteraction("name", oidcContext);
 
-      expect(oidcContext.runInteraction).toHaveBeenCalledWith();
+      expect(oidcContext.runInteraction).toHaveBeenCalledWith("name");
     });
   });
 });

package/templates/init/src/controllers/oidc/InteractionsController.ts

@@ -1,4 +1,4 @@
-import {Get} from "@tsed/common";
+import {Get, PathParams} from "@tsed/common";
 import {Interactions, OidcCtx} from "@tsed/oidc-provider";
 import {Name} from "@tsed/schema";
 import * as interactions from "../../interactions/index";
@@ -9,8 +9,8 @@ import * as interactions from "../../interactions/index";
   children: Object.values(interactions)
 })
 export class InteractionsController {
-  @Get("/")
-  async promptInteraction(@OidcCtx() oidcCtx: OidcCtx) {
+  @Get("/:name?")
+  async promptInteraction(@PathParams("name") name: string | undefined, @OidcCtx() oidcCtx: OidcCtx) {
     return oidcCtx.runInteraction();
   }
 }

package/templates/init/src/interactions/AbortInteraction.ts

@@ -0,0 +1,26 @@
+import {Inject} from "@tsed/common";
+import {Interaction, OidcCtx, OidcProvider, InteractionMethods} from "@tsed/oidc-provider";
+import {View} from "@tsed/platform-views";
+import {Name} from "@tsed/schema";
+
+@Interaction({
+  name: "abort"
+})
+@Name("Oidc")
+export class AbortInteraction implements InteractionMethods {
+  @Inject()
+  oidc: OidcProvider;
+
+  @View("interaction")
+  async $prompt(@OidcCtx() oidcCtx: OidcCtx): Promise<any> {
+    return oidcCtx.interactionFinished(
+      {
+        error: "access_denied",
+        error_description: "End-User aborted interaction"
+      },
+      {
+        mergeWithLastSubmission: false
+      }
+    );
+  }
+}

package/templates/init/src/interactions/ConsentInteraction.ts

@@ -3,7 +3,8 @@ import {Interaction, OidcCtx, OidcProvider} from "@tsed/oidc-provider";
 import {Name} from "@tsed/schema";
 
 @Interaction({
-  name: "consent"
+  name: "consent",
+  requestable: true
 })
 @Name("Oidc")
 export class ConsentInteraction {

package/templates/init/src/interactions/CustomInteraction.ts

@@ -1,20 +1,68 @@
-import {Inject} from "@tsed/common";
+import {View} from "@tsed/common";
 import {Env} from "@tsed/core";
 import {Constant} from "@tsed/di";
-import {Interaction} from "@tsed/oidc-provider";
+import {Interaction, InteractionMethods, OidcCtx, OidcSession, Params, Prompt, Uid} from "@tsed/oidc-provider";
 import {Name} from "@tsed/schema";
-import {Accounts} from "../services/Accounts";
+import {interactionPolicy, KoaContextWithOIDC} from "oidc-provider";
+import Check = interactionPolicy.Check;
 
 @Interaction({
-  name: "custom"
+  name: "custom",
+  requestable: true
 })
 @Name("Oidc")
-export class CustomInteraction {
+export class CustomInteraction implements InteractionMethods {
   @Constant("env")
   env: Env;
 
-  @Inject()
-  accounts: Accounts;
+  $onCreate() {
+  }
 
-  $onCreate() {}
+  /**
+   * return checks conditions. See: https://github.com/panva/node-oidc-provider/blob/main/docs/README.md#interactionspolicy
+   */
+  checks() {
+    return [
+      new Check("no_session", "End-User authentication is required", (ctx) => {
+        const { oidc } = ctx;
+
+        if (oidc.session?.accountId) {
+          // @ts-ignore
+          return Check.NO_NEED_TO_PROMPT;
+        }
+
+        // @ts-ignore
+        return Check.REQUEST_PROMPT;
+      })
+    ];
+  }
+
+  /**
+   * return checks conditions. See: https://github.com/panva/node-oidc-provider/blob/main/docs/README.md#interactionspolicy
+   */
+  details(ctx: KoaContextWithOIDC) {
+    const { oidc } = ctx;
+
+    return {
+      ...(oidc.params?.max_age === undefined ? undefined : { max_age: oidc.params.max_age }),
+      ...(oidc.params?.login_hint === undefined ? undefined : { login_hint: oidc.params.login_hint }),
+      ...(oidc.params?.id_token_hint === undefined ? undefined : { id_token_hint: oidc.params.id_token_hint })
+    };
+  }
+
+  @View("custom")
+  async $prompt(
+    @OidcCtx() oidcCtx: OidcCtx,
+    @Prompt() prompt: Prompt,
+    @OidcSession() session: OidcSession,
+    @Params() params: Params,
+    @Uid() uid: Uid
+  ): Promise<any> {
+    await oidcCtx.checkClientId();
+
+    return oidcCtx.interactionPrompt({
+      title: "Custom",
+      flash: false
+    });
+  }
 }

package/templates/init/src/interactions/LoginInteraction.ts

@@ -6,7 +6,8 @@ import {Name} from "@tsed/schema";
 import {Accounts} from "../services/Accounts";
 
 @Interaction({
-  name: "login"
+  name: "login",
+  requestable: true
 })
 @Name("Oidc")
 export class LoginInteraction {