Implemented service model

Author: xaviaracil

CASEProvider/README.md

@@ -5,6 +5,7 @@ A complete implementation of the **Competencies and Academic Standards Exchange
 This implementation follows the CASE v1.1 specification from 1EdTech:
 
 - Specification URL: <https://purl.imsglobal.org/spec/case/v1p1>
+- OpenAPI Definition: <https://purl.imsglobal.org/spec/case/v1p1/schema/openapi/imscasev1p1_openapi2_v1p0.json>
 
 ## Overview
 
@@ -14,6 +15,14 @@ This service provides a REST API that implements the CASE v1.1 specification fro
 
 - ✅ PostgreSQL database with Prisma ORM
 - ✅ TypeScript for type safety
+- ✅ Six manager endpoints:
+  - **AssociationsManager**: Manage CFAssociations
+  - **DefinitionsManager**: Manage CFConcepts, CFSubjects, CFLicenses, CFItemTypes, CFAssociationGroupings
+  - **DocumentsManager**: Manage CFDocuments
+  - **ItemsManager**: Manage CFItems
+  - **PackagesManager**: Manage CFPackages
+  - **RubricsManager**: Manage CFRubrics and CFRubricCriteria
+- ✅ OpenAPI specification endpoint at `/ims/case/v1p1/openapi.json`
 
 ## Prerequisites
 
@@ -95,6 +104,43 @@ The server will start on `http://localhost:3000` (or the PORT specified in your
 
 ## API Endpoints
 
+### Base Path
+
+All CASE API endpoints are prefixed with: `/ims/case/v1p1`
+
+### Available Endpoints
+
+#### Associations Manager
+
+- `GET /ims/case/v1p1/CFAssociations/{sourcedId}` - Get a specific association
+
+#### Definitions Manager
+
+- `GET /ims/case/v1p1/CFAssociationGroupings/{sourcedId}` - Get an association grouping
+- `GET /ims/case/v1p1/CFConcepts/{sourcedId}` - Get a concept
+- `GET /ims/case/v1p1/CFSubjects/{sourcedId}` - Get a subject
+- `GET /ims/case/v1p1/CFLicenses/{sourcedId}` - Get a license
+- `GET /ims/case/v1p1/CFItemTypes/{sourcedId}` - Get an item type
+
+#### Documents Manager
+
+- `GET /ims/case/v1p1/CFDocuments` - List all documents
+- `GET /ims/case/v1p1/CFDocuments/{sourcedId}` - Get a specific document
+
+#### Items Manager
+
+- `GET /ims/case/v1p1/CFItems` - List all items
+- `GET /ims/case/v1p1/CFItems/{sourcedId}` - Get a specific item
+
+#### Packages Manager
+
+- `GET /ims/case/v1p1/CFPackages/{sourcedId}` - Get a package
+
+#### Rubrics Manager
+
+- `GET /ims/case/v1p1/CFRubrics/{sourcedId}` - Get a rubric
+- `GET /ims/case/v1p1/CFRubricCriteria/{sourcedId}` - Get rubric criteria
+
 #### Utilities
 
 - `GET /` - Service information
@@ -128,12 +174,23 @@ CASEProvider/
 ├── prisma/
 │   ├── migrations/            # Database migrations
 │   └── schema.prisma          # Database schema
+├── public/
+│   └── openapi-spec.json      # CASE v1.1 OpenAPI specification
 ├── src/
 │   ├── index.ts               # Application entry point
 │   ├── lib/
+│   │   ├── errors.ts          # Error handling utilities
 │   │   ├── prisma.ts          # Prisma client
+│   │   └── validation.ts      # Validation utilities
 │   ├── routes/
-│   │   ├── upload.ts          # Upload routes
+│       ├── associations.ts    # Associations endpoints
+│       ├── definitions.ts     # Definitions endpoints
+│       ├── documents.ts       # Documents endpoints
+│       ├── items.ts           # Items endpoints
+│       ├── packages.ts        # Packages endpoints
+│       ├── rubrics.ts         # Rubrics endpoints
+│       ├── spec.ts            # OpenAPI spec endpoint
+│       └── upload.ts          # Upload endpoints
 ├── package.json
 ├── tsconfig.json
 └── README.md

CASEProvider/public/openapi-spec.json

@@ -3,6 +3,13 @@ import cors from 'cors';
 import dotenv from 'dotenv';
 import { uploadRouter } from './routes/upload';
 import { nullValueCleanup } from './middlewares/json';
+import { BASE_PATH } from './routes/constants';
+import { associationsRouter } from './routes/associations';
+import { definitionsRouter } from './routes/definitions';
+import { documentsRouter } from './routes/documents';
+import { itemsRouter } from './routes/items';
+import { packagesRouter } from './routes/packages';
+import { rubricsRouter } from './routes/rubrics';
 
 dotenv.config();
 
@@ -15,6 +22,12 @@ app.use(nullValueCleanup);
 
 // Mount routers
 app.use("/", uploadRouter);
+app.use(BASE_PATH, associationsRouter);
+app.use(BASE_PATH, definitionsRouter);
+app.use(BASE_PATH, documentsRouter);
+app.use(BASE_PATH, itemsRouter);
+app.use(BASE_PATH, packagesRouter);
+app.use(BASE_PATH, rubricsRouter);
 
 // Health check endpoint
 app.get('/health', (req, res) => {

CASEProvider/src/index.ts

@@ -0,0 +1,94 @@
+import { Response } from "express";
+
+type CodeMinorField = {
+  imsx_codeMinorFieldName: string;
+  imsx_codeMinorFieldValue: string;
+};
+
+type CodeMinor = {
+  imsx_codeMinorField: CodeMinorField[];
+};
+
+type StatusInfo = {
+  imsx_codeMajor: string;
+  imsx_severity: string;
+  imsx_description: string;
+  imsx_codeMinor?: CodeMinor;
+};
+
+export const sendError = (
+  res: Response,
+  statusCode: number,
+  description: string,
+  field?: string,
+  codeMinor?: string
+) => {
+  const statusInfo: StatusInfo = {
+    imsx_codeMajor: "failure",
+    imsx_severity: "error",
+    imsx_description: description,
+  };
+
+  if (codeMinor) {
+    statusInfo.imsx_codeMinor = {
+      imsx_codeMinorField: [
+        {
+          imsx_codeMinorFieldName: field || "general",
+          imsx_codeMinorFieldValue: codeMinor,
+        },
+      ],
+    };
+  }
+
+  res.status(statusCode).json(statusInfo);
+};
+
+export const errors = {
+  notFound: (res: Response, message = "Unknown Object") =>
+    sendError(res, 404, message, "unknownobject"),
+
+  unauthorized: (res: Response) =>
+    sendError(
+      res,
+      401,
+      "The request was not correctly authorised",
+      "unauthorisedrequest"
+    ),
+
+  forbidden: (res: Response) =>
+    sendError(
+      res,
+      403,
+      "The server refuses to take any further action",
+      "forbidden"
+    ),
+
+  invalidSelection: (res: Response, field: string) =>
+    sendError(
+      res,
+      400,
+      "An invalid selection field was supplied",
+      field,
+      "invalid_selection_field"
+    ),
+
+  invalidQueryParameter: (res: Response, field: string) =>
+    sendError(
+      res,
+      400,
+      "An invalid query parameter was supplied",
+      field,
+      "invalid_query_parameter"
+    ),
+
+  serverBusy: (res: Response) =>
+    sendError(
+      res,
+      429,
+      "The server is receiving too many requests",
+      "server_busy"
+    ),
+
+  internalError: (res: Response) =>
+    sendError(res, 500, "Internal server error", "internal_server_error"),
+};