Update README.md to provide a comprehensive overview of The Order monorepo, including repository structure, quickstart guide, development workflow, and contribution guidelines.
This commit is contained in:
7
packages/workflows/src/index.ts
Normal file
7
packages/workflows/src/index.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
/**
|
||||
* The Order Workflows Package
|
||||
*/
|
||||
|
||||
export * from './intake';
|
||||
export * from './review';
|
||||
|
||||
28
packages/workflows/src/intake.ts
Normal file
28
packages/workflows/src/intake.ts
Normal file
@@ -0,0 +1,28 @@
|
||||
/**
|
||||
* Intake workflow definitions
|
||||
*/
|
||||
|
||||
export interface IntakeWorkflowInput {
|
||||
documentId: string;
|
||||
fileUrl: string;
|
||||
userId: string;
|
||||
}
|
||||
|
||||
export interface IntakeWorkflowOutput {
|
||||
documentId: string;
|
||||
processed: boolean;
|
||||
classification: string;
|
||||
extractedData?: unknown;
|
||||
}
|
||||
|
||||
/**
|
||||
* Intake workflow: ingestion → OCR → classify → route
|
||||
*/
|
||||
export async function intakeWorkflow(
|
||||
input: IntakeWorkflowInput
|
||||
): Promise<IntakeWorkflowOutput> {
|
||||
// Implementation using Temporal or Step Functions
|
||||
// This is a placeholder structure
|
||||
throw new Error('Not implemented');
|
||||
}
|
||||
|
||||
28
packages/workflows/src/review.ts
Normal file
28
packages/workflows/src/review.ts
Normal file
@@ -0,0 +1,28 @@
|
||||
/**
|
||||
* Review workflow definitions
|
||||
*/
|
||||
|
||||
export interface ReviewWorkflowInput {
|
||||
documentId: string;
|
||||
reviewerId: string;
|
||||
workflowType: 'legal' | 'finance' | 'compliance';
|
||||
}
|
||||
|
||||
export interface ReviewWorkflowOutput {
|
||||
documentId: string;
|
||||
approved: boolean;
|
||||
comments?: string;
|
||||
nextStep?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Review workflow: document review → approval → publish
|
||||
*/
|
||||
export async function reviewWorkflow(
|
||||
input: ReviewWorkflowInput
|
||||
): Promise<ReviewWorkflowOutput> {
|
||||
// Implementation using Temporal or Step Functions
|
||||
// This is a placeholder structure
|
||||
throw new Error('Not implemented');
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user