jaypie 0.1.0

package/.eslintrc.cjs

@@ -0,0 +1,40 @@
+module.exports = {
+  root: true,
+  env: {
+    es6: true,
+    node: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "plugin:import/errors",
+    // "Add plugin:prettier/recommended as the last item in the extends array in your .eslintrc* config file, so that eslint-config-prettier has the opportunity to override other configs"
+    "plugin:prettier/recommended",
+  ],
+  overrides: [
+    {
+      files: ["__tests__/**", "**/*.spec.js", "**/*.test.js"],
+      plugins: ["vitest"],
+      extends: ["plugin:vitest/recommended"],
+      rules: {
+        "vitest/no-focused-tests": "error",
+        "vitest/no-disabled-tests": "warn",
+      },
+    },
+    {
+      files: ["*.cjs"],
+      rules: {
+        "import/no-commonjs": "off",
+      },
+    },
+  ],
+  parserOptions: {
+    ecmaVersion: "latest",
+    sourceType: "module",
+  },
+  plugins: ["prettier"],
+  rules: {
+    "import/extensions": ["error", "ignorePackages"],
+    "import/no-commonjs": "error",
+    "no-console": "warn",
+  },
+};

package/.github/workflows/npm-deploy.yml

@@ -0,0 +1,55 @@
+name: NPM Deploy
+
+on:
+  push:
+    tags: 
+      - v*
+
+env:
+  PROJECT_ENV: meta
+  PROJECT_SERVICE: libraries
+
+jobs:
+  deploy:
+    name: NPM Deploy
+    permissions:
+      id-token: write # for aws-actions/configure-aws-credentials
+      contents: read # for actions/checkout
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      - name: NPM Install (`npm install`)
+        run: npm install
+      - name: NPM Deploy
+        run: |
+          npm config set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}
+          npm publish --access public
+  lint:
+    name: Lint (in parallel)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install dependencies
+        run: npm ci
+      - name: Run ESLint
+        run: npm run lint
+        # run: npx eslint . --max-warnings=0
+  test:
+    name: Unit Test (in parallel)
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: |
+        npm test

package/.vscode/settings.json

@@ -0,0 +1,23 @@
+{
+  "cSpell.words": [
+    "certificatemanager",
+    "clonedeep",
+    "composables",
+    "ejectability",
+    "Finlayson",
+    "fontface",
+    "hygen",
+    "iconsets",
+    "initzero",
+    "jaypie",
+    "knowdev",
+    "oidc",
+    "pinia",
+    "roboto",
+    "unplugin",
+    "vendia",
+    "vuekit",
+    "vuetify",
+    "wght"
+  ]
+}

package/README.md

@@ -0,0 +1,69 @@
+# Jaypie 🐦‍⬛
+
+Event-driven fullstack architecture centered around JavaScript, AWS, and the JSON:API specification
+
+"JavaScript on both sides and underneath"
+
+## 🐦‍⬛ Introduction
+
+Jaypie is an opinionated approach to application development centered around JavaScript and the JSON:API specification in an event-driven architecture.
+
+Jaypie is suited for applications that require custom infrastructure beyond HTTP requests (e.g., message queues). Without custom infrastructure, fullstack hosts like Vercel or Netlify are recommended.
+
+### "Jaypie Stack"
+
+* AWS infrastructure managed by CDK in Node.js
+* Express server running on AWS Lambda
+* Node.js worker processes running on AWS Lambda
+* MongoDB via Mongoose
+* Vue ecosystem frontend: Vue 3 composition, Vuetify, Pinia
+* Vitest for testing
+* ES6 syntax enforced via ESLint
+* Prettier formatting
+* JSON logging with custom metadata
+
+### Philosophy
+
+Jaypie is for building fullstack JavaScript applications. 
+
+#### JavaScript Only 💛
+
+Jaypie uses the AWS Cloud Development Kit (CDK) to manage infrastructure, which is written in Node.js. This makes managing infrastructure accessible to the fullstack developer without learning a new syntax and living without language constructs like loops and inheritance.
+
+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.
+
+#### Mock Everywhere 🎴
+
+Jaypie strives to be "mockable-first" meaning all components should be easily tested via default or provided mocks.
+
+## 📋 Usage
+
+### Installation
+
+```bash
+npm install jaypie
+```
+
+TODO: need to document peer dependencies
+
+### Example
+
+TODO: Example should include one trivial and possibly one thorough example of using the library
+
+## 📖 Reference
+
+TODO: Reference should be a complete list of everything in the package
+
+## 📝 Changelog
+
+| Date       | Version | Summary        |
+| ---------- | ------- | -------------- |
+|  3/15/2024 |   0.0.1 | Initial commit |
+
+## 📜 License
+
+Published by Finlayson Studio. All rights reserved

package/_templates/jaypie/hygen/jest.command.ejs.t

@@ -0,0 +1,14 @@
+---
+to: <%= hygen %>/<%= generator %>/<%= action %>/jest.command.ejs.t
+---
+---
+inject: true
+to: package.json
+after: scripts
+skip_if: spec<%- '<' %>%= colonSubspec %<%- '>' %>.+<%- '<' %>%= path %<%- '>' %>/__tests__/<%- '<' %>%= name %<%- '>' %><%- '<' %>%= dotSubtype %<%- '>' %>.spec.js
+sh: |
+  if jq -e '.scripts["format:package"]' package.json <%- '>' %> /dev/null; then
+    npm run format:package 2<%- '>' %> /dev/null || true
+  fi
+---
+    "test:spec<%- '<' %>%= colonSubspec %<%- '>' %>:<%- '<' %>%= name %<%- '>' %><%- '<' %>%= dotSubtype %<%- '>' %>": "vitest run ./<%- '<' %>%= path %<%- '>' %>/__tests__/<%- '<' %>%= name %<%- '>' %><%- '<' %>%= dotSubtype %<%- '>' %>.spec.js",

package/_templates/jaypie/hygen/new.ejs.t

@@ -0,0 +1,31 @@
+---
+to: <%= hygen %>/<%= generator %>/<%= action %>/new.ejs.t
+---
+---
+to: <%- '<' %>%= path %<%- '>' %>/<%- '<' %>%= name %<%- '>' %><%- '<' %>%= dotSubtype %<%- '>' %>.js
+---
+//
+//
+// Constants
+//
+
+//
+//
+// Helper Functions
+//
+
+//
+//
+// Main
+//
+
+const <%- '<' %>%= name %<%- '>' %> = () =<%- '>' %> {
+  //
+};
+
+//
+//
+// Export
+//
+
+export default <%- '<' %>%= name %<%- '>' %>;

package/_templates/jaypie/hygen/prompt.cjs

@@ -0,0 +1,37 @@
+// see types of prompts:
+// https://github.com/enquirer/enquirer/tree/master/examples
+//
+module.exports = [
+  {
+    type: "input",
+    name: "actionInput",
+    message: "Action name (e.g., 'file'):",
+    onSubmit: (name, value, input) => {
+      // Remove leading './' and trailing '/'
+      value = value.replace(/^\.?\/|\/$/g, "");
+      input.state.answers.action = value;
+    },
+  },
+  {
+    type: "input",
+    name: "generatorInput",
+    initial: "project",
+    message: "Hygen generator directory (e.g., 'jaypie'):",
+    onSubmit: (name, value, input) => {
+      // Remove leading './' and trailing '/'
+      value = value.replace(/^\.?\/|\/$/g, "");
+      input.state.answers.generator = value;
+    },
+  },
+  {
+    type: "input",
+    name: "hygenInput",
+    initial: "_templates",
+    message: "Hygen template directory (always '_templates'):",
+    onSubmit: (name, value, input) => {
+      // Remove leading './' and trailing '/'
+      value = value.replace(/^\.?\/|\/$/g, "");
+      input.state.answers.hygen = value;
+    },
+  },
+];

package/_templates/jaypie/hygen/prompt.ejs.t

@@ -0,0 +1,44 @@
+---
+to: <%= hygen %>/<%= generator %>/<%= action %>/prompt.cjs
+---
+// see types of prompts:
+// https://github.com/enquirer/enquirer/tree/master/examples
+//
+module.exports = [
+  {
+    type: "input",
+    name: "pathInput",
+    initial: "src/util",
+    message: "Path (e.g., 'cdk/lib'):",
+    onSubmit: (name, value, input) =<%- '>' %> {
+      input.state.answers.path = value;
+    },
+  },
+  {
+    type: "input",
+    name: "nameInput",
+    message: "File name (e.g., 'sum'):",
+    onSubmit: (name, value, input) =<%- '>' %> {
+      input.state.answers.name = value;
+    },
+  },
+  {
+    type: "input",
+    name: "subtypeInput",
+    message: "Subtype (optional; e.g., 'function'):",
+    onSubmit: (name, value, input) =<%- '>' %> {
+      input.state.answers.subtype = value;
+      input.state.answers.dotSubtype = value ? `.${value}` : "";
+    },
+  },
+  {
+    type: "input",
+    name: "subspecInput",
+    message:
+      "Sub-spec test, for `npm run test:spec:SUBSPEC:sum.function` command (e.g., 'express' or 'lib:project'):",
+    onSubmit: (name, value, input) =<%- '>' %> {
+      input.state.answers.subspec = value;
+      input.state.answers.colonSubspec = value ? `:${value}` : "";
+    },
+  },
+];

package/_templates/jaypie/hygen/test.ejs.t

@@ -0,0 +1,52 @@
+---
+to: <%= hygen %>/<%= generator %>/<%= action %>/test.ejs.t
+---
+---
+to: <%- '<' %>%= path %<%- '>' %>/__tests__/<%- '<' %>%= name %<%- '>' %><%- '<' %>%= dotSubtype %<%- '>' %>.spec.js
+---
+// eslint-disable-next-line no-unused-vars
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+
+// Subject
+import <%- '<' %>%= name %<%- '>' %> from "../<%- '<' %>%= name %<%- '>' %><%- '<' %>%= dotSubtype %<%- '>' %>.js";
+
+//
+//
+// Mock constants
+//
+
+//
+//
+// Mock modules
+//
+
+//
+//
+// Mock environment
+//
+
+const DEFAULT_ENV = process.env;
+beforeEach(() =<%- '>' %> {
+  process.env = { ...process.env };
+});
+afterEach(() =<%- '>' %> {
+  process.env = DEFAULT_ENV;
+});
+
+//
+//
+// Run tests
+//
+
+<%- '<' %>%_ 
+  let Subtype = "";
+  // If subtype is defined, capitalize the first letter
+  if(subtype) Subtype = " " + subtype.charAt(0).toUpperCase() + subtype.slice(1);
+_%<%- '>' %>
+describe("<%- '<' %>%= Name %<%- '>' %><%- '<' %>%= Subtype %<%- '>' %>", () =<%- '>' %> {
+  it("Works", () =<%- '>' %> {
+    const response = <%- '<' %>%= name %<%- '>' %>();
+    console.log("response :<%- '>' %><%- '>' %> ", response);
+    expect(response).not.toBeUndefined();
+  });
+});

package/_templates/jaypie/vite/new.ejs.t

@@ -0,0 +1,28 @@
+---
+to: <%= path %>/<%= name %><%= dotSubtype %>.js
+---
+//
+//
+// Constants
+//
+
+//
+//
+// Helper Functions
+//
+
+//
+//
+// Main
+//
+
+const <%= name %> = () => {
+  //
+};
+
+//
+//
+// Export
+//
+
+export default <%= name %>;

package/_templates/jaypie/vite/prompt.cjs

@@ -0,0 +1,35 @@
+// see types of prompts:
+// https://github.com/enquirer/enquirer/tree/master/examples
+//
+module.exports = [
+  {
+    type: "input",
+    name: "path",
+    initial: "src",
+    message: "Path (e.g., 'src/util' no leading './' or trailing '/'):",
+  },
+  {
+    type: "input",
+    name: "name",
+    message: "File name (e.g., 'sum' not 'sum.function'):",
+  },
+  {
+    type: "input",
+    name: "subtype",
+    message: "Subtype (optional; e.g., 'function'):",
+    onSubmit: (name, value, input) => {
+      // eslint-disable-next-line no-param-reassign
+      input.state.answers.dotSubtype = value ? `.${value}` : "";
+    },
+  },
+  {
+    type: "input",
+    name: "subspec",
+    message:
+      "Sub-spec test, for `npm run test:spec:SUBSPEC:sum.function` command (e.g., 'express'):",
+    onSubmit: (name, value, input) => {
+      // eslint-disable-next-line no-param-reassign
+      input.state.answers.colonSubspec = value ? `:${value}` : "";
+    },
+  },
+];

package/_templates/jaypie/vite/test.ejs.t

@@ -0,0 +1,49 @@
+---
+to: <%= path %>/__tests__/<%= name %><%= dotSubtype %>.spec.js
+---
+// eslint-disable-next-line no-unused-vars
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+
+// Subject
+import <%= name %> from "../<%= name %><%= dotSubtype %>.js";
+
+//
+//
+// Mock constants
+//
+
+//
+//
+// Mock modules
+//
+
+//
+//
+// Mock environment
+//
+
+const DEFAULT_ENV = process.env;
+beforeEach(() => {
+  process.env = { ...process.env };
+});
+afterEach(() => {
+  process.env = DEFAULT_ENV;
+});
+
+//
+//
+// Run tests
+//
+
+<%_
+  let Subtype = "";
+  // If subtype is defined, capitalize the first letter
+  if(subtype) Subtype = " " + subtype.charAt(0).toUpperCase() + subtype.slice(1);
+_%>
+describe("<%= Name %><%= Subtype %>", () => {
+  it("Works", () => {
+    const response = <%= name %>();
+    console.log("response :>> ", response);
+    expect(response).not.toBeUndefined();
+  });
+});

package/_templates/jaypie/vite/vitest.command.ejs.t

@@ -0,0 +1,11 @@
+---
+inject: true
+to: package.json
+after: scripts
+skip_if: spec<%= colonSubspec %>.+<%= path %>/__tests__/<%= name %><%= dotSubtype %>.spec.js
+sh: |
+  if jq -e '.scripts["format:package"]' package.json > /dev/null; then
+    npm run format:package 2> /dev/null || true
+  fi
+---
+    "test:spec<%= colonSubspec %>:<%= name %><%= dotSubtype %>": "vitest run ./<%= path %>/__tests__/<%= name %><%= dotSubtype %>.spec.js",    

package/_templates/jaypie/vitest/jest.command.ejs.t

@@ -0,0 +1,11 @@
+---
+inject: true
+to: package.json
+after: scripts
+skip_if: spec<%= colonSubspec %>.+<%= path %>/__tests__/<%= name %><%= dotSubtype %>.spec.js
+sh: |
+  if jq -e '.scripts["format:package"]' package.json > /dev/null; then
+    npm run format:package 2> /dev/null || true
+  fi
+---
+    "test:spec<%= colonSubspec %>:<%= name %><%= dotSubtype %>": "vitest run ./<%= path %>/__tests__/<%= name %><%= dotSubtype %>.spec.js",

package/_templates/jaypie/vitest/prompt.cjs

@@ -0,0 +1,41 @@
+// see types of prompts:
+// https://github.com/enquirer/enquirer/tree/master/examples
+//
+module.exports = [
+  {
+    type: "input",
+    name: "pathInput",
+    initial: "src",
+    message: "Path (e.g., 'src/util'):",
+    onSubmit: (name, value, input) => {
+      input.state.answers.path = value;
+    },
+  },
+  {
+    type: "input",
+    name: "nameInput",
+    message: "File name (e.g., 'sum'):",
+    onSubmit: (name, value, input) => {
+      input.state.answers.name = value;
+    },
+  },
+  {
+    type: "input",
+    name: "subtypeInput",
+    message: "Subtype (optional; e.g., 'function'):",
+    onSubmit: (name, value, input) => {
+      input.state.answers.subtype = value;
+      input.state.answers.dotSubtype = value ? `.${value}` : "";
+    },
+  },
+  {
+    type: "input",
+    name: "subspecInput",
+    message:
+      "Sub-spec test, for `npm run test:spec:SUBSPEC:sum.function` command (e.g., 'express' or 'lib:project'):",
+    onSubmit: (name, value, input) => {
+      input.state.answers.subspec = value;
+      input.state.answers.colonSubspec = value ? `:${value}` : "";
+    },
+  },
+];

package/_templates/jaypie/vitest/test.ejs.t

@@ -0,0 +1,49 @@
+---
+to: <%= path %>/__tests__/<%= name %><%= dotSubtype %>.spec.js
+---
+// eslint-disable-next-line no-unused-vars
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+
+// Subject
+import <%= name %> from "../<%= name %><%= dotSubtype %>.js";
+
+//
+//
+// Mock constants
+//
+
+//
+//
+// Mock modules
+//
+
+//
+//
+// Mock environment
+//
+
+const DEFAULT_ENV = process.env;
+beforeEach(() => {
+  process.env = { ...process.env };
+});
+afterEach(() => {
+  process.env = DEFAULT_ENV;
+});
+
+//
+//
+// Run tests
+//
+
+<%_ 
+  let Subtype = "";
+  // If subtype is defined, capitalize the first letter
+  if(subtype) Subtype = " " + subtype.charAt(0).toUpperCase() + subtype.slice(1);
+_%>
+describe("<%= Name %><%= Subtype %>", () => {
+  it("Works", () => {
+    const response = <%= name %>();
+    console.log("response :>> ", response);
+    expect(response).not.toBeUndefined();
+  });
+});

package/_templates/jaypie/workflow-npm/npm-deploy.ejs.t

@@ -0,0 +1,58 @@
+---
+to: <%= path %>/<%= name %>.yml
+---
+name: NPM Deploy
+
+on:
+  push:
+    tags: 
+      - v*
+
+env:
+  PROJECT_ENV: meta
+  PROJECT_SERVICE: libraries
+
+jobs:
+  deploy:
+    name: NPM Deploy
+    permissions:
+      id-token: write # for aws-actions/configure-aws-credentials
+      contents: read # for actions/checkout
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      - name: NPM Install (`npm install`)
+        run: npm install
+      - name: NPM Deploy
+        run: |
+          npm config set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}
+          npm publish --access <%= access %>
+  lint:
+    name: Lint (in parallel)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install dependencies
+        run: npm ci
+      - name: Run ESLint
+        run: npm run lint
+        # run: npx eslint . --max-warnings=0
+  test:
+    name: Unit Test (in parallel)
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: |
+        npm test

package/_templates/jaypie/workflow-npm/prompt.cjs

@@ -0,0 +1,32 @@
+// see types of prompts:
+// https://github.com/enquirer/enquirer/tree/master/examples
+//
+module.exports = [
+  {
+    type: "input",
+    name: "accessInput",
+    initial: "public",
+    message: "Access ('public' or 'restricted'):",
+    onSubmit: (name, value, input) => {
+      input.state.answers.access = value;
+    },
+  },
+  {
+    type: "input",
+    name: "pathInput",
+    initial: ".github/workflows",
+    message: "Path (always '.github/workflows'):",
+    onSubmit: (name, value, input) => {
+      input.state.answers.path = value;
+    },
+  },
+  {
+    type: "input",
+    name: "nameInput",
+    initial: "npm-deploy",
+    message: "File name, no extension (always 'npm-deploy'):",
+    onSubmit: (name, value, input) => {
+      input.state.answers.name = value;
+    },
+  },
+];

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "jaypie",
+  "version": "0.1.0",
+  "author": "Finlayson Studio",
+  "type": "module",
+  "main": "src/index.js",
+  "scripts": {
+    "format": "npm run format:package && npm run format:lint",
+    "format:lint": "eslint --fix .",
+    "format:package": "sort-package-json ./package.json",
+    "init:deploy": "hygen jaypie workflow-npm",
+    "lint": "eslint .",
+    "new": "hygen jaypie vite",
+    "test": "vitest",
+    "test:spec:index": "vitest run ./src/__tests__/index.spec.js"
+  },
+  "dependencies": {
+    "@jaypie/core": "^0.3.3"
+  },
+  "devDependencies": {
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-vitest": "^0.3.26",
+    "hygen": "^6.2.11",
+    "jest-extended": "^4.0.2",
+    "prettier": "^3.2.5",
+    "sort-package-json": "^2.8.0",
+    "vitest": "^1.4.0"
+  }
+}

package/src/__tests__/index.spec.js

@@ -0,0 +1,41 @@
+// eslint-disable-next-line no-unused-vars
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+
+// Subject
+import { PROJECT } from "../index.js";
+
+//
+//
+// Mock constants
+//
+
+//
+//
+// Mock modules
+//
+
+//
+//
+// Mock environment
+//
+
+const DEFAULT_ENV = process.env;
+beforeEach(() => {
+  process.env = { ...process.env };
+});
+afterEach(() => {
+  process.env = DEFAULT_ENV;
+});
+
+//
+//
+// Run tests
+//
+
+describe("Index", () => {
+  it("Works", () => {
+    expect(PROJECT).not.toBeUndefined();
+    expect(PROJECT.SPONSOR).not.toBeUndefined();
+    expect(PROJECT.SPONSOR.JAYPIE).toBeString();
+  });
+});

package/src/index.js

@@ -0,0 +1,6 @@
+//
+//
+// Export
+//
+
+export * from "@jaypie/core";

package/testSetup.js

@@ -0,0 +1,3 @@
+import { expect } from "vitest";
+import * as matchers from "jest-extended";
+expect.extend(matchers);

package/vite.config.js

@@ -0,0 +1,10 @@
+/// <reference types="vitest" />
+
+import { defineConfig } from "vite";
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  test: {
+    setupFiles: ["./testSetup.js"],
+  },
+});