@edifice.io/communities-tests 1.0.0-develop-pedago.9.1753990538887 → 1.1.3

package/it/scenarios/utils/_http-response.utils.ts

@@ -0,0 +1,46 @@
+//Response type: wrap either an error code or a response entity from HTTP calls
+export type HttpResponse<T> = Either<HttpError, T>;
+
+//Http Error type, for use in the k6 function checkReturnCode
+export type HttpError = {
+  status: number;
+};
+
+//Helper functions to create success or failure http responses
+export function failure<T>(status: number): HttpResponse<T> {
+  return left({ status });
+}
+export function success<T>(result: T): HttpResponse<T> {
+  return right(result);
+}
+
+//Either type with Left and Right classes
+type Either<L, R> = Left<L> | Right<R>;
+
+class Left<L> {
+  constructor(public readonly value: L) {}
+  isLeft(): this is Left<L> {
+    return true;
+  }
+  isRight(): this is Right<unknown> {
+    return false;
+  }
+}
+
+class Right<R> {
+  constructor(public readonly value: R) {}
+  isLeft(): this is Left<unknown> {
+    return false;
+  }
+  isRight(): this is Right<R> {
+    return true;
+  }
+}
+
+//Helper functions to create instances of Left and Right
+function left<L, R>(l: L): Either<L, R> {
+  return new Left(l);
+}
+function right<L, R>(r: R): Either<L, R> {
+  return new Right(r);
+}

package/it/scenarios/utils/_invitation-api.utils.ts

@@ -191,54 +191,54 @@ export function listMyInvitations(
     seeLater?: boolean;
     communityId?: number;
     fields?: string[];
-  } = {}
+  } = {},
 ): PaginatedInvitations | null {
   try {
     let url = `${rootUrl}/communities/api/invitations`;
     const queryParams = new URLSearchParams();
-    
+
     // Add pagination parameters
     if (options.page) {
       queryParams.append("page", options.page.toString());
     }
-    
+
     if (options.size) {
       queryParams.append("size", options.size.toString());
     }
-    
+
     // Add filters
     if (options.status) {
       queryParams.append("status", options.status);
     }
-    
+
     if (options.seeLater !== undefined) {
       queryParams.append("seelater", options.seeLater.toString());
     }
-    
+
     if (options.communityId) {
       queryParams.append("communityid", options.communityId.toString());
     }
-    
+
     // Add fields to include
     if (options.fields && options.fields.length > 0) {
-      options.fields.forEach(field => {
+      options.fields.forEach((field) => {
         queryParams.append("fields", field);
       });
     }
-    
+
     // Add query string to URL if there are parameters
     const queryString = queryParams.toString();
     if (queryString) {
       url += `?${queryString}`;
     }
-    
+
     const response = http.get(url, { headers: getHeaders() });
-    
+
     if (response.status === 200) {
       return JSON.parse(<string>response.body);
     } else {
       console.error(
-        `Failed to list invitations: ${response.status} ${response.body}`
+        `Failed to list invitations: ${response.status} ${response.body}`,
       );
       return null;
     }
@@ -426,23 +426,21 @@ export function updateRequestStatus(
  */
 export function updateInvitationSeeLater(
   invitationId: number | string,
-  seeLater: boolean
+  seeLater: boolean,
 ): Invitation | null {
   try {
     const url = `${rootUrl}/communities/api/invitations/${invitationId}/see-later`;
     const payload = { seeLater };
-    
-    const response = http.put(
-      url,
-      JSON.stringify(payload),
-      { headers: { ...getHeaders(), "Content-Type": "application/json" } }
-    );
-    
+
+    const response = http.put(url, JSON.stringify(payload), {
+      headers: { ...getHeaders(), "Content-Type": "application/json" },
+    });
+
     if (response.status === 200 || response.status === 201) {
       return JSON.parse(<string>response.body);
     } else {
       console.error(
-        `Failed to update see-later flag: ${response.status} ${response.body}`
+        `Failed to update see-later flag: ${response.status} ${response.body}`,
       );
       return null;
     }

package/it/scenarios/utils/_resource-api.utils.ts

@@ -35,6 +35,7 @@ export type CreateResourceParams = {
   resourceUrl?: string;
   openInNewTab?: boolean;
   resourceEntId?: string;
+  folderId?: number;
 };
 
 export type UpdateResourceParams = {
@@ -65,7 +66,7 @@ export type Resource = {
     displayName: string;
   };
   communityId: number;
-  folderIds: number[];
+  folderId?: number;
 };
 
 export type PageMetadata = {
@@ -261,8 +262,9 @@ export function listResourcesWithSearch(
     addedAfter?: string;
     sortBy?: string;
     sortDirection?: SortDirection;
-  } = {}
-) : ResourcesResponse | null {
+    folderId?: number;
+  } = {},
+): ResourcesResponse | null {
   const {
     page = 1,
     size = 10,
@@ -271,22 +273,27 @@ export function listResourcesWithSearch(
     addedAfter,
     sortBy,
     sortDirection,
+    folderId,
   } = options;
 
   let url = `${rootUrl}/communities/api/communities/${communityId}/resources?page=${page}&size=${size}`;
-  
+
   if (search) url += `&search=${encodeURIComponent(search)}`;
   if (type) url += `&type=${encodeURIComponent(type)}`;
+  if (folderId) url += `&folderId=${encodeURIComponent(folderId)}`;
   if (addedAfter) url += `&addedafter=${encodeURIComponent(addedAfter)}`;
   if (sortBy) url += `&sortby=${encodeURIComponent(sortBy)}`;
-  if (sortDirection) url += `&sortdirection=${encodeURIComponent(sortDirection)}`;
+  if (sortDirection)
+    url += `&sortdirection=${encodeURIComponent(sortDirection)}`;
 
   const response = http.get(url, { headers: getHeaders() });
 
   if (response.status === 200) {
     return JSON.parse(response.body as string);
   }
-  
-  console.error(`Failed to list resources: ${response.status} - ${response.body}`);
+
+  console.error(
+    `Failed to list resources: ${response.status} - ${response.body}`,
+  );
   return null;
 }

package/it/scenarios/utils/_role.utils.ts

@@ -1,5 +1,9 @@
 import http from "k6/http";
-import { getHeaders, getRoleByName, Role } from "../../../node_modules/edifice-k6-commons/dist/index.js";
+import {
+  getHeaders,
+  getRoleByName,
+  Role,
+} from "../../../node_modules/edifice-k6-commons/dist/index.js";
 import { check } from "k6";
 
 const rootUrl = __ENV.ROOT_URL || "";
@@ -15,8 +19,12 @@ export function createAndSetAllRoles(): Role {
       { headers: getHeaders() },
     );
     check(res, { "get workflow actions": (r) => r.status == 200 });
-    const applications = JSON.parse(<string>res.body) as Array<{actions: string[]}>;
-    const actions = applications.flatMap(application => application.actions.map((entries) => entries[0]));
+    const applications = JSON.parse(<string>res.body) as Array<{
+      actions: string[];
+    }>;
+    const actions = applications.flatMap((application) =>
+      application.actions.map((entries) => entries[0]),
+    );
     const headers = getHeaders();
     headers["content-type"] = "application/json";
     const payload = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edifice.io/communities-tests",
-  "version": "1.0.0-develop-pedago.9.1753990538887",
+  "version": "1.1.3",
   "description": "Common functions for testing module community with K6.",
   "repository": {
     "type": "git",
@@ -27,22 +27,14 @@
     "husky": "^9.0.11",
     "prettier": "^3.2.5",
     "semantic-release": "^23.0.2",
-    "typescript": "^5.2.2",
     "vite": "^5.1.4",
     "vite-plugin-dts": "^4.3.0"
   },
-  "lint-staged": {
-    "*.{js,ts,jsx,tsx,json,css,md}": "pnpm format"
-  },
   "scripts": {
     "dev": "vite",
     "build": "tsc && vite build",
     "build:types": "tsc --build",
     "preview": "vite preview",
-    "clean": "rm -Rf dist",
-    "format": "pnpm run format:write && pnpm run format:check",
-    "format:check": "npx prettier --check \"src/**/*.ts\"",
-    "format:write": "npx prettier --write \"src/**/*.ts\"",
-    "pre-commit": "pnpm run format"
+    "clean": "rm -Rf dist"
   }
 }

package/types/generated/announcement.ts

@@ -0,0 +1,73 @@
+// Types automatically generated from DTOs using TypeScript Compiler API
+// Category: announcement
+// Generated on: 2025-12-02T09:34:02.434Z
+
+import {
+  PageMetadataDto,
+  PaginationQueryDto,
+  SortDirection,
+  UserDto,
+} from "./base";
+
+export enum MediaType {
+  AUDIO = "audio",
+  VIDEO = "video",
+  IMAGE = "image",
+  ATTACHMENT = "attachment",
+  EMBEDDER = "embedder",
+  HYPERLINK = "hyperlink",
+  STUDIO = "studio",
+}
+
+export enum AnnouncementSortField {
+  PUBLICATION_DATE = "publicationDate",
+  MODIFICATION_DATE = "modificationDate",
+}
+
+export interface MediaDto {
+  id: string;
+  name: string;
+  type: MediaType;
+  mimeType: string;
+  url: string;
+}
+
+export interface AnnouncementDto {
+  id: number;
+  content: string;
+  publicationDate: Date;
+  modificationDate?: Date;
+  author: UserDto;
+  modifier?: UserDto;
+  media: MediaDto[];
+  communityId: number;
+}
+
+export interface CreateAnnouncementDto {
+  content: string;
+  media: MediaDto[];
+}
+
+export interface UpdateAnnouncementDto {
+  content: string;
+  media: MediaDto[];
+}
+
+export interface CountAnnouncementDto {
+  count: number;
+}
+
+export interface SearchAnnouncementDto extends PaginationQueryDto {
+  publishedAfter?: Date;
+  sortBy?: AnnouncementSortField;
+  sortDirection?: SortDirection;
+}
+
+export interface SearchAnnouncementResponseDto {
+  items: AnnouncementDto[];
+  meta: PageMetadataDto;
+}
+
+export interface CountAnnouncementsDto {
+  count: number;
+}

package/types/generated/base.ts

@@ -0,0 +1,32 @@
+// Types automatically generated from DTOs using TypeScript Compiler API
+// Category: base
+// Generated on: 2025-12-02T09:34:02.436Z
+
+export enum SortDirection {
+  ASC = "ASC",
+  DESC = "DESC",
+}
+
+export interface PaginationQueryDto {
+  page?: number;
+  size?: number;
+}
+
+export interface PageMetadataDto {
+  totalItems: number;
+  itemCount: number;
+  itemsPerPage: number;
+  totalPages: number;
+  currentPage: number;
+}
+
+export interface FieldSelectionDto {
+  fields?: string;
+}
+
+export interface UserDto {
+  id: number;
+  displayName: string;
+  entId: string;
+  profile: string;
+}

package/types/generated/community.ts

@@ -0,0 +1,97 @@
+// Types automatically generated from DTOs using TypeScript Compiler API
+// Category: community
+// Generated on: 2025-12-02T09:34:02.436Z
+
+import { InvitedUserDto } from "./invitation";
+import {
+  PageMetadataDto,
+  PaginationQueryDto,
+  SortDirection,
+  UserDto,
+} from "./base";
+
+export enum CommunityType {
+  CLASS = "CLASS",
+  FREE = "FREE",
+}
+
+export enum CommunitySortField {
+  TITLE = "TITLE",
+}
+
+export interface InitialInvitationDto {
+  users: InvitedUserDto[];
+}
+
+export interface CreateCommunityDto {
+  image?: string;
+  title: string;
+  type: CommunityType;
+  schoolYearStart?: number;
+  schoolYearEnd?: number;
+  welcomeNote?: string;
+  discussionEnabled: boolean;
+  secretCode?: string;
+  invitations?: InitialInvitationDto;
+  colour?: string;
+}
+
+export interface UpdateCommunityDto {
+  image?: string;
+  title: string;
+  type: CommunityType;
+  schoolYearStart?: number;
+  schoolYearEnd?: number;
+  welcomeNote?: string;
+  discussionEnabled: boolean;
+  secretCode?: string;
+  colour?: string;
+}
+
+export interface SearchCommunityRequestDto extends PaginationQueryDto {
+  title?: string;
+  type?: CommunityType;
+  createdAfter?: Date;
+  schoolYear?: number;
+  sortBy?: CommunitySortField;
+  sortDirection?: SortDirection;
+  fields?: string[];
+}
+
+export interface SearchCommunityResponseDto {
+  items: CommunityResponseDto[];
+  meta: PageMetadataDto;
+}
+
+export interface CommunityStatsDto {
+  totalMembers: number;
+  acceptedMembers: number;
+  totalAdmins: number;
+  acceptedAdmins: number;
+}
+
+export interface CommunityResponseDto {
+  id: number;
+  image?: string;
+  title: string;
+  creationDate: Date;
+  updateDate?: Date;
+  type: CommunityType;
+  schoolYearStart?: number;
+  schoolYearEnd?: number;
+  welcomeNote?: string;
+  discussionEnabled: boolean;
+  archivedDate?: Date;
+  creator: UserDto;
+  modifier?: UserDto;
+  archiver?: UserDto;
+  stats?: CommunityStatsDto;
+  colour?: string;
+}
+
+export interface CommunitySecretCodeDto {
+  id: number;
+  secretCode: string;
+}
+
+export type CommunityFields = "basic" | "stats";

package/types/generated/discussion.ts

@@ -0,0 +1,47 @@
+// Types automatically generated from DTOs using TypeScript Compiler API
+// Category: discussion
+// Generated on: 2025-12-02T09:34:02.436Z
+
+import { PageMetadataDto } from "./base";
+
+export interface CountDiscussionDto {
+  count: number;
+}
+
+export interface CountDiscussionMessageDto {
+  count: number;
+}
+
+export interface CountDiscussionsDto {
+  count: number;
+}
+
+export interface DiscussionDto {
+  id: number;
+  title: string;
+  creationDate: Date;
+  updateDate: Date;
+  creatorId: number;
+  communityId: number;
+  archivedDate?: Date;
+  archivedById?: number;
+}
+
+export interface SearchDiscussionDto {
+  page?: number;
+  size?: number;
+  sortBy?: string;
+  sortDirection?: string;
+  search?: string;
+}
+
+export interface SearchDiscussionResponseDto {
+  items: DiscussionDto[];
+  meta: PageMetadataDto;
+}
+
+export interface CreateDiscussionDto {
+  title: string;
+  content: string;
+  communityId: number;
+}

package/types/generated/folder.ts

@@ -0,0 +1,49 @@
+// Types automatically generated from DTOs using TypeScript Compiler API
+// Category: folder
+// Generated on: 2025-12-02T09:34:02.436Z
+
+import { PageMetadataDto, PaginationQueryDto, UserDto } from "./base";
+import { ResourceDto } from "./resource";
+
+export interface FolderStatsDto {
+  childCount: number;
+}
+
+export interface FolderDto {
+  id: number;
+  name: string;
+  creationDate: Date;
+  modificationDate?: Date;
+  isRoot: boolean;
+  creator: UserDto;
+  modifier?: UserDto;
+  parentId?: number;
+  communityId: number;
+  stats?: FolderStatsDto;
+}
+
+export interface FolderDetailsDto extends FolderDto {
+  subFolders?: FolderDto[];
+  resources?: ResourceDto[];
+}
+
+export interface CreateFolderDto {
+  name: string;
+  parentId?: number;
+}
+
+export interface UpdateFolderDto {
+  name: string;
+  parentId?: number;
+}
+
+export interface SearchFolderDto extends PaginationQueryDto {
+  name?: string;
+  parentId?: number;
+  rootOnly?: boolean;
+}
+
+export interface SearchFolderResponseDto {
+  items: FolderDto[];
+  meta: PageMetadataDto;
+}

package/types/generated/index.ts

@@ -0,0 +1,12 @@
+// Index of automatically generated K6 types
+// Generated on: 2025-12-02T09:34:02.437Z
+
+export * from "./announcement.ts";
+export * from "./base.ts";
+export * from "./community.ts";
+export * from "./discussion.ts";
+export * from "./folder.ts";
+export * from "./invitation.ts";
+export * from "./membership.ts";
+export * from "./resource.ts";
+export * from "./wiki.ts";