@twin.org/messaging-connector-entity-storage 0.0.2-next.6 → 0.0.3-next.2

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 (35) hide show
  1. package/dist/es/entities/emailEntry.js +75 -0
  2. package/dist/es/entities/emailEntry.js.map +1 -0
  3. package/dist/es/entities/pushNotificationDeviceEntry.js +59 -0
  4. package/dist/es/entities/pushNotificationDeviceEntry.js.map +1 -0
  5. package/dist/es/entities/pushNotificationMessageEntry.js +67 -0
  6. package/dist/es/entities/pushNotificationMessageEntry.js.map +1 -0
  7. package/dist/es/entities/smsEntry.js +59 -0
  8. package/dist/es/entities/smsEntry.js.map +1 -0
  9. package/dist/es/entityStorageMessagingEmailConnector.js +83 -0
  10. package/dist/es/entityStorageMessagingEmailConnector.js.map +1 -0
  11. package/dist/es/entityStorageMessagingPushNotificationConnector.js +114 -0
  12. package/dist/es/entityStorageMessagingPushNotificationConnector.js.map +1 -0
  13. package/dist/es/entityStorageMessagingSmsConnector.js +74 -0
  14. package/dist/es/entityStorageMessagingSmsConnector.js.map +1 -0
  15. package/dist/es/index.js +14 -0
  16. package/dist/es/index.js.map +1 -0
  17. package/dist/es/models/IEntityStorageMessagingEmailConnectorConstructorOptions.js +4 -0
  18. package/dist/es/models/IEntityStorageMessagingEmailConnectorConstructorOptions.js.map +1 -0
  19. package/dist/es/models/IEntityStorageMessagingPushNotificationConnectorConstructorOptions.js +4 -0
  20. package/dist/es/models/IEntityStorageMessagingPushNotificationConnectorConstructorOptions.js.map +1 -0
  21. package/dist/es/models/IEntityStorageMessagingSmsConnectorConstructorOptions.js +4 -0
  22. package/dist/es/models/IEntityStorageMessagingSmsConnectorConstructorOptions.js.map +1 -0
  23. package/dist/es/schema.js +27 -0
  24. package/dist/es/schema.js.map +1 -0
  25. package/dist/types/entityStorageMessagingEmailConnector.d.ts +6 -1
  26. package/dist/types/entityStorageMessagingPushNotificationConnector.d.ts +6 -1
  27. package/dist/types/entityStorageMessagingSmsConnector.d.ts +6 -1
  28. package/dist/types/index.d.ts +11 -11
  29. package/docs/changelog.md +41 -0
  30. package/docs/reference/classes/EntityStorageMessagingEmailConnector.md +18 -0
  31. package/docs/reference/classes/EntityStorageMessagingPushNotificationConnector.md +18 -0
  32. package/docs/reference/classes/EntityStorageMessagingSmsConnector.md +18 -0
  33. package/package.json +7 -10
  34. package/dist/cjs/index.cjs +0 -528
  35. package/dist/esm/index.mjs +0 -523
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IEntityStorageMessagingPushNotificationConnectorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IEntityStorageMessagingPushNotificationConnectorConstructorOptions.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Options for the entity storage messaging push notification connector.\n */\nexport interface IEntityStorageMessagingPushNotificationConnectorConstructorOptions {\n\t/**\n\t * The type of logging component to use, defaults to no logging.\n\t */\n\tloggingComponentType?: string;\n\n\t/**\n\t * The type of entity storage connector to use for the push notifications entries.\n\t * @default push-notification-device-entry\n\t */\n\tmessagingDeviceEntryStorageConnectorType?: string;\n\n\t/**\n\t * The type of entity storage connector to use for the push notifications entries.\n\t * @default push-notification-message-entry\n\t */\n\tmessagingMessageEntryStorageConnectorType?: string;\n}\n"]}
@@ -0,0 +1,4 @@
1
+ // Copyright 2024 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ export {};
4
+ //# sourceMappingURL=IEntityStorageMessagingSmsConnectorConstructorOptions.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IEntityStorageMessagingSmsConnectorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IEntityStorageMessagingSmsConnectorConstructorOptions.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Options for the entity storage messaging SMS connector.\n */\nexport interface IEntityStorageMessagingSmsConnectorConstructorOptions {\n\t/**\n\t * The type of logging component to use, defaults to no logging.\n\t */\n\tloggingComponentType?: string;\n\n\t/**\n\t * The type of entity storage connector to use for the sms entries.\n\t * @default sms-entry\n\t */\n\tmessagingSmsEntryStorageConnectorType?: string;\n}\n"]}
@@ -0,0 +1,27 @@
1
+ // Copyright 2024 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ import { EntitySchemaFactory, EntitySchemaHelper } from "@twin.org/entity";
4
+ import { EmailEntry } from "./entities/emailEntry.js";
5
+ import { PushNotificationDeviceEntry } from "./entities/pushNotificationDeviceEntry.js";
6
+ import { PushNotificationMessageEntry } from "./entities/pushNotificationMessageEntry.js";
7
+ import { SmsEntry } from "./entities/smsEntry.js";
8
+ /**
9
+ * Initialize the schema for the messaging connector entity storage.
10
+ * @param options The options for the initialisation.
11
+ * @param options.email Should we register email schemas.
12
+ * @param options.sms Should we register sms schemas.
13
+ * @param options.pushNotification Should we register push notification schemas.
14
+ */
15
+ export function initSchema(options) {
16
+ if (options?.email ?? true) {
17
+ EntitySchemaFactory.register("EmailEntry", () => EntitySchemaHelper.getSchema(EmailEntry));
18
+ }
19
+ if (options?.pushNotification ?? true) {
20
+ EntitySchemaFactory.register("PushNotificationDeviceEntry", () => EntitySchemaHelper.getSchema(PushNotificationDeviceEntry));
21
+ EntitySchemaFactory.register("PushNotificationMessageEntry", () => EntitySchemaHelper.getSchema(PushNotificationMessageEntry));
22
+ }
23
+ if (options?.sms ?? true) {
24
+ EntitySchemaFactory.register("SmsEntry", () => EntitySchemaHelper.getSchema(SmsEntry));
25
+ }
26
+ }
27
+ //# sourceMappingURL=schema.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/schema.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE3E,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAC;AACxF,OAAO,EAAE,4BAA4B,EAAE,MAAM,4CAA4C,CAAC;AAC1F,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAElD;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,OAI1B;IACA,IAAI,OAAO,EAAE,KAAK,IAAI,IAAI,EAAE,CAAC;QAC5B,mBAAmB,CAAC,QAAQ,eAAuB,GAAG,EAAE,CACvD,kBAAkB,CAAC,SAAS,CAAC,UAAU,CAAC,CACxC,CAAC;IACH,CAAC;IAED,IAAI,OAAO,EAAE,gBAAgB,IAAI,IAAI,EAAE,CAAC;QACvC,mBAAmB,CAAC,QAAQ,gCAAwC,GAAG,EAAE,CACxE,kBAAkB,CAAC,SAAS,CAAC,2BAA2B,CAAC,CACzD,CAAC;QACF,mBAAmB,CAAC,QAAQ,iCAAyC,GAAG,EAAE,CACzE,kBAAkB,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAC1D,CAAC;IACH,CAAC;IAED,IAAI,OAAO,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;QAC1B,mBAAmB,CAAC,QAAQ,aAAqB,GAAG,EAAE,CAAC,kBAAkB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChG,CAAC;AACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { EntitySchemaFactory, EntitySchemaHelper } from \"@twin.org/entity\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { EmailEntry } from \"./entities/emailEntry.js\";\nimport { PushNotificationDeviceEntry } from \"./entities/pushNotificationDeviceEntry.js\";\nimport { PushNotificationMessageEntry } from \"./entities/pushNotificationMessageEntry.js\";\nimport { SmsEntry } from \"./entities/smsEntry.js\";\n\n/**\n * Initialize the schema for the messaging connector entity storage.\n * @param options The options for the initialisation.\n * @param options.email Should we register email schemas.\n * @param options.sms Should we register sms schemas.\n * @param options.pushNotification Should we register push notification schemas.\n */\nexport function initSchema(options?: {\n\temail?: boolean;\n\tsms?: boolean;\n\tpushNotification?: boolean;\n}): void {\n\tif (options?.email ?? true) {\n\t\tEntitySchemaFactory.register(nameof<EmailEntry>(), () =>\n\t\t\tEntitySchemaHelper.getSchema(EmailEntry)\n\t\t);\n\t}\n\n\tif (options?.pushNotification ?? true) {\n\t\tEntitySchemaFactory.register(nameof<PushNotificationDeviceEntry>(), () =>\n\t\t\tEntitySchemaHelper.getSchema(PushNotificationDeviceEntry)\n\t\t);\n\t\tEntitySchemaFactory.register(nameof<PushNotificationMessageEntry>(), () =>\n\t\t\tEntitySchemaHelper.getSchema(PushNotificationMessageEntry)\n\t\t);\n\t}\n\n\tif (options?.sms ?? true) {\n\t\tEntitySchemaFactory.register(nameof<SmsEntry>(), () => EntitySchemaHelper.getSchema(SmsEntry));\n\t}\n}\n"]}
@@ -1,5 +1,5 @@
1
1
  import type { IMessagingEmailConnector } from "@twin.org/messaging-models";
2
- import type { IEntityStorageMessagingEmailConnectorConstructorOptions } from "./models/IEntityStorageMessagingEmailConnectorConstructorOptions";
2
+ import type { IEntityStorageMessagingEmailConnectorConstructorOptions } from "./models/IEntityStorageMessagingEmailConnectorConstructorOptions.js";
3
3
  /**
4
4
  * Class for connecting to the email messaging operations of the Entity Storage.
5
5
  */
@@ -17,6 +17,11 @@ export declare class EntityStorageMessagingEmailConnector implements IMessagingE
17
17
  * @param options The options for the connector.
18
18
  */
19
19
  constructor(options?: IEntityStorageMessagingEmailConnectorConstructorOptions);
20
+ /**
21
+ * Returns the class name of the component.
22
+ * @returns The class name of the component.
23
+ */
24
+ className(): string;
20
25
  /**
21
26
  * Store a custom email using Entity Storage.
22
27
  * @param sender The sender email address.
@@ -1,5 +1,5 @@
1
1
  import type { IMessagingPushNotificationsConnector } from "@twin.org/messaging-models";
2
- import type { IEntityStorageMessagingPushNotificationConnectorConstructorOptions } from "./models/IEntityStorageMessagingPushNotificationConnectorConstructorOptions";
2
+ import type { IEntityStorageMessagingPushNotificationConnectorConstructorOptions } from "./models/IEntityStorageMessagingPushNotificationConnectorConstructorOptions.js";
3
3
  /**
4
4
  * Class for connecting to the push notifications messaging operations of the Entity Storage.
5
5
  */
@@ -17,6 +17,11 @@ export declare class EntityStorageMessagingPushNotificationConnector implements
17
17
  * @param options The options for the connector.
18
18
  */
19
19
  constructor(options?: IEntityStorageMessagingPushNotificationConnectorConstructorOptions);
20
+ /**
21
+ * Returns the class name of the component.
22
+ * @returns The class name of the component.
23
+ */
24
+ className(): string;
20
25
  /**
21
26
  * Registers a device to an specific app in order to send notifications to it.
22
27
  * @param applicationId The application address.
@@ -1,5 +1,5 @@
1
1
  import type { IMessagingSmsConnector } from "@twin.org/messaging-models";
2
- import type { IEntityStorageMessagingSmsConnectorConstructorOptions } from "./models/IEntityStorageMessagingSmsConnectorConstructorOptions";
2
+ import type { IEntityStorageMessagingSmsConnectorConstructorOptions } from "./models/IEntityStorageMessagingSmsConnectorConstructorOptions.js";
3
3
  /**
4
4
  * Class for connecting to the SMS messaging operations of the Entity Storage.
5
5
  */
@@ -17,6 +17,11 @@ export declare class EntityStorageMessagingSmsConnector implements IMessagingSms
17
17
  * @param options The options for the connector.
18
18
  */
19
19
  constructor(options?: IEntityStorageMessagingSmsConnectorConstructorOptions);
20
+ /**
21
+ * Returns the class name of the component.
22
+ * @returns The class name of the component.
23
+ */
24
+ className(): string;
20
25
  /**
21
26
  * Send a SMS message to a phone number.
22
27
  * @param phoneNumber The recipient phone number.
@@ -1,11 +1,11 @@
1
- export * from "./entities/emailEntry";
2
- export * from "./entities/pushNotificationDeviceEntry";
3
- export * from "./entities/pushNotificationMessageEntry";
4
- export * from "./entities/smsEntry";
5
- export * from "./entityStorageMessagingEmailConnector";
6
- export * from "./entityStorageMessagingPushNotificationConnector";
7
- export * from "./entityStorageMessagingSmsConnector";
8
- export * from "./models/IEntityStorageMessagingEmailConnectorConstructorOptions";
9
- export * from "./models/IEntityStorageMessagingPushNotificationConnectorConstructorOptions";
10
- export * from "./models/IEntityStorageMessagingSmsConnectorConstructorOptions";
11
- export * from "./schema";
1
+ export * from "./entities/emailEntry.js";
2
+ export * from "./entities/pushNotificationDeviceEntry.js";
3
+ export * from "./entities/pushNotificationMessageEntry.js";
4
+ export * from "./entities/smsEntry.js";
5
+ export * from "./entityStorageMessagingEmailConnector.js";
6
+ export * from "./entityStorageMessagingPushNotificationConnector.js";
7
+ export * from "./entityStorageMessagingSmsConnector.js";
8
+ export * from "./models/IEntityStorageMessagingEmailConnectorConstructorOptions.js";
9
+ export * from "./models/IEntityStorageMessagingPushNotificationConnectorConstructorOptions.js";
10
+ export * from "./models/IEntityStorageMessagingSmsConnectorConstructorOptions.js";
11
+ export * from "./schema.js";
package/docs/changelog.md CHANGED
@@ -1,5 +1,46 @@
1
1
  # @twin.org/messaging-connector-entity-storage - Changelog
2
2
 
3
+ ## [0.0.3-next.2](https://github.com/twinfoundation/messaging/compare/messaging-connector-entity-storage-v0.0.3-next.1...messaging-connector-entity-storage-v0.0.3-next.2) (2026-01-20)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **messaging-connector-entity-storage:** Synchronize repo versions
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/messaging-models bumped from 0.0.3-next.1 to 0.0.3-next.2
16
+
17
+ ## [0.0.3-next.1](https://github.com/twinfoundation/messaging/compare/messaging-connector-entity-storage-v0.0.3-next.0...messaging-connector-entity-storage-v0.0.3-next.1) (2025-11-11)
18
+
19
+
20
+ ### Features
21
+
22
+ * add context id features ([#24](https://github.com/twinfoundation/messaging/issues/24)) ([42b94e8](https://github.com/twinfoundation/messaging/commit/42b94e8be32c86db6afc5ccf5e9ff2c93d15d05d))
23
+ * add messaging admin component ([cbaaca3](https://github.com/twinfoundation/messaging/commit/cbaaca34db6a9f5c51438c201535b4b43a1aea1f))
24
+ * add validate-locales ([5eeff9b](https://github.com/twinfoundation/messaging/commit/5eeff9b9bf6cecf93b249b56c4bb74b4c5bf86c9))
25
+ * Entity Storage email connector init ([#2](https://github.com/twinfoundation/messaging/issues/2)) ([65b344d](https://github.com/twinfoundation/messaging/commit/65b344de0d2d3d557d921e3d32e263dcb04ee9b3))
26
+ * eslint migration to flat config ([faa02ec](https://github.com/twinfoundation/messaging/commit/faa02ec0ef450db88b08e938415e40cf13625d15))
27
+ * update dependencies ([53dcde6](https://github.com/twinfoundation/messaging/commit/53dcde60d6efaee5957296f6d097cb97c0fb2f9d))
28
+ * update framework core ([fc476b4](https://github.com/twinfoundation/messaging/commit/fc476b48e6075de0ae871e3cec1fa179aa04b5eb))
29
+ * use shared store mechanism ([#8](https://github.com/twinfoundation/messaging/issues/8)) ([9ad65c2](https://github.com/twinfoundation/messaging/commit/9ad65c239ba77bb75604a1f6e51b975357f3228d))
30
+
31
+
32
+ ### Bug Fixes
33
+
34
+ * Adding format to the MessagingEntries ts number ([8b99d4f](https://github.com/twinfoundation/messaging/commit/8b99d4f01c4f2b08da8d2affc1b9554fcb0d3690))
35
+ * Make SMS entry error property optional ([#5](https://github.com/twinfoundation/messaging/issues/5)) ([e0faf83](https://github.com/twinfoundation/messaging/commit/e0faf83e028a2c5dc45a5e8ba1a546013e4a3c8c))
36
+
37
+
38
+ ### Dependencies
39
+
40
+ * The following workspace dependencies were updated
41
+ * dependencies
42
+ * @twin.org/messaging-models bumped from 0.0.3-next.0 to 0.0.3-next.1
43
+
3
44
  ## [0.0.2-next.6](https://github.com/twinfoundation/messaging/compare/messaging-connector-entity-storage-v0.0.2-next.5...messaging-connector-entity-storage-v0.0.2-next.6) (2025-10-09)
4
45
 
5
46
 
@@ -44,6 +44,24 @@ Runtime name for the class.
44
44
 
45
45
  ## Methods
46
46
 
47
+ ### className()
48
+
49
+ > **className**(): `string`
50
+
51
+ Returns the class name of the component.
52
+
53
+ #### Returns
54
+
55
+ `string`
56
+
57
+ The class name of the component.
58
+
59
+ #### Implementation of
60
+
61
+ `IMessagingEmailConnector.className`
62
+
63
+ ***
64
+
47
65
  ### sendCustomEmail()
48
66
 
49
67
  > **sendCustomEmail**(`sender`, `recipients`, `subject`, `content`): `Promise`\<`boolean`\>
@@ -44,6 +44,24 @@ Runtime name for the class.
44
44
 
45
45
  ## Methods
46
46
 
47
+ ### className()
48
+
49
+ > **className**(): `string`
50
+
51
+ Returns the class name of the component.
52
+
53
+ #### Returns
54
+
55
+ `string`
56
+
57
+ The class name of the component.
58
+
59
+ #### Implementation of
60
+
61
+ `IMessagingPushNotificationsConnector.className`
62
+
63
+ ***
64
+
47
65
  ### registerDevice()
48
66
 
49
67
  > **registerDevice**(`applicationId`, `deviceToken`): `Promise`\<`string`\>
@@ -44,6 +44,24 @@ Runtime name for the class.
44
44
 
45
45
  ## Methods
46
46
 
47
+ ### className()
48
+
49
+ > **className**(): `string`
50
+
51
+ Returns the class name of the component.
52
+
53
+ #### Returns
54
+
55
+ `string`
56
+
57
+ The class name of the component.
58
+
59
+ #### Implementation of
60
+
61
+ `IMessagingSmsConnector.className`
62
+
63
+ ***
64
+
47
65
  ### sendSMS()
48
66
 
49
67
  > **sendSMS**(`phoneNumber`, `message`): `Promise`\<`boolean`\>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/messaging-connector-entity-storage",
3
- "version": "0.0.2-next.6",
3
+ "version": "0.0.3-next.2",
4
4
  "description": "Messaging connector implementation using the Entity Storage",
5
5
  "repository": {
6
6
  "type": "git",
@@ -17,23 +17,20 @@
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.2-next.6",
20
+ "@twin.org/messaging-models": "0.0.3-next.2",
21
21
  "@twin.org/nameof": "next"
22
22
  },
23
- "main": "./dist/cjs/index.cjs",
24
- "module": "./dist/esm/index.mjs",
23
+ "main": "./dist/es/index.js",
25
24
  "types": "./dist/types/index.d.ts",
26
25
  "exports": {
27
26
  ".": {
28
27
  "types": "./dist/types/index.d.ts",
29
- "require": "./dist/cjs/index.cjs",
30
- "import": "./dist/esm/index.mjs"
31
- },
32
- "./locales": "./locales"
28
+ "import": "./dist/es/index.js",
29
+ "default": "./dist/es/index.js"
30
+ }
33
31
  },
34
32
  "files": [
35
- "dist/cjs",
36
- "dist/esm",
33
+ "dist/es",
37
34
  "dist/types",
38
35
  "locales",
39
36
  "docs"