commit 7791baff20ececf220c62fdeb864e6211951b2d4 Author: garrettmills Date: Tue Dec 24 09:43:23 2024 -0500 Big bang diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..81c05ed --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +*.lockb binary diff=lockb diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9b1ee42 --- /dev/null +++ b/.gitignore @@ -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 diff --git a/README.md b/README.md new file mode 100644 index 0000000..5d3181b --- /dev/null +++ b/README.md @@ -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. diff --git a/bun.lockb b/bun.lockb new file mode 100755 index 0000000..93f63c1 Binary files /dev/null and b/bun.lockb differ diff --git a/index.ts b/index.ts new file mode 100644 index 0000000..9716130 --- /dev/null +++ b/index.ts @@ -0,0 +1,4 @@ + +import { config } from "./src/config.ts"; + +console.log(config) diff --git a/package.json b/package.json new file mode 100644 index 0000000..218b3df --- /dev/null +++ b/package.json @@ -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" + } +} \ No newline at end of file diff --git a/src/bones/index.ts b/src/bones/index.ts new file mode 100644 index 0000000..c9f6f04 --- /dev/null +++ b/src/bones/index.ts @@ -0,0 +1 @@ +export * from './types' diff --git a/src/bones/types.ts b/src/bones/types.ts new file mode 100644 index 0000000..f8399c4 --- /dev/null +++ b/src/bones/types.ts @@ -0,0 +1,89 @@ +/** Type alias for something that may or may not be wrapped in a promise. */ +export type Awaitable = T | Promise + +/** Type alias for something that may be undefined. */ +export type Maybe = T | undefined + +export type MaybeArr = { + [Index in keyof T]: Maybe +} & {length: T['length']} + +export type Either = Left | Right + +export type Left = [T, undefined] + +export type Right = [undefined, T] + +export function isLeft(what: Either): what is Left { + return typeof what[1] === 'undefined' +} + +export function isRight(what: Either): what is Right { + return typeof what[0] === 'undefined' +} + +export function left(what: T): Left { + return [what, undefined] +} + +export function right(what: T): Right { + return [undefined, what] +} + +export function unleft(what: Left): T { + return what[0] +} + +export function unright(what: Right): T { + return what[1] +} + +/** Type alias for a callback that accepts a typed argument. */ +export type ParameterizedCallback = ((arg: T) => any) + +/** A key-value form of a given type. */ +export type KeyValue = {key: string, value: T} + +/** Simple helper method to verify that a key is a keyof some object. */ +export function isKeyof(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(obj: X, prop: Y): obj is X & Record { // eslint-disable-line @typescript-eslint/ban-types + return Object.hasOwnProperty.call(obj, prop) +} + +/** + * TypeScript helper for creating tagged-types. + */ +export interface TypeTag { + readonly __typeTag: S +} + +export type PrefixTypeArray = [T, ...TArr] +export type SuffixTypeArray = [...TArr, T] +export type TypeArraySignature = (...params: TArr) => TReturn + +export type MethodsOf any> = { + [K in keyof T]: T[K] extends TMethod ? K : never +}[keyof T] + +export type MethodType any> = { + [K in keyof TClass]: TClass[K] extends TMethod ? TClass[K] : never +}[TKey] + +export type Awaited = T extends PromiseLike ? 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 (infer ElementType)[] ? ElementType : never; diff --git a/src/config.ts b/src/config.ts new file mode 100644 index 0000000..54afd59 --- /dev/null +++ b/src/config.ts @@ -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) diff --git a/src/types.ts b/src/types.ts new file mode 100644 index 0000000..426d2f3 --- /dev/null +++ b/src/types.ts @@ -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 +export const castCommentsConfig = (what: unknown): CommentsConfig => { + return commentsConfigSchema.parse(what) +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..238655f --- /dev/null +++ b/tsconfig.json @@ -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 + } +}