@bisondesk/commons-sdk 1.0.21 → 1.0.23-B

package/src/notifications.ts

@@ -0,0 +1,40 @@
+import { BusinessEntityIds } from './constants';
+
+export enum NotificationVisibility {
+  UNREAD = 'unread',
+  READ = 'read',
+}
+
+export type NewNotificationsEvent<T = unknown> = {
+  tenantId: string;
+  notifications: NewNotification<T>[];
+};
+
+type BaseNotification<T = {}> = {
+  sourceId: string; // userId
+  destinationId: string; // userId
+  businessEntityId: BusinessEntityIds;
+  recordId: string;
+  recordTitle?: string;
+  meta: T;
+  origin: string;
+};
+
+export type NewNotification<T = unknown> = BaseNotification<T>;
+
+export type Notification<T = unknown> = BaseNotification<T> & {
+  id: string;
+  createdAt: string;
+  visibility: NotificationVisibility;
+};
+
+export type NotificationReadUpdates = {
+  notificationIds: string[] | undefined; // not passing a value means read all
+};
+
+export type NotificationsInfo = {
+  unreadCount: number;
+  unseen: boolean;
+  latestSeenAt?: string;
+  latestNotificationAt?: string;
+};

package/src/pdf-gen.ts

@@ -0,0 +1,43 @@
+import { BusinessEntityIds } from './constants';
+import { AttachmentValue } from './types';
+
+export type TemplateData = { [key: string]: unknown };
+
+export type NewPdfTemplateGroup = {
+  exampleData?: TemplateData;
+  title: string;
+  id: string; // [a-z][a-z0-9_]*
+};
+
+export type PdfTemplateGroup = NewPdfTemplateGroup & {
+  modifiedAt: string;
+  modifiedBy: string;
+};
+
+type BasePdfTemplate = {
+  branch: string;
+  docx: AttachmentValue;
+  groupId: string;
+  language: string;
+};
+
+export type PdfTemplate = BasePdfTemplate & {
+  id: string;
+  modifiedAt: string;
+  modifiedBy: string;
+  pdf: AttachmentValue;
+};
+
+export type NewPdfTemplate = BasePdfTemplate & {
+  id?: string;
+};
+
+export type GeneratePdfEvent = {
+  branch: string;
+  businessEntityId: BusinessEntityIds;
+  data: TemplateData;
+  groupId: string;
+  language: string;
+  outputFilename?: string;
+  tenantId: string;
+};

package/src/storage.ts

@@ -0,0 +1,83 @@
+import type Joi from 'joi';
+import { Requester } from './types';
+
+export type UploadInfo = {
+  id: string;
+  uploadUrl: string;
+  downloadPath: string;
+  method: 'POST' | 'PATCH' | 'PUT';
+  headers?: {
+    [name: string]: string;
+  };
+};
+
+export type VideoDownloadInfo = {
+  url: string;
+  quality: string;
+  size: number;
+};
+
+export type VideoInfo = {
+  status: 'SUCCESS' | 'PROCESSING' | 'ERROR';
+  downloads: VideoDownloadInfo[];
+  id: string;
+};
+
+export enum UploadProviders {
+  Vimeo = 'vimeo',
+  S3 = 's3',
+}
+
+type BaseUploadUrlRequest = {
+  contentType: string;
+};
+
+export type VimeoUploadRequest = BaseUploadUrlRequest & {
+  size: number;
+  name: string;
+};
+
+export type S3UploadRequest = BaseUploadUrlRequest & {
+  // is the file supposed to be shared by all tenants that need it, or will each tenant have its copy
+  shared: boolean;
+  fileName: string;
+  businessEntityId: string;
+};
+
+export type UploadUrlRequest<Provider extends UploadProviders> =
+  Provider extends UploadProviders.Vimeo
+    ? VimeoUploadRequest
+    : Provider extends UploadProviders.S3
+    ? S3UploadRequest
+    : {};
+
+export type UploadProvider = {
+  validationSchema: Joi.ObjectSchema<any>;
+  getVideoListInfo: (requester: Requester, videoIds: string[]) => Promise<VideoInfo[]>;
+  getUploadInfo(
+    requester: Requester,
+    request: UploadUrlRequest<UploadProviders>
+  ): Promise<UploadInfo>;
+};
+
+export type UploadProvidersDefinition = {
+  [key in UploadProviders]: UploadProvider;
+};
+
+export enum MediaExportResolution {
+  Low = 'low',
+  High = 'high',
+}
+
+export type MediaExportRequest = {
+  urls: string[];
+  resolution?: MediaExportResolution;
+};
+
+export type MediaExportEvent = {
+  s3Keys: string[];
+  outputId: string;
+  tenantId: string;
+  entityId: string;
+  resolution: MediaExportResolution;
+};

package/src/types.ts

@@ -1,16 +1,29 @@
+import { AppRoles } from './constants';
+
 export type PaginatedList<T, M = {}> = {
   results: T[];
   totalCount: number;
   meta: M;
 };
 
+export type NextList<T, M = {}> = {
+  results: T[];
+  nextToken?: string;
+  meta: M;
+};
+
+export type PaginatedRequest = {
+  limit?: number;
+  offset?: number;
+};
+
 export type Requester = {
   lang: string;
-  roles: string[];
+  roles: AppRoles[];
   tenantId: string;
   tenantLang: string;
   userAgent?: string;
-  source: string;
+  source?: string;
   userId: string;
   isApi: boolean;
 };
@@ -37,3 +50,85 @@ export type CognitoInfo = {
   appClientId: string;
   region: Region;
 };
+
+export type SearchPermissions = {
+  users: string[];
+  roles: AppRoles[];
+};
+
+export type PhoneNumberValue = {
+  country: string;
+  e164: string;
+  international: string;
+  national: string;
+};
+
+export type PhoneNumberRawValue = {
+  defaultCountry?: string;
+  input: string;
+};
+
+export type LocationValue = {
+  addressLine1?: string;
+  addressLine2?: string;
+  city?: string;
+  country: string;
+  postalCode?: string;
+  gps?: {
+    lat: number;
+    lon: number;
+  };
+};
+
+export type LinkValue = {
+  text?: string;
+  url: string;
+};
+
+export type Document = {
+  type: string; // passport, driving_license, ...
+  displayName: string;
+  file: AttachmentValue;
+};
+
+export type AttachmentValue = {
+  contentType: string;
+  fileName: string;
+  id: string;
+  previewSrc?: string;
+  size: number;
+  uploadedAt: string;
+  uploadedBy: string;
+  url: string;
+  descriptions?: string | MultiLangValue;
+};
+
+export type VatLayerResponse = { vatNumber: string } & (
+  | { formatValid: false; viesValid: false }
+  | {
+      formatValid: true;
+      viesValid: boolean;
+      countryCode: string;
+      name: string;
+      addressLines: string[];
+    }
+);
+
+export type VatValidationResponse = {
+  vatNumber: string;
+  formatValid?: boolean;
+  countryCode?: string;
+} & (
+  | { viesValid: false }
+  | {
+      viesValid: true;
+      name?: string;
+      normalizedAddress?: LocationValue;
+      officialAddress?: string[];
+    }
+);
+
+export type VatValidationRequest = {
+  defaultCountry?: string;
+  input: string;
+};