@etohq/framework 1.0.0 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etohq/framework",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Framework",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -27,11 +27,13 @@
     "./feature-flags": "./dist/feature-flags/index.js",
     "./utils": "./dist/utils/index.js",
     "./types": "./dist/types/index.js",
+    "./types/http": "./dist/types/http/index.js",
     "./build-tools": "./dist/build-tools/index.js",
     "./orchestration": "./dist/orchestration/index.js",
     "./workflows-sdk": "./dist/workflows-sdk/index.js",
     "./workflows-sdk/composer": "./dist/workflows-sdk/composer.js",
-    "./modules-sdk": "./dist/modules-sdk/index.js"
+    "./modules-sdk": "./dist/modules-sdk/index.js",
+    "./link-modules-sdk": "./dist/link-modules-sdk/index.js"
   },
   "engines": {
     "node": ">=20"
@@ -53,7 +55,7 @@
     "test": "jest --runInBand --bail --passWithNoTests --forceExit"
   },
   "devDependencies": {
-    "@etohq/cli": "^1.0.0",
+    "@etohq/cli": "^1.2.0",
     "@mikro-orm/cli": "5.9.7",
     "@mikro-orm/core": "5.9.7",
     "@mikro-orm/knex": "5.9.7",
@@ -74,11 +76,12 @@
     "vite": "^5.2.11"
   },
   "dependencies": {
-    "@etohq/modules-sdk": "^1.0.0",
-    "@etohq/orchestration": "^1.0.0",
-    "@etohq/types": "^1.0.0",
-    "@etohq/utils": "^1.0.0",
-    "@etohq/workflows-sdk": "^1.0.0",
+    "@etohq/link-modules-sdk": "^1.2.0",
+    "@etohq/modules-sdk": "^1.2.0",
+    "@etohq/orchestration": "^1.2.0",
+    "@etohq/types": "^1.2.0",
+    "@etohq/utils": "^1.2.0",
+    "@etohq/workflows-sdk": "^1.2.0",
     "@jercle/yargonaut": "^1.1.5",
     "@opentelemetry/api": "^1.9.0",
     "@types/express": "^4.17.17",
@@ -95,7 +98,7 @@
     "zod": "3.22.4"
   },
   "peerDependencies": {
-    "@etohq/cli": "^1.0.0",
+    "@etohq/cli": "^1.1.0",
     "@mikro-orm/cli": "5.9.7",
     "@mikro-orm/core": "5.9.7",
     "@mikro-orm/knex": "5.9.7",

package/dist/http/express-loader.d.ts

@@ -1,8 +0,0 @@
-import { Express } from "express";
-export declare function expressLoader({ app }: {
-    app: Express;
-}): Promise<{
-    app: Express;
-    shutdown: () => Promise<void>;
-}>;
-//# sourceMappingURL=express-loader.d.ts.map

package/dist/http/express-loader.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"express-loader.d.ts","sourceRoot":"","sources":["../../src/http/express-loader.ts"],"names":[],"mappings":"AAEA,OAAgB,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAW1C,wBAAsB,aAAa,CAAC,EAAE,GAAG,EAAE,EAAE;IAAE,GAAG,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC;IACtE,GAAG,EAAE,OAAO,CAAA;IACZ,QAAQ,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAC9B,CAAC,CAsFD"}

package/dist/http/express-loader.js

@@ -1,85 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.expressLoader = expressLoader;
-const connect_redis_1 = __importDefault(require("connect-redis"));
-const cookie_parser_1 = __importDefault(require("cookie-parser"));
-const express_1 = __importDefault(require("express"));
-const express_session_1 = __importDefault(require("express-session"));
-const ioredis_1 = __importDefault(require("ioredis"));
-const morgan_1 = __importDefault(require("morgan"));
-const path_1 = __importDefault(require("path"));
-const logger_1 = require("../logger");
-const config_1 = require("../config");
-const NOISY_ENDPOINTS_CHUNKS = ["@fs", "@id", "@vite", "@react", "node_modules"];
-async function expressLoader({ app }) {
-    const baseDir = config_1.configManager.baseDir;
-    const configModule = config_1.configManager.config;
-    const isProduction = config_1.configManager.isProduction;
-    const NODE_ENV = process.env.NODE_ENV || "development";
-    const IS_DEV = NODE_ENV.startsWith("dev");
-    const isStaging = NODE_ENV === "staging";
-    const isTest = NODE_ENV === "test";
-    let sameSite = false;
-    let secure = false;
-    if (isProduction || isStaging) {
-        secure = true;
-        sameSite = "none";
-    }
-    const { http, sessionOptions } = configModule.projectConfig;
-    const sessionOpts = {
-        name: sessionOptions?.name ?? "connect.sid",
-        resave: sessionOptions?.resave ?? true,
-        rolling: sessionOptions?.rolling ?? false,
-        saveUninitialized: sessionOptions?.saveUninitialized ?? true,
-        proxy: true,
-        secret: sessionOptions?.secret ?? http?.cookieSecret,
-        cookie: {
-            sameSite,
-            secure,
-            maxAge: sessionOptions?.ttl ?? 10 * 60 * 60 * 1000,
-        },
-        store: null,
-    };
-    let redisClient;
-    if (configModule?.projectConfig?.redisUrl) {
-        const RedisStore = (0, connect_redis_1.default)(express_session_1.default);
-        redisClient = new ioredis_1.default(configModule.projectConfig.redisUrl, configModule.projectConfig.redisOptions ?? {});
-        sessionOpts.store = new RedisStore({
-            client: redisClient,
-            prefix: `${configModule?.projectConfig?.redisPrefix ?? ""}sess:`,
-        });
-    }
-    app.set("trust proxy", 1);
-    /**
-     * Method to skip logging HTTP requests. We skip in test environment
-     * and also exclude files served by vite during development
-     */
-    function shouldSkipHttpLog(req, res) {
-        return (isTest || NOISY_ENDPOINTS_CHUNKS.some((chunk) => req.url.includes(chunk)));
-    }
-    /**
-     * The middleware to use for logging. We write the log messages
-     * using winston, but rely on morgan to hook into HTTP requests
-     */
-    const loggingMiddleware = (0, morgan_1.default)(IS_DEV
-        ? ":method :url ← :referrer (:status) - :response-time ms"
-        : "combined", {
-        skip: shouldSkipHttpLog,
-        stream: {
-            write: (message) => logger_1.logger.http(message.trim()),
-        },
-    });
-    app.use(loggingMiddleware);
-    app.use((0, cookie_parser_1.default)());
-    app.use((0, express_session_1.default)(sessionOpts));
-    // Currently we don't allow configuration of static files, but this can be revisited as needed.
-    app.use("/static", express_1.default.static(path_1.default.join(baseDir, "static")));
-    const shutdown = async () => {
-        redisClient?.disconnect();
-    };
-    return { app, shutdown };
-}
-//# sourceMappingURL=express-loader.js.map

package/dist/http/express-loader.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"express-loader.js","sourceRoot":"","sources":["../../src/http/express-loader.ts"],"names":[],"mappings":";;;;;AAaA,sCAyFC;AAtGD,kEAAuC;AACvC,kEAAwC;AACxC,sDAA0C;AAC1C,sEAAqC;AACrC,sDAA2B;AAC3B,oDAA2B;AAC3B,gDAAuB;AACvB,sCAAkC;AAClC,sCAAyC;AAGzC,MAAM,sBAAsB,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAA;AAEzE,KAAK,UAAU,aAAa,CAAC,EAAE,GAAG,EAAoB;IAI3D,MAAM,OAAO,GAAG,sBAAa,CAAC,OAAO,CAAA;IACrC,MAAM,YAAY,GAAG,sBAAa,CAAC,MAAM,CAAA;IACzC,MAAM,YAAY,GAAG,sBAAa,CAAC,YAAY,CAAA;IAC/C,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,aAAa,CAAA;IACtD,MAAM,MAAM,GAAG,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;IACzC,MAAM,SAAS,GAAG,QAAQ,KAAK,SAAS,CAAA;IACxC,MAAM,MAAM,GAAG,QAAQ,KAAK,MAAM,CAAA;IAElC,IAAI,QAAQ,GAAqB,KAAK,CAAA;IACtC,IAAI,MAAM,GAAG,KAAK,CAAA;IAClB,IAAI,YAAY,IAAI,SAAS,EAAE,CAAC;QAC9B,MAAM,GAAG,IAAI,CAAA;QACb,QAAQ,GAAG,MAAM,CAAA;IACnB,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,YAAY,CAAC,aAAa,CAAA;IAC3D,MAAM,WAAW,GAAG;QAClB,IAAI,EAAE,cAAc,EAAE,IAAI,IAAI,aAAa;QAC3C,MAAM,EAAE,cAAc,EAAE,MAAM,IAAI,IAAI;QACtC,OAAO,EAAE,cAAc,EAAE,OAAO,IAAI,KAAK;QACzC,iBAAiB,EAAE,cAAc,EAAE,iBAAiB,IAAI,IAAI;QAC5D,KAAK,EAAE,IAAI;QACX,MAAM,EAAE,cAAc,EAAE,MAAM,IAAI,IAAI,EAAE,YAAY;QACpD,MAAM,EAAE;YACN,QAAQ;YACR,MAAM;YACN,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;SACnD;QACD,KAAK,EAAE,IAAI;KACZ,CAAA;IAED,IAAI,WAAkB,CAAA;IAEtB,IAAI,YAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;QAC1C,MAAM,UAAU,GAAG,IAAA,uBAAW,EAAC,yBAAO,CAAC,CAAA;QACvC,WAAW,GAAG,IAAI,iBAAK,CACrB,YAAY,CAAC,aAAa,CAAC,QAAQ,EACnC,YAAY,CAAC,aAAa,CAAC,YAAY,IAAI,EAAE,CAC9C,CAAA;QACD,WAAW,CAAC,KAAK,GAAG,IAAI,UAAU,CAAC;YACjC,MAAM,EAAE,WAAW;YACnB,MAAM,EAAE,GAAG,YAAY,EAAE,aAAa,EAAE,WAAW,IAAI,EAAE,OAAO;SACjE,CAAC,CAAA;IACJ,CAAC;IAED,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,CAAA;IAEzB;;;OAGG;IACH,SAAS,iBAAiB,CAAC,GAAe,EAAE,GAAgB;QAC1D,OAAO,CACL,MAAM,IAAI,sBAAsB,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAC1E,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,MAAM,iBAAiB,GAAG,IAAA,gBAAM,EAC9B,MAAM;QACJ,CAAC,CAAC,wDAAwD;QAC1D,CAAC,CAAC,UAAU,EACd;QACE,IAAI,EAAE,iBAAiB;QACvB,MAAM,EAAE;YACN,KAAK,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,eAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;SACxD;KACF,CACF,CAAA;IAED,GAAG,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;IAC1B,GAAG,CAAC,GAAG,CAAC,IAAA,uBAAY,GAAE,CAAC,CAAA;IACvB,GAAG,CAAC,GAAG,CAAC,IAAA,yBAAO,EAAC,WAAW,CAAC,CAAC,CAAA;IAE7B,+FAA+F;IAC/F,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,iBAAO,CAAC,MAAM,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAA;IAEhE,MAAM,QAAQ,GAAG,KAAK,IAAI,EAAE;QAC1B,WAAW,EAAE,UAAU,EAAE,CAAA;IAC3B,CAAC,CAAA;IAED,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAA;AAC1B,CAAC"}

package/dist/http/router.d.ts

@@ -1,100 +0,0 @@
-import { type Express, RequestHandler } from "express";
-import { AuthType } from "./middlewares";
-import { MiddlewareFunction, MiddlewaresConfig, RouteHandler, RouteVerb } from "./types";
-export declare class ApiRoutesLoader {
-    #private;
-    /**
-     * Wrap the original route handler implementation for
-     * instrumentation.
-     */
-    static traceRoute?: (handler: RouteHandler, route: {
-        route: string;
-        method: string;
-    }) => RouteHandler;
-    /**
-     * Wrap the original middleware handler implementation for
-     * instrumentation.
-     */
-    static traceMiddleware?: (handler: RequestHandler | MiddlewareFunction, route: {
-        route: string;
-        method?: string;
-    }) => RequestHandler | MiddlewareFunction;
-    constructor({ app, activityId, sourceDir, }: {
-        app: Express;
-        activityId?: string;
-        sourceDir: string;
-    });
-    /**
-     * Validate the route config and display a log info if
-     * it should be ignored or skipped.
-     *
-     * @param {GlobalMiddlewareDescriptor} descriptor
-     * @param {MiddlewaresConfig} config
-     *
-     * @return {void}
-     */
-    protected validateMiddlewaresConfig({ config, }: {
-        config?: MiddlewaresConfig;
-    }): void;
-    /**
-     * Take care of replacing the special path segments
-     * to an express specific path segment
-     *
-     * @param route - The route to parse
-     *
-     * @example
-     * "/admin/orders/[id]/route.ts => "/admin/orders/:id/route.ts"
-     */
-    protected parseRoute(route: string): string;
-    /**
-     * Load the file content from a descriptor and retrieve the verbs and handlers
-     * to be assigned to the descriptor
-     *
-     * @return {Promise<void>}
-     */
-    protected createRoutesConfig(): Promise<void>;
-    protected createRoutesDescriptor(path: string): void;
-    protected createMiddlewaresDescriptor(): Promise<void>;
-    protected createRoutesMap(): Promise<void>;
-    /**
-     * Apply the most specific body parser middleware to the router
-     */
-    applyBodyParserMiddleware(path: string, method: RouteVerb): void;
-    /**
-     * Applies middleware that checks if a valid publishable key is set on store request
-     */
-    applyStorePublishableKeyMiddleware(route: string | RegExp): void;
-    /**
-     * Applies the route middleware on a route. Encapsulates the logic
-     * needed to pass the middleware via the trace calls
-     */
-    applyAuthMiddleware(route: string | RegExp, actorType: string | string[], authType: AuthType | AuthType[], options?: {
-        allowUnauthenticated?: boolean;
-        allowUnregistered?: boolean;
-    }): void;
-    /**
-     * Apply the route specific middlewares to the router,
-     * this includes the cors, authentication and
-     * body parsing. These are applied first to ensure
-     * that they are applied before any other middleware.
-     */
-    applyRouteSpecificMiddlewares(): void;
-    /**
-     * Apply the error handler middleware to the router
-     */
-    applyErrorHandlerMiddleware(): void;
-    protected registerRoutes(): Promise<void>;
-    protected registerMiddlewares(): Promise<void>;
-    load(): Promise<void>;
-}
-export declare class RoutesLoader {
-    #private;
-    constructor({ app, activityId, sourceDir, baseRestrictedFields, }: {
-        app: Express;
-        activityId?: string;
-        sourceDir: string | string[];
-        baseRestrictedFields?: string[];
-    });
-    load(): Promise<void>;
-}
-//# sourceMappingURL=router.d.ts.map

package/dist/http/router.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/http/router.ts"],"names":[],"mappings":"AASA,OAAO,EACL,KAAK,OAAO,EAEZ,cAAc,EAIf,MAAM,SAAS,CAAA;AAMhB,OAAO,EAAgB,QAAQ,EAAgB,MAAM,eAAe,CAAA;AAEpE,OAAO,EAML,kBAAkB,EAElB,iBAAiB,EAKjB,YAAY,EACZ,SAAS,EACV,MAAM,SAAS,CAAA;AA0LhB,qBAAa,eAAe;;IA+C1B;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,EAAE,CAClB,OAAO,EAAE,YAAY,EACrB,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,KACrC,YAAY,CAAA;IAEjB;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,EAAE,CACvB,OAAO,EAAE,cAAc,GAAG,kBAAkB,EAC5C,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,KACtC,cAAc,GAAG,kBAAkB,CAAA;gBAE5B,EACV,GAAG,EACH,UAAU,EACV,SAAS,GACV,EAAE;QACD,GAAG,EAAE,OAAO,CAAA;QACZ,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,SAAS,EAAE,MAAM,CAAA;KAClB;IAOD;;;;;;;;OAQG;IACH,SAAS,CAAC,yBAAyB,CAAC,EAClC,MAAM,GACP,EAAE;QACD,MAAM,CAAC,EAAE,iBAAiB,CAAA;KAC3B,GAAG,IAAI;IAmBR;;;;;;;;OAQG;IACH,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAyC3C;;;;;OAKG;cACa,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAyFnD,SAAS,CAAC,sBAAsB,CAAC,IAAI,EAAE,MAAM;cA2B7B,2BAA2B;cA0D3B,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IA6BhD;;OAEG;IACH,yBAAyB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,IAAI;IA2BhE;;OAEG;IACH,kCAAkC,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAczD;;;OAGG;IACH,mBAAmB,CACjB,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,EAC5B,QAAQ,EAAE,QAAQ,GAAG,QAAQ,EAAE,EAC/B,OAAO,CAAC,EAAE;QAAE,oBAAoB,CAAC,EAAE,OAAO,CAAC;QAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;KAAE;IAe3E;;;;;OAKG;IACH,6BAA6B,IAAI,IAAI;IA2HrC;;OAEG;IACH,2BAA2B,IAAI,IAAI;cA0BnB,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;cAkD/B,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAkD9C,IAAI;CA0DX;AAED,qBAAa,YAAY;;gBAmBX,EACV,GAAG,EACH,UAAU,EACV,SAAS,EACT,oBAAyB,GAC1B,EAAE;QACD,GAAG,EAAE,OAAO,CAAA;QACZ,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;QAC5B,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAA;KAChC;IA6BK,IAAI;CAiBX"}