@strapi/plugin-graphql 5.7.0 → 5.8.0

package/dist/admin/index.js

@@ -16,7 +16,7 @@ const __variableDynamicImportRuntimeHelper = (glob, path, segs) => {
   });
 };
 const name$1 = "@strapi/plugin-graphql";
-const version = "5.6.0";
+const version = "5.7.0";
 const description = "Adds GraphQL endpoint with default API methods.";
 const repository = {
   type: "git",
@@ -71,7 +71,7 @@ const dependencies = {
   "@koa/cors": "5.0.0",
   "@strapi/design-system": "2.0.0-rc.14",
   "@strapi/icons": "2.0.0-rc.14",
-  "@strapi/utils": "5.6.0",
+  "@strapi/utils": "5.7.0",
   graphql: "^16.8.1",
   "graphql-depth-limit": "^1.1.0",
   "graphql-playground-middleware-koa": "^1.6.21",
@@ -84,19 +84,19 @@ const dependencies = {
 };
 const devDependencies = {
   "@strapi/sdk-plugin": "^5.2.0",
-  "@strapi/strapi": "5.6.0",
-  "@strapi/types": "5.6.0",
+  "@strapi/strapi": "5.7.0",
+  "@strapi/types": "5.7.0",
   "@types/graphql-depth-limit": "1.1.5",
   "@types/koa-bodyparser": "4.3.12",
   "@types/koa__cors": "5.0.0",
   "cross-env": "^7.0.3",
-  "eslint-config-custom": "5.6.0",
+  "eslint-config-custom": "5.7.0",
   koa: "2.15.2",
   react: "18.3.1",
   "react-dom": "18.3.1",
   "react-router-dom": "6.22.3",
   "styled-components": "6.1.8",
-  tsconfig: "5.6.0",
+  tsconfig: "5.7.0",
   typescript: "5.3.2"
 };
 const peerDependencies = {

package/dist/admin/index.mjs

@@ -15,7 +15,7 @@ const __variableDynamicImportRuntimeHelper = (glob, path, segs) => {
   });
 };
 const name$1 = "@strapi/plugin-graphql";
-const version = "5.6.0";
+const version = "5.7.0";
 const description = "Adds GraphQL endpoint with default API methods.";
 const repository = {
   type: "git",
@@ -70,7 +70,7 @@ const dependencies = {
   "@koa/cors": "5.0.0",
   "@strapi/design-system": "2.0.0-rc.14",
   "@strapi/icons": "2.0.0-rc.14",
-  "@strapi/utils": "5.6.0",
+  "@strapi/utils": "5.7.0",
   graphql: "^16.8.1",
   "graphql-depth-limit": "^1.1.0",
   "graphql-playground-middleware-koa": "^1.6.21",
@@ -83,19 +83,19 @@ const dependencies = {
 };
 const devDependencies = {
   "@strapi/sdk-plugin": "^5.2.0",
-  "@strapi/strapi": "5.6.0",
-  "@strapi/types": "5.6.0",
+  "@strapi/strapi": "5.7.0",
+  "@strapi/types": "5.7.0",
   "@types/graphql-depth-limit": "1.1.5",
   "@types/koa-bodyparser": "4.3.12",
   "@types/koa__cors": "5.0.0",
   "cross-env": "^7.0.3",
-  "eslint-config-custom": "5.6.0",
+  "eslint-config-custom": "5.7.0",
   koa: "2.15.2",
   react: "18.3.1",
   "react-dom": "18.3.1",
   "react-router-dom": "6.22.3",
   "styled-components": "6.1.8",
-  tsconfig: "5.6.0",
+  tsconfig: "5.7.0",
   typescript: "5.3.2"
 };
 const peerDependencies = {

package/dist/server/index.js

@@ -94,6 +94,61 @@ const merge = fp.mergeWith((a, b) => {
     return a.concat(b);
   }
 });
+const determineLandingPage = (strapi2) => {
+  const { config: config2 } = strapi2.plugin("graphql");
+  const utils2 = strapi2.plugin("graphql").service("utils");
+  const configLandingPage = config2("landingPage");
+  const isProduction = process.env.NODE_ENV === "production";
+  const localLanding = () => {
+    strapi2.log.debug("Apollo landing page: local");
+    utils2.playground.setEnabled(true);
+    return _default.ApolloServerPluginLandingPageLocalDefault();
+  };
+  const prodLanding = () => {
+    strapi2.log.debug("Apollo landing page: production");
+    utils2.playground.setEnabled(false);
+    return _default.ApolloServerPluginLandingPageProductionDefault();
+  };
+  const userLanding = (userFunction) => {
+    strapi2.log.debug("Apollo landing page: from user-defined function...");
+    const result = userFunction(strapi2);
+    if (result === true) {
+      return localLanding();
+    }
+    if (result === false) {
+      return prodLanding();
+    }
+    strapi2.log.debug("Apollo landing page: user-defined");
+    return result;
+  };
+  const playgroundAlways = config2("playgroundAlways");
+  if (playgroundAlways !== void 0) {
+    strapi2.log.warn(
+      "The graphql config playgroundAlways is deprecated. This will be removed in Strapi 6. Please use landingPage instead. "
+    );
+  }
+  if (playgroundAlways === false) {
+    strapi2.log.warn(
+      "graphql config playgroundAlways:false has no effect, please use landingPage:false to disable Graphql Playground in all environments"
+    );
+  }
+  if (playgroundAlways || configLandingPage === true) {
+    return localLanding();
+  }
+  if (configLandingPage === false) {
+    return prodLanding();
+  }
+  if (configLandingPage === void 0) {
+    return isProduction ? prodLanding() : localLanding();
+  }
+  if (fp.isFunction(configLandingPage)) {
+    return userLanding(configLandingPage);
+  }
+  strapi2.log.warn(
+    "Your Graphql landing page has been disabled because there is a problem with your Graphql settings"
+  );
+  return prodLanding();
+};
 async function bootstrap({ strapi: strapi2 }) {
   const schema = strapi2.plugin("graphql").service("content-api").buildSchema();
   if (fp.isEmpty(schema)) {
@@ -102,15 +157,7 @@ async function bootstrap({ strapi: strapi2 }) {
   }
   const { config: config2 } = strapi2.plugin("graphql");
   const path = config2("endpoint");
-  const playgroundEnabled = !(process.env.NODE_ENV === "production" && !config2("playgroundAlways"));
-  let landingPage;
-  if (playgroundEnabled) {
-    landingPage = _default.ApolloServerPluginLandingPageLocalDefault();
-    strapi2.log.debug("Using Apollo sandbox landing page");
-  } else {
-    landingPage = _default.ApolloServerPluginLandingPageProductionDefault();
-    strapi2.log.debug("Using Apollo production landing page");
-  }
+  const landingPage = determineLandingPage(strapi2);
   const defaultServerConfig = {
     // Schema
     schema,
@@ -159,7 +206,7 @@ async function bootstrap({ strapi: strapi2 }) {
       }
     };
     const isPlaygroundRequest = ctx.request.method === "GET" && ctx.request.url === path && // Matches the GraphQL endpoint
-    playgroundEnabled && // Only allow if the Playground is enabled
+    strapi2.plugin("graphql").service("utils").playground.isEnabled() && // Only allow if the Playground is enabled
     ctx.request.header.accept?.includes("text/html");
     if (isPlaygroundRequest) {
       return next();
@@ -1022,14 +1069,18 @@ const naming = ({ strapi: strapi2 }) => {
   };
 };
 const playground = (ctx) => {
+  let enabled = false;
   return {
+    setEnabled(val) {
+      enabled = val;
+    },
     isEnabled() {
-      return !(process.env.NODE_ENV === "production" && !ctx.strapi.plugin("graphql").config("playgroundAlways"));
+      return enabled;
     }
   };
 };
 const utils$1 = (context) => ({
-  playground: playground(context),
+  playground: playground(),
   naming: naming(context),
   attributes: attributes(context),
   mappers: mappers(context)

package/dist/server/index.mjs

@@ -1,4 +1,4 @@
-import { isEmpty, toUpper, snakeCase, pick, mergeWith, isArray, isObject, propOr, get, getOr, first, isFunction, isNil, prop, startsWith, difference, propEq, isDate, has, mapValues, map, upperFirst, camelCase, pipe, lowerFirst, set, omit, identity, constant, isUndefined, isString, defaultTo, entries, reduce, merge as merge$1 } from "lodash/fp";
+import { isEmpty, toUpper, snakeCase, pick, mergeWith, isArray, isObject, isFunction, propOr, get, getOr, first, isNil, prop, startsWith, difference, propEq, isDate, has, mapValues, map, upperFirst, camelCase, pipe, lowerFirst, set, omit, identity, constant, isUndefined, isString, defaultTo, entries, reduce, merge as merge$1 } from "lodash/fp";
 import { ApolloServer } from "@apollo/server";
 import { ApolloServerPluginLandingPageLocalDefault, ApolloServerPluginLandingPageProductionDefault } from "@apollo/server/plugin/landingPage/default";
 import { koaMiddleware } from "@as-integrations/koa";
@@ -72,6 +72,61 @@ const merge = mergeWith((a, b) => {
     return a.concat(b);
   }
 });
+const determineLandingPage = (strapi2) => {
+  const { config: config2 } = strapi2.plugin("graphql");
+  const utils2 = strapi2.plugin("graphql").service("utils");
+  const configLandingPage = config2("landingPage");
+  const isProduction = process.env.NODE_ENV === "production";
+  const localLanding = () => {
+    strapi2.log.debug("Apollo landing page: local");
+    utils2.playground.setEnabled(true);
+    return ApolloServerPluginLandingPageLocalDefault();
+  };
+  const prodLanding = () => {
+    strapi2.log.debug("Apollo landing page: production");
+    utils2.playground.setEnabled(false);
+    return ApolloServerPluginLandingPageProductionDefault();
+  };
+  const userLanding = (userFunction) => {
+    strapi2.log.debug("Apollo landing page: from user-defined function...");
+    const result = userFunction(strapi2);
+    if (result === true) {
+      return localLanding();
+    }
+    if (result === false) {
+      return prodLanding();
+    }
+    strapi2.log.debug("Apollo landing page: user-defined");
+    return result;
+  };
+  const playgroundAlways = config2("playgroundAlways");
+  if (playgroundAlways !== void 0) {
+    strapi2.log.warn(
+      "The graphql config playgroundAlways is deprecated. This will be removed in Strapi 6. Please use landingPage instead. "
+    );
+  }
+  if (playgroundAlways === false) {
+    strapi2.log.warn(
+      "graphql config playgroundAlways:false has no effect, please use landingPage:false to disable Graphql Playground in all environments"
+    );
+  }
+  if (playgroundAlways || configLandingPage === true) {
+    return localLanding();
+  }
+  if (configLandingPage === false) {
+    return prodLanding();
+  }
+  if (configLandingPage === void 0) {
+    return isProduction ? prodLanding() : localLanding();
+  }
+  if (isFunction(configLandingPage)) {
+    return userLanding(configLandingPage);
+  }
+  strapi2.log.warn(
+    "Your Graphql landing page has been disabled because there is a problem with your Graphql settings"
+  );
+  return prodLanding();
+};
 async function bootstrap({ strapi: strapi2 }) {
   const schema = strapi2.plugin("graphql").service("content-api").buildSchema();
   if (isEmpty(schema)) {
@@ -80,15 +135,7 @@ async function bootstrap({ strapi: strapi2 }) {
   }
   const { config: config2 } = strapi2.plugin("graphql");
   const path = config2("endpoint");
-  const playgroundEnabled = !(process.env.NODE_ENV === "production" && !config2("playgroundAlways"));
-  let landingPage;
-  if (playgroundEnabled) {
-    landingPage = ApolloServerPluginLandingPageLocalDefault();
-    strapi2.log.debug("Using Apollo sandbox landing page");
-  } else {
-    landingPage = ApolloServerPluginLandingPageProductionDefault();
-    strapi2.log.debug("Using Apollo production landing page");
-  }
+  const landingPage = determineLandingPage(strapi2);
   const defaultServerConfig = {
     // Schema
     schema,
@@ -137,7 +184,7 @@ async function bootstrap({ strapi: strapi2 }) {
       }
     };
     const isPlaygroundRequest = ctx.request.method === "GET" && ctx.request.url === path && // Matches the GraphQL endpoint
-    playgroundEnabled && // Only allow if the Playground is enabled
+    strapi2.plugin("graphql").service("utils").playground.isEnabled() && // Only allow if the Playground is enabled
     ctx.request.header.accept?.includes("text/html");
     if (isPlaygroundRequest) {
       return next();
@@ -1000,14 +1047,18 @@ const naming = ({ strapi: strapi2 }) => {
   };
 };
 const playground = (ctx) => {
+  let enabled = false;
   return {
+    setEnabled(val) {
+      enabled = val;
+    },
     isEnabled() {
-      return !(process.env.NODE_ENV === "production" && !ctx.strapi.plugin("graphql").config("playgroundAlways"));
+      return enabled;
     }
   };
 };
 const utils$1 = (context) => ({
-  playground: playground(context),
+  playground: playground(),
   naming: naming(context),
   attributes: attributes(context),
   mappers: mappers(context)

package/dist/server/src/bootstrap.d.ts

@@ -1,4 +1,6 @@
+import { type ApolloServerPlugin } from '@apollo/server';
 import type { Core } from '@strapi/types';
+export declare const determineLandingPage: (strapi: Core.Strapi) => ApolloServerPlugin<import("@apollo/server").BaseContext>;
 export declare function bootstrap({ strapi }: {
     strapi: Core.Strapi;
 }): Promise<void>;

package/dist/server/src/bootstrap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bootstrap.d.ts","sourceRoot":"","sources":["../../../server/src/bootstrap.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAW1C,wBAAsB,SAAS,CAAC,EAAE,MAAM,EAAE,EAAE;IAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAA;CAAE,iBA6IlE"}
+{"version":3,"file":"bootstrap.d.ts","sourceRoot":"","sources":["../../../server/src/bootstrap.ts"],"names":[],"mappings":"AACA,OAAO,EAAgB,KAAK,kBAAkB,EAA4B,MAAM,gBAAgB,CAAC;AAUjG,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAW1C,eAAO,MAAM,oBAAoB,WAAY,KAAK,MAAM,6DA8EvD,CAAC;AAEF,wBAAsB,SAAS,CAAC,EAAE,MAAM,EAAE,EAAE;IAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAA;CAAE,iBAmIlE"}

package/dist/server/src/index.d.ts

@@ -229,6 +229,7 @@ declare const _default: {
         };
         utils: (context: import("./services/types").Context) => {
             playground: {
+                setEnabled(val: boolean): void;
                 isEnabled(): boolean;
             };
             naming: {

package/dist/server/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../server/src/index.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGxC,wBAIE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../server/src/index.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGxC,wBAIE"}

package/dist/server/src/services/index.d.ts

@@ -216,6 +216,7 @@ export declare const services: {
     };
     utils: (context: import("./types").Context) => {
         playground: {
+            setEnabled(val: boolean): void;
             isEnabled(): boolean;
         };
         naming: {

package/dist/server/src/services/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../server/src/services/index.ts"],"names":[],"mappings":";AASA,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CASpB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../server/src/services/index.ts"],"names":[],"mappings":";AASA,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CASpB,CAAC"}

package/dist/server/src/services/utils/index.d.ts

@@ -1,6 +1,7 @@
 import type { Context } from '../types';
 declare const _default: (context: Context) => {
     playground: {
+        setEnabled(val: boolean): void;
         isEnabled(): boolean;
     };
     naming: {

package/dist/server/src/services/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../server/src/services/utils/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;kCAEf,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAhC,wBAKG"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../server/src/services/utils/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;kCAEf,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAhC,wBAKG"}

package/dist/server/src/services/utils/playground.d.ts

@@ -1,5 +1,6 @@
 import { Context } from '../types';
 declare const _default: (ctx: Context) => {
+    setEnabled(val: boolean): void;
     isEnabled(): boolean;
 };
 export default _default;

package/dist/server/src/services/utils/playground.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"playground.d.ts","sourceRoot":"","sources":["../../../../../server/src/services/utils/playground.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;8BAEd,OAAO;;;AAA5B,wBASE"}
+{"version":3,"file":"playground.d.ts","sourceRoot":"","sources":["../../../../../server/src/services/utils/playground.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;8BAKd,OAAO;oBAIR,OAAO;;;AAJ3B,wBAWE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/plugin-graphql",
-  "version": "5.7.0",
+  "version": "5.8.0",
   "description": "Adds GraphQL endpoint with default API methods.",
   "repository": {
     "type": "git",
@@ -55,7 +55,7 @@
     "@koa/cors": "5.0.0",
     "@strapi/design-system": "2.0.0-rc.14",
     "@strapi/icons": "2.0.0-rc.14",
-    "@strapi/utils": "5.7.0",
+    "@strapi/utils": "5.8.0",
     "graphql": "^16.8.1",
     "graphql-depth-limit": "^1.1.0",
     "graphql-playground-middleware-koa": "^1.6.21",
@@ -68,19 +68,19 @@
   },
   "devDependencies": {
     "@strapi/sdk-plugin": "^5.2.0",
-    "@strapi/strapi": "5.7.0",
-    "@strapi/types": "5.7.0",
+    "@strapi/strapi": "5.8.0",
+    "@strapi/types": "5.8.0",
     "@types/graphql-depth-limit": "1.1.5",
     "@types/koa-bodyparser": "4.3.12",
     "@types/koa__cors": "5.0.0",
     "cross-env": "^7.0.3",
-    "eslint-config-custom": "5.7.0",
+    "eslint-config-custom": "5.8.0",
     "koa": "2.15.2",
     "react": "18.3.1",
     "react-dom": "18.3.1",
     "react-router-dom": "6.22.3",
     "styled-components": "6.1.8",
-    "tsconfig": "5.7.0",
+    "tsconfig": "5.8.0",
     "typescript": "5.3.2"
   },
   "peerDependencies": {