project.interface.ts

import {
  ApiKeyDto,
  ProjectCollectionDTO,
  ProjectDetailsDTO,
  ProjectForUserDTO,
  ProjectInvitationsDto,
} from '../repositories/projects/types';
import { PermissionName } from '../repositories/projects/util';
import { UserData } from '../repositories/users/types';

export interface CreateProjectResponse {
  id: number;
  name: string;
  slug: string;
}

export interface CreateProjectRequest {
  name: string;
  slug: string;
}

export type ListProjectResponse = ProjectForUserDTO[];

export type ProjectDetailsResponse = ProjectDetailsDTO;

export interface GenerateProjectApiKeyRequest {
  name: string;
  expireAt: Date;
  force: boolean;
}

export interface GenerateProjectApiKeyResponse {
  apiKey: string;
}

export interface ListApiKeysResponse {
  keys: ApiKeyDto[];
}

export interface CreateProjectCollectionRequest {
  name: string;
  isPublic: boolean;
  collectionData: Record<string, unknown>;
}

export interface CreateProjectCollectionResponse {
  collectionId: number;
}

export type GetProjectCollectionByIdResponse = ProjectCollectionDTO;

export type GetCollectionDataResponse = object;

export type ListProjectCollectionsResponse = ProjectCollectionDTO[];

export interface RegisterDeviceRequest {
  token: string;
  timestamp: number;
}

export interface UpdateProjectCollectionRequest {
  name: string;
  isPublic: boolean;
}

export interface InviteProjectMemberRequest {
  memberName: string;
  emailAddress: string;
  permissions: PermissionName[];
}

export interface CancelProjectInvitationRequest {
  emailAddress: string;
}

export type listProjectInvitationResponse = ProjectInvitationsDto;

export interface listProjectUsersResponse {
  users: Array<
    UserData & {
      permissions: string[];
    }
  >;
}

export interface UpdateProjectUserPermissionRequest {
  permissions: PermissionName[];
}