This commit is contained in:
Garrett Mills 2024-12-24 09:43:23 -05:00
commit 7791baff20
11 changed files with 371 additions and 0 deletions

1
.gitattributes vendored Normal file
View File

@ -0,0 +1 @@
*.lockb binary diff=lockb

175
.gitignore vendored Normal file
View File

@ -0,0 +1,175 @@
# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
# Logs
logs
_.log
npm-debug.log_
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*
# Caches
.cache
# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
# Runtime data
pids
_.pid
_.seed
*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
*.lcov
# nyc test coverage
.nyc_output
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# Bower dependency directory (https://bower.io/)
bower_components
# node-waf configuration
.lock-wscript
# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release
# Dependency directories
node_modules/
jspm_packages/
# Snowpack dependency directory (https://snowpack.dev/)
web_modules/
# TypeScript cache
*.tsbuildinfo
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Optional stylelint cache
.stylelintcache
# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local
# parcel-bundler cache (https://parceljs.org/)
.parcel-cache
# Next.js build output
.next
out
# Nuxt.js build / generate output
.nuxt
dist
# Gatsby files
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public
# vuepress build output
.vuepress/dist
# vuepress v2.x temp and cache directory
.temp
# Docusaurus cache and generated files
.docusaurus
# Serverless directories
.serverless/
# FuseBox cache
.fusebox/
# DynamoDB Local files
.dynamodb/
# TernJS port file
.tern-port
# Stores VSCode versions used for testing VSCode extensions
.vscode-test
# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
# IntelliJ based IDEs
.idea
# Finder (MacOS) folder config
.DS_Store

15
README.md Normal file
View File

@ -0,0 +1,15 @@
# email-comments
To install dependencies:
```bash
bun install
```
To run:
```bash
bun run index.ts
```
This project was created using `bun init` in bun v1.1.42. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.

BIN
bun.lockb Executable file

Binary file not shown.

4
index.ts Normal file
View File

@ -0,0 +1,4 @@
import { config } from "./src/config.ts";
console.log(config)

16
package.json Normal file
View File

@ -0,0 +1,16 @@
{
"name": "email-comments",
"module": "index.ts",
"type": "module",
"devDependencies": {
"@types/bun": "^1.1.14"
},
"peerDependencies": {
"typescript": "^5.0.0"
},
"dependencies": {
"@types/imapflow": "^1.0.19",
"imapflow": "^1.0.171",
"zod": "^3.24.1"
}
}

1
src/bones/index.ts Normal file
View File

@ -0,0 +1 @@
export * from './types'

89
src/bones/types.ts Normal file
View File

@ -0,0 +1,89 @@
/** Type alias for something that may or may not be wrapped in a promise. */
export type Awaitable<T> = T | Promise<T>
/** Type alias for something that may be undefined. */
export type Maybe<T> = T | undefined
export type MaybeArr<T extends [...any[]]> = {
[Index in keyof T]: Maybe<T[Index]>
} & {length: T['length']}
export type Either<T1, T2> = Left<T1> | Right<T2>
export type Left<T> = [T, undefined]
export type Right<T> = [undefined, T]
export function isLeft<T1, T2>(what: Either<T1, T2>): what is Left<T1> {
return typeof what[1] === 'undefined'
}
export function isRight<T1, T2>(what: Either<T1, T2>): what is Right<T2> {
return typeof what[0] === 'undefined'
}
export function left<T>(what: T): Left<T> {
return [what, undefined]
}
export function right<T>(what: T): Right<T> {
return [undefined, what]
}
export function unleft<T>(what: Left<T>): T {
return what[0]
}
export function unright<T>(what: Right<T>): T {
return what[1]
}
/** Type alias for a callback that accepts a typed argument. */
export type ParameterizedCallback<T> = ((arg: T) => any)
/** A key-value form of a given type. */
export type KeyValue<T> = {key: string, value: T}
/** Simple helper method to verify that a key is a keyof some object. */
export function isKeyof<T extends object>(key: unknown, obj: T): key is keyof T {
if ( typeof key !== 'string' && typeof key !== 'symbol' ) {
return false
}
return key in obj
}
/** A typescript-compatible version of Object.hasOwnProperty. */
export function hasOwnProperty<X extends {}, Y extends PropertyKey>(obj: X, prop: Y): obj is X & Record<Y, unknown> { // eslint-disable-line @typescript-eslint/ban-types
return Object.hasOwnProperty.call(obj, prop)
}
/**
* TypeScript helper for creating tagged-types.
*/
export interface TypeTag<S extends string> {
readonly __typeTag: S
}
export type PrefixTypeArray<T, TArr extends unknown[]> = [T, ...TArr]
export type SuffixTypeArray<TArr extends unknown[], T> = [...TArr, T]
export type TypeArraySignature<TArr extends unknown[], TReturn> = (...params: TArr) => TReturn
export type MethodsOf<T, TMethod = (...args: any[]) => any> = {
[K in keyof T]: T[K] extends TMethod ? K : never
}[keyof T]
export type MethodType<TClass, TKey extends keyof TClass, TMethod = (...args: any[]) => any> = {
[K in keyof TClass]: TClass[K] extends TMethod ? TClass[K] : never
}[TKey]
export type Awaited<T> = T extends PromiseLike<infer U> ? U : T
export type Integer = TypeTag<'@extollo/lib.Integer'> & number
export function isInteger(num: number): num is Integer {
return !isNaN(num) && parseInt(String(num), 10) === num
}
export type ArrayElement<ArrayType extends readonly unknown[]> =
ArrayType extends readonly (infer ElementType)[] ? ElementType : never;

20
src/config.ts Normal file
View File

@ -0,0 +1,20 @@
import {castCommentsConfig, type CommentsConfig} from "./types.ts";
const maybeConfig: any = {
mail: {
imap: {
host: process.env.CHORUS_IMAP_HOST,
port: process.env.CHORUS_IMAP_PORT || 993,
auth: {
user: process.env.CHORUS_IMAP_USER,
pass: process.env.CHORUS_IMAP_PASS,
},
},
threads: {
type: 'alias',
template: process.env.CHORUS_THREAD_TEMPLATE,
},
},
}
export const config: CommentsConfig = castCommentsConfig(maybeConfig)

23
src/types.ts Normal file
View File

@ -0,0 +1,23 @@
import {z} from "zod";
const commentsConfigSchema = z.object({
mail: z.object({
imap: z.object({
host: z.string(),
port: z.number({ coerce: true }),
auth: z.object({
user: z.string(),
pass: z.string(),
}),
}),
threads: z.object({
type: z.string(), // fixme : in validation
template: z.string(),
}),
}),
})
export type CommentsConfig = z.infer<typeof commentsConfigSchema>
export const castCommentsConfig = (what: unknown): CommentsConfig => {
return commentsConfigSchema.parse(what)
}

27
tsconfig.json Normal file
View File

@ -0,0 +1,27 @@
{
"compilerOptions": {
// Enable latest features
"lib": ["ESNext", "DOM"],
"target": "ESNext",
"module": "ESNext",
"moduleDetection": "force",
"jsx": "react-jsx",
"allowJs": true,
// Bundler mode
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"verbatimModuleSyntax": true,
"noEmit": true,
// Best practices
"strict": true,
"skipLibCheck": true,
"noFallthroughCasesInSwitch": true,
// Some stricter flags (disabled by default)
"noUnusedLocals": false,
"noUnusedParameters": false,
"noPropertyAccessFromIndexSignature": false
}
}