@antelopejs/interface-dms 0.3.4 → 0.3.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/CHANGELOG.md +16 -0
- package/dist/invites.d.ts +10 -5
- package/dist/invites.js +21 -3
- package/dist/invites.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## v0.3.5
|
|
4
|
+
|
|
5
|
+
[compare changes](https://github.com/AntelopeJS/dms/compare/interface-v0.3.4...v0.3.5)
|
|
6
|
+
|
|
7
|
+
### 🩹 Fixes
|
|
8
|
+
|
|
9
|
+
- **invites:** Tell the inviter when the invitation e-mail was not sent ([#122](https://github.com/AntelopeJS/dms/pull/122))
|
|
10
|
+
|
|
11
|
+
### 🏡 Chore
|
|
12
|
+
|
|
13
|
+
- **release:** @antelopejs/dms v0.5.3 ([335141d](https://github.com/AntelopeJS/dms/commit/335141d))
|
|
14
|
+
|
|
15
|
+
### ❤️ Contributors
|
|
16
|
+
|
|
17
|
+
- Antony Rizzitelli <rizzitelli.antony@pm.me>
|
|
18
|
+
|
|
3
19
|
## v0.3.4
|
|
4
20
|
|
|
5
21
|
[compare changes](https://github.com/AntelopeJS/dms/compare/interface-v0.3.3...v0.3.4)
|
package/dist/invites.d.ts
CHANGED
|
@@ -13,10 +13,12 @@ export interface InviteUserToTenantOptions {
|
|
|
13
13
|
asTenantOwner?: boolean;
|
|
14
14
|
skipEmailValidation?: boolean;
|
|
15
15
|
sendEmail?: boolean;
|
|
16
|
+
awaitEmailDelivery?: boolean;
|
|
16
17
|
inviterName?: string;
|
|
17
18
|
extensions?: InviteExtensionPayloads;
|
|
18
19
|
}
|
|
19
20
|
export declare function inviteeDisplayName(firstname?: string | null, lastname?: string | null): string | undefined;
|
|
21
|
+
export type InviteEmailDelivery = "sent" | "failed";
|
|
20
22
|
export declare namespace internal {
|
|
21
23
|
interface TenantInviteEmail {
|
|
22
24
|
tenantId: string;
|
|
@@ -28,15 +30,18 @@ export declare namespace internal {
|
|
|
28
30
|
inviterName?: string;
|
|
29
31
|
}
|
|
30
32
|
function sendTenantInviteEmail(invite: TenantInviteEmail): Promise<void>;
|
|
33
|
+
function deliverTenantInviteEmail(invite: TenantInviteEmail): Promise<InviteEmailDelivery>;
|
|
31
34
|
}
|
|
32
|
-
export
|
|
33
|
-
kind: "added";
|
|
34
|
-
userId: string;
|
|
35
|
-
} | {
|
|
35
|
+
export interface InvitedUserResult {
|
|
36
36
|
kind: "invited";
|
|
37
37
|
inviteId: string;
|
|
38
38
|
token: string;
|
|
39
|
-
|
|
39
|
+
emailDelivery?: InviteEmailDelivery;
|
|
40
|
+
}
|
|
41
|
+
export type InviteUserToTenantResult = {
|
|
42
|
+
kind: "added";
|
|
43
|
+
userId: string;
|
|
44
|
+
} | InvitedUserResult;
|
|
40
45
|
export declare function inviteUserToTenant(options: InviteUserToTenantOptions): Promise<InviteUserToTenantResult>;
|
|
41
46
|
export interface CreateUserInviteTokenOptions {
|
|
42
47
|
tenantId: string;
|
package/dist/invites.js
CHANGED
|
@@ -44,13 +44,31 @@ var internal;
|
|
|
44
44
|
});
|
|
45
45
|
}
|
|
46
46
|
internal.sendTenantInviteEmail = sendTenantInviteEmail;
|
|
47
|
+
async function deliverTenantInviteEmail(invite) {
|
|
48
|
+
try {
|
|
49
|
+
await sendTenantInviteEmail(invite);
|
|
50
|
+
return "sent";
|
|
51
|
+
}
|
|
52
|
+
catch (error) {
|
|
53
|
+
logging_1.Logging.Error(`[DMS] invite email to "${invite.email}" could not be sent:`, error);
|
|
54
|
+
return "failed";
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
internal.deliverTenantInviteEmail = deliverTenantInviteEmail;
|
|
47
58
|
})(internal || (exports.internal = internal = {}));
|
|
48
59
|
async function inviteUserToTenant(options) {
|
|
49
60
|
const result = await (0, tenant_lifecycle_1.runTenantLifecycleOperation)(options.tenantId, () => inviteAdmittedUser(options));
|
|
50
|
-
if (options.sendEmail
|
|
51
|
-
|
|
61
|
+
if (!options.sendEmail || result.kind !== "invited")
|
|
62
|
+
return result;
|
|
63
|
+
const invite = { ...options, token: result.token };
|
|
64
|
+
if (!options.awaitEmailDelivery) {
|
|
65
|
+
(0, fire_and_forget_1.fireAndForget)(internal.sendTenantInviteEmail(invite), `invite email to "${options.email}"`);
|
|
66
|
+
return result;
|
|
52
67
|
}
|
|
53
|
-
return
|
|
68
|
+
return {
|
|
69
|
+
...result,
|
|
70
|
+
emailDelivery: await internal.deliverTenantInviteEmail(invite),
|
|
71
|
+
};
|
|
54
72
|
}
|
|
55
73
|
async function inviteAdmittedUser(options) {
|
|
56
74
|
const { tenantId, email, firstname = null, lastname = null, language = "en", roleIds = [], asTenantOwner = false, skipEmailValidation = false, extensions, } = options;
|
package/dist/invites.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"invites.js","sourceRoot":"","sources":["../src/invites.ts"],"names":[],"mappings":";;;;;;
|
|
1
|
+
{"version":3,"file":"invites.js","sourceRoot":"","sources":["../src/invites.ts"],"names":[],"mappings":";;;;;;AAuDA,gDASC;AAiGD,gDAmBC;AA0GD,sDAMC;AApSD,6CAAyC;AACzC,gEAA6D;AAC7D,6FAAqE;AACrE,6BAKc;AACd,iCAA8C;AAC9C,kCAAsD;AACtD,gEAAwC;AACxC,6DAAwD;AACxD,uCAAoD;AACpD,mCAA2E;AAE3E,2DAAuE;AACvE,2DAG6B;AAC7B,yDAAiE;AACjE,yDAAkE;AAErD,QAAA,mBAAmB,GAAG,EAAE,CAAC;AACzB,QAAA,kBAAkB,GAAG,CAAC,CAAC;AA8BpC,SAAgB,kBAAkB,CAChC,SAAyB,EACzB,QAAwB;IAExB,MAAM,IAAI,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC;SAC/B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;SACxB,IAAI,CAAC,GAAG,CAAC;SACT,IAAI,EAAE,CAAC;IACV,OAAO,IAAI,IAAI,SAAS,CAAC;AAC3B,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,QAAgB;IACxC,MAAM,MAAM,GAAG,MAAM,IAAA,wCAAQ,EAAC,gBAAW,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACzD,OAAO,MAAM,EAAE,IAAI,IAAI,SAAS,CAAC;AACnC,CAAC;AAQD,IAAiB,QAAQ,CAmDxB;AAnDD,WAAiB,QAAQ;IAiBhB,KAAK,UAAU,qBAAqB,CACzC,MAAyB;QAEzB,MAAM,IAAA,2BAAoB,EACxB,MAAM,CAAC,KAAK,EACZ,MAAM,CAAC,KAAK,EACZ,kBAAkB,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,EACrD;YACE,aAAa,EAAE,MAAM,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;YAChD,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,QAAQ,EAAE,MAAM,CAAC,QAAQ;SAC1B,CACF,CAAC;IACJ,CAAC;IAbqB,8BAAqB,wBAa1C,CAAA;IAOM,KAAK,UAAU,wBAAwB,CAC5C,MAAyB;QAEzB,IAAI,CAAC;YACH,MAAM,qBAAqB,CAAC,MAAM,CAAC,CAAC;YACpC,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,iBAAO,CAAC,KAAK,CACX,0BAA0B,MAAM,CAAC,KAAK,sBAAsB,EAC5D,KAAK,CACN,CAAC;YACF,OAAO,QAAQ,CAAC;QAClB,CAAC;IACH,CAAC;IAbqB,iCAAwB,2BAa7C,CAAA;AACH,CAAC,EAnDgB,QAAQ,wBAAR,QAAQ,QAmDxB;AAiCM,KAAK,UAAU,kBAAkB,CACtC,OAAkC;IAElC,MAAM,MAAM,GAAG,MAAM,IAAA,8CAA2B,EAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,EAAE,CACtE,kBAAkB,CAAC,OAAO,CAAC,CAC5B,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IACnE,MAAM,MAAM,GAAG,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC;IACnD,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC;QAChC,IAAA,+BAAa,EACX,QAAQ,CAAC,qBAAqB,CAAC,MAAM,CAAC,EACtC,oBAAoB,OAAO,CAAC,KAAK,GAAG,CACrC,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,OAAO;QACL,GAAG,MAAM;QACT,aAAa,EAAE,MAAM,QAAQ,CAAC,wBAAwB,CAAC,MAAM,CAAC;KAC/D,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,kBAAkB,CAC/B,OAAkC;IAElC,MAAM,EACJ,QAAQ,EACR,KAAK,EACL,SAAS,GAAG,IAAI,EAChB,QAAQ,GAAG,IAAI,EACf,QAAQ,GAAG,IAAI,EACf,OAAO,GAAG,EAAE,EACZ,aAAa,GAAG,KAAK,EACrB,mBAAmB,GAAG,KAAK,EAC3B,UAAU,GACX,GAAG,OAAO,CAAC;IAEZ,MAAM,SAAS,GAAG,IAAA,wCAAQ,EAAC,cAAS,CAAC,CAAC;IACtC,MAAM,YAAY,GAAG,MAAM,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACvD,IAAI,YAAY,EAAE,CAAC;QACjB,MAAM,IAAA,+CAA4B,EAAC,SAAS,EAAE,YAAY,CAAC,GAAG,EAAE,QAAQ,EAAE;YACxE,OAAO;YACP,aAAa,EAAE,aAAa;SAC7B,CAAC,CAAC;QACH,MAAM,uBAAuB,CAC3B,QAAQ,EACR,KAAK,EACL,YAAY,CAAC,GAAG,EAChB,UAAU,CACX,CAAC;QACF,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,CAAC,GAAG,EAAE,CAAC;IACrD,CAAC;IAED,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,MAAM,yBAAyB,CAAC;QAC1D,QAAQ;QACR,KAAK;QACL,SAAS;QACT,QAAQ;QACR,QAAQ;QACR,OAAO;QACP,aAAa;QACb,mBAAmB;QACnB,UAAU;KACX,CAAC,CAAC;IAEH,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AAC9C,CAAC;AAOD,KAAK,UAAU,uBAAuB,CACpC,QAAgB,EAChB,KAAa,EACb,MAAc,EACd,UAA+C;IAE/C,IAAI,CAAC,UAAU;QAAE,OAAO;IACxB,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,IAAA,wCAAQ,EAAC,sBAAiB,EAAE,QAAQ,CAAC,CAAC,SAAS,CAClE,MAAM,CACP,CAAC;QACF,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,iDAAiD,KAAK,EAAE,CAAC,CAAC;QAC5E,CAAC;QACD,MAAM,IAAA,kCAAuB,EAAC,UAAU,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;IACzE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,iBAAO,CAAC,KAAK,CACX,gCAAgC,KAAK,yCAAyC,EAC9E,KAAK,CACN,CAAC;IACJ,CAAC;AACH,CAAC;AAgCM,KAAK,UAAU,qBAAqB,CACzC,OAAqC;IAErC,OAAO,IAAA,8CAA2B,EAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,EAAE,CACxD,yBAAyB,CAAC,OAAO,CAAC,CACnC,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,yBAAyB,CACtC,OAAqC;IAErC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAC5D,MAAM,eAAe,GAAG,IAAA,wCAAQ,EAAC,oBAAe,EAAE,QAAQ,CAAC,CAAC;IAC5D,MAAM,cAAc,GAClB,OAAO,CAAC,cAAc,IAAI,CAAC,MAAM,eAAe,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IACtE,MAAM,WAAW,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACjD,IAAI,cAAc,EAAE,CAAC;QACnB,MAAM,UAAU,GAAG,MAAM,IAAA,gCAAY,EAAC;YACpC,QAAQ;YACR,MAAM,EAAE,cAAc;YACtB,MAAM,EAAE,OAAO,CAAC,iBAAiB,IAAI,UAAU;YAC/C,WAAW;SACZ,CAAC,CAAC;QACH,MAAM,IAAA,oDAAgC,EAAC,UAAU,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,CAAC,WAAW;YACzB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,OAAO;YACL,QAAQ,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG;YACpC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,KAAK;SACpC,CAAC;IACJ,CAAC;IACD,MAAM,IAAA,oBAAY,EAAC,YAAI,CAAC,oBAAoB,EAAE;QAC5C,QAAQ;QACR,KAAK;QACL,aAAa;QACb,OAAO;KACR,CAAC,CAAC;IACH,MAAM,eAAe,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC1C,MAAM,IAAA,oBAAY,EAAC,YAAI,CAAC,cAAc,EAAE;QACtC,QAAQ;QACR,QAAQ,EAAE,WAAW,CAAC,GAAG;QACzB,KAAK,EAAE,WAAW,CAAC,KAAK;QACxB,KAAK;QACL,aAAa;QACb,OAAO;KACR,CAAC,CAAC;IACH,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,KAAK,EAAE,CAAC;AACjE,CAAC;AAED,SAAS,mBAAmB,CAC1B,OAAqC;IAErC,OAAO,oBAAe,CAAC,aAAa,CAAC;QACnC,GAAG,EAAE,IAAA,wBAAU,GAAE;QACjB,SAAS,EAAE,IAAI,IAAI,EAAE;QACrB,KAAK,EAAE,IAAA,mBAAc,EAAC,OAAO,CAAC,KAAK,CAAC;QACpC,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,IAAI;QACpC,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,IAAI;QAClC,SAAS,EAAE,OAAO,CAAC,OAAO;QAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,KAAK,EAAE,sBAAY,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,2BAAmB,EAAE,CAAC;QAC7D,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,SAAS,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,0BAAkB,GAAG,2BAAoB,CAAC;QAC3E,mBAAmB,EAAE,OAAO,CAAC,mBAAmB;QAChD,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,IAAI;KACvC,CAAC,CAAC;AACL,CAAC"}
|
package/package.json
CHANGED