@twin.org/messaging-connector-entity-storage 0.0.1-next.3 → 0.0.1-next.5

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 (18) hide show
  1. package/dist/cjs/index.cjs +280 -258
  2. package/dist/esm/index.mjs +277 -255
  3. package/dist/types/entityStorageMessagingEmailConnector.d.ts +4 -0
  4. package/dist/types/entityStorageMessagingPushNotificationConnector.d.ts +4 -0
  5. package/dist/types/entityStorageMessagingSmsConnector.d.ts +4 -0
  6. package/dist/types/index.d.ts +4 -0
  7. package/dist/types/schema.d.ts +9 -1
  8. package/docs/changelog.md +1 -1
  9. package/docs/reference/classes/EmailEntry.md +77 -0
  10. package/docs/reference/classes/EntityStorageMessagingEmailConnector.md +8 -0
  11. package/docs/reference/classes/EntityStorageMessagingPushNotificationConnector.md +8 -0
  12. package/docs/reference/classes/EntityStorageMessagingSmsConnector.md +8 -0
  13. package/docs/reference/classes/PushNotificationDeviceEntry.md +61 -0
  14. package/docs/reference/classes/PushNotificationMessageEntry.md +69 -0
  15. package/docs/reference/classes/SmsEntry.md +61 -0
  16. package/docs/reference/functions/initSchema.md +19 -1
  17. package/docs/reference/index.md +4 -0
  18. package/package.json +2 -2
package/docs/reference/classes/EntityStorageMessagingEmailConnector.md CHANGED
@@ -34,6 +34,14 @@ The type of entity storage connector to use for the email entries, defaults to "
34
34
 
35
35
  ## Properties
36
36
 
37
+ ### NAMESPACE
38
+
39
+ > `readonly` `static` **NAMESPACE**: `string` = `"entity-storage"`
40
+
41
+ The namespace for the connector.
42
+
43
+ ***
44
+
37
45
  ### CLASS\_NAME
38
46
 
39
47
  > `readonly` **CLASS\_NAME**: `string`
package/docs/reference/classes/EntityStorageMessagingPushNotificationConnector.md CHANGED
@@ -38,6 +38,14 @@ The type of entity storage connector to use for the push notifications entries,
38
38
 
39
39
  ## Properties
40
40
 
41
+ ### NAMESPACE
42
+
43
+ > `readonly` `static` **NAMESPACE**: `string` = `"entity-storage"`
44
+
45
+ The namespace for the connector.
46
+
47
+ ***
48
+
41
49
  ### CLASS\_NAME
42
50
 
43
51
  > `readonly` **CLASS\_NAME**: `string`
package/docs/reference/classes/EntityStorageMessagingSmsConnector.md CHANGED
@@ -34,6 +34,14 @@ The type of entity storage connector to use for the sms entries, defaults to "sm
34
34
 
35
35
  ## Properties
36
36
 
37
+ ### NAMESPACE
38
+
39
+ > `readonly` `static` **NAMESPACE**: `string` = `"entity-storage"`
40
+
41
+ The namespace for the connector.
42
+
43
+ ***
44
+
37
45
  ### CLASS\_NAME
38
46
 
39
47
  > `readonly` **CLASS\_NAME**: `string`
package/docs/reference/classes/PushNotificationDeviceEntry.md ADDED
@@ -0,0 +1,61 @@
1
+ # Class: PushNotificationDeviceEntry
2
+
3
+ Call defining an push notification device entry.
4
+
5
+ ## Constructors
6
+
7
+ ### new PushNotificationDeviceEntry()
8
+
9
+ > **new PushNotificationDeviceEntry**(): [`PushNotificationDeviceEntry`](PushNotificationDeviceEntry.md)
10
+
11
+ #### Returns
12
+
13
+ [`PushNotificationDeviceEntry`](PushNotificationDeviceEntry.md)
14
+
15
+ ## Properties
16
+
17
+ ### id
18
+
19
+ > **id**: `string`
20
+
21
+ The id.
22
+
23
+ ***
24
+
25
+ ### applicationId
26
+
27
+ > **applicationId**: `string`
28
+
29
+ The applicationId.
30
+
31
+ ***
32
+
33
+ ### deviceToken
34
+
35
+ > **deviceToken**: `string`
36
+
37
+ The device token.
38
+
39
+ ***
40
+
41
+ ### ts
42
+
43
+ > **ts**: `number`
44
+
45
+ The timestamp of the push notification device entry.
46
+
47
+ ***
48
+
49
+ ### status
50
+
51
+ > **status**: `string`
52
+
53
+ The status.
54
+
55
+ ***
56
+
57
+ ### error?
58
+
59
+ > `optional` **error**: `IError`
60
+
61
+ The error.
package/docs/reference/classes/PushNotificationMessageEntry.md ADDED
@@ -0,0 +1,69 @@
1
+ # Class: PushNotificationMessageEntry
2
+
3
+ Call defining an push notification message entry.
4
+
5
+ ## Constructors
6
+
7
+ ### new PushNotificationMessageEntry()
8
+
9
+ > **new PushNotificationMessageEntry**(): [`PushNotificationMessageEntry`](PushNotificationMessageEntry.md)
10
+
11
+ #### Returns
12
+
13
+ [`PushNotificationMessageEntry`](PushNotificationMessageEntry.md)
14
+
15
+ ## Properties
16
+
17
+ ### id
18
+
19
+ > **id**: `string`
20
+
21
+ The id.
22
+
23
+ ***
24
+
25
+ ### deviceAddress
26
+
27
+ > **deviceAddress**: `string`
28
+
29
+ The device address.
30
+
31
+ ***
32
+
33
+ ### title
34
+
35
+ > **title**: `string`
36
+
37
+ The title.
38
+
39
+ ***
40
+
41
+ ### message
42
+
43
+ > **message**: `string`
44
+
45
+ The message.
46
+
47
+ ***
48
+
49
+ ### ts
50
+
51
+ > **ts**: `number`
52
+
53
+ The timestamp of the push notification entry.
54
+
55
+ ***
56
+
57
+ ### status
58
+
59
+ > **status**: `string`
60
+
61
+ The status.
62
+
63
+ ***
64
+
65
+ ### error?
66
+
67
+ > `optional` **error**: `IError`
68
+
69
+ The error.
package/docs/reference/classes/SmsEntry.md ADDED
@@ -0,0 +1,61 @@
1
+ # Class: SmsEntry
2
+
3
+ Call defining an sms entry.
4
+
5
+ ## Constructors
6
+
7
+ ### new SmsEntry()
8
+
9
+ > **new SmsEntry**(): [`SmsEntry`](SmsEntry.md)
10
+
11
+ #### Returns
12
+
13
+ [`SmsEntry`](SmsEntry.md)
14
+
15
+ ## Properties
16
+
17
+ ### id
18
+
19
+ > **id**: `string`
20
+
21
+ The id.
22
+
23
+ ***
24
+
25
+ ### phoneNumber
26
+
27
+ > **phoneNumber**: `string`
28
+
29
+ The phone number to deliver the message.
30
+
31
+ ***
32
+
33
+ ### ts
34
+
35
+ > **ts**: `number`
36
+
37
+ The timestamp of the sms entry.
38
+
39
+ ***
40
+
41
+ ### message
42
+
43
+ > **message**: `string`
44
+
45
+ The message.
46
+
47
+ ***
48
+
49
+ ### status
50
+
51
+ > **status**: `string`
52
+
53
+ The status.
54
+
55
+ ***
56
+
57
+ ### error?
58
+
59
+ > `optional` **error**: `IError`
60
+
61
+ The error.
package/docs/reference/functions/initSchema.md CHANGED
@@ -1,9 +1,27 @@
1
1
  # Function: initSchema()
2
2
 
3
- > **initSchema**(): `void`
3
+ > **initSchema**(`options`?): `void`
4
4
 
5
5
  Initialize the schema for the messaging connector entity storage.
6
6
 
7
+ ## Parameters
8
+
9
+ • **options?**
10
+
11
+ The options for the initialisation.
12
+
13
+ • **options.email?**: `boolean`
14
+
15
+ Should we register email schemas.
16
+
17
+ • **options.sms?**: `boolean`
18
+
19
+ Should we register sms schemas.
20
+
21
+ • **options.pushNotification?**: `boolean`
22
+
23
+ Should we register push notification schemas.
24
+
7
25
  ## Returns
8
26
 
9
27
  `void`
package/docs/reference/index.md CHANGED
@@ -2,6 +2,10 @@
2
2
 
3
3
  ## Classes
4
4
 
5
+ - [EmailEntry](classes/EmailEntry.md)
6
+ - [PushNotificationDeviceEntry](classes/PushNotificationDeviceEntry.md)
7
+ - [PushNotificationMessageEntry](classes/PushNotificationMessageEntry.md)
8
+ - [SmsEntry](classes/SmsEntry.md)
5
9
  - [EntityStorageMessagingEmailConnector](classes/EntityStorageMessagingEmailConnector.md)
6
10
  - [EntityStorageMessagingPushNotificationConnector](classes/EntityStorageMessagingPushNotificationConnector.md)
7
11
  - [EntityStorageMessagingSmsConnector](classes/EntityStorageMessagingSmsConnector.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/messaging-connector-entity-storage",
3
- "version": "0.0.1-next.3",
3
+ "version": "0.0.1-next.5",
4
4
  "description": "Messaging connector implementation using the Entity Storage",
5
5
  "repository": {
6
6
  "type": "git",
@@ -17,7 +17,7 @@
17
17
  "@twin.org/core": "next",
18
18
  "@twin.org/entity": "next",
19
19
  "@twin.org/logging-models": "next",
20
- "@twin.org/messaging-models": "0.0.1-next.3",
20
+ "@twin.org/messaging-models": "0.0.1-next.5",
21
21
  "@twin.org/nameof": "next"
22
22
  },
23
23
  "main": "./dist/cjs/index.cjs",