@iservice365/layer-common 0.0.6 → 0.2.0

package/types/address.d.ts

@@ -0,0 +1,13 @@
+declare type TAddress = {
+  _id?: string;
+  type: string;
+  user?: string;
+  org?: string;
+  country: string;
+  address: string;
+  continuedAddress?: string;
+  city: string;
+  province: string;
+  postalCode: string;
+  taxId: string;
+};

package/types/customer.d.ts

@@ -0,0 +1,15 @@
+declare type TCustomer = {
+  _id: string;
+  name: string;
+  orgId: string;
+  customerOrgId: string;
+  createdAt: string;
+  updatedAt: string;
+  siteName?: string;
+  siteDescription?: string;
+};
+
+declare type TCustomerCreate = Pick<
+  TCustomer,
+  "name" | "orgId" | "siteName" | "siteDescription"
+>;

package/types/feedback.d.ts

@@ -0,0 +1,63 @@
+declare type TFeedback = {
+  _id: string;
+  attachments?: string[];
+  category: string;
+  subject: string;
+  location: string;
+  description: string;
+  createdBy: string;
+  createdAt?: string;
+  updatedAt?: string;
+  status?: string;
+  metadata?: TFeedbackMetadata;
+  createdByName?: string;
+  organization?: string;
+  site?: string;
+  signature?: string;
+  name?: string;
+  highPriority?: boolean;
+  serviceProvider?: string;
+  assignee?: string;
+};
+
+declare type TFeedbackMetadata = {
+  serviceProvider: string;
+  assignee: string;
+  organization: string;
+  site: string;
+  name: string;
+  signature: string;
+  attachments: string;
+  completedAt: string;
+};
+
+declare type TFeedbackCreate = Pick<
+  TFeedback,
+  | "subject"
+  | "category"
+  | "location"
+  | "description"
+  | "attachments"
+  | "highPriority"
+  | "serviceProvider"
+  | "assignee"
+  | "organization"
+  | "site"
+>;
+
+declare type TFeedbackUpdate = Pick<
+  TFeedback,
+  "subject" | "category" | "location" | "description" | "attachments"
+>;
+
+declare type TFeedbackUpdate = Pick<
+  TFeedback,
+  "attachments" | "category" | "subject" | "location" | "description"
+>;
+
+declare type TFeedbackStatusComplete = Pick<
+  TFeedback,
+  "status" | "name" | "signature" | "attachments"
+>;
+
+declare type TFeedbackUpdateStatus = Pick<TFeedback, "status">;

package/types/local.d.ts

@@ -1,22 +1,3 @@
-declare type TUser = {
-  _id: string;
-  email: string;
-  password: string;
-  firstName: string;
-  middleName?: string;
-  lastName: string;
-  suffix?: string;
-  birthMonth?: string;
-  birthDate?: string;
-  birthYear?: string;
-  profile?: string;
-  defaultOrg?: string;
-  createdAt: string;
-  updatedAt: string;
-  status: string;
-  deletedAt: string;
-};
-
 declare type TToken = {
   accessToken: string;
   refreshToken: string;
@@ -32,23 +13,9 @@ declare type TNavigationItem = {
   title: string;
   icon?: string;
   route?: TNavigationRoute;
-  link?: string;
   children?: TNavigationItem[];
 };
 
-declare type TOrg = {
-  _id?: string;
-  name: string;
-  email: string;
-  busInst: string;
-  owner: string;
-  type: string;
-  createdAt?: string;
-  updatedAt?: string;
-  status?: string;
-  deletedAt?: string;
-};
-
 declare type TKeyValuePair<
   K extends string | number | symbol = string,
   V = string | number | object | Array | TKeyValuePair
@@ -56,9 +23,50 @@ declare type TKeyValuePair<
   [key in K]: V;
 };
 
-declare type TOrgsAsOption = {
-  value: string;
-  title: string;
-  subtitle?: string;
-  email?: string;
+declare type TFeedbackPaginatedResponse = {
+  items: TFeedback[];
+  totalItems: number;
+  page: number;
+  pages: number;
+  pageRange: string;
+};
+
+declare type TCustomerPaginatedResponse = {
+  items: TCustomer[];
+  totalItems: number;
+  page: number;
+  pages: number;
+  pageRange: string;
+};
+
+declare type TSitePaginatedResponse = {
+  items: TSite[];
+  totalItems: number;
+  page: number;
+  pages: number;
+  pageRange: string;
+};
+
+declare type TServiceProviderPaginatedResponse = {
+  items: TServiceProvider[];
+  totalItems: number;
+  page: number;
+  pages: number;
+  pageRange: string;
+};
+
+declare type TWorkOrderPaginatedResponse = {
+  items: TWorkOrder[];
+  totalItems: number;
+  page: number;
+  pages: number;
+  pageRange: string;
+};
+
+declare type TMemberPaginatedResponse = {
+  items: TMember[];
+  totalItems: number;
+  page: number;
+  pages: number;
+  pageRange: string;
 };

package/types/member.d.ts

@@ -0,0 +1,21 @@
+declare type TMember = {
+  _id: string;
+  org?: string;
+  orgName?: string;
+  roleName?: string;
+  name: string;
+  user: string;
+  role: string;
+  type: string;
+  customerOrgId?: string;
+  customerSiteId?: string;
+  status?: string;
+  createdAt?: string;
+  updatedAt?: string;
+  deletedAt?: string;
+};
+
+declare type TMemberUserCreateVerification = Pick<
+  TUser,
+  "name" | "password" | "type"
+>;

package/types/org.d.ts

@@ -0,0 +1,13 @@
+declare type TOrg = {
+  _id?: string;
+  name: string;
+  email: string;
+  contact: string;
+  busInst: string;
+  type: string;
+  createdAt?: string;
+  updatedAt?: string;
+  status?: string;
+  deletedAt?: string;
+  nature?: string;
+};

package/types/permission.d.ts

@@ -15,6 +15,7 @@ declare type TPermissions = {
 
 declare type TRole = {
   _id?: string;
+  default?: boolean;
   name: string;
   description: string;
   permissions: string[];

package/types/price.d.ts

@@ -0,0 +1,17 @@
+declare type TPriceType =
+  | "monthly-subscription"
+  | "yearly-subscription"
+  | "one-time-payment"
+  | "other";
+
+declare type TPrice = {
+  _id?: string;
+  value: number;
+  saleValue?: number;
+  saleExpiry?: Date;
+  name: string;
+  type?: TPriceType;
+  createdAt?: Date;
+  updatedAt?: Date;
+  deletedAt?: Date;
+};

package/types/promo-code.d.ts

@@ -0,0 +1,19 @@
+declare type TPromoTier = {
+  min: number;
+  max: number;
+  price: number;
+};
+
+declare type TPromoCode = {
+  _id?: ObjectId;
+  code: string;
+  description?: string;
+  type: "tiered" | "fixed";
+  tiers?: TPromoTier[];
+  fixed_rate?: number;
+  appliesTo?: string; // "subscription" | "order"
+  createdAt?: string; // Date of creation
+  expiresAt?: string; // Optional expiry
+  assignedTo?: string | ObjectId; // Store the only ape who used it
+  status?: "active" | "expired" | "disabled";
+};

package/types/service-provider.d.ts

@@ -0,0 +1,15 @@
+declare type TServiceProvider = {
+  _id?: string;
+  name: string;
+  orgId: string;
+  customerOrgId: string;
+  siteId: string;
+  serviceProviderOrgId: string;
+  type: string;
+  nature: string;
+};
+
+declare type TServiceProviderName = {
+  _id: string;
+  name: string;
+};

package/types/site.d.ts

@@ -0,0 +1,13 @@
+declare type TSite = {
+  _id?: string;
+  name: string;
+  description: string;
+  orgId: string;
+  customerOrgId: string;
+  customerSiteId: string;
+  createdAt?: string;
+  updatedAt?: string;
+  deletedAt?: string;
+};
+
+declare type TSiteCreate = Pick<TSite, "name" | "description" | "orgId">;

package/types/subscription.d.ts

@@ -0,0 +1,23 @@
+declare type TSubscription = {
+  _id?: string;
+  user?: string;
+  org?: string;
+  customerId: string;
+  paymentMethodId: string;
+  amount: number;
+  description?: string;
+  currency: string;
+  promoCode?: string;
+  type: string;
+  paidSeats?: number;
+  currentSeats?: number;
+  maxSeats?: number;
+  status?: string;
+  billingCycle: "monthly" | "yearly";
+  nextBillingDate?: string;
+  lastPaymentStatus?: string;
+  failedAttempts?: number;
+  createdAt?: string;
+  updatedAt?: string;
+  deletedAt?: string;
+};

package/types/user.d.ts

@@ -0,0 +1,19 @@
+declare type TUser = {
+  _id: string;
+  email: string;
+  password: string;
+  name: string;
+  suffix?: string;
+  month?: string;
+  day?: number;
+  year?: number;
+  profile?: string;
+  defaultOrg: string;
+  createdAt: string;
+  updatedAt: string;
+  status: string;
+  deletedAt: string;
+  gender: string;
+  contact: string;
+  type?: string;
+};

package/types/verification.d.ts

@@ -0,0 +1,20 @@
+declare type TVerificationMetadata = {
+  app?: string;
+  role?: string;
+};
+
+declare type TMiniVerification = Pick<
+  TVerification,
+  "createdAt" | "email" | "_id"
+>;
+
+declare type TVerification = {
+  _id: string;
+  type: string;
+  email: string;
+  metadata?: TVerificationMetadata;
+  status?: string;
+  createdAt: string;
+  updatedAt?: string | null;
+  expireAt: string;
+};

package/types/work-order.d.ts

@@ -0,0 +1,40 @@
+declare type TWorkOrder = {
+  _id: string;
+  subject: string;
+  description: string;
+  createdBy: string;
+  createdByName?: string;
+  service: string;
+  provider: string;
+  assignee?: string;
+  organization: string;
+  site: string;
+  location: string;
+  attachments?: string[];
+  feedback?: string;
+  status?: string;
+  createdAt?: string;
+  updatedAt?: string;
+  highPriority?: boolean;
+  block: string;
+  level: string;
+  unit: string;
+};
+
+declare type TWorkOrderCreate = Pick<
+  TWorkOrder,
+  | "subject"
+  | "description"
+  | "attachments"
+  | "location"
+  | "organization"
+  | "site"
+  | "block"
+  | "level"
+  | "unit"
+  | "highPriority"
+  | "assignee"
+  | "feedback"
+  | "category"
+  | "serviceProvider"
+>;