@treatwell/moleculer-call-wrapper 1.0.0

package/dist/index.mjs

@@ -0,0 +1,694 @@
+import { readFile, writeFile } from 'node:fs/promises';
+import { isTypeReferenceNode, isQualifiedName, isImportDeclaration, isNamedImports, factory, createSourceFile, ScriptTarget, isMethodDeclaration, isPropertyAssignment, SyntaxKind, createPrinter, NewLineKind, NodeFlags, isCallExpression } from 'typescript';
+import { readFileSync } from 'node:fs';
+import { relative, dirname, resolve } from 'node:path';
+import crypto from 'node:crypto';
+import { cloneNode } from 'ts-clone-node';
+
+const MOLECULER_NAME = "m";
+function fillImports(context, sourceFile, node) {
+  node.forEachChild((n) => fillImports(context, sourceFile, n));
+  if (!isTypeReferenceNode(node)) {
+    return;
+  }
+  let nodeName = node.typeName.getText();
+  if (isQualifiedName(node.typeName)) {
+    nodeName = node.typeName.left.getText();
+  }
+  let importName = node.typeName.getText();
+  const importDeclaration = sourceFile.statements.filter(isImportDeclaration).find((n) => {
+    if (n.importClause?.namedBindings && isNamedImports(n.importClause.namedBindings)) {
+      const importIdentifier = n.importClause.namedBindings.elements.find(
+        (c) => c.name.getText() === nodeName
+      );
+      if (importIdentifier?.propertyName) {
+        importName = importIdentifier.propertyName.getText();
+      }
+      return !!importIdentifier;
+    }
+    return false;
+  });
+  if (importDeclaration) {
+    let key = importDeclaration.moduleSpecifier.getText().slice(1, -1);
+    if (key.startsWith(".")) {
+      key = `./${relative(
+        dirname(context.wrapperPath),
+        resolve(dirname(context.currentFilePath), key)
+      ).replace(/\\/g, "/")}`;
+    }
+    const name = addDepToImports(context.imports, key);
+    context.importMapping.set(node, `${name}.${importName}`);
+  }
+}
+function getUniqueNameFromKey(key) {
+  switch (key) {
+    case "@wavyapp/wavy-sdk":
+      return "sdk";
+    case "moleculer":
+      return MOLECULER_NAME;
+    default:
+      if (/^[a-zA-Z]\w+$/.test(key)) {
+        return key;
+      }
+      return `s${crypto.createHash("sha1").update(key).digest("hex").slice(0, 7)}`;
+  }
+}
+function addDepToImports(imports, key) {
+  let name = imports.get(key);
+  if (!name) {
+    name = getUniqueNameFromKey(key);
+    imports.set(key, name);
+  }
+  return name;
+}
+function importMappingCloneHook(importMapping) {
+  return (n) => {
+    if (isTypeReferenceNode(n) && importMapping.has(n)) {
+      return {
+        typeName: () => factory.createIdentifier(importMapping.get(n))
+      };
+    }
+    return void 0;
+  };
+}
+
+function parseService(context, service) {
+  const actions = [];
+  const sourceFile = createSourceFile(
+    "service.ts",
+    readFileSync(context.currentFilePath, "utf8"),
+    ScriptTarget.ESNext,
+    true
+  );
+  const handlers = findActionsTypes(context, sourceFile);
+  const version = service.version ? `v${service.version}.` : "";
+  Object.entries(service.schema.actions || {}).forEach(
+    ([actionName, action]) => {
+      if (action === false || typeof action === "object" && action.visibility === "private") {
+        return;
+      }
+      const { params, returnType, typeParameters } = handlers.get(actionName) || {};
+      if (typeParameters) {
+        typeParameters.forEach((tp) => fillImports(context, sourceFile, tp));
+      }
+      if (returnType) {
+        fillImports(context, sourceFile, returnType);
+      }
+      if (params) {
+        fillImports(context, sourceFile, params);
+      }
+      actions.push({
+        actionName: `${version}${service.name}.${actionName}`,
+        params,
+        returnType,
+        typeParameters
+      });
+    }
+  );
+  context.builtins.forEach(
+    (injectBuiltin) => injectBuiltin(context, actions, service, sourceFile)
+  );
+  return actions;
+}
+function findActionsTypes(context, sourceFile) {
+  const handlers = /* @__PURE__ */ new Map();
+  function visit(n) {
+    if (!isMethodDeclaration(n) || n.name.getText() !== "handler" || n.parameters.length !== 1) {
+      return n.forEachChild(visit);
+    }
+    if (!isPropertyAssignment(n.parent.parent)) {
+      return n.forEachChild(visit);
+    }
+    const ctxType = n.parameters[0].type;
+    if (!ctxType || !isTypeReferenceNode(ctxType)) {
+      return n.forEachChild(visit);
+    }
+    let paramsType;
+    if (ctxType.typeArguments?.length && ctxType.typeArguments[0].getText() !== "never") {
+      [paramsType] = ctxType.typeArguments;
+    }
+    handlers.set(n.parent.parent.name.getText(), {
+      params: paramsType,
+      returnType: n.type,
+      typeParameters: n.typeParameters
+    });
+    return void 0;
+  }
+  sourceFile.forEachChild(visit);
+  return handlers;
+}
+
+const ParamsActions = "Actions";
+const NoParamsActions = "ActionsU";
+function createWrapperParameters(action, importMapping, actionTypeGenericName) {
+  let actionParamType;
+  if (actionTypeGenericName) {
+    actionParamType = factory.createTypeReferenceNode(
+      factory.createIdentifier(actionTypeGenericName),
+      void 0
+    );
+  } else if (action.actionName) {
+    actionParamType = factory.createLiteralTypeNode(
+      factory.createStringLiteral(action.actionName, true)
+    );
+  } else {
+    actionParamType = factory.createKeywordTypeNode(SyntaxKind.StringKeyword);
+  }
+  return [
+    factory.createParameterDeclaration(
+      void 0,
+      void 0,
+      "ctx",
+      void 0,
+      factory.createTypeReferenceNode(`${MOLECULER_NAME}.Context`)
+    ),
+    factory.createParameterDeclaration(
+      void 0,
+      void 0,
+      "action",
+      void 0,
+      actionParamType
+    ),
+    factory.createParameterDeclaration(
+      void 0,
+      void 0,
+      "params",
+      action.params ? void 0 : factory.createToken(SyntaxKind.QuestionToken),
+      cloneNode(action.params, {
+        hook: importMappingCloneHook(importMapping)
+      }) || factory.createKeywordTypeNode(SyntaxKind.UndefinedKeyword)
+    ),
+    factory.createParameterDeclaration(
+      void 0,
+      void 0,
+      "meta",
+      factory.createToken(SyntaxKind.QuestionToken),
+      factory.createTypeReferenceNode(`${MOLECULER_NAME}.CallingOptions`)
+    )
+  ];
+}
+function createWrapperReturnType(action, importMapping) {
+  if (!action.returnType) {
+    return factory.createTypeReferenceNode("Promise", [
+      factory.createKeywordTypeNode(SyntaxKind.VoidKeyword)
+    ]);
+  }
+  if (isTypeReferenceNode(action.returnType) && action.returnType.getSourceFile() && action.returnType.typeName.getText() === "Promise") {
+    return cloneNode(action.returnType, {
+      hook: importMappingCloneHook(importMapping)
+    });
+  }
+  return factory.createTypeReferenceNode("Promise", [
+    cloneNode(action.returnType, {
+      hook: importMappingCloneHook(importMapping)
+    })
+  ]);
+}
+function createUnwrapReturnType(action, importMapping) {
+  if (!action.returnType) {
+    return factory.createKeywordTypeNode(SyntaxKind.VoidKeyword);
+  }
+  if (isTypeReferenceNode(action.returnType) && action.returnType.getSourceFile() && action.returnType.typeName.getText() === "Promise" && action.returnType.typeArguments?.length) {
+    return cloneNode(action.returnType.typeArguments[0], {
+      hook: importMappingCloneHook(importMapping)
+    });
+  }
+  return cloneNode(action.returnType, {
+    hook: importMappingCloneHook(importMapping)
+  });
+}
+function createWrapperTypeParameters(action, importMapping) {
+  if (!action.typeParameters) {
+    return [];
+  }
+  return action.typeParameters.map(
+    (tp) => cloneNode(tp, { hook: importMappingCloneHook(importMapping) })
+  );
+}
+function createWrapperFunctionOverload(action, importMapping, name, actionTypeGenericName, block) {
+  return factory.createFunctionDeclaration(
+    [factory.createModifier(SyntaxKind.ExportKeyword)],
+    void 0,
+    name,
+    createWrapperTypeParameters(action, importMapping),
+    createWrapperParameters(action, importMapping, actionTypeGenericName),
+    createWrapperReturnType(action, importMapping),
+    block
+  );
+}
+function findUnusedTemplateName(action) {
+  const typeNames = new Set(action.typeParameters?.map((t) => t.name.getText()));
+  let actionTemplateName = "N";
+  while (typeNames.has(actionTemplateName)) {
+    actionTemplateName += "N";
+  }
+  return actionTemplateName;
+}
+function buildCallWrapperFile(actions, imports, importMapping) {
+  const stmts = [];
+  let sortedImports = [...imports.keys()].sort();
+  sortedImports = [
+    ...sortedImports.filter((d) => d.startsWith("@")),
+    ...sortedImports.filter((d) => !d.startsWith(".") && !d.startsWith("@")),
+    ...sortedImports.filter((d) => d.startsWith("."))
+  ];
+  for (const importPath of sortedImports) {
+    const importName = imports.get(importPath);
+    stmts.push(
+      factory.createImportDeclaration(
+        void 0,
+        factory.createImportClause(
+          true,
+          void 0,
+          factory.createNamespaceImport(factory.createIdentifier(importName))
+        ),
+        factory.createStringLiteral(importPath, true)
+      )
+    );
+  }
+  const sortedActions = actions.sort(
+    (a, b) => (a.actionName || "").localeCompare(b.actionName || "")
+  );
+  const actionsProperties = [];
+  const actionsNoParamsProperties = [];
+  stmts.push(
+    factory.createInterfaceDeclaration(
+      void 0,
+      factory.createIdentifier(ParamsActions),
+      void 0,
+      void 0,
+      actionsProperties
+    )
+  );
+  stmts.push(
+    factory.createInterfaceDeclaration(
+      void 0,
+      factory.createIdentifier(NoParamsActions),
+      void 0,
+      void 0,
+      actionsNoParamsProperties
+    )
+  );
+  const callTStmts = [];
+  const callStmts = [];
+  for (const action of sortedActions) {
+    if (action.typeParameters?.length) {
+      const templateTypes = createWrapperTypeParameters(action, importMapping);
+      if (action.params) {
+        const actionTemplateName = findUnusedTemplateName(action);
+        action.params = factory.createConditionalTypeNode(
+          factory.createTypeReferenceNode(
+            factory.createIdentifier(actionTemplateName),
+            void 0
+          ),
+          factory.createLiteralTypeNode(
+            factory.createStringLiteral(action.actionName || "", true)
+          ),
+          action.params,
+          factory.createKeywordTypeNode(SyntaxKind.NeverKeyword)
+        );
+        action.typeParameters = factory.createNodeArray([
+          ...templateTypes,
+          factory.createTypeParameterDeclaration(
+            void 0,
+            factory.createIdentifier(actionTemplateName),
+            factory.createKeywordTypeNode(SyntaxKind.StringKeyword),
+            factory.createLiteralTypeNode(
+              factory.createStringLiteral(action.actionName || "", true)
+            )
+          )
+        ]);
+        callTStmts.push(
+          createWrapperFunctionOverload(
+            action,
+            importMapping,
+            "callT",
+            actionTemplateName
+          )
+        );
+      } else {
+        callStmts.push(
+          createWrapperFunctionOverload(action, importMapping, "call")
+        );
+      }
+    } else if (action.params) {
+      actionsProperties.push(
+        factory.createPropertySignature(
+          void 0,
+          factory.createStringLiteral(action.actionName || "", true),
+          void 0,
+          factory.createTupleTypeNode([
+            cloneNode(action.params, {
+              hook: importMappingCloneHook(importMapping)
+            }),
+            createUnwrapReturnType(action, importMapping)
+          ])
+        )
+      );
+    } else {
+      actionsNoParamsProperties.push(
+        factory.createPropertySignature(
+          void 0,
+          factory.createStringLiteral(action.actionName || "", true),
+          void 0,
+          createUnwrapReturnType(action, importMapping)
+        )
+      );
+    }
+  }
+  callStmts.push(
+    createWrapperFunctionOverload(
+      {
+        typeParameters: factory.createNodeArray([
+          factory.createTypeParameterDeclaration(
+            void 0,
+            factory.createIdentifier("N"),
+            factory.createTypeOperatorNode(
+              SyntaxKind.KeyOfKeyword,
+              factory.createTypeReferenceNode(
+                factory.createIdentifier(ParamsActions),
+                void 0
+              )
+            )
+          )
+        ]),
+        params: factory.createIndexedAccessTypeNode(
+          factory.createIndexedAccessTypeNode(
+            factory.createTypeReferenceNode(
+              factory.createIdentifier(ParamsActions)
+            ),
+            factory.createTypeReferenceNode(factory.createIdentifier("N"))
+          ),
+          factory.createLiteralTypeNode(factory.createNumericLiteral("0"))
+        ),
+        returnType: factory.createIndexedAccessTypeNode(
+          factory.createIndexedAccessTypeNode(
+            factory.createTypeReferenceNode(
+              factory.createIdentifier(ParamsActions),
+              void 0
+            ),
+            factory.createTypeReferenceNode(
+              factory.createIdentifier("N"),
+              void 0
+            )
+          ),
+          factory.createLiteralTypeNode(factory.createNumericLiteral("1"))
+        )
+      },
+      importMapping,
+      "call",
+      "N"
+    )
+  );
+  callStmts.push(
+    createWrapperFunctionOverload(
+      {
+        typeParameters: factory.createNodeArray([
+          factory.createTypeParameterDeclaration(
+            void 0,
+            factory.createIdentifier("N"),
+            factory.createTypeOperatorNode(
+              SyntaxKind.KeyOfKeyword,
+              factory.createTypeReferenceNode(
+                factory.createIdentifier(NoParamsActions),
+                void 0
+              )
+            )
+          )
+        ]),
+        returnType: factory.createIndexedAccessTypeNode(
+          factory.createTypeReferenceNode(
+            factory.createIdentifier(NoParamsActions),
+            void 0
+          ),
+          factory.createTypeReferenceNode(
+            factory.createIdentifier("N"),
+            void 0
+          )
+        )
+      },
+      importMapping,
+      "call",
+      "N"
+    )
+  );
+  callStmts.push(
+    createWrapperFunctionOverload(
+      {
+        params: factory.createKeywordTypeNode(SyntaxKind.UnknownKeyword),
+        returnType: factory.createKeywordTypeNode(SyntaxKind.UnknownKeyword)
+      },
+      importMapping,
+      "call",
+      void 0,
+      factory.createBlock(
+        [
+          factory.createReturnStatement(
+            factory.createCallExpression(
+              factory.createPropertyAccessExpression(
+                factory.createIdentifier("ctx"),
+                factory.createIdentifier("call")
+              ),
+              void 0,
+              [
+                factory.createIdentifier("action"),
+                factory.createIdentifier("params"),
+                factory.createIdentifier("meta")
+              ]
+            )
+          )
+        ],
+        true
+      )
+    )
+  );
+  callTStmts.push(
+    createWrapperFunctionOverload(
+      {
+        params: factory.createKeywordTypeNode(SyntaxKind.UnknownKeyword),
+        returnType: factory.createKeywordTypeNode(SyntaxKind.UnknownKeyword)
+      },
+      importMapping,
+      "callT",
+      void 0,
+      factory.createBlock(
+        [
+          factory.createReturnStatement(
+            factory.createCallExpression(
+              factory.createPropertyAccessExpression(
+                factory.createIdentifier("ctx"),
+                factory.createIdentifier("call")
+              ),
+              void 0,
+              [
+                factory.createIdentifier("action"),
+                factory.createIdentifier("params"),
+                factory.createIdentifier("meta")
+              ]
+            )
+          )
+        ],
+        true
+      )
+    )
+  );
+  const printer = createPrinter({ newLine: NewLineKind.LineFeed });
+  const sourceFile = factory.createSourceFile(
+    [...stmts, ...callStmts, ...callTStmts],
+    factory.createToken(SyntaxKind.EndOfFileToken),
+    NodeFlags.Const
+  );
+  let res = printer.printFile(sourceFile);
+  res = res.replace(/interface Actions/, "\ninterface Actions").replace(/export function call/, "\nexport function call").replace(/export function callT/, "\nexport function callT");
+  const eslintIgnoreRules = [
+    "@typescript-eslint/no-explicit-any",
+    "@typescript-eslint/no-unused-vars"
+  ];
+  res = `/* eslint-disable ${eslintIgnoreRules.join(",")} */
+${res}`;
+  return res;
+}
+
+function injectDatabaseMixinV2Builtins(context, actions, service, sourceFile) {
+  const dbMixin = service.originalSchema.mixins?.find(
+    (m) => m.methods?._getDatabaseMixinCollection
+  );
+  if (!dbMixin) {
+    return;
+  }
+  const types = findDatabaseMixinTypes(context, sourceFile);
+  if (!types) {
+    return;
+  }
+  const typeArguments = types.tenantField ? [types.entityType, types.tenantField] : [types.entityType];
+  const version = service.version ? `v${service.version}.` : "";
+  const dbActions = actions.filter((a) => a.actionName?.startsWith(`${version}${service.name}.`)).filter((a) => !a.params || !a.returnType);
+  const importName = addDepToImports(
+    context.imports,
+    "@treatwell/moleculer-essentials"
+  );
+  for (const action of dbActions) {
+    const actionName = action.actionName?.replace(
+      `${version}${service.name}.`,
+      ""
+    );
+    if (!action.params) {
+      switch (actionName) {
+        case "find":
+        case "findStream": {
+          action.params = factory.createTypeReferenceNode(
+            `${importName}.DatabaseActionFindParams`,
+            typeArguments
+          );
+          break;
+        }
+        case "getInternal": {
+          action.params = factory.createTypeReferenceNode(
+            `${importName}.DatabaseActionGetInternalParams`,
+            typeArguments
+          );
+          break;
+        }
+        case "get": {
+          action.params = factory.createTypeReferenceNode(
+            `${importName}.DatabaseActionGetParams`,
+            typeArguments
+          );
+          break;
+        }
+        case "countInternal": {
+          action.params = factory.createTypeReferenceNode(
+            `${importName}.DatabaseActionCountInternalParams`,
+            typeArguments
+          );
+          break;
+        }
+        case "count": {
+          action.params = factory.createTypeReferenceNode(
+            `${importName}.DatabaseActionCountParams`,
+            typeArguments
+          );
+          break;
+        }
+        case "list": {
+          action.params = factory.createTypeReferenceNode(
+            `${importName}.DatabaseActionListParams`,
+            typeArguments
+          );
+          break;
+        }
+        case "create": {
+          action.params = factory.createTypeReferenceNode(
+            `${importName}.DatabaseActionCreateParams`,
+            [types.entityType]
+          );
+          break;
+        }
+        case "update": {
+          action.params = factory.createTypeReferenceNode(
+            `${importName}.DatabaseActionUpdateParams`,
+            typeArguments
+          );
+          break;
+        }
+        case "remove": {
+          action.params = factory.createTypeReferenceNode(
+            `${importName}.DatabaseActionRemoveParams`,
+            typeArguments
+          );
+          break;
+        }
+      }
+    }
+    if (!action.returnType) {
+      switch (actionName) {
+        case "find": {
+          action.returnType = factory.createTypeReferenceNode(
+            `${importName}.DatabaseActionFindResult`,
+            [types.entityType]
+          );
+          break;
+        }
+        case "findStream": {
+          const streamImportName = addDepToImports(context.imports, "stream");
+          action.returnType = factory.createTypeReferenceNode(
+            `${streamImportName}.Readable`
+          );
+          break;
+        }
+        case "countInternal":
+        case "count": {
+          action.returnType = factory.createKeywordTypeNode(
+            SyntaxKind.NumberKeyword
+          );
+          break;
+        }
+        case "list": {
+          action.returnType = factory.createTypeReferenceNode(
+            `${importName}.DatabaseActionListResult`,
+            [types.entityType]
+          );
+          break;
+        }
+        case "create":
+        case "update":
+        case "remove":
+        case "getInternal":
+        case "get": {
+          action.returnType = factory.createTypeReferenceNode(
+            `${importName}.DatabaseActionEntityResult`,
+            [types.entityType]
+          );
+          break;
+        }
+      }
+    }
+  }
+}
+function findDatabaseMixinTypes(context, sourceFile) {
+  let res;
+  function visit(n) {
+    if (!isCallExpression(n) || n.expression.getText() !== "DatabaseMethodsMixin") {
+      n.forEachChild(visit);
+      return;
+    }
+    if (!n.typeArguments?.length) {
+      return;
+    }
+    res = { entityType: n.typeArguments[0], tenantField: n.typeArguments[1] };
+  }
+  visit(sourceFile);
+  if (res) {
+    fillImports(context, sourceFile, res.entityType);
+    if (res.tenantField) {
+      fillImports(context, sourceFile, res.tenantField);
+    }
+  }
+  return res;
+}
+
+async function createWrapperCall(wrapperPath, services, svcFiles, additionalBuiltins) {
+  const currentContent = await readFile(wrapperPath, "utf8");
+  const importMapping = /* @__PURE__ */ new Map();
+  const imports = /* @__PURE__ */ new Map();
+  addDepToImports(imports, "moleculer");
+  const builtins = [injectDatabaseMixinV2Builtins, ...additionalBuiltins];
+  const actions = services.flatMap(
+    (svc, idx) => parseService(
+      {
+        imports,
+        currentFilePath: svcFiles[idx],
+        wrapperPath,
+        importMapping,
+        builtins
+      },
+      svc
+    )
+  );
+  const wrapper = buildCallWrapperFile(actions, imports, importMapping);
+  if (currentContent !== wrapper && wrapper.trim()) {
+    await writeFile(wrapperPath, wrapper);
+  }
+}
+
+export { addDepToImports, createWrapperCall, fillImports };