@bisondesk/commons-sdk 1.0.0

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@bisondesk/commons-sdk",
+  "version": "1.0.0",
+  "scripts": {
+    "build": "npx tsc --build",
+    "clean": "rm -rf lib *.tsbuildinfo",
+    "unittest": "echo \"No test specified\"",
+    "integrationtest": "echo \"No test specified\""
+  },
+  "dependencies": {
+    "nanoid": "3.1.22"
+  },
+  "devDependencies": {
+    "@types/nanoid": "2.1.0",
+    "typescript": "4.2.3"
+  }
+}

package/src/constants.ts

@@ -0,0 +1,16 @@
+//
+// STATIC ROLES
+//
+export const ADMINS_ROLE = 'admins';
+
+//
+// CLOUDFORMATION
+//
+export const INFRA_STACK_NAME = 'infra';
+export const RDS_MASTER_SECRET_ID_OUTPUT_NAME = 'RDSMasterSecretId';
+export const RDS_DEFAULT_SECRET_ID_OUTPUT_NAME = 'RDSSecretId';
+
+//
+// I18N
+//
+export const SUPPORTED_LANGUAGES = ['en', 'fr', 'nl'];

package/src/ids.ts

@@ -0,0 +1,36 @@
+import { customAlphabet } from 'nanoid';
+
+export enum Alphabet {
+  Full = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_',
+  Alphanumeric = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz',
+  Lowercase = 'abcdefghijklmnopqrstuvwxyz',
+  LowerAlphanumeric = '0123456789abcdefghijklmnopqrstuvwxyz',
+}
+
+// The ID can contain only alphabets and numbers and underscore.
+// The ID should start with an alphabet and should not have two consecutive underscores or end with an underscore.
+export const generateId = (idLength: number = 15, alphabet: Alphabet = Alphabet.Full): string => {
+  const nanoid = customAlphabet(alphabet, idLength);
+  while (true) {
+    const id = nanoid();
+    if (isValid(id)) {
+      return id;
+    }
+  }
+};
+
+const isValid = (id: string): boolean => {
+  if (!Number.isNaN(Number.parseInt(id[0]))) {
+    return false;
+  }
+
+  if (id.endsWith('_') || id.startsWith('_')) {
+    return false;
+  }
+
+  if (id.includes('__')) {
+    return false;
+  }
+
+  return true;
+};

package/src/types.ts

@@ -0,0 +1,49 @@
+export type PaginatedList<T, M = {}> = {
+  results: T[];
+  totalCount: number;
+  meta: M;
+};
+
+export type Requester = {
+  lang: string;
+  roles: string[];
+  tenantId: string;
+  tenantLang: string;
+  userAgent?: string;
+  sourceIp: string;
+  userId: string;
+  isApi: boolean;
+};
+
+export type Option = {
+  value: string | number;
+  label: string;
+  color?: string;
+};
+
+export enum Region {
+  euWest1 = 'eu-west-1',
+}
+
+export type ErrorResponse = {
+  message?: string;
+  data?: unknown;
+};
+
+export type MultiLangValue = { key?: string } & { [languageCode: string]: string };
+
+export type CognitoInfo = {
+  userPoolId: string;
+  appClientId: string;
+  region: Region;
+};
+
+export enum SortOrder {
+  asc = 'asc',
+  desc = 'desc',
+}
+
+export type SortFilter = {
+  fieldId: string;
+  order: SortOrder;
+};

package/tsconfig.json

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