Merge pull request #10 from contentstack/feature/OAA-2926-master

feat: adding tls capability on epicurou

Author: Ilan-kumaran

.github/workflows/publish-epicurus-package.yml

@@ -0,0 +1,39 @@
+name: Publish Epicurus Package
+
+on:
+  push:
+    branches:
+      - main
+    
+jobs:
+    build:
+      runs-on: ubuntu-latest
+      steps:
+        - name: Checkout repository
+          uses: actions/checkout@v3
+
+        - name: Set up Node.js
+          uses: actions/setup-node@v3
+          with:
+            node-version: 20
+            cache: 'npm'
+        
+        - name: Authenticate to Github Package Registry
+          env:
+            NODE_AUTH_TOKEN: ${{ secrets.PKG_TOKEN }}
+          run: |
+            echo "@contentstack:registry=https://npm.pkg.github.com" >> ~/.npmrc 
+            echo "//npm.pkg.github.com/:_authToken=${ NODE_AUTH_TOKEN}" > ~/.npmrc
+
+        - name: Install dependencies
+          run: npm install
+
+        - name: Build the package
+          run: npm run compile
+
+        - name: Publish to Github Package Registry
+          env:
+            NODE_AUTH_TOKEN: ${{ secrets.PKG_TOKEN }}
+          run: |
+            echo "Publishing Epicurus package to GitHub Package Registry..."
+            npm publish --registry=https://npm.pkg.github.com

.gitignore

@@ -1,2 +1,2 @@
 node_modules
-js
+.idea

.snyk

@@ -0,0 +1,10 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.25.0
+# ignores vulnerabilities until expiry date; change duration by modifying expiry date
+ignore:
+  SNYK-JS-REDIS-1255645:
+    - '*':
+        reason: 'High Severity - https://contentstack.atlassian.net/browse/IS-1224'
+        expires: 2025-06-15T05:52:48.301Z
+        created: 2025-05-15T05:52:48.306Z
+patch: {}

.talismanrc

@@ -2,4 +2,6 @@ fileignoreconfig:
 - filename: .github/workflows/secrets-scan.yml
   ignore_detectors:
     - filecontent
+- filename: package-lock.json
+  checksum: 52fe445de22ff337ecbd1dd7731cf738777f4f9f95a81ff7fbe087d851902b42
 version: "1.0"

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 ABX
+Copyright (c) 2018-2025 ABX
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

SECURITY.md

@@ -0,0 +1,25 @@
+
+Security
+Contentstack takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations.
+
+If you believe you have found a security vulnerability in any Contentstack-owned repository, please report it to us as described below.
+
+Reporting Security Issues
+Please do not report security vulnerabilities through public GitHub issues.
+
+Send email to [email protected].
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message.
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+Full paths of source file(s) related to the manifestation of the issue
+The location of the affected source code (tag/branch/commit or direct URL)
+Any special configuration required to reproduce the issue
+Step-by-step instructions to reproduce the issue
+Proof-of-concept or exploit code (if possible)
+Impact of the issue, including how an attacker might exploit the issue
+This information will help us triage your report more quickly.
+
+https://www.contentstack.com/trust/

js/config.d.ts

@@ -0,0 +1,3 @@
+export declare const config: {
+    requestValidityPeriod: number;
+};

js/config.js

@@ -0,0 +1,13 @@
+import { RedisClient } from 'redis';
+import { EpicurusRedisConfig, serverCallback, subscribeCallback } from './interface';
+export default function Epicurus(redisConfig?: EpicurusRedisConfig, requestTimeout?: number): EpicurusPublicInterface;
+export declare type EpicurusPublicInterface = {
+    getRedisClient: () => RedisClient;
+    getRedisSubClient: () => RedisClient;
+    subscribe: <T = any>(channel: string, callback: subscribeCallback<T>) => Promise<void>;
+    publish: (channel: string, body: any) => void;
+    server: <T = any, S = any>(channel: string, callback: serverCallback<T, S>) => Promise<void>;
+    request: <T = any>(channel: string, body: any) => Promise<T>;
+    shutdown: () => void;
+    close: () => void;
+};