@serve.zone/platformclient 1.1.4 → 1.1.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.
- package/.smartconfig.json +17 -6
- package/dist_ts/00_commitinfo_data.js +1 -1
- package/dist_ts/email/classes.emailconnector.d.ts +1 -1
- package/dist_ts/email/classes.emailconnector.js +2 -1
- package/dist_ts/email/classes.letterconnector.d.ts +1 -1
- package/dist_ts/email/classes.letterconnector.js +2 -1
- package/dist_ts/email/classes.pushnotificationconnector.js +2 -2
- package/dist_ts_infohtml/plugins.js +1 -2
- package/dist_ts_infohtml/template.js +11 -8
- package/package.json +13 -13
- package/readme.md +70 -73
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/email/classes.emailconnector.ts +1 -1
- package/ts/email/classes.letterconnector.ts +1 -0
- package/ts/email/classes.pushnotificationconnector.ts +1 -1
package/.smartconfig.json
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"@git.zone/cli": {
|
|
3
|
+
"schemaVersion": 2,
|
|
3
4
|
"projectType": "npm",
|
|
4
5
|
"module": {
|
|
5
|
-
"githost": "
|
|
6
|
+
"githost": "code.foss.global",
|
|
6
7
|
"gitscope": "serve.zone",
|
|
7
8
|
"gitrepo": "platformclient",
|
|
8
9
|
"description": "a module that makes it really easy to use the serve.zone platform inside your app",
|
|
@@ -11,11 +12,21 @@
|
|
|
11
12
|
"projectDomain": "serve.zone"
|
|
12
13
|
},
|
|
13
14
|
"release": {
|
|
14
|
-
"
|
|
15
|
-
"
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
15
|
+
"targets": {
|
|
16
|
+
"git": {
|
|
17
|
+
"enabled": true,
|
|
18
|
+
"remote": "origin"
|
|
19
|
+
},
|
|
20
|
+
"npm": {
|
|
21
|
+
"enabled": true,
|
|
22
|
+
"registries": [
|
|
23
|
+
"https://verdaccio.lossless.digital",
|
|
24
|
+
"https://registry.npmjs.org"
|
|
25
|
+
],
|
|
26
|
+
"accessLevel": "public",
|
|
27
|
+
"alreadyPublished": "success"
|
|
28
|
+
}
|
|
29
|
+
}
|
|
19
30
|
}
|
|
20
31
|
},
|
|
21
32
|
"@ship.zone/szci": {
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@serve.zone/platformclient',
|
|
6
|
-
version: '1.1.
|
|
6
|
+
version: '1.1.5',
|
|
7
7
|
description: 'a module that makes it really easy to use the serve.zone platform inside your app'
|
|
8
8
|
};
|
|
9
9
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSw0QkFBNEI7SUFDbEMsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLG1GQUFtRjtDQUNqRyxDQUFBIn0=
|
|
@@ -3,7 +3,7 @@ import * as plugins from '../plugins.js';
|
|
|
3
3
|
export declare class SzEmailConnector {
|
|
4
4
|
platformClientRef: SzPlatformClient;
|
|
5
5
|
constructor(platformClientRefArg: SzPlatformClient);
|
|
6
|
-
sendEmail(optionsArg: plugins.servezoneInterfaces.platform.email.IReq_SendEmail['request']): Promise<
|
|
6
|
+
sendEmail(optionsArg: plugins.servezoneInterfaces.platform.email.IReq_SendEmail['request']): Promise<string | undefined>;
|
|
7
7
|
sendNotification(optionsArg: {
|
|
8
8
|
toArg: string;
|
|
9
9
|
subject: string;
|
|
@@ -17,8 +17,9 @@ export class SzEmailConnector {
|
|
|
17
17
|
}
|
|
18
18
|
const typedRequest = this.platformClientRef.typedsocket.createTypedRequest('sendEmail');
|
|
19
19
|
const response = await typedRequest.fire(optionsArg);
|
|
20
|
+
return response.responseId;
|
|
20
21
|
}
|
|
21
22
|
async sendNotification(optionsArg) { }
|
|
22
23
|
async sendActionLink(optionsArg) { }
|
|
23
24
|
}
|
|
24
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
25
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xhc3Nlcy5lbWFpbGNvbm5lY3Rvci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzL2VtYWlsL2NsYXNzZXMuZW1haWxjb25uZWN0b3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxLQUFLLE9BQU8sTUFBTSxlQUFlLENBQUM7QUFFekMsT0FBTyxFQUFFLE1BQU0sRUFBRSxNQUFNLGNBQWMsQ0FBQztBQUV0QyxNQUFNLE9BQU8sZ0JBQWdCO0lBRzNCLFlBQVksb0JBQXNDO1FBQ2hELElBQUksQ0FBQyxpQkFBaUIsR0FBRyxvQkFBb0IsQ0FBQztJQUNoRCxDQUFDO0lBRU0sS0FBSyxDQUFDLFNBQVMsQ0FDcEIsVUFBZ0Y7UUFFaEYsSUFBSSxJQUFJLENBQUMsaUJBQWlCLENBQUMsU0FBUyxFQUFFLENBQUM7WUFDckMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxNQUFNLEVBQUUsMkJBQTJCLFVBQVUsQ0FBQyxLQUFLLE9BQU8sVUFBVSxDQUFDLEVBQUU7O1VBRTlFLFVBQVUsQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLFVBQVUsSUFBSSxFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDOztTQUVyRSxDQUFDLENBQUM7UUFDUCxDQUFDO1FBRUQsSUFBSSxJQUFJLENBQUMsaUJBQWlCLENBQUMsU0FBUyxFQUFFLENBQUM7WUFDckMsT0FBTztRQUNULENBQUM7UUFFRCxNQUFNLFlBQVksR0FDaEIsSUFBSSxDQUFDLGlCQUFpQixDQUFDLFdBQVcsQ0FBQyxrQkFBa0IsQ0FDbkQsV0FBVyxDQUNaLENBQUM7UUFDSixNQUFNLFFBQVEsR0FBRyxNQUFNLFlBQVksQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUM7UUFDckQsT0FBTyxRQUFRLENBQUMsVUFBVSxDQUFDO0lBQzdCLENBQUM7SUFFTSxLQUFLLENBQUMsZ0JBQWdCLENBQUMsVUFBNEQsSUFBRyxDQUFDO0lBRXZGLEtBQUssQ0FBQyxjQUFjLENBQUMsVUFBNEQsSUFBRyxDQUFDO0NBQzdGIn0=
|
|
@@ -3,5 +3,5 @@ import type { SzPlatformClient } from '../classes.platformclient.js';
|
|
|
3
3
|
export declare class SzLetterConnector {
|
|
4
4
|
platformClientRef: SzPlatformClient;
|
|
5
5
|
constructor(platformClientRefArg: SzPlatformClient);
|
|
6
|
-
sendLetter(optionsArg: plugins.servezoneInterfaces.platform.letter.IReq_SendLetter['request']): Promise<
|
|
6
|
+
sendLetter(optionsArg: plugins.servezoneInterfaces.platform.letter.IReq_SendLetter['request']): Promise<string | undefined>;
|
|
7
7
|
}
|
|
@@ -12,6 +12,7 @@ export class SzLetterConnector {
|
|
|
12
12
|
}
|
|
13
13
|
const typedRequest = this.platformClientRef.typedsocket.createTypedRequest('sendLetter');
|
|
14
14
|
const response = await typedRequest.fire(optionsArg);
|
|
15
|
+
return response.processId;
|
|
15
16
|
}
|
|
16
17
|
}
|
|
17
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
18
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xhc3Nlcy5sZXR0ZXJjb25uZWN0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9lbWFpbC9jbGFzc2VzLmxldHRlcmNvbm5lY3Rvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLGVBQWUsQ0FBQztBQUd6QyxNQUFNLE9BQU8saUJBQWlCO0lBRzVCLFlBQVksb0JBQXNDO1FBQ2hELElBQUksQ0FBQyxpQkFBaUIsR0FBRyxvQkFBb0IsQ0FBQztJQUNoRCxDQUFDO0lBRU0sS0FBSyxDQUFDLFVBQVUsQ0FDckIsVUFBa0Y7UUFHbEYsSUFBSSxJQUFJLENBQUMsaUJBQWlCLENBQUMsU0FBUyxFQUFFLENBQUM7WUFDckMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxZQUFZLEVBQUUsVUFBVSxDQUFDLENBQUM7UUFDeEMsQ0FBQztRQUVELElBQUksSUFBSSxDQUFDLGlCQUFpQixDQUFDLFNBQVMsRUFBRSxDQUFDO1lBQ3JDLE9BQU87UUFDVCxDQUFDO1FBRUQsTUFBTSxZQUFZLEdBQ2hCLElBQUksQ0FBQyxpQkFBaUIsQ0FBQyxXQUFXLENBQUMsa0JBQWtCLENBQ25ELFlBQVksQ0FDYixDQUFDO1FBQ0osTUFBTSxRQUFRLEdBQUcsTUFBTSxZQUFZLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBQ3JELE9BQU8sUUFBUSxDQUFDLFNBQVMsQ0FBQztJQUM1QixDQUFDO0NBQ0YifQ==
|
|
@@ -12,10 +12,10 @@ export class SzPushNotificationConnector {
|
|
|
12
12
|
}
|
|
13
13
|
const typedRequest = this.platformClientRef.typedsocket.createTypedRequest('sendPushNotification');
|
|
14
14
|
const response = await typedRequest.fire(optionsArg);
|
|
15
|
-
if (process.env
|
|
15
|
+
if (typeof process !== 'undefined' && process.env?.SERVEZONE_PLATFORMCLIENT_DEBUG) {
|
|
16
16
|
console.log('sendPushNotification response', response);
|
|
17
17
|
}
|
|
18
18
|
return response.status;
|
|
19
19
|
}
|
|
20
20
|
}
|
|
21
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
21
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xhc3Nlcy5wdXNobm90aWZpY2F0aW9uY29ubmVjdG9yLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvZW1haWwvY2xhc3Nlcy5wdXNobm90aWZpY2F0aW9uY29ubmVjdG9yLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDO0FBRXpDLE1BQU0sT0FBTywyQkFBMkI7SUFHdEMsWUFBWSxvQkFBc0M7UUFDaEQsSUFBSSxDQUFDLGlCQUFpQixHQUFHLG9CQUFvQixDQUFDO0lBQ2hELENBQUM7SUFFTSxLQUFLLENBQUMsb0JBQW9CLENBQy9CLFVBQXNHO1FBRXRHLElBQUksSUFBSSxDQUFDLGlCQUFpQixDQUFDLFNBQVMsRUFBRSxDQUFDO1lBQ3JDLE9BQU8sQ0FBQyxHQUFHLENBQUMsc0JBQXNCLEVBQUUsVUFBVSxDQUFDLENBQUM7UUFDbEQsQ0FBQztRQUVELElBQUksSUFBSSxDQUFDLGlCQUFpQixDQUFDLFNBQVMsRUFBRSxDQUFDO1lBQ3JDLE9BQU87UUFDVCxDQUFDO1FBRUQsTUFBTSxZQUFZLEdBQ2hCLElBQUksQ0FBQyxpQkFBaUIsQ0FBQyxXQUFXLENBQUMsa0JBQWtCLENBQ25ELHNCQUFzQixDQUN2QixDQUFDO1FBQ0osTUFBTSxRQUFRLEdBQUcsTUFBTSxZQUFZLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBRXJELElBQUksT0FBTyxPQUFPLEtBQUssV0FBVyxJQUFJLE9BQU8sQ0FBQyxHQUFHLEVBQUUsOEJBQThCLEVBQUUsQ0FBQztZQUNsRixPQUFPLENBQUMsR0FBRyxDQUFDLCtCQUErQixFQUFFLFFBQVEsQ0FBQyxDQUFDO1FBQ3pELENBQUM7UUFFRCxPQUFPLFFBQVEsQ0FBQyxNQUFNLENBQUM7SUFDekIsQ0FBQztDQUNGIn0=
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
/// <reference types="node" />
|
|
2
1
|
import * as smartntml from '@push.rocks/smartntml';
|
|
3
2
|
export { smartntml, };
|
|
4
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
3
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzX2luZm9odG1sL3BsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLFNBQVMsTUFBTSx1QkFBdUIsQ0FBQztBQUVuRCxPQUFPLEVBQ0wsU0FBUyxHQUNWLENBQUEifQ==
|
|
@@ -32,6 +32,11 @@ export const simpleInfo = async (smartntmlInstanceArg, optionsArg) => {
|
|
|
32
32
|
width: 150px;
|
|
33
33
|
padding-top: 70px;
|
|
34
34
|
margin: 0px auto 30px auto;
|
|
35
|
+
color: #ffffff;
|
|
36
|
+
text-align: center;
|
|
37
|
+
font-size: 24px;
|
|
38
|
+
font-weight: 700;
|
|
39
|
+
letter-spacing: 0.08em;
|
|
35
40
|
}
|
|
36
41
|
|
|
37
42
|
.content {
|
|
@@ -111,9 +116,7 @@ export const simpleInfo = async (smartntmlInstanceArg, optionsArg) => {
|
|
|
111
116
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
112
117
|
</head>
|
|
113
118
|
<body>
|
|
114
|
-
<div class="logo">
|
|
115
|
-
<img src="https://assetbroker.lossless.one/brandfiles/lossless/svg-minimal-bright.svg" />
|
|
116
|
-
</div>
|
|
119
|
+
<div class="logo">serve.zone</div>
|
|
117
120
|
<div class="content">
|
|
118
121
|
${(() => {
|
|
119
122
|
const returnArray = [];
|
|
@@ -132,7 +135,7 @@ export const simpleInfo = async (smartntmlInstanceArg, optionsArg) => {
|
|
|
132
135
|
returnArray.push(html `<div class="addontext">
|
|
133
136
|
We recorded this event. Should you continue to see this page against your
|
|
134
137
|
expectations, feel free to mail us at
|
|
135
|
-
<a href="mailto:hello@
|
|
138
|
+
<a href="mailto:hello@task.vc">hello@task.vc</a>
|
|
136
139
|
</div>`);
|
|
137
140
|
}
|
|
138
141
|
if (optionsArg.redirectTo) {
|
|
@@ -144,13 +147,13 @@ export const simpleInfo = async (smartntmlInstanceArg, optionsArg) => {
|
|
|
144
147
|
})()}
|
|
145
148
|
</div>
|
|
146
149
|
<div class="legal">
|
|
147
|
-
<a href="https://
|
|
148
|
-
/ <a href="https://
|
|
149
|
-
<a href="https://
|
|
150
|
+
<a href="https://task.vc">Task Venture Capital GmbH</a> / © 2014-${new Date().getFullYear()}
|
|
151
|
+
/ <a href="https://task.vc">Legal Info</a> /
|
|
152
|
+
<a href="https://task.vc">Privacy Policy</a>
|
|
150
153
|
</div>
|
|
151
154
|
</body>
|
|
152
155
|
</html>
|
|
153
156
|
`;
|
|
154
157
|
return smartntmlInstanceArg.renderTemplateResult(htmlTemplate);
|
|
155
158
|
};
|
|
156
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
159
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVtcGxhdGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90c19pbmZvaHRtbC90ZW1wbGF0ZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLGNBQWMsQ0FBQztBQUN4QyxPQUFPLEVBQXlCLE1BQU0sdUJBQXVCLENBQUM7QUFFOUQsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHLEtBQUssRUFDN0Isb0JBQWlELEVBQ2pELFVBQTRCLEVBQzVCLEVBQUU7SUFDRixNQUFNLElBQUksR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUM7SUFDaEQsTUFBTSxZQUFZLEdBQUcsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUE7OztpQkFHOUMsVUFBVSxDQUFDLEtBQUs7OzttQ0FHRSxVQUFVLENBQUMsVUFBVTs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OzsrQkE4RnpCLFVBQVUsQ0FBQyxTQUFTO21DQUNoQixVQUFVLENBQUMsYUFBYTs7O3NCQUdyQyxVQUFVLENBQUMsU0FBUzs7OztxQ0FJTCxVQUFVLENBQUMsYUFBYTs7Ozs7Ozs7WUFRakQsQ0FBQyxHQUFHLEVBQUU7UUFDTixNQUFNLFdBQVcsR0FBbUQsRUFBRSxDQUFDO1FBQ3ZFLElBQUksVUFBVSxDQUFDLE9BQU8sRUFBRSxDQUFDO1lBQ3ZCLFdBQVcsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFBOzt3QkFFWCxVQUFVLENBQUMsT0FBTztvQkFDdEIsVUFBVSxDQUFDLElBQUk7O2VBRXBCLENBQUMsQ0FBQztRQUNMLENBQUM7YUFBTSxDQUFDO1lBQ04sV0FBVyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUEsMEJBQTBCLFVBQVUsQ0FBQyxJQUFJLFNBQVMsQ0FBQyxDQUFDO1FBQzNFLENBQUM7UUFDRCxJQUFJLFVBQVUsQ0FBQyxTQUFTLElBQUksVUFBVSxDQUFDLGFBQWEsRUFBRSxDQUFDO1lBQ3JELFdBQVcsQ0FBQyxJQUFJLENBQ2QsSUFBSSxDQUFBOzs7O3VCQUlHLENBQ1IsQ0FBQztRQUNKLENBQUM7UUFDRCxJQUFJLFVBQVUsQ0FBQyxVQUFVLEVBQUUsQ0FBQztZQUMxQixXQUFXLENBQUMsSUFBSSxDQUNkLElBQUksQ0FBQTs0Q0FDd0IsVUFBVSxDQUFDLFVBQVU7dUJBQzFDLENBQ1IsQ0FBQztRQUNKLENBQUM7UUFDRCxPQUFPLFdBQVcsQ0FBQztJQUNyQixDQUFDLENBQUMsRUFBRTs7O2lGQUdtRSxJQUFJLElBQUksRUFBRSxDQUFDLFdBQVcsRUFBRTs7Ozs7O0dBTXRHLENBQUM7SUFDRixPQUFPLG9CQUFvQixDQUFDLG9CQUFvQixDQUFDLFlBQVksQ0FBQyxDQUFDO0FBQ2pFLENBQUMsQ0FBQyJ9
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@serve.zone/platformclient",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.5",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "a module that makes it really easy to use the serve.zone platform inside your app",
|
|
6
6
|
"main": "dist_ts/index.js",
|
|
@@ -9,29 +9,29 @@
|
|
|
9
9
|
"author": "Task Venture Capital GmbH",
|
|
10
10
|
"license": "MIT",
|
|
11
11
|
"devDependencies": {
|
|
12
|
-
"@git.zone/tsbuild": "^4.4.
|
|
13
|
-
"@git.zone/tsbundle": "^2.10.
|
|
14
|
-
"@git.zone/tsrun": "^2.0.
|
|
15
|
-
"@git.zone/tstest": "^3.6.
|
|
16
|
-
"@types/node": "^25.
|
|
12
|
+
"@git.zone/tsbuild": "^4.4.2",
|
|
13
|
+
"@git.zone/tsbundle": "^2.10.4",
|
|
14
|
+
"@git.zone/tsrun": "^2.0.4",
|
|
15
|
+
"@git.zone/tstest": "^3.6.6",
|
|
16
|
+
"@types/node": "^25.9.1"
|
|
17
17
|
},
|
|
18
18
|
"dependencies": {
|
|
19
19
|
"@api.global/typedrequest": "^3.3.0",
|
|
20
|
-
"@api.global/typedserver": "^8.
|
|
20
|
+
"@api.global/typedserver": "^8.5.3",
|
|
21
21
|
"@api.global/typedsocket": "^4.1.2",
|
|
22
|
-
"@push.rocks/qenv": "^6.1.
|
|
22
|
+
"@push.rocks/qenv": "^6.1.4",
|
|
23
23
|
"@push.rocks/smartlog": "^3.2.2",
|
|
24
|
-
"@push.rocks/smartntml": "^2.0.
|
|
25
|
-
"@serve.zone/interfaces": "^5.
|
|
24
|
+
"@push.rocks/smartntml": "^2.0.9",
|
|
25
|
+
"@serve.zone/interfaces": "^5.5.0"
|
|
26
26
|
},
|
|
27
27
|
"repository": {
|
|
28
28
|
"type": "git",
|
|
29
|
-
"url": "git+https://
|
|
29
|
+
"url": "git+https://code.foss.global/serve.zone/platformclient.git"
|
|
30
30
|
},
|
|
31
31
|
"bugs": {
|
|
32
|
-
"url": "https://
|
|
32
|
+
"url": "https://code.foss.global/serve.zone/platformclient/issues"
|
|
33
33
|
},
|
|
34
|
-
"homepage": "https://
|
|
34
|
+
"homepage": "https://code.foss.global/serve.zone/platformclient#readme",
|
|
35
35
|
"browserslist": [
|
|
36
36
|
"last 1 chrome versions"
|
|
37
37
|
],
|
package/readme.md
CHANGED
|
@@ -1,78 +1,83 @@
|
|
|
1
1
|
# @serve.zone/platformclient
|
|
2
2
|
|
|
3
|
-
`@serve.zone/platformclient` is the
|
|
4
|
-
|
|
5
|
-
Use it when your app should trigger serve.zone communication workflows without manually wiring TypedRequest methods or transport setup.
|
|
3
|
+
`@serve.zone/platformclient` is the application SDK for serve.zone platform services. It opens a TypedSocket connection to a platform endpoint and gives application code focused connectors for transactional email, SMS, push notifications, and physical letters without hand-writing TypedRequest setup.
|
|
6
4
|
|
|
7
5
|
## Issue Reporting and Security
|
|
8
6
|
|
|
9
7
|
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
|
10
8
|
|
|
11
|
-
##
|
|
9
|
+
## Install
|
|
12
10
|
|
|
13
11
|
```bash
|
|
14
12
|
pnpm add @serve.zone/platformclient
|
|
15
13
|
```
|
|
16
14
|
|
|
17
|
-
## What It Does
|
|
18
|
-
|
|
19
|
-
`SzPlatformClient` handles the shared serve.zone platform connection and gives you these connectors:
|
|
20
|
-
|
|
21
|
-
| Connector | Purpose | TypedRequest method |
|
|
22
|
-
| --- | --- | --- |
|
|
23
|
-
| `emailConnector` | Send transactional email | `sendEmail` |
|
|
24
|
-
| `smsConnector` | Send SMS messages and verification codes | `sendSms`, `sendVerificationCode` |
|
|
25
|
-
| `pushNotificationConnector` | Send push notifications | `sendPushNotification` |
|
|
26
|
-
| `letterConnector` | Send physical letters through the platform | `sendLetter` |
|
|
27
|
-
|
|
28
|
-
Requests use the types from `@serve.zone/interfaces`, so payloads stay aligned with the serve.zone backend contracts.
|
|
29
|
-
|
|
30
15
|
## Quick Start
|
|
31
16
|
|
|
32
17
|
```typescript
|
|
33
18
|
import { SzPlatformClient } from '@serve.zone/platformclient';
|
|
34
19
|
|
|
35
|
-
const platformClient = new SzPlatformClient(
|
|
20
|
+
const platformClient = new SzPlatformClient({
|
|
21
|
+
token: process.env.SERVEZONE_PLATFORM_TOKEN,
|
|
22
|
+
platformUrl: process.env.SERVEZONE_PLATFORM_URL,
|
|
23
|
+
});
|
|
24
|
+
|
|
36
25
|
await platformClient.init();
|
|
37
26
|
|
|
38
27
|
await platformClient.emailConnector.sendEmail({
|
|
39
28
|
to: 'user@example.com',
|
|
40
|
-
from: 'hello@
|
|
41
|
-
title: '
|
|
42
|
-
body: 'Your workspace is ready.',
|
|
29
|
+
from: 'hello@example.com',
|
|
30
|
+
title: 'Workspace ready',
|
|
31
|
+
body: 'Your serve.zone workspace is ready.',
|
|
43
32
|
});
|
|
44
33
|
```
|
|
45
34
|
|
|
46
|
-
|
|
35
|
+
## Connectors
|
|
36
|
+
|
|
37
|
+
`SzPlatformClient` owns the shared connection and exposes connector instances:
|
|
38
|
+
|
|
39
|
+
| Connector | Main methods | Platform capability |
|
|
40
|
+
| --- | --- | --- |
|
|
41
|
+
| `emailConnector` | `sendEmail()` | `email` |
|
|
42
|
+
| `smsConnector` | `sendSms()`, `sendSmsVerifcation()` | `sms` |
|
|
43
|
+
| `pushNotificationConnector` | `sendPushNotification()` | `pushnotification` |
|
|
44
|
+
| `letterConnector` | `sendLetter()` | `letter` |
|
|
45
|
+
|
|
46
|
+
The request and response payloads come from `@serve.zone/interfaces`, so TypeScript stays aligned with the serve.zone platform contracts.
|
|
47
47
|
|
|
48
48
|
## Configuration
|
|
49
49
|
|
|
50
|
-
The client needs
|
|
50
|
+
The client needs an authorization string and a platform endpoint. You can provide both directly, through environment variables, or through platform bindings.
|
|
51
51
|
|
|
52
|
-
| Value |
|
|
53
|
-
| --- | --- |
|
|
54
|
-
| Authorization
|
|
55
|
-
| Platform URL |
|
|
56
|
-
|
|
|
52
|
+
| Value | Sources |
|
|
53
|
+
| --- | --- |
|
|
54
|
+
| Authorization | Constructor string, `authorizationString`, `authorization`, `token`, `init()` argument, `SERVEZONE_PLATFORM_AUTHORIZATION`, `SERVEZONE_PLATFORM_TOKEN`, or binding credentials. |
|
|
55
|
+
| Platform URL | `url`, `platformUrl`, `SERVEZONE_PLATFORM_URL`, or the first active binding endpoint using `typedrequest` or `http`. |
|
|
56
|
+
| Platform bindings | Constructor `binding` or `bindings`, `SERVEZONE_PLATFORM_BINDING`, or `SERVEZONE_PLATFORM_BINDINGS`. |
|
|
57
|
+
|
|
58
|
+
Binding environment variables must contain JSON encoded `IPlatformBinding` objects from `@serve.zone/interfaces`.
|
|
57
59
|
|
|
58
60
|
```typescript
|
|
59
|
-
|
|
60
|
-
await client.init('your-platform-authorization-token');
|
|
61
|
-
```
|
|
61
|
+
import { SzPlatformClient } from '@serve.zone/platformclient';
|
|
62
62
|
|
|
63
|
-
|
|
63
|
+
const client = new SzPlatformClient(process.env.SERVEZONE_PLATFORM_AUTHORIZATION);
|
|
64
|
+
await client.init();
|
|
65
|
+
```
|
|
64
66
|
|
|
65
67
|
```typescript
|
|
68
|
+
import { SzPlatformClient } from '@serve.zone/platformclient';
|
|
69
|
+
|
|
66
70
|
const client = new SzPlatformClient({
|
|
67
|
-
|
|
68
|
-
|
|
71
|
+
authorization: process.env.SERVEZONE_PLATFORM_AUTHORIZATION,
|
|
72
|
+
url: process.env.SERVEZONE_PLATFORM_URL,
|
|
69
73
|
});
|
|
74
|
+
|
|
70
75
|
await client.init();
|
|
71
76
|
```
|
|
72
77
|
|
|
73
78
|
## Debug Mode
|
|
74
79
|
|
|
75
|
-
Pass `test` as the authorization string to
|
|
80
|
+
Pass `test` as the authorization string to activate debug mode. In debug mode, the client does not open a TypedSocket connection. Connector methods log or return deterministic test values instead of sending real platform requests.
|
|
76
81
|
|
|
77
82
|
```typescript
|
|
78
83
|
const client = new SzPlatformClient('test');
|
|
@@ -80,7 +85,7 @@ await client.init();
|
|
|
80
85
|
|
|
81
86
|
await client.emailConnector.sendEmail({
|
|
82
87
|
to: 'developer@example.com',
|
|
83
|
-
from: 'hello@
|
|
88
|
+
from: 'hello@example.com',
|
|
84
89
|
title: 'Preview only',
|
|
85
90
|
body: 'This message is logged, not sent.',
|
|
86
91
|
});
|
|
@@ -89,23 +94,26 @@ const verificationCode = await client.smsConnector.sendSmsVerifcation({
|
|
|
89
94
|
toNumber: 491234567890,
|
|
90
95
|
fromName: 'ServeZone',
|
|
91
96
|
});
|
|
92
|
-
|
|
97
|
+
|
|
98
|
+
console.log(verificationCode); // 123456
|
|
93
99
|
```
|
|
94
100
|
|
|
101
|
+
The current SMS verification method is spelled `sendSmsVerifcation()` in code. Use that exact method name until the public API changes.
|
|
102
|
+
|
|
95
103
|
## Connector Examples
|
|
96
104
|
|
|
97
|
-
|
|
105
|
+
Email:
|
|
98
106
|
|
|
99
107
|
```typescript
|
|
100
108
|
await client.emailConnector.sendEmail({
|
|
101
109
|
to: 'user@example.com',
|
|
102
|
-
from: 'hello@
|
|
110
|
+
from: 'hello@example.com',
|
|
103
111
|
title: 'Invoice ready',
|
|
104
112
|
body: 'Your invoice is available in the dashboard.',
|
|
105
113
|
});
|
|
106
114
|
```
|
|
107
115
|
|
|
108
|
-
|
|
116
|
+
SMS:
|
|
109
117
|
|
|
110
118
|
```typescript
|
|
111
119
|
const status = await client.smsConnector.sendSms({
|
|
@@ -115,16 +123,7 @@ const status = await client.smsConnector.sendSms({
|
|
|
115
123
|
});
|
|
116
124
|
```
|
|
117
125
|
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
```typescript
|
|
121
|
-
const code = await client.smsConnector.sendSmsVerifcation({
|
|
122
|
-
toNumber: 491234567890,
|
|
123
|
-
fromName: 'ServeZone',
|
|
124
|
-
});
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
### Push Notifications
|
|
126
|
+
Push notification:
|
|
128
127
|
|
|
129
128
|
```typescript
|
|
130
129
|
const status = await client.pushNotificationConnector.sendPushNotification({
|
|
@@ -133,7 +132,7 @@ const status = await client.pushNotificationConnector.sendPushNotification({
|
|
|
133
132
|
});
|
|
134
133
|
```
|
|
135
134
|
|
|
136
|
-
|
|
135
|
+
Letter:
|
|
137
136
|
|
|
138
137
|
```typescript
|
|
139
138
|
await client.letterConnector.sendLetter({
|
|
@@ -145,25 +144,32 @@ await client.letterConnector.sendLetter({
|
|
|
145
144
|
});
|
|
146
145
|
```
|
|
147
146
|
|
|
148
|
-
Exact
|
|
147
|
+
Exact fields are defined in `@serve.zone/interfaces` under `platform.email`, `platform.sms`, `platform.pushnotification`, and `platform.letter`.
|
|
149
148
|
|
|
150
|
-
##
|
|
149
|
+
## Platform Bindings
|
|
151
150
|
|
|
152
|
-
|
|
151
|
+
Platform bindings allow a workload to discover endpoint URLs and credentials from its runtime environment.
|
|
153
152
|
|
|
154
153
|
```typescript
|
|
155
|
-
import {
|
|
154
|
+
import { SzPlatformClient } from '@serve.zone/platformclient';
|
|
155
|
+
import { platform } from '@serve.zone/interfaces';
|
|
156
156
|
|
|
157
|
-
const
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
157
|
+
const binding: platform.IPlatformBinding = JSON.parse(
|
|
158
|
+
process.env.SERVEZONE_PLATFORM_BINDING!
|
|
159
|
+
);
|
|
160
|
+
|
|
161
|
+
const client = new SzPlatformClient({ binding });
|
|
162
|
+
await client.init();
|
|
163
163
|
|
|
164
|
-
|
|
164
|
+
const emailBinding = client.getPlatformBinding('email');
|
|
165
165
|
```
|
|
166
166
|
|
|
167
|
+
Bindings with `desiredState: 'disabled'` or `status: 'failed'` are ignored when the client auto-selects an endpoint.
|
|
168
|
+
|
|
169
|
+
## InfoHtml Helper
|
|
170
|
+
|
|
171
|
+
The repository also contains a small `ts_infohtml` source folder for rendering simple informational HTML pages from text or options. It is not exported from the package root, so treat it as a source-level helper rather than the main SDK API.
|
|
172
|
+
|
|
167
173
|
## Development
|
|
168
174
|
|
|
169
175
|
```bash
|
|
@@ -172,16 +178,7 @@ pnpm test
|
|
|
172
178
|
pnpm run build
|
|
173
179
|
```
|
|
174
180
|
|
|
175
|
-
The package is authored
|
|
176
|
-
|
|
177
|
-
## Links
|
|
178
|
-
|
|
179
|
-
| Resource | URL |
|
|
180
|
-
| --- | --- |
|
|
181
|
-
| npm package | <https://www.npmjs.com/package/@serve.zone/platformclient> |
|
|
182
|
-
| Source | <https://gitlab.com/serve.zone/platformclient> |
|
|
183
|
-
| Source mirror | <https://github.com/serve.zone/platformclient> |
|
|
184
|
-
| Typedoc | <https://serve.zone.gitlab.io/platformclient/> |
|
|
181
|
+
The package is authored as ESM TypeScript and builds source folders with `tsbuild tsfolders --web --allowimplicitany`.
|
|
185
182
|
|
|
186
183
|
## License and Legal Information
|
|
187
184
|
|
|
@@ -197,7 +194,7 @@ Use of these trademarks must comply with Task Venture Capital GmbH's Trademark G
|
|
|
197
194
|
|
|
198
195
|
### Company Information
|
|
199
196
|
|
|
200
|
-
Task Venture Capital GmbH
|
|
197
|
+
Task Venture Capital GmbH
|
|
201
198
|
Registered at District Court Bremen HRB 35230 HB, Germany
|
|
202
199
|
|
|
203
200
|
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
package/ts/00_commitinfo_data.ts
CHANGED
|
@@ -25,7 +25,7 @@ export class SzPushNotificationConnector {
|
|
|
25
25
|
);
|
|
26
26
|
const response = await typedRequest.fire(optionsArg);
|
|
27
27
|
|
|
28
|
-
if (process.env
|
|
28
|
+
if (typeof process !== 'undefined' && process.env?.SERVEZONE_PLATFORMCLIENT_DEBUG) {
|
|
29
29
|
console.log('sendPushNotification response', response);
|
|
30
30
|
}
|
|
31
31
|
|