@headless-lms/server 0.2.0 → 0.3.0

package/dist/http/routes/bundles.js

@@ -1,9 +1,9 @@
+import { refusals } from "../schemas/shared.js";
 import { resolveScope } from "../scope.js";
-import { ErrorBody } from "../schemas/shared.js";
 import { AddBundleItem, Bundle, BundleIdParam, BundleItem, BundleItemParams, BundlesPage, BundlesQuery, CreateBundle, UpdateBundle } from "../schemas/bundles.js";
 import "../schemas/index.js";
-import { NotFoundError } from "@headless-lms/core/shared/errors";
 import { z } from "zod";
+import { NotFoundError } from "@headless-lms/core/shared/errors";
 //#region src/http/routes/bundles.ts
 async function bundlesRoutes(app, container) {
 	const r = app.withTypeProvider();
@@ -15,9 +15,13 @@ async function bundlesRoutes(app, container) {
 		schema: {
 			operationId: "listBundles",
 			tags: ["Content"],
-			summary: "List bundles",
+			summary: "List bundles (staff)",
+			description: "Staff only (owner, admin, instructor).",
 			querystring: BundlesQuery,
-			response: { 200: BundlesPage }
+			response: {
+				200: BundlesPage,
+				...refusals(403)
+			}
 		},
 		handler: async (req) => {
 			const scope = await resolveScope(container, req);
@@ -31,11 +35,12 @@ async function bundlesRoutes(app, container) {
 		schema: {
 			operationId: "getBundle",
 			tags: ["Content"],
-			summary: "Get a bundle by id",
+			summary: "Get a bundle (staff)",
+			description: "Staff only (owner, admin, instructor).",
 			params: BundleIdParam,
 			response: {
 				200: Bundle,
-				404: ErrorBody
+				...refusals(403, 404)
 			}
 		},
 		handler: async (req) => {
@@ -52,11 +57,12 @@ async function bundlesRoutes(app, container) {
 		schema: {
 			operationId: "createBundle",
 			tags: ["Content"],
-			summary: "Create a bundle, optionally with initial content",
+			summary: "Create a bundle, optionally with initial content (staff)",
+			description: "Staff only (owner, admin, instructor). 404 when an initial content id is unknown.",
 			body: CreateBundle,
 			response: {
 				201: Bundle,
-				404: ErrorBody
+				...refusals(403, 404)
 			}
 		},
 		handler: async (req, reply) => {
@@ -72,12 +78,13 @@ async function bundlesRoutes(app, container) {
 		schema: {
 			operationId: "updateBundle",
 			tags: ["Content"],
-			summary: "Update a bundle",
+			summary: "Rename a bundle (staff)",
+			description: "Staff only (owner, admin, instructor).",
 			params: BundleIdParam,
 			body: UpdateBundle,
 			response: {
 				200: Bundle,
-				404: ErrorBody
+				...refusals(403, 404)
 			}
 		},
 		handler: async (req) => {
@@ -92,11 +99,12 @@ async function bundlesRoutes(app, container) {
 		schema: {
 			operationId: "deleteBundle",
 			tags: ["Content"],
-			summary: "Delete a bundle (its content survives)",
+			summary: "Delete a bundle (staff)",
+			description: "Staff only (owner, admin, instructor). Its content survives; access granted through the bundle ends.",
 			params: BundleIdParam,
 			response: {
 				204: z.void(),
-				404: ErrorBody
+				...refusals(403, 404)
 			}
 		},
 		handler: async (req, reply) => {
@@ -112,11 +120,12 @@ async function bundlesRoutes(app, container) {
 		schema: {
 			operationId: "listBundleItems",
 			tags: ["Content"],
-			summary: "List a bundle's content items",
+			summary: "List a bundle's content (staff)",
+			description: "Staff only (owner, admin, instructor).",
 			params: BundleIdParam,
 			response: {
 				200: z.array(BundleItem),
-				404: ErrorBody
+				...refusals(403)
 			}
 		},
 		handler: async (req) => {
@@ -131,12 +140,13 @@ async function bundlesRoutes(app, container) {
 		schema: {
 			operationId: "addBundleItem",
 			tags: ["Content"],
-			summary: "Add a content item to a bundle",
+			summary: "Add content to a bundle (staff)",
+			description: "Staff only (owner, admin, instructor). Everyone who holds the bundle can open the content from then on. Returns the bundle's content.",
 			params: BundleIdParam,
 			body: AddBundleItem,
 			response: {
 				200: z.array(BundleItem),
-				404: ErrorBody
+				...refusals(403, 404)
 			}
 		},
 		handler: async (req) => {
@@ -151,11 +161,12 @@ async function bundlesRoutes(app, container) {
 		schema: {
 			operationId: "removeBundleItem",
 			tags: ["Content"],
-			summary: "Remove a content item from a bundle (the content survives)",
+			summary: "Remove content from a bundle (staff)",
+			description: "Staff only (owner, admin, instructor). The content survives; access to it through the bundle ends. Returns the bundle's content.",
 			params: BundleItemParams,
 			response: {
 				200: z.array(BundleItem),
-				404: ErrorBody
+				...refusals(403, 404)
 			}
 		},
 		handler: async (req) => {

package/dist/http/routes/bundles.js.map

@@ -1 +1 @@
-{"version":3,"file":"bundles.js","names":[],"sources":["../../../src/http/routes/bundles.ts"],"sourcesContent":["// HTTP routes for bundles — named groupings of content items. Request +\n// response are validated against the shared contract schemas by the Zod type\n// provider, and @fastify/swagger reads the same schemas to build the OpenAPI\n// spec.\nimport type { FastifyInstance } from 'fastify';\nimport type { ZodTypeProvider } from 'fastify-type-provider-zod';\nimport {\n  AddBundleItem,\n  Bundle,\n  BundleIdParam,\n  BundleItem,\n  BundleItemParams,\n  BundlesPage,\n  BundlesQuery,\n  CreateBundle,\n  ErrorBody,\n  UpdateBundle,\n} from '../schemas/index.js';\nimport { z } from 'zod';\nimport type { Container } from '../../app/container.js';\nimport { NotFoundError } from '@headless-lms/core/shared/errors';\nimport { resolveScope } from '../scope.js';\n\nexport async function bundlesRoutes(app: FastifyInstance, container: Container): Promise<void> {\n  const r = app.withTypeProvider<ZodTypeProvider>();\n  const content = container.content;\n\n  r.route({\n    method: 'GET',\n    url: '/api/bundles',\n    preHandler: app.requireOrgSession,\n    schema: {\n      operationId: 'listBundles',\n      tags: ['Content'],\n      summary: 'List bundles',\n      querystring: BundlesQuery,\n      response: { 200: BundlesPage },\n    },\n    handler: async (req) => {\n      const scope = await resolveScope(container, req);\n      return content.listBundles(scope.orgId, req.query);\n    },\n  });\n\n  r.route({\n    method: 'GET',\n    url: '/api/bundles/:bundleId',\n    preHandler: app.requireOrgSession,\n    schema: {\n      operationId: 'getBundle',\n      tags: ['Content'],\n      summary: 'Get a bundle by id',\n      params: BundleIdParam,\n      response: { 200: Bundle, 404: ErrorBody },\n    },\n    handler: async (req) => {\n      const scope = await resolveScope(container, req);\n      const bundle = await content.getBundle(scope.orgId, req.params.bundleId);\n      if (!bundle) {\n        throw new NotFoundError('Bundle', req.params.bundleId);\n      }\n      return bundle;\n    },\n  });\n\n  r.route({\n    method: 'POST',\n    url: '/api/bundles',\n    preHandler: app.requireOrgSession,\n    schema: {\n      operationId: 'createBundle',\n      tags: ['Content'],\n      summary: 'Create a bundle, optionally with initial content',\n      body: CreateBundle,\n      response: { 201: Bundle, 404: ErrorBody },\n    },\n    handler: async (req, reply) => {\n      const scope = await resolveScope(container, req);\n      const bundle = await content.createBundle(scope.orgId, req.body);\n      return reply.code(201).send(bundle);\n    },\n  });\n\n  r.route({\n    method: 'PATCH',\n    url: '/api/bundles/:bundleId',\n    preHandler: app.requireOrgSession,\n    schema: {\n      operationId: 'updateBundle',\n      tags: ['Content'],\n      summary: 'Update a bundle',\n      params: BundleIdParam,\n      body: UpdateBundle,\n      response: { 200: Bundle, 404: ErrorBody },\n    },\n    handler: async (req) => {\n      const scope = await resolveScope(container, req);\n      return content.updateBundle(scope.orgId, req.params.bundleId, req.body);\n    },\n  });\n\n  r.route({\n    method: 'DELETE',\n    url: '/api/bundles/:bundleId',\n    preHandler: app.requireOrgSession,\n    schema: {\n      operationId: 'deleteBundle',\n      tags: ['Content'],\n      summary: 'Delete a bundle (its content survives)',\n      params: BundleIdParam,\n      response: { 204: z.void(), 404: ErrorBody },\n    },\n    handler: async (req, reply) => {\n      const scope = await resolveScope(container, req);\n      await content.deleteBundle(scope.orgId, req.params.bundleId);\n      return reply.code(204).send();\n    },\n  });\n\n  r.route({\n    method: 'GET',\n    url: '/api/bundles/:bundleId/items',\n    preHandler: app.requireOrgSession,\n    schema: {\n      operationId: 'listBundleItems',\n      tags: ['Content'],\n      summary: \"List a bundle's content items\",\n      params: BundleIdParam,\n      response: { 200: z.array(BundleItem), 404: ErrorBody },\n    },\n    handler: async (req) => {\n      const scope = await resolveScope(container, req);\n      return content.listBundleItems(scope.orgId, req.params.bundleId);\n    },\n  });\n\n  r.route({\n    method: 'POST',\n    url: '/api/bundles/:bundleId/items',\n    preHandler: app.requireOrgSession,\n    schema: {\n      operationId: 'addBundleItem',\n      tags: ['Content'],\n      summary: 'Add a content item to a bundle',\n      params: BundleIdParam,\n      body: AddBundleItem,\n      response: { 200: z.array(BundleItem), 404: ErrorBody },\n    },\n    handler: async (req) => {\n      const scope = await resolveScope(container, req);\n      return content.addBundleItem(scope.orgId, req.params.bundleId, req.body.contentId);\n    },\n  });\n\n  r.route({\n    method: 'DELETE',\n    url: '/api/bundles/:bundleId/items/:contentId',\n    preHandler: app.requireOrgSession,\n    schema: {\n      operationId: 'removeBundleItem',\n      tags: ['Content'],\n      summary: 'Remove a content item from a bundle (the content survives)',\n      params: BundleItemParams,\n      response: { 200: z.array(BundleItem), 404: ErrorBody },\n    },\n    handler: async (req) => {\n      const scope = await resolveScope(container, req);\n      return content.removeBundleItem(scope.orgId, req.params.bundleId, req.params.contentId);\n    },\n  });\n}\n"],"mappings":";;;;;;;AAuBA,eAAsB,cAAc,KAAsB,WAAqC;CAC7F,MAAM,IAAI,IAAI,iBAAkC;CAChD,MAAM,UAAU,UAAU;CAE1B,EAAE,MAAM;EACN,QAAQ;EACR,KAAK;EACL,YAAY,IAAI;EAChB,QAAQ;GACN,aAAa;GACb,MAAM,CAAC,SAAS;GAChB,SAAS;GACT,aAAa;GACb,UAAU,EAAE,KAAK,YAAY;EAC/B;EACA,SAAS,OAAO,QAAQ;GACtB,MAAM,QAAQ,MAAM,aAAa,WAAW,GAAG;GAC/C,OAAO,QAAQ,YAAY,MAAM,OAAO,IAAI,KAAK;EACnD;CACF,CAAC;CAED,EAAE,MAAM;EACN,QAAQ;EACR,KAAK;EACL,YAAY,IAAI;EAChB,QAAQ;GACN,aAAa;GACb,MAAM,CAAC,SAAS;GAChB,SAAS;GACT,QAAQ;GACR,UAAU;IAAE,KAAK;IAAQ,KAAK;GAAU;EAC1C;EACA,SAAS,OAAO,QAAQ;GACtB,MAAM,QAAQ,MAAM,aAAa,WAAW,GAAG;GAC/C,MAAM,SAAS,MAAM,QAAQ,UAAU,MAAM,OAAO,IAAI,OAAO,QAAQ;GACvE,IAAI,CAAC,QACH,MAAM,IAAI,cAAc,UAAU,IAAI,OAAO,QAAQ;GAEvD,OAAO;EACT;CACF,CAAC;CAED,EAAE,MAAM;EACN,QAAQ;EACR,KAAK;EACL,YAAY,IAAI;EAChB,QAAQ;GACN,aAAa;GACb,MAAM,CAAC,SAAS;GAChB,SAAS;GACT,MAAM;GACN,UAAU;IAAE,KAAK;IAAQ,KAAK;GAAU;EAC1C;EACA,SAAS,OAAO,KAAK,UAAU;GAC7B,MAAM,QAAQ,MAAM,aAAa,WAAW,GAAG;GAC/C,MAAM,SAAS,MAAM,QAAQ,aAAa,MAAM,OAAO,IAAI,IAAI;GAC/D,OAAO,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,MAAM;EACpC;CACF,CAAC;CAED,EAAE,MAAM;EACN,QAAQ;EACR,KAAK;EACL,YAAY,IAAI;EAChB,QAAQ;GACN,aAAa;GACb,MAAM,CAAC,SAAS;GAChB,SAAS;GACT,QAAQ;GACR,MAAM;GACN,UAAU;IAAE,KAAK;IAAQ,KAAK;GAAU;EAC1C;EACA,SAAS,OAAO,QAAQ;GACtB,MAAM,QAAQ,MAAM,aAAa,WAAW,GAAG;GAC/C,OAAO,QAAQ,aAAa,MAAM,OAAO,IAAI,OAAO,UAAU,IAAI,IAAI;EACxE;CACF,CAAC;CAED,EAAE,MAAM;EACN,QAAQ;EACR,KAAK;EACL,YAAY,IAAI;EAChB,QAAQ;GACN,aAAa;GACb,MAAM,CAAC,SAAS;GAChB,SAAS;GACT,QAAQ;GACR,UAAU;IAAE,KAAK,EAAE,KAAK;IAAG,KAAK;GAAU;EAC5C;EACA,SAAS,OAAO,KAAK,UAAU;GAC7B,MAAM,QAAQ,MAAM,aAAa,WAAW,GAAG;GAC/C,MAAM,QAAQ,aAAa,MAAM,OAAO,IAAI,OAAO,QAAQ;GAC3D,OAAO,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK;EAC9B;CACF,CAAC;CAED,EAAE,MAAM;EACN,QAAQ;EACR,KAAK;EACL,YAAY,IAAI;EAChB,QAAQ;GACN,aAAa;GACb,MAAM,CAAC,SAAS;GAChB,SAAS;GACT,QAAQ;GACR,UAAU;IAAE,KAAK,EAAE,MAAM,UAAU;IAAG,KAAK;GAAU;EACvD;EACA,SAAS,OAAO,QAAQ;GACtB,MAAM,QAAQ,MAAM,aAAa,WAAW,GAAG;GAC/C,OAAO,QAAQ,gBAAgB,MAAM,OAAO,IAAI,OAAO,QAAQ;EACjE;CACF,CAAC;CAED,EAAE,MAAM;EACN,QAAQ;EACR,KAAK;EACL,YAAY,IAAI;EAChB,QAAQ;GACN,aAAa;GACb,MAAM,CAAC,SAAS;GAChB,SAAS;GACT,QAAQ;GACR,MAAM;GACN,UAAU;IAAE,KAAK,EAAE,MAAM,UAAU;IAAG,KAAK;GAAU;EACvD;EACA,SAAS,OAAO,QAAQ;GACtB,MAAM,QAAQ,MAAM,aAAa,WAAW,GAAG;GAC/C,OAAO,QAAQ,cAAc,MAAM,OAAO,IAAI,OAAO,UAAU,IAAI,KAAK,SAAS;EACnF;CACF,CAAC;CAED,EAAE,MAAM;EACN,QAAQ;EACR,KAAK;EACL,YAAY,IAAI;EAChB,QAAQ;GACN,aAAa;GACb,MAAM,CAAC,SAAS;GAChB,SAAS;GACT,QAAQ;GACR,UAAU;IAAE,KAAK,EAAE,MAAM,UAAU;IAAG,KAAK;GAAU;EACvD;EACA,SAAS,OAAO,QAAQ;GACtB,MAAM,QAAQ,MAAM,aAAa,WAAW,GAAG;GAC/C,OAAO,QAAQ,iBAAiB,MAAM,OAAO,IAAI,OAAO,UAAU,IAAI,OAAO,SAAS;EACxF;CACF,CAAC;AACH"}
+{"version":3,"file":"bundles.js","names":[],"sources":["../../../src/http/routes/bundles.ts"],"sourcesContent":["// HTTP routes for bundles — named groupings of content items. Request +\n// response are validated against the shared contract schemas by the Zod type\n// provider, and @fastify/swagger reads the same schemas to build the OpenAPI\n// spec.\nimport type { FastifyInstance } from 'fastify';\nimport type { ZodTypeProvider } from 'fastify-type-provider-zod';\nimport {\n  AddBundleItem,\n  Bundle,\n  BundleIdParam,\n  BundleItem,\n  BundleItemParams,\n  BundlesPage,\n  BundlesQuery,\n  CreateBundle,\n  UpdateBundle,\n  refusals,\n} from '../schemas/index.js';\nimport { z } from 'zod';\nimport type { Container } from '../../app/container.js';\nimport { NotFoundError } from '@headless-lms/core/shared/errors';\nimport { resolveScope } from '../scope.js';\n\nexport async function bundlesRoutes(app: FastifyInstance, container: Container): Promise<void> {\n  const r = app.withTypeProvider<ZodTypeProvider>();\n  const content = container.content;\n\n  r.route({\n    method: 'GET',\n    url: '/api/bundles',\n    preHandler: app.requireOrgSession,\n    schema: {\n      operationId: 'listBundles',\n      tags: ['Content'],\n      summary: 'List bundles (staff)',\n      description: 'Staff only (owner, admin, instructor).',\n      querystring: BundlesQuery,\n      response: { 200: BundlesPage, ...refusals(403) },\n    },\n    handler: async (req) => {\n      const scope = await resolveScope(container, req);\n      return content.listBundles(scope.orgId, req.query);\n    },\n  });\n\n  r.route({\n    method: 'GET',\n    url: '/api/bundles/:bundleId',\n    preHandler: app.requireOrgSession,\n    schema: {\n      operationId: 'getBundle',\n      tags: ['Content'],\n      summary: 'Get a bundle (staff)',\n      description: 'Staff only (owner, admin, instructor).',\n      params: BundleIdParam,\n      response: { 200: Bundle, ...refusals(403, 404) },\n    },\n    handler: async (req) => {\n      const scope = await resolveScope(container, req);\n      const bundle = await content.getBundle(scope.orgId, req.params.bundleId);\n      if (!bundle) {\n        throw new NotFoundError('Bundle', req.params.bundleId);\n      }\n      return bundle;\n    },\n  });\n\n  r.route({\n    method: 'POST',\n    url: '/api/bundles',\n    preHandler: app.requireOrgSession,\n    schema: {\n      operationId: 'createBundle',\n      tags: ['Content'],\n      summary: 'Create a bundle, optionally with initial content (staff)',\n      description:\n        'Staff only (owner, admin, instructor). 404 when an initial content id is unknown.',\n      body: CreateBundle,\n      response: { 201: Bundle, ...refusals(403, 404) },\n    },\n    handler: async (req, reply) => {\n      const scope = await resolveScope(container, req);\n      const bundle = await content.createBundle(scope.orgId, req.body);\n      return reply.code(201).send(bundle);\n    },\n  });\n\n  r.route({\n    method: 'PATCH',\n    url: '/api/bundles/:bundleId',\n    preHandler: app.requireOrgSession,\n    schema: {\n      operationId: 'updateBundle',\n      tags: ['Content'],\n      summary: 'Rename a bundle (staff)',\n      description: 'Staff only (owner, admin, instructor).',\n      params: BundleIdParam,\n      body: UpdateBundle,\n      response: { 200: Bundle, ...refusals(403, 404) },\n    },\n    handler: async (req) => {\n      const scope = await resolveScope(container, req);\n      return content.updateBundle(scope.orgId, req.params.bundleId, req.body);\n    },\n  });\n\n  r.route({\n    method: 'DELETE',\n    url: '/api/bundles/:bundleId',\n    preHandler: app.requireOrgSession,\n    schema: {\n      operationId: 'deleteBundle',\n      tags: ['Content'],\n      summary: 'Delete a bundle (staff)',\n      description:\n        'Staff only (owner, admin, instructor). Its content survives; access granted through the bundle ends.',\n      params: BundleIdParam,\n      response: { 204: z.void(), ...refusals(403, 404) },\n    },\n    handler: async (req, reply) => {\n      const scope = await resolveScope(container, req);\n      await content.deleteBundle(scope.orgId, req.params.bundleId);\n      return reply.code(204).send();\n    },\n  });\n\n  r.route({\n    method: 'GET',\n    url: '/api/bundles/:bundleId/items',\n    preHandler: app.requireOrgSession,\n    schema: {\n      operationId: 'listBundleItems',\n      tags: ['Content'],\n      summary: \"List a bundle's content (staff)\",\n      description: 'Staff only (owner, admin, instructor).',\n      params: BundleIdParam,\n      response: { 200: z.array(BundleItem), ...refusals(403) },\n    },\n    handler: async (req) => {\n      const scope = await resolveScope(container, req);\n      return content.listBundleItems(scope.orgId, req.params.bundleId);\n    },\n  });\n\n  r.route({\n    method: 'POST',\n    url: '/api/bundles/:bundleId/items',\n    preHandler: app.requireOrgSession,\n    schema: {\n      operationId: 'addBundleItem',\n      tags: ['Content'],\n      summary: 'Add content to a bundle (staff)',\n      description:\n        \"Staff only (owner, admin, instructor). Everyone who holds the bundle can open the content from then on. Returns the bundle's content.\",\n      params: BundleIdParam,\n      body: AddBundleItem,\n      response: { 200: z.array(BundleItem), ...refusals(403, 404) },\n    },\n    handler: async (req) => {\n      const scope = await resolveScope(container, req);\n      return content.addBundleItem(scope.orgId, req.params.bundleId, req.body.contentId);\n    },\n  });\n\n  r.route({\n    method: 'DELETE',\n    url: '/api/bundles/:bundleId/items/:contentId',\n    preHandler: app.requireOrgSession,\n    schema: {\n      operationId: 'removeBundleItem',\n      tags: ['Content'],\n      summary: 'Remove content from a bundle (staff)',\n      description:\n        \"Staff only (owner, admin, instructor). The content survives; access to it through the bundle ends. Returns the bundle's content.\",\n      params: BundleItemParams,\n      response: { 200: z.array(BundleItem), ...refusals(403, 404) },\n    },\n    handler: async (req) => {\n      const scope = await resolveScope(container, req);\n      return content.removeBundleItem(scope.orgId, req.params.bundleId, req.params.contentId);\n    },\n  });\n}\n"],"mappings":";;;;;;;AAuBA,eAAsB,cAAc,KAAsB,WAAqC;CAC7F,MAAM,IAAI,IAAI,iBAAkC;CAChD,MAAM,UAAU,UAAU;CAE1B,EAAE,MAAM;EACN,QAAQ;EACR,KAAK;EACL,YAAY,IAAI;EAChB,QAAQ;GACN,aAAa;GACb,MAAM,CAAC,SAAS;GAChB,SAAS;GACT,aAAa;GACb,aAAa;GACb,UAAU;IAAE,KAAK;IAAa,GAAG,SAAS,GAAG;GAAE;EACjD;EACA,SAAS,OAAO,QAAQ;GACtB,MAAM,QAAQ,MAAM,aAAa,WAAW,GAAG;GAC/C,OAAO,QAAQ,YAAY,MAAM,OAAO,IAAI,KAAK;EACnD;CACF,CAAC;CAED,EAAE,MAAM;EACN,QAAQ;EACR,KAAK;EACL,YAAY,IAAI;EAChB,QAAQ;GACN,aAAa;GACb,MAAM,CAAC,SAAS;GAChB,SAAS;GACT,aAAa;GACb,QAAQ;GACR,UAAU;IAAE,KAAK;IAAQ,GAAG,SAAS,KAAK,GAAG;GAAE;EACjD;EACA,SAAS,OAAO,QAAQ;GACtB,MAAM,QAAQ,MAAM,aAAa,WAAW,GAAG;GAC/C,MAAM,SAAS,MAAM,QAAQ,UAAU,MAAM,OAAO,IAAI,OAAO,QAAQ;GACvE,IAAI,CAAC,QACH,MAAM,IAAI,cAAc,UAAU,IAAI,OAAO,QAAQ;GAEvD,OAAO;EACT;CACF,CAAC;CAED,EAAE,MAAM;EACN,QAAQ;EACR,KAAK;EACL,YAAY,IAAI;EAChB,QAAQ;GACN,aAAa;GACb,MAAM,CAAC,SAAS;GAChB,SAAS;GACT,aACE;GACF,MAAM;GACN,UAAU;IAAE,KAAK;IAAQ,GAAG,SAAS,KAAK,GAAG;GAAE;EACjD;EACA,SAAS,OAAO,KAAK,UAAU;GAC7B,MAAM,QAAQ,MAAM,aAAa,WAAW,GAAG;GAC/C,MAAM,SAAS,MAAM,QAAQ,aAAa,MAAM,OAAO,IAAI,IAAI;GAC/D,OAAO,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,MAAM;EACpC;CACF,CAAC;CAED,EAAE,MAAM;EACN,QAAQ;EACR,KAAK;EACL,YAAY,IAAI;EAChB,QAAQ;GACN,aAAa;GACb,MAAM,CAAC,SAAS;GAChB,SAAS;GACT,aAAa;GACb,QAAQ;GACR,MAAM;GACN,UAAU;IAAE,KAAK;IAAQ,GAAG,SAAS,KAAK,GAAG;GAAE;EACjD;EACA,SAAS,OAAO,QAAQ;GACtB,MAAM,QAAQ,MAAM,aAAa,WAAW,GAAG;GAC/C,OAAO,QAAQ,aAAa,MAAM,OAAO,IAAI,OAAO,UAAU,IAAI,IAAI;EACxE;CACF,CAAC;CAED,EAAE,MAAM;EACN,QAAQ;EACR,KAAK;EACL,YAAY,IAAI;EAChB,QAAQ;GACN,aAAa;GACb,MAAM,CAAC,SAAS;GAChB,SAAS;GACT,aACE;GACF,QAAQ;GACR,UAAU;IAAE,KAAK,EAAE,KAAK;IAAG,GAAG,SAAS,KAAK,GAAG;GAAE;EACnD;EACA,SAAS,OAAO,KAAK,UAAU;GAC7B,MAAM,QAAQ,MAAM,aAAa,WAAW,GAAG;GAC/C,MAAM,QAAQ,aAAa,MAAM,OAAO,IAAI,OAAO,QAAQ;GAC3D,OAAO,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK;EAC9B;CACF,CAAC;CAED,EAAE,MAAM;EACN,QAAQ;EACR,KAAK;EACL,YAAY,IAAI;EAChB,QAAQ;GACN,aAAa;GACb,MAAM,CAAC,SAAS;GAChB,SAAS;GACT,aAAa;GACb,QAAQ;GACR,UAAU;IAAE,KAAK,EAAE,MAAM,UAAU;IAAG,GAAG,SAAS,GAAG;GAAE;EACzD;EACA,SAAS,OAAO,QAAQ;GACtB,MAAM,QAAQ,MAAM,aAAa,WAAW,GAAG;GAC/C,OAAO,QAAQ,gBAAgB,MAAM,OAAO,IAAI,OAAO,QAAQ;EACjE;CACF,CAAC;CAED,EAAE,MAAM;EACN,QAAQ;EACR,KAAK;EACL,YAAY,IAAI;EAChB,QAAQ;GACN,aAAa;GACb,MAAM,CAAC,SAAS;GAChB,SAAS;GACT,aACE;GACF,QAAQ;GACR,MAAM;GACN,UAAU;IAAE,KAAK,EAAE,MAAM,UAAU;IAAG,GAAG,SAAS,KAAK,GAAG;GAAE;EAC9D;EACA,SAAS,OAAO,QAAQ;GACtB,MAAM,QAAQ,MAAM,aAAa,WAAW,GAAG;GAC/C,OAAO,QAAQ,cAAc,MAAM,OAAO,IAAI,OAAO,UAAU,IAAI,KAAK,SAAS;EACnF;CACF,CAAC;CAED,EAAE,MAAM;EACN,QAAQ;EACR,KAAK;EACL,YAAY,IAAI;EAChB,QAAQ;GACN,aAAa;GACb,MAAM,CAAC,SAAS;GAChB,SAAS;GACT,aACE;GACF,QAAQ;GACR,UAAU;IAAE,KAAK,EAAE,MAAM,UAAU;IAAG,GAAG,SAAS,KAAK,GAAG;GAAE;EAC9D;EACA,SAAS,OAAO,QAAQ;GACtB,MAAM,QAAQ,MAAM,aAAa,WAAW,GAAG;GAC/C,OAAO,QAAQ,iBAAiB,MAAM,OAAO,IAAI,OAAO,UAAU,IAAI,OAAO,SAAS;EACxF;CACF,CAAC;AACH"}

package/dist/http/routes/communities.d.ts

@@ -0,0 +1,7 @@
+import { Container } from "../../app/container.js";
+import { FastifyInstance } from "fastify";
+//#region src/http/routes/communities.d.ts
+declare function communitiesRoutes(app: FastifyInstance, container: Container): Promise<void>;
+//#endregion
+export { communitiesRoutes };
+//# sourceMappingURL=communities.d.ts.map

package/dist/http/routes/communities.js

@@ -0,0 +1,462 @@
+import { refusals } from "../schemas/shared.js";
+import { resolveScope } from "../scope.js";
+import { CommunitiesPage, CommunitiesQuery, Community, CommunityAnalytics, CommunityIdParam, CommunitySpaceParam, CreateCommunity, CreateSpace, OrderedIds, PatchDmSettings, SetSpaceTopics, SpaceDetail, SpaceLinkBody, SpaceLinkParam, UpdateCommunity, UpdateSpace } from "../schemas/community.js";
+import { MessageQueue } from "../schemas/chats.js";
+import "../schemas/index.js";
+import { z } from "zod";
+import { NotFoundError } from "@headless-lms/core/shared/errors";
+//#region src/http/routes/communities.ts
+async function communitiesRoutes(app, container) {
+	const r = app.withTypeProvider();
+	const content = container.content;
+	const tags = ["Communities"];
+	r.route({
+		method: "GET",
+		url: "/api/communities",
+		schema: {
+			operationId: "listCommunities",
+			tags,
+			summary: "List communities (staff)",
+			description: "Staff only (owner, admin, instructor). Pages every community in the organization, drafts included, filtered by `status` and searched by title.",
+			querystring: CommunitiesQuery,
+			response: {
+				200: CommunitiesPage,
+				...refusals(403)
+			}
+		},
+		handler: async (req) => {
+			const scope = await resolveScope(container, req);
+			return content.listCommunities(scope.orgId, req.query);
+		}
+	});
+	r.route({
+		method: "POST",
+		url: "/api/communities",
+		schema: {
+			operationId: "createCommunity",
+			tags,
+			summary: "Create a community (staff)",
+			description: "Owner or admin only. The community starts as a draft with the default direct-message settings and no spaces. Members see it once it is published and they hold it.",
+			body: CreateCommunity,
+			response: {
+				201: Community,
+				...refusals(403, 409)
+			}
+		},
+		handler: async (req, reply) => {
+			const scope = await resolveScope(container, req);
+			const community = await content.createCommunity(scope.orgId, req.body, {
+				id: scope.orgUserId,
+				role: scope.role
+			});
+			req.log.info({ communityId: community.id }, "community created");
+			return reply.code(201).send(community);
+		}
+	});
+	r.route({
+		method: "GET",
+		url: "/api/communities/:communityId",
+		schema: {
+			operationId: "getCommunity",
+			tags,
+			summary: "Get a community (staff)",
+			description: "Staff only (owner, admin, instructor). Any community of the organization, drafts included.",
+			params: CommunityIdParam,
+			response: {
+				200: Community,
+				...refusals(403, 404)
+			}
+		},
+		handler: async (req) => {
+			const scope = await resolveScope(container, req);
+			const community = await content.getCommunity(scope.orgId, req.params.communityId);
+			if (!community) throw new NotFoundError("Community", req.params.communityId);
+			return community;
+		}
+	});
+	r.route({
+		method: "PATCH",
+		url: "/api/communities/:communityId",
+		schema: {
+			operationId: "updateCommunity",
+			tags,
+			summary: "Update a community (staff)",
+			description: "Owner or admin only. Changes only the fields sent. `thumbnailAssetId` must be a ready library image (409 otherwise); null clears it.",
+			params: CommunityIdParam,
+			body: UpdateCommunity,
+			response: {
+				200: Community,
+				...refusals(403, 404, 409)
+			}
+		},
+		handler: async (req) => {
+			const scope = await resolveScope(container, req);
+			return content.updateCommunity(scope.orgId, req.params.communityId, req.body, {
+				id: scope.orgUserId,
+				role: scope.role
+			});
+		}
+	});
+	r.route({
+		method: "DELETE",
+		url: "/api/communities/:communityId",
+		schema: {
+			operationId: "deleteCommunity",
+			tags,
+			summary: "Delete a community (staff)",
+			description: "Owner or admin only. Links to the community from other spaces are removed with it.",
+			params: CommunityIdParam,
+			response: {
+				204: z.void(),
+				...refusals(403, 404)
+			}
+		},
+		handler: async (req, reply) => {
+			const scope = await resolveScope(container, req);
+			await content.deleteCommunity(scope.orgId, req.params.communityId, {
+				id: scope.orgUserId,
+				role: scope.role
+			});
+			return reply.code(204).send();
+		}
+	});
+	r.route({
+		method: "PATCH",
+		url: "/api/communities/:communityId/settings",
+		schema: {
+			operationId: "patchCommunityDmSettings",
+			tags,
+			summary: "Change direct-message settings for a community (staff)",
+			description: "Owner or admin only. Changes only the settings sent; the rest keep their values. They decide who may message whom from then on.",
+			params: CommunityIdParam,
+			body: PatchDmSettings,
+			response: {
+				200: Community,
+				...refusals(403, 404)
+			}
+		},
+		handler: async (req) => {
+			const scope = await resolveScope(container, req);
+			return content.patchDmSettings(scope.orgId, req.params.communityId, req.body, {
+				id: scope.orgUserId,
+				role: scope.role
+			});
+		}
+	});
+	r.route({
+		method: "POST",
+		url: "/api/communities/:communityId/publish",
+		schema: {
+			operationId: "publishCommunity",
+			tags,
+			summary: "Publish a community (staff)",
+			description: "Owner or admin only. Makes the community visible to the people who hold it.",
+			params: CommunityIdParam,
+			response: {
+				200: Community,
+				...refusals(403, 404, 409)
+			}
+		},
+		handler: async (req) => {
+			const scope = await resolveScope(container, req);
+			return content.publishCommunity(scope.orgId, req.params.communityId, {
+				id: scope.orgUserId,
+				role: scope.role
+			});
+		}
+	});
+	r.route({
+		method: "POST",
+		url: "/api/communities/:communityId/unpublish",
+		schema: {
+			operationId: "unpublishCommunity",
+			tags,
+			summary: "Unpublish a community (staff)",
+			description: "Owner or admin only. Hides the community from members again; nothing in it is deleted.",
+			params: CommunityIdParam,
+			response: {
+				200: Community,
+				...refusals(403, 404, 409)
+			}
+		},
+		handler: async (req) => {
+			const scope = await resolveScope(container, req);
+			return content.unpublishCommunity(scope.orgId, req.params.communityId, {
+				id: scope.orgUserId,
+				role: scope.role
+			});
+		}
+	});
+	r.route({
+		method: "GET",
+		url: "/api/communities/:communityId/analytics",
+		schema: {
+			operationId: "getCommunityAnalytics",
+			tags,
+			summary: "Staff analytics for a community",
+			description: "Staff only (owner, admin, instructor). Membership, activity and moderation counts for one community.",
+			params: CommunityIdParam,
+			response: {
+				200: CommunityAnalytics,
+				...refusals(403, 404)
+			}
+		},
+		handler: async (req) => {
+			const scope = await resolveScope(container, req);
+			const stats = await container.reporting.admin.communityAnalytics(scope.orgId, req.params.communityId);
+			if (!stats) throw new NotFoundError("Community", req.params.communityId);
+			return stats;
+		}
+	});
+	r.route({
+		method: "GET",
+		url: "/api/communities/:communityId/message-queue",
+		schema: {
+			operationId: "getCommunityMessageQueue",
+			tags,
+			summary: "Open message flags in a community (staff)",
+			description: "Staff only (owner, admin, instructor). The messages in the community's chats with open flags, with the flags and the chat each is in. Holds at most the 100 oldest open flags; working the queue brings in the next ones.",
+			params: CommunityIdParam,
+			response: {
+				200: MessageQueue,
+				...refusals(403, 404)
+			}
+		},
+		handler: async (req) => {
+			const scope = await resolveScope(container, req);
+			return container.chats.messageQueue(scope.orgId, {
+				id: scope.orgUserId,
+				role: scope.role
+			}, req.params.communityId);
+		}
+	});
+	r.route({
+		method: "GET",
+		url: "/api/communities/:communityId/spaces",
+		schema: {
+			operationId: "listCommunitySpaces",
+			tags,
+			summary: "List the spaces in a community (staff)",
+			description: "Staff only (owner, admin, instructor). Every space in order, with its topics and links.",
+			params: CommunityIdParam,
+			response: {
+				200: z.array(SpaceDetail),
+				...refusals(403, 404)
+			}
+		},
+		handler: async (req) => {
+			const scope = await resolveScope(container, req);
+			return content.listSpaces(scope.orgId, req.params.communityId);
+		}
+	});
+	r.route({
+		method: "POST",
+		url: "/api/communities/:communityId/spaces",
+		schema: {
+			operationId: "createSpace",
+			tags,
+			summary: "Create a space (staff)",
+			description: "Owner or admin only. The space is added last. An `all_members` space cannot have a capacity (409).",
+			params: CommunityIdParam,
+			body: CreateSpace,
+			response: {
+				201: SpaceDetail,
+				...refusals(403, 404, 409)
+			}
+		},
+		handler: async (req, reply) => {
+			const scope = await resolveScope(container, req);
+			const space = await content.createSpace(scope.orgId, req.params.communityId, req.body, {
+				id: scope.orgUserId,
+				role: scope.role
+			});
+			return reply.code(201).send(space);
+		}
+	});
+	r.route({
+		method: "PUT",
+		url: "/api/communities/:communityId/spaces/order",
+		schema: {
+			operationId: "reorderSpaces",
+			tags,
+			summary: "Reorder the spaces in a community (staff)",
+			description: "Owner or admin only. Send every space id of the community exactly once (409 otherwise).",
+			params: CommunityIdParam,
+			body: OrderedIds,
+			response: {
+				200: z.array(SpaceDetail),
+				...refusals(403, 404, 409)
+			}
+		},
+		handler: async (req) => {
+			const scope = await resolveScope(container, req);
+			return content.reorderSpaces(scope.orgId, req.params.communityId, req.body.ids, {
+				id: scope.orgUserId,
+				role: scope.role
+			});
+		}
+	});
+	r.route({
+		method: "GET",
+		url: "/api/communities/:communityId/spaces/:spaceId",
+		schema: {
+			operationId: "getSpace",
+			tags,
+			summary: "Get a space (staff)",
+			description: "Staff only (owner, admin, instructor). The space with its topics and links.",
+			params: CommunitySpaceParam,
+			response: {
+				200: SpaceDetail,
+				...refusals(403, 404)
+			}
+		},
+		handler: async (req) => {
+			const scope = await resolveScope(container, req);
+			const space = await content.getCommunitySpace(scope.orgId, req.params.communityId, req.params.spaceId);
+			if (!space) throw new NotFoundError("Space", req.params.spaceId);
+			return space;
+		}
+	});
+	r.route({
+		method: "PATCH",
+		url: "/api/communities/:communityId/spaces/:spaceId",
+		schema: {
+			operationId: "updateSpace",
+			tags,
+			summary: "Update a space (staff)",
+			description: "Owner or admin only. Changes only the fields sent; `settings` merges into the current settings. An `all_members` space cannot have a capacity (409).",
+			params: CommunitySpaceParam,
+			body: UpdateSpace,
+			response: {
+				200: SpaceDetail,
+				...refusals(403, 404, 409)
+			}
+		},
+		handler: async (req) => {
+			const scope = await resolveScope(container, req);
+			return content.updateSpace(scope.orgId, req.params.communityId, req.params.spaceId, req.body, {
+				id: scope.orgUserId,
+				role: scope.role
+			});
+		}
+	});
+	r.route({
+		method: "DELETE",
+		url: "/api/communities/:communityId/spaces/:spaceId",
+		schema: {
+			operationId: "deleteSpace",
+			tags,
+			summary: "Delete a space (staff)",
+			description: "Owner or admin only. The space and everything in it go.",
+			params: CommunitySpaceParam,
+			response: {
+				204: z.void(),
+				...refusals(403, 404)
+			}
+		},
+		handler: async (req, reply) => {
+			const scope = await resolveScope(container, req);
+			await content.deleteSpace(scope.orgId, req.params.communityId, req.params.spaceId, {
+				id: scope.orgUserId,
+				role: scope.role
+			});
+			return reply.code(204).send();
+		}
+	});
+	r.route({
+		method: "PUT",
+		url: "/api/communities/:communityId/spaces/:spaceId/topics",
+		schema: {
+			operationId: "setSpaceTopics",
+			tags,
+			summary: "Replace the topics on a space (staff)",
+			description: "Owner or admin only. The list replaces the current topics: an entry with an `id` keeps and renames that topic, one without adds a topic, and a topic left out is deleted. Names must be unique (409), and a topic that posts use cannot be deleted (409).",
+			params: CommunitySpaceParam,
+			body: SetSpaceTopics,
+			response: {
+				200: SpaceDetail,
+				...refusals(403, 404, 409)
+			}
+		},
+		handler: async (req) => {
+			const scope = await resolveScope(container, req);
+			return content.setSpaceTopics(scope.orgId, req.params.communityId, req.params.spaceId, req.body, {
+				id: scope.orgUserId,
+				role: scope.role
+			});
+		}
+	});
+	r.route({
+		method: "POST",
+		url: "/api/communities/:communityId/spaces/:spaceId/links",
+		schema: {
+			operationId: "addSpaceLink",
+			tags,
+			summary: "Link a course, download, or community into a space (staff)",
+			description: "Owner or admin only. The link is added last. Linking the same content twice is a 409.",
+			params: CommunitySpaceParam,
+			body: SpaceLinkBody,
+			response: {
+				201: SpaceDetail,
+				...refusals(403, 404, 409)
+			}
+		},
+		handler: async (req, reply) => {
+			const scope = await resolveScope(container, req);
+			const space = await content.addSpaceLink(scope.orgId, req.params.communityId, req.params.spaceId, req.body.contentId, {
+				id: scope.orgUserId,
+				role: scope.role
+			});
+			return reply.code(201).send(space);
+		}
+	});
+	r.route({
+		method: "DELETE",
+		url: "/api/communities/:communityId/spaces/:spaceId/links/:linkId",
+		schema: {
+			operationId: "removeSpaceLink",
+			tags,
+			summary: "Remove a link from a space (staff)",
+			description: "Owner or admin only. The linked content itself is untouched.",
+			params: SpaceLinkParam,
+			response: {
+				200: SpaceDetail,
+				...refusals(403, 404)
+			}
+		},
+		handler: async (req) => {
+			const scope = await resolveScope(container, req);
+			return content.removeSpaceLink(scope.orgId, req.params.communityId, req.params.spaceId, req.params.linkId, {
+				id: scope.orgUserId,
+				role: scope.role
+			});
+		}
+	});
+	r.route({
+		method: "PUT",
+		url: "/api/communities/:communityId/spaces/:spaceId/links/order",
+		schema: {
+			operationId: "reorderSpaceLinks",
+			tags,
+			summary: "Reorder the links in a space (staff)",
+			description: "Owner or admin only. Send every link id of the space exactly once (409 otherwise).",
+			params: CommunitySpaceParam,
+			body: OrderedIds,
+			response: {
+				200: SpaceDetail,
+				...refusals(403, 404, 409)
+			}
+		},
+		handler: async (req) => {
+			const scope = await resolveScope(container, req);
+			return content.reorderSpaceLinks(scope.orgId, req.params.communityId, req.params.spaceId, req.body.ids, {
+				id: scope.orgUserId,
+				role: scope.role
+			});
+		}
+	});
+}
+//#endregion
+export { communitiesRoutes };
+
+//# sourceMappingURL=communities.js.map