@churchapps/helpers/src/interfaces/Access.ts

Library of helper functions not specific to any one ChurchApps project or framework.

import { PersonInterface } from "./Membership";

export interface ApiInterface {
  name: string;
  keyName?: string;
  permissions: RolePermissionInterface[];
  jwt: string;
}
export interface ChurchInterface {
  id?: string;
  name?: string;
  registrationDate?: Date;
  address1?: string;
  address2?: string;
  city?: string;
  state?: string;
  zip?: string;
  country?: string;
  subDomain?: string;
  settings?: GenericSettingInterface[];
  archivedDate?: Date;
}
export interface DomainInterface {
  id?: string;
  domainName?: string;
}
export interface RegisterChurchRequestInterface extends ChurchInterface {
  appName?: string;
}
export interface LoadCreateUserRequestInterface {
  userEmail: string;
  fromEmail?: string;
  subject?: string;
  body?: string;
  firstName: string;
  lastName: string;
}
export interface LoginResponseInterface {
  user: UserInterface;
  userChurches: LoginUserChurchInterface[];
  errors: string[];
}
export interface LoginUserChurchInterface {
  person: PersonInterface;
  church: ChurchInterface;
  apis: ApiInterface[];
  jwt: string;
  groups: { id: string; tags: string; name: string; leader: boolean }[];
}

export interface PermissionInterface {
  apiName?: string;
  section?: string;
  action?: string;
  displaySection?: string;
  displayAction?: string;
}
export interface RegisterUserInterface {
  firstName?: string;
  lastName: string;
  email?: string;
  appName: string;
  appUrl: string;
}
export interface RoleInterface {
  id?: string;
  churchId?: string;
  name?: string;
}
export interface RolePermissionInterface {
  id?: string;
  churchId?: string;
  roleId?: string;
  apiName?: string;
  contentType?: string;
  contentId?: string;
  action?: string;
}
export interface RoleMemberInterface {
  id?: string;
  churchId?: string;
  roleId?: string;
  userId?: string;
  user?: UserInterface;
  personId?: string;
}
export interface ResetPasswordRequestInterface {
  userEmail: string;
}
export interface ResetPasswordResponseInterface {
  emailed: boolean;
}
export interface UserInterface {
  id?: string;
  email?: string;
  authGuid?: string;
  firstName?: string;
  lastName?: string;
  registrationDate?: Date;
  lastLogin?: Date;
  password?: string;
  jwt?: string;
}
export interface GenericSettingInterface {
  id?: string;
  churchId?: string;
  keyName?: string;
  value?: string;
  public?: number;
}
export interface UserChurchInterface {
  id?: string;
  userId?: string;
  churchId?: string;
  personId?: string;
}

export interface ApiConfig {
  keyName: string;
  url: string;
  jwt: string;
  permissions: RolePermissionInterface[];
}
export type ApiListType =
  | "MembershipApi"
  | "AttendanceApi"
  | "GivingApi"
  | "DoingApi"
  | "MessagingApi"
  | "LessonsApi"
  | "ReportingApi"
  | "ContentApi"
  | "AskApi";
export interface IApiPermission {
  api: string;
  contentType: string;
  action: string;
}