@bisondesk/core-sdk 1.0.0

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@bisondesk/core-sdk",
+  "version": "1.0.0",
+  "description": "",
+  "scripts": {
+    "clean": "rm -rf build dist lib *.tsbuildinfo",
+    "unittest": "echo \"No test specified\"",
+    "integrationtest": "echo \"No test specified\"",
+    "build": "npx tsc --build",
+    "watch": "npx tsc --build --watch"
+  },
+  "author": "Ivo Anastácio",
+  "dependencies": {
+    "@hapi/joi": "17.1.1",
+    "@bisondesk/commons-sdk": "1.0.0"
+  },
+  "devDependencies": {
+    "@types/hapi__joi": "17.1.6",
+    "@types/node": "14.14.37",
+    "typescript": "4.2.3"
+  }
+}

package/src/constants.ts

@@ -0,0 +1,18 @@
+//
+// STATIC PICKLIST IDS
+//
+export const APP_LANGUAGES_PICKLIST_ID = 'appLanguages';
+export const TIMEZONES_PICKLIST_ID = 'timezones';
+export const COUNTRIES_PICKLIST_ID = 'countries';
+
+//
+// PICKLIST CONSTANTS
+//
+export const MAX_SORT_PRIORITY = 10000;
+export const MIN_SORT_PRIORITY = 1;
+
+//
+// SEARCH
+//
+export const FILTER_RANGE_SEPARATOR = '__';
+export const FILTER_MULTIPLE_SEPARATOR = '__';

package/src/types/events.ts

@@ -0,0 +1,17 @@
+export enum RecordAction {
+  // if you rename this, you also need to adjust the SNS subscription filters
+  Create = 'content.records.create',
+  Update = 'content.records.update',
+  Delete = 'content.records.delete',
+}
+
+export type ActionMessage = {
+  id: string;
+  action: RecordAction;
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+  businessEntityId: string;
+  recordId: string;
+  fieldIds?: string[];
+};

package/src/types/fields.ts

@@ -0,0 +1,42 @@
+import { MultiLangValue } from '@bisondesk/commons-sdk/lib/types';
+
+export enum FieldTypes {
+  checkbox = 'checkbox',
+  collaborator = 'collaborator',
+  date = 'date',
+  email = 'email',
+  image = 'image',
+  picklist = 'picklist',
+  multilang = 'multilang',
+  multiRecord = 'multiRecord',
+  multiline = 'multiline',
+  number = 'number',
+  phoneNumber = 'phoneNumber',
+  rating = 'rating',
+  record = 'record',
+  text = 'text',
+  location = 'location',
+}
+
+export type PhoneNumberValue = {
+  country?: string;
+  e164: string;
+  international: string;
+  national: string;
+};
+
+export type PhoneNumberRawValue = {
+  defaultCountry?: string;
+  input: string;
+};
+
+export type AttachmentValue = {
+  contentType: string;
+  fileName: string;
+  id: string;
+  size: number;
+  uploadedAt: string;
+  uploadedBy: string;
+  url: string;
+  descriptions?: string | MultiLangValue;
+};

package/src/types/picklists.ts

@@ -0,0 +1,67 @@
+import { MultiLangValue } from '@bisondesk/commons-sdk/lib/types';
+////////////////////////////////////////////////////////////////////
+// Picklist
+////////////////////////////////////////////////////////////////////
+
+export type PicklistValueUpdateRequest = {
+  picklistId: string;
+  value: PicklistValue | NewPicklistValue;
+};
+export type NewPicklistValue = {
+  color?: string;
+  customId?: string;
+  sortPriority?: number;
+  titles: MultiLangValue;
+};
+export type PicklistValue = NewPicklistValue & {
+  id: string;
+  system?: boolean;
+};
+export type PicklistValueListRequest = {
+  picklistId: string;
+  limit: number;
+  offset: number;
+};
+export type PicklistValueRequest = {
+  picklistId: string;
+  valueId: string;
+};
+export type AdHocPicklistValues = {
+  [picklistId: string]: {
+    [valueId: string]: PicklistValue;
+  };
+};
+export type AdHocPicklistValueDisplay = {
+  [picklistId: string]: {
+    [valueId: string]: {
+      color?: string;
+      title: string;
+    };
+  };
+};
+export type PicklistOptionsRequest = {
+  picklistId: string;
+  lang: string;
+};
+export type QuickAddPicklistValue = {
+  customId?: string;
+  sortPriority?: number;
+  titles: MultiLangValue;
+};
+export type NewPicklist = {
+  titles: MultiLangValue;
+  values: QuickAddPicklistValue[];
+  customSort?: boolean;
+  customId?: string;
+};
+export type BasePicklist = {
+  customSort?: boolean;
+  id: string;
+  system?: boolean;
+  titles: MultiLangValue;
+  customId?: string;
+};
+export type PicklistInfo = BasePicklist & {
+  count: number;
+  modifiedAt: string;
+};

package/src/types/search.ts

@@ -0,0 +1,153 @@
+import { SortFilter } from '@bisondesk/commons-sdk/lib/types';
+import { FieldTypes } from './fields';
+
+export enum ConditionType {
+  and = 'AND',
+  or = 'OR',
+}
+
+export type Filter<OP extends string = string> = {
+  data: string;
+  fieldId: string;
+  fieldType: FieldTypes;
+  operator: OP;
+};
+
+export type ComplexFilter<OP extends string = string> = {
+  condition: ConditionType;
+  filters: Array<Filter<OP> | ComplexFilter<OP>>;
+};
+
+export type SearchRequest<OP extends string = string> = {
+  fullText?: string;
+  limit: number;
+  offset?: number;
+  query?: ComplexFilter<OP>;
+  sortBy?: SortFilter[];
+  lang: string;
+};
+
+export type RecordSearchRequest<OP extends string = string> = SearchRequest<OP> & {
+  businessEntityId: string;
+};
+
+export type TextSearchRequest = {
+  businessEntityIds?: string[]; // omit to search across all valid business entities
+  fullText: string;
+  limit: number;
+  offset?: number;
+  lang: string;
+};
+
+export enum ElasticsearchOperator {
+  // all properties
+  empty = 'EMPTY',
+  notEmpty = 'NOT_EMPTY',
+  is = 'IS',
+  isNot = 'IS_NOT',
+  // number, date properties
+  greaterThanOrEqual = 'GTE',
+  greaterThan = 'GT',
+  lessThanEqual = 'LTE',
+  lessThan = 'LT',
+  between = 'BETWEEN',
+  // string properties
+  contains = 'CONTAINS',
+  notContains = 'NOT_CONTAINS',
+  startsWith = 'STARTS_WITH',
+  endsWith = 'ENDS_WITH',
+}
+
+export enum DateOperator {
+  after = 'GTE',
+  before = 'LTE',
+  empty = 'EMPTY',
+  is = 'IS',
+  lastMonth = 'LAST_MONTH',
+  lastWeek = 'LAST_WEEK',
+  notEmpty = 'NOT_EMPTY',
+  thisMonth = 'THIS_MONTH',
+  thisWeek = 'THIS_WEEK',
+  today = 'TODAY',
+  yesterday = 'YESTERDAY',
+}
+
+export enum NumberOperator {
+  between = 'BETWEEN',
+  empty = 'EMPTY',
+  greaterThan = 'GT',
+  greaterThanOrEqual = 'GTE',
+  is = 'IS',
+  isNot = 'IS_NOT',
+  lessThan = 'LT',
+  lessThanEqual = 'LTE',
+  notEmpty = 'NOT_EMPTY',
+}
+
+export enum CheckboxOperator {
+  empty = 'EMPTY',
+  is = 'IS',
+  notEmpty = 'NOT_EMPTY',
+}
+
+export enum PicklistOperator {
+  empty = 'EMPTY',
+  isMultiple = 'IS_MULTIPLE',
+  isNotMultiple = 'IS_NOT_MULTIPLE',
+  notEmpty = 'NOT_EMPTY',
+}
+
+export enum RatingOperator {
+  empty = 'EMPTY',
+  greaterThan = 'GT',
+  greaterThanOrEqual = 'GTE',
+  is = 'IS',
+  isNot = 'IS_NOT',
+  lessThan = 'LT',
+  lessThanEqual = 'LTE',
+  notEmpty = 'NOT_EMPTY',
+}
+
+export enum TextOperator {
+  contains = 'CONTAINS',
+  empty = 'EMPTY',
+  endsWith = 'ENDS_WITH',
+  is = 'IS',
+  isNot = 'IS_NOT',
+  notContains = 'NOT_CONTAINS',
+  notEmpty = 'NOT_EMPTY',
+  startsWith = 'STARTS_WITH',
+}
+
+export type SearchResponse<T = any> = {
+  took: number;
+  timed_out: boolean;
+  _scroll_id?: string;
+  _shards: unknown;
+  hits: {
+    total: {
+      value: number;
+      relation: 'eq' | 'gte';
+    };
+    max_score: number;
+    hits: Array<{
+      _index: string;
+      _type: string;
+      _id: string;
+      _score: number;
+      _source?: T;
+      _version?: number;
+      _explanation?: unknown;
+      fields?: any;
+      highlight?: any;
+      inner_hits?: any;
+      matched_queries?: string[];
+      sort?: Array<string | number>;
+    }>;
+  };
+  aggregations?: unknown;
+};
+
+export type FilterTransformer = (
+  filter: Filter<string>
+) => Filter<ElasticsearchOperator> | ComplexFilter<ElasticsearchOperator>;

package/src/types/storage.ts

@@ -0,0 +1,12 @@
+export type UploadInfo = {
+  id: string;
+  uploadUrl: string;
+  downloadUrl: string;
+};
+
+export type GetUploadUrlRequest = {
+  businessEntityId: string;
+  fieldId: string;
+  fileName: string;
+  contentType: string;
+};

package/src/types/tenants.ts

@@ -0,0 +1,14 @@
+import { Region } from '@bisondesk/commons-sdk/lib/types';
+
+export type NewTenant = {
+  country: string;
+  region: Region;
+  name: string;
+  languages: string[];
+  subdomain: string;
+};
+
+export type Tenant = NewTenant & {
+  id: string;
+  subdomain: string;
+};

package/src/types/users.ts

@@ -0,0 +1,15 @@
+import { AttachmentValue, PhoneNumberValue } from './fields';
+
+export type User = {
+  active: boolean;
+  createdAt: string;
+  email: string;
+  firstName: string;
+  id: string;
+  language: string;
+  lastName: string;
+  phone: PhoneNumberValue;
+  picture?: AttachmentValue;
+  roles: string[];
+  updatedAt: string;
+};

package/src/types/utils.ts

@@ -0,0 +1,27 @@
+export type CountryInfo = {
+  code: string; // code is ISO 3166-1 alpha-2
+  name: string;
+  labels: {
+    city: string;
+    state: string;
+    postalCode?: string;
+  };
+  required: {
+    city: boolean;
+    state: boolean;
+    postalCode: boolean;
+  };
+  dialCode: number;
+  currencyCode: string;
+  states?: {
+    [code: string]: string; // code is ISO 3166-2
+  };
+  postalCodeFormat?: string;
+  postalCodeEx?: string;
+};
+
+export type Country = {
+  code: string;
+  name: string;
+  dialCode: number;
+};

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["src"],
+  "compilerOptions": {
+    "composite": true,
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "lib",
+    "rootDir": "src",
+    "sourceMap": true
+  },
+  "references": [{ "path": "../commons-sdk" }]
+}