@izara_project/izara-core-library-sns 1.0.6 → 1.0.8

package/index.js

@@ -15,16 +15,8 @@ You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-'use strict';
-
 // Import the SnS shared library functions
-const SnsSharedLib = require('./src/SnsSharedLib');
+import snsSharedLib from './src/SnsSharedLib.js';
 
 // Export all the functions
-module.exports = {
-  snsTopicName: SnsSharedLib.snsTopicName,
-  snsTopicArn: SnsSharedLib.snsTopicArn,
-  extractTopicName: SnsSharedLib.extractTopicName,
-  snsTopicNameByFlowSchema: SnsSharedLib.snsTopicNameByFlowSchema,
-  snsTopicArnByFlowSchema: SnsSharedLib.snsTopicArnByFlowSchema
-};
+export default snsSharedLib;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@izara_project/izara-core-library-sns",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Connecting with AWS SNS Resource",
   "main": "index.js",
   "scripts": {
@@ -14,12 +14,11 @@
   "license": "AGPL-3.0-or-later",
   "homepage": "https://bitbucket.org/izara-core-libraries/izara-core-library-sns/src/master/README.md",
   "devDependencies": {
-    "jest": "^29.7.0"
+    "jest": "^30.2.0"
   },
   "jest": {
     "testEnvironment": "node"
   },
-  "dependencies": {
-    "@izara_project/izara-core-library-service-schemas": "^1.0.49"
-  }
+  "type": "module",
+  "dependencies": {}
 }

package/src/SnsSharedLib.js

@@ -15,53 +15,76 @@ You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-'use strict';
-
-// const { getServiceNameWithCache } = require('@izara_project/izara-core-library-service-schemas/src/ServiceConfig')
 /**
- * Generate sns topic name
- * @param {Object} _izContext
- * @param {string} topicName
- * @param {string} serviceTag
+ * Build an SNS topic name for a given logical topic.
  *
- * @returns {string} deployed SNS resource name
+ * The final topic name is constructed by concatenating service tag, stage,
+ * and the provided `topicName`. When `serviceTag` is omitted the current
+ * service (`process.env.iz_serviceTag`) is used.
+ *
+ * @param {Object} _izContext - Izara context object (kept for parity with other helpers).
+ * @param {string} topicName - Logical topic name (e.g. function/event name).
+ * @param {string} [serviceTag=null] - Optional service tag for external services.
+ * @param {string} [stage=null] - Optional stage override (defaults to `process.env.iz_stage`).
+ * @returns {string} The resolved SNS topic name (no ARN).
  */
-module.exports.snsTopicName = async (_izContext, topicName, serviceTag = null) => {
+function snsTopicName(_izContext, topicName, serviceTag = null, stage = null) {
   // concatenate with env stage setting
   // return serviceName + process.env.iz_stage + topicName
 
-  if (!serviceTag) { // for owner service
-    return process.env.iz_serviceTag + process.env.iz_stage + topicName;
-  } else { // create table name for external service
-    return serviceTag + process.env.iz_stage + topicName;
-  }
-}
+  const stageSuffix = stage ? stage : process.env.iz_stage;
+  const serviceTagResolved = serviceTag
+    ? serviceTag
+    : process.env.iz_serviceTag;
 
+  return serviceTagResolved + stageSuffix + topicName;
+}
 
 /**
- * Generate sns topic name
- * @param {Object} _izContext
- * @param {string} topicName
- * @param {string} serviceTag
+ * Build the SNS Topic ARN for a given logical topic name.
  *
- * @returns {string} deployed SNS resource name
+ * The function uses `snsTopicName` to resolve the topic name and then
+ * builds an ARN in the form `arn:aws:sns:{region}:{accountId}:{topicName}`.
+ *
+ * @param {Object} _izContext - Izara context object.
+ * @param {string} topicName - Logical topic name.
+ * @param {string} [serviceTag=null] - Optional service tag for external service topics.
+ * @param {string} [region=null] - Optional AWS region override (defaults to `process.env.iz_region`).
+ * @param {string} [accountId=null] - Optional account override (defaults to `process.env.iz_accountId`).
+ * @param {string} [stage=null] - Optional stage override (defaults to `process.env.iz_stage`).
+ * @returns {string} The SNS topic ARN.
  */
-module.exports.snsTopicArn = async (_izContext, topicName, serviceTag = null) => {
-  const snsTopicArn = await this.snsTopicName(_izContext, topicName, serviceTag)
-  // concatenate with env stage setting
+function snsTopicArn(
+  _izContext,
+  topicName,
+  serviceTag = null,
+  region = null,
+  accountId = null,
+  stage = null
+) {
+  const topic = snsTopicName(_izContext, topicName, serviceTag, stage);
+
+  const actualRegion = region ? region : process.env.iz_region;
+  const actualAccountId = accountId ? accountId : process.env.iz_accountId;
+
   // arn:aws:sns:us-east-1:468568093265:GraphHandlerDevInChangeRelationshipType
-  return await `arn:aws:sns:${process.env.iz_region}:${process.env.iz_accountId}:${snsTopicArn}`
+  return `arn:aws:sns:${actualRegion}:${actualAccountId}:${topic}`;
 }
 
 /**
- * Generate sns topic name
- * @param {string} topicArn
+ * Extract the topic name from an SNS topic ARN.
  *
- * @returns {string} deployed SNS resource name
+ * Example: `arn:aws:sns:us-east-1:123456789012:MyTopic` -> `MyTopic`.
+ * The function returns `null` if the ARN is not in the expected format.
+ *
+ * @param {string} topicArn - Fully-qualified SNS topic ARN.
+ * @returns {string|null} The extracted topic name or `null` if invalid.
  */
-module.exports.extractTopicName = (topicArn) => {
-  let topicName = topicArn.split(":")[5];
-  return topicName
+function extractTopicName(topicArn) {
+  if (typeof topicArn !== 'string') return null;
+  const parts = topicArn.split(':');
+  if (parts.length < 6) return null;
+  return parts[5] || null;
 }
 
 /**
@@ -70,12 +93,16 @@ module.exports.extractTopicName = (topicArn) => {
  * @param {string} topicName
  * @param {string} serviceTag
  */
-module.exports.snsTopicNameByFlowSchema = (_izContext, topicName, serviceTag = null) => {
-  if (!serviceTag) { // for owner service
-    return process.env.iz_serviceTag + "_" + process.env.iz_stage + "_" + topicName;
-  } else { // create table name for external service
-    return serviceTag + "_" + process.env.iz_stage + "_" + topicName;
-  }
+function snsTopicNameByFlowSchema(
+  _izContext,
+  topicName,
+  serviceTag = null,
+  stage = null
+) {
+  const stageSuffix = stage ? stage : process.env.iz_stage;
+  const serviceTagSuffix = serviceTag ? serviceTag : process.env.iz_serviceTag;
+
+  return `${serviceTagSuffix}_${stageSuffix}_${topicName}`;
 }
 
 /**
@@ -86,9 +113,33 @@ module.exports.snsTopicNameByFlowSchema = (_izContext, topicName, serviceTag = n
  *
  * @returns {string} deployed SNS resource name
  */
-module.exports.snsTopicArnByFlowSchema = async (_izContext, topicName, serviceTag = null) => {
-  const snsTopicArn = await this.snsTopicNameByFlowSchema(_izContext, topicName, serviceTag)
+function snsTopicArnByFlowSchema(
+  _izContext,
+  topicName,
+  serviceTag = null,
+  region = null,
+  accountId = null,
+  stage = null
+) {
+  const snsTopicArn = snsTopicNameByFlowSchema(
+    _izContext,
+    topicName,
+    serviceTag,
+    stage
+  );
+
+  const actualRegion = region ? region : process.env.iz_region;
+  const actualAccountId = accountId ? accountId : process.env.iz_accountId;
+
   // concatenate with env stage setting
   // arn:aws:sns:us-east-1:468568093265:GraphHandlerDevInChangeRelationshipType
-  return await `arn:aws:sns:${process.env.iz_region}:${process.env.iz_accountId}:${snsTopicArn}`
-}
+  return `arn:aws:sns:${actualRegion}:${actualAccountId}:${snsTopicArn}`;
+}
+
+export default {
+  snsTopicName,
+  snsTopicArn,
+  extractTopicName,
+  snsTopicNameByFlowSchema,
+  snsTopicArnByFlowSchema
+};