@etohq/link-modules-sdk 1.0.0

package/dist/utils/generate-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-schema.d.ts","sourceRoot":"","sources":["../../src/utils/generate-schema.ts"],"names":[],"mappings":"AACA,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACzB,MAAM,wBAAwB,CAAA;AAS/B,wBAAgB,qBAAqB,CACnC,YAAY,EAAE,kBAAkB,EAChC,OAAO,EAAE,wBAAwB,EACjC,OAAO,EAAE,wBAAwB,EACjC,EAAE,MAAM,EAAE,GAAE;IAAE,MAAM,MAAA;CAAwB,UAgM7C"}

package/dist/utils/generate-schema.js

@@ -0,0 +1,156 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateGraphQLSchema = generateGraphQLSchema;
+const modules_sdk_1 = require("@etohq/framework/modules-sdk");
+const utils_1 = require("@etohq/utils");
+function generateGraphQLSchema(joinerConfig, primary, foreign, { logger } = { logger: console }) {
+    let fieldNames;
+    let entityName;
+    const isReadOnlyLink = joinerConfig.isReadOnlyLink;
+    if (!isReadOnlyLink) {
+        fieldNames = primary.foreignKey.split(",").concat(foreign.foreignKey);
+        entityName = (0, utils_1.toPascalCase)("Link_" +
+            (joinerConfig.databaseConfig?.tableName ??
+                (0, utils_1.composeTableName)(primary.serviceName, primary.foreignKey, foreign.serviceName, foreign.foreignKey)));
+    }
+    let typeDef = "";
+    for (const extend of joinerConfig.extends ?? []) {
+        const extendedModule = modules_sdk_1.EtoModule.getModuleInstance(extend.serviceName);
+        if (!extendedModule) {
+            throw new Error(`Module ${extend.serviceName} not found. Please verify that the module is configured and installed, also the module must be loaded before the link modules.`);
+        }
+        let extendedEntityName = extendedModule[extend.serviceName].__joinerConfig.linkableKeys[extend.relationship.primaryKey];
+        if (!isReadOnlyLink && (!primary || !foreign || !extendedEntityName)) {
+            logger.warn(`Link modules schema: No linkable key found for ${extend.relationship.primaryKey} on module ${extend.serviceName}.`);
+            continue;
+        }
+        const fieldName = (0, utils_1.camelToSnakeCase)((0, utils_1.lowerCaseFirst)(extend.relationship.alias));
+        let type = extend.relationship.isList ? `[${entityName}]` : entityName;
+        if (joinerConfig?.isReadOnlyLink) {
+            // TODO: In readonly links, the relationship of the extend where entity is undefined has to be applied on all entities in the module that have the relationshiop foreing key attribute (unkown in this context)
+            if (!extend.entity) {
+                continue;
+            }
+            const rel = extend.relationship;
+            const extendedService = modules_sdk_1.EtoModule.getModuleInstance(rel.serviceName);
+            const hasGraphqlSchema = !!extendedService[rel.serviceName].__joinerConfig.schema;
+            const relEntity = rel.entity
+                ? rel.entity
+                : extendedService[rel.serviceName].__joinerConfig.linkableKeys[rel.primaryKey];
+            if (!relEntity || !hasGraphqlSchema) {
+                continue;
+            }
+            type = rel.isList ? `[${relEntity}]` : relEntity;
+            extendedEntityName = extend.entity;
+        }
+        /**
+         * Find the field aliases shortcut to extend the entity with it
+         */
+        const fieldsAliasesField = Object.entries(extend.fieldAlias || {})
+            .map(([field, config]) => {
+            const path = (0, utils_1.isString)(config) ? config : config.path;
+            const isList = (0, utils_1.isString)(config)
+                ? extend.relationship.isList
+                : config.isList ?? extend.relationship.isList;
+            const targetEntityAlias = path.split(".").pop();
+            const targetEntityRelation = joinerConfig.relationships?.find((relation) => relation.alias === targetEntityAlias);
+            if (!targetEntityRelation) {
+                return;
+            }
+            const targetEntityName = modules_sdk_1.EtoModule.getJoinerConfig(targetEntityRelation.serviceName).linkableKeys?.[targetEntityRelation.foreignKey];
+            if (!targetEntityName) {
+                logger.warn(`Link modules schema: No linkable key found for ${targetEntityRelation.foreignKey} on module ${targetEntityRelation.serviceName}.`);
+                return;
+            }
+            // TODO: Re visit field aliases that access properties from a type
+            /*const targetEntityType = `${targetEntityName}${
+              relationshipPropertyPath.length
+                ? relationshipPropertyPath.reduce((acc, value) => {
+                    return `${acc}[${value}]`
+                  }, targetEntityName)
+                : ""
+            }`*/
+            return `${field}: ${isList ? `[${targetEntityName}]` : targetEntityName}`;
+        })
+            .filter(Boolean);
+        typeDef += `    
+      extend type ${extendedEntityName} {
+        ${fieldName}: ${type}
+        
+        ${fieldsAliasesField.join("\n")}
+      }
+    `;
+    }
+    if (isReadOnlyLink) {
+        return typeDef;
+    }
+    // Pivot table fields
+    const fields = fieldNames.reduce((acc, curr) => {
+        acc[curr] = {
+            type: "String",
+            nullable: false,
+        };
+        return acc;
+    }, {});
+    const extraFields = joinerConfig.databaseConfig?.extraFields ?? {};
+    for (const column in extraFields) {
+        fields[column] = {
+            type: getGraphQLType(extraFields[column].type),
+            nullable: !!extraFields[column].nullable,
+        };
+    }
+    // TODO: temporary, every module might always expose their schema
+    const doesPrimaryExportSchema = !!modules_sdk_1.EtoModule.getJoinerConfig(primary.serviceName)?.schema;
+    const doesForeignExportSchema = !!modules_sdk_1.EtoModule.getJoinerConfig(foreign.serviceName)?.schema;
+    // Link table relationships
+    const primaryField = doesPrimaryExportSchema
+        ? `${(0, utils_1.camelToSnakeCase)(primary.alias)}: ${(0, utils_1.toPascalCase)((0, utils_1.composeTableName)(primary.serviceName))}`
+        : "";
+    const foreignField = doesForeignExportSchema
+        ? `${(0, utils_1.camelToSnakeCase)(foreign.alias)}: ${(0, utils_1.toPascalCase)((0, utils_1.composeTableName)(foreign.serviceName))}`
+        : "";
+    typeDef += `
+    type ${entityName} {
+      ${Object.entries(fields)
+        .map(([field, { type, nullable }]) => `${field}: ${nullable ? type : `${type}!`}`)
+        .join("\n      ")}
+        
+      ${primaryField}
+      ${foreignField}
+      
+      createdAt: String!
+      updatedAt: String!
+      deletedAt: String
+    }
+  `;
+    return typeDef;
+}
+function getGraphQLType(type) {
+    const typeDef = {
+        numeric: "Float",
+        integer: "Int",
+        smallint: "Int",
+        tinyint: "Int",
+        mediumint: "Int",
+        float: "Float",
+        double: "Float",
+        boolean: "Boolean",
+        decimal: "Float",
+        string: "String",
+        uuid: "ID",
+        text: "String",
+        date: "Date",
+        time: "Time",
+        datetime: "DateTime",
+        bigint: "BigInt",
+        blob: "Blob",
+        uint8array: "[Int]",
+        array: "[String]",
+        enumArray: "[String]",
+        enum: "String",
+        json: "JSON",
+        jsonb: "JSON",
+    };
+    return typeDef[type] ?? "String";
+}
+//# sourceMappingURL=generate-schema.js.map

package/dist/utils/generate-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-schema.js","sourceRoot":"","sources":["../../src/utils/generate-schema.ts"],"names":[],"mappings":";;AAaA,sDAoMC;AAjND,8DAAwD;AAKxD,wCAMqB;AAErB,SAAgB,qBAAqB,CACnC,YAAgC,EAChC,OAAiC,EACjC,OAAiC,EACjC,EAAE,MAAM,KAAiB,EAAE,MAAM,EAAE,OAAO,EAAE;IAE5C,IAAI,UAAqB,CAAA;IACzB,IAAI,UAAmB,CAAA;IAEvB,MAAM,cAAc,GAAG,YAAY,CAAC,cAAc,CAAA;IAClD,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QAErE,UAAU,GAAG,IAAA,oBAAY,EACvB,OAAO;YACL,CAAC,YAAY,CAAC,cAAc,EAAE,SAAS;gBACrC,IAAA,wBAAgB,EACd,OAAO,CAAC,WAAW,EACnB,OAAO,CAAC,UAAU,EAClB,OAAO,CAAC,WAAW,EACnB,OAAO,CAAC,UAAU,CACnB,CAAC,CACP,CAAA;IACH,CAAC;IAED,IAAI,OAAO,GAAG,EAAE,CAAA;IAEhB,KAAK,MAAM,MAAM,IAAI,YAAY,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;QAChD,MAAM,cAAc,GAAG,uBAAS,CAAC,iBAAiB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;QACtE,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CACb,UAAU,MAAM,CAAC,WAAW,gIAAgI,CAC7J,CAAA;QACH,CAAC;QAED,IAAI,kBAAkB,GACpB,cAAc,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC,YAAY,CAC5D,MAAM,CAAC,YAAY,CAAC,UAAU,CAC/B,CAAA;QAEH,IAAI,CAAC,cAAc,IAAI,CAAC,CAAC,OAAO,IAAI,CAAC,OAAO,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACrE,MAAM,CAAC,IAAI,CACT,kDAAkD,MAAM,CAAC,YAAY,CAAC,UAAU,cAAc,MAAM,CAAC,WAAW,GAAG,CACpH,CAAA;YAED,SAAQ;QACV,CAAC;QAED,MAAM,SAAS,GAAG,IAAA,wBAAgB,EAChC,IAAA,sBAAc,EAAC,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAC1C,CAAA;QAED,IAAI,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,UAAU,GAAG,CAAC,CAAC,CAAC,UAAU,CAAA;QACtE,IAAI,YAAY,EAAE,cAAc,EAAE,CAAC;YACjC,+MAA+M;YAC/M,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;gBACnB,SAAQ;YACV,CAAC;YAED,MAAM,GAAG,GAAG,MAAM,CAAC,YAAY,CAAA;YAC/B,MAAM,eAAe,GAAG,uBAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;YAEpE,MAAM,gBAAgB,GACpB,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC,MAAM,CAAA;YAC1D,MAAM,SAAS,GAAG,GAAG,CAAC,MAAM;gBAC1B,CAAC,CAAC,GAAG,CAAC,MAAM;gBACZ,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC,YAAY,CAC1D,GAAG,CAAC,UAAU,CACf,CAAA;YAEL,IAAI,CAAC,SAAS,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACpC,SAAQ;YACV,CAAC;YAED,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,SAAS,GAAG,CAAC,CAAC,CAAC,SAAU,CAAA;YACjD,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAA;QACpC,CAAC;QAED;;WAEG;QACH,MAAM,kBAAkB,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC;aAC/D,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE;YACvB,MAAM,IAAI,GAAG,IAAA,gBAAQ,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAA;YACpD,MAAM,MAAM,GAAG,IAAA,gBAAQ,EAAC,MAAM,CAAC;gBAC7B,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM;gBAC5B,CAAC,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC,MAAM,CAAA;YAE/C,MAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAA;YAE/C,MAAM,oBAAoB,GAAG,YAAY,CAAC,aAAa,EAAE,IAAI,CAC3D,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,KAAK,iBAAiB,CACnD,CAAA;YAED,IAAI,CAAC,oBAAoB,EAAE,CAAC;gBAC1B,OAAM;YACR,CAAC;YAED,MAAM,gBAAgB,GAAG,uBAAS,CAAC,eAAe,CAChD,oBAAoB,CAAC,WAAW,CACjC,CAAC,YAAY,EAAE,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAA;YAEjD,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtB,MAAM,CAAC,IAAI,CACT,kDAAkD,oBAAoB,CAAC,UAAU,cAAc,oBAAoB,CAAC,WAAW,GAAG,CACnI,CAAA;gBAED,OAAM;YACR,CAAC;YAED,kEAAkE;YAClE;;;;;;gBAMI;YAEJ,OAAO,GAAG,KAAK,KACb,MAAM,CAAC,CAAC,CAAC,IAAI,gBAAgB,GAAG,CAAC,CAAC,CAAC,gBACrC,EAAE,CAAA;QACJ,CAAC,CAAC;aACD,MAAM,CAAC,OAAO,CAAC,CAAA;QAElB,OAAO,IAAI;oBACK,kBAAkB;UAC5B,SAAS,KAAK,IAAI;;UAElB,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC;;KAElC,CAAA;IACH,CAAC;IAED,IAAI,cAAc,EAAE,CAAC;QACnB,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,qBAAqB;IACrB,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;QAC7C,GAAG,CAAC,IAAI,CAAC,GAAG;YACV,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,KAAK;SAChB,CAAA;QACD,OAAO,GAAG,CAAA;IACZ,CAAC,EAAE,EAAE,CAAC,CAAA;IAEN,MAAM,WAAW,GAAG,YAAY,CAAC,cAAc,EAAE,WAAW,IAAI,EAAE,CAAA;IAElE,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE,CAAC;QACjC,MAAM,CAAC,MAAM,CAAC,GAAG;YACf,IAAI,EAAE,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC;YAC9C,QAAQ,EAAE,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,QAAQ;SACzC,CAAA;IACH,CAAC;IAED,iEAAiE;IACjE,MAAM,uBAAuB,GAAG,CAAC,CAAC,uBAAS,CAAC,eAAe,CACzD,OAAO,CAAC,WAAW,CACpB,EAAE,MAAM,CAAA;IACT,MAAM,uBAAuB,GAAG,CAAC,CAAC,uBAAS,CAAC,eAAe,CACzD,OAAO,CAAC,WAAW,CACpB,EAAE,MAAM,CAAA;IAET,2BAA2B;IAC3B,MAAM,YAAY,GAAG,uBAAuB;QAC1C,CAAC,CAAC,GAAG,IAAA,wBAAgB,EAAC,OAAO,CAAC,KAAK,CAAC,KAAK,IAAA,oBAAY,EACjD,IAAA,wBAAgB,EAAC,OAAO,CAAC,WAAW,CAAC,CACtC,EAAE;QACL,CAAC,CAAC,EAAE,CAAA;IAEN,MAAM,YAAY,GAAG,uBAAuB;QAC1C,CAAC,CAAC,GAAG,IAAA,wBAAgB,EAAC,OAAO,CAAC,KAAK,CAAC,KAAK,IAAA,oBAAY,EACjD,IAAA,wBAAgB,EAAC,OAAO,CAAC,WAAW,CAAC,CACtC,EAAE;QACL,CAAC,CAAC,EAAE,CAAA;IAEN,OAAO,IAAI;WACF,UAAU;QACZ,MAAM,CAAC,OAAO,CAAC,MAAM,CAAS;SAC9B,GAAG,CACF,CAAC,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAC9B,GAAG,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,EAAE,CAC9C;SACA,IAAI,CAAC,UAAU,CAAC;;QAEjB,YAAY;QACZ,YAAY;;;;;;GAMjB,CAAA;IAED,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,SAAS,cAAc,CAAC,IAAI;IAC1B,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,KAAK;QAChB,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,OAAO;QACf,OAAO,EAAE,SAAS;QAClB,OAAO,EAAE,OAAO;QAChB,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,IAAI;QACV,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,UAAU;QACpB,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE,OAAO;QACnB,KAAK,EAAE,UAAU;QACjB,SAAS,EAAE,UAAU;QACrB,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,MAAM;KACd,CAAA;IAED,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAA;AAClC,CAAC"}

package/dist/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./generate-entity";
+export * from "./generate-schema";
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA"}

package/dist/utils/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./generate-entity"), exports);
+__exportStar(require("./generate-schema"), exports);
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAiC;AACjC,oDAAiC"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@etohq/link-modules-sdk",
+  "version": "1.0.0",
+  "description": "Eto Link Module Package",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "!dist/**/__tests__",
+    "!dist/**/__mocks__",
+    "!dist/**/__fixtures__"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/etohq/eto",
+    "directory": "packages/core/link-modules"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "author": "Eto",
+  "license": "MIT",
+  "scripts": {
+    "watch": "tsc --build --watch",
+    "watch:test": "tsc --build tsconfig.spec.json --watch",
+    "prepare": "cross-env NODE_ENV=production yarn run build",
+    "resolve:aliases": "tsc --showConfig -p tsconfig.json > tsconfig.resolved.json && tsc-alias -p tsconfig.resolved.json && rimraf tsconfig.resolved.json",
+    "build": "rimraf dist && tsc --build && npm run resolve:aliases",
+    "test": "jest --passWithNoTests --runInBand --bail --forceExit -- src",
+    "test:integration": "jest --forceExit -- integration-tests/**/__tests__/**/*.ts"
+  },
+  "devDependencies": {
+    "@mikro-orm/core": "5.9.7",
+    "@mikro-orm/migrations": "5.9.7",
+    "@mikro-orm/postgresql": "5.9.7",
+    "@swc/core": "^1.7.28",
+    "@swc/jest": "^0.2.36",
+    "@types/jest": "^29.5.14",
+    "cross-env": "^5.2.1",
+    "jest": "^29.7.0",
+    "rimraf": "^5.0.2",
+    "tsc-alias": "^1.8.6",
+    "typescript": "^5.6.2"
+  },
+  "dependencies": {
+    "awilix": "^8.0.1"
+  },
+  "peerDependencies": {
+    "@mikro-orm/core": "5.9.7",
+    "@mikro-orm/migrations": "5.9.7",
+    "@mikro-orm/postgresql": "5.9.7",
+    "awilix": "^8.0.1"
+  }
+}