@ikatec/digisac-api-sdk 4.4.0 → 4.5.0

package/src/apis/pipeline/types.ts

@@ -1,4 +1,5 @@
 import type { Department } from '../departments/types'
+import type { WhereClause } from '../../core/types'
 
 export type PipelineStageStatus = {
   id: string
@@ -95,3 +96,164 @@ export type UpdatePipelinePayload = {
   goBack?: boolean
   permissionToViewCard?: boolean | null
 }
+
+/** Codes the stage routes answer (as a JSON string, with 200) instead of the stage. */
+export type PipelineStageRefusal = 'STAGES_LIMIT' | 'STAGE_ALREADY_EXIST'
+
+export type PipelineStageStatusInput = {
+  /** Send the `id` of an existing status to keep it on update; omit it to create one. */
+  id?: string
+  name: string
+  position: number
+}
+
+export type PipelineStageReasonInput = {
+  /** Send the `id` of an existing reason to keep it on update; omit it to create one. */
+  id?: string
+  name: string
+  position: number
+  isWon?: boolean
+}
+
+export type CreatePipelineStagePayload = {
+  /** Up to 255 characters; must not repeat the name of another stage of the pipeline. */
+  name: string
+  pipelineId: string
+  /** Must be truthy — the backend `required` rule refuses `0`. */
+  position: number
+  /** Up to 10. */
+  statuses?: PipelineStageStatusInput[]
+  /** Up to 20. */
+  reasons?: PipelineStageReasonInput[]
+}
+
+export type UpdatePipelineStagePayload = CreatePipelineStagePayload & {
+  /**
+   * The stage id. Send it: the duplicate-name check compares against the `id` of the body,
+   * so without it keeping the current name answers `'STAGE_ALREADY_EXIST'`.
+   */
+  id?: string
+}
+
+/**
+ * Where the cards of a deleted stage go:
+ * - `typeAction: 'move'` moves them to `idNewStage` (a stage of the same pipeline), clearing
+ *   status, reason and result;
+ * - without `typeAction`, they are archived and moved to the first stage of the pipeline.
+ */
+export type DeletePipelineStagePayload = {
+  typeAction?: 'move'
+  idNewStage?: string
+  /**
+   * Author of the card movements written by `'move'` — the backend reads it from the body, not
+   * from the token (the UI sends the logged user). Without it, moving a stage that has cards
+   * fails with 500 (`CardMovement.userId cannot be null`) after the cards were already moved,
+   * and the stage is kept.
+   */
+  user?: { id: string }
+}
+
+/** Answer of the stage deletion; `'PIPELINES_MIN_STAGES'` = refused, the pipeline keeps 2 stages. */
+export type DeletePipelineStageResult = 'MESSAGE_STAGE_DELETED' | 'PIPELINES_MIN_STAGES'
+
+export type PipelineStatusRef = { id: string; name: string }
+
+/** `GET /pipelines/status/{id}`: the status plus how many cards use it. */
+export type PipelineStageStatusWithCount = PipelineStageStatus & { cardsCount: number }
+
+/**
+ * What happens to the cards of a deleted status: `'keep-without-status'` clears their status,
+ * `'move-to-another'` sets `newStatusId` (not validated by the backend).
+ */
+export type DeletePipelineStatusPayload =
+  | { action: 'keep-without-status' }
+  | { action: 'move-to-another'; newStatusId: string }
+
+export type PipelineAutomationType = 'notification'
+
+export type PipelineAutomationConfig = {
+  notify?: 'high' | 'medium' | 'medium-high'
+  frequency?: 'daily' | 'weekly' | 'biweekly' | 'monthly'
+  day?: string
+  from?: { high?: string; medium?: string }
+  recipient?: 'admin' | 'owner' | 'both'
+}
+
+export type PipelineAutomation = {
+  id: string
+  pipelineId: string
+  type: PipelineAutomationType
+  isArchived: boolean | null
+  archivedAt: string | null
+  config: PipelineAutomationConfig
+  createdAt: string
+  updatedAt: string
+}
+
+export type CreatePipelineAutomationPayload = {
+  pipelineId: string
+  /** The backend does not validate it (any string is stored); `'notification'` is the only one used. */
+  type: PipelineAutomationType
+  config?: PipelineAutomationConfig
+  isArchived?: boolean
+}
+
+/** The backend validator requires `pipelineId` and `type` on update too. */
+export type UpdatePipelineAutomationPayload = CreatePipelineAutomationPayload
+
+/** Card date filters of the CSV export; the UI sends `'YYYY-MM-DD HH:mm:ss'`. */
+export type ExportPipelinePayload = {
+  /** Without both `createdAt*`, the range defaults to now (empty export). */
+  createdAtInit?: string
+  createdAtFinal?: string
+  /** With both `wonAt*`, only won cards are exported. */
+  wonAtInit?: string
+  wonAtFinal?: string
+}
+
+export type PipelinesWithTotalsQuery = {
+  /** `accountId` is always injected by the backend. `$and[].createdAt` filters the cards. */
+  where?: WhereClause<PipelineRecord>
+  order?: [string, 'ASC' | 'DESC'][]
+  limit?: number
+  /** `true` lists only the pipelines that are not archived. */
+  archive?: boolean
+}
+
+export type PipelineTotals = {
+  id: string
+  name: string
+  total: number | null
+  totalSuccess: number | null
+  totalFailed: number | null
+  /** A bigint, sent as a string. */
+  totalCards: string
+}
+
+/**
+ * Pipelines without stages are left out; there is no pagination. With a `createdAt` filter, only
+ * the stages that have matching cards are listed, but `totals` still has every stage.
+ */
+export type PipelinesWithTotals = {
+  data: (PipelineRecord & { stages: PipelineStage[]; totals: PipelineTotals[] })[]
+}
+
+/** Card filters of the stage totals (same as the board filters of the UI). */
+export type PipelineStageTotalsFilters = {
+  status?: { value: string }
+  service?: { id: string }
+  nameTitle?: string
+  /** `DD/MM/YYYY`. */
+  createdFrom?: string
+  createdUntil?: string
+  owner?: { id: string; value?: string }
+  wonFrom?: string
+  wonUntil?: string
+}
+
+export type PipelineStageTotals = PipelineStage & {
+  totalCards: number
+  totalCardsValue: number
+  totalWonCardsValue: number
+  totalLostCardsValue: number
+}

package/src/apis/tags/TagsApi.test.ts

@@ -38,6 +38,11 @@ describe('TagsApi', () => {
       expect(result).toBe('OK')
     })
 
+    it('resolves to false when no link changed', async () => {
+      vi.mocked(client.post).mockResolvedValue(false)
+      await expect(api.attachContacts('t1', { where: { id: 'c1' } })).resolves.toBe(false)
+    })
+
     it('forwards custom headers', async () => {
       await api.attachContacts('t1', { where: { id: 'c1' } }, headers)
       expect(client.post).toHaveBeenCalledWith(

package/src/apis/tags/TagsApi.ts

@@ -5,6 +5,7 @@ import type {
   AttachTagsToDepartmentsPayload,
   CreateTagPayload,
   Tag,
+  TagContactsLinkResult,
   UpdateTagPayload,
 } from './types'
 
@@ -14,15 +15,16 @@ export class TagsApi extends BaseCrudApi<Tag, CreateTagPayload, UpdateTagPayload
   }
 
   /**
-   * Adds the tag to every contact of the account that matches the selection. Resolves to `'OK'`.
+   * Adds the tag to every contact of the account that matches the selection. Resolves to `'OK'`,
+   * or `false` when every contact already had the tag.
    * @permissions tags.view
    */
   attachContacts(
     id: string,
     body: ContactsSelection,
     headers?: Record<string, string>,
-  ): Promise<string> {
-    return this.client.post<string, ContactsSelection>(
+  ): Promise<TagContactsLinkResult> {
+    return this.client.post<TagContactsLinkResult, ContactsSelection>(
       `${this.basePath}/${id}/contacts`,
       body,
       headers,
@@ -31,15 +33,15 @@ export class TagsApi extends BaseCrudApi<Tag, CreateTagPayload, UpdateTagPayload
 
   /**
    * Removes the tag from every contact of the account that matches the selection. Resolves to
-   * `'OK'`.
+   * `'OK'`, or `false` when no contact had the tag.
    * @permissions tags.view OR tags.destroy
    */
   detachContacts(
     id: string,
     body: ContactsSelection,
     headers?: Record<string, string>,
-  ): Promise<string> {
-    return this.client.request<string, ContactsSelection>(
+  ): Promise<TagContactsLinkResult> {
+    return this.client.request<TagContactsLinkResult, ContactsSelection>(
       'DELETE',
       `${this.basePath}/${id}/contacts`,
       body,

package/src/apis/tags/types.ts

@@ -28,6 +28,12 @@ export type UpdateTagPayload = {
   backgroundColor?: string | null
 }
 
+/**
+ * Result of linking or unlinking a tag and the contacts of a selection: `'OK'` when at least one
+ * link changed, `false` when nothing changed (every contact already had, or did not have, the tag).
+ */
+export type TagContactsLinkResult = 'OK' | false
+
 /**
  * Body for `POST /tags/attach-many-departments`. An empty `departmentIds` makes the tags
  * available to every department.

package/src/apis/users/UsersApi.test.ts

@@ -32,15 +32,15 @@ const user: User = {
   email: 'alice@example.com',
   phoneNumber: null,
   branch: null,
-  isSuperAdmin: false,
   isClientUser: false,
-  active: true,
   language: 'pt-BR',
   isFirstLogin: false,
   status: 'offline',
   clientsStatus: { web: 'offline', app: 'offline' },
-  offlineAt: null,
   isActiveInternalChat: false,
+  internalChatToken: null,
+  noteReference: false,
+  data: {},
   passwordExpiresAt: null,
   otpAuthActive: false,
   preferences: {},

package/src/apis/users/types.ts

@@ -9,21 +9,39 @@ export type UserPreferences = {
   isShowTagsChat?: boolean
 }
 
+export type UserData = {
+  /** Push token of the mobile app; cleared (`null`) when the user is archived. */
+  expoPushToken?: string | null
+  [key: string]: unknown
+}
+
+/** A connection the user is restricted to (`GET /users/:id` of a non-admin user). */
+export type UserRestrictedService = {
+  id: string
+  name: string
+}
+
+/**
+ * A user as the API answers it (`userTransformer`). `isSuperAdmin`, `active` and `offlineAt` exist in
+ * the database but are never answered.
+ */
 export type User = {
   id: string
   name: string
   email: string
   phoneNumber: string | null
   branch: string | null
-  isSuperAdmin: boolean
   isClientUser: boolean
-  active: boolean
   language: string
   isFirstLogin: boolean
   status: UserStatus
   clientsStatus: Record<string, string> | null
-  offlineAt: string | null
   isActiveInternalChat: boolean
+  /** Token of the internal chat; `null` right after the creation, regenerated on every write of the user. */
+  internalChatToken: string | null
+  /** Set by the backend from an internal flag of the user. */
+  noteReference: boolean
+  data: UserData
   passwordExpiresAt: string | null
   otpAuthActive: boolean | null
   preferences: UserPreferences
@@ -37,6 +55,8 @@ export type User = {
   timetable?: Timetable | null
   roles?: Role[]
   departments?: Department[]
+  /** Only in `GET /users/:id`, for a user without an admin role. */
+  restrictedServices?: UserRestrictedService[]
 }
 
 export type UserRelationships = 'timetable' | 'roles' | 'departments'