feat(csi-161): define all interfaces and types

.circleci/config.yml

@@ -25,6 +25,16 @@ defaults_docker_Dependencies: &defaults_docker_Dependencies |
     apk --no-cache add bash bash-doc bash-completion
     npm install -g node-gyp
 
+defaults_machine_Dependencies: &defaults_machine_Dependencies |
+  ## Add Package Repos
+  ## Ref: https://docs.confluent.io/platform/current/installation/installing_cp/deb-ubuntu.html#get-the-software
+  wget -qO - https://packages.confluent.io/deb/7.4/archive.key | sudo apt-key add -
+  sudo add-apt-repository -y "deb https://packages.confluent.io/clients/deb $(lsb_release -cs) main"
+
+  ## Install deps
+  sudo apt install -y curl bash musl-dev libsasl2-dev
+  sudo ln -s /usr/lib/x86_64-linux-musl/libc.so /lib/libc.musl-x86_64.so.1
+
 defaults_awsCliDependencies: &defaults_awsCliDependencies |
     apk --no-cache add aws-cli
 
@@ -41,8 +51,9 @@ defaults_npm_auth: &defaults_npm_auth
 
 defaults_npm_publish_release: &defaults_npm_publish_release
   name: Publish NPM $RELEASE_TAG artifact
-  command: |
+  command: |   
     source $BASH_ENV
+    npm ci
     echo "Publishing tag $RELEASE_TAG"
     npm publish --tag $RELEASE_TAG --access public
 
@@ -240,6 +251,27 @@ jobs:
       - store_test_results:
           path: coverage
 
+  test-integration:
+    executor: default-machine
+    steps:
+      - run:
+          name: Install general dependencies
+          command: *defaults_machine_Dependencies
+      - checkout
+      - run:
+          <<: *defaults_configure_nvm
+      - run:
+          <<: *defaults_display_versions
+      - restore_cache:
+          key: dependency-cache-{{ .Environment.CIRCLE_SHA1 }}
+      - run:
+          name: Execute integration tests
+          command: |
+            docker compose build
+            docker compose up -d
+            npm run test:int
+            docker compose down -v
+
   vulnerability-check:
     executor: default-docker
     steps:
@@ -438,7 +470,7 @@ workflows:
           context: org-global
       - setup:
           context: org-global
-          filters:
+          filters: &BUILD_AND_TEST_FILTERS
             tags:
               only: /.*/
             branches:
@@ -490,6 +522,11 @@ workflows:
               ignore:
                 - /feature*/
                 - /bugfix*/
+      - test-integration:
+          context: org-global
+          requires:
+            - setup
+          filters: *BUILD_AND_TEST_FILTERS
       - vulnerability-check:
           context: org-global
           requires:

.env

@@ -0,0 +1,4 @@
+LOG_LEVEL_PROXY_CACHE=debug
+
+REDIS_HOST=localhost
+REDIS_PORT=6379

.npmignore

@@ -0,0 +1,11 @@
+node_modules/
+npm-debug.log
+
+src/
+test/
+coverage/
+
+jest.config.js
+tsconfig.json
+tsconfig.test.json
+tsup.config.ts

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### [0.3.3](https://github.com/mojaloop/inter-scheme-proxy-cache-lib/compare/v0.3.2...v0.3.3) (2024-06-26)
+
+
+### Chore
+
+* **csi-162:** added BasicProxyCache; hid logger-related types; updated docs ([c3fe557](https://github.com/mojaloop/inter-scheme-proxy-cache-lib/commit/c3fe557a805579d638298401acc5bce23ae9d810))
+
+### [0.3.2](https://github.com/mojaloop/inter-scheme-proxy-cache-lib/compare/v0.3.1-snapshot.1...v0.3.2) (2024-06-26)
+
+
+### Chore
+
+* **csi-162:** updated deps ([20b959f](https://github.com/mojaloop/inter-scheme-proxy-cache-lib/commit/20b959fe72967ddb7fb0a068ae6d178c2755ebbf))

README.md

@@ -1,35 +1,72 @@
-# inter-scheme-proxy-cache-lib
+# @mojaloop/inter-scheme-proxy-cache-lib
 
 `inter-scheme-proxy-cache-lib` is a common component that provides proxy caching mapping.
 It helps reliably integrate proxy functionality throughout the all involved services.
 
-### Use cases:
+## Use cases:
  - Proxy caching. (see [details](https://github.com/infitx-org/uml_diagrams/blob/main/Proxy/Proxy%20pattern%20-%20happy%20path.png))
  - Failure count cache with max failure count per {Id}. (see [details](https://github.com/infitx-org/uml_diagrams/blob/main/Proxy/Proxy%20pattern%20-%20Lazy%20Discovery%20-%20No%20Oracles.png))
 
+## Quick Start
 
-### Install dependencies
+### Installation
 
 ```bash
-npm install
+npm install @mojaloop/inter-scheme-proxy-cache-lib
 ```
 
-## Build
+### Basic Usage
+
+```typescript
+// ESM
+import { createProxyCache, STORAGE_TYPES } from '@mojaloop/inter-scheme-proxy-cache-lib';
+// CJS
+const { createProxyCache } = require('@mojaloop/inter-scheme-proxy-cache-lib');
+
+const proxyCache = createProxyCache(STORAGE_TYPES.redis, { 
+  host: 'localhost',
+  port: 6379,
+  ...
+});
+await proxyCache.addDfspIdToProxyMapping('dfsp_1', 'proxyAB');
+```
+
+### API docs
+Check [_IProxyCache_](https://mojaloop.github.io/inter-scheme-proxy-cache-lib/interfaces/IProxyCache.html) interface docs to get more details.
+
+Comprehensive and interactive API documentation, based on TypeScript source code of the package,
+could be found [**here**](https://mojaloop.github.io/inter-scheme-proxy-cache-lib)
+
+
+### Environment Variables
+| Env Variable Name           | Default Value | Description                        | 
+|-----------------------------|---------------|------------------------------------|
+| LOG_LEVEL_PROXY_CACHE       | `warn`        | The log level for the proxyCache |
+
+
+
+## Development
+
+### Build
 
 Command to transpile Typescript into JS:
 
 ```bash
 npm run build
 ```
 
-## Run
+### Tests
 
 ```bash
-npm start
+npm test
 ```
 
-## Tests
+### Generate Typedoc documentation
 
 ```bash
-npm test
+npm run docs
 ```
+
+## Collaborators
+
+- [Eugen Klymniuk](https://github.com/geka-evk)

docker-compose.yml

@@ -0,0 +1,14 @@
+version: "3.9"
+
+services:
+  redis:
+    image: redis:6.2.4-alpine
+#    image: redis/redis-stack:latest
+    restart: "unless-stopped"
+    environment:
+      - ALLOW_EMPTY_PASSWORD=yes
+      - REDIS_PORT=6379
+      - REDIS_REPLICATION_MODE=master
+      - REDIS_TLS_ENABLED=no
+    ports:
+      - "${REDIS_PORT}:6379"

docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/assets/highlight.css

@@ -0,0 +1,22 @@
+:root {
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --code-background: var(--dark-code-background);
+}
+
+pre, code { background: var(--code-background); }