@wisemen/wise-crm-web 2.0.0-alpha.45 → 2.0.0-alpha.46

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.
package/dist/index.d.ts CHANGED
@@ -5,12 +5,15 @@ import { ComputedRef } from 'vue';
5
5
  import { default as default_2 } from 'zod';
6
6
  import { DefineComponent } from 'vue';
7
7
  import { InfiniteQueryOptions } from '@wisemen/vue-core-api-utils';
8
+ import { OffsetPaginationParams } from '@wisemen/vue-core-api-utils';
9
+ import { OffsetPaginationResponse } from '@wisemen/vue-core-api-utils';
8
10
  import { PublicProps } from 'vue';
9
11
  import { Ref } from 'vue';
10
12
  import { RouteLocationNormalized } from 'vue-router';
11
13
  import { RouteRecordRaw } from 'vue-router';
12
14
  import { Temporal } from 'temporal-polyfill';
13
15
  import { UIBadgeProps } from '@wisemen/vue-core-design-system';
16
+ import { UITableColumnSize } from '@wisemen/vue-core-design-system';
14
17
  import { z } from 'zod';
15
18
 
16
19
  declare const __VLS_component: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
@@ -231,6 +234,34 @@ declare interface EntityConfig {
231
234
  type: WiseCrmEntityType;
232
235
  }
233
236
 
237
+ declare type EntityOverviewEntity = 'business' | 'individual';
238
+
239
+ /**
240
+ * Replaces the CRM index and columns of an entity overview with the host app's.
241
+ * The package keeps the search, infinite scroll, error state and the link to the detail view.
242
+ */
243
+ declare interface EntityOverviewOptions<TRow extends EntityOverviewRow> {
244
+ /**
245
+ * Replaces the built-in columns.
246
+ */
247
+ columns: WiseCrmEntityOverviewColumn<TRow>[];
248
+ /**
249
+ * Returns one page of rows. Called instead of the CRM index, also when the search changes.
250
+ * Invalidate the `wiseCrmHostEntityOverview` query key to call it again.
251
+ */
252
+ getData: (params: {
253
+ pagination: OffsetPaginationParams;
254
+ search: string | null;
255
+ }) => Promise<OffsetPaginationResponse<TRow>>;
256
+ }
257
+
258
+ /**
259
+ * The fields the package reads from a host row; the rest is only read by the host's columns.
260
+ */
261
+ declare interface EntityOverviewRow {
262
+ uuid: string;
263
+ }
264
+
234
265
  declare function getConfig(): TenantConfig;
235
266
 
236
267
  declare function getCustomFieldDefinitionForEntity(entityType: WiseCrmEntityType): CustomFieldDefinitionIndex[];
@@ -286,6 +317,10 @@ declare interface InitProps {
286
317
  * Rendered after the built-in badges in the header of the business sidebar.
287
318
  */
288
319
  headerBadges?: WiseCrmBusinessHeaderBadge[];
320
+ /**
321
+ * Replaces the CRM index and columns of the business overview with the host app's.
322
+ */
323
+ overview?: WiseCrmBusinessOverviewOptions;
289
324
  /**
290
325
  * Rendered after the built-in sections in the Overview tab of the business sidebar.
291
326
  */
@@ -319,6 +354,10 @@ declare interface InitProps {
319
354
  * Rendered after the built-in badges in the header of the individual sidebar.
320
355
  */
321
356
  headerBadges?: WiseCrmIndividualHeaderBadge[];
357
+ /**
358
+ * Replaces the CRM index and columns of the individual overview with the host app's.
359
+ */
360
+ overview?: WiseCrmIndividualOverviewOptions;
322
361
  /**
323
362
  * Rendered after the built-in sections in the Overview tab of the individual sidebar.
324
363
  */
@@ -460,6 +499,10 @@ businessUuid: WiseCrmBusinessUuid;
460
499
 
461
500
  export declare type WiseCrmBusinessHeaderBadge = HeaderBadge<WiseCrmBusinessUuid>;
462
501
 
502
+ export declare type WiseCrmBusinessOverviewOptions<TRow extends {
503
+ uuid: WiseCrmBusinessUuid;
504
+ } = any> = EntityOverviewOptions<TRow>;
505
+
463
506
  export declare const WiseCrmBusinessTable: DefineComponent< {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
464
507
 
465
508
  export declare const WiseCrmBusinessUpdateCard: DefineComponent< {
@@ -517,6 +560,29 @@ externalAttachments: PublicFileReference[];
517
560
 
518
561
  export declare type WiseCrmDealUuid = z.infer<typeof dealUuidSchema>;
519
562
 
563
+ /**
564
+ * The props the package passes to a table column's `component`.
565
+ */
566
+ export declare interface WiseCrmEntityOverviewCellProps<TRow> {
567
+ row: TRow;
568
+ }
569
+
570
+ /**
571
+ * A consumer-provided column of an entity overview.
572
+ */
573
+ export declare interface WiseCrmEntityOverviewColumn<TRow> {
574
+ headerLabel: ComputedRef<string>;
575
+ /**
576
+ * Unique per overview.
577
+ */
578
+ key: string;
579
+ size?: UITableColumnSize;
580
+ /**
581
+ * Rendered inside the cell of each row.
582
+ */
583
+ component: Component<WiseCrmEntityOverviewCellProps<TRow>>;
584
+ }
585
+
520
586
  export declare enum WiseCrmEntityType {
521
587
  INDIVIDUAL = "individual",
522
588
  BUSINESS = "business"
@@ -540,6 +606,10 @@ individualUuid: WiseCrmIndividualUuid;
540
606
 
541
607
  export declare type WiseCrmIndividualHeaderBadge = HeaderBadge<WiseCrmIndividualUuid>;
542
608
 
609
+ export declare type WiseCrmIndividualOverviewOptions<TRow extends {
610
+ uuid: WiseCrmIndividualUuid;
611
+ } = any> = EntityOverviewOptions<TRow>;
612
+
543
613
  export declare const WiseCrmIndividualTable: DefineComponent< {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
544
614
 
545
615
  export declare const WiseCrmIndividualUpdateCard: DefineComponent< {
@@ -2008,6 +2078,12 @@ export declare interface WiseCrmQueryKeys {
2008
2078
  locale: ComputedRef<string>;
2009
2079
  };
2010
2080
  };
2081
+ wiseCrmHostEntityOverview: {
2082
+ params: {
2083
+ entity: ComputedRef<EntityOverviewEntity>;
2084
+ search: ComputedRef<string | null>;
2085
+ };
2086
+ };
2011
2087
  wiseCrmIndividualBillingInformation: {
2012
2088
  params: {
2013
2089
  individualUuid: ComputedRef<WiseCrmIndividualUuid | null>;
package/dist/index.js CHANGED
@@ -1,4 +1,4 @@
1
- import { aD as i, aE as r, aF as C, aG as m, aH as n, Z as d, aI as o, aJ as t, aK as l, aL as u, aM as W, aN as v, d as p, a7 as g, y as B, v as D, aO as I, aP as b, aQ as f } from "./index-DSFHgVvi.js";
1
+ import { aD as i, aE as r, aF as C, aG as m, aH as n, Z as d, aI as o, aJ as t, aK as l, aL as u, aM as W, aN as v, d as p, a7 as g, y as B, v as D, aO as I, aP as b, aQ as f } from "./index-DoUWBza_.js";
2
2
  import "zod";
3
3
  import { bs as c } from "./uuid.util-DUuuAgdg.js";
4
4
  export {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@wisemen/wise-crm-web",
3
3
  "type": "module",
4
- "version": "2.0.0-alpha.45",
4
+ "version": "2.0.0-alpha.46",
5
5
  "private": false,
6
6
  "description": "CRM frontend package with Vue 3 components, composables and types",
7
7
  "author": "Wisemen",