@webiny/api-event-handler-core 0.0.0-unstable.0156a4c312

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Webiny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,11 @@
+# @webiny/api-event-handler-core
+
+> [!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.
+
+📘 **Documentation:** [https://www.webiny.com/docs](https://www.webiny.com/docs)
+
+---
+
+_This README file is automatically generated during the publish process._

package/index.d.ts

@@ -0,0 +1,2 @@
+export { registerApiRequestStack } from "./registerApiRequestStack.js";
+export type { RegisterApiRequestStackConfig } from "./registerApiRequestStack.js";

package/index.js

@@ -0,0 +1 @@
+export { registerApiRequestStack } from "./registerApiRequestStack.js";

package/package.json

@@ -0,0 +1,61 @@
+{
+	"name": "@webiny/api-event-handler-core",
+	"version": "0.0.0-unstable.0156a4c312",
+	"type": "module",
+	"main": "index.js",
+	"exports": {
+		".": "./index.js",
+		"./*": "./*"
+	},
+	"types": "index.d.ts",
+	"description": "Transport-agnostic composition of the Webiny API request stack (registerApiRequestStack).",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git"
+	},
+	"contributors": [
+		"Webiny Team"
+	],
+	"license": "MIT",
+	"dependencies": {
+		"@webiny/api-aco": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-audit-logs": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-core": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-dashboard": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-file-manager": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-file-manager-aco": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-graphql": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-headless-cms": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-headless-cms-aco": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-headless-cms-scheduler": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-headless-cms-tasks": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-headless-cms-workflows": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-mailer": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-record-locking": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-scheduler": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-website-builder": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-website-builder-scheduler": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-website-builder-workflows": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-websockets": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-workflows": "0.0.0-unstable.0156a4c312",
+		"@webiny/background-tasks": "0.0.0-unstable.0156a4c312",
+		"@webiny/handler": "0.0.0-unstable.0156a4c312",
+		"@webiny/webhooks": "0.0.0-unstable.0156a4c312"
+	},
+	"peerDependencies": {
+		"@webiny/di": "^2.0.0"
+	},
+	"devDependencies": {
+		"@webiny/build-tools": "0.0.0-unstable.0156a4c312",
+		"@webiny/di": "2.0.0",
+		"rimraf": "6.1.3",
+		"typescript": "7.0.2",
+		"vitest": "5.0.5"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"webiny": {
+		"publishFrom": "dist"
+	}
+}

package/registerApiRequestStack.d.ts

@@ -0,0 +1,58 @@
+import type { Container } from "@webiny/di";
+import { registerExtensions } from "@webiny/handler";
+/** Installs a hosting-specific transport adapter into the per-request container at its interleave point. */
+export type TransportRegistrar = (container: Container) => void | Promise<void>;
+export interface RegisterApiRequestStackConfig {
+    /**
+     * Project-defined extensions, applied at register() time (so extension features — including
+     * code-defined CMS models — are registered before anything lists/caches the model set).
+     */
+    extensions: () => Parameters<typeof registerExtensions>[1];
+    /**
+     * Hosting-specific transport adapters, each installed at its exact interleave point in the stack.
+     * Every entry follows the same shape: it runs immediately AFTER the transport-agnostic domain
+     * Feature has registered its NULL default, and overrides that default (nearest-container-last-wins)
+     * with the real adapter. Each is optional — omit one for a deployment/transport that lacks that
+     * capability. AWS supplies AWS adapters (API Gateway Management API / EventBridge / S3); the
+     * standalone server supplies in-process adapters (server WebSockets / Bree / local disk).
+     */
+    transports?: {
+        /**
+         * Hosting-specific replacements for api-core defaults, run right after `ApiCoreFeature`:
+         * `PublicUrls` (default: every URL unknown), and `EncryptionConfig` / `HashingConfig`
+         * (default: read from build params).
+         */
+        hostingConfig?: TransportRegistrar;
+        /**
+         * Real-time (WebSockets) transport, run right after `WebsocketsFeature`. Overrides the
+         * NullWebsocketsTransport, otherwise every server→client send() is a silent no-op.
+         */
+        realtime?: TransportRegistrar;
+        /**
+         * Scheduler transport, run AFTER `SchedulerFeature` and BEFORE `CmsSchedulerFeature`.
+         */
+        scheduler?: TransportRegistrar;
+        /**
+         * File-manager storage transport, run AFTER `FileManagerAppFeature` (which registers the
+         * AssetDeliveryRoute + NULL asset-delivery impls). Overrides those nulls with real impls and
+         * adds the file-operation features.
+         */
+        fileManager?: TransportRegistrar;
+    };
+}
+/**
+ * Registers the transport-AGNOSTIC Webiny API request stack: every domain feature + the GraphQL
+ * engine, in the correct (order-sensitive) sequence. This is shared by all transport composition
+ * packages (`@webiny/api-event-handler-aws`, and the future `-server`) so the feature set and its
+ * ordering live in ONE place and can't drift between transports.
+ *
+ * Transport- and storage-specific pieces are injected via the hooks in {@link RegisterApiRequestStackConfig}
+ * at their exact interleave points. The caller is responsible for the ROOT-container transport wiring
+ * (HTTP/event transport, auth/tenant loaders, identity provider, DB + storage) before dispatch reaches
+ * this per-request stack. That includes the `Logger`: api-core registers none, so a root without one
+ * fails the first time anything that logs is built.
+ *
+ * ORDER IS LOAD-BEARING — do not reorder. Notably: extensions must be applied before anything that
+ * lists + caches the per-request model set; the GraphQL engine must be registered last.
+ */
+export declare function registerApiRequestStack(container: Container, config: RegisterApiRequestStackConfig): Promise<void>;

package/registerApiRequestStack.js

@@ -0,0 +1,63 @@
+import { registerBuildParams, registerExtensions } from "@webiny/handler";
+import { GraphQLEngineFeature } from "@webiny/api-graphql";
+import { ApiCoreFeature } from "@webiny/api-core";
+import { WcpLicenseLoader } from "@webiny/api-core/features/wcp/WcpLicenseLoader.js";
+import { HeadlessCmsFeature } from "@webiny/api-headless-cms";
+import { AcoHcmsFeature } from "@webiny/api-headless-cms-aco";
+import { HcmsTasksFeature } from "@webiny/api-headless-cms-tasks";
+import { CmsWorkflowsFeature } from "@webiny/api-headless-cms-workflows";
+import { CmsSchedulerFeature } from "@webiny/api-headless-cms-scheduler";
+import { MailerFeature } from "@webiny/api-mailer";
+import { RecordLockingAppFeature } from "@webiny/api-record-locking";
+import { AuditLogsFeature } from "@webiny/api-audit-logs";
+import { DashboardAppFeature } from "@webiny/api-dashboard";
+import { WebhooksFeature } from "@webiny/webhooks/api";
+import { AcoFeature } from "@webiny/api-aco";
+import { BackgroundTasksFeature } from "@webiny/background-tasks/api";
+import { FileManagerAppFeature } from "@webiny/api-file-manager";
+import { FileManagerAcoFeature } from "@webiny/api-file-manager-aco";
+import { WebsiteBuilderFeature } from "@webiny/api-website-builder";
+import { WebsiteBuilderWorkflowsFeature } from "@webiny/api-website-builder-workflows";
+import { WebsiteBuilderSchedulerFeature } from "@webiny/api-website-builder-scheduler";
+import { WebsocketsFeature } from "@webiny/api-websockets";
+import { WorkflowsFeature } from "@webiny/api-workflows";
+import { SchedulerFeature } from "@webiny/api-scheduler";
+async function registerApiRequestStack(container, config) {
+    await WcpLicenseLoader.load();
+    const extensions = config.extensions();
+    await registerBuildParams(container, extensions);
+    ApiCoreFeature.register(container, {
+        wcpLicense: void 0
+    });
+    await config.transports?.hostingConfig?.(container);
+    HeadlessCmsFeature.register(container, {
+        type: "manage"
+    });
+    AcoFeature.register(container);
+    AcoHcmsFeature.register(container);
+    HcmsTasksFeature.register(container);
+    FileManagerAppFeature.register(container);
+    FileManagerAcoFeature.register(container);
+    await config.transports?.fileManager?.(container);
+    WebsiteBuilderFeature.register(container);
+    WebsiteBuilderWorkflowsFeature.register(container);
+    WebsiteBuilderSchedulerFeature.register(container);
+    WebsocketsFeature.register(container);
+    await config.transports?.realtime?.(container);
+    MailerFeature.register(container);
+    RecordLockingAppFeature.register(container, {});
+    AuditLogsFeature.register(container, {});
+    DashboardAppFeature.register(container);
+    WebhooksFeature.register(container);
+    BackgroundTasksFeature.register(container);
+    WorkflowsFeature.register(container);
+    CmsWorkflowsFeature.register(container);
+    SchedulerFeature.register(container);
+    await config.transports?.scheduler?.(container);
+    CmsSchedulerFeature.register(container);
+    await registerExtensions(container, extensions);
+    GraphQLEngineFeature.register(container);
+}
+export { registerApiRequestStack };
+
+//# sourceMappingURL=registerApiRequestStack.js.map

package/registerApiRequestStack.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registerApiRequestStack.js","sources":["../src/registerApiRequestStack.ts"],"sourcesContent":["import type { Container } from \"@webiny/di\";\nimport { registerBuildParams, registerExtensions } from \"@webiny/handler\";\nimport { GraphQLEngineFeature } from \"@webiny/api-graphql\";\nimport { ApiCoreFeature } from \"@webiny/api-core\";\nimport { WcpLicenseLoader } from \"@webiny/api-core/features/wcp/WcpLicenseLoader.js\";\nimport { HeadlessCmsFeature } from \"@webiny/api-headless-cms\";\nimport { AcoHcmsFeature } from \"@webiny/api-headless-cms-aco\";\nimport { HcmsTasksFeature } from \"@webiny/api-headless-cms-tasks\";\nimport { CmsWorkflowsFeature } from \"@webiny/api-headless-cms-workflows\";\nimport { CmsSchedulerFeature } from \"@webiny/api-headless-cms-scheduler\";\nimport { MailerFeature } from \"@webiny/api-mailer\";\nimport { RecordLockingAppFeature } from \"@webiny/api-record-locking\";\nimport { AuditLogsFeature } from \"@webiny/api-audit-logs\";\nimport { DashboardAppFeature } from \"@webiny/api-dashboard\";\nimport { WebhooksFeature } from \"@webiny/webhooks/api\";\nimport { AcoFeature } from \"@webiny/api-aco\";\nimport { BackgroundTasksFeature } from \"@webiny/background-tasks/api\";\nimport { FileManagerAppFeature } from \"@webiny/api-file-manager\";\nimport { FileManagerAcoFeature } from \"@webiny/api-file-manager-aco\";\nimport { WebsiteBuilderFeature } from \"@webiny/api-website-builder\";\nimport { WebsiteBuilderWorkflowsFeature } from \"@webiny/api-website-builder-workflows\";\nimport { WebsiteBuilderSchedulerFeature } from \"@webiny/api-website-builder-scheduler\";\nimport { WebsocketsFeature } from \"@webiny/api-websockets\";\nimport { WorkflowsFeature } from \"@webiny/api-workflows\";\nimport { SchedulerFeature } from \"@webiny/api-scheduler\";\n\n/** Installs a hosting-specific transport adapter into the per-request container at its interleave point. */\nexport type TransportRegistrar = (container: Container) => void | Promise<void>;\n\nexport interface RegisterApiRequestStackConfig {\n    /**\n     * Project-defined extensions, applied at register() time (so extension features — including\n     * code-defined CMS models — are registered before anything lists/caches the model set).\n     */\n    extensions: () => Parameters<typeof registerExtensions>[1];\n    /**\n     * Hosting-specific transport adapters, each installed at its exact interleave point in the stack.\n     * Every entry follows the same shape: it runs immediately AFTER the transport-agnostic domain\n     * Feature has registered its NULL default, and overrides that default (nearest-container-last-wins)\n     * with the real adapter. Each is optional — omit one for a deployment/transport that lacks that\n     * capability. AWS supplies AWS adapters (API Gateway Management API / EventBridge / S3); the\n     * standalone server supplies in-process adapters (server WebSockets / Bree / local disk).\n     */\n    transports?: {\n        /**\n         * Hosting-specific replacements for api-core defaults, run right after `ApiCoreFeature`:\n         * `PublicUrls` (default: every URL unknown), and `EncryptionConfig` / `HashingConfig`\n         * (default: read from build params).\n         */\n        hostingConfig?: TransportRegistrar;\n        /**\n         * Real-time (WebSockets) transport, run right after `WebsocketsFeature`. Overrides the\n         * NullWebsocketsTransport, otherwise every server→client send() is a silent no-op.\n         */\n        realtime?: TransportRegistrar;\n        /**\n         * Scheduler transport, run AFTER `SchedulerFeature` and BEFORE `CmsSchedulerFeature`.\n         */\n        scheduler?: TransportRegistrar;\n        /**\n         * File-manager storage transport, run AFTER `FileManagerAppFeature` (which registers the\n         * AssetDeliveryRoute + NULL asset-delivery impls). Overrides those nulls with real impls and\n         * adds the file-operation features.\n         */\n        fileManager?: TransportRegistrar;\n    };\n}\n\n/**\n * Registers the transport-AGNOSTIC Webiny API request stack: every domain feature + the GraphQL\n * engine, in the correct (order-sensitive) sequence. This is shared by all transport composition\n * packages (`@webiny/api-event-handler-aws`, and the future `-server`) so the feature set and its\n * ordering live in ONE place and can't drift between transports.\n *\n * Transport- and storage-specific pieces are injected via the hooks in {@link RegisterApiRequestStackConfig}\n * at their exact interleave points. The caller is responsible for the ROOT-container transport wiring\n * (HTTP/event transport, auth/tenant loaders, identity provider, DB + storage) before dispatch reaches\n * this per-request stack. That includes the `Logger`: api-core registers none, so a root without one\n * fails the first time anything that logs is built.\n *\n * ORDER IS LOAD-BEARING — do not reorder. Notably: extensions must be applied before anything that\n * lists + caches the per-request model set; the GraphQL engine must be registered last.\n */\nexport async function registerApiRequestStack(\n    container: Container,\n    config: RegisterApiRequestStackConfig\n): Promise<void> {\n    // Refresh the WCP license BEFORE any feature registers — this is the single per-request refresh.\n    // register()-time feature-flag checks (e.g. the private-files gate) and WcpContext.canUse* both\n    // read it via the process cache (`WcpLicenseProvider.get()` / `WcpLicenseLoader.getCached()`). Runs here\n    // — the shared request stack both hosting types call — so no handler wires it. Process-cached\n    // (~5-min TTL) + single-flighted → cheap no-op on warm requests.\n    await WcpLicenseLoader.load();\n\n    // ── Build params (before ANY feature) ──────────────────────\n    // Features gate themselves on FeatureFlags at register() time (AuditLogs, RecordLocking,\n    // Workflows, ...), and FeatureFlags is a BuildParam. Registered with the rest of the extensions\n    // below, it arrived too late: those gates read `{}`, and a license-granted feature couldn't be\n    // disabled from config.\n    const extensions = config.extensions();\n    await registerBuildParams(container, extensions);\n\n    // ── Core API (per-request: EventPublisher + tenant/identity/request contexts must bind to the\n    // request child container so per-request event handlers are resolvable) ─────────\n    ApiCoreFeature.register(container, { wcpLicense: undefined });\n    await config.transports?.hostingConfig?.(container);\n\n    // ── CMS ────────────────────────────────────────────────────\n    HeadlessCmsFeature.register(container, { type: \"manage\" });\n    AcoFeature.register(container);\n    AcoHcmsFeature.register(container);\n    HcmsTasksFeature.register(container);\n\n    // ── File Manager (domain) + storage transport ──────────────\n    FileManagerAppFeature.register(container);\n    FileManagerAcoFeature.register(container);\n    await config.transports?.fileManager?.(container);\n\n    // ── Website Builder ────────────────────────────────────────\n    WebsiteBuilderFeature.register(container);\n    WebsiteBuilderWorkflowsFeature.register(container);\n    WebsiteBuilderSchedulerFeature.register(container);\n\n    // ── Websockets (domain) + real-time transport ──────────────\n    WebsocketsFeature.register(container);\n    await config.transports?.realtime?.(container);\n\n    // ── Supporting services ────────────────────────────────────\n    MailerFeature.register(container);\n    RecordLockingAppFeature.register(container, {});\n    AuditLogsFeature.register(container, {});\n    DashboardAppFeature.register(container);\n    WebhooksFeature.register(container);\n    BackgroundTasksFeature.register(container);\n\n    // ── Workflows ──────────────────────────────────────────────\n    WorkflowsFeature.register(container);\n    CmsWorkflowsFeature.register(container);\n\n    // ── Scheduler + scheduler transport ────────────────────────\n    SchedulerFeature.register(container);\n    await config.transports?.scheduler?.(container);\n    CmsSchedulerFeature.register(container);\n\n    // ── Extensions ─────────────────────────────────────────────\n    // Apply at register() time so extension features — including code-defined CMS models\n    // (ModelFactory), e.g. Languages — are registered before anything populates ModelCache. Anything\n    // reaching the model set through GetModel/ListModels (which go via ModelsFetcher ->\n    // ModelCache.getOrSet) caches it for the rest of the request, so a set built before extensions\n    // register would be missing their models. Every consumer now resolves models at schema-build or\n    // resolver time, i.e. after all registration.\n    await registerExtensions(container, extensions);\n\n    // ── GraphQL engine (always last) ───────────────────────────\n    GraphQLEngineFeature.register(container);\n}\n"],"names":["registerApiRequestStack","container","config","WcpLicenseLoader","extensions","registerBuildParams","ApiCoreFeature","undefined","HeadlessCmsFeature","AcoFeature","AcoHcmsFeature","HcmsTasksFeature","FileManagerAppFeature","FileManagerAcoFeature","WebsiteBuilderFeature","WebsiteBuilderWorkflowsFeature","WebsiteBuilderSchedulerFeature","WebsocketsFeature","MailerFeature","RecordLockingAppFeature","AuditLogsFeature","DashboardAppFeature","WebhooksFeature","BackgroundTasksFeature","WorkflowsFeature","CmsWorkflowsFeature","SchedulerFeature","CmsSchedulerFeature","registerExtensions","GraphQLEngineFeature"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAmFO,eAAeA,wBAClBC,SAAoB,EACpBC,MAAqC;IAOrC,MAAMC,iBAAiB,IAAI;IAO3B,MAAMC,aAAaF,OAAO,UAAU;IACpC,MAAMG,oBAAoBJ,WAAWG;IAIrCE,eAAe,QAAQ,CAACL,WAAW;QAAE,YAAYM;IAAU;IAC3D,MAAML,OAAO,UAAU,EAAE,gBAAgBD;IAGzCO,mBAAmB,QAAQ,CAACP,WAAW;QAAE,MAAM;IAAS;IACxDQ,WAAW,QAAQ,CAACR;IACpBS,eAAe,QAAQ,CAACT;IACxBU,iBAAiB,QAAQ,CAACV;IAG1BW,sBAAsB,QAAQ,CAACX;IAC/BY,sBAAsB,QAAQ,CAACZ;IAC/B,MAAMC,OAAO,UAAU,EAAE,cAAcD;IAGvCa,sBAAsB,QAAQ,CAACb;IAC/Bc,+BAA+B,QAAQ,CAACd;IACxCe,+BAA+B,QAAQ,CAACf;IAGxCgB,kBAAkB,QAAQ,CAAChB;IAC3B,MAAMC,OAAO,UAAU,EAAE,WAAWD;IAGpCiB,cAAc,QAAQ,CAACjB;IACvBkB,wBAAwB,QAAQ,CAAClB,WAAW,CAAC;IAC7CmB,iBAAiB,QAAQ,CAACnB,WAAW,CAAC;IACtCoB,oBAAoB,QAAQ,CAACpB;IAC7BqB,gBAAgB,QAAQ,CAACrB;IACzBsB,uBAAuB,QAAQ,CAACtB;IAGhCuB,iBAAiB,QAAQ,CAACvB;IAC1BwB,oBAAoB,QAAQ,CAACxB;IAG7ByB,iBAAiB,QAAQ,CAACzB;IAC1B,MAAMC,OAAO,UAAU,EAAE,YAAYD;IACrC0B,oBAAoB,QAAQ,CAAC1B;IAS7B,MAAM2B,mBAAmB3B,WAAWG;IAGpCyB,qBAAqB,QAAQ,CAAC5B;AAClC"}