@ibiliaze/global-vars 1.140.0 → 1.141.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -290,6 +290,16 @@ export interface CampaignBase<Id, TDate> {
290
290
  createdAt?: TDate;
291
291
  updatedAt?: TDate;
292
292
  }
293
+ export interface CampaignJobStage {
294
+ sent: number;
295
+ replies: number;
296
+ clicks: number;
297
+ opens: number;
298
+ totalProspects: number;
299
+ }
300
+ export interface CampaignJobStages {
301
+ [jobId: string]: CampaignJobStage;
302
+ }
293
303
  export interface CategoryBase<Id, TDate> {
294
304
  _id?: Id;
295
305
  name: string;
@@ -725,6 +735,28 @@ export interface SaleBase<Id, TDate> {
725
735
  createdAt?: TDate;
726
736
  updatedAt?: TDate;
727
737
  }
738
+ export interface SaleInsightData {
739
+ period: string;
740
+ salesData: {
741
+ [key: string]: number;
742
+ } | null;
743
+ expensesData: {
744
+ [key: string]: number;
745
+ } | null;
746
+ totalSales: number | null;
747
+ totalExpenses: number | null;
748
+ numberOfSalesData: {
749
+ [key: string]: number;
750
+ } | null;
751
+ numberOfExpensesData: {
752
+ [key: string]: number;
753
+ } | null;
754
+ growthData: {
755
+ [key: string]: number;
756
+ } | null;
757
+ numberOfSales: number | null;
758
+ numberOfExpenses: number | null;
759
+ }
728
760
  export interface SectionBase<Id, TDate> {
729
761
  _id?: Id;
730
762
  name: string;
@@ -1,4 +1,4 @@
1
- import type { CampaignBase } from '../inputsDefault';
1
+ import type { CampaignBase, CampaignJobStage } from '../inputsDefault';
2
2
  export declare const campaignRoleDefs: <TId, TDate>() => readonly [{
3
3
  readonly method: "post";
4
4
  readonly path: "/campaign";
@@ -69,13 +69,7 @@ export declare const campaignRoleDefs: <TId, TDate>() => readonly [{
69
69
  readonly role: "getCampaignInsightById";
70
70
  readonly name: "Get campaign insight";
71
71
  readonly response_200: {
72
- stages: ({
73
- sent: number;
74
- replies: number;
75
- clicks: number;
76
- opens: number;
77
- totalProspects: number;
78
- } & {
72
+ stages: (CampaignJobStage & {
79
73
  stageId: string;
80
74
  }[]) | null;
81
75
  };
@@ -50,7 +50,7 @@ export declare const eventRoleDefs: <TId, TDate>() => readonly [{
50
50
  message: string;
51
51
  event: EventBase<TId, TDate>;
52
52
  };
53
- readonly response_400: {
53
+ readonly response_404: {
54
54
  message: string;
55
55
  };
56
56
  readonly response_500: {
@@ -66,6 +66,9 @@ export declare const eventRoleDefs: <TId, TDate>() => readonly [{
66
66
  events: EventBase<TId, TDate>[];
67
67
  count: number;
68
68
  };
69
+ readonly response_404: {
70
+ message: string;
71
+ };
69
72
  readonly response_500: {
70
73
  message: string;
71
74
  error: string;
@@ -34,7 +34,7 @@ const eventRoleDefs = () => {
34
34
  role: 'postEventBookCancel',
35
35
  name: 'Request booking cancel',
36
36
  response_200: {},
37
- response_400: {},
37
+ response_404: {},
38
38
  response_500: {},
39
39
  },
40
40
  {
@@ -43,6 +43,7 @@ const eventRoleDefs = () => {
43
43
  role: 'getEvents',
44
44
  name: 'Get events',
45
45
  response_200: {},
46
+ response_404: {},
46
47
  response_500: {},
47
48
  },
48
49
  {
@@ -3,4 +3,8 @@ export declare const googleRoleDefs: readonly [{
3
3
  readonly path: "/util/google/webhook";
4
4
  readonly role: "postUtilGoogleWebhook";
5
5
  readonly name: "Handle Google webhook";
6
+ readonly response_200: {
7
+ message?: string;
8
+ error?: string;
9
+ };
6
10
  }];
@@ -2,10 +2,12 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.googleRoleDefs = void 0;
4
4
  exports.googleRoleDefs = [
5
+ // POST /util/google/webhook – handle webhook
5
6
  {
6
7
  method: 'post',
7
8
  path: '/util/google/webhook',
8
9
  role: 'postUtilGoogleWebhook',
9
10
  name: 'Handle Google webhook',
11
+ response_200: {},
10
12
  },
11
13
  ];
@@ -1,6 +1,23 @@
1
+ type InfoGeneral = {
2
+ quotesThisMonth: number;
3
+ salesThisMonth: number;
4
+ prospectsThisMonth: number;
5
+ projectsCompletedThisMonth: number;
6
+ };
7
+ type InfoProjects = {
8
+ activeProjectsThisMonth: unknown[];
9
+ };
10
+ type InfoPayload = InfoGeneral | InfoProjects | undefined;
1
11
  export declare const infoRoleDefs: readonly [{
2
12
  readonly method: "get";
3
13
  readonly path: "/util/info/general";
4
14
  readonly role: "getUtilInfoGeneral";
5
15
  readonly name: "Get general util info";
16
+ readonly response_200: {
17
+ info: InfoPayload;
18
+ };
19
+ readonly response_400: {
20
+ message: string;
21
+ };
6
22
  }];
23
+ export {};
@@ -2,10 +2,13 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.infoRoleDefs = void 0;
4
4
  exports.infoRoleDefs = [
5
+ // GET /util/info/general – general util info
5
6
  {
6
7
  method: 'get',
7
8
  path: '/util/info/general',
8
9
  role: 'getUtilInfoGeneral',
9
10
  name: 'Get general util info',
11
+ response_200: {},
12
+ response_400: {},
10
13
  },
11
14
  ];
@@ -1,6 +1,19 @@
1
+ type QuotaLimitRow = {
2
+ schema: string;
3
+ count: number;
4
+ limit: number;
5
+ };
1
6
  export declare const quotaRoleDefs: readonly [{
2
7
  readonly method: "get";
3
8
  readonly path: "/util/quota/limit";
4
9
  readonly role: "getUtilQuotaLimit";
5
10
  readonly name: "Get quota limits";
11
+ readonly response_200: {
12
+ limits: QuotaLimitRow[];
13
+ message: string;
14
+ };
15
+ readonly response_400: {
16
+ message: string;
17
+ };
6
18
  }];
19
+ export {};
@@ -2,10 +2,13 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.quotaRoleDefs = void 0;
4
4
  exports.quotaRoleDefs = [
5
+ // GET /util/quota/limit – quota limits
5
6
  {
6
7
  method: 'get',
7
8
  path: '/util/quota/limit',
8
9
  role: 'getUtilQuotaLimit',
9
10
  name: 'Get quota limits',
11
+ response_200: {},
12
+ response_400: {},
10
13
  },
11
14
  ];
@@ -1,4 +1,4 @@
1
- import type { SaleBase } from '../inputsDefault';
1
+ import type { SaleBase, SaleInsightData } from '../inputsDefault';
2
2
  export declare const saleRoleDefs: <TId, TDate>() => readonly [{
3
3
  readonly method: "post";
4
4
  readonly path: "/sale";
@@ -55,18 +55,7 @@ export declare const saleRoleDefs: <TId, TDate>() => readonly [{
55
55
  readonly path: "/sale/insight/:period/:date";
56
56
  readonly role: "getSaleInsightByPeriodDate";
57
57
  readonly name: "Get sale insights";
58
- readonly response_200: {
59
- period: string;
60
- salesData: number[];
61
- expensesData: number[];
62
- totalSales: number;
63
- totalExpenses: number;
64
- numberOfSalesData: number[];
65
- numberOfExpensesData: number[];
66
- growthData: number[];
67
- numberOfSales: number;
68
- numberOfExpenses: number;
69
- };
58
+ readonly response_200: SaleInsightData;
70
59
  readonly response_400: {
71
60
  message: string;
72
61
  };
@@ -3,4 +3,11 @@ export declare const schemaRoleDefs: readonly [{
3
3
  readonly path: "/util/update-schema";
4
4
  readonly role: "postUtilUpdateSchema";
5
5
  readonly name: "Update schema";
6
+ readonly response_200: {
7
+ message: string;
8
+ };
9
+ readonly response_500: {
10
+ message: string;
11
+ error: string;
12
+ };
6
13
  }];
@@ -2,10 +2,13 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.schemaRoleDefs = void 0;
4
4
  exports.schemaRoleDefs = [
5
+ // POST /util/update-schema – update schema
5
6
  {
6
7
  method: 'post',
7
8
  path: '/util/update-schema',
8
9
  role: 'postUtilUpdateSchema',
9
10
  name: 'Update schema',
11
+ response_200: {},
12
+ response_500: {},
10
13
  },
11
14
  ];
@@ -107,7 +107,7 @@ export declare const staffRoleDefs: <TId, TDate>() => readonly [{
107
107
  readonly role: "getStaffAll";
108
108
  readonly name: "Get all staff";
109
109
  readonly response_200: {
110
- staff: StaffBase<TId, TDate>[];
110
+ staffs: StaffBase<TId, TDate>[];
111
111
  count?: number;
112
112
  };
113
113
  readonly response_500: {
@@ -443,13 +443,7 @@ export declare const apis: <TId, TDate>() => readonly [{
443
443
  readonly role: "getCampaignInsightById";
444
444
  readonly name: "Get campaign insight";
445
445
  readonly response_200: {
446
- stages: ({
447
- sent: number;
448
- replies: number;
449
- clicks: number;
450
- opens: number;
451
- totalProspects: number;
452
- } & {
446
+ stages: (import("./inputsDefault").CampaignJobStage & {
453
447
  stageId: string;
454
448
  }[]) | null;
455
449
  };
@@ -666,7 +660,7 @@ export declare const apis: <TId, TDate>() => readonly [{
666
660
  message: string;
667
661
  event: import("./inputsDefault").EventBase<TId_6, TDate_6>;
668
662
  };
669
- readonly response_400: {
663
+ readonly response_404: {
670
664
  message: string;
671
665
  };
672
666
  readonly response_500: {
@@ -682,6 +676,9 @@ export declare const apis: <TId, TDate>() => readonly [{
682
676
  events: import("./inputsDefault").EventBase<TId_6, TDate_6>[];
683
677
  count: number;
684
678
  };
679
+ readonly response_404: {
680
+ message: string;
681
+ };
685
682
  readonly response_500: {
686
683
  message: string;
687
684
  error: string;
@@ -1836,18 +1833,7 @@ export declare const apis: <TId, TDate>() => readonly [{
1836
1833
  readonly path: "/sale/insight/:period/:date";
1837
1834
  readonly role: "getSaleInsightByPeriodDate";
1838
1835
  readonly name: "Get sale insights";
1839
- readonly response_200: {
1840
- period: string;
1841
- salesData: number[];
1842
- expensesData: number[];
1843
- totalSales: number;
1844
- totalExpenses: number;
1845
- numberOfSalesData: number[];
1846
- numberOfExpensesData: number[];
1847
- growthData: number[];
1848
- numberOfSales: number;
1849
- numberOfExpenses: number;
1850
- };
1836
+ readonly response_200: import("./inputsDefault").SaleInsightData;
1851
1837
  readonly response_400: {
1852
1838
  message: string;
1853
1839
  };
@@ -2494,7 +2480,7 @@ export declare const apis: <TId, TDate>() => readonly [{
2494
2480
  readonly role: "getStaffAll";
2495
2481
  readonly name: "Get all staff";
2496
2482
  readonly response_200: {
2497
- staff: import("./inputsDefault").StaffBase<TId_24, TDate_24>[];
2483
+ staffs: import("./inputsDefault").StaffBase<TId_24, TDate_24>[];
2498
2484
  count?: number;
2499
2485
  };
2500
2486
  readonly response_500: {
@@ -2826,21 +2812,56 @@ export declare const apis: <TId, TDate>() => readonly [{
2826
2812
  readonly path: "/util/google/webhook";
2827
2813
  readonly role: "postUtilGoogleWebhook";
2828
2814
  readonly name: "Handle Google webhook";
2815
+ readonly response_200: {
2816
+ message?: string;
2817
+ error?: string;
2818
+ };
2829
2819
  }, {
2830
2820
  readonly method: "get";
2831
2821
  readonly path: "/util/info/general";
2832
2822
  readonly role: "getUtilInfoGeneral";
2833
2823
  readonly name: "Get general util info";
2824
+ readonly response_200: {
2825
+ info: {
2826
+ quotesThisMonth: number;
2827
+ salesThisMonth: number;
2828
+ prospectsThisMonth: number;
2829
+ projectsCompletedThisMonth: number;
2830
+ } | {
2831
+ activeProjectsThisMonth: unknown[];
2832
+ } | undefined;
2833
+ };
2834
+ readonly response_400: {
2835
+ message: string;
2836
+ };
2834
2837
  }, {
2835
2838
  readonly method: "get";
2836
2839
  readonly path: "/util/quota/limit";
2837
2840
  readonly role: "getUtilQuotaLimit";
2838
2841
  readonly name: "Get quota limits";
2842
+ readonly response_200: {
2843
+ limits: {
2844
+ schema: string;
2845
+ count: number;
2846
+ limit: number;
2847
+ }[];
2848
+ message: string;
2849
+ };
2850
+ readonly response_400: {
2851
+ message: string;
2852
+ };
2839
2853
  }, {
2840
2854
  readonly method: "post";
2841
2855
  readonly path: "/util/update-schema";
2842
2856
  readonly role: "postUtilUpdateSchema";
2843
2857
  readonly name: "Update schema";
2858
+ readonly response_200: {
2859
+ message: string;
2860
+ };
2861
+ readonly response_500: {
2862
+ message: string;
2863
+ error: string;
2864
+ };
2844
2865
  }];
2845
2866
  declare const allApis: readonly [{
2846
2867
  readonly method: "post";
@@ -3261,13 +3282,7 @@ declare const allApis: readonly [{
3261
3282
  readonly role: "getCampaignInsightById";
3262
3283
  readonly name: "Get campaign insight";
3263
3284
  readonly response_200: {
3264
- stages: ({
3265
- sent: number;
3266
- replies: number;
3267
- clicks: number;
3268
- opens: number;
3269
- totalProspects: number;
3270
- } & {
3285
+ stages: (import("./inputsDefault").CampaignJobStage & {
3271
3286
  stageId: string;
3272
3287
  }[]) | null;
3273
3288
  };
@@ -3484,7 +3499,7 @@ declare const allApis: readonly [{
3484
3499
  message: string;
3485
3500
  event: import("./inputsDefault").EventBase<TId_5, TDate_5>;
3486
3501
  };
3487
- readonly response_400: {
3502
+ readonly response_404: {
3488
3503
  message: string;
3489
3504
  };
3490
3505
  readonly response_500: {
@@ -3500,6 +3515,9 @@ declare const allApis: readonly [{
3500
3515
  events: import("./inputsDefault").EventBase<TId_5, TDate_5>[];
3501
3516
  count: number;
3502
3517
  };
3518
+ readonly response_404: {
3519
+ message: string;
3520
+ };
3503
3521
  readonly response_500: {
3504
3522
  message: string;
3505
3523
  error: string;
@@ -4654,18 +4672,7 @@ declare const allApis: readonly [{
4654
4672
  readonly path: "/sale/insight/:period/:date";
4655
4673
  readonly role: "getSaleInsightByPeriodDate";
4656
4674
  readonly name: "Get sale insights";
4657
- readonly response_200: {
4658
- period: string;
4659
- salesData: number[];
4660
- expensesData: number[];
4661
- totalSales: number;
4662
- totalExpenses: number;
4663
- numberOfSalesData: number[];
4664
- numberOfExpensesData: number[];
4665
- growthData: number[];
4666
- numberOfSales: number;
4667
- numberOfExpenses: number;
4668
- };
4675
+ readonly response_200: import("./inputsDefault").SaleInsightData;
4669
4676
  readonly response_400: {
4670
4677
  message: string;
4671
4678
  };
@@ -5312,7 +5319,7 @@ declare const allApis: readonly [{
5312
5319
  readonly role: "getStaffAll";
5313
5320
  readonly name: "Get all staff";
5314
5321
  readonly response_200: {
5315
- staff: import("./inputsDefault").StaffBase<TId_23, TDate_23>[];
5322
+ staffs: import("./inputsDefault").StaffBase<TId_23, TDate_23>[];
5316
5323
  count?: number;
5317
5324
  };
5318
5325
  readonly response_500: {
@@ -5644,21 +5651,56 @@ declare const allApis: readonly [{
5644
5651
  readonly path: "/util/google/webhook";
5645
5652
  readonly role: "postUtilGoogleWebhook";
5646
5653
  readonly name: "Handle Google webhook";
5654
+ readonly response_200: {
5655
+ message?: string;
5656
+ error?: string;
5657
+ };
5647
5658
  }, {
5648
5659
  readonly method: "get";
5649
5660
  readonly path: "/util/info/general";
5650
5661
  readonly role: "getUtilInfoGeneral";
5651
5662
  readonly name: "Get general util info";
5663
+ readonly response_200: {
5664
+ info: {
5665
+ quotesThisMonth: number;
5666
+ salesThisMonth: number;
5667
+ prospectsThisMonth: number;
5668
+ projectsCompletedThisMonth: number;
5669
+ } | {
5670
+ activeProjectsThisMonth: unknown[];
5671
+ } | undefined;
5672
+ };
5673
+ readonly response_400: {
5674
+ message: string;
5675
+ };
5652
5676
  }, {
5653
5677
  readonly method: "get";
5654
5678
  readonly path: "/util/quota/limit";
5655
5679
  readonly role: "getUtilQuotaLimit";
5656
5680
  readonly name: "Get quota limits";
5681
+ readonly response_200: {
5682
+ limits: {
5683
+ schema: string;
5684
+ count: number;
5685
+ limit: number;
5686
+ }[];
5687
+ message: string;
5688
+ };
5689
+ readonly response_400: {
5690
+ message: string;
5691
+ };
5657
5692
  }, {
5658
5693
  readonly method: "post";
5659
5694
  readonly path: "/util/update-schema";
5660
5695
  readonly role: "postUtilUpdateSchema";
5661
5696
  readonly name: "Update schema";
5697
+ readonly response_200: {
5698
+ message: string;
5699
+ };
5700
+ readonly response_500: {
5701
+ message: string;
5702
+ error: string;
5703
+ };
5662
5704
  }];
5663
5705
  export type RoleName = (typeof allApis)[number]['role'];
5664
5706
  export declare const roles: Map<Partial<Record<MethodKey, string>>, {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ibiliaze/global-vars",
3
- "version": "1.140.0",
3
+ "version": "1.141.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "sideEffects": false,
@@ -22,7 +22,7 @@
22
22
  "scripts": {
23
23
  "build": "tsc",
24
24
  "pub": "npm publish --access public",
25
- "git": "git add .; git commit -m 'changes'; git tag -a v1.140.0 -m 'v1.140.0'; git push origin v1.140.0; git push",
25
+ "git": "git add .; git commit -m 'changes'; git tag -a v1.141.0 -m 'v1.141.0'; git push origin v1.141.0; git push",
26
26
  "push": "npm run build; npm run git; npm run pub"
27
27
  },
28
28
  "author": "Ibi Hasanli",