@marinoscar/platform-api 0.0.0-stage → 0.1.0-next.4

package/dist/sharing/groups/groups.controller.js

@@ -0,0 +1,327 @@
+"use strict";
+// =============================================================================
+// The group routes: /api/groups (issue #728, PP-7.1)
+// =============================================================================
+//
+// Every route declares its permission through the app's access decorators
+// (there is no global guard); the GROUP rule (member, group admin, the
+// `groups:admin` override) is the services' decision, inside the request's
+// org-scoped transaction:
+//
+//   GET    /groups                        groups:read (scope=all: + groups:admin)
+//   POST   /groups                        groups:write
+//   GET    /groups/:id                    groups:read   member or groups:admin, else 404
+//   PATCH  /groups/:id                    groups:write  group admin or groups:admin
+//   DELETE /groups/:id                    groups:write  group admin or groups:admin
+//   GET    /groups/:id/members            groups:read   member or groups:admin
+//   POST   /groups/:id/members            groups:write  group admin
+//   PATCH  /groups/:id/members/:userId    groups:write  group admin
+//   DELETE /groups/:id/members/:userId    groups:read   self; others need groups:write + group admin
+//   GET    /groups/:id/invites            groups:read   group admin
+//   POST   /groups/:id/invites            groups:write  group admin
+//   DELETE /groups/:id/invites/:inviteId  groups:write  group admin
+// =============================================================================
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createGroupsController = createGroupsController;
+const common_1 = require("@nestjs/common");
+const swagger_1 = require("@nestjs/swagger");
+const groups_dto_1 = require("../dto/groups.dto");
+const permissions_1 = require("../permissions");
+const group_common_1 = require("./group-common");
+const group_invites_service_1 = require("./group-invites.service");
+const group_membership_service_1 = require("./group-membership.service");
+const groups_service_1 = require("./groups.service");
+const sharing_principal_decorator_1 = require("./sharing-principal.decorator");
+const NOT_FOUND = 'The group does not exist in your organization, or you are not a member (never 403: an id discloses nothing)';
+/**
+ * Creates the `GroupsController` class for one set of module options, its
+ * routes guarded by the app's access decorators. `SharingModule.forRoot()`
+ * calls it.
+ *
+ * @param options - the resolved module options.
+ * @returns the controller class.
+ *
+ * @stability experimental
+ */
+function createGroupsController(options) {
+    const access = options.host.access;
+    const CurrentPrincipal = (0, sharing_principal_decorator_1.createSharingPrincipalDecorator)(options.principal);
+    const READ = access.requirePermissions([permissions_1.SHARING_PERMISSIONS.GROUPS_READ]);
+    const WRITE = access.requirePermissions([permissions_1.SHARING_PERMISSIONS.GROUPS_WRITE]);
+    let GroupsController = class GroupsController {
+        groups;
+        members;
+        invites;
+        constructor(groups, members, invites) {
+            this.groups = groups;
+            this.members = members;
+            this.invites = invites;
+        }
+        // ---- groups -----------------------------------------------------------------
+        list(principal, query) {
+            return this.groups.list(principal, query);
+        }
+        create(principal, body) {
+            return this.groups.create(principal, body);
+        }
+        get(principal, id) {
+            return this.groups.get(principal, id);
+        }
+        update(principal, id, body, ifMatch) {
+            return this.groups.update(principal, id, body, (0, group_common_1.parseIfMatch)(ifMatch));
+        }
+        async delete(principal, id) {
+            await this.groups.delete(principal, id);
+        }
+        // ---- members ----------------------------------------------------------------
+        listMembers(principal, id, query) {
+            return this.members.list(principal, id, query);
+        }
+        addMember(principal, id, body) {
+            return this.members.add(principal, id, body);
+        }
+        changeRole(principal, id, userId, body) {
+            return this.members.changeRole(principal, id, userId, body.role);
+        }
+        async removeMember(principal, id, userId) {
+            await this.members.remove(principal, id, userId);
+        }
+        // ---- invites ----------------------------------------------------------------
+        listInvites(principal, id, query) {
+            return this.invites.list(principal, id, query);
+        }
+        createInvite(principal, id, body) {
+            return this.invites.create(principal, id, body);
+        }
+        async revokeInvite(principal, id, inviteId) {
+            await this.invites.revoke(principal, id, inviteId);
+        }
+    };
+    __decorate([
+        (0, common_1.Get)(),
+        READ,
+        (0, swagger_1.ApiOperation)({
+            summary: 'List groups',
+            description: '`scope=mine` (default): the groups of your active organization you belong to. `scope=all`: every group ' +
+                'of the organization, which also needs `groups:admin` (403 otherwise). Flat pagination, by name.',
+        }),
+        (0, swagger_1.ApiResponse)({ status: 200, type: groups_dto_1.GroupListResponseDto }),
+        __param(0, CurrentPrincipal()),
+        __param(1, (0, common_1.Query)()),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object, groups_dto_1.GroupListQueryDto]),
+        __metadata("design:returntype", void 0)
+    ], GroupsController.prototype, "list", null);
+    __decorate([
+        (0, common_1.Post)(),
+        WRITE,
+        (0, swagger_1.ApiOperation)({
+            summary: 'Create a group',
+            description: 'Creates a group in your active organization and makes you its `admin`, in one transaction. 409 ' +
+                '`GROUP_LIMIT_REACHED` past the per-creator limit. Requires `groups:write`.',
+        }),
+        (0, swagger_1.ApiResponse)({ status: 201, type: groups_dto_1.GroupResponseDto }),
+        __param(0, CurrentPrincipal()),
+        __param(1, (0, common_1.Body)()),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object, groups_dto_1.CreateGroupDto]),
+        __metadata("design:returntype", void 0)
+    ], GroupsController.prototype, "create", null);
+    __decorate([
+        (0, common_1.Get)(':id'),
+        READ,
+        (0, swagger_1.ApiParam)({ name: 'id', format: 'uuid' }),
+        (0, swagger_1.ApiOperation)({
+            summary: 'Get a group',
+            description: 'For a member of the group or a `groups:admin` holder. Anyone else gets 404, never 403. Requires `groups:read`.',
+        }),
+        (0, swagger_1.ApiResponse)({ status: 200, type: groups_dto_1.GroupResponseDto }),
+        (0, swagger_1.ApiResponse)({ status: 404, description: NOT_FOUND }),
+        __param(0, CurrentPrincipal()),
+        __param(1, (0, common_1.Param)('id', new common_1.ParseUUIDPipe())),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object, String]),
+        __metadata("design:returntype", void 0)
+    ], GroupsController.prototype, "get", null);
+    __decorate([
+        (0, common_1.Patch)(':id'),
+        WRITE,
+        (0, swagger_1.ApiParam)({ name: 'id', format: 'uuid' }),
+        (0, swagger_1.ApiHeader)({ name: 'If-Match', required: false, description: "The group's `version`; a stale one answers 409 `VERSION_CONFLICT`." }),
+        (0, swagger_1.ApiOperation)({
+            summary: 'Update a group',
+            description: 'Name, description or metadata. For a group `admin` or a `groups:admin` holder (a member with another role ' +
+                'gets 403, anyone else 404). Send the `version` in `If-Match`. Requires `groups:write`.',
+        }),
+        (0, swagger_1.ApiResponse)({ status: 200, type: groups_dto_1.GroupResponseDto }),
+        __param(0, CurrentPrincipal()),
+        __param(1, (0, common_1.Param)('id', new common_1.ParseUUIDPipe())),
+        __param(2, (0, common_1.Body)()),
+        __param(3, (0, common_1.Headers)('if-match')),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object, String, groups_dto_1.UpdateGroupDto, String]),
+        __metadata("design:returntype", void 0)
+    ], GroupsController.prototype, "update", null);
+    __decorate([
+        (0, common_1.Delete)(':id'),
+        WRITE,
+        (0, common_1.HttpCode)(common_1.HttpStatus.NO_CONTENT),
+        (0, swagger_1.ApiParam)({ name: 'id', format: 'uuid' }),
+        (0, swagger_1.ApiOperation)({
+            summary: 'Delete a group',
+            description: 'Removes the group with its members and invitations. Refused with 409 `GROUP_OWNS_RESOURCES` (and ' +
+                '`details.counts`, per resource type) while the group still owns resources. For a group `admin` or a ' +
+                '`groups:admin` holder. Requires `groups:write`.',
+        }),
+        (0, swagger_1.ApiResponse)({ status: 204, description: 'Deleted' }),
+        (0, swagger_1.ApiResponse)({ status: 409, description: '`GROUP_OWNS_RESOURCES`, with `details.counts`' }),
+        __param(0, CurrentPrincipal()),
+        __param(1, (0, common_1.Param)('id', new common_1.ParseUUIDPipe())),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object, String]),
+        __metadata("design:returntype", Promise)
+    ], GroupsController.prototype, "delete", null);
+    __decorate([
+        (0, common_1.Get)(':id/members'),
+        READ,
+        (0, swagger_1.ApiParam)({ name: 'id', format: 'uuid' }),
+        (0, swagger_1.ApiOperation)({ summary: 'List the members of a group', description: 'Admins first. For a member or a `groups:admin` holder. Requires `groups:read`.' }),
+        (0, swagger_1.ApiResponse)({ status: 200, type: groups_dto_1.GroupMemberListResponseDto }),
+        __param(0, CurrentPrincipal()),
+        __param(1, (0, common_1.Param)('id', new common_1.ParseUUIDPipe())),
+        __param(2, (0, common_1.Query)()),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object, String, groups_dto_1.PageQueryDto]),
+        __metadata("design:returntype", void 0)
+    ], GroupsController.prototype, "listMembers", null);
+    __decorate([
+        (0, common_1.Post)(':id/members'),
+        WRITE,
+        (0, swagger_1.ApiParam)({ name: 'id', format: 'uuid' }),
+        (0, swagger_1.ApiOperation)({
+            summary: 'Add a member to a group',
+            description: 'By `userId` or `email`; the person must be an active member of the organization (422 `NOT_AN_ORG_MEMBER` ' +
+                'otherwise, for an unknown address too). Failed lookups by e-mail are throttled per account (10 per 10 ' +
+                'minutes, approximate across replicas): past that, 429 `LOOKUP_THROTTLED` with `details.retryAfterMs` and ' +
+                '`Retry-After`. 409 `ALREADY_A_MEMBER` or `GROUP_FULL`. For a group `admin`. Requires `groups:write`.',
+        }),
+        (0, swagger_1.ApiResponse)({ status: 201, type: groups_dto_1.GroupMemberResponseDto }),
+        (0, swagger_1.ApiResponse)({ status: 422, description: '`NOT_AN_ORG_MEMBER`' }),
+        (0, swagger_1.ApiResponse)({ status: 429, description: '`LOOKUP_THROTTLED`' }),
+        __param(0, CurrentPrincipal()),
+        __param(1, (0, common_1.Param)('id', new common_1.ParseUUIDPipe())),
+        __param(2, (0, common_1.Body)()),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object, String, groups_dto_1.AddGroupMemberDto]),
+        __metadata("design:returntype", void 0)
+    ], GroupsController.prototype, "addMember", null);
+    __decorate([
+        (0, common_1.Patch)(':id/members/:userId'),
+        WRITE,
+        (0, swagger_1.ApiParam)({ name: 'id', format: 'uuid' }),
+        (0, swagger_1.ApiParam)({ name: 'userId', format: 'uuid' }),
+        (0, swagger_1.ApiOperation)({
+            summary: "Change a member's role",
+            description: 'The last `admin` cannot be demoted: 409 `LAST_GROUP_ADMIN` (promote another member first). For a group ' +
+                '`admin`. Requires `groups:write`.',
+        }),
+        (0, swagger_1.ApiResponse)({ status: 200, type: groups_dto_1.GroupMemberResponseDto }),
+        (0, swagger_1.ApiResponse)({ status: 409, description: '`LAST_GROUP_ADMIN`' }),
+        __param(0, CurrentPrincipal()),
+        __param(1, (0, common_1.Param)('id', new common_1.ParseUUIDPipe())),
+        __param(2, (0, common_1.Param)('userId', new common_1.ParseUUIDPipe())),
+        __param(3, (0, common_1.Body)()),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object, String, String, groups_dto_1.UpdateGroupMemberDto]),
+        __metadata("design:returntype", void 0)
+    ], GroupsController.prototype, "changeRole", null);
+    __decorate([
+        (0, common_1.Delete)(':id/members/:userId'),
+        READ,
+        (0, common_1.HttpCode)(common_1.HttpStatus.NO_CONTENT),
+        (0, swagger_1.ApiParam)({ name: 'id', format: 'uuid' }),
+        (0, swagger_1.ApiParam)({ name: 'userId', format: 'uuid' }),
+        (0, swagger_1.ApiOperation)({
+            summary: 'Leave a group, or remove a member',
+            description: 'With your own `userId`: leave the group (`groups:read` is enough). Anyone else: needs `groups:write` (403 ' +
+                'otherwise) and the group `admin` role. The last `admin` cannot leave: 409 `LAST_GROUP_ADMIN`.',
+        }),
+        (0, swagger_1.ApiResponse)({ status: 204, description: 'Removed' }),
+        (0, swagger_1.ApiResponse)({ status: 409, description: '`LAST_GROUP_ADMIN`' }),
+        __param(0, CurrentPrincipal()),
+        __param(1, (0, common_1.Param)('id', new common_1.ParseUUIDPipe())),
+        __param(2, (0, common_1.Param)('userId', new common_1.ParseUUIDPipe())),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object, String, String]),
+        __metadata("design:returntype", Promise)
+    ], GroupsController.prototype, "removeMember", null);
+    __decorate([
+        (0, common_1.Get)(':id/invites'),
+        READ,
+        (0, swagger_1.ApiParam)({ name: 'id', format: 'uuid' }),
+        (0, swagger_1.ApiOperation)({ summary: "List a group's invitations", description: '`status=pending` (default) or `all`, newest first. For a group `admin`. Requires `groups:read`.' }),
+        (0, swagger_1.ApiResponse)({ status: 200, type: groups_dto_1.GroupInviteListResponseDto }),
+        __param(0, CurrentPrincipal()),
+        __param(1, (0, common_1.Param)('id', new common_1.ParseUUIDPipe())),
+        __param(2, (0, common_1.Query)()),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object, String, groups_dto_1.GroupInviteListQueryDto]),
+        __metadata("design:returntype", void 0)
+    ], GroupsController.prototype, "listInvites", null);
+    __decorate([
+        (0, common_1.Post)(':id/invites'),
+        WRITE,
+        (0, swagger_1.ApiParam)({ name: 'id', format: 'uuid' }),
+        (0, swagger_1.ApiOperation)({
+            summary: 'Invite an address to a group',
+            description: 'One pending invitation per address (409 `INVITE_PENDING`); a declined or revoked address can be invited ' +
+                'again. In a multi-organization deployment the address must belong to a member of the organization or ' +
+                'have a pending invitation to it (422 `NOT_AN_ORG_MEMBER`). The invitee is notified (`groups.invitation`). ' +
+                'For a group `admin`. Requires `groups:write`.',
+        }),
+        (0, swagger_1.ApiResponse)({ status: 201, type: groups_dto_1.GroupInviteResponseDto }),
+        (0, swagger_1.ApiResponse)({ status: 409, description: '`INVITE_PENDING` or `ALREADY_A_MEMBER`' }),
+        __param(0, CurrentPrincipal()),
+        __param(1, (0, common_1.Param)('id', new common_1.ParseUUIDPipe())),
+        __param(2, (0, common_1.Body)()),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object, String, groups_dto_1.CreateGroupInviteDto]),
+        __metadata("design:returntype", void 0)
+    ], GroupsController.prototype, "createInvite", null);
+    __decorate([
+        (0, common_1.Delete)(':id/invites/:inviteId'),
+        WRITE,
+        (0, common_1.HttpCode)(common_1.HttpStatus.NO_CONTENT),
+        (0, swagger_1.ApiParam)({ name: 'id', format: 'uuid' }),
+        (0, swagger_1.ApiParam)({ name: 'inviteId', format: 'uuid' }),
+        (0, swagger_1.ApiOperation)({ summary: 'Revoke a group invitation', description: '409 `INVITE_NOT_PENDING` once answered. For a group `admin`. Requires `groups:write`.' }),
+        (0, swagger_1.ApiResponse)({ status: 204, description: 'Revoked' }),
+        __param(0, CurrentPrincipal()),
+        __param(1, (0, common_1.Param)('id', new common_1.ParseUUIDPipe())),
+        __param(2, (0, common_1.Param)('inviteId', new common_1.ParseUUIDPipe())),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object, String, String]),
+        __metadata("design:returntype", Promise)
+    ], GroupsController.prototype, "revokeInvite", null);
+    GroupsController = __decorate([
+        (0, swagger_1.ApiTags)('Groups'),
+        (0, common_1.Controller)('groups'),
+        __metadata("design:paramtypes", [groups_service_1.GroupsService,
+            group_membership_service_1.GroupMembershipService,
+            group_invites_service_1.GroupInvitesService])
+    ], GroupsController);
+    return GroupsController;
+}
+//# sourceMappingURL=groups.controller.js.map

package/dist/sharing/groups/groups.controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"groups.controller.js","sourceRoot":"","sources":["../../../src/sharing/groups/groups.controller.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,qDAAqD;AACrD,gFAAgF;AAChF,EAAE;AACF,0EAA0E;AAC1E,uEAAuE;AACvE,2EAA2E;AAC3E,0BAA0B;AAC1B,EAAE;AACF,kFAAkF;AAClF,uDAAuD;AACvD,yFAAyF;AACzF,oFAAoF;AACpF,oFAAoF;AACpF,+EAA+E;AAC/E,oEAAoE;AACpE,oEAAoE;AACpE,qGAAqG;AACrG,oEAAoE;AACpE,oEAAoE;AACpE,oEAAoE;AACpE,gFAAgF;;;;;;;;;;;;;;AA0ChF,wDAiNC;AAzPD,2CAA8I;AAC9I,6CAA0F;AAG1F,kDAe2B;AAC3B,gDAAqD;AAErD,iDAA8C;AAC9C,mEAA8D;AAC9D,yEAAoE;AACpE,qDAAiD;AACjD,+EAAgF;AAEhF,MAAM,SAAS,GAAG,6GAA6G,CAAC;AAEhI;;;;;;;;;GASG;AACH,SAAgB,sBAAsB,CAAC,OAAqC;IAC1E,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;IACnC,MAAM,gBAAgB,GAAG,IAAA,6DAA+B,EAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5E,MAAM,IAAI,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC,iCAAmB,CAAC,WAAW,CAAC,CAAC,CAAC;IAC1E,MAAM,KAAK,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC,iCAAmB,CAAC,YAAY,CAAC,CAAC,CAAC;IAE5E,IAEM,gBAAgB,GAFtB,MAEM,gBAAgB;QAED;QACA;QACA;QAHnB,YACmB,MAAqB,EACrB,OAA+B,EAC/B,OAA4B;YAF5B,WAAM,GAAN,MAAM,CAAe;YACrB,YAAO,GAAP,OAAO,CAAwB;YAC/B,YAAO,GAAP,OAAO,CAAqB;QAC5C,CAAC;QAEJ,gFAAgF;QAWhF,IAAI,CAAqB,SAAoB,EAAW,KAAwB;YAC9E,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAC5C,CAAC;QAWD,MAAM,CAAqB,SAAoB,EAAU,IAAoB;YAC3E,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC7C,CAAC;QAWD,GAAG,CAAqB,SAAoB,EAAoC,EAAU;YACxF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACxC,CAAC;QAaD,MAAM,CACgB,SAAoB,EACN,EAAU,EACpC,IAAoB,EACP,OAAgB;YAErC,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,IAAA,2BAAY,EAAC,OAAO,CAAC,CAAC,CAAC;QACxE,CAAC;QAeK,AAAN,KAAK,CAAC,MAAM,CAAqB,SAAoB,EAAoC,EAAU;YACjG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAC1C,CAAC;QAED,gFAAgF;QAOhF,WAAW,CAAqB,SAAoB,EAAoC,EAAU,EAAW,KAAmB;YAC9H,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC;QAgBD,SAAS,CAAqB,SAAoB,EAAoC,EAAU,EAAU,IAAuB;YAC/H,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;QAC/C,CAAC;QAcD,UAAU,CACY,SAAoB,EACN,EAAU,EACN,MAAc,EAC5C,IAA0B;YAElC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACnE,CAAC;QAeK,AAAN,KAAK,CAAC,YAAY,CACI,SAAoB,EACN,EAAU,EACN,MAAc;YAEpD,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;QACnD,CAAC;QAED,gFAAgF;QAOhF,WAAW,CAAqB,SAAoB,EAAoC,EAAU,EAAW,KAA8B;YACzI,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC;QAeD,YAAY,CAAqB,SAAoB,EAAoC,EAAU,EAAU,IAA0B;YACrI,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;QAClD,CAAC;QASK,AAAN,KAAK,CAAC,YAAY,CACI,SAAoB,EACN,EAAU,EACJ,QAAgB;YAExD,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;QACrD,CAAC;KACF,CAAA;IApLC;QATC,IAAA,YAAG,GAAE;QACL,IAAI;QACJ,IAAA,sBAAY,EAAC;YACZ,OAAO,EAAE,aAAa;YACtB,WAAW,EACT,yGAAyG;gBACzG,iGAAiG;SACpG,CAAC;QACD,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,iCAAoB,EAAE,CAAC;QACnD,WAAA,gBAAgB,EAAE,CAAA;QAAwB,WAAA,IAAA,cAAK,GAAE,CAAA;;iDAAQ,8BAAiB;;gDAE/E;IAWD;QATC,IAAA,aAAI,GAAE;QACN,KAAK;QACL,IAAA,sBAAY,EAAC;YACZ,OAAO,EAAE,gBAAgB;YACzB,WAAW,EACT,iGAAiG;gBACjG,4EAA4E;SAC/E,CAAC;QACD,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,6BAAgB,EAAE,CAAC;QAC7C,WAAA,gBAAgB,EAAE,CAAA;QAAwB,WAAA,IAAA,aAAI,GAAE,CAAA;;iDAAO,2BAAc;;kDAE5E;IAWD;QATC,IAAA,YAAG,EAAC,KAAK,CAAC;QACV,IAAI;QACJ,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QACxC,IAAA,sBAAY,EAAC;YACZ,OAAO,EAAE,aAAa;YACtB,WAAW,EAAE,gHAAgH;SAC9H,CAAC;QACD,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,6BAAgB,EAAE,CAAC;QACpD,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC;QAChD,WAAA,gBAAgB,EAAE,CAAA;QAAwB,WAAA,IAAA,cAAK,EAAC,IAAI,EAAE,IAAI,sBAAa,EAAE,CAAC,CAAA;;;;+CAE9E;IAaD;QAXC,IAAA,cAAK,EAAC,KAAK,CAAC;QACZ,KAAK;QACL,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QACxC,IAAA,mBAAS,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,EAAE,oEAAoE,EAAE,CAAC;QACnI,IAAA,sBAAY,EAAC;YACZ,OAAO,EAAE,gBAAgB;YACzB,WAAW,EACT,4GAA4G;gBAC5G,wFAAwF;SAC3F,CAAC;QACD,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,6BAAgB,EAAE,CAAC;QAElD,WAAA,gBAAgB,EAAE,CAAA;QAClB,WAAA,IAAA,cAAK,EAAC,IAAI,EAAE,IAAI,sBAAa,EAAE,CAAC,CAAA;QAChC,WAAA,IAAA,aAAI,GAAE,CAAA;QACN,WAAA,IAAA,gBAAO,EAAC,UAAU,CAAC,CAAA;;yDADN,2BAAc;;kDAI7B;IAeK;QAbL,IAAA,eAAM,EAAC,KAAK,CAAC;QACb,KAAK;QACL,IAAA,iBAAQ,EAAC,mBAAU,CAAC,UAAU,CAAC;QAC/B,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QACxC,IAAA,sBAAY,EAAC;YACZ,OAAO,EAAE,gBAAgB;YACzB,WAAW,EACT,mGAAmG;gBACnG,sGAAsG;gBACtG,iDAAiD;SACpD,CAAC;QACD,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC;QACpD,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,+CAA+C,EAAE,CAAC;QAC7E,WAAA,gBAAgB,EAAE,CAAA;QAAwB,WAAA,IAAA,cAAK,EAAC,IAAI,EAAE,IAAI,sBAAa,EAAE,CAAC,CAAA;;;;kDAEvF;IASD;QALC,IAAA,YAAG,EAAC,aAAa,CAAC;QAClB,IAAI;QACJ,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QACxC,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,6BAA6B,EAAE,WAAW,EAAE,gFAAgF,EAAE,CAAC;QACvJ,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,uCAA0B,EAAE,CAAC;QAClD,WAAA,gBAAgB,EAAE,CAAA;QAAwB,WAAA,IAAA,cAAK,EAAC,IAAI,EAAE,IAAI,sBAAa,EAAE,CAAC,CAAA;QAAc,WAAA,IAAA,cAAK,GAAE,CAAA;;yDAAQ,yBAAY;;uDAE/H;IAgBD;QAdC,IAAA,aAAI,EAAC,aAAa,CAAC;QACnB,KAAK;QACL,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QACxC,IAAA,sBAAY,EAAC;YACZ,OAAO,EAAE,yBAAyB;YAClC,WAAW,EACT,2GAA2G;gBAC3G,wGAAwG;gBACxG,2GAA2G;gBAC3G,sGAAsG;SACzG,CAAC;QACD,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,mCAAsB,EAAE,CAAC;QAC1D,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,qBAAqB,EAAE,CAAC;QAChE,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,oBAAoB,EAAE,CAAC;QACrD,WAAA,gBAAgB,EAAE,CAAA;QAAwB,WAAA,IAAA,cAAK,EAAC,IAAI,EAAE,IAAI,sBAAa,EAAE,CAAC,CAAA;QAAc,WAAA,IAAA,aAAI,GAAE,CAAA;;yDAAO,8BAAiB;;qDAEhI;IAcD;QAZC,IAAA,cAAK,EAAC,qBAAqB,CAAC;QAC5B,KAAK;QACL,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QACxC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAC5C,IAAA,sBAAY,EAAC;YACZ,OAAO,EAAE,wBAAwB;YACjC,WAAW,EACT,yGAAyG;gBACzG,mCAAmC;SACtC,CAAC;QACD,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,mCAAsB,EAAE,CAAC;QAC1D,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,oBAAoB,EAAE,CAAC;QAE7D,WAAA,gBAAgB,EAAE,CAAA;QAClB,WAAA,IAAA,cAAK,EAAC,IAAI,EAAE,IAAI,sBAAa,EAAE,CAAC,CAAA;QAChC,WAAA,IAAA,cAAK,EAAC,QAAQ,EAAE,IAAI,sBAAa,EAAE,CAAC,CAAA;QACpC,WAAA,IAAA,aAAI,GAAE,CAAA;;iEAAO,iCAAoB;;sDAGnC;IAeK;QAbL,IAAA,eAAM,EAAC,qBAAqB,CAAC;QAC7B,IAAI;QACJ,IAAA,iBAAQ,EAAC,mBAAU,CAAC,UAAU,CAAC;QAC/B,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QACxC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAC5C,IAAA,sBAAY,EAAC;YACZ,OAAO,EAAE,mCAAmC;YAC5C,WAAW,EACT,4GAA4G;gBAC5G,+FAA+F;SAClG,CAAC;QACD,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC;QACpD,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,oBAAoB,EAAE,CAAC;QAE7D,WAAA,gBAAgB,EAAE,CAAA;QAClB,WAAA,IAAA,cAAK,EAAC,IAAI,EAAE,IAAI,sBAAa,EAAE,CAAC,CAAA;QAChC,WAAA,IAAA,cAAK,EAAC,QAAQ,EAAE,IAAI,sBAAa,EAAE,CAAC,CAAA;;;;wDAGtC;IASD;QALC,IAAA,YAAG,EAAC,aAAa,CAAC;QAClB,IAAI;QACJ,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QACxC,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,4BAA4B,EAAE,WAAW,EAAE,iGAAiG,EAAE,CAAC;QACvK,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,uCAA0B,EAAE,CAAC;QAClD,WAAA,gBAAgB,EAAE,CAAA;QAAwB,WAAA,IAAA,cAAK,EAAC,IAAI,EAAE,IAAI,sBAAa,EAAE,CAAC,CAAA;QAAc,WAAA,IAAA,cAAK,GAAE,CAAA;;yDAAQ,oCAAuB;;uDAE1I;IAeD;QAbC,IAAA,aAAI,EAAC,aAAa,CAAC;QACnB,KAAK;QACL,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QACxC,IAAA,sBAAY,EAAC;YACZ,OAAO,EAAE,8BAA8B;YACvC,WAAW,EACT,0GAA0G;gBAC1G,uGAAuG;gBACvG,4GAA4G;gBAC5G,+CAA+C;SAClD,CAAC;QACD,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,mCAAsB,EAAE,CAAC;QAC1D,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,wCAAwC,EAAE,CAAC;QACtE,WAAA,gBAAgB,EAAE,CAAA;QAAwB,WAAA,IAAA,cAAK,EAAC,IAAI,EAAE,IAAI,sBAAa,EAAE,CAAC,CAAA;QAAc,WAAA,IAAA,aAAI,GAAE,CAAA;;yDAAO,iCAAoB;;wDAEtI;IASK;QAPL,IAAA,eAAM,EAAC,uBAAuB,CAAC;QAC/B,KAAK;QACL,IAAA,iBAAQ,EAAC,mBAAU,CAAC,UAAU,CAAC;QAC/B,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QACxC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAC9C,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,2BAA2B,EAAE,WAAW,EAAE,uFAAuF,EAAE,CAAC;QAC5J,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC;QAElD,WAAA,gBAAgB,EAAE,CAAA;QAClB,WAAA,IAAA,cAAK,EAAC,IAAI,EAAE,IAAI,sBAAa,EAAE,CAAC,CAAA;QAChC,WAAA,IAAA,cAAK,EAAC,UAAU,EAAE,IAAI,sBAAa,EAAE,CAAC,CAAA;;;;wDAGxC;IArMG,gBAAgB;QAFrB,IAAA,iBAAO,EAAC,QAAQ,CAAC;QACjB,IAAA,mBAAU,EAAC,QAAQ,CAAC;yCAGQ,8BAAa;YACZ,iDAAsB;YACtB,2CAAmB;OAJ3C,gBAAgB,CAsMrB;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC"}

package/dist/sharing/groups/groups.service.d.ts

@@ -0,0 +1,81 @@
+import type { CreateGroupInput, GroupDto, GroupList, GroupListQuery, GroupRole, UpdateGroupInput } from '@marinoscar/platform-contract/sharing';
+import type { Principal } from '../../core/index';
+import { type GroupRow } from '../data/sharing-tx';
+import { type SharingDataPort } from '../ports';
+import { type ResolvedSharingModuleOptions } from '../sharing.options';
+import { GroupMembershipService } from './group-membership.service';
+import { SharingEffects } from './sharing-effects';
+/**
+ * One group row as the API returns it.
+ *
+ * @param row - the `groups` row.
+ * @param memberCount - its member count.
+ * @param myRole - the caller's role, or `null`.
+ * @returns the wire shape.
+ *
+ * @stability experimental
+ */
+export declare function toGroupDto(row: GroupRow, memberCount: number, myRole: GroupRole | null): GroupDto;
+/**
+ * Create, list, read, update and delete groups.
+ *
+ * @stability experimental
+ */
+export declare class GroupsService {
+    private readonly data;
+    private readonly options;
+    private readonly membership;
+    private readonly effects;
+    constructor(data: SharingDataPort, options: ResolvedSharingModuleOptions, membership: GroupMembershipService, effects: SharingEffects);
+    /**
+     * `GET /api/groups`: `scope=mine` lists the groups the caller belongs to;
+     * `scope=all` every group of the organization (`groups:admin`).
+     *
+     * @param principal - the caller.
+     * @param query - scope and page.
+     * @returns a page of groups, by name.
+     * @throws ForbiddenException 403 for `scope=all` without `groups:admin`.
+     */
+    list(principal: Principal, query: GroupListQuery): Promise<GroupList>;
+    /**
+     * `POST /api/groups`: creates the group and makes the caller its `admin`,
+     * in one transaction.
+     *
+     * @param principal - the caller (`groups:write`).
+     * @param input - name, description, metadata.
+     * @returns the group.
+     * @throws ConflictException 409 `GROUP_LIMIT_REACHED` past `maxGroupsPerCreator`.
+     */
+    create(principal: Principal, input: CreateGroupInput): Promise<GroupDto>;
+    /**
+     * `GET /api/groups/:id`.
+     *
+     * @param principal - the caller (member, or `groups:admin`).
+     * @param groupId - the group.
+     * @returns the group.
+     * @throws NotFoundException 404 for a group the caller may not see.
+     */
+    get(principal: Principal, groupId: string): Promise<GroupDto>;
+    /**
+     * `PATCH /api/groups/:id`, conditional on `If-Match` when given.
+     *
+     * @param principal - the caller (group `admin`, or `groups:admin`).
+     * @param groupId - the group.
+     * @param input - the fields to change.
+     * @param expectedVersion - the `If-Match` version, or `undefined` to overwrite.
+     * @returns the group.
+     * @throws ConflictException 409 `VERSION_CONFLICT` when the version moved.
+     */
+    update(principal: Principal, groupId: string, input: UpdateGroupInput, expectedVersion?: number): Promise<GroupDto>;
+    /**
+     * `DELETE /api/groups/:id`: refused while any registered resource type
+     * still has rows owned by the group; otherwise removes the group with its
+     * members and invites.
+     *
+     * @param principal - the caller (group `admin`, or `groups:admin`).
+     * @param groupId - the group.
+     * @throws ConflictException 409 `GROUP_OWNS_RESOURCES` with `details.counts`.
+     */
+    delete(principal: Principal, groupId: string): Promise<void>;
+}
+//# sourceMappingURL=groups.service.d.ts.map

package/dist/sharing/groups/groups.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"groups.service.d.ts","sourceRoot":"","sources":["../../../src/sharing/groups/groups.service.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EACV,gBAAgB,EAChB,QAAQ,EACR,SAAS,EACT,cAAc,EACd,SAAS,EACT,gBAAgB,EACjB,MAAM,uCAAuC,CAAC;AAE/C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAe,KAAK,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAIhE,OAAO,EAAgB,KAAK,eAAe,EAAE,MAAM,UAAU,CAAC;AAC9D,OAAO,EAAmB,KAAK,4BAA4B,EAAE,MAAM,oBAAoB,CAAC;AAExF,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAQnD;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,IAAI,GAAG,QAAQ,CAcjG;AAED;;;;GAIG;AACH,qBACa,aAAa;IAEA,OAAO,CAAC,QAAQ,CAAC,IAAI;IAClB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACjD,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAHe,IAAI,EAAE,eAAe,EAClB,OAAO,EAAE,4BAA4B,EAC9D,UAAU,EAAE,sBAAsB,EAClC,OAAO,EAAE,cAAc;IAG1C;;;;;;;;OAQG;IAEG,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC;IA0B3E;;;;;;;;OAQG;IAEG,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAsC9E;;;;;;;OAOG;IAEG,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAUnE;;;;;;;;;OASG;IAEG,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAsCzH;;;;;;;;OAQG;IAEG,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAiCnE"}