opticedge-cloud-utils 1.0.2 → 1.0.4

package/dist/db/mongo.d.ts

@@ -0,0 +1,3 @@
+import { Collection, Document } from 'mongodb';
+export declare function connectToMongo(projectId: string, uriSecret: string, dbName: string): Promise<void>;
+export declare function getCollection<T extends Document = Document>(name: string): Collection<T>;

package/dist/db/mongo.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.connectToMongo = connectToMongo;
+exports.getCollection = getCollection;
+const mongodb_1 = require("mongodb");
+const secrets_1 = require("../utils/secrets"); // reuse your secret manager util
+let client;
+let db;
+async function connectToMongo(projectId, uriSecret, dbName) {
+    if (client)
+        return;
+    const uri = await (0, secrets_1.getSecret)(projectId, uriSecret);
+    client = new mongodb_1.MongoClient(uri);
+    await client.connect();
+    db = client.db(dbName); // or pass DB name if needed
+}
+function getCollection(name) {
+    if (!db)
+        throw new Error('Mongo not initialized');
+    return db.collection(name);
+}

package/dist/db/mongo.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/db/mongo.test.js

@@ -0,0 +1,72 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const mongo_1 = require("./mongo");
+const mongodb_1 = require("mongodb");
+const secretsModule = __importStar(require("../utils/secrets"));
+jest.mock('mongodb');
+jest.mock('../utils/secrets');
+const mockDb = {
+    collection: jest.fn(),
+};
+const mockConnect = jest.fn();
+const mockClient = {
+    connect: mockConnect,
+    db: jest.fn().mockReturnValue(mockDb),
+};
+beforeEach(() => {
+    jest.clearAllMocks();
+    secretsModule.getSecret.mockResolvedValue('mongodb://mock-uri');
+    mongodb_1.MongoClient.mockImplementation(() => mockClient);
+});
+describe('Mongo Utils', () => {
+    it('should connect to MongoDB and store client/db', async () => {
+        await (0, mongo_1.connectToMongo)('test-project', 'mongo-uri-secret', 'test-db');
+        expect(secretsModule.getSecret).toHaveBeenCalledWith('test-project', 'mongo-uri-secret');
+        expect(mockConnect).toHaveBeenCalled();
+        expect(mockClient.db).toHaveBeenCalledWith('test-db');
+    });
+    it('should return a collection when db is initialized', async () => {
+        await (0, mongo_1.connectToMongo)('test-project', 'mongo-uri-secret', 'test-db');
+        (0, mongo_1.getCollection)('users');
+        expect(mockDb.collection).toHaveBeenCalledWith('users');
+    });
+    it('should throw error if db is not initialized', () => {
+        jest.isolateModules(() => {
+            const { getCollection } = require('./mongo');
+            expect(() => getCollection('users')).toThrow('Mongo not initialized');
+        });
+    });
+});

package/dist/index.d.ts

@@ -1 +1,3 @@
 export * from './auth/verify';
+export * from './utils/secrets';
+export * from './db/mongo';

package/dist/index.js

@@ -15,3 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./auth/verify"), exports);
+__exportStar(require("./utils/secrets"), exports);
+__exportStar(require("./db/mongo"), exports);

package/dist/utils/secrets.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns the latest value of a Secret Manager secret.
+ *
+ * @param projectId   – GCP project that owns the secret.
+ * @param secretName  – Secret name (without version).
+ * @returns           – UTF-8 string value.
+ */
+export declare function getSecret(projectId: string, secretName: string): Promise<string>;

package/dist/utils/secrets.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSecret = getSecret;
+const secret_manager_1 = require("@google-cloud/secret-manager");
+/**
+ * Returns the latest value of a Secret Manager secret.
+ *
+ * @param projectId   – GCP project that owns the secret.
+ * @param secretName  – Secret name (without version).
+ * @returns           – UTF-8 string value.
+ */
+async function getSecret(projectId, secretName) {
+    if (!projectId)
+        throw new Error('projectId is required');
+    if (!secretName)
+        throw new Error('secretName is required');
+    const secretClient = new secret_manager_1.SecretManagerServiceClient();
+    const [version] = await secretClient.accessSecretVersion({
+        name: `projects/${projectId}/secrets/${secretName}/versions/latest`,
+    });
+    return version.payload?.data?.toString('utf-8') ?? '';
+}

package/dist/utils/secrets.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/secrets.test.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const secrets_1 = require("./secrets");
+const secret_manager_1 = require("@google-cloud/secret-manager");
+jest.mock('@google-cloud/secret-manager');
+// Mock implementation
+const mockAccessSecretVersion = jest.fn();
+secret_manager_1.SecretManagerServiceClient.mockImplementation(() => ({
+    accessSecretVersion: mockAccessSecretVersion,
+}));
+describe('getSecret', () => {
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+    it('returns secret value as string', async () => {
+        mockAccessSecretVersion.mockResolvedValue([
+            {
+                payload: { data: Buffer.from('super-secret-value') },
+            },
+        ]);
+        const result = await (0, secrets_1.getSecret)('test-project', 'test-secret');
+        expect(result).toBe('super-secret-value');
+        expect(mockAccessSecretVersion).toHaveBeenCalledWith({
+            name: 'projects/test-project/secrets/test-secret/versions/latest',
+        });
+    });
+    it('throws if projectId is missing', async () => {
+        await expect((0, secrets_1.getSecret)('', 'secret')).rejects.toThrow('projectId is required');
+    });
+    it('throws if secretName is missing', async () => {
+        await expect((0, secrets_1.getSecret)('project', '')).rejects.toThrow('secretName is required');
+    });
+    it('returns empty string if payload or data is missing', async () => {
+        mockAccessSecretVersion.mockResolvedValue([{}]); // no payload
+        const result = await (0, secrets_1.getSecret)('project', 'secret');
+        expect(result).toBe('');
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opticedge-cloud-utils",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Common utilities for cloud functions",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -13,7 +13,9 @@
   "author": "Evans Musonda",
   "license": "MIT",
   "dependencies": {
-    "google-auth-library": "^9.15.1"
+    "@google-cloud/secret-manager": "^6.0.1",
+    "google-auth-library": "^9.15.1",
+    "mongodb": "^6.16.0"
   },
   "devDependencies": {
     "@google-cloud/functions-framework": "^4.0.0",

package/src/db/mongo.test.ts

@@ -0,0 +1,46 @@
+import { connectToMongo, getCollection } from './mongo';
+import { MongoClient, Db, Collection } from 'mongodb';
+import * as secretsModule from '../utils/secrets';
+
+jest.mock('mongodb');
+jest.mock('../utils/secrets');
+
+const mockDb = {
+  collection: jest.fn(),
+} as unknown as Db;
+
+const mockConnect = jest.fn();
+const mockClient = {
+  connect: mockConnect,
+  db: jest.fn().mockReturnValue(mockDb),
+} as unknown as MongoClient;
+
+beforeEach(() => {
+  jest.clearAllMocks();
+  (secretsModule.getSecret as jest.Mock).mockResolvedValue('mongodb://mock-uri');
+  (MongoClient as unknown as jest.Mock).mockImplementation(() => mockClient);
+});
+
+describe('Mongo Utils', () => {
+  it('should connect to MongoDB and store client/db', async () => {
+    await connectToMongo('test-project', 'mongo-uri-secret', 'test-db');
+
+    expect(secretsModule.getSecret).toHaveBeenCalledWith('test-project', 'mongo-uri-secret');
+    expect(mockConnect).toHaveBeenCalled();
+    expect(mockClient.db).toHaveBeenCalledWith('test-db');
+  });
+
+  it('should return a collection when db is initialized', async () => {
+    await connectToMongo('test-project', 'mongo-uri-secret', 'test-db');
+    getCollection('users');
+
+    expect(mockDb.collection).toHaveBeenCalledWith('users');
+  });
+
+  it('should throw error if db is not initialized', () => {
+    jest.isolateModules(() => {
+    const { getCollection } = require('./mongo');
+    expect(() => getCollection('users')).toThrow('Mongo not initialized');
+  });
+  });
+});

package/src/db/mongo.ts

@@ -0,0 +1,19 @@
+import { MongoClient, Db, Collection, Document } from 'mongodb';
+import { getSecret } from '../utils/secrets'; // reuse your secret manager util
+
+let client: MongoClient;
+let db: Db;
+
+export async function connectToMongo(projectId: string, uriSecret: string, dbName: string) {
+  if (client) return;
+
+  const uri = await getSecret(projectId, uriSecret);
+  client = new MongoClient(uri);
+  await client.connect();
+  db = client.db(dbName); // or pass DB name if needed
+}
+
+export function getCollection<T extends Document = Document>(name: string): Collection<T> {
+  if (!db) throw new Error('Mongo not initialized');
+  return db.collection<T>(name);
+}

package/src/index.ts

@@ -1 +1,3 @@
-export * from './auth/verify';
+export * from './auth/verify';
+export * from './utils/secrets';
+export * from './db/mongo';

package/src/utils/secrets.test.ts

@@ -0,0 +1,44 @@
+import { getSecret } from './secrets';
+import { SecretManagerServiceClient } from '@google-cloud/secret-manager';
+
+jest.mock('@google-cloud/secret-manager');
+
+// Mock implementation
+const mockAccessSecretVersion = jest.fn();
+(SecretManagerServiceClient as unknown as jest.Mock).mockImplementation(() => ({
+  accessSecretVersion: mockAccessSecretVersion,
+}));
+
+describe('getSecret', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('returns secret value as string', async () => {
+    mockAccessSecretVersion.mockResolvedValue([
+      {
+        payload: { data: Buffer.from('super-secret-value') },
+      },
+    ]);
+
+    const result = await getSecret('test-project', 'test-secret');
+    expect(result).toBe('super-secret-value');
+    expect(mockAccessSecretVersion).toHaveBeenCalledWith({
+      name: 'projects/test-project/secrets/test-secret/versions/latest',
+    });
+  });
+
+  it('throws if projectId is missing', async () => {
+    await expect(getSecret('', 'secret')).rejects.toThrow('projectId is required');
+  });
+
+  it('throws if secretName is missing', async () => {
+    await expect(getSecret('project', '')).rejects.toThrow('secretName is required');
+  });
+
+  it('returns empty string if payload or data is missing', async () => {
+    mockAccessSecretVersion.mockResolvedValue([{}]); // no payload
+    const result = await getSecret('project', 'secret');
+    expect(result).toBe('');
+  });
+});

package/src/utils/secrets.ts

@@ -0,0 +1,24 @@
+import { SecretManagerServiceClient } from '@google-cloud/secret-manager';
+
+/**
+ * Returns the latest value of a Secret Manager secret.
+ *
+ * @param projectId   – GCP project that owns the secret.
+ * @param secretName  – Secret name (without version).
+ * @returns           – UTF-8 string value.
+ */
+export async function getSecret(
+  projectId: string,
+  secretName: string
+): Promise<string> {
+  if (!projectId) throw new Error('projectId is required');
+  if (!secretName) throw new Error('secretName is required');
+
+  const secretClient = new SecretManagerServiceClient();
+
+  const [version] = await secretClient.accessSecretVersion({
+    name: `projects/${projectId}/secrets/${secretName}/versions/latest`,
+  });
+
+  return (version.payload?.data as Buffer)?.toString('utf-8') ?? '';
+}