@ikonintegration/ikapi 4.0.1 → 5.0.0

package/.eslintignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+smoke-tests

package/.eslintrc.cjs

@@ -0,0 +1,81 @@
+/* eslint-env node */
+module.exports = {
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+    'plugin:import/recommended',
+    'plugin:import/typescript',
+    'plugin:require-extensions/recommended',
+  ],
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint', 'prettier', 'require-extensions'],
+  root: true,
+  rules: {
+    'import/extensions': ['error', 'always'],
+    'prettier/prettier': [
+      'error',
+      {
+        tabWidth: 2,
+        useTabs: false,
+        bracketSameLine: false,
+        semi: false,
+        arrowParens: 'avoid',
+        jsxSingleQuote: true,
+        printWidth: 100,
+        singleQuote: true,
+        quoteProps: 'as-needed',
+        htmlWhitespaceSensitivity: 'css',
+        proseWrap: 'preserve',
+        bracketSpacing: true,
+        embeddedLanguageFormatting: 'auto',
+        endOfLine: 'lf',
+        trailingComma: 'es5',
+      },
+    ],
+    '@typescript-eslint/ban-ts-comment': 0,
+    '@typescript-eslint/no-explicit-any': 0,
+    '@typescript-eslint/explicit-member-accessibility': [
+      'error',
+      {
+        accessibility: 'explicit',
+        overrides: {
+          accessors: 'explicit',
+          constructors: 'no-public',
+          methods: 'explicit',
+          properties: 'explicit',
+          parameterProperties: 'explicit',
+        },
+      },
+    ],
+    'lines-between-class-members': [
+      'error',
+      {
+        enforce: [{ blankLine: 'always', prev: 'method', next: 'method' }],
+      },
+    ],
+    // turn on errors for missing imports
+    'import/no-unresolved': ['error', { ignore: ['\\.js$'] }],
+    // 'import/no-named-as-default-member': 'off',
+    'import/order': [
+      'error',
+      {
+        groups: [
+          'builtin', // Built-in imports (come from NodeJS native) go first
+          'external', // <- External imports
+          'internal', // <- Absolute imports
+          ['sibling', 'parent'], // <- Relative imports, the sibling and parent types they can be mingled together
+          'index', // <- index imports
+          'unknown', // <- unknown
+        ],
+        'newlines-between': 'always',
+        alphabetize: {
+          /* sort in ascending order. Options: ["ignore", "asc", "desc"] */
+          order: 'asc',
+          /* ignore case. Options: [true, false] */
+          caseInsensitive: true,
+        },
+      },
+    ],
+  },
+}

package/.github/workflows/npmpublish.yml

@@ -1,22 +1,11 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
-
-name: Node.js Package
-
+name: NPM Publish
 on:
-  release:
-    types: [created]
+  push: 
+    branches: [ "master" ]
 
 jobs:
-  publish-npm:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 18
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish --access='public'
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+  Publish:
+    uses: ikon-integration/tools-github-workflows/.github/workflows/npm-publish.yml@master
+    secrets: inherit
+    with:
+      NODE_VERSION: "20.x"

package/.github/workflows/prs.yml

@@ -0,0 +1,12 @@
+name: PR Checks
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  Checks:
+    uses: ikon-integration/tools-github-workflows/.github/workflows/prs-check.yml@master
+    secrets: inherit
+    with:
+      NODE_VERSION: "20.x"

package/README.md

@@ -1,6 +1,7 @@
 # IKApi ![Node.js Package](https://github.com/ikon-integration/IKApi/workflows/Node.js%20Package/badge.svg)
 Ikon nodejs API foundation
 
+[Docs](https://ikon-integration.github.io/ikapi/)
 
 ### Overall
 
@@ -13,124 +14,113 @@ Ikon nodejs API foundation
 
 - Router
 
-````
-import * as Config from './routes/tenant/config.js';
+```
+import { Router } from '@ikonintegration/ikapi';
+import HealthCheck from './routes/health/get';
 
 const routes = [
-  { route: '/tenant/config', method: 'GET', handler: Config.get },
+  { route: '/health', method: 'GET', handler: HealthCheck.handler },
+  // Additional routes can be added here
 ];
-//Main handler
-export const handler = async (event, context) => {
-  (await (new IKAPI.IKRouter(routes, {
-    database: {
-      type: 'DDB | SQL', -- fallback to DDB if not set
-      //DDB Specific
-      region: IBEWCoreGlobals.DatabaseRegion,
-      tableName: IBEWCoreGlobals.DatabaseTableName,
-      //SQL Specific
-      host: '127.0.0.1', database: 'DB',
-      port: 3307, user: 'root', password: 'IDK'
-    },
-    //Cache
-    cache: {
-      type: 'REDIS',
-      host: '127.0.0.1',
-      password: '22P',
-      user: '22U',
-      enableTLS: true,
-    },
-    //IKValidator
-    validation: {
-      additionalTypes: { TYPE: (val) => { return validate(val); } }
-    },
-    //Logger
-    logger: {
-      //takes precende over process.env.LOG_LEVEL
-      level: 'DEBUG' | 'INFO' | 'WARN' | 'ERROR',
-      enableSensitiveFiltering: false, //defaults to false
-      sensitiveFilteringKeywords: [], //replaced default blacklist set
-    },
-    //Queue
-    publisher: { region: 'SNS-REGION' },
-    //Resources tracker
-    resourcesTracker: { //by default, it will auto track (lambda, ecs, ddb)
-      busName: 'busName',
-      region: 'region',
-      appName: 'appName',
-    }
-  };)).handleEvent(event, context));
-}
-```
-
-- Mailer
 
-```
-const mailer = new IKAPI.IKMailer(LMCoreGlobals.SESSender, LMCoreGlobals.SESRegion);
-```
+export const router = new Router({
+  routes,
+  healthCheckRoute: '/otherHealth',
+  logger: {
+    logLevel: 'DEBUG', // or process.env.LOG_LEVEL
+    sensitiveFilteringKeywords: ['password', 'secret'],
+  },
+});
 
-- Process
+// Handler export
+export const handler = router.getExport();
 
-```
-export const main = async () => {
-  const interval = (Docket.Globals.ExtractorPollerInterval * 1000);
-  console.debug('Using interval of', interval);
-  //init authorization
-  await (new Docket.Core({},  Docket.Globals.AccessLevel.ANY)).authenticate(async (core) => {
-    await (new IKAPI.IKProcess(Docket.Globals.API_Config, interval)).execute( async (process) => {
-      await pull(core);
-    });
-  });
-};
 ```
 
-- Event Process (Queue/SQS)
+- Route
 
 ```
-//Main handler
-export const handler = async (event, context) => {
-  //Start event processor, if any event failed, execution will stop!
-  await (new IKAPI.IKEventProcessor(event, context, Docket.Globals.API_Config)).processEvent( async (transaction, recordContent) => {
-    //init authorization
-    return await (new Docket.Core(transaction,  Docket.Globals.AccessLevel.ANY)).authenticate(async (core) => {
-      core.queue.publishOnTopic(event, Docket.Globals.SNSTopic_ExtractorNotification);
-      return IKAPI.IKSuccessResponse();
-    });
-  });
-};
+import { Response, Route, HttpMethod } from '@ikonintegration/ikapi';
+
+interface GetHealthRoute extends Route<null, { message: string }> {}
+
+export default class HealthCheck implements GetHealthRoute {
+  public path: string = '/health';
+  public method: HttpMethod = HttpMethod.GET;
+  public openApi = {
+    summary: 'System health check',
+    description: 'Returns if the system is healthy or not',
+    tags: ['Health'],
+    security: [],
+  };
+
+  public handler: GetHealthRoute['handler'] = async () => {
+    return new Response({ message: 'System is healthy' });
+  };
+}
 ```
 
+
 - Transaction
 
 ```
+import { Response, ResponseErrorType, Transaction } from '@ikonintegration/ikapi'
+import type { Context, SQSEvent } from 'aws-lambda'
+
+import Core from '../core/Core.js'
+import Globals, { AccessLevel } from '../core/Globals.js'
+
+export type SuccessResponseType = { message: string }
+
 //Main handler
-export const handler = async (event, context) => {
-  //Start event processor, if any event failed, execution will stop!
-  await (new IKAPI.IKTransaction(event, context, Docket.Globals.API_Config)).execute( async (transaction) => {
-    //init authorization
-    return await (new Docket.Core(transaction,  Docket.Globals.AccessLevel.ANY)).authenticate(async (core) => {
-      const queue = event.queue;
-      //Get from specified queue
-      if (!queue) throw new Error(`Empty queue URL! - ${queue}`);
-      //Success :)
-      return IKAPI.IKSuccessResponse();
-    });
-  });
-};
+export const handler = async (event: SQSEvent, context: Context): Promise<void> => {
+  await new Transaction<null, SuccessResponseType | ResponseErrorType>(
+    event,
+    context,
+    Globals.API_Config
+  ).execute(async transaction => {
+    const type = event['eventType']
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    return await new Core(transaction, AccessLevel.PUBLIC).authenticate(async core => {
+      // Schedule
+      if (type == 'SCHEDULE_1') {
+        /* Schedule more message to SQS?*/
+        return Response.SuccessResponse({ message: '213' })
+      }
+
+      return Response.BadRequestResponse('No handler for the specified event type!')
+    })
+  })
+}
+
 ```
 
-- Dynamo Streams
+- Event Processor (SQS)
 
 ```
+import { EventProcessor, Response } from '@ikonintegration/ikapi'
+import type { Context, SQSEvent } from 'aws-lambda'
+
+import Core from '../core/Core.js'
+import Globals, { AccessLevel } from '../core/Globals.js'
+
+export type SuccessResponseType = { message: string }
+
 //Main handler
-export const handler = async (event, context) => {
-  //Start event processor, if any event failed, execution will stop!
-  await (new IKAPI.IKDynamoStream(event, context, Docket.Globals.API_Config)).processEvent( async (transaction, recordContent) => {
-    //Check if is deletion
-    if (!_isDynamoDeletion(recordContent)) return (new IKAPI.IKSuccessNoContentResponse());
-    //init authorization
-    return await (new Docket.Core(transaction,  Docket.Globals.AccessLevel.ANY)).authenticate(async (core) => {
-      return IKAPI.IKSuccessResponse();
-    });
-  });
-};
+export const handler = async (event: SQSEvent, context: Context): Promise<void> => {
+  await new EventProcessor<SuccessResponseType | null>(
+    event,
+    context,
+    Globals.API_Config
+  ).processEvent(async (transaction, recordContent) => {
+    const type = event['eventType'] || recordContent?.['eventType']
+    return await new Core(transaction, AccessLevel.PUBLIC).authenticate(async core => {
+      // Schedule
+      if (type == Globals.EmailEventType.TEMPLATE_EMAIL)
+        return await templateEmailNotification(recordContent, core)
+
+      return Response.BadRequestResponse('No handler for the specified event type!')
+    })
+  })
+}
 ```

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import { HttpMethod } from './src/API/Request.js';
+import Response, { ResponseErrorType } from './src/API/Response.js';
+import DynamoTransaction from './src/BaseEvent/DynamoTransaction.js';
+import EventProcessor from './src/BaseEvent/EventProcessor.js';
+import Process from './src/BaseEvent/Process.js';
+import StepTransaction from './src/BaseEvent/StepTransaction.js';
+import Transaction, { TransactionConfig } from './src/BaseEvent/Transaction.js';
+import Redis from './src/Cache/Redis.js';
+import Configuration from './src/Config/Configuration.js';
+import Crypto from './src/Crypto/Crypto.js';
+import * as Database from './src/Database/index.js';
+import Mailer from './src/Mailer/Mailer.js';
+import Router, { Route } from './src/Server/Router.js';
+import AsyncSingleton from './src/Util/AsyncSingleton.js';
+import Utils from './src/Util/Utils.js';
+export { Transaction, Process, EventProcessor, DynamoTransaction, StepTransaction, Router, Route, HttpMethod, Mailer, Crypto, Configuration, Redis, Database, Response, ResponseErrorType, Utils, AsyncSingleton, TransactionConfig, };

package/dist/index.js

@@ -0,0 +1,27 @@
+import { HttpMethod } from './src/API/Request.js';
+import Response from './src/API/Response.js';
+import DynamoTransaction from './src/BaseEvent/DynamoTransaction.js';
+import EventProcessor from './src/BaseEvent/EventProcessor.js';
+import Process from './src/BaseEvent/Process.js';
+import StepTransaction from './src/BaseEvent/StepTransaction.js';
+import Transaction from './src/BaseEvent/Transaction.js';
+import Redis from './src/Cache/Redis.js';
+import Configuration from './src/Config/Configuration.js';
+import Crypto from './src/Crypto/Crypto.js';
+import * as Database from './src/Database/index.js';
+import Mailer from './src/Mailer/Mailer.js';
+import Router from './src/Server/Router.js';
+import AsyncSingleton from './src/Util/AsyncSingleton.js';
+import Utils from './src/Util/Utils.js';
+export { 
+// Base Events
+Transaction, Process, EventProcessor, DynamoTransaction, StepTransaction, 
+// Http
+Router, HttpMethod, 
+// Modules
+Mailer, Crypto, Configuration, Redis, Database, 
+// API
+Response, 
+// Helpers
+Utils, AsyncSingleton, };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,QAA+B,MAAM,uBAAuB,CAAA;AACnE,OAAO,iBAAiB,MAAM,sCAAsC,CAAA;AACpE,OAAO,cAAc,MAAM,mCAAmC,CAAA;AAC9D,OAAO,OAAO,MAAM,4BAA4B,CAAA;AAChD,OAAO,eAAe,MAAM,oCAAoC,CAAA;AAChE,OAAO,WAAkC,MAAM,gCAAgC,CAAA;AAC/E,OAAO,KAAK,MAAM,sBAAsB,CAAA;AACxC,OAAO,aAAa,MAAM,+BAA+B,CAAA;AACzD,OAAO,MAAM,MAAM,wBAAwB,CAAA;AAC3C,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAA;AACnD,OAAO,MAAM,MAAM,wBAAwB,CAAA;AAC3C,OAAO,MAAiB,MAAM,wBAAwB,CAAA;AACtD,OAAO,cAAc,MAAM,8BAA8B,CAAA;AACzD,OAAO,KAAK,MAAM,qBAAqB,CAAA;AAEvC,OAAO;AACL,cAAc;AACd,WAAW,EACX,OAAO,EACP,cAAc,EACd,iBAAiB,EACjB,eAAe;AACf,OAAO;AACP,MAAM,EAEN,UAAU;AACV,UAAU;AACV,MAAM,EACN,MAAM,EACN,aAAa,EACb,KAAK,EACL,QAAQ;AACR,MAAM;AACN,QAAQ;AAER,UAAU;AACV,KAAK,EACL,cAAc,GAEf,CAAA"}