@ikatec/digisac-api-sdk 1.2.0

package/src/core/types.ts

@@ -0,0 +1,158 @@
+// ── Primitives ───────────────────────────────────────────────────────
+
+export type Primitive = string | number | boolean | null
+
+// ── Sequelize-style where operators ──────────────────────────────────
+
+type ComparisonOperators<T = Primitive> = {
+  $eq?: T
+  $ne?: T
+  $gt?: T
+  $gte?: T
+  $lt?: T
+  $lte?: T
+  $is?: null | boolean
+  $not?: T
+}
+
+type StringOperators = {
+  $like?: string
+  $notLike?: string
+  $iLike?: string
+  $notILike?: string
+  $regexp?: string
+  $notRegexp?: string
+  $iRegexp?: string
+  $notIRegexp?: string
+}
+
+type ArrayOperators<T = Primitive> = {
+  $in?: T[]
+  $notIn?: T[]
+  $between?: [T, T]
+  $notBetween?: [T, T]
+  $contains?: T[]
+  $contained?: T[]
+  $overlap?: T[]
+  $any?: T[]
+  $all?: T[]
+}
+
+type WhereOperators<T = Primitive> = ComparisonOperators<T> & StringOperators & ArrayOperators<T>
+
+type WhereValue<T> = T | WhereOperators<T>
+
+type WhereFields<T> = {
+  [K in keyof T]?: WhereValue<T[K]>
+}
+
+type LogicalOperators<T> = {
+  $and?: WhereClause<T> | WhereClause<T>[]
+  $or?: WhereClause<T> | WhereClause<T>[]
+}
+
+export type WhereClause<T> = WhereFields<T> & LogicalOperators<T>
+
+// ── Association helpers ──────────────────────────────────────────────
+
+/** Unwrap T[] to T, strip null/undefined, identity for plain objects */
+type Unwrap<T> = T extends (infer U)[] ? U : NonNullable<T>
+
+/** Keys of T whose unwrapped value is a non-primitive object (i.e. an association) */
+type AssociationKeys<T> = {
+  [K in keyof T]-?: Unwrap<T[K]> extends Primitive | Date
+    ? never
+    : Unwrap<T[K]> extends object
+      ? K & string
+      : never
+}[keyof T]
+
+// ── Include ──────────────────────────────────────────────────────────
+
+/** Typed include: `model` autocompletes to association keys, `where` is typed to the association model */
+type TypedIncludeObject<T> = {
+  [K in AssociationKeys<T>]: {
+    model: K
+    as?: string
+    include?: IncludeItem<Unwrap<T[K]>>[]
+    required?: boolean
+    where?: WhereClause<Unwrap<T[K]>>
+  }
+}[AssociationKeys<T>]
+
+export type IncludeItem<T = Record<string, unknown>> = AssociationKeys<T> | TypedIncludeObject<T>
+
+// ── ListQuery ────────────────────────────────────────────────────────
+
+export type ListQuery<T = Record<string, unknown>> = {
+  where?: WhereClause<T>
+  include?: IncludeItem<T>[]
+  attributes?: (keyof T & string)[]
+  fields?: (keyof T & string)[]
+  order?: [keyof T & string, 'ASC' | 'DESC' | 'asc' | 'desc'][]
+  page?: number
+  perPage?: number
+  limit?: number
+  offset?: number
+  subQuery?: boolean
+  through?: Record<string, unknown>
+  paranoid?: boolean
+  distinct?: boolean
+  paginate?: boolean
+}
+
+// ── Paginated ────────────────────────────────────────────────────────
+export type Paginated<T> = {
+  data: T[]
+  total: number
+  limit: number
+  skip: number
+  currentPage: number
+  lastPage: number
+  from: number
+  to: number
+}
+
+// ── CRUD interfaces ─────────────────────────────────────────────────
+
+export interface HasGetMany<TResponse, TQuery extends ListQuery<TResponse> = ListQuery<TResponse>> {
+  getMany(
+    query: TQuery & { paginate: false },
+    headers?: Record<string, string>,
+  ): Promise<TResponse[]>
+  getMany(
+    query?: TQuery & { paginate?: true },
+    headers?: Record<string, string>,
+  ): Promise<Paginated<TResponse>>
+  getMany(
+    query?: TQuery,
+    headers?: Record<string, string>,
+  ): Promise<Paginated<TResponse> | TResponse[]>
+}
+
+export interface HasGetOne<TResponse> {
+  getOne(id: string, headers?: Record<string, string>): Promise<TResponse>
+}
+
+export interface HasCreate<TResponse, TCreate> {
+  create(body: TCreate, headers?: Record<string, string>): Promise<TResponse>
+}
+
+export interface HasUpdateById<TResponse, TUpdate> {
+  updateById(id: string, body: TUpdate, headers?: Record<string, string>): Promise<TResponse>
+}
+
+export interface HasDeleteById<TResponse> {
+  deleteById(id: string, headers?: Record<string, string>): Promise<TResponse>
+}
+
+export type CrudApi<
+  TResponse,
+  TCreate,
+  TUpdate = TCreate,
+  TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,
+> = HasGetMany<TResponse, TQuery> &
+  HasGetOne<TResponse> &
+  HasCreate<TResponse, TCreate> &
+  HasUpdateById<TResponse, TUpdate> &
+  HasDeleteById<TResponse>

package/src/incommingWebhooks/index.test-d.ts

@@ -0,0 +1,43 @@
+import { expectAssignable, expectNotAssignable, expectType } from 'tsd'
+import type { WebhookPayload, WebhookEvent, WebhookEventPayloadMap, BotCommandData } from './index'
+import type { Message, MessageRelationships } from '../apis/messages'
+import type { Ticket, TicketRelationships } from '../apis/tickets'
+
+// ── WebhookPayload (generic) ─────────────────────────────────────────────────
+
+// unparameterised — event can be any WebhookEvent
+expectAssignable<WebhookPayload['event']>('message.created' as WebhookEvent)
+
+// narrowed to a specific event
+declare const msgPayload: WebhookPayload<'message.created'>
+expectType<'message.created'>(msgPayload.event)
+expectType<WebhookEventPayloadMap['message.created']>(msgPayload.data)
+expectAssignable<{ webhookId: string; timestamp: string }>(msgPayload)
+
+// ── data is stripped of relationships ────────────────────────────────────────
+
+// message payload must NOT have relationship keys
+expectNotAssignable<WebhookPayload<'message.created'>['data']>(
+  {} as Pick<Message, MessageRelationships>,
+)
+
+// ticket payload must NOT have relationship keys
+expectNotAssignable<WebhookPayload<'ticket.updated'>['data']>(
+  {} as Pick<Ticket, TicketRelationships>,
+)
+
+// ── event narrowing tightens data type ───────────────────────────────────────
+
+declare const ticketPayload: WebhookPayload<'ticket.created'>
+expectType<WebhookEventPayloadMap['ticket.created']>(ticketPayload.data)
+
+// ── bot.command uses BotCommandData ─────────────────────────────────────────
+
+declare const botPayload: WebhookPayload<'bot.command'>
+expectType<BotCommandData>(botPayload.data)
+expectAssignable<{ id: string; command: string }>(botPayload.data)
+
+// ── invalid events are rejected ──────────────────────────────────────────────
+
+expectNotAssignable<WebhookEvent>('message.deleted')
+expectNotAssignable<WebhookEvent>('unknown.event')

package/src/incommingWebhooks/index.ts

@@ -0,0 +1,133 @@
+import type { Bot, BotRelationships } from '../apis/bots'
+import type { Campaign, CampaignRelationships } from '../apis/campaigns'
+import type { Contact, ContactRelationships } from '../apis/contacts'
+import type { Department, DepartmentRelationships } from '../apis/departments'
+import type { Message, MessageRelationships } from '../apis/messages'
+import type { Organization, OrganizationRelationships } from '../apis/organizations'
+import type { Person, PersonRelationships } from '../apis/people'
+import type { Pipeline, PipelineRelationships } from '../apis/pipeline'
+import type { QuickReply, QuickReplyRelationships } from '../apis/quickReplies'
+import type { Role, RoleRelationships } from '../apis/roles'
+import type { Service, ServiceRelationships } from '../apis/services'
+import type { Tag, TagRelationships } from '../apis/tags'
+import type { Ticket, TicketRelationships } from '../apis/tickets'
+import type { TicketTopic } from '../apis/ticketTopics'
+import type { User, UserRelationships } from '../apis/users'
+
+// ─── Webhook Events ──────────────────────────────────────────────────────────
+
+export type WebhookEvent =
+  | 'message.created'
+  | 'message.updated'
+  | 'ticket.created'
+  | 'ticket.updated'
+  | 'service.created'
+  | 'service.updated'
+  | 'service.destroyed'
+  | 'contact.created'
+  | 'contact.updated'
+  | 'contact.destroyed'
+  | 'people.created'
+  | 'people.updated'
+  | 'people.destroyed'
+  | 'organization.created'
+  | 'organization.updated'
+  | 'organization.destroyed'
+  | 'user.created'
+  | 'user.updated'
+  | 'user.destroyed'
+  | 'department.created'
+  | 'department.updated'
+  | 'department.destroyed'
+  | 'ticketTopics.created'
+  | 'ticketTopics.updated'
+  | 'ticketTopics.destroyed'
+  | 'role.created'
+  | 'role.updated'
+  | 'role.destroyed'
+  | 'bot.created'
+  | 'bot.updated'
+  | 'bot.destroyed'
+  | 'bot.command'
+  | 'bot.enter-context'
+  | 'bot.leave-context'
+  | 'bot.api-signal'
+  | 'quickReplies.created'
+  | 'quickReplies.updated'
+  | 'quickReplies.destroyed'
+  | 'tag.created'
+  | 'tag.updated'
+  | 'tag.destroyed'
+  | 'campaign.created'
+  | 'campaign.updated'
+  | 'campaign.destroyed'
+  | 'pipeline.created'
+  | 'pipeline.updated'
+
+// ─── Event → Payload map ─────────────────────────────────────────────────────
+
+export type BotCommandData = {
+  id: string
+  contactId: string
+  accountId: string
+  command: string
+  message: Message
+}
+
+export interface WebhookEventPayloadMap {
+  'message.created': Omit<Message, MessageRelationships>
+  'message.updated': Omit<Message, MessageRelationships>
+  'ticket.created': Omit<Ticket, TicketRelationships>
+  'ticket.updated': Omit<Ticket, TicketRelationships>
+  'service.created': Omit<Service, ServiceRelationships>
+  'service.updated': Omit<Service, ServiceRelationships>
+  'service.destroyed': Omit<Service, ServiceRelationships>
+  'contact.created': Omit<Contact, ContactRelationships>
+  'contact.updated': Omit<Contact, ContactRelationships>
+  'contact.destroyed': Omit<Contact, ContactRelationships>
+  'people.created': Omit<Person, PersonRelationships>
+  'people.updated': Omit<Person, PersonRelationships>
+  'people.destroyed': Omit<Person, PersonRelationships>
+  'organization.created': Omit<Organization, OrganizationRelationships>
+  'organization.updated': Omit<Organization, OrganizationRelationships>
+  'organization.destroyed': Omit<Organization, OrganizationRelationships>
+  'user.created': Omit<User, UserRelationships>
+  'user.updated': Omit<User, UserRelationships>
+  'user.destroyed': Omit<User, UserRelationships>
+  'department.created': Omit<Department, DepartmentRelationships>
+  'department.updated': Omit<Department, DepartmentRelationships>
+  'department.destroyed': Omit<Department, DepartmentRelationships>
+  'ticketTopics.created': TicketTopic
+  'ticketTopics.updated': TicketTopic
+  'ticketTopics.destroyed': TicketTopic
+  'role.created': Omit<Role, RoleRelationships>
+  'role.updated': Omit<Role, RoleRelationships>
+  'role.destroyed': Omit<Role, RoleRelationships>
+  'bot.created': Omit<Bot, BotRelationships>
+  'bot.updated': Omit<Bot, BotRelationships>
+  'bot.destroyed': Omit<Bot, BotRelationships>
+  'bot.command': BotCommandData
+  'bot.enter-context': Omit<Bot, BotRelationships>
+  'bot.leave-context': Omit<Bot, BotRelationships>
+  'bot.api-signal': Omit<Bot, BotRelationships>
+  'quickReplies.created': Omit<QuickReply, QuickReplyRelationships>
+  'quickReplies.updated': Omit<QuickReply, QuickReplyRelationships>
+  'quickReplies.destroyed': Omit<QuickReply, QuickReplyRelationships>
+  'tag.created': Omit<Tag, TagRelationships>
+  'tag.updated': Omit<Tag, TagRelationships>
+  'tag.destroyed': Omit<Tag, TagRelationships>
+  'campaign.created': Omit<Campaign, CampaignRelationships>
+  'campaign.updated': Omit<Campaign, CampaignRelationships>
+  'campaign.destroyed': Omit<Campaign, CampaignRelationships>
+  'pipeline.created': Omit<Pipeline, PipelineRelationships>
+  'pipeline.updated': Omit<Pipeline, PipelineRelationships>
+}
+
+// ─── Webhook Envelope ────────────────────────────────────────────────────────
+
+export type WebhookPayload<E extends WebhookEvent = WebhookEvent> = {
+  event: E
+  data: WebhookEventPayloadMap[E]
+  webhookId: string
+  timestamp: string
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './core/index'