evo360-types 1.1.16 → 1.1.18

package/dist/index.d.ts

@@ -1,11 +1,14 @@
-export * from "./types/shared/index";
-export * from "./types/evo-core/index";
-export * from "./types/evo-tenant/index";
-export * from "./types/evo-people/index";
-export * from "./types/evo-calendar/index";
-export * from "./types/evo-task/index";
-export * from "./types/evo-survey/index";
-export * from "./types/evo-meeting/index";
+// @evo360/types/index.ts
+export * from "./types/shared";
+export * from "./types/evo-core";
+export * from "./types/evo-tenant";
+export * from "./types/evo-people";
+export * from "./types/evo-calendar";
+export * from "./types/evo-task";
+export * from "./types/evo-survey";
+export * from "./types/evo-meeting";
+
+// zod schemas
 export * from "./apps/shared/zod-schemas";
 export * from "./apps/evo-core/zod-schemas";
 export * from "./apps/evo-tenant/zod-schemas";

package/dist/index.js

@@ -15,14 +15,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 // @evo360/types/index.ts
-__exportStar(require("./types/shared/index"), exports);
-__exportStar(require("./types/evo-core/index"), exports);
-__exportStar(require("./types/evo-tenant/index"), exports);
-__exportStar(require("./types/evo-people/index"), exports);
-__exportStar(require("./types/evo-calendar/index"), exports);
-__exportStar(require("./types/evo-task/index"), exports);
-__exportStar(require("./types/evo-survey/index"), exports);
-__exportStar(require("./types/evo-meeting/index"), exports);
+__exportStar(require("./types/shared"), exports);
+__exportStar(require("./types/evo-core"), exports);
+__exportStar(require("./types/evo-tenant"), exports);
+__exportStar(require("./types/evo-people"), exports);
+__exportStar(require("./types/evo-calendar"), exports);
+__exportStar(require("./types/evo-task"), exports);
+__exportStar(require("./types/evo-survey"), exports);
+__exportStar(require("./types/evo-meeting"), exports);
 // zod schemas
 __exportStar(require("./apps/shared/zod-schemas"), exports);
 __exportStar(require("./apps/evo-core/zod-schemas"), exports);

package/dist/index.ts

@@ -0,0 +1,19 @@
+// @evo360/types/index.ts
+export * from "./types/shared";
+export * from "./types/evo-core";
+export * from "./types/evo-tenant";
+export * from "./types/evo-people";
+export * from "./types/evo-calendar";
+export * from "./types/evo-task";
+export * from "./types/evo-survey";
+export * from "./types/evo-meeting";
+
+// zod schemas
+export * from "./apps/shared/zod-schemas";
+export * from "./apps/evo-core/zod-schemas";
+export * from "./apps/evo-tenant/zod-schemas";
+export * from "./apps/evo-people/zod-schemas";
+export * from "./apps/evo-calendar/zod-schemas";
+export * from "./apps/evo-task/zod-schemas";
+export * from "./apps/evo-survey/zod-schemas";
+export * from "./apps/evo-meeting/zod-schemas";

package/dist/types/evo-calendar/fb_collections.ts

@@ -0,0 +1,5 @@
+//EVO Calendar Application Doc
+export const EVO_CALENDAR_APP = "evo-calendar";
+
+//Calendar collection
+export const EVENTS_COLLECTION = "events";

package/dist/types/evo-calendar/index.ts

@@ -0,0 +1,61 @@
+export * from "./fb_collections";
+import { FirestoreDocumentReference, IFireDoc, ITag } from "../shared";
+import { MeetingType } from "../evo-meeting";
+
+// ----- CalendarTypes
+// Enum for Event Instance Status
+export type EventStatus = "scheduled" | "completed" | "cancelled";
+export enum IEventStatus {
+  Scheduled = "scheduled", // The event is scheduled and upcoming
+  Completed = "completed", // The event has been completed
+  Cancelled = "cancelled", // The event has been cancelled
+}
+
+// Enum for Event Types
+export type EventType = "event" | "meeting" | "workshop" | "other";
+export enum IEventType {
+  Event = "event", // A general event type
+  Meeting = "meeting", // A meeting event
+  Workshop = "workshop", // A workshop event
+  Other = "other", // Any other type of event
+}
+
+// Interface for Meeting within a Event (meetingTasks)
+export interface IEventMeeting {
+  meetingRef?: FirestoreDocumentReference; // Reference to the original task
+  type: MeetingType; // Type of meeting
+  readonly task_count?: number;
+  readonly talkingPoints_count?: number;
+  tags?: ITag[];
+}
+
+// Interface for Recurring Events (recurringEvents)
+export interface IRecurringEvent extends IFireDoc {
+  title: string; // Title of the meeting
+  description?: string; // Optional description of the meeting
+  creatorName: string; // Name of the user who created the event
+  creatorRef?: FirestoreDocumentReference; // reference to the user who created the event
+  participants: string[]; // List of participant IDs
+  startDate: Date; // Start date and time of the first meeting
+  endDate?: Date; // Optional end date and time of the recurring meeting
+  type: EventType; // Type of event
+  rrule: string; // Recurrence rule in RRULE format
+  exceptions: string[]; // List of instance IDs that represent exceptions
+}
+
+// Interface for Event Instances (eventInstances)
+export interface IEvent extends IFireDoc {
+  recurringRef?: FirestoreDocumentReference; // Reference to the recurring event rule (optional)
+  title: string; // Title of the event
+  description?: string; // Optional description of the event
+  creatorName: string; // Name of the user who created the event
+  creatorRef?: FirestoreDocumentReference; // reference to the user who created the event
+  participantNames?: string[]; // List of participant names
+  participantRefs?: FirestoreDocumentReference[]; // List of participant references
+  startDate: Date; // Start date and time of the event
+  endDate?: Date; // Optional end date and time of the event
+  type: EventType; // Type of event
+  tags?: ITag[];
+  meeting?: IEventMeeting;
+  status: EventStatus; // Status of the event
+}

package/dist/types/evo-core/index.ts

@@ -0,0 +1,48 @@
+import { FirestoreDocumentReference, IFireDoc } from "../shared";
+
+//UserTypes
+export interface IUserSpecialRoles {
+  is_admin: boolean;
+  is_sys_admin: boolean;
+}
+
+export interface IUser extends IUserSpecialRoles, IFireDoc {
+  display_name: string;
+  email: string;
+  email_verified?: string;
+  full_name: string;
+  last_access: Date;
+  member_since: Date;
+  mobile_number?: string;
+  mobile_number_verified?: boolean;
+  phone_number?: null | string;
+  picture_url?: null | string;
+  role: number;
+  tenantRef?: FirestoreDocumentReference | null;
+  tenants?: string[];
+  sid?: null | string;
+}
+
+//AuthTypes
+export interface ILogin {
+  id: string;
+  user?: FirestoreDocumentReference;
+  displayname?: string | null;
+  email?: string | null;
+  emailverif?: false | boolean;
+  providerId?: string | null;
+}
+
+export interface IAction {
+  code: number;
+  action: string;
+  created_at: Date;
+  args?: IActionArgs | string | unknown | null;
+  user?: FirestoreDocumentReference;
+}
+
+export interface IActionArgs {
+  old_values?: Record<string, any>;
+  new_values?: Record<string, any>;
+  deleted_at?: Date;
+}

package/dist/types/evo-meeting/fb_collections.ts

@@ -0,0 +1,5 @@
+//EVO Meeting Application Doc
+export const EVO_MEETING_APP = "evo-meeting";
+
+//meetings collection
+export const MEETINGS_COLLECTION = "meetings";

package/dist/types/evo-meeting/index.ts

@@ -0,0 +1,69 @@
+export * from "./fb_collections";
+import { FirestoreDocumentReference, IFireDoc, ITag } from "../shared";
+import { TaskPriority, TaskStatus } from "../evo-task";
+
+// ----- MeetingTypes
+export type MeetingType =
+  | "regular"
+  | "oneonone"
+  | "feedback"
+  | "presentation"
+  | "other";
+export enum IMeetingType {
+  Regular = "regular", // A regular meeting
+  OneOnOne = "oneonone", // A one-on-one meeting
+  Feedback = "feedback", // A feedback session
+  Presentation = "presentation", // A presentation meeting
+  Other = "other", // Any other type of meeting
+}
+
+// Interface for Event within a Meeting (meetingEvent)
+export interface IMeetingEvent {
+  eventRef?: FirestoreDocumentReference; // Reference to the original event
+  participantNames: string[]; // List of participant names
+  participantRefs?: FirestoreDocumentReference[]; // List of participant references
+  startDate: Date; // Start date and time of the event
+  endDate?: Date; // Optional end date and time of the event
+}
+
+// Interface for Tasks within a Meeting (meetingTasks)
+export interface IMeetingTask {
+  taskRef?: FirestoreDocumentReference; // Reference to the original task
+  title: string; // Title (copied from the original task)
+  status: TaskStatus; // Status (can be updated independently from the original task)
+  priority?: TaskPriority; // Priority (copied from the original task)
+  assigneeName?: string; // Name of the assignee (copied from the original task)
+}
+
+// Interface for Talking Point Templates (talkingPointTemplates)
+export interface ITalkingPointTemplate extends IFireDoc {
+  title: string; // Title of the talking point
+  description?: string; // Optional detailed description
+  tags?: ITag[]; // Optional tags for categorization
+}
+
+// Interface for Talking Points within a Meeting (meetingTalkingPoints)
+export interface IMeetingTalkingPoint {
+  templateRef?: FirestoreDocumentReference; // Reference to the original template
+  title: string; // Title (can be copied from the template or edited)
+  description?: string; // Description (can be copied from the template or edited)
+  tags?: ITag[]; // Tags (can be copied from the template or edited)
+  discussed: boolean; // Flag to indicate if the talking point was discussed
+  notes?: string; // Optional field for notes taken during the discussion
+  assigneeName?: string; // Name of the assignee (optional)
+  assigneeRef?: FirestoreDocumentReference; // Reference to the assignee (optional)
+}
+
+// Interface for Meeting Instances (meetingInstances)
+export interface IMeeting extends IFireDoc {
+  title: string; // Title of the meeting
+  description?: string; // Optional description of the meeting
+  creatorName: string; // Name of the user who created the meeting
+  creatorRef?: FirestoreDocumentReference; // reference to the user who created the meeting
+  event: IMeetingEvent;
+  type: MeetingType; // Type of meeting
+  tasks?: IMeetingTask[];
+  talkingPoints?: IMeetingTalkingPoint[];
+  tags?: ITag[];
+  [key: string]: unknown; // index signature
+}

package/dist/types/evo-people/fb_collections.ts

@@ -0,0 +1,8 @@
+//EVO People Application Doc
+export const EVO_PEOPLE_APP = "evo-people";
+
+//people
+export const COMPANIES_COLLECTION = "companies";
+export const DEPARTMENTS_COLLECTION = "departments";
+export const OFFICES_COLLECTION = "offices";
+export const EMPLOYEES_COLLECTION = "employees";

package/dist/types/evo-people/index.ts

@@ -0,0 +1,96 @@
+export * from "./fb_collections";
+import {
+  FirestoreDocumentReference,
+  IFireDoc,
+  IGeoPoint,
+  ITag,
+} from "../shared";
+
+// ----- PeopleTypes
+// PeopleTypes
+export type EmployeeStatus = "active" | "inactive" | "draft";
+export enum IEmployeeStatus {
+  Active = "active",
+  Inactive = "inactive",
+  Draft = "draft",
+}
+
+export interface IEmployeeCounters {
+  active: number;
+  inactive: number;
+  draft: number;
+  deleted: number;
+  total: number;
+}
+
+export interface IProfile extends IFireDoc {
+  display_name: string;
+  last_name?: string | null;
+  first_name?: string | null;
+  gender?: string | null;
+  birthdate?: Date | null;
+  photo_ref?: string | null;
+  photo_url?: string | null;
+}
+
+export interface IEmployee extends IProfile {
+  employee_id?: string | null;
+  type?: string | null;
+  job_title?: string | null;
+  status?: EmployeeStatus;
+  company_name?: string | null;
+  companyRef?: FirestoreDocumentReference;
+  date_joining?: Date | null;
+  reporting_to_name?: string | null;
+  reporting_toRef?: FirestoreDocumentReference;
+  department_name?: string | null;
+  departmentRef?: FirestoreDocumentReference;
+  office_name?: string | null;
+  officeRef?: FirestoreDocumentReference;
+  work_email?: string | null;
+  work_phone?: string | null;
+  work_mobile?: string | null;
+  tags?: ITag[];
+  userRef?: FirestoreDocumentReference;
+  [key: string]: unknown; // index signature
+}
+
+export interface IDepartment extends IFireDoc {
+  code: string;
+  name: string;
+  lead_name?: string | null;
+  leadRef?: FirestoreDocumentReference;
+  parent_department_name?: string | null;
+  parent_departmentRef?: FirestoreDocumentReference | null;
+  readonly employee_counters?: IEmployeeCounters;
+  tags?: ITag[];
+}
+
+export interface IOffice extends IFireDoc {
+  code: string;
+  name: string;
+  timezone?: string | null;
+  company_name?: string | null;
+  companyRef?: FirestoreDocumentReference;
+  lead_name?: string | null;
+  leadRef?: FirestoreDocumentReference;
+  address_line1?: string;
+  address_line2?: string;
+  address_city?: string;
+  address_state?: string;
+  address_zip?: string;
+  address_country?: string;
+  address_geo?: IGeoPoint;
+  readonly employee_counters?: IEmployeeCounters;
+  tags?: ITag[];
+}
+
+export interface ICompany extends IFireDoc {
+  code: string;
+  name: string;
+  lead_name?: string | null;
+  leadRef?: FirestoreDocumentReference;
+  readonly employee_counters?: IEmployeeCounters;
+  tags?: ITag[];
+  [key: string]: unknown; // index signature
+}

package/dist/types/evo-survey/fb_collections.ts

@@ -0,0 +1,12 @@
+//EVO Surveys Application Doc
+export const EVO_SURVEY_APP = "evo-survey";
+
+//surveys
+export const SURVEYS_COLLECTION = "surveys";
+export const SURVEY_SECTIONS_COLLECTION = "sections";
+export const SURVEY_QUESTIONS_COLLECTION = "questions";
+
+//deployments
+export const SURVEY_DEPLOYMENTS_COLLECTION = "deployments";
+export const SURVEY_DEPLOYMENTS_INVITATIONS_COLLECTION = "invitations";
+export const SURVEY_DEPLOYMENTS_SUBMISSIONS_COLLECTION = "submissions";

package/dist/types/evo-survey/index.ts

@@ -0,0 +1,156 @@
+export * from "./fb_collections";
+import { FirestoreDocumentReference, IFireDoc, ITag } from "../shared";
+// ---- Survey
+//Survey
+export type SurveyPermission = "private" | "company" | "public";
+export enum ISurveyPermission {
+  Private = "private",
+  Company = "company",
+  Public = "public",
+}
+
+export type SurveyType = "360" | "general";
+export enum ISurveyType {
+  Review360 = "360",
+  General = "general",
+}
+
+export type SurveyStatus = "draft" | "ready" | "archived";
+export enum ISurveyStatus {
+  Draft = "draft",
+  Ready = "ready",
+  Archived = "archived",
+}
+
+export type SurveyQuestionType = "scale" | "essay" | "options";
+export enum ISurveyQuestionType {
+  Scale = "scale",
+  Essay = "essay",
+  Options = "options",
+}
+
+export interface IQuestion extends IFireDoc {
+  surveyId: string;
+  sectionId: string;
+  statement?: string;
+  description?: string;
+  description_text?: string;
+  order?: number;
+  required?: boolean;
+  tags?: ITag[];
+  type?: ISurveyQuestionType;
+}
+
+export interface IQuestionScale extends IQuestion {
+  type: ISurveyQuestionType.Scale;
+  scale_min?: number;
+  scale_max?: number;
+}
+
+export enum IQuestionScaleDefaultsScales {
+  Min = 0,
+  Max = 5,
+}
+
+export interface IQuestionEssay extends IQuestion {
+  type: ISurveyQuestionType.Essay;
+  length_min?: number;
+  length_max?: number;
+}
+export enum IQuestionEssayDefaultsLength {
+  Min = 0,
+  Max = 1024,
+}
+
+export interface IQuestionMultipleChoice extends IQuestion {
+  type: ISurveyQuestionType.Options;
+  options: string[];
+  allow_multiple_selections?: boolean;
+}
+
+export interface ISection extends IFireDoc {
+  surveyId: string;
+  name: string;
+  description: string;
+  order: number;
+  questions: (IQuestionEssay | IQuestionScale | IQuestionMultipleChoice)[];
+  readonly question_count?: number;
+}
+
+export interface ISurvey extends IFireDoc {
+  name: string;
+  description?: string;
+  status: SurveyStatus;
+  permission: SurveyPermission;
+  tags?: ITag[];
+  type: SurveyType;
+  sections?: ISection[];
+  readonly section_count?: number;
+  readonly question_count?: number;
+}
+
+export type SurveyDeploymentStatus =
+  | "draft"
+  | "open"
+  | "closed"
+  | "in_progress"
+  | "paused";
+export enum ISurveyDeploymentStatus {
+  Draft = "draft", //A aplicação está sendo criada e ainda não foi aberta.
+  Open = "open", //A aplicação está aberta e disponível para submissões.
+  Closed = "closed", //A aplicação está fechada e não aceita mais submissões.
+  InProgress = "in_progress", // A aplicação está em andamento, mas ainda não foi fechada para novas
+  Paused = "paused", // A aplicação está pausada, está sem receber submissões temporariamente
+}
+
+export type SurveySubmissionStatus =
+  | "not_started"
+  | "in_progress"
+  | "completed";
+export enum ISurveySubmissionStatus {
+  NotStarted = "not_started", //A submissão ainda não foi iniciada.
+  InProgress = "in_progress", //A submissão está em andamento.
+  Completed = "completed", //A submissão foi concluída.
+}
+
+export interface ISurveyResponse extends IFireDoc {
+  question_id: string;
+  answer: string | string[]; // String para resposta única, array de strings para múltipla escolha
+  date: Date;
+}
+
+export interface ISurveySubmission extends IFireDoc {
+  deploymentId?: string;
+  submission_date?: Date | null;
+  status: SurveySubmissionStatus;
+  modified_after_completion: boolean;
+  inviteeId?: string;
+  user_name?: string;
+  responses?: ISurveyResponse[];
+}
+
+export interface ISurveyInvitee extends IFireDoc {
+  name: string;
+  email?: string;
+  phone?: string;
+  responded: boolean;
+}
+
+export interface ISurveyDeployment extends IFireDoc {
+  name: string;
+  description?: string;
+  surveySourceRef?: FirestoreDocumentReference;
+  survey?: ISurvey | null;
+  start_date: Date | null;
+  end_date: Date | null;
+  status: SurveyDeploymentStatus;
+  allow_edit_answers: boolean;
+  allow_partial_submission: boolean;
+  invitees?: ISurveyInvitee[] | null;
+  readonly invitee_count?: number;
+  submissions?: ISurveySubmission[] | null;
+  readonly submission_count?: number;
+  readonly submission_not_started_count?: number;
+  readonly submission_in_progress_count?: number;
+  readonly submission_completed_count?: number;
+}

package/dist/types/evo-task/fb_collections.ts

@@ -0,0 +1,5 @@
+//EVO Task Application Doc
+export const EVO_TASK_APP = "evo-task";
+
+//Tasks collection
+export const TASKS_COLLECTION = "tasks";

package/dist/types/evo-task/index.ts

@@ -0,0 +1,42 @@
+export * from "./fb_collections";
+import { FirestoreDocumentReference, IFireDoc, ITag } from "../shared";
+// ----- TaskTypes
+// Enum for Task Instance Status
+
+export type TaskStatus =
+  | "not_started"
+  | "in_progress"
+  | "completed"
+  | "cancelled"
+  | "on_hold";
+
+export enum ITaskStatus {
+  NotStarted = "not_started",
+  InProgress = "in_progress",
+  Completed = "completed",
+  Cancelled = "cancelled",
+  OnHold = "on_hold",
+}
+
+// Interface for Task Priority
+export type TaskPriority = "low" | "medium" | "high";
+export enum ITaskPriority {
+  Low = "low",
+  Medium = "medium",
+  High = "high",
+}
+
+// Interface for Task Instances (taskInstances)
+export interface ITask extends IFireDoc {
+  title: string; // Title of the task
+  description?: string; // Optional description of the task
+  creatorName: string; // Name of the user who created the task
+  creatorRef?: FirestoreDocumentReference; // reference to the user who created the task
+  startDate: Date; // Start date and time of the task
+  dueDate?: Date; // Optional due date and time of the task
+  status: TaskStatus; // Status of the task
+  priority?: TaskPriority; // Priority of the task (optional)
+  assigneeName?: string; // Name of the assignee (optional)
+  assigneeRef?: FirestoreDocumentReference; // Reference to the assignee (optional)
+  tags?: ITag[];
+}

package/dist/types/evo-tenant/fb_collections.ts

@@ -0,0 +1,2 @@
+//tenants
+export const TENANTS_COLLECTION = "tenants";

package/dist/types/evo-tenant/index.ts

@@ -0,0 +1,27 @@
+export * from "./fb_collections";
+import { FirestoreDocumentReference, IFireDoc } from "../shared";
+
+// ----- TenantTypes
+//TenantTypes
+export type TenantLanguage = "ptBR" | "en";
+export enum ITenantLanguage {
+  ptBR = "ptBR",
+  en = "en",
+}
+
+export type TenantStatus = "draft" | "published" | "archived";
+export enum ITenantStatus {
+  Draft = "draft",
+  Published = "published",
+  Archived = "archived",
+}
+
+export interface ITenant extends IFireDoc {
+  name: string;
+  url_alias: string;
+  date_format: "DD/MM/YYYY hh:mm:ss" | string;
+  language: TenantLanguage | "ptBR";
+  status: TenantStatus | "draft";
+  timezone: "(GMT +00:00) Lisbon" | string;
+  created_by?: FirestoreDocumentReference;
+}

package/dist/types/shared/fb_collections.ts

@@ -0,0 +1,14 @@
+//Applications
+export const APPS_COLLECTION = "apps";
+
+//logins
+export const LOGINS_COLLECTION = "logins";
+
+//users
+export const USERS_COLLECTION = "users";
+
+//config
+export const CONFIG_COLLECTION = "config";
+
+//actions
+export const ACTIONS_COLLECTION = "actions";

package/dist/types/shared/index.ts

@@ -0,0 +1,32 @@
+export * from "./fb_collections";
+
+// ----- FirestoreTypes
+// Definir o tipo unificado para DocumentReference
+export interface FirestoreDocumentReference<> {
+  id: string;
+  path: string;
+  // Outros métodos comuns que você utiliza
+}
+
+export interface IGeoPoint {
+  latitude: number;
+  longitude: number;
+}
+
+//fsTypes
+export interface IFireDoc extends Record<string, unknown> {
+  readonly id: string;
+  readonly ref?: FirestoreDocumentReference;
+  tenant: string;
+  model_ver?: number;
+  created_at?: Date | null;
+  updated_at?: Date | null;
+  deleted_at?: Date | null;
+}
+
+// ----- TagTypes
+export interface ITag {
+  name: string;
+  color?: string;
+  hidden: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "evo360-types",
-  "version": "1.1.16",
+  "version": "1.1.18",
   "description": "HREVO360 Shared Types",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -8,8 +8,8 @@
     "dist"
   ],
   "scripts": {
-    "build-bkp": "tsc && copyfiles -u 1 src/**/*.d.ts dist",
-    "build": "tsc",
+    "build": "tsc && copyfiles -u 1 src/**/*.ts dist",
+    "build-bkp": "tsc",
     "compile": "tsc"
   },
   "homepage": "https://www.darvist.com",