@clipboard-health/ai-rules 1.6.9 → 1.6.10

package/backend/AGENTS.md

@@ -23,7 +23,7 @@ Send notifications through [Knock](https://docs.knock.app) using the `@clipboard
 
 <embedex source="packages/notifications/examples/usage.md">
 
-## `triggerChunked`
+### `triggerChunked`
 
 `triggerChunked` stores the full, immutable trigger request at job enqueue time, eliminating issues with stale data, chunking requests to stay under provider limits, and idempotency key conflicts that can occur if the request is updated at job execution time.
 
@@ -48,8 +48,8 @@ Send notifications through [Knock](https://docs.knock.app) using the `@clipboard
    import { TRIGGER_NOTIFICATION_JOB_NAME } from "./triggerNotification.constants";
 
    /**
-    * For mongo-jobs, implement HandlerInterface<SerializableTriggerChunkedRequest>.
-    * For background-jobs-postgres, implement Handler<SerializableTriggerChunkedRequest>.
+    * For mongo-jobs, implement `HandlerInterface<SerializableTriggerChunkedRequest>`.
+    * For background-jobs-postgres, implement `Handler<SerializableTriggerChunkedRequest>`.
     */
    export class TriggerNotificationJob implements BaseHandler<SerializableTriggerChunkedRequest> {
      public name = TRIGGER_NOTIFICATION_JOB_NAME;
@@ -63,6 +63,10 @@ Send notifications through [Knock](https://docs.knock.app) using the `@clipboard
 
      public async perform(
        data: SerializableTriggerChunkedRequest,
+       /**
+        * For mongo-jobs, implement `BackgroundJobType<SerializableTriggerChunkedRequest>`, which has _id, attemptsCount, and uniqueKey.
+        * For background-jobs-postgres, implement `Job<SerializableTriggerChunkedRequest>`, which has id, retryAttempts, and idempotencyKey.
+        */
        job: { _id: string; attemptsCount: number; uniqueKey?: string },
      ) {
        const metadata = {
@@ -72,7 +76,7 @@ Send notifications through [Knock](https://docs.knock.app) using the `@clipboard
          recipientCount: data.body.recipients.length,
          workflowKey: data.workflowKey,
        };
-       this.logger.info("Processing", metadata);
+       this.logger.info("TriggerNotificationJob processing", metadata);
 
        try {
          const request = toTriggerChunkedRequest(data, {
@@ -85,9 +89,11 @@ Send notifications through [Knock](https://docs.knock.app) using the `@clipboard
            throw result.error;
          }
 
-         this.logger.info("Success", { ...metadata, response: result.value });
+         const success = "TriggerNotificationJob success";
+         this.logger.info(success, { ...metadata, response: result.value });
+         // For background-jobs-postgres, return the `success` string result.
        } catch (error) {
-         this.logger.error("Failure", { ...metadata, error });
+         this.logger.error("TriggerNotificationJob failure", { ...metadata, error });
          throw error;
        }
      }

package/fullstack/AGENTS.md

@@ -23,7 +23,7 @@ Send notifications through [Knock](https://docs.knock.app) using the `@clipboard
 
 <embedex source="packages/notifications/examples/usage.md">
 
-## `triggerChunked`
+### `triggerChunked`
 
 `triggerChunked` stores the full, immutable trigger request at job enqueue time, eliminating issues with stale data, chunking requests to stay under provider limits, and idempotency key conflicts that can occur if the request is updated at job execution time.
 
@@ -48,8 +48,8 @@ Send notifications through [Knock](https://docs.knock.app) using the `@clipboard
    import { TRIGGER_NOTIFICATION_JOB_NAME } from "./triggerNotification.constants";
 
    /**
-    * For mongo-jobs, implement HandlerInterface<SerializableTriggerChunkedRequest>.
-    * For background-jobs-postgres, implement Handler<SerializableTriggerChunkedRequest>.
+    * For mongo-jobs, implement `HandlerInterface<SerializableTriggerChunkedRequest>`.
+    * For background-jobs-postgres, implement `Handler<SerializableTriggerChunkedRequest>`.
     */
    export class TriggerNotificationJob implements BaseHandler<SerializableTriggerChunkedRequest> {
      public name = TRIGGER_NOTIFICATION_JOB_NAME;
@@ -63,6 +63,10 @@ Send notifications through [Knock](https://docs.knock.app) using the `@clipboard
 
      public async perform(
        data: SerializableTriggerChunkedRequest,
+       /**
+        * For mongo-jobs, implement `BackgroundJobType<SerializableTriggerChunkedRequest>`, which has _id, attemptsCount, and uniqueKey.
+        * For background-jobs-postgres, implement `Job<SerializableTriggerChunkedRequest>`, which has id, retryAttempts, and idempotencyKey.
+        */
        job: { _id: string; attemptsCount: number; uniqueKey?: string },
      ) {
        const metadata = {
@@ -72,7 +76,7 @@ Send notifications through [Knock](https://docs.knock.app) using the `@clipboard
          recipientCount: data.body.recipients.length,
          workflowKey: data.workflowKey,
        };
-       this.logger.info("Processing", metadata);
+       this.logger.info("TriggerNotificationJob processing", metadata);
 
        try {
          const request = toTriggerChunkedRequest(data, {
@@ -85,9 +89,11 @@ Send notifications through [Knock](https://docs.knock.app) using the `@clipboard
            throw result.error;
          }
 
-         this.logger.info("Success", { ...metadata, response: result.value });
+         const success = "TriggerNotificationJob success";
+         this.logger.info(success, { ...metadata, response: result.value });
+         // For background-jobs-postgres, return the `success` string result.
        } catch (error) {
-         this.logger.error("Failure", { ...metadata, error });
+         this.logger.error("TriggerNotificationJob failure", { ...metadata, error });
          throw error;
        }
      }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@clipboard-health/ai-rules",
   "description": "Pre-built AI agent rules for consistent coding standards.",
-  "version": "1.6.9",
+  "version": "1.6.10",
   "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
   "devDependencies": {
     "@intellectronica/ruler": "0.3.21"