@webiny/api-headless-cms 0.0.0-unstable.085ff6572f → 0.0.0-unstable.0d717d18dd

package/HeadlessCmsContextualSchema.d.ts

@@ -0,0 +1,16 @@
+import type { IGraphQLContextualSchema } from "@webiny/api-graphql";
+import { TenantContext } from "@webiny/api-core/features/tenancy/TenantContext/abstractions.js";
+import { IdentityContext } from "@webiny/api-core/features/security/IdentityContext/abstractions.js";
+import type { IHeadlessCmsEndpointConfig } from "./HeadlessCmsEndpointConfig.js";
+import type { GraphQLSchema } from "graphql";
+declare class HeadlessCmsContextualSchemaImpl implements IGraphQLContextualSchema {
+    private tenantContext;
+    private identityContext;
+    private config;
+    constructor(tenantContext: TenantContext.Interface, identityContext: IdentityContext.Interface, config: IHeadlessCmsEndpointConfig);
+    build(ctx: Record<string, any>): Promise<GraphQLSchema>;
+}
+export declare const HeadlessCmsContextualSchema: typeof HeadlessCmsContextualSchemaImpl & {
+    __abstraction: import("@webiny/di").Abstraction<IGraphQLContextualSchema>;
+};
+export {};

package/HeadlessCmsContextualSchema.js

@@ -0,0 +1,32 @@
+import { GraphQLContextualSchema } from "@webiny/api-graphql";
+import { TenantContext } from "@webiny/api-core/features/tenancy/TenantContext/abstractions.js";
+import { IdentityContext } from "@webiny/api-core/features/security/IdentityContext/abstractions.js";
+import { getSchema } from "./graphql/getSchema.js";
+import { HeadlessCmsEndpointConfig } from "./HeadlessCmsEndpointConfig.js";
+class HeadlessCmsContextualSchemaImpl {
+    constructor(tenantContext, identityContext, config){
+        this.tenantContext = tenantContext;
+        this.identityContext = identityContext;
+        this.config = config;
+    }
+    async build(ctx) {
+        const cmsCtx = ctx;
+        const getTenant = ()=>this.tenantContext.getTenant();
+        return this.identityContext.withoutAuthorization(()=>getSchema({
+                context: cmsCtx,
+                getTenant,
+                type: this.config.type
+            }));
+    }
+}
+const HeadlessCmsContextualSchema = GraphQLContextualSchema.createImplementation({
+    implementation: HeadlessCmsContextualSchemaImpl,
+    dependencies: [
+        TenantContext,
+        IdentityContext,
+        HeadlessCmsEndpointConfig
+    ]
+});
+export { HeadlessCmsContextualSchema };
+
+//# sourceMappingURL=HeadlessCmsContextualSchema.js.map

package/HeadlessCmsContextualSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HeadlessCmsContextualSchema.js","sources":["../src/HeadlessCmsContextualSchema.ts"],"sourcesContent":["import { GraphQLContextualSchema } from \"@webiny/api-graphql\";\nimport type { IGraphQLContextualSchema } from \"@webiny/api-graphql\";\nimport { TenantContext } from \"@webiny/api-core/features/tenancy/TenantContext/abstractions.js\";\nimport { IdentityContext } from \"@webiny/api-core/features/security/IdentityContext/abstractions.js\";\nimport { getSchema } from \"~/graphql/getSchema.js\";\nimport { HeadlessCmsEndpointConfig } from \"~/HeadlessCmsEndpointConfig.js\";\nimport type { IHeadlessCmsEndpointConfig } from \"~/HeadlessCmsEndpointConfig.js\";\nimport type { CmsContext } from \"~/types/index.js\";\nimport type { GraphQLSchema } from \"graphql\";\n\nclass HeadlessCmsContextualSchemaImpl implements IGraphQLContextualSchema {\n    constructor(\n        private tenantContext: TenantContext.Interface,\n        private identityContext: IdentityContext.Interface,\n        private config: IHeadlessCmsEndpointConfig\n    ) {}\n\n    async build(ctx: Record<string, any>): Promise<GraphQLSchema> {\n        const cmsCtx = ctx as CmsContext;\n        const getTenant = () => this.tenantContext.getTenant();\n\n        return this.identityContext.withoutAuthorization(() => {\n            return getSchema({ context: cmsCtx, getTenant, type: this.config.type });\n        });\n    }\n}\n\nexport const HeadlessCmsContextualSchema = GraphQLContextualSchema.createImplementation({\n    implementation: HeadlessCmsContextualSchemaImpl,\n    dependencies: [TenantContext, IdentityContext, HeadlessCmsEndpointConfig]\n});\n"],"names":["HeadlessCmsContextualSchemaImpl","tenantContext","identityContext","config","ctx","cmsCtx","getTenant","getSchema","HeadlessCmsContextualSchema","GraphQLContextualSchema","TenantContext","IdentityContext","HeadlessCmsEndpointConfig"],"mappings":";;;;;AAUA,MAAMA;IACF,YACYC,aAAsC,EACtCC,eAA0C,EAC1CC,MAAkC,CAC5C;aAHUF,aAAa,GAAbA;aACAC,eAAe,GAAfA;aACAC,MAAM,GAANA;IACT;IAEH,MAAM,MAAMC,GAAwB,EAA0B;QAC1D,MAAMC,SAASD;QACf,MAAME,YAAY,IAAM,IAAI,CAAC,aAAa,CAAC,SAAS;QAEpD,OAAO,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAAC,IACtCC,UAAU;gBAAE,SAASF;gBAAQC;gBAAW,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI;YAAC;IAE9E;AACJ;AAEO,MAAME,8BAA8BC,wBAAwB,oBAAoB,CAAC;IACpF,gBAAgBT;IAChB,cAAc;QAACU;QAAeC;QAAiBC;KAA0B;AAC7E"}

package/HeadlessCmsEndpointConfig.d.ts

@@ -0,0 +1,10 @@
+import { Abstraction } from "@webiny/di";
+import type { ApiEndpoint } from "./types/index.js";
+/**
+ * The CMS endpoint type ("manage" | "read" | "preview") for the current handler, set in
+ * HeadlessCmsFeature.register() and read by the schema builders / contextual schema.
+ */
+export interface IHeadlessCmsEndpointConfig {
+    type: ApiEndpoint;
+}
+export declare const HeadlessCmsEndpointConfig: Abstraction<IHeadlessCmsEndpointConfig>;

package/HeadlessCmsEndpointConfig.js

@@ -0,0 +1,5 @@
+import { Abstraction } from "@webiny/di";
+const HeadlessCmsEndpointConfig = new Abstraction("HeadlessCmsEndpointConfig");
+export { HeadlessCmsEndpointConfig };
+
+//# sourceMappingURL=HeadlessCmsEndpointConfig.js.map

package/HeadlessCmsEndpointConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HeadlessCmsEndpointConfig.js","sources":["../src/HeadlessCmsEndpointConfig.ts"],"sourcesContent":["import { Abstraction } from \"@webiny/di\";\nimport type { ApiEndpoint } from \"~/types/index.js\";\n\n/**\n * The CMS endpoint type (\"manage\" | \"read\" | \"preview\") for the current handler, set in\n * HeadlessCmsFeature.register() and read by the schema builders / contextual schema.\n */\nexport interface IHeadlessCmsEndpointConfig {\n    type: ApiEndpoint;\n}\n\nexport const HeadlessCmsEndpointConfig = new Abstraction<IHeadlessCmsEndpointConfig>(\n    \"HeadlessCmsEndpointConfig\"\n);\n"],"names":["HeadlessCmsEndpointConfig","Abstraction"],"mappings":";AAWO,MAAMA,4BAA4B,IAAIC,YACzC"}

package/HeadlessCmsFeature.d.ts

@@ -0,0 +1,10 @@
+import type { ApiEndpoint } from "./types/index.js";
+export interface HeadlessCmsConfig {
+    type: ApiEndpoint;
+    /** Extra plugins (e.g. CmsGraphQLSchemaPlugin) to register in ctx.plugins at runtime. */
+    extraPlugins?: any[];
+}
+export declare const HeadlessCmsFeature: {
+    name: string;
+    register(container: import("@webiny/di").Container, context: HeadlessCmsConfig): void;
+};

package/HeadlessCmsFeature.js

@@ -0,0 +1,193 @@
+import { createFeature } from "@webiny/feature/api";
+import { IdentityContext } from "@webiny/api-core/features/security/IdentityContext/abstractions.js";
+import { TenantContext } from "@webiny/api-core/features/tenancy/TenantContext/abstractions.js";
+import { HeadlessCmsEndpointConfig } from "./HeadlessCmsEndpointConfig.js";
+import { createCmsRoute } from "./createCmsRoute.js";
+import { createRequestBody, processRequestBody } from "@webiny/api-graphql";
+import { BenchmarkAbstraction } from "@webiny/api";
+import { Benchmark } from "@webiny/api/Benchmark.js";
+import { PluginsContainer } from "@webiny/plugins";
+import { CompressionFeature } from "@webiny/utils/features/compression/feature.js";
+import { GraphQLFeature } from "./features/graphql/index.js";
+import { ValidationFeature } from "./features/validation/index.js";
+import { StorageFeature } from "./features/storage/index.js";
+import { CmsInstallerFeature } from "./features/installer/feature.js";
+import { ContentEntriesFeature } from "./features/contentEntry/ContentEntriesFeature.js";
+import { ContentModelFeature } from "./features/contentModel/ContentModelFeature.js";
+import { ContentModelGroupFeature } from "./features/contentModelGroup/ContentModelGroupFeature.js";
+import { ModelBuilderFeature } from "./features/modelBuilder/index.js";
+import { CmsWhereMapperFeature } from "./features/whereMapper/feature.js";
+import { CmsSortMapperFeature } from "./features/sortMapper/feature.js";
+import { CmsWebhooksFeature } from "./features/webhooks/feature.js";
+import { CmsBaseErrorTypeFactory } from "./graphql/schema/cms/CmsBaseErrorTypeFactory.js";
+import { CmsSchemaExecutor } from "./graphql/CmsSchemaExecutor.js";
+import { CmsMutationTypeDefsImpl, CmsQueryTypeDefsImpl, CmsResponseTypeDefsImpl } from "./graphql/schema/cms/typeDefs/index.js";
+import { CreateEntryResolverImpl, DeleteEntryRevisionResolverImpl, GetEntryResolverImpl, GetModelResolverImpl, ListEntriesResolverImpl, MutationCmsResolverImpl, PublishEntryRevisionResolverImpl, QueryCmsResolverImpl, UnpublishEntryRevisionResolverImpl, UpdateEntryRevisionResolverImpl } from "./graphql/schema/cms/resolvers/index.js";
+import { AccessControl } from "./crud/AccessControl/AccessControl.js";
+import { createModelGroupsCrud } from "./crud/contentModelGroup.crud.js";
+import { createModelsCrud } from "./crud/contentModel.crud.js";
+import { createContentEntryCrud } from "./crud/contentEntry.crud.js";
+import { CmsGraphQLSchemaPlugin, CmsGroupPlugin, CmsModelPlugin, StorageOperationsCmsModelPlugin } from "./plugins/index.js";
+import { createCmsModelFieldConvertersAttachFactory } from "./utils/converters/valueKeyStorageConverter.js";
+import { registerFieldConverters } from "./fieldConverters/abstractions.js";
+import { CmsModelPluginInstance } from "./features/contentModel/shared/abstractions.js";
+import { CmsGroupPluginInstance } from "./features/contentModelGroup/shared/abstractions.js";
+import { createExportCrud } from "./export/index.js";
+import { createImportCrud } from "./export/crud/importing.js";
+import { getSchema } from "./graphql/getSchema.js";
+import { createBaseSchemaPlugins } from "./graphql/schema/baseSchema.js";
+import { exportPlugin } from "./export/graphql/index.js";
+import { CoreGraphQLSchemaFactory } from "@webiny/api-graphql/graphql/abstractions.js";
+import { CmsGraphQLSchemaFactory } from "./graphql/CmsGraphQLSchemaFactory.js";
+import { CmsExport, CmsImport } from "./export/abstractions.js";
+import { ListGroupsUseCase } from "./features/contentModelGroup/ListGroups/index.js";
+import { RevisionIdScalar } from "./graphql/scalars/RevisionId.js";
+import { AccessControl as abstractions_js_AccessControl, CmsContext, CmsStorageModelProvider, HeadlessCms } from "./features/shared/abstractions.js";
+import { EntryFromStorageTransform, EntryToStorageTransform, PluginsContainer as abstractions_js_PluginsContainer, SearchableFieldsProvider } from "./legacy/abstractions.js";
+import { entryFromStorageTransform, entryToStorageTransform } from "./utils/entryStorage.js";
+import { getSearchableFields } from "./crud/contentEntry/searchableFields.js";
+const HeadlessCmsFeature = createFeature({
+    name: "HeadlessCms",
+    register (container, config) {
+        const { type } = config;
+        container.register(CmsBaseErrorTypeFactory);
+        container.register(CmsResponseTypeDefsImpl);
+        container.register(CmsQueryTypeDefsImpl);
+        container.register(CmsMutationTypeDefsImpl);
+        container.register(QueryCmsResolverImpl);
+        container.register(MutationCmsResolverImpl);
+        container.register(GetModelResolverImpl);
+        container.register(GetEntryResolverImpl);
+        container.register(ListEntriesResolverImpl);
+        container.register(CreateEntryResolverImpl);
+        container.register(UpdateEntryRevisionResolverImpl);
+        container.register(DeleteEntryRevisionResolverImpl);
+        container.register(PublishEntryRevisionResolverImpl);
+        container.register(UnpublishEntryRevisionResolverImpl);
+        container.registerInstance(HeadlessCmsEndpointConfig, {
+            type: config.type
+        });
+        CompressionFeature.register(container);
+        GraphQLFeature.register(container);
+        ValidationFeature.register(container);
+        StorageFeature.register(container);
+        CmsInstallerFeature.register(container);
+        ContentEntriesFeature.register(container);
+        ContentModelFeature.register(container);
+        ContentModelGroupFeature.register(container);
+        ModelBuilderFeature.register(container);
+        CmsWhereMapperFeature.register(container);
+        CmsSortMapperFeature.register(container);
+        CmsWebhooksFeature.register(container);
+        registerFieldConverters(container);
+        const pluginsContainer = new PluginsContainer([
+            ...config.extraPlugins ?? []
+        ]);
+        container.registerInstance(abstractions_js_PluginsContainer, pluginsContainer);
+        for (const plugin of pluginsContainer.byType(CmsModelPlugin.type))container.registerInstance(CmsModelPluginInstance, plugin);
+        for (const plugin of pluginsContainer.byType(CmsGroupPlugin.type))container.registerInstance(CmsGroupPluginInstance, plugin);
+        const userSchemaPlugins = pluginsContainer.byType(CmsGraphQLSchemaPlugin.type);
+        if (userSchemaPlugins.length > 0) container.registerInstance(CmsGraphQLSchemaFactory, {
+            execute: ()=>userSchemaPlugins
+        });
+        for (const plugin of config.extraPlugins ?? [])if (plugin && "function" == typeof plugin.apply) plugin.apply({
+            container
+        });
+        const benchmark = new Benchmark();
+        container.registerInstance(BenchmarkAbstraction, benchmark);
+        const cmsContext = {
+            container,
+            plugins: pluginsContainer,
+            benchmark
+        };
+        container.registerInstance(CmsContext, cmsContext);
+        container.registerInstance(CoreGraphQLSchemaFactory, {
+            execute: async (builder)=>{
+                builder.addTypeDefs("scalar RevisionId");
+                builder.addLegacyResolvers({
+                    RevisionId: RevisionIdScalar
+                });
+                return builder;
+            }
+        });
+        container.registerInstance(CmsStorageModelProvider, new StorageOperationsCmsModelPlugin(createCmsModelFieldConvertersAttachFactory(cmsContext)));
+        const identityContext = container.resolve(IdentityContext);
+        const tenantContext = container.resolve(TenantContext);
+        const getTenant = ()=>tenantContext.getTenant();
+        let accessControlInstance;
+        const getAccessControl = ()=>{
+            if (!accessControlInstance) accessControlInstance = new AccessControl({
+                getIdentity: async ()=>identityContext.getIdentity(),
+                getGroupsPermissions: ()=>identityContext.getPermissions("cms.contentModelGroup"),
+                getModelsPermissions: ()=>identityContext.getPermissions("cms.contentModel"),
+                getEntriesPermissions: ()=>identityContext.getPermissions("cms.contentEntry"),
+                listAllGroups: async ()=>{
+                    const result = await identityContext.withoutAuthorization(()=>container.resolve(ListGroupsUseCase).execute());
+                    if (result.isFail()) throw result.error;
+                    return result.value;
+                }
+            });
+            return accessControlInstance;
+        };
+        container.registerFactory(abstractions_js_AccessControl, ()=>getAccessControl());
+        let cmsFacade;
+        container.registerFactory(HeadlessCms, ()=>{
+            if (!cmsFacade) cmsFacade = {
+                type,
+                READ: "read" === type,
+                PREVIEW: "preview" === type,
+                MANAGE: "manage" === type,
+                accessControl: getAccessControl(),
+                ...createModelGroupsCrud({
+                    context: cmsContext
+                }),
+                ...createModelsCrud({
+                    context: cmsContext
+                }),
+                ...createContentEntryCrud({
+                    context: cmsContext
+                }),
+                export: {
+                    ...createExportCrud(cmsContext)
+                },
+                importing: {
+                    ...createImportCrud(cmsContext)
+                }
+            };
+            return cmsFacade;
+        });
+        container.registerFactory(CmsExport, ()=>container.resolve(HeadlessCms).export);
+        container.registerFactory(CmsImport, ()=>container.resolve(HeadlessCms).importing);
+        container.registerInstance(CmsSchemaExecutor, {
+            execute: async (schemaType, body)=>{
+                const bm = container.resolve(BenchmarkAbstraction);
+                const schema = await bm.measure("headlessCms.graphql.getSchema", ()=>identityContext.withoutAuthorization(()=>getSchema({
+                            context: cmsContext,
+                            getTenant,
+                            type: schemaType
+                        })));
+                const requestBody = await bm.measure("headlessCms.graphql.createRequestBody", async ()=>createRequestBody(body));
+                return bm.measure("headlessCms.graphql.processRequestBody", ()=>processRequestBody(requestBody, schema, cmsContext));
+            }
+        });
+        container.registerInstance(CmsGraphQLSchemaFactory, {
+            execute: ()=>createBaseSchemaPlugins(cmsContext)
+        });
+        if ("manage" === type) container.registerInstance(CmsGraphQLSchemaFactory, {
+            execute: ()=>[
+                    exportPlugin
+                ]
+        });
+        container.registerInstance(EntryToStorageTransform, (model, entry)=>entryToStorageTransform(cmsContext, model, entry));
+        container.registerInstance(EntryFromStorageTransform, (model, entry)=>entryFromStorageTransform(cmsContext, model, entry));
+        container.registerInstance(SearchableFieldsProvider, (params)=>getSearchableFields({
+                context: cmsContext,
+                fields: params.fields,
+                input: []
+            }));
+        container.register(createCmsRoute(config.type));
+    }
+});
+export { HeadlessCmsFeature };
+
+//# sourceMappingURL=HeadlessCmsFeature.js.map

package/HeadlessCmsFeature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HeadlessCmsFeature.js","sources":["../src/HeadlessCmsFeature.ts"],"sourcesContent":["import { createFeature } from \"@webiny/feature/api\";\nimport { IdentityContext } from \"@webiny/api-core/features/security/IdentityContext/abstractions.js\";\nimport { TenantContext } from \"@webiny/api-core/features/tenancy/TenantContext/abstractions.js\";\nimport { HeadlessCmsEndpointConfig } from \"./HeadlessCmsEndpointConfig.js\";\nimport { createCmsRoute } from \"./createCmsRoute.js\";\nimport { createRequestBody, processRequestBody } from \"@webiny/api-graphql\";\nimport { BenchmarkAbstraction } from \"@webiny/api\";\nimport { Benchmark } from \"@webiny/api/Benchmark.js\";\nimport { PluginsContainer } from \"@webiny/plugins\";\nimport { CompressionFeature } from \"@webiny/utils/features/compression/feature.js\";\nimport { GraphQLFeature } from \"~/features/graphql/index.js\";\nimport { ValidationFeature } from \"~/features/validation/index.js\";\nimport { StorageFeature } from \"~/features/storage/index.js\";\nimport { CmsInstallerFeature } from \"~/features/installer/feature.js\";\nimport { ContentEntriesFeature } from \"~/features/contentEntry/ContentEntriesFeature.js\";\nimport { ContentModelFeature } from \"~/features/contentModel/ContentModelFeature.js\";\nimport { ContentModelGroupFeature } from \"~/features/contentModelGroup/ContentModelGroupFeature.js\";\nimport { ModelBuilderFeature } from \"~/features/modelBuilder/index.js\";\nimport { CmsWhereMapperFeature } from \"~/features/whereMapper/feature.js\";\nimport { CmsSortMapperFeature } from \"~/features/sortMapper/feature.js\";\nimport { CmsWebhooksFeature } from \"~/features/webhooks/feature.js\";\nimport type { ApiEndpoint, CmsContext } from \"~/types/index.js\";\nimport { CmsBaseErrorTypeFactory } from \"~/graphql/schema/cms/CmsBaseErrorTypeFactory.js\";\nimport { CmsSchemaExecutor } from \"~/graphql/CmsSchemaExecutor.js\";\nimport {\n    CmsResponseTypeDefsImpl,\n    CmsQueryTypeDefsImpl,\n    CmsMutationTypeDefsImpl\n} from \"~/graphql/schema/cms/typeDefs/index.js\";\nimport {\n    QueryCmsResolverImpl,\n    MutationCmsResolverImpl,\n    GetModelResolverImpl,\n    GetEntryResolverImpl,\n    ListEntriesResolverImpl,\n    CreateEntryResolverImpl,\n    UpdateEntryRevisionResolverImpl,\n    DeleteEntryRevisionResolverImpl,\n    PublishEntryRevisionResolverImpl,\n    UnpublishEntryRevisionResolverImpl\n} from \"~/graphql/schema/cms/resolvers/index.js\";\n// Facade wiring (moved here from HeadlessCmsInitializer so the facade can be a lazy DI factory).\nimport { AccessControl } from \"~/crud/AccessControl/AccessControl.js\";\nimport { createModelGroupsCrud } from \"~/crud/contentModelGroup.crud.js\";\nimport { createModelsCrud } from \"~/crud/contentModel.crud.js\";\nimport { createContentEntryCrud } from \"~/crud/contentEntry.crud.js\";\nimport type { ICmsGraphQLSchemaPlugin } from \"~/plugins/index.js\";\nimport {\n    CmsGraphQLSchemaPlugin,\n    CmsGroupPlugin,\n    CmsModelPlugin,\n    StorageOperationsCmsModelPlugin\n} from \"~/plugins/index.js\";\nimport { createCmsModelFieldConvertersAttachFactory } from \"~/utils/converters/valueKeyStorageConverter.js\";\nimport { registerFieldConverters } from \"~/fieldConverters/abstractions.js\";\nimport { CmsModelPluginInstance } from \"~/features/contentModel/shared/abstractions.js\";\nimport { CmsGroupPluginInstance } from \"~/features/contentModelGroup/shared/abstractions.js\";\nimport { createExportCrud } from \"~/export/index.js\";\nimport { createImportCrud } from \"~/export/crud/importing.js\";\nimport { getSchema } from \"~/graphql/getSchema.js\";\nimport { createBaseSchemaPlugins } from \"~/graphql/schema/baseSchema.js\";\nimport { exportPlugin } from \"~/export/graphql/index.js\";\nimport { CoreGraphQLSchemaFactory } from \"@webiny/api-graphql/graphql/abstractions.js\";\nimport { CmsGraphQLSchemaFactory } from \"~/graphql/CmsGraphQLSchemaFactory.js\";\nimport { CmsExport, CmsImport } from \"~/export/abstractions.js\";\nimport { ListGroupsUseCase } from \"~/features/contentModelGroup/ListGroups/index.js\";\nimport { RevisionIdScalar } from \"~/graphql/scalars/RevisionId.js\";\nimport {\n    AccessControl as AccessControlAbstraction,\n    CmsContext as CmsContextAbstraction,\n    CmsStorageModelProvider,\n    HeadlessCms\n} from \"~/features/shared/abstractions.js\";\n\nimport {\n    EntryFromStorageTransform,\n    EntryToStorageTransform,\n    PluginsContainer as PluginsContainerAbstraction,\n    SearchableFieldsProvider\n} from \"~/legacy/abstractions.js\";\nimport { entryFromStorageTransform, entryToStorageTransform } from \"~/utils/entryStorage.js\";\nimport { getSearchableFields } from \"~/crud/contentEntry/searchableFields.js\";\nexport interface HeadlessCmsConfig {\n    type: ApiEndpoint;\n    /** Extra plugins (e.g. CmsGraphQLSchemaPlugin) to register in ctx.plugins at runtime. */\n    extraPlugins?: any[];\n}\n\nexport const HeadlessCmsFeature = createFeature<HeadlessCmsConfig>({\n    name: \"HeadlessCms\",\n    register(container, config) {\n        const { type } = config;\n\n        // Pre-register the CMS SDK namespace schema (Query.cms / Mutation.cms) so it is\n        // available when GraphQLSchemaComposer is constructed (before context enhancement).\n        // All these implementations have zero DI dependencies and are safe to register early.\n        container.register(CmsBaseErrorTypeFactory); // CmsError must come first\n        container.register(CmsResponseTypeDefsImpl);\n        container.register(CmsQueryTypeDefsImpl);\n        container.register(CmsMutationTypeDefsImpl);\n        container.register(QueryCmsResolverImpl);\n        container.register(MutationCmsResolverImpl);\n        container.register(GetModelResolverImpl);\n        container.register(GetEntryResolverImpl);\n        container.register(ListEntriesResolverImpl);\n        container.register(CreateEntryResolverImpl);\n        container.register(UpdateEntryRevisionResolverImpl);\n        container.register(DeleteEntryRevisionResolverImpl);\n        container.register(PublishEntryRevisionResolverImpl);\n        container.register(UnpublishEntryRevisionResolverImpl);\n\n        container.registerInstance(HeadlessCmsEndpointConfig, {\n            type: config.type\n        });\n\n        // Register CMS DI features statically so they are available before any enhancers run.\n        // All these are pure class registrations (no eager instantiation) so they are safe\n        // to register here before any request-time context is available.\n        CompressionFeature.register(container);\n        GraphQLFeature.register(container);\n        ValidationFeature.register(container);\n        StorageFeature.register(container);\n        CmsInstallerFeature.register(container);\n        ContentEntriesFeature.register(container);\n        ContentModelFeature.register(container);\n        ContentModelGroupFeature.register(container);\n        ModelBuilderFeature.register(container);\n        CmsWhereMapperFeature.register(container);\n        CmsSortMapperFeature.register(container);\n        CmsWebhooksFeature.register(container);\n\n        // ============================================================================\n        // Synchronous per-request wiring (moved out of HeadlessCmsInitializer.init).\n        // register() runs per request, pre-auth — correct for pure wiring and closures.\n        // ============================================================================\n\n        // Field value converters are resolved from the DI container.\n        registerFieldConverters(container);\n\n        // PluginsContainer still carries legacy extension plugins (e.g. CmsGraphQLSchemaPlugin)\n        // until those remaining consumers are migrated to DI.\n        const pluginsContainer = new PluginsContainer([...(config.extraPlugins ?? [])]);\n        container.registerInstance(PluginsContainerAbstraction, pluginsContainer);\n\n        // Code-defined model/group plugins are exposed via DI tokens so the\n        // Plugin{Models,Groups}Provider can resolve them without the plugins container.\n        for (const plugin of pluginsContainer.byType<CmsModelPlugin>(CmsModelPlugin.type)) {\n            container.registerInstance(CmsModelPluginInstance, plugin);\n        }\n        for (const plugin of pluginsContainer.byType<CmsGroupPlugin>(CmsGroupPlugin.type)) {\n            container.registerInstance(CmsGroupPluginInstance, plugin);\n        }\n\n        // User-provided GraphQL schema extension plugins (added via extraPlugins) are bridged\n        // to the CmsGraphQLSchemaFactory DI token so generateSchema includes them.\n        const userSchemaPlugins = pluginsContainer.byType<ICmsGraphQLSchemaPlugin>(\n            CmsGraphQLSchemaPlugin.type\n        );\n        if (userSchemaPlugins.length > 0) {\n            container.registerInstance(CmsGraphQLSchemaFactory, {\n                execute: () => userSchemaPlugins\n            });\n        }\n\n        // RegisterExtensionPlugins supplied via extraPlugins (test infra) only do DI registration\n        // via their apply(). Apply them here at register() time — matching the app's registerExtensions\n        // and the storage presets above — so code-defined models are present before per-request model\n        // listing runs.\n        for (const plugin of config.extraPlugins ?? []) {\n            if (plugin && typeof (plugin as any).apply === \"function\") {\n                (plugin as any).apply({ container });\n            }\n        }\n\n        const benchmark = new Benchmark();\n        container.registerInstance(BenchmarkAbstraction, benchmark);\n\n        // The CmsContext \"shim\": the request-scoped context object the facade builders, transforms\n        // and getSchema operate on. They only read `.container` (+ plugins/benchmark), so this is\n        // all they need — there is no legacy bag.\n        const cmsContext = {\n            container,\n            plugins: pluginsContainer,\n            benchmark\n        } as unknown as CmsContext;\n        container.registerInstance(CmsContextAbstraction, cmsContext);\n\n        container.registerInstance(CoreGraphQLSchemaFactory, {\n            execute: async builder => {\n                builder.addTypeDefs(\"scalar RevisionId\");\n                builder.addLegacyResolvers({ RevisionId: RevisionIdScalar });\n                return builder;\n            }\n        });\n\n        container.registerInstance(\n            CmsStorageModelProvider,\n            new StorageOperationsCmsModelPlugin(\n                createCmsModelFieldConvertersAttachFactory(cmsContext)\n            )\n        );\n\n        // Entry storage operations are registered by each adapter's feature at app-scope.\n        // HeadlessCmsFeature no longer manages entry storage registration.\n\n        const identityContext = container.resolve(IdentityContext);\n        const tenantContext = container.resolve(TenantContext);\n        const getTenant = () => tenantContext.getTenant();\n\n        // AccessControl is identity-dependent; build it lazily and memoise per request container.\n        let accessControlInstance: AccessControl | undefined;\n        const getAccessControl = (): AccessControl => {\n            if (!accessControlInstance) {\n                accessControlInstance = new AccessControl({\n                    getIdentity: async () => identityContext.getIdentity(),\n                    getGroupsPermissions: () =>\n                        identityContext.getPermissions(\"cms.contentModelGroup\"),\n                    getModelsPermissions: () => identityContext.getPermissions(\"cms.contentModel\"),\n                    getEntriesPermissions: () => identityContext.getPermissions(\"cms.contentEntry\"),\n                    listAllGroups: async () => {\n                        const result = await identityContext.withoutAuthorization(() =>\n                            container.resolve(ListGroupsUseCase).execute()\n                        );\n                        if (result.isFail()) {\n                            throw result.error;\n                        }\n                        return result.value;\n                    }\n                });\n            }\n            return accessControlInstance;\n        };\n        container.registerFactory(AccessControlAbstraction, () => getAccessControl());\n\n        // The HeadlessCms facade — a LAZY factory built on first resolve (post-auth), memoised per\n        // request container.\n        let cmsFacade: HeadlessCms.Interface | undefined;\n        container.registerFactory(HeadlessCms, () => {\n            if (!cmsFacade) {\n                cmsFacade = {\n                    type,\n                    READ: type === \"read\",\n                    PREVIEW: type === \"preview\",\n                    MANAGE: type === \"manage\",\n                    accessControl: getAccessControl(),\n                    ...createModelGroupsCrud({ context: cmsContext }),\n                    ...createModelsCrud({ context: cmsContext }),\n                    ...createContentEntryCrud({ context: cmsContext }),\n                    export: { ...createExportCrud(cmsContext) },\n                    importing: { ...createImportCrud(cmsContext) }\n                } as HeadlessCms.Interface;\n            }\n            return cmsFacade;\n        });\n        container.registerFactory(CmsExport, () => container.resolve(HeadlessCms).export);\n        container.registerFactory(CmsImport, () => container.resolve(HeadlessCms).importing);\n\n        // Register CmsSchemaExecutor so proxy resolvers can build and execute the CMS sub-schema.\n        container.registerInstance(CmsSchemaExecutor, {\n            execute: async (schemaType: ApiEndpoint, body: any) => {\n                const bm = container.resolve(BenchmarkAbstraction);\n                const schema = await bm.measure(\"headlessCms.graphql.getSchema\", () =>\n                    identityContext.withoutAuthorization(() =>\n                        getSchema({ context: cmsContext, getTenant, type: schemaType })\n                    )\n                );\n                const requestBody = await bm.measure(\n                    \"headlessCms.graphql.createRequestBody\",\n                    async () => createRequestBody(body)\n                );\n                return bm.measure(\"headlessCms.graphql.processRequestBody\", () =>\n                    processRequestBody(requestBody, schema, cmsContext)\n                );\n            }\n        });\n\n        // Register CMS sub-schema factories: base types (CmsError, CmsIdentity, etc.)\n        // and, for manage endpoints, the import/export operations.\n        container.registerInstance(CmsGraphQLSchemaFactory, {\n            execute: () => createBaseSchemaPlugins(cmsContext)\n        });\n        if (type === \"manage\") {\n            container.registerInstance(CmsGraphQLSchemaFactory, {\n                execute: () => [exportPlugin]\n            });\n        }\n\n        container.registerInstance(EntryToStorageTransform, (model, entry) => {\n            return entryToStorageTransform(cmsContext, model, entry);\n        });\n        container.registerInstance(EntryFromStorageTransform, (model, entry) => {\n            return entryFromStorageTransform(cmsContext, model, entry);\n        });\n        container.registerInstance(SearchableFieldsProvider, params => {\n            return getSearchableFields({\n                context: cmsContext,\n                fields: params.fields,\n                input: []\n            });\n        });\n\n        container.register(createCmsRoute(config.type));\n    }\n});\n"],"names":["HeadlessCmsFeature","createFeature","container","config","type","CmsBaseErrorTypeFactory","CmsResponseTypeDefsImpl","CmsQueryTypeDefsImpl","CmsMutationTypeDefsImpl","QueryCmsResolverImpl","MutationCmsResolverImpl","GetModelResolverImpl","GetEntryResolverImpl","ListEntriesResolverImpl","CreateEntryResolverImpl","UpdateEntryRevisionResolverImpl","DeleteEntryRevisionResolverImpl","PublishEntryRevisionResolverImpl","UnpublishEntryRevisionResolverImpl","HeadlessCmsEndpointConfig","CompressionFeature","GraphQLFeature","ValidationFeature","StorageFeature","CmsInstallerFeature","ContentEntriesFeature","ContentModelFeature","ContentModelGroupFeature","ModelBuilderFeature","CmsWhereMapperFeature","CmsSortMapperFeature","CmsWebhooksFeature","registerFieldConverters","pluginsContainer","PluginsContainer","PluginsContainerAbstraction","plugin","CmsModelPlugin","CmsModelPluginInstance","CmsGroupPlugin","CmsGroupPluginInstance","userSchemaPlugins","CmsGraphQLSchemaPlugin","CmsGraphQLSchemaFactory","benchmark","Benchmark","BenchmarkAbstraction","cmsContext","CmsContextAbstraction","CoreGraphQLSchemaFactory","builder","RevisionIdScalar","CmsStorageModelProvider","StorageOperationsCmsModelPlugin","createCmsModelFieldConvertersAttachFactory","identityContext","IdentityContext","tenantContext","TenantContext","getTenant","accessControlInstance","getAccessControl","AccessControl","result","ListGroupsUseCase","AccessControlAbstraction","cmsFacade","HeadlessCms","createModelGroupsCrud","createModelsCrud","createContentEntryCrud","createExportCrud","createImportCrud","CmsExport","CmsImport","CmsSchemaExecutor","schemaType","body","bm","schema","getSchema","requestBody","createRequestBody","processRequestBody","createBaseSchemaPlugins","exportPlugin","EntryToStorageTransform","model","entry","entryToStorageTransform","EntryFromStorageTransform","entryFromStorageTransform","SearchableFieldsProvider","params","getSearchableFields","createCmsRoute"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwFO,MAAMA,qBAAqBC,cAAiC;IAC/D,MAAM;IACN,UAASC,SAAS,EAAEC,MAAM;QACtB,MAAM,EAAEC,IAAI,EAAE,GAAGD;QAKjBD,UAAU,QAAQ,CAACG;QACnBH,UAAU,QAAQ,CAACI;QACnBJ,UAAU,QAAQ,CAACK;QACnBL,UAAU,QAAQ,CAACM;QACnBN,UAAU,QAAQ,CAACO;QACnBP,UAAU,QAAQ,CAACQ;QACnBR,UAAU,QAAQ,CAACS;QACnBT,UAAU,QAAQ,CAACU;QACnBV,UAAU,QAAQ,CAACW;QACnBX,UAAU,QAAQ,CAACY;QACnBZ,UAAU,QAAQ,CAACa;QACnBb,UAAU,QAAQ,CAACc;QACnBd,UAAU,QAAQ,CAACe;QACnBf,UAAU,QAAQ,CAACgB;QAEnBhB,UAAU,gBAAgB,CAACiB,2BAA2B;YAClD,MAAMhB,OAAO,IAAI;QACrB;QAKAiB,mBAAmB,QAAQ,CAAClB;QAC5BmB,eAAe,QAAQ,CAACnB;QACxBoB,kBAAkB,QAAQ,CAACpB;QAC3BqB,eAAe,QAAQ,CAACrB;QACxBsB,oBAAoB,QAAQ,CAACtB;QAC7BuB,sBAAsB,QAAQ,CAACvB;QAC/BwB,oBAAoB,QAAQ,CAACxB;QAC7ByB,yBAAyB,QAAQ,CAACzB;QAClC0B,oBAAoB,QAAQ,CAAC1B;QAC7B2B,sBAAsB,QAAQ,CAAC3B;QAC/B4B,qBAAqB,QAAQ,CAAC5B;QAC9B6B,mBAAmB,QAAQ,CAAC7B;QAQ5B8B,wBAAwB9B;QAIxB,MAAM+B,mBAAmB,IAAIC,iBAAiB;eAAK/B,OAAO,YAAY,IAAI,EAAE;SAAE;QAC9ED,UAAU,gBAAgB,CAACiC,kCAA6BF;QAIxD,KAAK,MAAMG,UAAUH,iBAAiB,MAAM,CAAiBI,eAAe,IAAI,EAC5EnC,UAAU,gBAAgB,CAACoC,wBAAwBF;QAEvD,KAAK,MAAMA,UAAUH,iBAAiB,MAAM,CAAiBM,eAAe,IAAI,EAC5ErC,UAAU,gBAAgB,CAACsC,wBAAwBJ;QAKvD,MAAMK,oBAAoBR,iBAAiB,MAAM,CAC7CS,uBAAuB,IAAI;QAE/B,IAAID,kBAAkB,MAAM,GAAG,GAC3BvC,UAAU,gBAAgB,CAACyC,yBAAyB;YAChD,SAAS,IAAMF;QACnB;QAOJ,KAAK,MAAML,UAAUjC,OAAO,YAAY,IAAI,EAAE,CAC1C,IAAIiC,UAAU,AAAiC,cAAjC,OAAQA,OAAe,KAAK,EACrCA,OAAe,KAAK,CAAC;YAAElC;QAAU;QAI1C,MAAM0C,YAAY,IAAIC;QACtB3C,UAAU,gBAAgB,CAAC4C,sBAAsBF;QAKjD,MAAMG,aAAa;YACf7C;YACA,SAAS+B;YACTW;QACJ;QACA1C,UAAU,gBAAgB,CAAC8C,YAAuBD;QAElD7C,UAAU,gBAAgB,CAAC+C,0BAA0B;YACjD,SAAS,OAAMC;gBACXA,QAAQ,WAAW,CAAC;gBACpBA,QAAQ,kBAAkB,CAAC;oBAAE,YAAYC;gBAAiB;gBAC1D,OAAOD;YACX;QACJ;QAEAhD,UAAU,gBAAgB,CACtBkD,yBACA,IAAIC,gCACAC,2CAA2CP;QAOnD,MAAMQ,kBAAkBrD,UAAU,OAAO,CAACsD;QAC1C,MAAMC,gBAAgBvD,UAAU,OAAO,CAACwD;QACxC,MAAMC,YAAY,IAAMF,cAAc,SAAS;QAG/C,IAAIG;QACJ,MAAMC,mBAAmB;YACrB,IAAI,CAACD,uBACDA,wBAAwB,IAAIE,cAAc;gBACtC,aAAa,UAAYP,gBAAgB,WAAW;gBACpD,sBAAsB,IAClBA,gBAAgB,cAAc,CAAC;gBACnC,sBAAsB,IAAMA,gBAAgB,cAAc,CAAC;gBAC3D,uBAAuB,IAAMA,gBAAgB,cAAc,CAAC;gBAC5D,eAAe;oBACX,MAAMQ,SAAS,MAAMR,gBAAgB,oBAAoB,CAAC,IACtDrD,UAAU,OAAO,CAAC8D,mBAAmB,OAAO;oBAEhD,IAAID,OAAO,MAAM,IACb,MAAMA,OAAO,KAAK;oBAEtB,OAAOA,OAAO,KAAK;gBACvB;YACJ;YAEJ,OAAOH;QACX;QACA1D,UAAU,eAAe,CAAC+D,+BAA0B,IAAMJ;QAI1D,IAAIK;QACJhE,UAAU,eAAe,CAACiE,aAAa;YACnC,IAAI,CAACD,WACDA,YAAY;gBACR9D;gBACA,MAAMA,AAAS,WAATA;gBACN,SAASA,AAAS,cAATA;gBACT,QAAQA,AAAS,aAATA;gBACR,eAAeyD;gBACf,GAAGO,sBAAsB;oBAAE,SAASrB;gBAAW,EAAE;gBACjD,GAAGsB,iBAAiB;oBAAE,SAAStB;gBAAW,EAAE;gBAC5C,GAAGuB,uBAAuB;oBAAE,SAASvB;gBAAW,EAAE;gBAClD,QAAQ;oBAAE,GAAGwB,iBAAiBxB,WAAW;gBAAC;gBAC1C,WAAW;oBAAE,GAAGyB,iBAAiBzB,WAAW;gBAAC;YACjD;YAEJ,OAAOmB;QACX;QACAhE,UAAU,eAAe,CAACuE,WAAW,IAAMvE,UAAU,OAAO,CAACiE,aAAa,MAAM;QAChFjE,UAAU,eAAe,CAACwE,WAAW,IAAMxE,UAAU,OAAO,CAACiE,aAAa,SAAS;QAGnFjE,UAAU,gBAAgB,CAACyE,mBAAmB;YAC1C,SAAS,OAAOC,YAAyBC;gBACrC,MAAMC,KAAK5E,UAAU,OAAO,CAAC4C;gBAC7B,MAAMiC,SAAS,MAAMD,GAAG,OAAO,CAAC,iCAAiC,IAC7DvB,gBAAgB,oBAAoB,CAAC,IACjCyB,UAAU;4BAAE,SAASjC;4BAAYY;4BAAW,MAAMiB;wBAAW;gBAGrE,MAAMK,cAAc,MAAMH,GAAG,OAAO,CAChC,yCACA,UAAYI,kBAAkBL;gBAElC,OAAOC,GAAG,OAAO,CAAC,0CAA0C,IACxDK,mBAAmBF,aAAaF,QAAQhC;YAEhD;QACJ;QAIA7C,UAAU,gBAAgB,CAACyC,yBAAyB;YAChD,SAAS,IAAMyC,wBAAwBrC;QAC3C;QACA,IAAI3C,AAAS,aAATA,MACAF,UAAU,gBAAgB,CAACyC,yBAAyB;YAChD,SAAS,IAAM;oBAAC0C;iBAAa;QACjC;QAGJnF,UAAU,gBAAgB,CAACoF,yBAAyB,CAACC,OAAOC,QACjDC,wBAAwB1C,YAAYwC,OAAOC;QAEtDtF,UAAU,gBAAgB,CAACwF,2BAA2B,CAACH,OAAOC,QACnDG,0BAA0B5C,YAAYwC,OAAOC;QAExDtF,UAAU,gBAAgB,CAAC0F,0BAA0BC,CAAAA,SAC1CC,oBAAoB;gBACvB,SAAS/C;gBACT,QAAQ8C,OAAO,MAAM;gBACrB,OAAO,EAAE;YACb;QAGJ3F,UAAU,QAAQ,CAAC6F,eAAe5F,OAAO,IAAI;IACjD;AACJ"}

package/README.md

@@ -1,73 +1,11 @@
 # @webiny/api-headless-cms
 
-[![](https://img.shields.io/npm/dw/@webiny/api-headless-cms.svg)](https://www.npmjs.com/package/@webiny/api-headless-cms)
-[![](https://img.shields.io/npm/v/@webiny/api-headless-cms.svg)](https://www.npmjs.com/package/@webiny/api-headless-cms)
-[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+> [!NOTE]
+> This package is part of the [Webiny](https://www.webiny.com) monorepo.
+> It’s **included in every Webiny project by default** and is not meant to be used as a standalone package.
 
-## Install
+📘 **Documentation:** [https://www.webiny.com/docs](https://www.webiny.com/docs)
 
-```
-npm install --save @webiny/api-headless-cms
-```
+---
 
-Or if you prefer yarn:
-
-```
-yarn add @webiny/api-headless-cms
-```
-
-## Testing
-Due to possibility of multiple storage operations, the tests are completely decoupled from those storage operations.
-
-The [jest.setup.js](./jest.setup.js) is using [@webiny/project-utils/testing/presets.js](../project-utils/testing/presets/index.js) to find and load all the packages containing `@webiny/api-headless-cms` and `storage-operations` keywords in their `package.json` file.
-Those packages are then used to build the test run - one for each of the packages. So depending on how many storage operations there are in the repository, that much of `api-headless-cms` tests will run.
-
-### Defining test environment
-To make it possible for api-headless-cms tests to run with a storage operations package you MUST create `presets.js` file in `storage-operations-package-path/__tests__/__api__/` directory. That file is loaded when setting up the api-headless-cms tests.
-
-It MUST contain the `testEnvironment` variable which contains path to the environment definition file.
-
-That environment file MUST define the test environment which extends `NodeEnvironment` class.
-
-Test environment MUST expose `__getStorageOperationsPlugins` method, via `this.global` property of the class, which will load the required plugins in the `api-headless-cms` tests.
-
-
-### Examples of preset and test environment files
-
-The first implementation of the decoupled storage operations is DynamoDB/Elasticsearch, which you can find in [@webiny/api-headless-cms-ddb-es](../api-headless-cms-ddb-es).
-Files which you can check to help you define your own presets and test environment are:
-* [presets.js](../api-headless-cms-ddb-es/__tests__/__api__/presets.js) - an array of presets of which last one defines the environment to be loaded
-* [environment.js](../api-headless-cms-ddb-es/__tests__/__api__/environment.js) - a class which extends NodeEnvironment and exposes `__getStorageOperationsPlugins` to the tests
-
-### Debugging when testing
-For the WebStorm (PhpStorm,...) when starting a test you must have some values defined in the run/debug configurations screen:
-#### Node options
-`````
---inspect=9229
-`````
-#### Working directory
-`````
-PATH_TO_YOUR_PROJECT_ROOT
-`````
-example:
-````
-~/webiny/webiny-js/
-````
-#### Jest options
-For DynamoDB + Elasticsearch storage operations tests:
-`````
---keyword=cms:base --keyword=cms:ddb-es
-`````
-For the DynamoDB storage operations tests:
-`````
---keyword=cms:base --keyword=cms:ddb
-`````
-Note that base keyword is the `cms:base`. It tells Jest setup to load the `api-headless-cms` tests with the api-headless-cms-ddb-es tests.
-
-#### Environment variables
-If you want to use local Elasticsearch:
-`````
-ELASTICSEARCH_PORT=9200;LOCAL_ELASTICSEARCH=true
-`````
-Nothing if you do not want to use the local Elasticsearch.
+_This README file is automatically generated during the publish process._

package/constants.d.ts

@@ -1 +1,45 @@
+import type { CmsIdentity, ICmsEntryLive } from "./types/index.js";
 export declare const ROOT_FOLDER = "root";
+export declare const CMS_MODEL_SINGLETON_TAG = "singleEntry";
+export declare const ENTRY_META_FIELDS: readonly ["createdOn", "modifiedOn", "savedOn", "deletedOn", "restoredOn", "firstPublishedOn", "lastPublishedOn", "createdBy", "modifiedBy", "savedBy", "deletedBy", "restoredBy", "firstPublishedBy", "lastPublishedBy", "revisionCreatedOn", "revisionModifiedOn", "revisionSavedOn", "revisionDeletedOn", "revisionRestoredOn", "revisionFirstPublishedOn", "revisionLastPublishedOn", "revisionCreatedBy", "revisionModifiedBy", "revisionSavedBy", "revisionDeletedBy", "revisionRestoredBy", "revisionFirstPublishedBy", "revisionLastPublishedBy"];
+export type EntryMetaFieldName = (typeof ENTRY_META_FIELDS)[number];
+export interface RecordWithEntryMetaFields {
+    revisionCreatedOn: string;
+    revisionSavedOn: string;
+    revisionModifiedOn: string | null;
+    revisionDeletedOn: string | null;
+    revisionRestoredOn: string | null;
+    revisionFirstPublishedOn: string | null;
+    revisionLastPublishedOn: string | null;
+    revisionCreatedBy: CmsIdentity;
+    revisionSavedBy: CmsIdentity;
+    revisionModifiedBy: CmsIdentity | null;
+    revisionDeletedBy: CmsIdentity | null;
+    revisionRestoredBy: CmsIdentity | null;
+    revisionFirstPublishedBy: CmsIdentity | null;
+    revisionLastPublishedBy: CmsIdentity | null;
+    createdOn: string;
+    savedOn: string;
+    modifiedOn: string | null;
+    deletedOn: string | null;
+    restoredOn: string | null;
+    firstPublishedOn: string | null;
+    lastPublishedOn: string | null;
+    createdBy: CmsIdentity;
+    savedBy: CmsIdentity;
+    modifiedBy: CmsIdentity | null;
+    deletedBy: CmsIdentity | null;
+    restoredBy: CmsIdentity | null;
+    firstPublishedBy: CmsIdentity | null;
+    lastPublishedBy: CmsIdentity | null;
+    live: ICmsEntryLive | null;
+}
+export declare const pickEntryMetaFields: (object: Partial<RecordWithEntryMetaFields>, filter?: (fieldName: EntryMetaFieldName | string) => boolean) => Partial<RecordWithEntryMetaFields>;
+export declare const isNullableEntryMetaField: (fieldName: string) => boolean;
+export declare const isNonNullableEntryMetaField: (fieldName: string) => boolean;
+export declare const isDateTimeEntryMetaField: (fieldName: string) => boolean;
+export declare const isIdentityEntryMetaField: (fieldName: string) => boolean;
+export declare const isRevisionEntryMetaField: (fieldName: string) => boolean;
+export declare const isEntryLevelEntryMetaField: (fieldName: string) => boolean;
+export declare const isDeletedEntryMetaField: (fieldName: string) => boolean;
+export declare const isRestoredEntryMetaField: (fieldName: string) => boolean;

package/constants.js

@@ -1,8 +1,59 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.ROOT_FOLDER = void 0;
 const ROOT_FOLDER = "root";
-exports.ROOT_FOLDER = ROOT_FOLDER;
+const CMS_MODEL_SINGLETON_TAG = "singleEntry";
+const ENTRY_META_FIELDS = [
+    "createdOn",
+    "modifiedOn",
+    "savedOn",
+    "deletedOn",
+    "restoredOn",
+    "firstPublishedOn",
+    "lastPublishedOn",
+    "createdBy",
+    "modifiedBy",
+    "savedBy",
+    "deletedBy",
+    "restoredBy",
+    "firstPublishedBy",
+    "lastPublishedBy",
+    "revisionCreatedOn",
+    "revisionModifiedOn",
+    "revisionSavedOn",
+    "revisionDeletedOn",
+    "revisionRestoredOn",
+    "revisionFirstPublishedOn",
+    "revisionLastPublishedOn",
+    "revisionCreatedBy",
+    "revisionModifiedBy",
+    "revisionSavedBy",
+    "revisionDeletedBy",
+    "revisionRestoredBy",
+    "revisionFirstPublishedBy",
+    "revisionLastPublishedBy"
+];
+const pickEntryMetaFields = (object, filter)=>{
+    const pickedEntryMetaFields = {};
+    for (const entryMetaFieldName of ENTRY_META_FIELDS){
+        const fieldExists = entryMetaFieldName in object;
+        if (!fieldExists) object[entryMetaFieldName] = void 0;
+        const mustPick = !filter || filter(entryMetaFieldName);
+        if (mustPick) Object.assign(pickedEntryMetaFields, {
+            [entryMetaFieldName]: object[entryMetaFieldName]
+        });
+    }
+    pickedEntryMetaFields.live = object.live;
+    return pickedEntryMetaFields;
+};
+const isNullableEntryMetaField = (fieldName)=>{
+    const lcFieldName = fieldName.toLowerCase();
+    return lcFieldName.includes("modified") || lcFieldName.includes("published") || lcFieldName.includes("deleted") || lcFieldName.includes("restored");
+};
+const isNonNullableEntryMetaField = (fieldName)=>!isNullableEntryMetaField(fieldName);
+const isDateTimeEntryMetaField = (fieldName)=>fieldName.endsWith("On");
+const isIdentityEntryMetaField = (fieldName)=>fieldName.endsWith("By");
+const isRevisionEntryMetaField = (fieldName)=>ENTRY_META_FIELDS.includes(fieldName) && fieldName.startsWith("revision");
+const isEntryLevelEntryMetaField = (fieldName)=>ENTRY_META_FIELDS.includes(fieldName) && !fieldName.startsWith("revision");
+const isDeletedEntryMetaField = (fieldName)=>ENTRY_META_FIELDS.includes(fieldName) && fieldName.includes("deleted");
+const isRestoredEntryMetaField = (fieldName)=>ENTRY_META_FIELDS.includes(fieldName) && fieldName.includes("restored");
+export { CMS_MODEL_SINGLETON_TAG, ENTRY_META_FIELDS, ROOT_FOLDER, isDateTimeEntryMetaField, isDeletedEntryMetaField, isEntryLevelEntryMetaField, isIdentityEntryMetaField, isNonNullableEntryMetaField, isNullableEntryMetaField, isRestoredEntryMetaField, isRevisionEntryMetaField, pickEntryMetaFields };
+
+//# sourceMappingURL=constants.js.map

package/constants.js.map

@@ -1 +1 @@
-{"version":3,"names":["ROOT_FOLDER"],"sources":["constants.ts"],"sourcesContent":["export const ROOT_FOLDER = \"root\";\n"],"mappings":";;;;;;AAAO,MAAMA,WAAW,GAAG,MAAM;AAAC"}
+{"version":3,"file":"constants.js","sources":["../src/constants.ts"],"sourcesContent":["import type { CmsIdentity, ICmsEntryLive } from \"~/types/index.js\";\n\nexport const ROOT_FOLDER = \"root\";\n\nexport const CMS_MODEL_SINGLETON_TAG = \"singleEntry\";\n\n// Content entries - xOn and xBy meta fields.\nexport const ENTRY_META_FIELDS = [\n    // Entry-level meta fields.\n    \"createdOn\",\n    \"modifiedOn\",\n    \"savedOn\",\n    \"deletedOn\",\n    \"restoredOn\",\n    \"firstPublishedOn\",\n    \"lastPublishedOn\",\n    \"createdBy\",\n    \"modifiedBy\",\n    \"savedBy\",\n    \"deletedBy\",\n    \"restoredBy\",\n    \"firstPublishedBy\",\n    \"lastPublishedBy\",\n\n    // Revision-level meta fields.\n    \"revisionCreatedOn\",\n    \"revisionModifiedOn\",\n    \"revisionSavedOn\",\n    \"revisionDeletedOn\",\n    \"revisionRestoredOn\",\n    \"revisionFirstPublishedOn\",\n    \"revisionLastPublishedOn\",\n    \"revisionCreatedBy\",\n    \"revisionModifiedBy\",\n    \"revisionSavedBy\",\n    \"revisionDeletedBy\",\n    \"revisionRestoredBy\",\n    \"revisionFirstPublishedBy\",\n    \"revisionLastPublishedBy\"\n] as const;\n\nexport type EntryMetaFieldName = (typeof ENTRY_META_FIELDS)[number];\n\nexport interface RecordWithEntryMetaFields {\n    revisionCreatedOn: string;\n    revisionSavedOn: string;\n    revisionModifiedOn: string | null;\n    revisionDeletedOn: string | null;\n    revisionRestoredOn: string | null;\n    revisionFirstPublishedOn: string | null;\n    revisionLastPublishedOn: string | null;\n    revisionCreatedBy: CmsIdentity;\n    revisionSavedBy: CmsIdentity;\n    revisionModifiedBy: CmsIdentity | null;\n    revisionDeletedBy: CmsIdentity | null;\n    revisionRestoredBy: CmsIdentity | null;\n    revisionFirstPublishedBy: CmsIdentity | null;\n    revisionLastPublishedBy: CmsIdentity | null;\n\n    // Entry-level meta fields.\n    createdOn: string;\n    savedOn: string;\n    modifiedOn: string | null;\n    deletedOn: string | null;\n    restoredOn: string | null;\n    firstPublishedOn: string | null;\n    lastPublishedOn: string | null;\n    createdBy: CmsIdentity;\n    savedBy: CmsIdentity;\n    modifiedBy: CmsIdentity | null;\n    deletedBy: CmsIdentity | null;\n    restoredBy: CmsIdentity | null;\n    firstPublishedBy: CmsIdentity | null;\n    lastPublishedBy: CmsIdentity | null;\n    live: ICmsEntryLive | null;\n}\n\nexport const pickEntryMetaFields = (\n    object: Partial<RecordWithEntryMetaFields>,\n    filter?: (fieldName: EntryMetaFieldName | string) => boolean\n) => {\n    const pickedEntryMetaFields: Partial<RecordWithEntryMetaFields> = {};\n    for (const entryMetaFieldName of ENTRY_META_FIELDS) {\n        const fieldExists = entryMetaFieldName in object;\n        if (!fieldExists) {\n            object[entryMetaFieldName] = undefined;\n        }\n\n        const mustPick = !filter || filter(entryMetaFieldName);\n        if (mustPick) {\n            Object.assign(pickedEntryMetaFields, {\n                [entryMetaFieldName]: object[entryMetaFieldName]\n            });\n        }\n    }\n    /**\n     * Also add live field, as it's not part of entry meta fields, but it's required to be transfered.\n     */\n    pickedEntryMetaFields.live = object.live;\n\n    return pickedEntryMetaFields;\n};\n\nexport const isNullableEntryMetaField = (fieldName: string) => {\n    // Only modifiedX, publishedX, deletedX fields are nullable.\n    const lcFieldName = fieldName.toLowerCase();\n    return (\n        lcFieldName.includes(\"modified\") ||\n        lcFieldName.includes(\"published\") ||\n        lcFieldName.includes(\"deleted\") ||\n        lcFieldName.includes(\"restored\")\n    );\n};\n\nexport const isNonNullableEntryMetaField = (fieldName: string) => {\n    return !isNullableEntryMetaField(fieldName);\n};\n\nexport const isDateTimeEntryMetaField = (fieldName: string) => {\n    // Only field ending with \"On\" are date/time fields.\n    return fieldName.endsWith(\"On\");\n};\n\nexport const isIdentityEntryMetaField = (fieldName: string) => {\n    // Only field ending with \"On\" are date/time fields.\n    return fieldName.endsWith(\"By\");\n};\n\nexport const isRevisionEntryMetaField = (fieldName: string) => {\n    return (\n        ENTRY_META_FIELDS.includes(fieldName as EntryMetaFieldName) &&\n        fieldName.startsWith(\"revision\")\n    );\n};\n\nexport const isEntryLevelEntryMetaField = (fieldName: string) => {\n    return (\n        ENTRY_META_FIELDS.includes(fieldName as EntryMetaFieldName) &&\n        !fieldName.startsWith(\"revision\")\n    );\n};\n\nexport const isDeletedEntryMetaField = (fieldName: string) => {\n    return (\n        ENTRY_META_FIELDS.includes(fieldName as EntryMetaFieldName) && fieldName.includes(\"deleted\")\n    );\n};\n\nexport const isRestoredEntryMetaField = (fieldName: string) => {\n    return (\n        ENTRY_META_FIELDS.includes(fieldName as EntryMetaFieldName) &&\n        fieldName.includes(\"restored\")\n    );\n};\n"],"names":["ROOT_FOLDER","CMS_MODEL_SINGLETON_TAG","ENTRY_META_FIELDS","pickEntryMetaFields","object","filter","pickedEntryMetaFields","entryMetaFieldName","fieldExists","undefined","mustPick","Object","isNullableEntryMetaField","fieldName","lcFieldName","isNonNullableEntryMetaField","isDateTimeEntryMetaField","isIdentityEntryMetaField","isRevisionEntryMetaField","isEntryLevelEntryMetaField","isDeletedEntryMetaField","isRestoredEntryMetaField"],"mappings":"AAEO,MAAMA,cAAc;AAEpB,MAAMC,0BAA0B;AAGhC,MAAMC,oBAAoB;IAE7B;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IAGA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;CACH;AAsCM,MAAMC,sBAAsB,CAC/BC,QACAC;IAEA,MAAMC,wBAA4D,CAAC;IACnE,KAAK,MAAMC,sBAAsBL,kBAAmB;QAChD,MAAMM,cAAcD,sBAAsBH;QAC1C,IAAI,CAACI,aACDJ,MAAM,CAACG,mBAAmB,GAAGE;QAGjC,MAAMC,WAAW,CAACL,UAAUA,OAAOE;QACnC,IAAIG,UACAC,OAAO,MAAM,CAACL,uBAAuB;YACjC,CAACC,mBAAmB,EAAEH,MAAM,CAACG,mBAAmB;QACpD;IAER;IAIAD,sBAAsB,IAAI,GAAGF,OAAO,IAAI;IAExC,OAAOE;AACX;AAEO,MAAMM,2BAA2B,CAACC;IAErC,MAAMC,cAAcD,UAAU,WAAW;IACzC,OACIC,YAAY,QAAQ,CAAC,eACrBA,YAAY,QAAQ,CAAC,gBACrBA,YAAY,QAAQ,CAAC,cACrBA,YAAY,QAAQ,CAAC;AAE7B;AAEO,MAAMC,8BAA8B,CAACF,YACjC,CAACD,yBAAyBC;AAG9B,MAAMG,2BAA2B,CAACH,YAE9BA,UAAU,QAAQ,CAAC;AAGvB,MAAMI,2BAA2B,CAACJ,YAE9BA,UAAU,QAAQ,CAAC;AAGvB,MAAMK,2BAA2B,CAACL,YAEjCX,kBAAkB,QAAQ,CAACW,cAC3BA,UAAU,UAAU,CAAC;AAItB,MAAMM,6BAA6B,CAACN,YAEnCX,kBAAkB,QAAQ,CAACW,cAC3B,CAACA,UAAU,UAAU,CAAC;AAIvB,MAAMO,0BAA0B,CAACP,YAEhCX,kBAAkB,QAAQ,CAACW,cAAoCA,UAAU,QAAQ,CAAC;AAInF,MAAMQ,2BAA2B,CAACR,YAEjCX,kBAAkB,QAAQ,CAACW,cAC3BA,UAAU,QAAQ,CAAC"}

package/createCmsRoute.d.ts

@@ -0,0 +1,21 @@
+import type { Container } from "@webiny/di";
+import type { IHttpRequest, IHttpResponse } from "@webiny/event-handler-core";
+import type { IGraphQLContextualSchema } from "@webiny/api-graphql";
+import type { ApiEndpoint } from "./types/index.js";
+/**
+ * The HTTP route for a CMS GraphQL endpoint (manage/read/preview). Per request it runs the
+ * contextual schemas, then executes the CMS sub-schema via CmsSchemaExecutor. The post-auth
+ * RequestContextInitializers are run once per request by the HTTP layer
+ * (RequestContextInitializerDecorator) before the router dispatches, so they cover every route.
+ */
+export declare function createCmsRoute(type: ApiEndpoint): {
+    new (container: Container, contextualSchemas: IGraphQLContextualSchema[]): {
+        readonly method: "POST";
+        readonly path: string;
+        container: Container;
+        contextualSchemas: IGraphQLContextualSchema[];
+        handle(request: IHttpRequest): Promise<IHttpResponse>;
+    };
+} & {
+    __abstraction: import("@webiny/di").Abstraction<import("@webiny/event-handler-core").IHttpRoute>;
+};

package/createCmsRoute.js

@@ -0,0 +1,49 @@
+import { HttpRoute, RequestContainer } from "@webiny/event-handler-core";
+import { GraphQLContextualSchema } from "@webiny/api-graphql";
+import { BenchmarkAbstraction } from "@webiny/api";
+import { CmsSchemaExecutor } from "./graphql/CmsSchemaExecutor.js";
+const CMS_PATHS = {
+    manage: "/cms/manage",
+    read: "/cms/read",
+    preview: "/cms/preview"
+};
+function createCmsRoute(type) {
+    class CmsGraphQLRoute {
+        constructor(container, contextualSchemas){
+            this.container = container;
+            this.contextualSchemas = contextualSchemas;
+            this.method = "POST";
+            this.path = CMS_PATHS[type];
+        }
+        async handle(request) {
+            const ctx = {
+                container: this.container
+            };
+            for (const schema of this.contextualSchemas)await schema.build(ctx);
+            const result = await this.container.resolve(CmsSchemaExecutor).execute(type, request.body);
+            await this.container.resolve(BenchmarkAbstraction).output();
+            return {
+                statusCode: 200,
+                headers: {
+                    "Content-Type": "application/json"
+                },
+                body: result
+            };
+        }
+    }
+    return HttpRoute.createImplementation({
+        implementation: CmsGraphQLRoute,
+        dependencies: [
+            RequestContainer,
+            [
+                GraphQLContextualSchema,
+                {
+                    multiple: true
+                }
+            ]
+        ]
+    });
+}
+export { createCmsRoute };
+
+//# sourceMappingURL=createCmsRoute.js.map