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

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Messaging Connector Entity Storage
 
-Messaging connector implementation using the Entity Storage.
+This package provides connectors that persist and manage messaging operations using entity storage.
 
 ## Installation
 
@@ -8,16 +8,6 @@ Messaging connector implementation using the Entity Storage.
 npm install @twin.org/messaging-connector-entity-storage
 ```
 
-## Testing
-
-The tests developed are functional tests.
-
-You can run the tests as follows:
-
-```sh
-npm run test
-```
-
 ## Examples
 
 Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)

package/dist/es/entityStorageMessagingPushNotificationConnector.js.map

@@ -1 +1 @@
-{"version":3,"file":"entityStorageMessagingPushNotificationConnector.js","sourceRoot":"","sources":["../../src/entityStorageMessagingPushNotificationConnector.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACjG,OAAO,EACN,6BAA6B,EAE7B,MAAM,iCAAiC,CAAC;AAQzC;;GAEG;AACH,MAAM,OAAO,+CAA+C;IAG3D;;OAEG;IACI,MAAM,CAAU,SAAS,GAAW,gBAAgB,CAAC;IAE5D;;OAEG;IACI,MAAM,CAAU,UAAU,qDAC0B;IAE3D;;;OAGG;IACgB,QAAQ,CAAqB;IAEhD;;;OAGG;IACc,4BAA4B,CAAuD;IAEpG;;;OAGG;IACc,6BAA6B,CAAwD;IAEtG;;;OAGG;IACH,YAAY,OAA4E;QACvF,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,WAAW,CAAC,OAAO,EAAE,oBAAoB,IAAI,SAAS,CAAC,CAAC;QACzF,IAAI,CAAC,4BAA4B,GAAG,6BAA6B,CAAC,GAAG,CACpE,OAAO,EAAE,wCAAwC,oCACF,CAC/C,CAAC;QACF,IAAI,CAAC,6BAA6B,GAAG,6BAA6B,CAAC,GAAG,CACrE,OAAO,EAAE,yCAAyC,qCACF,CAChD,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,+CAA+C,CAAC,UAAU,CAAC;IACnE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CAAC,aAAqB,EAAE,WAAmB;QACrE,MAAM,CAAC,WAAW,CACjB,+CAA+C,CAAC,UAAU,mBAE1D,aAAa,CACb,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,+CAA+C,CAAC,UAAU,iBAE1D,WAAW,CACX,CAAC;QACF,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;gBACxB,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,+CAA+C,CAAC,UAAU;gBAClE,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,OAAO,EAAE,mBAAmB;aAC5B,CAAC,CAAC;YAEH,MAAM,EAAE,GAAG,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;YAE3D,MAAM,MAAM,GAAgC;gBAC3C,EAAE;gBACF,aAAa;gBACb,WAAW;gBACX,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,MAAM,EAAE,SAAS;aACjB,CAAC;YAEF,MAAM,IAAI,CAAC,4BAA4B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACpD,OAAO,EAAE,CAAC;QACX,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,YAAY,CACrB,+CAA+C,CAAC,UAAU,EAC1D,2BAA2B,EAC3B,EAAE,QAAQ,EAAE,eAAe,EAAE,KAAK,EAAE,aAAa,EAAE,EACnD,GAAG,CACH,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,0BAA0B,CACtC,aAAqB,EACrB,KAAa,EACb,OAAe;QAEf,MAAM,CAAC,WAAW,CACjB,+CAA+C,CAAC,UAAU,mBAE1D,aAAa,CACb,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,+CAA+C,CAAC,UAAU,WAE1D,KAAK,CACL,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,+CAA+C,CAAC,UAAU,aAE1D,OAAO,CACP,CAAC;QACF,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;gBACxB,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,+CAA+C,CAAC,UAAU;gBAClE,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,OAAO,EAAE,yBAAyB;aAClC,CAAC,CAAC;YAEH,MAAM,EAAE,GAAG,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;YAE3D,MAAM,MAAM,GAAiC;gBAC5C,EAAE;gBACF,aAAa;gBACb,KAAK;gBACL,OAAO;gBACP,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,MAAM,EAAE,SAAS;aACjB,CAAC;YAEF,MAAM,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACrD,OAAO,IAAI,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,YAAY,CACrB,+CAA+C,CAAC,UAAU,EAC1D,4BAA4B,EAC5B,EAAE,KAAK,EAAE,aAAa,EAAE,EACxB,GAAG,CACH,CAAC;QACH,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ComponentFactory, Converter, GeneralError, Guards, RandomHelper } from \"@twin.org/core\";\nimport {\n\tEntityStorageConnectorFactory,\n\ttype IEntityStorageConnector\n} from \"@twin.org/entity-storage-models\";\nimport type { ILoggingComponent } from \"@twin.org/logging-models\";\nimport type { IMessagingPushNotificationsConnector } from \"@twin.org/messaging-models\";\nimport { nameof, nameofKebabCase } from \"@twin.org/nameof\";\nimport type { PushNotificationDeviceEntry } from \"./entities/pushNotificationDeviceEntry.js\";\nimport type { PushNotificationMessageEntry } from \"./entities/pushNotificationMessageEntry.js\";\nimport type { IEntityStorageMessagingPushNotificationConnectorConstructorOptions } from \"./models/IEntityStorageMessagingPushNotificationConnectorConstructorOptions.js\";\n\n/**\n * Class for connecting to the push notifications messaging operations of the Entity Storage.\n */\nexport class EntityStorageMessagingPushNotificationConnector\n\timplements IMessagingPushNotificationsConnector\n{\n\t/**\n\t * The namespace for the connector.\n\t */\n\tpublic static readonly NAMESPACE: string = \"entity-storage\";\n\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string =\n\t\tnameof<EntityStorageMessagingPushNotificationConnector>();\n\n\t/**\n\t * The logging component.\n\t * @internal\n\t */\n\tprotected readonly _logging?: ILoggingComponent;\n\n\t/**\n\t * The entity storage for the push notifications device entries.\n\t * @internal\n\t */\n\tprivate readonly _messagingDeviceEntryStorage: IEntityStorageConnector<PushNotificationDeviceEntry>;\n\n\t/**\n\t * The entity storage for the push notifications message entries.\n\t * @internal\n\t */\n\tprivate readonly _messagingMessageEntryStorage: IEntityStorageConnector<PushNotificationMessageEntry>;\n\n\t/**\n\t * Create a new instance of EntityStorageMessagingPushNotificationConnector.\n\t * @param options The options for the connector.\n\t */\n\tconstructor(options?: IEntityStorageMessagingPushNotificationConnectorConstructorOptions) {\n\t\tthis._logging = ComponentFactory.getIfExists(options?.loggingComponentType ?? \"logging\");\n\t\tthis._messagingDeviceEntryStorage = EntityStorageConnectorFactory.get(\n\t\t\toptions?.messagingDeviceEntryStorageConnectorType ??\n\t\t\t\tnameofKebabCase<PushNotificationDeviceEntry>()\n\t\t);\n\t\tthis._messagingMessageEntryStorage = EntityStorageConnectorFactory.get(\n\t\t\toptions?.messagingMessageEntryStorageConnectorType ??\n\t\t\t\tnameofKebabCase<PushNotificationMessageEntry>()\n\t\t);\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn EntityStorageMessagingPushNotificationConnector.CLASS_NAME;\n\t}\n\n\t/**\n\t * Registers a device to an specific app in order to send notifications to it.\n\t * @param applicationId The application address.\n\t * @param deviceToken The device token.\n\t * @returns If the device was registered successfully.\n\t */\n\tpublic async registerDevice(applicationId: string, deviceToken: string): Promise<string> {\n\t\tGuards.stringValue(\n\t\t\tEntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\tnameof(applicationId),\n\t\t\tapplicationId\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tEntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\tnameof(deviceToken),\n\t\t\tdeviceToken\n\t\t);\n\t\ttry {\n\t\t\tawait this._logging?.log({\n\t\t\t\tlevel: \"info\",\n\t\t\t\tsource: EntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\t\tts: Date.now(),\n\t\t\t\tmessage: \"deviceRegistering\"\n\t\t\t});\n\n\t\t\tconst id = Converter.bytesToHex(RandomHelper.generate(32));\n\n\t\t\tconst entity: PushNotificationDeviceEntry = {\n\t\t\t\tid,\n\t\t\t\tapplicationId,\n\t\t\t\tdeviceToken,\n\t\t\t\tts: Date.now(),\n\t\t\t\tstatus: \"pending\"\n\t\t\t};\n\n\t\t\tawait this._messagingDeviceEntryStorage.set(entity);\n\t\t\treturn id;\n\t\t} catch (err) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tEntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\t\t\"deviceTokenRegisterFailed\",\n\t\t\t\t{ property: \"applicationId\", value: applicationId },\n\t\t\t\terr\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Send a push notification to a device.\n\t * @param deviceAddress The address of the device.\n\t * @param title The title of the notification.\n\t * @param message The message to send.\n\t * @returns If the notification was sent successfully.\n\t */\n\tpublic async sendSinglePushNotification(\n\t\tdeviceAddress: string,\n\t\ttitle: string,\n\t\tmessage: string\n\t): Promise<boolean> {\n\t\tGuards.stringValue(\n\t\t\tEntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\tnameof(deviceAddress),\n\t\t\tdeviceAddress\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tEntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\tnameof(title),\n\t\t\ttitle\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tEntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\tnameof(message),\n\t\t\tmessage\n\t\t);\n\t\ttry {\n\t\t\tawait this._logging?.log({\n\t\t\t\tlevel: \"info\",\n\t\t\t\tsource: EntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\t\tts: Date.now(),\n\t\t\t\tmessage: \"pushNotificationSending\"\n\t\t\t});\n\n\t\t\tconst id = Converter.bytesToHex(RandomHelper.generate(32));\n\n\t\t\tconst entity: PushNotificationMessageEntry = {\n\t\t\t\tid,\n\t\t\t\tdeviceAddress,\n\t\t\t\ttitle,\n\t\t\t\tmessage,\n\t\t\t\tts: Date.now(),\n\t\t\t\tstatus: \"pending\"\n\t\t\t};\n\n\t\t\tawait this._messagingMessageEntryStorage.set(entity);\n\t\t\treturn true;\n\t\t} catch (err) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tEntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\t\t\"sendPushNotificationFailed\",\n\t\t\t\t{ value: deviceAddress },\n\t\t\t\terr\n\t\t\t);\n\t\t}\n\t}\n}\n"]}
+{"version":3,"file":"entityStorageMessagingPushNotificationConnector.js","sourceRoot":"","sources":["../../src/entityStorageMessagingPushNotificationConnector.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACjG,OAAO,EACN,6BAA6B,EAE7B,MAAM,iCAAiC,CAAC;AAQzC;;GAEG;AACH,MAAM,OAAO,+CAA+C;IAC3D;;OAEG;IACI,MAAM,CAAU,SAAS,GAAW,gBAAgB,CAAC;IAE5D;;OAEG;IACI,MAAM,CAAU,UAAU,qDAC0B;IAE3D;;;OAGG;IACgB,QAAQ,CAAqB;IAEhD;;;OAGG;IACc,4BAA4B,CAAuD;IAEpG;;;OAGG;IACc,6BAA6B,CAAwD;IAEtG;;;OAGG;IACH,YAAY,OAA4E;QACvF,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,WAAW,CAAC,OAAO,EAAE,oBAAoB,IAAI,SAAS,CAAC,CAAC;QACzF,IAAI,CAAC,4BAA4B,GAAG,6BAA6B,CAAC,GAAG,CACpE,OAAO,EAAE,wCAAwC,oCACF,CAC/C,CAAC;QACF,IAAI,CAAC,6BAA6B,GAAG,6BAA6B,CAAC,GAAG,CACrE,OAAO,EAAE,yCAAyC,qCACF,CAChD,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,+CAA+C,CAAC,UAAU,CAAC;IACnE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CAAC,aAAqB,EAAE,WAAmB;QACrE,MAAM,CAAC,WAAW,CACjB,+CAA+C,CAAC,UAAU,mBAE1D,aAAa,CACb,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,+CAA+C,CAAC,UAAU,iBAE1D,WAAW,CACX,CAAC;QACF,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;gBACxB,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,+CAA+C,CAAC,UAAU;gBAClE,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,OAAO,EAAE,mBAAmB;aAC5B,CAAC,CAAC;YAEH,MAAM,EAAE,GAAG,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;YAE3D,MAAM,MAAM,GAAgC;gBAC3C,EAAE;gBACF,aAAa;gBACb,WAAW;gBACX,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,MAAM,EAAE,SAAS;aACjB,CAAC;YAEF,MAAM,IAAI,CAAC,4BAA4B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACpD,OAAO,EAAE,CAAC;QACX,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,YAAY,CACrB,+CAA+C,CAAC,UAAU,EAC1D,2BAA2B,EAC3B,EAAE,QAAQ,EAAE,eAAe,EAAE,KAAK,EAAE,aAAa,EAAE,EACnD,GAAG,CACH,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,0BAA0B,CACtC,aAAqB,EACrB,KAAa,EACb,OAAe;QAEf,MAAM,CAAC,WAAW,CACjB,+CAA+C,CAAC,UAAU,mBAE1D,aAAa,CACb,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,+CAA+C,CAAC,UAAU,WAE1D,KAAK,CACL,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,+CAA+C,CAAC,UAAU,aAE1D,OAAO,CACP,CAAC;QACF,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;gBACxB,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,+CAA+C,CAAC,UAAU;gBAClE,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,OAAO,EAAE,yBAAyB;aAClC,CAAC,CAAC;YAEH,MAAM,EAAE,GAAG,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;YAE3D,MAAM,MAAM,GAAiC;gBAC5C,EAAE;gBACF,aAAa;gBACb,KAAK;gBACL,OAAO;gBACP,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,MAAM,EAAE,SAAS;aACjB,CAAC;YAEF,MAAM,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACrD,OAAO,IAAI,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,YAAY,CACrB,+CAA+C,CAAC,UAAU,EAC1D,4BAA4B,EAC5B,EAAE,KAAK,EAAE,aAAa,EAAE,EACxB,GAAG,CACH,CAAC;QACH,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ComponentFactory, Converter, GeneralError, Guards, RandomHelper } from \"@twin.org/core\";\nimport {\n\tEntityStorageConnectorFactory,\n\ttype IEntityStorageConnector\n} from \"@twin.org/entity-storage-models\";\nimport type { ILoggingComponent } from \"@twin.org/logging-models\";\nimport type { IMessagingPushNotificationsConnector } from \"@twin.org/messaging-models\";\nimport { nameof, nameofKebabCase } from \"@twin.org/nameof\";\nimport type { PushNotificationDeviceEntry } from \"./entities/pushNotificationDeviceEntry.js\";\nimport type { PushNotificationMessageEntry } from \"./entities/pushNotificationMessageEntry.js\";\nimport type { IEntityStorageMessagingPushNotificationConnectorConstructorOptions } from \"./models/IEntityStorageMessagingPushNotificationConnectorConstructorOptions.js\";\n\n/**\n * Class for connecting to the push notifications messaging operations of the Entity Storage.\n */\nexport class EntityStorageMessagingPushNotificationConnector implements IMessagingPushNotificationsConnector {\n\t/**\n\t * The namespace for the connector.\n\t */\n\tpublic static readonly NAMESPACE: string = \"entity-storage\";\n\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string =\n\t\tnameof<EntityStorageMessagingPushNotificationConnector>();\n\n\t/**\n\t * The logging component.\n\t * @internal\n\t */\n\tprotected readonly _logging?: ILoggingComponent;\n\n\t/**\n\t * The entity storage for the push notifications device entries.\n\t * @internal\n\t */\n\tprivate readonly _messagingDeviceEntryStorage: IEntityStorageConnector<PushNotificationDeviceEntry>;\n\n\t/**\n\t * The entity storage for the push notifications message entries.\n\t * @internal\n\t */\n\tprivate readonly _messagingMessageEntryStorage: IEntityStorageConnector<PushNotificationMessageEntry>;\n\n\t/**\n\t * Create a new instance of EntityStorageMessagingPushNotificationConnector.\n\t * @param options The options for the connector.\n\t */\n\tconstructor(options?: IEntityStorageMessagingPushNotificationConnectorConstructorOptions) {\n\t\tthis._logging = ComponentFactory.getIfExists(options?.loggingComponentType ?? \"logging\");\n\t\tthis._messagingDeviceEntryStorage = EntityStorageConnectorFactory.get(\n\t\t\toptions?.messagingDeviceEntryStorageConnectorType ??\n\t\t\t\tnameofKebabCase<PushNotificationDeviceEntry>()\n\t\t);\n\t\tthis._messagingMessageEntryStorage = EntityStorageConnectorFactory.get(\n\t\t\toptions?.messagingMessageEntryStorageConnectorType ??\n\t\t\t\tnameofKebabCase<PushNotificationMessageEntry>()\n\t\t);\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn EntityStorageMessagingPushNotificationConnector.CLASS_NAME;\n\t}\n\n\t/**\n\t * Registers a device to an specific app in order to send notifications to it.\n\t * @param applicationId The application address.\n\t * @param deviceToken The device token.\n\t * @returns If the device was registered successfully.\n\t */\n\tpublic async registerDevice(applicationId: string, deviceToken: string): Promise<string> {\n\t\tGuards.stringValue(\n\t\t\tEntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\tnameof(applicationId),\n\t\t\tapplicationId\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tEntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\tnameof(deviceToken),\n\t\t\tdeviceToken\n\t\t);\n\t\ttry {\n\t\t\tawait this._logging?.log({\n\t\t\t\tlevel: \"info\",\n\t\t\t\tsource: EntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\t\tts: Date.now(),\n\t\t\t\tmessage: \"deviceRegistering\"\n\t\t\t});\n\n\t\t\tconst id = Converter.bytesToHex(RandomHelper.generate(32));\n\n\t\t\tconst entity: PushNotificationDeviceEntry = {\n\t\t\t\tid,\n\t\t\t\tapplicationId,\n\t\t\t\tdeviceToken,\n\t\t\t\tts: Date.now(),\n\t\t\t\tstatus: \"pending\"\n\t\t\t};\n\n\t\t\tawait this._messagingDeviceEntryStorage.set(entity);\n\t\t\treturn id;\n\t\t} catch (err) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tEntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\t\t\"deviceTokenRegisterFailed\",\n\t\t\t\t{ property: \"applicationId\", value: applicationId },\n\t\t\t\terr\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Send a push notification to a device.\n\t * @param deviceAddress The address of the device.\n\t * @param title The title of the notification.\n\t * @param message The message to send.\n\t * @returns If the notification was sent successfully.\n\t */\n\tpublic async sendSinglePushNotification(\n\t\tdeviceAddress: string,\n\t\ttitle: string,\n\t\tmessage: string\n\t): Promise<boolean> {\n\t\tGuards.stringValue(\n\t\t\tEntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\tnameof(deviceAddress),\n\t\t\tdeviceAddress\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tEntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\tnameof(title),\n\t\t\ttitle\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tEntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\tnameof(message),\n\t\t\tmessage\n\t\t);\n\t\ttry {\n\t\t\tawait this._logging?.log({\n\t\t\t\tlevel: \"info\",\n\t\t\t\tsource: EntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\t\tts: Date.now(),\n\t\t\t\tmessage: \"pushNotificationSending\"\n\t\t\t});\n\n\t\t\tconst id = Converter.bytesToHex(RandomHelper.generate(32));\n\n\t\t\tconst entity: PushNotificationMessageEntry = {\n\t\t\t\tid,\n\t\t\t\tdeviceAddress,\n\t\t\t\ttitle,\n\t\t\t\tmessage,\n\t\t\t\tts: Date.now(),\n\t\t\t\tstatus: \"pending\"\n\t\t\t};\n\n\t\t\tawait this._messagingMessageEntryStorage.set(entity);\n\t\t\treturn true;\n\t\t} catch (err) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tEntityStorageMessagingPushNotificationConnector.CLASS_NAME,\n\t\t\t\t\"sendPushNotificationFailed\",\n\t\t\t\t{ value: deviceAddress },\n\t\t\t\terr\n\t\t\t);\n\t\t}\n\t}\n}\n"]}

package/docs/changelog.md

@@ -1,6 +1,34 @@
-# @twin.org/messaging-connector-entity-storage - Changelog
+# Changelog
 
-## [0.0.3-next.3](https://github.com/twinfoundation/messaging/compare/messaging-connector-entity-storage-v0.0.3-next.2...messaging-connector-entity-storage-v0.0.3-next.3) (2026-02-26)
+## [0.0.3-next.5](https://github.com/iotaledger/twin-messaging/compare/messaging-connector-entity-storage-v0.0.3-next.4...messaging-connector-entity-storage-v0.0.3-next.5) (2026-05-20)
+
+
+### Features
+
+* update dependencies ([eda66c5](https://github.com/iotaledger/twin-messaging/commit/eda66c5c670f36f1ba86a8f768e4781b629c88ff))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/messaging-models bumped from 0.0.3-next.4 to 0.0.3-next.5
+
+## [0.0.3-next.4](https://github.com/iotaledger/twin-messaging/compare/messaging-connector-entity-storage-v0.0.3-next.3...messaging-connector-entity-storage-v0.0.3-next.4) (2026-05-11)
+
+
+### Features
+
+* typescript 6 update ([0aabd3e](https://github.com/iotaledger/twin-messaging/commit/0aabd3e05fbdf1cbc5df34cf24c461a75abc9d7e))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/messaging-models bumped from 0.0.3-next.3 to 0.0.3-next.4
+
+## [0.0.3-next.3](https://github.com/iotaledger/twin-messaging/compare/messaging-connector-entity-storage-v0.0.3-next.2...messaging-connector-entity-storage-v0.0.3-next.3) (2026-02-26)
 
 
 ### Miscellaneous Chores
@@ -14,7 +42,7 @@
   * dependencies
     * @twin.org/messaging-models bumped from 0.0.3-next.2 to 0.0.3-next.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)
+## [0.0.3-next.2](https://github.com/iotaledger/twin-messaging/compare/messaging-connector-entity-storage-v0.0.3-next.1...messaging-connector-entity-storage-v0.0.3-next.2) (2026-01-20)
 
 
 ### Miscellaneous Chores
@@ -28,25 +56,25 @@
   * dependencies
     * @twin.org/messaging-models bumped from 0.0.3-next.1 to 0.0.3-next.2
 
-## [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)
+## [0.0.3-next.1](https://github.com/iotaledger/twin-messaging/compare/messaging-connector-entity-storage-v0.0.3-next.0...messaging-connector-entity-storage-v0.0.3-next.1) (2025-11-11)
 
 
 ### Features
 
-* add context id features ([#24](https://github.com/twinfoundation/messaging/issues/24)) ([42b94e8](https://github.com/twinfoundation/messaging/commit/42b94e8be32c86db6afc5ccf5e9ff2c93d15d05d))
-* add messaging admin component ([cbaaca3](https://github.com/twinfoundation/messaging/commit/cbaaca34db6a9f5c51438c201535b4b43a1aea1f))
-* add validate-locales ([5eeff9b](https://github.com/twinfoundation/messaging/commit/5eeff9b9bf6cecf93b249b56c4bb74b4c5bf86c9))
-* Entity Storage email connector init ([#2](https://github.com/twinfoundation/messaging/issues/2)) ([65b344d](https://github.com/twinfoundation/messaging/commit/65b344de0d2d3d557d921e3d32e263dcb04ee9b3))
-* eslint migration to flat config ([faa02ec](https://github.com/twinfoundation/messaging/commit/faa02ec0ef450db88b08e938415e40cf13625d15))
-* update dependencies ([53dcde6](https://github.com/twinfoundation/messaging/commit/53dcde60d6efaee5957296f6d097cb97c0fb2f9d))
-* update framework core ([fc476b4](https://github.com/twinfoundation/messaging/commit/fc476b48e6075de0ae871e3cec1fa179aa04b5eb))
-* use shared store mechanism ([#8](https://github.com/twinfoundation/messaging/issues/8)) ([9ad65c2](https://github.com/twinfoundation/messaging/commit/9ad65c239ba77bb75604a1f6e51b975357f3228d))
+* add context id features ([#24](https://github.com/iotaledger/twin-messaging/issues/24)) ([42b94e8](https://github.com/iotaledger/twin-messaging/commit/42b94e8be32c86db6afc5ccf5e9ff2c93d15d05d))
+* add messaging admin component ([cbaaca3](https://github.com/iotaledger/twin-messaging/commit/cbaaca34db6a9f5c51438c201535b4b43a1aea1f))
+* add validate-locales ([5eeff9b](https://github.com/iotaledger/twin-messaging/commit/5eeff9b9bf6cecf93b249b56c4bb74b4c5bf86c9))
+* Entity Storage email connector init ([#2](https://github.com/iotaledger/twin-messaging/issues/2)) ([65b344d](https://github.com/iotaledger/twin-messaging/commit/65b344de0d2d3d557d921e3d32e263dcb04ee9b3))
+* eslint migration to flat config ([faa02ec](https://github.com/iotaledger/twin-messaging/commit/faa02ec0ef450db88b08e938415e40cf13625d15))
+* update dependencies ([53dcde6](https://github.com/iotaledger/twin-messaging/commit/53dcde60d6efaee5957296f6d097cb97c0fb2f9d))
+* update framework core ([fc476b4](https://github.com/iotaledger/twin-messaging/commit/fc476b48e6075de0ae871e3cec1fa179aa04b5eb))
+* use shared store mechanism ([#8](https://github.com/iotaledger/twin-messaging/issues/8)) ([9ad65c2](https://github.com/iotaledger/twin-messaging/commit/9ad65c239ba77bb75604a1f6e51b975357f3228d))
 
 
 ### Bug Fixes
 
-* Adding format to the MessagingEntries ts number ([8b99d4f](https://github.com/twinfoundation/messaging/commit/8b99d4f01c4f2b08da8d2affc1b9554fcb0d3690))
-* Make SMS entry error property optional ([#5](https://github.com/twinfoundation/messaging/issues/5)) ([e0faf83](https://github.com/twinfoundation/messaging/commit/e0faf83e028a2c5dc45a5e8ba1a546013e4a3c8c))
+* Adding format to the MessagingEntries ts number ([8b99d4f](https://github.com/iotaledger/twin-messaging/commit/8b99d4f01c4f2b08da8d2affc1b9554fcb0d3690))
+* Make SMS entry error property optional ([#5](https://github.com/iotaledger/twin-messaging/issues/5)) ([e0faf83](https://github.com/iotaledger/twin-messaging/commit/e0faf83e028a2c5dc45a5e8ba1a546013e4a3c8c))
 
 
 ### Dependencies
@@ -55,12 +83,12 @@
   * dependencies
     * @twin.org/messaging-models bumped from 0.0.3-next.0 to 0.0.3-next.1
 
-## [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)
+## [0.0.2-next.6](https://github.com/iotaledger/twin-messaging/compare/messaging-connector-entity-storage-v0.0.2-next.5...messaging-connector-entity-storage-v0.0.2-next.6) (2025-10-09)
 
 
 ### Features
 
-* add validate-locales ([5eeff9b](https://github.com/twinfoundation/messaging/commit/5eeff9b9bf6cecf93b249b56c4bb74b4c5bf86c9))
+* add validate-locales ([5eeff9b](https://github.com/iotaledger/twin-messaging/commit/5eeff9b9bf6cecf93b249b56c4bb74b4c5bf86c9))
 
 
 ### Dependencies
@@ -69,7 +97,7 @@
   * dependencies
     * @twin.org/messaging-models bumped from 0.0.2-next.5 to 0.0.2-next.6
 
-## [0.0.2-next.5](https://github.com/twinfoundation/messaging/compare/messaging-connector-entity-storage-v0.0.2-next.4...messaging-connector-entity-storage-v0.0.2-next.5) (2025-10-02)
+## [0.0.2-next.5](https://github.com/iotaledger/twin-messaging/compare/messaging-connector-entity-storage-v0.0.2-next.4...messaging-connector-entity-storage-v0.0.2-next.5) (2025-10-02)
 
 
 ### Miscellaneous Chores
@@ -83,7 +111,7 @@
   * dependencies
     * @twin.org/messaging-models bumped from 0.0.2-next.4 to 0.0.2-next.5
 
-## [0.0.2-next.4](https://github.com/twinfoundation/messaging/compare/messaging-connector-entity-storage-v0.0.2-next.3...messaging-connector-entity-storage-v0.0.2-next.4) (2025-09-29)
+## [0.0.2-next.4](https://github.com/iotaledger/twin-messaging/compare/messaging-connector-entity-storage-v0.0.2-next.3...messaging-connector-entity-storage-v0.0.2-next.4) (2025-09-29)
 
 
 ### Miscellaneous Chores
@@ -97,12 +125,12 @@
   * dependencies
     * @twin.org/messaging-models bumped from 0.0.2-next.3 to 0.0.2-next.4
 
-## [0.0.2-next.3](https://github.com/twinfoundation/messaging/compare/messaging-connector-entity-storage-v0.0.2-next.2...messaging-connector-entity-storage-v0.0.2-next.3) (2025-09-29)
+## [0.0.2-next.3](https://github.com/iotaledger/twin-messaging/compare/messaging-connector-entity-storage-v0.0.2-next.2...messaging-connector-entity-storage-v0.0.2-next.3) (2025-09-29)
 
 
 ### Features
 
-* add messaging admin component ([cbaaca3](https://github.com/twinfoundation/messaging/commit/cbaaca34db6a9f5c51438c201535b4b43a1aea1f))
+* add messaging admin component ([cbaaca3](https://github.com/iotaledger/twin-messaging/commit/cbaaca34db6a9f5c51438c201535b4b43a1aea1f))
 
 
 ### Dependencies
@@ -111,12 +139,12 @@
   * dependencies
     * @twin.org/messaging-models bumped from 0.0.2-next.2 to 0.0.2-next.3
 
-## [0.0.2-next.2](https://github.com/twinfoundation/messaging/compare/messaging-connector-entity-storage-v0.0.2-next.1...messaging-connector-entity-storage-v0.0.2-next.2) (2025-08-29)
+## [0.0.2-next.2](https://github.com/iotaledger/twin-messaging/compare/messaging-connector-entity-storage-v0.0.2-next.1...messaging-connector-entity-storage-v0.0.2-next.2) (2025-08-29)
 
 
 ### Features
 
-* eslint migration to flat config ([faa02ec](https://github.com/twinfoundation/messaging/commit/faa02ec0ef450db88b08e938415e40cf13625d15))
+* eslint migration to flat config ([faa02ec](https://github.com/iotaledger/twin-messaging/commit/faa02ec0ef450db88b08e938415e40cf13625d15))
 
 
 ### Dependencies
@@ -125,21 +153,21 @@
   * dependencies
     * @twin.org/messaging-models bumped from 0.0.2-next.1 to 0.0.2-next.2
 
-## [0.0.2-next.1](https://github.com/twinfoundation/messaging/compare/messaging-connector-entity-storage-v0.0.2-next.0...messaging-connector-entity-storage-v0.0.2-next.1) (2025-08-20)
+## [0.0.2-next.1](https://github.com/iotaledger/twin-messaging/compare/messaging-connector-entity-storage-v0.0.2-next.0...messaging-connector-entity-storage-v0.0.2-next.1) (2025-08-20)
 
 
 ### Features
 
-* Entity Storage email connector init ([#2](https://github.com/twinfoundation/messaging/issues/2)) ([65b344d](https://github.com/twinfoundation/messaging/commit/65b344de0d2d3d557d921e3d32e263dcb04ee9b3))
-* update dependencies ([53dcde6](https://github.com/twinfoundation/messaging/commit/53dcde60d6efaee5957296f6d097cb97c0fb2f9d))
-* update framework core ([fc476b4](https://github.com/twinfoundation/messaging/commit/fc476b48e6075de0ae871e3cec1fa179aa04b5eb))
-* use shared store mechanism ([#8](https://github.com/twinfoundation/messaging/issues/8)) ([9ad65c2](https://github.com/twinfoundation/messaging/commit/9ad65c239ba77bb75604a1f6e51b975357f3228d))
+* Entity Storage email connector init ([#2](https://github.com/iotaledger/twin-messaging/issues/2)) ([65b344d](https://github.com/iotaledger/twin-messaging/commit/65b344de0d2d3d557d921e3d32e263dcb04ee9b3))
+* update dependencies ([53dcde6](https://github.com/iotaledger/twin-messaging/commit/53dcde60d6efaee5957296f6d097cb97c0fb2f9d))
+* update framework core ([fc476b4](https://github.com/iotaledger/twin-messaging/commit/fc476b48e6075de0ae871e3cec1fa179aa04b5eb))
+* use shared store mechanism ([#8](https://github.com/iotaledger/twin-messaging/issues/8)) ([9ad65c2](https://github.com/iotaledger/twin-messaging/commit/9ad65c239ba77bb75604a1f6e51b975357f3228d))
 
 
 ### Bug Fixes
 
-* Adding format to the MessagingEntries ts number ([8b99d4f](https://github.com/twinfoundation/messaging/commit/8b99d4f01c4f2b08da8d2affc1b9554fcb0d3690))
-* Make SMS entry error property optional ([#5](https://github.com/twinfoundation/messaging/issues/5)) ([e0faf83](https://github.com/twinfoundation/messaging/commit/e0faf83e028a2c5dc45a5e8ba1a546013e4a3c8c))
+* Adding format to the MessagingEntries ts number ([8b99d4f](https://github.com/iotaledger/twin-messaging/commit/8b99d4f01c4f2b08da8d2affc1b9554fcb0d3690))
+* Make SMS entry error property optional ([#5](https://github.com/iotaledger/twin-messaging/issues/5)) ([e0faf83](https://github.com/iotaledger/twin-messaging/commit/e0faf83e028a2c5dc45a5e8ba1a546013e4a3c8c))
 
 
 ### Dependencies
@@ -153,7 +181,7 @@
 
 ### Features
 
-* release to production ([cc714a7](https://github.com/twinfoundation/messaging/commit/cc714a7e1db251ab8e1a158f7753387a56d60271))
+* release to production ([cc714a7](https://github.com/iotaledger/twin-messaging/commit/cc714a7e1db251ab8e1a158f7753387a56d60271))
 
 
 ### Dependencies
@@ -162,7 +190,7 @@
   * dependencies
     * @twin.org/messaging-models bumped from ^0.0.0 to ^0.0.1
 
-## [0.0.1-next.16](https://github.com/twinfoundation/messaging/compare/messaging-connector-entity-storage-v0.0.1-next.15...messaging-connector-entity-storage-v0.0.1-next.16) (2025-06-30)
+## [0.0.1-next.16](https://github.com/iotaledger/twin-messaging/compare/messaging-connector-entity-storage-v0.0.1-next.15...messaging-connector-entity-storage-v0.0.1-next.16) (2025-06-30)
 
 
 ### Miscellaneous Chores
@@ -176,12 +204,12 @@
   * dependencies
     * @twin.org/messaging-models bumped from 0.0.1-next.15 to 0.0.1-next.16
 
-## [0.0.1-next.15](https://github.com/twinfoundation/messaging/compare/messaging-connector-entity-storage-v0.0.1-next.14...messaging-connector-entity-storage-v0.0.1-next.15) (2025-06-12)
+## [0.0.1-next.15](https://github.com/iotaledger/twin-messaging/compare/messaging-connector-entity-storage-v0.0.1-next.14...messaging-connector-entity-storage-v0.0.1-next.15) (2025-06-12)
 
 
 ### Features
 
-* update dependencies ([53dcde6](https://github.com/twinfoundation/messaging/commit/53dcde60d6efaee5957296f6d097cb97c0fb2f9d))
+* update dependencies ([53dcde6](https://github.com/iotaledger/twin-messaging/commit/53dcde60d6efaee5957296f6d097cb97c0fb2f9d))
 
 
 ### Dependencies
@@ -190,12 +218,12 @@
   * dependencies
     * @twin.org/messaging-models bumped from 0.0.1-next.14 to 0.0.1-next.15
 
-## [0.0.1-next.14](https://github.com/twinfoundation/messaging/compare/messaging-connector-entity-storage-v0.0.1-next.13...messaging-connector-entity-storage-v0.0.1-next.14) (2025-04-17)
+## [0.0.1-next.14](https://github.com/iotaledger/twin-messaging/compare/messaging-connector-entity-storage-v0.0.1-next.13...messaging-connector-entity-storage-v0.0.1-next.14) (2025-04-17)
 
 
 ### Features
 
-* use shared store mechanism ([#8](https://github.com/twinfoundation/messaging/issues/8)) ([9ad65c2](https://github.com/twinfoundation/messaging/commit/9ad65c239ba77bb75604a1f6e51b975357f3228d))
+* use shared store mechanism ([#8](https://github.com/iotaledger/twin-messaging/issues/8)) ([9ad65c2](https://github.com/iotaledger/twin-messaging/commit/9ad65c239ba77bb75604a1f6e51b975357f3228d))
 
 
 ### Dependencies
@@ -204,18 +232,18 @@
   * dependencies
     * @twin.org/messaging-models bumped from 0.0.1-next.13 to 0.0.1-next.14
 
-## [0.0.1-next.13](https://github.com/twinfoundation/messaging/compare/messaging-connector-entity-storage-v0.0.1-next.12...messaging-connector-entity-storage-v0.0.1-next.13) (2025-03-28)
+## [0.0.1-next.13](https://github.com/iotaledger/twin-messaging/compare/messaging-connector-entity-storage-v0.0.1-next.12...messaging-connector-entity-storage-v0.0.1-next.13) (2025-03-28)
 
 
 ### Features
 
-* Entity Storage email connector init ([#2](https://github.com/twinfoundation/messaging/issues/2)) ([65b344d](https://github.com/twinfoundation/messaging/commit/65b344de0d2d3d557d921e3d32e263dcb04ee9b3))
+* Entity Storage email connector init ([#2](https://github.com/iotaledger/twin-messaging/issues/2)) ([65b344d](https://github.com/iotaledger/twin-messaging/commit/65b344de0d2d3d557d921e3d32e263dcb04ee9b3))
 
 
 ### Bug Fixes
 
-* Adding format to the MessagingEntries ts number ([8b99d4f](https://github.com/twinfoundation/messaging/commit/8b99d4f01c4f2b08da8d2affc1b9554fcb0d3690))
-* Make SMS entry error property optional ([#5](https://github.com/twinfoundation/messaging/issues/5)) ([e0faf83](https://github.com/twinfoundation/messaging/commit/e0faf83e028a2c5dc45a5e8ba1a546013e4a3c8c))
+* Adding format to the MessagingEntries ts number ([8b99d4f](https://github.com/iotaledger/twin-messaging/commit/8b99d4f01c4f2b08da8d2affc1b9554fcb0d3690))
+* Make SMS entry error property optional ([#5](https://github.com/iotaledger/twin-messaging/issues/5)) ([e0faf83](https://github.com/iotaledger/twin-messaging/commit/e0faf83e028a2c5dc45a5e8ba1a546013e4a3c8c))
 
 
 ### Dependencies

package/docs/examples.md

@@ -1 +1,119 @@
-# @twin.org/messaging-connector-entity-storage - Examples
+# Messaging Connector Entity Storage Examples
+
+These examples show how to queue message work in entity storage and inspect stored entries during processing.
+
+## EntityStorageMessagingPushNotificationConnector
+
+```typescript
+import { EntityStorageMessagingPushNotificationConnector } from '@twin.org/messaging-connector-entity-storage';
+
+const pushConnector = new EntityStorageMessagingPushNotificationConnector();
+
+console.log(pushConnector.className()); // EntityStorageMessagingPushNotificationConnector
+const deviceRecordId = await pushConnector.registerDevice('orders-app', 'device-token-001');
+console.log(deviceRecordId); // 3f0a8e8e7d58b2f1a1d2f3c4b5e6a7c8d9e0f112131415161718191a1b1c1d1e
+
+const queued = await pushConnector.sendSinglePushNotification(
+  'device-record-001',
+  'Order dispatched',
+  'Your parcel has left the warehouse'
+);
+console.log(queued); // true
+```
+
+## EntityStorageMessagingEmailConnector
+
+```typescript
+import { EntityStorageMessagingEmailConnector } from '@twin.org/messaging-connector-entity-storage';
+
+const emailConnector = new EntityStorageMessagingEmailConnector();
+
+console.log(emailConnector.className()); // EntityStorageMessagingEmailConnector
+
+const queued = await emailConnector.sendCustomEmail(
+  'service@example.org',
+  ['recipient@example.org'],
+  'Welcome',
+  '<p>Thanks for signing up.</p>'
+);
+console.log(queued); // true
+```
+
+## EntityStorageMessagingSmsConnector
+
+```typescript
+import { EntityStorageMessagingSmsConnector } from '@twin.org/messaging-connector-entity-storage';
+
+const smsConnector = new EntityStorageMessagingSmsConnector();
+
+console.log(smsConnector.className()); // EntityStorageMessagingSmsConnector
+
+const queued = await smsConnector.sendSMS(
+  '+441234567890',
+  'Your appointment is confirmed for 10:30'
+);
+console.log(queued); // true
+```
+
+## PushNotificationMessageEntry
+
+```typescript
+import { PushNotificationMessageEntry } from '@twin.org/messaging-connector-entity-storage';
+
+const messageEntry = new PushNotificationMessageEntry();
+messageEntry.id = 'push-message-001';
+messageEntry.deviceAddress = 'device-record-001';
+messageEntry.title = 'Order dispatched';
+messageEntry.message = 'Your parcel has left the warehouse';
+messageEntry.ts = Date.now();
+messageEntry.status = 'pending';
+
+console.log(messageEntry.status); // pending
+```
+
+## PushNotificationDeviceEntry
+
+```typescript
+import { PushNotificationDeviceEntry } from '@twin.org/messaging-connector-entity-storage';
+
+const deviceEntry = new PushNotificationDeviceEntry();
+deviceEntry.id = 'push-device-001';
+deviceEntry.applicationId = 'orders-app';
+deviceEntry.deviceToken = 'device-token-001';
+deviceEntry.ts = Date.now();
+deviceEntry.status = 'pending';
+
+console.log(deviceEntry.applicationId); // orders-app
+```
+
+## EmailEntry
+
+```typescript
+import { EmailEntry } from '@twin.org/messaging-connector-entity-storage';
+
+const emailEntry = new EmailEntry();
+emailEntry.id = 'email-001';
+emailEntry.sender = 'service@example.org';
+emailEntry.recipients = ['recipient@example.org'];
+emailEntry.ts = Date.now();
+emailEntry.subject = 'Welcome';
+emailEntry.message = '<p>Thanks for signing up.</p>';
+emailEntry.status = 'pending';
+
+console.log(emailEntry.recipients.length); // 1
+```
+
+## SmsEntry
+
+```typescript
+import { SmsEntry } from '@twin.org/messaging-connector-entity-storage';
+
+const smsEntry = new SmsEntry();
+smsEntry.id = 'sms-001';
+smsEntry.phoneNumber = '+441234567890';
+smsEntry.ts = Date.now();
+smsEntry.message = 'Your appointment is confirmed for 10:30';
+smsEntry.status = 'sent';
+
+console.log(smsEntry.status); // sent
+```

package/docs/reference/classes/EmailEntry.md

@@ -14,7 +14,7 @@ Call defining an email entry.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,7 +22,7 @@ The id.
 
 ***
 
-### sender
+### sender {#sender}
 
 > **sender**: `string`
 
@@ -30,7 +30,7 @@ The sender email address.
 
 ***
 
-### recipients
+### recipients {#recipients}
 
 > **recipients**: `string`[]
 
@@ -38,7 +38,7 @@ The recipient email addresses.
 
 ***
 
-### ts
+### ts {#ts}
 
 > **ts**: `number`
 
@@ -46,7 +46,7 @@ The timestamp of the email entry.
 
 ***
 
-### message
+### message {#message}
 
 > **message**: `string`
 
@@ -54,7 +54,7 @@ The message.
 
 ***
 
-### subject
+### subject {#subject}
 
 > **subject**: `string`
 
@@ -62,7 +62,7 @@ The subject.
 
 ***
 
-### status
+### status {#status}
 
 > **status**: `string`
 
@@ -70,8 +70,8 @@ The status.
 
 ***
 
-### error?
+### error? {#error}
 
-> `optional` **error**: `IError`
+> `optional` **error?**: `IError`
 
 The error.

package/docs/reference/classes/EntityStorageMessagingEmailConnector.md

@@ -28,7 +28,7 @@ The options for the connector.
 
 ## Properties
 
-### NAMESPACE
+### NAMESPACE {#namespace}
 
 > `readonly` `static` **NAMESPACE**: `string` = `"entity-storage"`
 
@@ -36,7 +36,7 @@ The namespace for the connector.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -44,7 +44,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -62,7 +62,7 @@ The class name of the component.
 
 ***
 
-### sendCustomEmail()
+### sendCustomEmail() {#sendcustomemail}
 
 > **sendCustomEmail**(`sender`, `recipients`, `subject`, `content`): `Promise`\<`boolean`\>
 

package/docs/reference/classes/EntityStorageMessagingPushNotificationConnector.md

@@ -28,7 +28,7 @@ The options for the connector.
 
 ## Properties
 
-### NAMESPACE
+### NAMESPACE {#namespace}
 
 > `readonly` `static` **NAMESPACE**: `string` = `"entity-storage"`
 
@@ -36,7 +36,7 @@ The namespace for the connector.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -44,7 +44,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -62,7 +62,7 @@ The class name of the component.
 
 ***
 
-### registerDevice()
+### registerDevice() {#registerdevice}
 
 > **registerDevice**(`applicationId`, `deviceToken`): `Promise`\<`string`\>
 
@@ -94,7 +94,7 @@ If the device was registered successfully.
 
 ***
 
-### sendSinglePushNotification()
+### sendSinglePushNotification() {#sendsinglepushnotification}
 
 > **sendSinglePushNotification**(`deviceAddress`, `title`, `message`): `Promise`\<`boolean`\>
 

package/docs/reference/classes/EntityStorageMessagingSmsConnector.md

@@ -28,7 +28,7 @@ The options for the connector.
 
 ## Properties
 
-### NAMESPACE
+### NAMESPACE {#namespace}
 
 > `readonly` `static` **NAMESPACE**: `string` = `"entity-storage"`
 
@@ -36,7 +36,7 @@ The namespace for the connector.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -44,7 +44,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -62,7 +62,7 @@ The class name of the component.
 
 ***
 
-### sendSMS()
+### sendSMS() {#sendsms}
 
 > **sendSMS**(`phoneNumber`, `message`): `Promise`\<`boolean`\>
 

package/docs/reference/classes/PushNotificationDeviceEntry.md

@@ -14,7 +14,7 @@ Call defining an push notification device entry.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,7 +22,7 @@ The id.
 
 ***
 
-### applicationId
+### applicationId {#applicationid}
 
 > **applicationId**: `string`
 
@@ -30,7 +30,7 @@ The applicationId.
 
 ***
 
-### deviceToken
+### deviceToken {#devicetoken}
 
 > **deviceToken**: `string`
 
@@ -38,7 +38,7 @@ The device token.
 
 ***
 
-### ts
+### ts {#ts}
 
 > **ts**: `number`
 
@@ -46,7 +46,7 @@ The timestamp of the push notification device entry.
 
 ***
 
-### status
+### status {#status}
 
 > **status**: `string`
 
@@ -54,8 +54,8 @@ The status.
 
 ***
 
-### error?
+### error? {#error}
 
-> `optional` **error**: `IError`
+> `optional` **error?**: `IError`
 
 The error.

package/docs/reference/classes/PushNotificationMessageEntry.md

@@ -14,7 +14,7 @@ Call defining an push notification message entry.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,7 +22,7 @@ The id.
 
 ***
 
-### deviceAddress
+### deviceAddress {#deviceaddress}
 
 > **deviceAddress**: `string`
 
@@ -30,7 +30,7 @@ The device address.
 
 ***
 
-### title
+### title {#title}
 
 > **title**: `string`
 
@@ -38,7 +38,7 @@ The title.
 
 ***
 
-### message
+### message {#message}
 
 > **message**: `string`
 
@@ -46,7 +46,7 @@ The message.
 
 ***
 
-### ts
+### ts {#ts}
 
 > **ts**: `number`
 
@@ -54,7 +54,7 @@ The timestamp of the push notification entry.
 
 ***
 
-### status
+### status {#status}
 
 > **status**: `string`
 
@@ -62,8 +62,8 @@ The status.
 
 ***
 
-### error?
+### error? {#error}
 
-> `optional` **error**: `IError`
+> `optional` **error?**: `IError`
 
 The error.

package/docs/reference/classes/SmsEntry.md

@@ -14,7 +14,7 @@ Call defining an sms entry.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,7 +22,7 @@ The id.
 
 ***
 
-### phoneNumber
+### phoneNumber {#phonenumber}
 
 > **phoneNumber**: `string`
 
@@ -30,7 +30,7 @@ The phone number to deliver the message.
 
 ***
 
-### ts
+### ts {#ts}
 
 > **ts**: `number`
 
@@ -38,7 +38,7 @@ The timestamp of the sms entry.
 
 ***
 
-### message
+### message {#message}
 
 > **message**: `string`
 
@@ -46,7 +46,7 @@ The message.
 
 ***
 
-### status
+### status {#status}
 
 > **status**: `string`
 
@@ -54,8 +54,8 @@ The status.
 
 ***
 
-### error?
+### error? {#error}
 
-> `optional` **error**: `IError`
+> `optional` **error?**: `IError`
 
 The error.

package/docs/reference/interfaces/IEntityStorageMessagingEmailConnectorConstructorOptions.md

@@ -4,17 +4,17 @@ Options for the entity storage messaging email connector.
 
 ## Properties
 
-### loggingComponentType?
+### loggingComponentType? {#loggingcomponenttype}
 
-> `optional` **loggingComponentType**: `string`
+> `optional` **loggingComponentType?**: `string`
 
 The type of logging component to use, defaults to no logging.
 
 ***
 
-### messagingEmailEntryStorageConnectorType?
+### messagingEmailEntryStorageConnectorType? {#messagingemailentrystorageconnectortype}
 
-> `optional` **messagingEmailEntryStorageConnectorType**: `string`
+> `optional` **messagingEmailEntryStorageConnectorType?**: `string`
 
 The type of entity storage connector to use for the email entries.
 

package/docs/reference/interfaces/IEntityStorageMessagingPushNotificationConnectorConstructorOptions.md

@@ -4,17 +4,17 @@ Options for the entity storage messaging push notification connector.
 
 ## Properties
 
-### loggingComponentType?
+### loggingComponentType? {#loggingcomponenttype}
 
-> `optional` **loggingComponentType**: `string`
+> `optional` **loggingComponentType?**: `string`
 
 The type of logging component to use, defaults to no logging.
 
 ***
 
-### messagingDeviceEntryStorageConnectorType?
+### messagingDeviceEntryStorageConnectorType? {#messagingdeviceentrystorageconnectortype}
 
-> `optional` **messagingDeviceEntryStorageConnectorType**: `string`
+> `optional` **messagingDeviceEntryStorageConnectorType?**: `string`
 
 The type of entity storage connector to use for the push notifications entries.
 
@@ -26,9 +26,9 @@ push-notification-device-entry
 
 ***
 
-### messagingMessageEntryStorageConnectorType?
+### messagingMessageEntryStorageConnectorType? {#messagingmessageentrystorageconnectortype}
 
-> `optional` **messagingMessageEntryStorageConnectorType**: `string`
+> `optional` **messagingMessageEntryStorageConnectorType?**: `string`
 
 The type of entity storage connector to use for the push notifications entries.
 

package/docs/reference/interfaces/IEntityStorageMessagingSmsConnectorConstructorOptions.md

@@ -4,17 +4,17 @@ Options for the entity storage messaging SMS connector.
 
 ## Properties
 
-### loggingComponentType?
+### loggingComponentType? {#loggingcomponenttype}
 
-> `optional` **loggingComponentType**: `string`
+> `optional` **loggingComponentType?**: `string`
 
 The type of logging component to use, defaults to no logging.
 
 ***
 
-### messagingSmsEntryStorageConnectorType?
+### messagingSmsEntryStorageConnectorType? {#messagingsmsentrystorageconnectortype}
 
-> `optional` **messagingSmsEntryStorageConnectorType**: `string`
+> `optional` **messagingSmsEntryStorageConnectorType?**: `string`
 
 The type of entity storage connector to use for the sms entries.
 

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/messaging-connector-entity-storage",
-	"version": "0.0.3-next.3",
-	"description": "Messaging connector implementation using the Entity Storage",
+	"version": "0.0.3-next.5",
+	"description": "Provides connectors that persist and manage messaging operations using entity storage.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/messaging.git",
+		"url": "git+https://github.com/iotaledger/messaging.git",
 		"directory": "packages/messaging-connector-entity-storage"
 	},
 	"author": "adrian.sanchez.sequeira@iota.org",
@@ -17,7 +17,7 @@
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/logging-models": "next",
-		"@twin.org/messaging-models": "0.0.3-next.3",
+		"@twin.org/messaging-models": "0.0.3-next.5",
 		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/es/index.js",
@@ -51,7 +51,7 @@
 		"integration"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/messaging/issues"
+		"url": "git+https://github.com/iotaledger/messaging/issues"
 	},
 	"homepage": "https://twindev.org"
 }