init

.github/actions/spelling/README.md

@@ -0,0 +1,5 @@
+# check-spelling/check-spelling configuration
+
+| File                   | Purpose                     | Format                                            | Info                                                                               |
+| ---------------------- | --------------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| [allow.txt](allow.txt) | Add words to the dictionary | one word per line (only letters and `'`s allowed) | [allow](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow) |

.github/actions/spelling/allow.txt

@@ -0,0 +1,3 @@
+isnan
+outstem
+Templating

.github/pull_request_template.md

@@ -0,0 +1,16 @@
+## Purpose
+
+What does this pull request hope to accomplish?
+
+## Screenshot
+
+UI change? Add a screenshot or a gif!
+
+## Acceptance Criteria
+
+- [ ] The user should be able to do ...
+- [ ] Something should occur when ...
+
+## Additional Notes
+
+Any additional notes for developers to give greater context.

.github/workflows/deploy-core.yml

@@ -0,0 +1,30 @@
+name: Core Deployment
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - 'core/**'
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js 14.15
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14.15
+      - name: Install dependencies
+        working-directory: ./core
+        run: yarn install
+      - name: Run production build
+        working-directory: ./core
+        run: yarn run build
+      - name: Push to NPM
+        working-directory: ./core
+        run: |
+          npm version "v1.0.${GITHUB_RUN_NUMBER}"
+          npm publish
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/pull-request-core.yml

@@ -0,0 +1,38 @@
+name: Core Checks
+
+on:
+  pull_request:
+    branches:
+      - master
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test-and-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Uses Node.js 14.17
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14.17
+      - name: Install dependencies
+        working-directory: ./core
+        run: yarn install
+      - name: Run prettier
+        working-directory: ./core
+        run: yarn prettier:check
+      - name: Linter
+        working-directory: ./core
+        run: yarn lint
+      - name: Spell check
+        working-directory: ./core
+        run: npx cspell "**/*.{md,js,ts,tsx}"
+      # - name: Run unit tests
+      #   working-directory: ./core
+      #   run: yarn test
+      - name: Run production build
+        working-directory: ./core
+        run: yarn build

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+echo '-----Core Precommit-----'
+cd ./core && npx lint-staged 

README.md

@@ -1,2 +1,14 @@
 # PDF-Express-Middleware
 Middleware express using react-pdf to generate PDF files
+
+## Project Structure
+
+#### Core
+Core contains the middleware builder and PDF wrapper, as well as the base root context
+
+#### Prebuilt
+Prebuilt contains additional prebuilt middleware that can be used, for example integrating i18Next
+## Hooks
+To set up precommit hooks with husky, run the following\
+`npm install -g husky`\
+`npx husky install .husky`

core/.eslintrc.js

@@ -0,0 +1,136 @@
+const path = require("path");
+
+module.exports = {
+  env: {
+    browser: true,
+    node: true,
+    es2021: true,
+  },
+  extends: [],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: "latest",
+  },
+  plugins: ["react", "no-only-tests", "unused-imports", "prefer-arrow"],
+  overrides: [
+    {
+      files: ["*.ts", "*.tsx"],
+      parserOptions: {
+        sourceType: "module",
+        project: ["./tsconfig.test.json"],
+        tsconfigRootDir: __dirname,
+      },
+      extends: [
+        "eslint:recommended",
+        "plugin:react/recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:eslint-comments/recommended",
+        "prettier", // Make sure this is always last
+      ],
+      rules: {
+        "no-only-tests/no-only-tests": "error",
+        "@typescript-eslint/no-shadow": "error",
+        "@typescript-eslint/no-unused-vars": "error",
+        "eslint-comments/no-unused-disable": "error",
+        "eslint-comments/no-unlimited-disable": "error",
+        "eslint-comments/disable-enable-pair": [
+          "error",
+          { allowWholeFile: true },
+        ],
+        "unused-imports/no-unused-imports": "error",
+        "@typescript-eslint/consistent-type-definitions": "error",
+        "@typescript-eslint/dot-notation": "error",
+        "@typescript-eslint/explicit-member-accessibility": [
+          "off",
+          {
+            accessibility: "explicit",
+          },
+        ],
+        "@typescript-eslint/no-require-imports": "error",
+        "id-blacklist": "off",
+        "id-match": "off",
+        "@typescript-eslint/no-misused-promises": [
+          "error",
+          {
+            checksVoidReturn: false,
+          },
+        ],
+        "no-restricted-properties": [
+          2,
+          {
+            object: "translate",
+            property: "getBrowserLang",
+            message: "Please use userCurrentLang instead.",
+          },
+          {
+            object: "t",
+            property: "getBrowserLang",
+            message: "Please use userCurrentLang instead.",
+          },
+          {
+            object: "translateService",
+            property: "getBrowserLang",
+            message: "Please use userCurrentLang instead.",
+          },
+        ],
+        "no-underscore-dangle": "off",
+        "@typescript-eslint/member-ordering": "off",
+        "jsdoc/newline-after-description": "off",
+        "@typescript-eslint/ban-types": "error",
+        "no-var": "error",
+        "no-shadow": "off",
+        "prefer-arrow/prefer-arrow-functions": "error",
+        "prefer-const": "error",
+        "@typescript-eslint/no-unused-expressions": "error",
+        "use-isnan": "error",
+        "@typescript-eslint/consistent-type-assertions": "error",
+        "@typescript-eslint/naming-convention": [
+          "error",
+          // typeLike (class, interface, typeAlias, enum, typeParameter) should use StrictPascalCase
+          { selector: ["typeLike"], format: ["PascalCase"] },
+          // Destructured variables should have no casing enforced
+          {
+            selector: ["variable"],
+            modifiers: ["destructured"],
+            format: null,
+          },
+          // Stand-alone variables should be camelCase or UPPER_CASE
+          {
+            selector: ["variable"],
+            format: ["camelCase", "UPPER_CASE"],
+          },
+          // Class properties and function parameters are only loosely enforced
+          {
+            selector: ["parameter", "accessor", "typeProperty"],
+            format: ["PascalCase", "snake_case", "camelCase", "UPPER_CASE"],
+            leadingUnderscore: "allow",
+          },
+          // Functions must use camelCase
+          {
+            selector: [
+              "function",
+              "variable",
+              "classMethod",
+              "typeMethod",
+              "classProperty",
+              "typeProperty",
+            ],
+            // PascalCase is needed here for React components
+            format: ["camelCase", "PascalCase"],
+            types: ["function"], // To scope 'parameter', 'classProperty', 'typeProperty' and 'variable'
+            filter: { regex: "toJSON", match: false },
+          },
+        ],
+        "@typescript-eslint/consistent-indexed-object-style": [
+          "error",
+          "record",
+        ],
+      },
+    },
+  ],
+  settings: {
+    react: {
+      version: "detect",
+    },
+  },
+};

core/.gitignore

@@ -0,0 +1,39 @@
+# Dependency directories
+node_modules/
+
+# Optional eslint cache
+.eslintcache
+
+# Yarn Integrity file
+.yarn-integrity
+
+# compiled output
+/deps
+/dist
+
+# dependencies
+/node_modules
+
+# IDE - VSCode
+.vs/*
+.vscode/*
+.editorconfig
+
+# misc
+npm-debug.log
+yarn-error.log
+
+#Cspell Cache
+.cspellcache
+
+# Betterer Cache
+.betterer.cache
+
+# Yarn Berry
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

core/.npmrc

@@ -0,0 +1 @@
+//registry.npmjs.org/:_authToken=${NPM_TOKEN}

core/.yarnrc.yml

@@ -0,0 +1,2 @@
+nodeLinker: node-modules
+yarnPath: .yarn/releases/yarn-3.3.0.cjs

core/README.md

@@ -0,0 +1,75 @@
+## Base Root
+
+For simple usage, a base root context element and it's associated middleware are provided as `BaseRootContext` and `basePDFGenerator`
+
+### Usage
+
+**Certificate Element**
+
+```ts
+import React from "react";
+import { Page, View, Text } from "@react-pdf/renderer";
+
+export const Certificate = ({ name, age }: CertificateProps) => {
+  return (
+    <Page size="A4" orientation="landscape">
+      <View>
+        <Text>
+          {name} - {age}
+        </Text>
+      </View>
+    </Page>
+  );
+};
+```
+
+**Endpoint**
+
+```ts
+import { ProgramCertificate } from "./template";
+import { basePDFGenerator } from "express-react-pdf";
+
+router.get(
+  "/certificate",
+  basePDFGenerator(Certificate, (req) => ({
+    name: req.query.name,
+    age: req.query.age,
+  }))
+);
+```
+
+## Builder
+
+The `pdfMiddlewareBuilder` can be used to create react-pdf middleware for your express server. This supports defining a new root context, as well as how to extract data from your request to populate your root.
+
+### Example - Integrating Other Frameworks
+
+_Note: this will soon be published as a package_
+
+Custom root contexts can be defined to integrate other frameworks, for example the i18Next translation library
+
+**Root Context**
+
+```ts
+export const I18NextRootContext = ({
+  translate,
+  children,
+}: I18NextRootContextProps & PropsWithChildren) => {
+  return (
+    <I18nextProvider i18n={translate}>
+      <Document>{children}</Document>
+    </I18nextProvider>
+  );
+};
+```
+
+**Middleware**
+
+```ts
+export const i18NextPDFMiddleware = pdfMiddlewareBuilder(
+  I18NextRootContext,
+  (req) => ({
+    translate: req.i18n,
+  })
+);
+```

core/cspell.json

@@ -0,0 +1,12 @@
+{
+  "version": "0.2",
+  "ignorePaths": ["./deps"],
+  "dictionaryDefinitions": [
+    {
+      "name": "allow",
+      "path": "../.github/actions/spelling/allow.txt",
+      "addWords": true
+    }
+  ],
+  "dictionaries": ["allow"]
+}