collection schema

src/models/generated/schemasPublic.d.ts

@@ -8,10 +8,37 @@
 
 
 /**
- * Description of the collection object (Collection class)
+ * Collection details.
  */
 export interface Collection {
+  /**
+   * Unique identifier of the collection.
+   */
   uid: string;
+  /**
+   * Title of the collection.
+   */
+  title: string;
+  /**
+   * Description of the collection.
+   */
+  description: string;
+  /**
+   * Access level of the collection.
+   */
+  accessLevel: "public" | "private";
+  /**
+   * Creation date of the collection.
+   */
+  createdAt: string;
+  /**
+   * Last update date of the collection.
+   */
+  updatedAt: string;
+  /**
+   * Total number of items in the collection.
+   */
+  totalItems: number;
 }
 
 

src/schema/schemasPublic/Collection.json

@@ -1,15 +1,41 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Collection",
-  "description": "Description of the collection object (Collection class)",
+  "description": "Collection details.",
   "type": "object",
   "additionalProperties": false,
-  "required": ["uid"],
   "properties": {
     "uid": {
       "type": "string",
-      "minLength": 2,
-      "maxLength": 50
+      "description": "Unique identifier of the collection."
+    },
+    "title": {
+      "type": "string",
+      "description": "Title of the collection."
+    },
+    "description": {
+      "type": "string",
+      "description": "Description of the collection."
+    },
+    "accessLevel": {
+      "type": "string",
+      "description": "Access level of the collection.",
+      "enum": ["public", "private"]
+    },
+    "createdAt": {
+      "type": "string",
+      "description": "Creation date of the collection.",
+      "format": "date-time"
+    },
+    "updatedAt": {
+      "type": "string",
+      "description": "Last update date of the collection.",
+      "format": "date-time"
+    },
+    "totalItems": {
+      "type": "integer",
+      "description": "Total number of items in the collection."
     }
-  }
+  },
+  "required": ["uid", "title", "description", "accessLevel", "createdAt", "updatedAt", "totalItems"]
 }

src/services/collections/collections.hooks.js

@@ -1,5 +1,9 @@
 import { authenticateAround as authenticate } from '../../hooks/authenticate'
 import { rateLimit } from '../../hooks/rateLimiter'
+import { transformResponseDataItem, transformResponse } from '../../hooks/transformation'
+import { inPublicApi } from '../../hooks/redaction'
+import { transformCollection } from '../../transformers/collection'
+
 const { queryWithCommonParams, validate, utils, REGEX_UIDS } = require('../../hooks/params')
 
 const { STATUS_PRIVATE, STATUS_PUBLIC } = require('../../models/collections.model')
@@ -85,11 +89,11 @@ module.exports = {
 
   after: {
     all: [],
-    find: [],
-    get: [],
-    create: [],
+    find: [transformResponseDataItem(transformCollection, inPublicApi)],
+    get: [transformResponse(transformCollection, inPublicApi)],
+    create: [transformResponse(transformCollection, inPublicApi)],
     update: [],
-    patch: [],
+    patch: [transformResponse(transformCollection, inPublicApi)],
     remove: [],
   },
 

src/transformers/collection.ts

@@ -0,0 +1,23 @@
+import { Collection as CollectionInternal } from '../models/generated/schemas'
+import { Collection as CollectionPublic } from '../models/generated/schemasPublic'
+
+const toAccessLevel = (status: string): CollectionPublic['accessLevel'] => {
+  switch (status.toUpperCase()) {
+    case 'PUB':
+      return 'public'
+    default:
+      return 'private'
+  }
+}
+
+export const transformCollection = (input: CollectionInternal): CollectionPublic => {
+  return {
+    uid: input.uid,
+    title: input.name,
+    description: input.description,
+    createdAt: input.creationDate,
+    updatedAt: input.lastModifiedDate,
+    totalItems: Number(input.countItems),
+    accessLevel: toAccessLevel(input.status),
+  }
+}