@living-architecture/riviere-extract-conventions 0.4.3 → 0.4.5

package/dist/{interfaces.d.ts → component-contracts.d.ts}

@@ -64,4 +64,13 @@ export interface UIPageDef {
 export interface DomainOpContainerDef {
     readonly __brand?: 'DomainOpContainerDef';
 }
-//# sourceMappingURL=interfaces.d.ts.map
+/**
+ * Marker interface for event publisher classes.
+ * Classes implementing this interface publish domain events via typed methods.
+ * Each public method should have exactly one parameter whose type implements EventDef.
+ * The parameter type name is matched against Event component metadata.eventName.
+ */
+export interface EventPublisherDef {
+    readonly __brand?: 'EventPublisherDef';
+}
+//# sourceMappingURL=component-contracts.d.ts.map

package/dist/component-contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-contracts.d.ts","sourceRoot":"","sources":["../src/component-contracts.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAA;AAEpE;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAA;CAC5B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAC;AAEjD;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAAE,QAAQ,CAAC,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAA;CAAC;AAE/E;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM,GAAG,OAAO;IAC7C,QAAQ,CAAC,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAA;IAC5C,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAC9B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,SAAS;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAC;AAEnD;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,sBAAsB,CAAA;CAAC;AAEjF;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAA;CAAC"}

package/dist/decorators.d.ts

@@ -17,6 +17,10 @@ export declare function APIContainer<T>(target: T, _: ClassDecoratorContext): T;
  * Marks a class as a container where all public methods are event handlers.
  */
 export declare function EventHandlerContainer<T>(target: T, _: ClassDecoratorContext): T;
+/**
+ * Marks a class as a container where all public methods are event publishers.
+ */
+export declare function EventPublisherContainer<T>(target: T, _: ClassDecoratorContext): T;
 /**
  * Marks a class as a use case component.
  */

package/dist/decorators.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../src/decorators.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,KAAK,MAAM,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAA;AAM7C;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,qBAAqB,GAAG,CAAC,CAE3E;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,qBAAqB,GAAG,CAAC,CAEtE;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,qBAAqB,GAAG,CAAC,CAE/E;AAMD;;GAEG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,qBAAqB,GAAG,CAAC,CAEjE;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,qBAAqB,GAAG,CAAC,CAE/D;AAED;;GAEG;AACH,wBAAgB,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,qBAAqB,GAAG,CAAC,CAE5D;AAMD;;GAEG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,2BAA2B,GAAG,CAAC,CAEvF;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,2BAA2B,GAAG,CAAC,CAE1F;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,2BAA2B,GAAG,CAAC,CAE3F;AASD;;;;;GAKG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,MAAM,GACX,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,qBAAqB,GAAG,2BAA2B,KAAK,CAAC,CAgBnF;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,qBAAqB,GAAG,2BAA2B,GAAG,CAAC,CAE9F;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAQjE"}
+{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../src/decorators.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,KAAK,MAAM,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAA;AAM7C;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,qBAAqB,GAAG,CAAC,CAE3E;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,qBAAqB,GAAG,CAAC,CAEtE;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,qBAAqB,GAAG,CAAC,CAE/E;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,qBAAqB,GAAG,CAAC,CAEjF;AAMD;;GAEG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,qBAAqB,GAAG,CAAC,CAEjE;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,qBAAqB,GAAG,CAAC,CAE/D;AAED;;GAEG;AACH,wBAAgB,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,qBAAqB,GAAG,CAAC,CAE5D;AAMD;;GAEG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,2BAA2B,GAAG,CAAC,CAEvF;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,2BAA2B,GAAG,CAAC,CAE1F;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,2BAA2B,GAAG,CAAC,CAE3F;AASD;;;;;GAKG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,MAAM,GACX,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,qBAAqB,GAAG,2BAA2B,KAAK,CAAC,CAgBnF;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,qBAAqB,GAAG,2BAA2B,GAAG,CAAC,CAE9F;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAQjE"}

package/dist/decorators.js

@@ -25,6 +25,12 @@ export function APIContainer(target, _) {
 export function EventHandlerContainer(target, _) {
     return target;
 }
+/**
+ * Marks a class as a container where all public methods are event publishers.
+ */
+export function EventPublisherContainer(target, _) {
+    return target;
+}
 // ============================================================================
 // Class-as-Component Decorators
 // ============================================================================

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export { DomainOpContainer, APIContainer, EventHandlerContainer, UseCase, Event, UI, DomainOp, APIEndpoint, EventHandler, Custom, Ignore, getCustomType, } from './decorators';
-export type { HttpMethod, APIControllerDef, EventDef, EventHandlerDef, IEventHandler, UIPageDef, DomainOpContainerDef, } from './interfaces';
+export { DomainOpContainer, APIContainer, EventHandlerContainer, EventPublisherContainer, UseCase, Event, UI, DomainOp, APIEndpoint, EventHandler, Custom, Ignore, getCustomType, } from './decorators';
+export type { HttpMethod, APIControllerDef, EventDef, EventHandlerDef, IEventHandler, UIPageDef, DomainOpContainerDef, EventPublisherDef, } from './component-contracts';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,iBAAiB,EACjB,YAAY,EACZ,qBAAqB,EAErB,OAAO,EACP,KAAK,EACL,EAAE,EAEF,QAAQ,EACR,WAAW,EACX,YAAY,EAEZ,MAAM,EACN,MAAM,EAEN,aAAa,GACd,MAAM,cAAc,CAAA;AAGrB,YAAY,EACV,UAAU,EACV,gBAAgB,EAChB,QAAQ,EACR,eAAe,EACf,aAAa,EACb,SAAS,EACT,oBAAoB,GACrB,MAAM,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,iBAAiB,EACjB,YAAY,EACZ,qBAAqB,EACrB,uBAAuB,EAEvB,OAAO,EACP,KAAK,EACL,EAAE,EAEF,QAAQ,EACR,WAAW,EACX,YAAY,EAEZ,MAAM,EACN,MAAM,EAEN,aAAa,GACd,MAAM,cAAc,CAAA;AAGrB,YAAY,EACV,UAAU,EACV,gBAAgB,EAChB,QAAQ,EACR,eAAe,EACf,aAAa,EACb,SAAS,EACT,oBAAoB,EACpB,iBAAiB,GAClB,MAAM,uBAAuB,CAAA"}

package/dist/index.js

@@ -1,6 +1,6 @@
 export { 
 // Container decorators
-DomainOpContainer, APIContainer, EventHandlerContainer, 
+DomainOpContainer, APIContainer, EventHandlerContainer, EventPublisherContainer, 
 // Class-as-component decorators
 UseCase, Event, UI, 
 // Method-level decorators

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@living-architecture/riviere-extract-conventions",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "type": "module",
   "publishConfig": {
     "access": "public"
@@ -32,6 +32,6 @@
     "!**/*.tsbuildinfo"
   ],
   "dependencies": {
-    "@living-architecture/riviere-extract-config": "0.4.2"
+    "@living-architecture/riviere-extract-config": "0.4.3"
   }
 }

package/src/default-extraction.config.json

@@ -67,6 +67,20 @@
           "subscribedEvents": { "fromGenericArg": { "interface": "IEventHandler", "position": 0 } }
         }
       },
+      "eventPublisher": {
+        "find": "methods",
+        "where": {
+          "inClassWith": {
+            "hasDecorator": {
+              "name": "EventPublisherContainer",
+              "from": "@living-architecture/riviere-extract-conventions"
+            }
+          }
+        },
+        "extract": {
+          "publishedEventType": { "fromParameterType": { "position": 0 } }
+        }
+      },
       "ui": {
         "find": "classes",
         "where": {

package/src/eslint/event-publisher-method-signature.cjs

@@ -0,0 +1,179 @@
+const { implementsInterface } = require('./interface-ast-predicates.cjs')
+
+let getParserServices = null
+try {
+  getParserServices = require('@typescript-eslint/utils').ESLintUtils.getParserServices
+/* v8 ignore next -- soft-require: package always present in this repo */
+} catch { /* type checking unavailable */ }
+
+function getTypeReferenceName(typeAnnotation) {
+  const typeName = typeAnnotation.typeName
+  if (typeName.type === 'TSQualifiedName') {
+    return typeName.right.name
+  }
+  return typeName.name
+}
+
+function checkEventDefShape(checker, services, param, typeAnnotation) {
+  if (!checker || !services) return null
+
+  const tsParam = services.esTreeNodeToTSNodeMap.get(param)
+  const paramType = checker.getTypeAtLocation(tsParam)
+  const typeProperty = paramType.getProperty('type')
+  const referenceName = getTypeReferenceName(typeAnnotation)
+
+  if (!typeProperty) {
+    return referenceName
+  }
+
+  const typePropertyType = checker.getTypeOfSymbol(typeProperty)
+  const stringType = checker.getStringType()
+  if (!checker.isTypeAssignableTo(typePropertyType, stringType)) {
+    return referenceName
+  }
+
+  return null
+}
+
+function checkMethod(context, member, className, checker, services) {
+  const methodName = member.key.name
+
+  if (member.accessibility === 'private' || member.accessibility === 'protected') {
+    context.report({
+      node: member.key,
+      messageId: 'nonPublicMethod',
+      data: {
+        methodName,
+        className,
+        accessibility: member.accessibility,
+      },
+    })
+    return
+  }
+
+  const params = member.value.params
+
+  if (params.length === 0) {
+    context.report({
+      node: member.key,
+      messageId: 'missingParameter',
+      data: {
+        methodName,
+        className,
+      },
+    })
+    return
+  }
+
+  if (params.length > 1) {
+    context.report({
+      node: member.key,
+      messageId: 'tooManyParameters',
+      data: {
+        methodName,
+        className,
+      },
+    })
+    return
+  }
+
+  const param = params[0]
+  const typeAnnotation = param.typeAnnotation && param.typeAnnotation.typeAnnotation
+
+  if (!typeAnnotation) {
+    context.report({
+      node: member.key,
+      messageId: 'missingTypeAnnotation',
+      data: {
+        methodName,
+        className,
+      },
+    })
+    return
+  }
+
+  if (typeAnnotation.type !== 'TSTypeReference') {
+    context.report({
+      node: member.key,
+      messageId: 'notTypeReference',
+      data: {
+        methodName,
+        className,
+      },
+    })
+    return
+  }
+
+  const failedTypeName = checkEventDefShape(checker, services, param, typeAnnotation)
+  if (failedTypeName) {
+    context.report({
+      node: member.key,
+      messageId: 'notEventDef',
+      data: {
+        typeName: failedTypeName,
+        methodName,
+        className,
+      },
+    })
+  }
+}
+
+function isMethodToCheck(member) {
+  return (
+    member.type === 'MethodDefinition' &&
+    member.kind !== 'constructor' &&
+    member.kind !== 'get' &&
+    member.kind !== 'set'
+  )
+}
+
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Require EventPublisherDef methods to have exactly one EventDef-typed parameter',
+      requiresTypeChecking: true,
+      examples: {
+        valid: "class OrderPublisher implements EventPublisherDef { publish(event: OrderPlacedEvent): void {} }",
+        invalid: "class OrderPublisher implements EventPublisherDef { publish(): void {} }",
+      },
+    },
+    schema: [],
+    messages: {
+      missingParameter: "Method '{{methodName}}' on EventPublisherDef class '{{className}}' must have exactly one parameter",
+      tooManyParameters: "Method '{{methodName}}' on EventPublisherDef class '{{className}}' must have exactly one parameter",
+      missingTypeAnnotation: "Parameter of method '{{methodName}}' on EventPublisherDef class '{{className}}' must have a type annotation",
+      notTypeReference: "Parameter of method '{{methodName}}' on EventPublisherDef class '{{className}}' must have a type reference annotation",
+      notEventDef: "Parameter type '{{typeName}}' of method '{{methodName}}' on EventPublisherDef class '{{className}}' does not implement EventDef (missing 'type: string' property)",
+      nonPublicMethod: "Method '{{methodName}}' on EventPublisherDef class '{{className}}' must be public, but is {{accessibility}}",
+    },
+  },
+  create(context) {
+    let services = null
+    let checker = null
+    /* v8 ignore start -- graceful degradation: getParserServices always available in this repo */
+    if (getParserServices) {
+      try {
+        services = getParserServices(context, true)
+        checker = services.program?.getTypeChecker() ?? null
+      } catch { /* no type info */ }
+    }
+    /* v8 ignore stop */
+
+    return {
+      ClassDeclaration(node) {
+        /* v8 ignore next -- ClassDeclaration always has id (name) */
+        if (!node.id) return
+        if (!implementsInterface(node, 'EventPublisherDef')) return
+
+        const className = node.id.name
+
+        for (const member of node.body.body) {
+          if (isMethodToCheck(member)) {
+            checkMethod(context, member, className, checker, services)
+          }
+        }
+      },
+    }
+  },
+}

package/src/eslint/event-publisher-method-signature.d.cts

@@ -0,0 +1,6 @@
+import type { TSESLint } from '@typescript-eslint/utils'
+
+type MessageIds = 'missingParameter' | 'tooManyParameters' | 'missingTypeAnnotation' | 'notTypeReference' | 'notEventDef' | 'nonPublicMethod'
+
+declare const rule: TSESLint.RuleModule<MessageIds>
+export default rule

package/src/eslint/index.cjs

@@ -3,6 +3,7 @@ const apiControllerRequiresRouteAndMethod = require('./api-controller-requires-r
 const eventRequiresTypeProperty = require('./event-requires-type-property.cjs')
 const eventHandlerRequiresSubscribedEvents = require('./event-handler-requires-subscribed-events.cjs')
 const uiPageRequiresRoute = require('./ui-page-requires-route.cjs')
+const eventPublisherMethodSignature = require('./event-publisher-method-signature.cjs')
 
 module.exports = {
   rules: {
@@ -11,5 +12,6 @@ module.exports = {
     'event-requires-type-property': eventRequiresTypeProperty,
     'event-handler-requires-subscribed-events': eventHandlerRequiresSubscribedEvents,
     'ui-page-requires-route': uiPageRequiresRoute,
+    'event-publisher-method-signature': eventPublisherMethodSignature,
   },
 }

package/src/eslint/require-component-decorator.cjs

@@ -2,6 +2,7 @@ const COMPONENT_DECORATORS = [
   'DomainOpContainer',
   'APIContainer',
   'EventHandlerContainer',
+  'EventPublisherContainer',
   'UseCase',
   'Event',
   'UI',
@@ -35,7 +36,7 @@ module.exports = {
     schema: [],
     messages: {
       missingDecorator:
-        "Class '{{className}}' requires a component decorator. Add one of: @UseCase, @Event, @UI, @DomainOpContainer, @APIContainer, @EventHandlerContainer, @Custom('type'), or @Ignore",
+        "Class '{{className}}' requires a component decorator. Add one of: @UseCase, @Event, @UI, @DomainOpContainer, @APIContainer, @EventHandlerContainer, @EventPublisherContainer, @Custom('type'), or @Ignore",
     },
   },
   create(context) {

package/dist/interfaces.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAA;AAEpE;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAA;CAC5B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAC;AAEjD;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAAE,QAAQ,CAAC,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAA;CAAC;AAE/E;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM,GAAG,OAAO;IAC7C,QAAQ,CAAC,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAA;IAC5C,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAC9B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,SAAS;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAC;AAEnD;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,sBAAsB,CAAA;CAAC"}