jaypie 0.1.0 → 0.1.2

package/README.md

@@ -34,7 +34,7 @@ Does NOT use Kubernetes, Docker, Terraform, or the "Serverless" framework.
 
 #### Eject Anything ⏏️
 
-Jaypie embraces "ejectability," the philosophy that any part of the framework can be removed (and therefore replaced) without disturbing the whole.
+Jaypie embraces "ejectability," the philosophy that any part of the code can be removed (and therefore replaced) without disturbing the whole.
 
 #### Mock Everywhere 🎴
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jaypie",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "author": "Finlayson Studio",
   "type": "module",
   "main": "src/index.js",
@@ -12,10 +12,12 @@
     "lint": "eslint .",
     "new": "hygen jaypie vite",
     "test": "vitest",
-    "test:spec:index": "vitest run ./src/__tests__/index.spec.js"
+    "test:spec:dynamicExport.function": "vitest run ./src/__tests__/dynamicExport.function.spec.js",
+    "test:spec:index": "vitest run ./src/__tests__/index.spec.js",
+    "test:spec:mongoose.package": "vitest run ./src/__tests__/mongoose.package.spec.js"
   },
   "dependencies": {
-    "@jaypie/core": "^0.3.3"
+    "@jaypie/core": "^0.4.0"
   },
   "devDependencies": {
     "eslint": "^8.57.0",
@@ -28,5 +30,21 @@
     "prettier": "^3.2.5",
     "sort-package-json": "^2.8.0",
     "vitest": "^1.4.0"
+  },
+  "peerDependencies": {
+    "@jaypie/aws": "^0.1.1",
+    "@jaypie/lambda": "^0.1.1",
+    "@jaypie/mongoose": "^0.1.1"
+  },
+  "peerDependenciesMeta": {
+    "@jaypie/aws": {
+      "optional": true
+    },
+    "@jaypie/lambda": {
+      "optional": true
+    },
+    "@jaypie/mongoose": {
+      "optional": true
+    }
   }
 }

package/src/__tests__/dynamicExport.function.spec.js

@@ -0,0 +1,110 @@
+import {
+  afterEach,
+  beforeAll,
+  beforeEach,
+  describe,
+  expect,
+  it,
+  vi,
+} from "vitest";
+
+// Subject
+import dynamicExport from "../dynamicExport.function.js";
+
+//
+//
+// Mock constants
+//
+
+const MOCK = {
+  MODULE: "mock-module",
+};
+
+//
+//
+// Mock environment
+//
+
+const DEFAULT_ENV = process.env;
+beforeEach(() => {
+  process.env = { ...process.env };
+});
+afterEach(() => {
+  process.env = DEFAULT_ENV;
+  vi.clearAllMocks();
+});
+
+//
+//
+// Run tests
+//
+
+describe("Dynamic Export Function", () => {
+  it("Is a function", () => {
+    expect(dynamicExport).toBeFunction();
+  });
+  describe("Error Handling", () => {
+    it("Throws if exports is not an array", () => {
+      expect(() => dynamicExport({ exports: "string" })).toThrow();
+    });
+    it("Throws if exports is an empty array", () => {
+      expect(() => dynamicExport({ exports: [] })).toThrow();
+    });
+    it("Throws if moduleImport is not a string", () => {
+      expect(() => dynamicExport({ moduleImport: 123 })).toThrow();
+    });
+  });
+  describe("Happy Path", () => {
+    it("Returns an object", () => {
+      expect(dynamicExport({ moduleImport: MOCK.MODULE })).toBeObject();
+    });
+    it("Returns an object with the exports", () => {
+      const exports = ["default", "named"];
+      const result = dynamicExport({ exports, moduleImport: MOCK.MODULE });
+      expect(result).toContainKeys(exports);
+    });
+    it("Returns an object with the exports as functions", () => {
+      const exports = ["default", "named"];
+      const result = dynamicExport({ exports, moduleImport: MOCK.MODULE });
+      expect(result.default).toBeFunction();
+      expect(result.named).toBeFunction();
+    });
+    it("Exported functions throw if the real module is not installed", async () => {
+      const exports = ["default"];
+      const result = dynamicExport({ exports, moduleImport: MOCK.MODULE });
+      await expect(result.default()).rejects.toThrow();
+    });
+  });
+  describe("Features", () => {
+    const mockDefaultFunction = vi.fn();
+    const mockNamedFunction = vi.fn();
+    const mockScalar = "scalar";
+    beforeAll(() => {
+      vi.doMock(MOCK.MODULE, () => {
+        return {
+          default: mockDefaultFunction,
+          named: mockNamedFunction,
+          scalar: mockScalar,
+        };
+      });
+    });
+    it("Calls the default function", async () => {
+      const exports = ["default", "named"];
+      const result = dynamicExport({ exports, moduleImport: MOCK.MODULE });
+      await result.default();
+      expect(mockDefaultFunction).toHaveBeenCalled();
+    });
+    it("Calls the named function", async () => {
+      const exports = ["default", "named"];
+      const result = dynamicExport({ exports, moduleImport: MOCK.MODULE });
+      await result.named();
+      expect(mockNamedFunction).toHaveBeenCalled();
+    });
+    it.todo("Returns the scalar", async () => {
+      const exports = ["scalar"];
+      const result = dynamicExport({ exports, moduleImport: MOCK.MODULE });
+      expect(result.scalar).not.toBeFunction();
+      expect(result.scalar).toBe(mockScalar);
+    });
+  });
+});

package/src/__tests__/mongoose.package.spec.js

@@ -0,0 +1,81 @@
+import {
+  afterEach,
+  beforeAll,
+  beforeEach,
+  describe,
+  expect,
+  it,
+  vi,
+} from "vitest";
+
+// Subject
+import { connectFromSecretEnv, disconnect } from "../mongoose.package.js";
+
+//
+//
+// Mock constants
+//
+
+//
+//
+// Mock modules
+//
+
+//
+//
+// Mock environment
+//
+
+const DEFAULT_ENV = process.env;
+beforeEach(() => {
+  process.env = { ...process.env };
+});
+afterEach(() => {
+  process.env = DEFAULT_ENV;
+  vi.clearAllMocks();
+});
+
+//
+//
+// Run tests
+//
+
+describe("Mongoose Package", () => {
+  it("Works", () => {
+    expect(connectFromSecretEnv).toBeFunction();
+    expect(disconnect).toBeFunction();
+  });
+  describe("Error Handling", () => {
+    it("Throws a configuration error if Mongoose is not installed", async () => {
+      try {
+        await connectFromSecretEnv();
+      } catch (error) {
+        expect(error.isProjectError).toBeTrue();
+      }
+      expect.assertions(1);
+    });
+  });
+  describe("Features", () => {
+    const mockConnectFromSecretEnv = vi.fn();
+    const mockDisconnect = vi.fn();
+    beforeAll(() => {
+      vi.doMock("@jaypie/mongoose", () => {
+        return {
+          connectFromSecretEnv: mockConnectFromSecretEnv,
+          disconnect: mockDisconnect,
+          mongoose: {
+            disconnect: mockDisconnect,
+          },
+        };
+      });
+    });
+    it("Calls @jaypie/mongoose for connectFromSecretEnv", async () => {
+      await connectFromSecretEnv();
+      expect(mockConnectFromSecretEnv).toHaveBeenCalled();
+    });
+    it("Calls @jaypie/mongoose for disconnect", async () => {
+      await disconnect();
+      expect(mockDisconnect).toHaveBeenCalled();
+    });
+  });
+});

package/src/aws.package.js

@@ -0,0 +1,12 @@
+import { JAYPIE } from "@jaypie/core";
+import dynamicExport from "./dynamicExport.function.js";
+
+//
+//
+// Export
+//
+
+export const { getSecret } = dynamicExport({
+  exports: ["getSecret"],
+  moduleImport: JAYPIE.LIB.AWS,
+});

package/src/dynamicExport.function.js

@@ -0,0 +1,55 @@
+import { ConfigurationError, JAYPIE, moduleLogger } from "@jaypie/core";
+
+//
+//
+// Helper Functions
+//
+
+let _importedModule;
+async function dynamicImport(module) {
+  if (!_importedModule) {
+    try {
+      // eslint-disable-next-line import/no-unresolved
+      _importedModule = await import(module);
+    } catch (error) {
+      moduleLogger
+        .with({ lib: JAYPIE.LIB.JAYPIE })
+        .error(`[jaypie] ${module} could not be imported`);
+      if (process.env.NODE_ENV === "test") {
+        if (!_importedModule) {
+          // eslint-disable-next-line no-console
+          console.warn(
+            `[jaypie] Caught error importing ${module} -- Is it installed?`,
+          );
+        }
+        // eslint-disable-next-line no-console
+        console.error(error);
+      }
+      throw new ConfigurationError();
+    }
+  }
+  return _importedModule;
+}
+
+//
+//
+// Main
+//
+
+export default ({ exports = ["default"], moduleImport } = {}) => {
+  // Validate
+  if (Array.isArray(exports) && !exports.length) {
+    throw new ConfigurationError();
+  }
+  if (!moduleImport || typeof moduleImport !== "string") {
+    throw new ConfigurationError();
+  }
+  // Setup
+  return exports.reduce((acc, key) => {
+    acc[key] = async () => {
+      const imported = await dynamicImport(moduleImport);
+      return await imported[key]();
+    };
+    return acc;
+  }, {});
+};

package/src/index.js

@@ -4,3 +4,7 @@
 //
 
 export * from "@jaypie/core";
+
+export * from "./aws.package.js";
+export * from "./lambda.package.js";
+export * from "./mongoose.package.js";

package/src/lambda.package.js

@@ -0,0 +1,12 @@
+import { JAYPIE } from "@jaypie/core";
+import dynamicExport from "./dynamicExport.function.js";
+
+//
+//
+// Export
+//
+
+export const { lambdaHandler } = dynamicExport({
+  exports: ["lambdaHandler"],
+  moduleImport: JAYPIE.LIB.LAMBDA,
+});

package/src/mongoose.package.js

@@ -0,0 +1,12 @@
+import { JAYPIE } from "@jaypie/core";
+import dynamicExport from "./dynamicExport.function.js";
+
+//
+//
+// Export
+//
+
+export const { connectFromSecretEnv, disconnect } = dynamicExport({
+  exports: ["connectFromSecretEnv", "disconnect"],
+  moduleImport: JAYPIE.LIB.MONGOOSE,
+});