feat(api-headless-cms): add getExecutableSchema utility

webiny · Apr 25, 2024 · a7220b5 · a7220b5
1 parent cf397c5
commit a7220b5
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 5 deletions.
diff --git a/packages/api-headless-cms/__tests__/contentAPI/aco/setup/updateLocationGraphQlPlugin.ts b/packages/api-headless-cms/__tests__/contentAPI/aco/setup/updateLocationGraphQlPlugin.ts
@@ -1,9 +1,10 @@
 import { ErrorResponse, Response } from "@webiny/handler-graphql";
-import { CmsGraphQLSchemaPlugin } from "~/index";
+import { createCmsGraphQLSchemaPlugin } from "~/index";
 import { ACO_TEST_MODEL_ID } from "./model";
+import { CmsContext } from "~/types";
 
 const createUpdateLocationGraphQlPlugin = () => {
-    const plugin = new CmsGraphQLSchemaPlugin({
+    const plugin = createCmsGraphQLSchemaPlugin<CmsContext>({
         typeDefs: /* GraphQL */ `
             type UpdateTestAcoModelLocationResponse {
                 data: TestAcoModel

diff --git a/packages/api-headless-cms/src/context.ts b/packages/api-headless-cms/src/context.ts
@@ -1,6 +1,8 @@
-import { CmsContext, HeadlessCmsStorageOperations } from "~/types";
+import { ApiEndpoint, CmsContext, HeadlessCmsStorageOperations } from "~/types";
 import WebinyError from "@webiny/error";
 import { ContextPlugin } from "@webiny/api";
+import { GraphQLRequestBody } from "@webiny/handler-graphql/types";
+import { processRequestBody } from "@webiny/handler-graphql";
 import { CmsParametersPlugin, CmsParametersPluginResponse } from "~/plugins/CmsParametersPlugin";
 import { AccessControl } from "~/crud/AccessControl/AccessControl";
 import { createSystemCrud } from "~/crud/system.crud";
@@ -11,6 +13,7 @@ import { StorageOperationsCmsModelPlugin } from "~/plugins";
 import { createCmsModelFieldConvertersAttachFactory } from "~/utils/converters/valueKeyStorageConverter";
 import { createExportCrud } from "~/export";
 import { createImportCrud } from "~/export/crud/importing";
+import { getSchema } from "~/graphql/getSchema";
 
 const getParameters = async (context: CmsContext): Promise<CmsParametersPluginResponse> => {
     const plugins = context.plugins.byType<CmsParametersPlugin>(CmsParametersPlugin.type);
@@ -58,6 +61,45 @@ export const createContextPlugin = ({ storageOperations }: CrudParams) => {
             return context.tenancy.getCurrentTenant();
         };
 
+        const setSchemaType = (type: ApiEndpoint | null) => {
+            if (!type) {
+                return;
+            }
+
+            context.cms.type = type;
+
+            switch (type) {
+                case "read":
+                    context.cms.READ = true;
+                    break;
+                case "preview":
+                    context.cms.PREVIEW = true;
+                    break;
+                default:
+                    context.cms.MANAGE = true;
+            }
+        };
+
+        async function getExecutableSchema(type: ApiEndpoint) {
+            const originalType = context.cms.type;
+            setSchemaType(type);
+
+            const schema = await context.security.withoutAuthorization(() => {
+                return getSchema({
+                    context,
+                    getTenant,
+                    getLocale,
+                    type
+                });
+            });
+
+            setSchemaType(originalType);
+
+            return async <TData, TExtensions>(input: GraphQLRequestBody | GraphQLRequestBody[]) => {
+                return processRequestBody<TData, TExtensions>(input, schema, context);
+            };
+        }
+
         context.plugins.register(
             new StorageOperationsCmsModelPlugin(
                 createCmsModelFieldConvertersAttachFactory(context.plugins)
@@ -89,6 +131,7 @@ export const createContextPlugin = ({ storageOperations }: CrudParams) => {
                 MANAGE: type === "manage",
                 storageOperations,
                 accessControl,
+                getExecutableSchema,
                 ...createSystemCrud({
                     context,
                     getTenant,

diff --git a/packages/api-headless-cms/src/plugins/CmsGraphQLSchemaPlugin.ts b/packages/api-headless-cms/src/plugins/CmsGraphQLSchemaPlugin.ts
@@ -1,6 +1,13 @@
-import { GraphQLSchemaPlugin } from "@webiny/handler-graphql";
+import { GraphQLSchemaPlugin, GraphQLSchemaPluginConfig } from "@webiny/handler-graphql";
+import { Context } from "@webiny/api/types";
 import { CmsContext } from "~/types";
 
 export class CmsGraphQLSchemaPlugin<T = CmsContext> extends GraphQLSchemaPlugin<T> {
     public static override type = "cms.graphql.schema";
 }
+
+export const createCmsGraphQLSchemaPlugin = <TContext = Context>(
+    params: GraphQLSchemaPluginConfig<TContext>
+) => {
+    return new CmsGraphQLSchemaPlugin<TContext>(params);
+};
diff --git a/packages/api-headless-cms/src/types/types.ts b/packages/api-headless-cms/src/types/types.ts
@@ -1,7 +1,8 @@
 import { Plugin } from "@webiny/plugins/types";
 import { I18NContext, I18NLocale } from "@webiny/api-i18n/types";
 import { Context } from "@webiny/api/types";
-import { GraphQLFieldResolver, Resolvers } from "@webiny/handler-graphql/types";
+import { GraphQLFieldResolver, GraphQLRequestBody, Resolvers } from "@webiny/handler-graphql/types";
+import { processRequestBody } from "@webiny/handler-graphql";
 import { SecurityPermission } from "@webiny/api-security/types";
 import { DbContext } from "@webiny/handler-db/types";
 import { Topic } from "@webiny/pubsub/types";
@@ -62,8 +63,17 @@ export interface HeadlessCms
      */
     export: HeadlessCmsExport;
     importing: HeadlessCmsImport;
+    getExecutableSchema: GetExecutableSchema;
 }
 
+export type GetExecutableSchema = (
+    type: ApiEndpoint
+) => Promise<
+    <TData = Record<string, any>, TExtensions = Record<string, any>>(
+        input: GraphQLRequestBody | GraphQLRequestBody[]
+    ) => ReturnType<typeof processRequestBody<TData, TExtensions>>
+>;
+
 /**
  * @description This combines all contexts used in the CMS into a single one.
  *