Merge pull request #2 from GSA-TTS/architecture

Architecture diagram for discussion

apps/cli/tsconfig.json

@@ -4,6 +4,8 @@
     "outDir": "./dist",
     "emitDeclarationOnly": true
   },
-  "include": ["./src"],
+  "include": [
+    "./src"
+  ],
   "references": []
 }

apps/frontend/package.json

@@ -10,6 +10,7 @@
     "test": "vitest"
   },
   "dependencies": {
+    "@atj/docassemble": "workspace:*",
     "@atj/documents": "workspace:*",
     "@atj/interviews": "workspace:*",
     "@axe-core/playwright": "^4.7.3",

apps/frontend/src/index.ts

@@ -1,3 +1,7 @@
 import { createAppRoot } from './views/main';
 
-createAppRoot(document.getElementById('root') as HTMLElement, {});
+createAppRoot(document.getElementById('root') as HTMLElement, {
+  backend: {
+    helloWorld: (str: string) => str,
+  },
+});

packages-python/docassemble-server/docker-compose.yml

@@ -0,0 +1,25 @@
+version: '3'
+
+services:
+  web:
+    image: jhpyle/docassemble
+    ports:
+      - '8011:80'
+    volumes:
+      - data:/usr/share/docassemble/data
+      - log:/usr/share/docassemble/log
+      - config:/usr/share/docassemble/config
+      - webapp:/usr/share/docassemble/webapp
+  redis:
+    image: 'redis:latest'
+  postgres:
+    image: 'postgres:latest'
+    environment:
+      POSTGRES_DB: docassemble
+      POSTGRES_USER: docassemble
+      POSTGRES_PASSWORD: secret-password
+volumes:
+  data:
+  log:
+  config:
+  webapp:

packages/docassemble/.gitignore

@@ -0,0 +1 @@
+.env

packages/docassemble/README.md

@@ -0,0 +1,11 @@
+# @atj/docassemble
+
+This package is the home for adapters that leverage [docassemble](https://docassemble.org/).
+
+## Development
+
+Run tests with coverage:
+
+```bash
+pnpm test
+```

packages/docassemble/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@atj/docassemble",
+  "version": "1.0.0",
+  "description": "10x ATJ docassemble adapter",
+  "license": "CC0",
+  "main": "src/index.ts",
+  "scripts": {
+    "build": "tsup src/* --env.NODE_ENV production",
+    "test": "vitest run --coverage"
+  },
+  "dependencies": {
+    "@atj/documents": "workspace:*",
+    "@atj/interviews": "workspace:*"
+  },
+  "devDependencies": {
+    "vitest": "^0.34.4"
+  }
+}

packages/docassemble/src/client.test.ts

@@ -0,0 +1,11 @@
+import { describe, expect, it } from 'vitest';
+import { createTestDocassembleClient } from './context/test';
+
+describe('docassemble api client', () => {
+  const client = createTestDocassembleClient();
+
+  it('returns a list of interviews', async () => {
+    const interviews = await client.getInterviews();
+    expect(interviews).not.toEqual(null);
+  });
+});

packages/docassemble/src/client.ts

@@ -0,0 +1,33 @@
+import { DocassembleInterview } from './types';
+
+export const createDocassembleInterview = (interviewId: string) => {};
+
+export type DocassembleClientContext = {
+  apiUrl: string;
+  apiKey: string;
+};
+
+export class DocassembleClient {
+  constructor(private ctx: DocassembleClientContext) {}
+
+  getInterviews = () => {
+    return fetch(`${this.ctx.apiUrl}/api/interviews`, {
+      headers: {
+        'X-API-Key': this.ctx.apiKey,
+      },
+    })
+      .then(response => response.json())
+      .then(data => {
+        return {
+          ok: true,
+          interviews: data.items as DocassembleInterview[],
+        };
+      })
+      .catch(error => {
+        return {
+          ok: false,
+          error: error.message,
+        };
+      });
+  };
+}

packages/docassemble/src/context/index.ts

@@ -0,0 +1,5 @@
+import { DocassembleClient, type DocassembleClientContext } from '../client';
+
+export const createDocassembleClient = (ctx: DocassembleClientContext) => {
+  return new DocassembleClient(ctx);
+};

packages/docassemble/src/context/test.ts

@@ -0,0 +1,8 @@
+import { createDocassembleClient } from '.';
+
+export const createTestDocassembleClient = () => {
+  return createDocassembleClient({
+    apiUrl: 'http://localhost:8011',
+    apiKey: (import.meta as any).env.VITE_DOCASSEMBLE_API_KEY || '',
+  });
+};

packages/docassemble/src/types.ts

@@ -0,0 +1,21 @@
+// Guessing at the types here, based on the JSON returned by the API.
+export type DocassembleInterview = {
+  email: string;
+  filename: string;
+  metadata: {
+    _origin_package: string;
+    _origin_path: string;
+    title: string;
+  };
+  modtime: string;
+  session: string;
+  starttime: string;
+  subtitle: string | null;
+  tags: string[];
+  temp_user_id: string | null;
+  title: string;
+  user_id: number;
+  utc_modtime: string;
+  utc_starttime: string | null;
+  valid: boolean;
+};

packages/docassemble/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "emitDeclarationOnly": true
+  },
+  "include": [
+    "./src"
+  ],
+  "references": []
+}