@clipboard-health/ai-rules 1.6.8 → 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/datamodeling/AGENTS.md

@@ -89,7 +89,7 @@ These define our modeling rules, patterns, and safety constraints.
 - DEVIN ONLY: When running dbt commands in the data-modeling repository, always reuse the existing SNOWFLAKE_SCHEMA environment variable value that is already set. Do NOT replace it with a hardcoded value like "dbt_devin" - the SNOWFLAKE_SCHEMA is set to a unique per-session string and overwriting it will cause issues.
 - Use `dbt build` to verify your changes.
 - ALL dbt staging models must have strictly defined datatypes. Please Read the "Casting DBT Staging Model Datatype Heuristic" Knowledge we have. These datatypes need to defined in the yaml documentation too.
-- Use doc blocks for any YAML column descriptions that span across more than one model. Do NOT repeat descriptions for the same column - please reuse a doc-block!
+- Always use doc blocks for YAML column descriptions (reference `models/docs.md`). Reuse existing doc blocks instead of duplicating descriptions for the same column across multiple models.
 - When adding new fields to tables keep the original source field name format, but remove any custom field prefix (**c). For example assignment_type**c should be renamed to assignment_type. Please do not hallucinate the column field names as this is misleading for users.
 - If a source table doesn't exist. Please tell the user to ask the data-team to ingest it via the relevant ETL tool.
 - A model must always have a primary/unique key. If there's no obvious one, please create a surrogate key using a combination of fields and by looking at the data. Use `dbt_utils.generate_surrogate_key` to do so.
@@ -110,7 +110,7 @@ These define our modeling rules, patterns, and safety constraints.
 - At least one column must be the primary key. This column should have both the `not_null` and `unique` tests.
 - Every column must include:
   - A `name`
-  - A `description`. Use a doc-block if the column already exists in the `docs.md` file. If you see the same column being referenced more than once in the repo, create a doc-block for it.
+  - A `description`. Always use doc blocks for YAML column descriptions (reference `models/docs.md`). Reuse existing doc blocks instead of duplicating descriptions for the same column across multiple models. If they don't already exist, make them.
   - A `data_type`.
   - Include a newline between columns
 - Ensure proper YAML formatting and indentation.

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.8",
+  "version": "1.6.10",
   "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
   "devDependencies": {
     "@intellectronica/ruler": "0.3.21"