feat: short internal name for "oidc" plugin

Author: aartoni

README.md

@@ -22,14 +22,14 @@ Just put the following in your `config/plugins.ts`.
 
 ```ts
 export default ({ env }) => ({
-  "strapi-plugin-oidc": {
+  "oidc": {
     enabled: true,
     config: {
       // Either sets token to session storage if false or local storage if true
       REMEMBER_ME: false,
 
       // OpenID Connect
-      OIDC_REDIRECT_URI: "https://your-strapi/api/strapi-plugin-oidc/callback",
+      OIDC_REDIRECT_URI: "https://your-strapi/api/oidc/callback",
       OIDC_CLIENT_ID: "[Client ID from the provider]",
       OIDC_CLIENT_SECRET: "[Client secret from the provider]",
       OIDC_AUTHORIZATION_ENDPOINT: "[API Endpoint]",
@@ -72,7 +72,7 @@ export default [
   "strapi::security",
   "strapi::cors",
   // ...
-  "plugin::strapi-plugin-oidc.block-native-auth",
+  "plugin::oidc.block-native-auth",
 ];
 ```
 

admin/src/OidcLoginPage.tsx

@@ -12,7 +12,7 @@ const OidcLoginPage = () => {
   const { token } = useAuth("OidcLoginPage", (auth) => auth);
 
   useEffect(() => {
-    if (!token) window.location.replace("/api/strapi-plugin-oidc/sign-in");
+    if (!token) window.location.replace("/api/oidc/sign-in");
   }, [token]);
 
   if (token) return <Navigate to="/" />;

admin/src/index.ts

@@ -18,9 +18,7 @@ export default {
         defaultMessage: "Single Sign-On",
       },
       Component: () => import("./pages/App"),
-      permissions: [
-        { action: "plugin::strapi-plugin-oidc.read", subject: null },
-      ],
+      permissions: [{ action: "plugin::oidc.read", subject: null }],
     });
     app.registerPlugin({ id: PLUGIN_ID, initializer: Initializer, name });
   },

admin/src/pages/HomePage/index.tsx

@@ -18,14 +18,14 @@ const HomePage = () => {
   const { get, put } = useFetchClient();
 
   useEffect(() => {
-    get("/strapi-plugin-oidc/sso-roles").then((response) => {
+    get("/oidc/sso-roles").then((response) => {
       setExpression(response.data?.expression ?? "");
     });
   }, []);
 
   const onSave = async () => {
     try {
-      await put("/strapi-plugin-oidc/sso-roles", { expression });
+      await put("/oidc/sso-roles", { expression });
       setSuccess(true);
       setTimeout(() => setSuccess(false), 3000);
     } catch (e) {
@@ -37,9 +37,7 @@ const HomePage = () => {
 
   return (
     <Page.Protect
-      permissions={[
-        { action: "plugin::strapi-plugin-oidc.read", subject: null },
-      ]}
+      permissions={[{ action: "plugin::oidc.read", subject: null }]}
     >
       <Layouts.Header
         title="Single Sign On"

admin/src/pluginId.ts

@@ -1,5 +1,5 @@
 import pluginPkg from "../../package.json";
 
-const PLUGIN_ID = pluginPkg.name.replace(/^@strapi\/plugin-/i, "");
+const PLUGIN_ID = pluginPkg.strapi.name;
 
 export default PLUGIN_ID;

compose.yml

@@ -6,7 +6,7 @@ services:
       - OIDC_AUTHORIZATION_ENDPOINT=https://${AUTH_DOMAIN}/api/oidc/authorization
       - OIDC_TOKEN_ENDPOINT=https://${AUTH_DOMAIN}/api/oidc/token
       - OIDC_USER_INFO_ENDPOINT=https://${AUTH_DOMAIN}/api/oidc/userinfo
-      - OIDC_REDIRECT_URI=https://${CMS_DOMAIN}/api/strapi-plugin-oidc/callback
+      - OIDC_REDIRECT_URI=https://${CMS_DOMAIN}/api/oidc/callback
       # TODO Should we load the client ID + secret from secrets instead?
       - OIDC_CLIENT_ID=onbU2exrz2I0RCJRrXsCQj49dgLFHLppCekGGdKmBaQ_7MWpAKcnylw6kO-7lUhsUtzmGJM8
       - OIDC_CLIENT_SECRET=yebsr4POK_hXenANvvo4DAHBGPIP_3a0

config/authelia/configuration.yml

@@ -13,7 +13,7 @@ identity_providers:
         client_name: 'Strapi'
         client_secret: '{{ secret "/run/secrets/oidc_strapi_digest" }}'
         redirect_uris:
-          - https://{{ mustEnv "CMS_DOMAIN" }}/api/strapi-plugin-oidc/callback
+          - https://{{ mustEnv "CMS_DOMAIN" }}/api/oidc/callback
         scopes:
           - 'email'
           - 'groups'

cypress/e2e/login.cy.js

@@ -4,7 +4,7 @@ import pluginPkg from "../../package.json";
 
 const CMS = "https://cms.strapi.local";
 const IDP = "https://auth.strapi.local";
-const PLUGIN_ID = pluginPkg.name.replace(/^@strapi\/plugin-/i, "");
+const PLUGIN_ID = pluginPkg.strapi.name;
 
 describe("SSO plugin", () => {
   describe("OIDC sign-in", () => {

cypress/support/commands.js

@@ -19,7 +19,7 @@ Cypress.Commands.add("loginAs", (username, password) => {
         AUTHELIA_STACK.idp,
         { args: { cms: AUTHELIA_STACK.cms, username, password } },
         ({ cms, username, password }) => {
-          cy.visit(`${cms}/api/strapi-plugin-oidc/sign-in`);
+          cy.visit(`${cms}/api/oidc/sign-in`);
           cy.get("#username-textfield").type(username);
           cy.get("#password-textfield").type(password);
           cy.get("#sign-in-button").click();

package.json

@@ -4,7 +4,7 @@
   "description": "Plug-in for single sign-on with Strapi!",
   "strapi": {
     "displayName": "Single Sign On",
-    "name": "strapi-plugin-oidc",
+    "name": "oidc",
     "description": "Version 5 enables single sign-on",
     "kind": "plugin"
   },