@hexabot-ai/api 3.1.3-alpha.0 → 3.2.0-alpha.0

package/src/chat/types/button.ts

@@ -1,86 +0,0 @@
-/*
- * Hexabot — Fair Core License (FCL-1.0-ALv2)
- * Copyright (c) 2025 Hexastack.
- * Full terms: see LICENSE.md.
- */
-
-import { z } from 'zod';
-
-export enum ButtonType {
-  postback = 'postback',
-  web_url = 'web_url',
-}
-
-export type PostBackButton = {
-  type: ButtonType.postback;
-  title: string;
-  payload: string;
-};
-
-export type WebUrlButton = {
-  type: ButtonType.web_url;
-  title: string;
-  url: string;
-  messenger_extensions?: boolean;
-  webview_height_ratio?: 'compact' | 'tall' | 'full';
-};
-
-export type Button = PostBackButton | WebUrlButton;
-
-export const buttonSchema = z
-  .object({
-    type: z.enum([ButtonType.postback, ButtonType.web_url]).meta({
-      title: 'Type',
-      description: 'The type of button.',
-    }),
-    title: z.string().meta({
-      title: 'Title',
-      description: 'The label shown to the user.',
-    }),
-    payload: z.string().optional().meta({
-      title: 'Payload',
-      description: 'The value sent back when the button is clicked.',
-    }),
-    url: z
-      .union([z.url(), z.literal('')])
-      .optional()
-      .meta({
-        title: 'URL',
-        description: 'The destination URL opened when the button is clicked.',
-      }),
-    messenger_extensions: z.boolean().optional().meta({
-      title: 'Messenger extensions',
-      description: 'Whether to enable Messenger Extensions for the webview.',
-    }),
-    webview_height_ratio: z.enum(['compact', 'tall', 'full']).optional().meta({
-      title: 'Webview height ratio',
-      description: 'The height of the webview.',
-    }),
-  })
-  .superRefine((button, ctx) => {
-    if (button.type === ButtonType.postback && !button.payload) {
-      ctx.addIssue({
-        code: z.ZodIssueCode.custom,
-        path: ['payload'],
-        message: 'Payload is required for postback buttons.',
-      });
-    }
-
-    if (button.type === ButtonType.web_url && !button.url) {
-      ctx.addIssue({
-        code: z.ZodIssueCode.custom,
-        path: ['url'],
-        message: 'URL is required for web_url buttons.',
-      });
-    }
-  }) as unknown as z.ZodType<Button>;
-
-export enum PayloadType {
-  location = 'location',
-  attachments = 'attachments',
-  quick_reply = 'quick_reply',
-  button = 'button',
-  outcome = 'outcome',
-  menu = 'menu',
-  content = 'content',
-}

package/src/chat/types/message.ts

@@ -1,282 +0,0 @@
-/*
- * Hexabot — Fair Core License (FCL-1.0-ALv2)
- * Copyright (c) 2025 Hexastack.
- * Full terms: see LICENSE.md.
- */
-
-import { z } from 'zod';
-
-import { Message } from '../dto/message.dto';
-
-import { attachmentPayloadSchema } from './attachment';
-import { buttonSchema, PayloadType } from './button';
-import { contentOptionsSchema } from './options';
-import { stdQuickReplySchema } from './quick-reply';
-
-export enum StdEventType {
-  message = 'message',
-  delivery = 'delivery',
-  read = 'read',
-  typing = 'typing',
-  follow = 'follow',
-  echo = 'echo',
-  error = 'error',
-  unknown = '',
-}
-
-export enum IncomingMessageType {
-  message = 'message',
-  postback = 'postback',
-  quick_reply = 'quick_reply',
-  location = 'location',
-  attachments = 'attachments',
-  unknown = '',
-}
-
-export const incomingMessageType = z.enum(IncomingMessageType);
-
-export type IncomingMessageTypeLiteral = z.infer<typeof incomingMessageType>;
-
-export enum OutgoingMessageFormat {
-  text = 'text',
-  quickReplies = 'quickReplies',
-  buttons = 'buttons',
-  attachment = 'attachment',
-  list = 'list',
-  carousel = 'carousel',
-  system = 'system',
-}
-
-export const outgoingMessageFormatSchema = z.enum(OutgoingMessageFormat);
-
-export type OutgoingMessageFormatLiteral = z.infer<
-  typeof outgoingMessageFormatSchema
->;
-
-export const payloadTypeSchema = z.enum(PayloadType);
-
-export type PayloadTypeLiteral = z.infer<typeof payloadTypeSchema>;
-
-export const stdOutgoingTextMessageSchema = z.object({
-  text: z.string(),
-});
-
-export type StdOutgoingTextMessage = z.infer<
-  typeof stdOutgoingTextMessageSchema
->;
-
-export const stdOutgoingQuickRepliesMessageSchema = z.object({
-  text: z.string(),
-  quickReplies: z.array(stdQuickReplySchema),
-});
-
-export type StdOutgoingQuickRepliesMessage = z.infer<
-  typeof stdOutgoingQuickRepliesMessageSchema
->;
-
-export const stdOutgoingButtonsMessageSchema = z.object({
-  text: z.string(),
-  buttons: z.array(buttonSchema),
-});
-
-export type StdOutgoingButtonsMessage = z.infer<
-  typeof stdOutgoingButtonsMessageSchema
->;
-
-export const contentElementSchema = z
-  .object({
-    id: z.string(),
-    title: z.string(),
-  })
-  .catchall(z.any());
-
-export type ContentElement = z.infer<typeof contentElementSchema>;
-
-export const contentPaginationSchema = z.object({
-  total: z.number(),
-  skip: z.number(),
-  limit: z.number(),
-});
-
-export type ContentPagination = z.infer<typeof contentPaginationSchema>;
-
-export const stdOutgoingListMessageSchema = z.object({
-  options: contentOptionsSchema,
-  elements: z.array(contentElementSchema),
-  pagination: contentPaginationSchema,
-});
-
-export type StdOutgoingListMessage = z.infer<
-  typeof stdOutgoingListMessageSchema
->;
-
-export const stdOutgoingAttachmentMessageSchema = z.object({
-  attachment: attachmentPayloadSchema,
-  quickReplies: z.array(stdQuickReplySchema).optional(),
-});
-
-export type StdOutgoingAttachmentMessage = z.infer<
-  typeof stdOutgoingAttachmentMessageSchema
->;
-
-export const stdOutgoingSystemMessageSchema = z.object({
-  outcome: z.string().optional(), // "any" or any other string (in snake case)
-  data: z.any().optional(),
-});
-
-export type StdOutgoingSystemMessage = z.infer<
-  typeof stdOutgoingSystemMessageSchema
->;
-
-export const StdOutgoingMessageSchema = z.union([
-  stdOutgoingTextMessageSchema,
-  stdOutgoingQuickRepliesMessageSchema,
-  stdOutgoingButtonsMessageSchema,
-  stdOutgoingListMessageSchema,
-  stdOutgoingAttachmentMessageSchema,
-]);
-
-export type StdOutgoingMessage = z.infer<typeof StdOutgoingMessageSchema>;
-
-export const stdIncomingTextMessageSchema = z.object({
-  text: z.string(),
-});
-
-export type StdIncomingTextMessage = z.infer<
-  typeof stdIncomingTextMessageSchema
->;
-
-export const stdIncomingPostBackMessageSchema =
-  stdIncomingTextMessageSchema.extend({
-    postback: z.string(),
-  });
-
-export type StdIncomingPostBackMessage = z.infer<
-  typeof stdIncomingPostBackMessageSchema
->;
-
-export const stdIncomingLocationMessageSchema = z.object({
-  type: z.literal(PayloadType.location),
-  coordinates: z.object({
-    lat: z.number(),
-    lon: z.number(),
-  }),
-});
-
-export type StdIncomingLocationMessage = z.infer<
-  typeof stdIncomingLocationMessageSchema
->;
-
-export const stdIncomingAttachmentMessageSchema = z.object({
-  type: z.literal(PayloadType.attachments),
-  serialized_text: z.string(),
-  attachment: z.union([
-    attachmentPayloadSchema,
-    z.array(attachmentPayloadSchema),
-  ]),
-});
-
-export type StdIncomingAttachmentMessage = z.infer<
-  typeof stdIncomingAttachmentMessageSchema
->;
-
-export const stdIncomingMessageSchema = z.union([
-  stdIncomingTextMessageSchema,
-  stdIncomingPostBackMessageSchema,
-  stdIncomingLocationMessageSchema,
-  stdIncomingAttachmentMessageSchema,
-]);
-
-export type StdIncomingMessage = z.infer<typeof stdIncomingMessageSchema>;
-
-export interface IncomingMessage extends Omit<Message, 'recipient' | 'sentBy'> {
-  message: StdIncomingMessage;
-  sender: string;
-}
-
-export interface OutgoingMessage extends Omit<Message, 'sender'> {
-  message: StdOutgoingMessage;
-  recipient: string;
-  sentBy?: string;
-  handover: boolean;
-}
-
-export type AnyMessage = IncomingMessage | OutgoingMessage;
-
-export const stdOutgoingTextEnvelopeSchema = z.object({
-  format: z.literal(OutgoingMessageFormat.text),
-  message: stdOutgoingTextMessageSchema,
-});
-
-export type StdOutgoingTextEnvelope = z.infer<
-  typeof stdOutgoingTextEnvelopeSchema
->;
-
-export const stdOutgoingQuickRepliesEnvelopeSchema = z.object({
-  format: z.literal(OutgoingMessageFormat.quickReplies),
-  message: stdOutgoingQuickRepliesMessageSchema,
-});
-
-export type StdOutgoingQuickRepliesEnvelope = z.infer<
-  typeof stdOutgoingQuickRepliesEnvelopeSchema
->;
-
-export const stdOutgoingButtonsEnvelopeSchema = z.object({
-  format: z.literal(OutgoingMessageFormat.buttons),
-  message: stdOutgoingButtonsMessageSchema,
-});
-
-export type StdOutgoingButtonsEnvelope = z.infer<
-  typeof stdOutgoingButtonsEnvelopeSchema
->;
-
-export const stdOutgoingListEnvelopeSchema = z.object({
-  format: z.enum([OutgoingMessageFormat.list, OutgoingMessageFormat.carousel]),
-  message: stdOutgoingListMessageSchema,
-});
-
-export type StdOutgoingListEnvelope = z.infer<
-  typeof stdOutgoingListEnvelopeSchema
->;
-
-export const stdOutgoingAttachmentEnvelopeSchema = z.object({
-  format: z.literal(OutgoingMessageFormat.attachment),
-  message: stdOutgoingAttachmentMessageSchema,
-});
-
-export type StdOutgoingAttachmentEnvelope = z.infer<
-  typeof stdOutgoingAttachmentEnvelopeSchema
->;
-
-export const stdOutgoingSystemEnvelopeSchema = z.object({
-  format: z.literal(OutgoingMessageFormat.system),
-  message: stdOutgoingSystemMessageSchema,
-});
-
-export type StdOutgoingSystemEnvelope = z.infer<
-  typeof stdOutgoingSystemEnvelopeSchema
->;
-
-export const stdOutgoingMessageEnvelopeSchema = z.union([
-  stdOutgoingTextEnvelopeSchema,
-  stdOutgoingQuickRepliesEnvelopeSchema,
-  stdOutgoingButtonsEnvelopeSchema,
-  stdOutgoingListEnvelopeSchema,
-  stdOutgoingAttachmentEnvelopeSchema,
-]);
-
-export type StdOutgoingMessageEnvelope = z.infer<
-  typeof stdOutgoingMessageEnvelopeSchema
->;
-
-export const stdOutgoingEnvelopeSchema = z.union([
-  stdOutgoingMessageEnvelopeSchema,
-  stdOutgoingSystemEnvelopeSchema,
-]);
-
-export type StdOutgoingEnvelope = z.infer<typeof stdOutgoingEnvelopeSchema>;
-
-// is-valid-message-text validation
-export const validMessageTextSchema = z.object({
-  text: z.string(),
-});

package/src/chat/types/options.ts

@@ -1,130 +0,0 @@
-/*
- * Hexabot — Fair Core License (FCL-1.0-ALv2)
- * Copyright (c) 2025 Hexastack.
- * Full terms: see LICENSE.md.
- */
-
-import { z } from 'zod';
-
-import { buttonSchema } from './button';
-
-export const contentOptionsSchema = z.object({
-  display: z.enum(['list', 'carousel']).meta({
-    title: 'Display',
-  }),
-  contentType: z
-    .string()
-    .optional()
-    .meta({
-      title: 'Content Type',
-      'ui:widget': 'AutoCompleteWidget',
-      'ui:options': {
-        entity: 'ContentType',
-        valueKey: 'id',
-        labelKey: 'name',
-      },
-    }),
-  fields: z
-    .object({
-      title: z.string().meta({
-        title: 'Title',
-        'ui:field': 'AutoCompleteField',
-        'ui:options': {
-          entity: 'ContentType',
-          idFormPath: 'content.contentType',
-          nestedArrayField: 'schema.properties',
-          nestedArrayItemField: 'type',
-          nestedArrayItemValue: 'string',
-        },
-      }),
-      subtitle: z
-        .string()
-        .optional()
-        .meta({
-          title: 'Subtitle',
-          'ui:field': 'AutoCompleteField',
-          'ui:options': {
-            entity: 'ContentType',
-            idFormPath: 'content.contentType',
-            nestedArrayField: 'schema.properties',
-            nestedArrayItemField: 'type',
-            nestedArrayItemValue: 'string',
-          },
-        }),
-      image_url: z
-        .string()
-        .optional()
-        .meta({
-          title: 'Image URL Field',
-          'ui:field': 'AutoCompleteField',
-          'ui:options': {
-            entity: 'ContentType',
-            idFormPath: 'content.contentType',
-            nestedArrayField: 'schema.properties',
-            nestedArrayItemField: 'type',
-            nestedArrayItemValue: 'file',
-          },
-        }),
-      url: z
-        .string()
-        .optional()
-        .meta({
-          title: 'URL',
-          'ui:field': 'AutoCompleteField',
-          'ui:options': {
-            showOnlyWhenWebUrlButton: true,
-            entity: 'ContentType',
-            valueKey: 'name',
-            idFormPath: 'content.contentType',
-            nestedArrayField: 'schema.properties',
-            nestedArrayItemField: 'type',
-            nestedArrayItemValue: 'uri',
-          },
-        }),
-      action_title: z
-        .string()
-        .optional()
-        .meta({
-          title: 'Action Title',
-          'ui:options': {
-            showOnlyWhenPostbackButton: true,
-          },
-        }),
-      action_payload: z
-        .string()
-        .optional()
-        .meta({
-          title: 'Action Payload',
-          'ui:options': {
-            showOnlyWhenPostbackButton: true,
-          },
-        }),
-    })
-    .meta({ title: 'Fields' }),
-  buttons: z.array(buttonSchema).meta({ title: 'Buttons' }),
-  limit: z.number().finite(),
-  query: z.any().optional(),
-  top_element_style: z.enum(['large', 'compact']).optional().meta({
-    title: 'Top Element Style',
-  }),
-});
-
-export type ContentOptions = z.infer<typeof contentOptionsSchema>;
-
-export const fallbackOptionsSchema = z.object({
-  active: z.boolean(),
-  message: z.array(z.string()),
-  max_attempts: z.number().finite(),
-});
-
-export type FallbackOptions = z.infer<typeof fallbackOptionsSchema>;
-
-export const ActionOptionsSchema = z.object({
-  typing: z.union([z.boolean(), z.int().nonnegative()]).optional(),
-  content: contentOptionsSchema.optional(),
-  fallback: fallbackOptionsSchema.optional(),
-  assignTo: z.string().optional(),
-  effects: z.array(z.string()).optional(),
-});
-
-export type ActionOptions = z.infer<typeof ActionOptionsSchema>;

package/src/chat/types/quick-reply.ts

@@ -1,41 +0,0 @@
-/*
- * Hexabot — Fair Core License (FCL-1.0-ALv2)
- * Copyright (c) 2025 Hexastack.
- * Full terms: see LICENSE.md.
- */
-
-import { z } from 'zod';
-
-import { attachmentPayloadSchema } from './attachment';
-import { PayloadType } from './button';
-
-export const cordinatesSchema = z.object({
-  lat: z.number(),
-  lon: z.number(),
-});
-
-export const payloadSchema = z.discriminatedUnion('type', [
-  z.object({
-    type: z.literal(PayloadType.location),
-    coordinates: cordinatesSchema,
-  }),
-  z.object({
-    type: z.literal(PayloadType.attachments),
-    attachment: attachmentPayloadSchema,
-  }),
-]);
-
-export const stdQuickReplySchema = z.object({
-  title: z.string().meta({
-    title: 'Title',
-    description: 'The label shown to the user.',
-  }),
-  payload: z.string().meta({
-    title: 'Payload',
-    description: 'The value sent back when the quick reply is selected.',
-  }),
-});
-
-export type Payload = z.infer<typeof payloadSchema>;
-
-export type StdQuickReply = z.infer<typeof stdQuickReplySchema>;

package/src/i18n/localize-schema-metadata.ts

@@ -1,63 +0,0 @@
-/*
- * Hexabot — Fair Core License (FCL-1.0-ALv2)
- * Copyright (c) 2026 Hexastack.
- * Full terms: see LICENSE.md.
- */
-
-import { I18nService } from '@/i18n/services/i18n.service';
-import { isPlainObject } from '@/utils/helpers/object';
-
-type LocalizableSchemaMetadataOptions = {
-  i18n: I18nService;
-  ns: string;
-  lang?: string;
-};
-
-const LOCALIZABLE_SCHEMA_METADATA_KEYS = new Set(['title', 'description']);
-const translateMetadataString = (
-  value: string,
-  { i18n, ns, lang }: LocalizableSchemaMetadataOptions,
-): string => {
-  return i18n.t(value, {
-    ns,
-    ...(lang ? { lang } : {}),
-    defaultValue: value,
-  });
-};
-const localizeNode = (
-  input: unknown,
-  options: LocalizableSchemaMetadataOptions,
-): unknown => {
-  if (Array.isArray(input)) {
-    return input.map((entry) => localizeNode(entry, options));
-  }
-
-  if (!isPlainObject(input)) {
-    return input;
-  }
-
-  return Object.entries(input).reduce<Record<string, unknown>>(
-    (acc, [key, value]) => {
-      if (
-        LOCALIZABLE_SCHEMA_METADATA_KEYS.has(key) &&
-        typeof value === 'string'
-      ) {
-        acc[key] = translateMetadataString(value, options);
-
-        return acc;
-      }
-
-      acc[key] = localizeNode(value, options);
-
-      return acc;
-    },
-    {},
-  );
-};
-
-export const localizeSchemaMetadata = <T>(
-  schema: T,
-  options: LocalizableSchemaMetadataOptions,
-): T => {
-  return localizeNode(schema, options) as T;
-};

package/src/user/dto/assigned-profile.dto.ts

@@ -1,76 +0,0 @@
-/*
- * Hexabot — Fair Core License (FCL-1.0-ALv2)
- * Copyright (c) 2025 Hexastack.
- * Full terms: see LICENSE.md.
- */
-
-import { Exclude, Expose } from 'class-transformer';
-
-import { ChannelName } from '@/channel';
-import { SubscriberChannelData } from '@/chat';
-
-import { UserProvider } from '../types/user-provider.type';
-
-import { UserProfileStub } from './user-profile.dto';
-
-@Exclude()
-export class UserProfileAssignedStub extends UserProfileStub {
-  // Subscriber Specific
-  @Expose()
-  locale: string | null;
-
-  @Expose()
-  gender: string | null;
-
-  @Expose()
-  country: string | null;
-
-  @Expose()
-  foreignId: string;
-
-  @Expose()
-  assignedAt: Date | null;
-
-  @Expose()
-  lastvisit: Date | null;
-
-  @Expose()
-  retainedFrom: Date | null;
-
-  @Expose()
-  channel!: SubscriberChannelData<ChannelName>;
-
-  @Expose({ name: 'labelIds' })
-  labels!: string[];
-
-  @Expose({ name: 'assignedToId' })
-  assignedTo: string | null;
-
-  // User specific
-  @Expose()
-  username!: string;
-
-  @Expose()
-  email!: string;
-
-  @Expose()
-  sendEmail!: boolean;
-
-  @Expose()
-  state!: boolean;
-
-  @Expose()
-  resetCount!: number;
-
-  @Expose()
-  resetToken!: string | null;
-
-  @Expose()
-  provider?: UserProvider;
-
-  @Expose({ name: 'roleIds' })
-  roles: string[];
-
-  @Expose({ name: 'avatarId' })
-  avatar: string;
-}