@clipboard-health/notifications 2.5.14 → 2.5.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +3 -3
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -22,7 +22,7 @@ Send notifications through third-party providers.
22
22
  });
23
23
  ```
24
24
 
25
- 2. Add types and the job name to the module's logic directory if it exists, else module root:
25
+ 2. Add types and the job name to the module's logic directory if it exists, else module root. You MUST create and use the `...DataJob` and `...DataEnqueue` types:
26
26
 
27
27
  ```ts
28
28
  import { type NotificationData } from "@clipboard-health/notifications";
@@ -84,14 +84,14 @@ Send notifications through third-party providers.
84
84
  workflowKey: data.workflowKey,
85
85
  });
86
86
  } catch (error) {
87
- this.logger.error("Failed", { error, data });
87
+ this.logger.error("Failure", { error, data });
88
88
  throw error;
89
89
  }
90
90
  }
91
91
  }
92
92
  ```
93
93
 
94
- 4. Search the service for a constant that stores workflow keys. If there isn't one, create and export it:
94
+ 4. Search the service for a constant that stores workflow keys. If there isn't one, create and export it. You MUST insert the key in alphabetical order:
95
95
 
96
96
  ```ts
97
97
  export const WORKFLOW_KEYS = {
package/package.json CHANGED
@@ -1,17 +1,17 @@
1
1
  {
2
2
  "name": "@clipboard-health/notifications",
3
3
  "description": "Send notifications through third-party providers.",
4
- "version": "2.5.14",
4
+ "version": "2.5.17",
5
5
  "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
6
6
  "dependencies": {
7
- "@clipboard-health/background-jobs-adapter": "1.5.14",
8
- "@clipboard-health/phone-number": "1.5.14",
9
- "@clipboard-health/util-ts": "4.5.14",
7
+ "@clipboard-health/background-jobs-adapter": "1.5.17",
8
+ "@clipboard-health/phone-number": "1.5.17",
9
+ "@clipboard-health/util-ts": "4.5.17",
10
10
  "@knocklabs/node": "1.24.0",
11
11
  "tslib": "2.8.1"
12
12
  },
13
13
  "devDependencies": {
14
- "@clipboard-health/testing-core": "1.5.14",
14
+ "@clipboard-health/testing-core": "1.5.17",
15
15
  "type-fest": "5.3.1"
16
16
  },
17
17
  "keywords": [],