neo-cmp-cli 1.13.16 → 1.13.18

package/template/neo-pipeline-cmps/src/utils/common.ts

@@ -0,0 +1,229 @@
+/**
+ * Shared pure utility methods across multiple components (filter where, stage name, amount display, NeoBI request body, etc.)
+ */
+
+export interface PropsContext {
+  data?: {
+    __NeoCurrentUser?: {
+      id?: number;
+      name?: string | null;
+    };
+  };
+}
+/** Convert filter option to finite number, returns null if invalid (consistent with filter2chartFilter, etc.) */
+export function toFiniteNumber(v: unknown): number | null {
+  if (v == null || v === '') return null;
+  if (typeof v === 'number' && Number.isFinite(v)) return v;
+  const n = Number(v);
+  return Number.isFinite(n) ? n : null;
+}
+
+/** Time range start/end: returns closed interval [start, end] when both are valid numbers (millisecond timestamps, consistent with FilterBar) */
+export function closeRangeFromFilter(
+  range: unknown,
+): { start: number; end: number } | null {
+  if (!range || typeof range !== 'object') return null;
+  const r = range as { start?: unknown; end?: unknown };
+  const start = toFiniteNumber(r.start);
+  const end = toFiniteNumber(r.end);
+  if (start == null || end == null) return null;
+  return { start, end };
+}
+
+/** opportunityOwner -> user id list for where clause (string to avoid big integer precision loss) */
+export function normalizeOwnerIdsForWhere(owner: unknown): string[] {
+  if (owner == null || owner === '') return [];
+  const raw = Array.isArray(owner) ? owner : [owner];
+  const out: string[] = [];
+  for (const item of raw) {
+    if (item == null || item === '') continue;
+    const s = String(item).trim().replace(/,/g, '');
+    if (s === '' || !/^-?\d+$/.test(s)) continue;
+    out.push(s);
+  }
+  return out;
+}
+
+export function entityTypeIdForWhere(businessType: unknown): string | null {
+  if (businessType == null || businessType === '') return null;
+  const s = String(businessType).trim();
+  if (s === '' || !/^-?\d+$/.test(s.replace(/,/g, ''))) return null;
+  return s.replace(/,/g, '');
+}
+
+/** Extract the segment after the first '.' from stage display name, used for matching customItem1__c, etc. */
+export function extractStageKeyFromStageName(stageName: string): string {
+  const s = String(stageName ?? '').trim();
+  const i = s.indexOf('.');
+  if (i < 0) return s;
+  return s.slice(i + 1).trim();
+}
+
+/** Opportunity rows, etc.: returns 0 when empty or unparseable */
+export function parseNumberOrZero(raw: unknown): number {
+  if (raw === null || raw === undefined || raw === '') return 0;
+  const n =
+    typeof raw === 'number'
+      ? raw
+      : parseFloat(String(raw).replace(/,/g, '').trim());
+  return Number.isFinite(n) ? n : 0;
+}
+
+/** Threshold config, etc.: returns NaN when empty or unparseable */
+export function parseNumberOrNaN(raw: unknown): number {
+  if (raw === null || raw === undefined || raw === '') return NaN;
+  const n =
+    typeof raw === 'number'
+      ? raw
+      : parseFloat(String(raw).replace(/,/g, '').trim());
+  return Number.isFinite(n) ? n : NaN;
+}
+
+/** Display amount: $ prefix; uses K / M / B / T abbreviation when >= 1e3 */
+export function formatAmountDisplay(n: number): string {
+  if (!Number.isFinite(n)) return '-';
+  const sign = n < 0 ? '-' : '';
+  const abs = Math.abs(n);
+  if (abs === 0) return '$0';
+
+  if (abs < 1000) {
+    const part = Number.isInteger(abs)
+      ? abs.toLocaleString('en-US')
+      : abs.toLocaleString('en-US', {
+          minimumFractionDigits: 0,
+          maximumFractionDigits: 2,
+        });
+    return `${sign}$${part}`;
+  }
+
+  const tier = Math.min(Math.floor(Math.log10(abs) / 3), 4);
+  const suffixes = ['', 'K', 'M', 'B', 'T'] as const;
+  const suffix = suffixes[tier];
+  const divisor = 1000 ** tier;
+  const scaled = abs / divisor;
+
+  let body: string;
+  if (scaled >= 100) body = String(Math.round(scaled));
+  else if (scaled >= 10) body = scaled.toFixed(1).replace(/\.0$/, '');
+  else body = scaled.toFixed(2).replace(/\.?0+$/, '');
+
+  return `${sign}$${body}${suffix}`;
+}
+
+/** queryDataTask: x-www-form-urlencoded form body (filter passed as JSON string) */
+export function buildQueryDataTaskFormBody(params: {
+  viewId: string;
+  userId: string | number;
+  type: string;
+  filter: Record<string, unknown>;
+}): string {
+  const form = new URLSearchParams();
+  form.set('viewId', String(params.viewId));
+  form.set('userId', String(params.userId));
+  form.set('type', params.type);
+  form.set('filter', JSON.stringify(params.filter));
+  return form.toString();
+}
+
+/** Owner multi-select default: current logged-in user id (consistent with __NeoCurrentUser) */
+export function getDefaultOpportunityOwnerIds(
+  props: PropsContext,
+): (number | string)[] {
+  // return [1246045]; // Default user changed to (Alice)
+  const curUser = props.data?.__NeoCurrentUser;
+  if (
+    curUser?.id == null ||
+    curUser.name == null ||
+    String(curUser.name).trim() === ''
+  ) {
+    return [];
+  }
+  return [curUser.id];
+}
+
+/** Owner multi-select default: current logged-in user id (consistent with __NeoCurrentUser) */
+export function getDefaultFilterWhereByProps(props: any = {}): any {
+  let userId = 1246045; // Default user (Alice)
+  const curUser = props.data?.__NeoCurrentUser;
+  if (curUser?.id) {
+    userId = curUser.id;
+  }
+  const defaultFilter = {
+    relation: '1 and 2 and 3',
+    filter: [
+      {
+        modelKey: 'opportunity',
+        serialNo: 1,
+        fieldKey: 'closeDate',
+        type: 'date',
+        entityOnlyFilter: 0,
+        timeType: 'relative',
+        operate: 'eq',
+        value: [
+          {
+            val: 401,
+            baseType: 'system',
+          },
+        ],
+        seq: 1,
+      },
+      {
+        modelKey: 'opportunity',
+        serialNo: 1,
+        fieldKey: 'ownerId',
+        type: 'refer',
+        referKey: 'user',
+        optionType: 'user',
+        entityOnlyFilter: 0,
+        operate: 'in',
+        value: [
+          {
+            val: userId,
+            sub: false,
+            source: 'internal',
+            specialType: 0,
+          },
+        ],
+        includeNullValue: 0,
+        seq: 2,
+      },
+      {
+        modelKey: 'opportunity',
+        serialNo: 1,
+        fieldKey: 'entityType',
+        type: 'refer',
+        entityOnlyFilter: 0,
+        operate: 'in',
+        value: [
+          {
+            val: 8150459,
+          },
+        ],
+        seq: 3,
+      },
+    ],
+  };
+  return defaultFilter;
+}
+
+export function getDefaultFilterByProps(props: any = {}): any {
+  let userId = 1246045; // Default user (Alice)
+  const curUser = props.data?.__NeoCurrentUser;
+  if (curUser?.id) {
+    userId = curUser.id;
+  }
+  const defaultFilter = {
+    closeDate: 401,
+    closeDateCustomRange: {
+      start: 1775059200000,
+      end: 1782835199999,
+    },
+    opportunityOwner: [userId],
+    businessType: 8150459,
+    businessTypeLabel: 'New Business',
+    businessTypeApiKey: 'defaultBusiType_1',
+    changesSince: 'Start of the Period',
+    changesSinceCustomTime: 1775059200000,
+  };
+  return defaultFilter;
+}

package/template/neo-pipeline-cmps/src/utils/filter2chartFilter.ts

@@ -0,0 +1,266 @@
+/**
+ * Filter condition formatting
+ * Formats the filter conditions from the filter bar component into the format required by the API.
+ * 
+ * Data conversion rules:
+1. closeDate
+
+Non-custom: Use toFiniteNumber to convert the option value (e.g. 201 / "201") to a number, timeType: 'relative', value: [{ val, baseType: 'system' }].
+custom: Read closeDateCustomRange.start / end; when both are valid numbers, timeType: 'absolute', value is two { val, close: 1 } entries; if range is missing, this item is not generated.
+
+2. opportunityOwner -> ownerId
+Supports single value (string/number) or multi-select array; toFiniteNumber each item, invalid items are discarded. When at least one valid id exists, generates a refer condition (referKey: 'user', optionType: 'user', operate: 'in', includeNullValue: 0).
+value is an array, each user is { val, sub: false, source: 'internal', specialType: 0 }.
+
+3. businessType -> entityType
+When a value exists and can be converted to a number, generates refer + value: [{ val }]; empty string does not pass entityType.
+
+4. relation
+Concatenated as "1 and 2 and 3" based on the seq of final items; when there are no conditions, it is '', filter is [].
+
+ * 
+ * Example:
+ * Filter conditions from the filter bar component:
+{
+    "closeDate": "custom",
+    "closeDateCustomRange": {
+        "start": 1775577600000,
+        "end": 1777996799999
+    },
+    "opportunityOwner": ["1255807", 2088134315786370],
+    "businessType": "8150459",
+    "changesSince": "Custom",
+    "changesSinceCustomTime": 1776268800000
+}
+
+Format required by the API:
+{
+    "relation": "1 and 2 and 3",
+    "filter": [
+      {
+        "seq": 1,
+        "fieldKey": "closeDate",
+        "modelKey": "opportunity",
+        "serialNo": 1,
+        "type": "date",
+        "entityOnlyFilter": 0,
+        "timeType": "relative",
+        "operate": "eq",
+        "value": [
+          {
+            "val": 101,
+            "baseType": "system"
+          }
+        ]
+      },
+      {
+        "seq": 2,
+        "fieldKey": "ownerId",
+        "modelKey": "opportunity",
+        "serialNo": 1,
+        "type": "refer",
+        "referKey": "user",
+        "optionType": "user",
+        "entityOnlyFilter": 0,
+        "operate": "in",
+        "value": [
+          {
+            "val": 1255807,
+            "sub": false,
+            "source": "internal",
+            "specialType": 0
+          },
+          {
+            "val": 2088134315786370,
+            "sub": false,
+            "source": "internal",
+            "specialType": 0
+          }
+        ],
+        "includeNullValue": 0
+      },
+      {
+        "seq": 3,
+        "fieldKey": "entityType",
+        "modelKey": "opportunity",
+        "serialNo": 1,
+        "type": "refer",
+        "entityOnlyFilter": 0,
+        "operate": "in",
+        "value": [
+          {
+            "val": 8150459
+          }
+        ]
+      }
+    ]
+  }
+
+  If closeDate is custom, the closeDateCustomRange needs to be formatted into the API-required format
+  {
+        "seq": 3,
+        "fieldKey": "closeDate",
+        "modelKey": "opportunity",
+        "serialNo": 1,
+        "type": "date",
+        "entityOnlyFilter": 0,
+        "timeType": "absolute",
+        "operate": "eq",
+        "value": [
+            {
+              "val": 1777305600000,
+              "close": 1
+            },
+            {
+              "val": 1780156799999,
+              "close": 1
+            }
+          ]
+      }
+*/
+
+import { toFiniteNumber } from './common';
+
+const MODEL_KEY = 'opportunity';
+const SERIAL_NO = 1;
+
+type ChartFilterItem = {
+  seq: number;
+  fieldKey: string;
+  modelKey: string;
+  serialNo: number;
+  type: string;
+  entityOnlyFilter: number;
+  operate: string;
+  value: unknown[];
+  timeType?: string;
+  referKey?: string;
+  optionType?: string;
+  includeNullValue?: number;
+};
+
+export interface ChartFilterPayload {
+  relation: string;
+  filter: ChartFilterItem[];
+}
+
+function closeDateChunk(
+  filter: Record<string, unknown>,
+): Omit<ChartFilterItem, 'seq'> | null {
+  const raw = filter.closeDate;
+  const isCustom = String(raw ?? '').toLowerCase() === 'custom';
+
+  if (isCustom) {
+    const range = filter.closeDateCustomRange as
+      | { start?: unknown; end?: unknown }
+      | undefined;
+    const start = toFiniteNumber(range?.start);
+    const end = toFiniteNumber(range?.end);
+    if (start == null || end == null) return null;
+    return {
+      modelKey: MODEL_KEY,
+      serialNo: SERIAL_NO,
+      fieldKey: 'closeDate',
+      type: 'date',
+      entityOnlyFilter: 0,
+      timeType: 'absolute',
+      operate: 'eq',
+      value: [
+        { val: start, close: 1 },
+        { val: end, close: 1 },
+      ],
+    };
+  }
+
+  const n = toFiniteNumber(raw);
+  if (n == null) return null;
+  return {
+    modelKey: MODEL_KEY,
+    serialNo: SERIAL_NO,
+    fieldKey: 'closeDate',
+    type: 'date',
+    entityOnlyFilter: 0,
+    timeType: 'relative',
+    operate: 'eq',
+    value: [{ val: n, baseType: 'system' }],
+  };
+}
+
+const ownerUserValueItem = (val: number) => ({
+  val,
+  sub: false as const,
+  source: 'internal' as const,
+  specialType: 0,
+});
+
+/** Parse valid user id list from opportunityOwner (single value or id array) */
+function normalizeOwnerIds(owner: unknown): number[] {
+  if (owner == null || owner === '') return [];
+  const raw = Array.isArray(owner) ? owner : [owner];
+  const out: number[] = [];
+  for (const item of raw) {
+    if (item == null || item === '') continue;
+    const n = toFiniteNumber(item);
+    if (n != null) out.push(n);
+  }
+  return out;
+}
+
+function ownerChunk(
+  filter: Record<string, unknown>,
+): Omit<ChartFilterItem, 'seq'> | null {
+  const ids = normalizeOwnerIds(filter.opportunityOwner);
+  if (ids.length === 0) return null;
+  return {
+    modelKey: MODEL_KEY,
+    serialNo: SERIAL_NO,
+    fieldKey: 'ownerId',
+    type: 'refer',
+    referKey: 'user',
+    optionType: 'user',
+    entityOnlyFilter: 0,
+    operate: 'in',
+    value: ids.map(ownerUserValueItem),
+    includeNullValue: 0,
+  };
+}
+
+function entityTypeChunk(
+  filter: Record<string, unknown>,
+): Omit<ChartFilterItem, 'seq'> | null {
+  const busi = filter.businessType;
+  if (busi == null || busi === '') return null;
+  const val = toFiniteNumber(busi);
+  if (val == null) return null;
+  return {
+    modelKey: MODEL_KEY,
+    serialNo: SERIAL_NO,
+    fieldKey: 'entityType',
+    type: 'refer',
+    entityOnlyFilter: 0,
+    operate: 'in',
+    value: [{ val }],
+  };
+}
+
+/**
+ * Convert filter bar payload to chart/API filter structure; only maps closeDate, ownerId, entityType.
+ */
+export const filter2chartFilter = (filter: any): ChartFilterPayload => {
+  const f = filter && typeof filter === 'object' ? filter : {};
+  const parts = [closeDateChunk(f), ownerChunk(f), entityTypeChunk(f)].filter(
+    Boolean,
+  ) as Omit<ChartFilterItem, 'seq'>[];
+
+  const filterOut: ChartFilterItem[] = parts.map((p, i) => ({
+    ...p,
+    seq: i + 1,
+  }));
+
+  const relation =
+    filterOut.length === 0
+      ? ''
+      : filterOut.map((x) => String(x.seq)).join(' and ');
+
+  return { relation, filter: filterOut };
+};

package/template/neo-pipeline-cmps/src/utils/filterBar.ts

@@ -0,0 +1,140 @@
+/**
+ * Filter bar filterBar specific utility methods
+ */
+import moment from 'moment';
+
+export interface FilterOption {
+  value: string | number;
+  label: string;
+  /** apiKey on API items like business type, used to align with defaultBusiType config */
+  apiKey?: string;
+}
+
+/** Custom date range: start/end are Unix millisecond timestamps (day is local startOfDay / endOfDay) */
+export interface TimestampRange {
+  start?: number;
+  end?: number;
+}
+
+/** Normalize dropdown item value / label */
+export function normalizeOptions(list?: FilterOption[]): FilterOption[] {
+  if (!Array.isArray(list) || list.length === 0) return [];
+  return list.map((o) => ({
+    value: o.value,
+    label: String(o.label ?? o.value),
+  }));
+}
+
+/** Changes Since dropdown default options */
+export function defaultChangesSinceOptions(): FilterOption[] {
+  return [
+    { value: 'Start of the Period', label: 'Start of the Period' },
+    { value: 'Custom', label: 'Custom' },
+  ];
+}
+
+/** Convert two selected days from RangePicker to start/end timestamps (inclusive of the day) */
+export function momentRangeToTimestamps(dates: any): TimestampRange | null {
+  const m0 = dates?.[0];
+  const m1 = dates?.[1];
+  if (!m0 || !m1) return null;
+  return {
+    start: moment(m0).startOf('day').valueOf(),
+    end: moment(m1).endOf('day').valueOf(),
+  };
+}
+
+/**
+ * Convert Close Date relative period code to local calendar day start/end timestamps (start at midnight, end at 23:59:59.999).
+ * Convention: hundreds digit 2=this week (ISO week), 3=this month, 4=this quarter (e.g. 201/301/401 and other codes in the same range).
+ */
+export function relativeCloseDateRangeFromCode(
+  encoded: number | string,
+): TimestampRange | null {
+  const curEncoded = typeof encoded === 'number' ? encoded : Number(encoded);
+  if (!Number.isFinite(curEncoded)) return null;
+  const now = moment();
+  if (curEncoded === 201) {
+    // This Week
+    return {
+      start: now.clone().startOf('isoWeek').startOf('day').valueOf(),
+      end: now.clone().endOf('isoWeek').endOf('day').valueOf(),
+    };
+  }
+  if (curEncoded === 301) {
+    // This Month (start is the second day of the month at midnight)
+    return {
+      start: now
+        .clone()
+        .startOf('month')
+        .startOf('day')
+        .add(1, 'day')
+        .valueOf(),
+      end: now.clone().endOf('month').endOf('day').valueOf(),
+    };
+  }
+  if (curEncoded === 401) {
+    // This Quarter (start is the second day of the quarter at midnight)
+    return {
+      start: now
+        .clone()
+        .startOf('quarter')
+        .startOf('day')
+        .add(1, 'day')
+        .valueOf(),
+      end: now.clone().endOf('quarter').endOf('day').valueOf(),
+    };
+  }
+  return null;
+}
+
+/** Convert user entity query results to owner dropdown options (deduplicated by id) */
+export function parseUserRecordsToOwnerOptions(records: any): FilterOption[] {
+  const arr = Array.isArray(records) ? records : [];
+  const seen = new Set<string>();
+  const out: FilterOption[] = [];
+  for (const row of arr) {
+    if (row == null || typeof row !== 'object') continue;
+    const id = row.id;
+    const name = row.name != null ? String(row.name) : '';
+    if (!id || !name || seen.has(id)) continue;
+    seen.add(id);
+    out.push({ value: id, label: name });
+  }
+  return out;
+}
+
+/** Extract list array from business type API response */
+export function getBusinessTypeRawList(res: any): any[] {
+  const raw = res?.data !== undefined ? res.data : res;
+  const arr = Array.isArray(raw)
+    ? raw
+    : raw?.records || raw?.items || raw?.list || raw?.data || [];
+  return Array.isArray(arr) ? arr : [];
+}
+
+/** Parse business type API results to dropdown options (preserving apiKey for default item matching) */
+export function parseBusinessTypes(res: any): FilterOption[] {
+  const arr = getBusinessTypeRawList(res);
+  return arr
+    .map((x: any) => ({
+      value: x.id ?? x.apiKey ?? x.value,
+      label: String(x.label ?? x.name ?? x.title ?? x.apiKey ?? ''),
+      apiKey: x.apiKey != null ? String(x.apiKey) : undefined,
+    }))
+    .filter((o) => o.value != null && o.value !== '' && o.label);
+}
+
+/**
+ * Resolve default selected value in business type options by apiKey === defaultBusiType (consistent with dropdown value, usually id)
+ */
+export function resolveDefaultBusinessTypeValue(
+  options: FilterOption[],
+  defaultBusiTypeKey?: string,
+): string | number {
+  if (defaultBusiTypeKey == null || defaultBusiTypeKey === '') return '';
+  const key = String(defaultBusiTypeKey);
+  const hit = options.find((o) => o.apiKey != null && o.apiKey === key);
+  if (!hit) return '';
+  return hit.value;
+}