create-qpq-app 0.1.5

package/template/docusaurus/docs/index.md

@@ -0,0 +1,211 @@
+---
+sidebar_position: 0
+slug: /
+title: Quidproquo - Platform-Agnostic Web Framework
+---
+
+# Quidproquo
+
+A functional, action-based web framework built on generators and pure functions that enables complete execution logging, event replay, and platform-agnostic deployments.
+
+## What is Quidproquo?
+
+Quidproquo (QPQ) is a revolutionary web framework that separates business logic from platform implementation through a unique action/processor pattern. Instead of writing code tied to specific cloud providers or runtime environments, you write pure generator functions ("stories") that yield actions, which are then processed by platform-specific implementations.
+
+### Core Philosophy
+
+At its heart, Quidproquo embraces three fundamental principles:
+
+1. **Pure Functional Composition**: All business logic is expressed as pure generator functions that yield actions and receive results, ensuring deterministic execution and testability.
+
+2. **Platform Abstraction**: Write your application once and deploy it anywhere - AWS Lambda, Node.js servers, browser environments, or any other runtime - without changing your business logic.
+
+3. **Complete Observability**: Every action, decision, and state change is logged, enabling unprecedented debugging capabilities including time-travel debugging and event replay.
+
+### The Problem It Solves
+
+Traditional web frameworks tightly couple your business logic with infrastructure code. When you write an AWS Lambda function, your code is littered with AWS SDK calls. When you need to migrate to Azure or run locally for testing, you face a massive rewrite.
+
+Quidproquo solves this by introducing a layer of abstraction through "actions" - simple, serializable objects that describe what you want to do, not how to do it. The framework handles the "how" through platform-specific action processors.
+
+```typescript
+// Instead of this (platform-specific):
+import { S3Client, GetObjectCommand } from '@aws-sdk/client-s3';
+const s3 = new S3Client();
+const result = await s3.send(new GetObjectCommand({
+  Bucket: 'my-bucket',
+  Key: 'file.txt'
+}));
+
+// You write this (platform-agnostic):
+function* readFile() {
+  const content = yield* askFileReadTextContents('my-drive', 'file.txt');
+  return content;
+}
+```
+
+### Target Audience
+
+Quidproquo is ideal for:
+
+- **Teams building microservices** that need consistent patterns across services
+- **Developers working with serverless** who want better local development and testing
+- **Organizations requiring multi-cloud deployments** without vendor lock-in
+- **Projects needing comprehensive audit logs** and debugging capabilities
+- **Applications requiring event sourcing** or replay functionality
+
+## Why Quidproquo?
+
+### Write Once, Deploy Anywhere
+
+Your business logic remains unchanged whether you deploy to:
+- AWS Lambda functions
+- Google Cloud Functions
+- Azure Functions
+- Traditional Node.js servers
+- Edge computing environments
+- Browser/client-side applications
+
+The same story (generator function) works everywhere - only the action processors change.
+
+### Platform Abstraction Benefits
+
+1. **No Vendor Lock-in**: Switch cloud providers or deployment targets without rewriting your application
+2. **Simplified Testing**: Test your business logic without mocking complex SDK calls
+3. **Local Development**: Run your entire application locally with the dev server, including queues, storage, and databases
+4. **Gradual Migration**: Move services between platforms incrementally
+5. **Cost Optimization**: Deploy different parts of your application to the most cost-effective platforms
+
+### Comparison with Traditional Frameworks
+
+| Traditional Frameworks | Quidproquo |
+|------------------------|------------|
+| Business logic mixed with infrastructure code | Clean separation of concerns |
+| Platform-specific implementations | Platform-agnostic stories |
+| Complex mocking for tests | Pure functions are easily testable |
+| Limited debugging for production issues | Complete execution history and replay |
+| Difficult to migrate between platforms | Same code runs everywhere |
+| Logs show what happened | Logs show what, why, and enable replay |
+
+## Key Features & Benefits
+
+### Complete Execution Logging
+
+Every action your application takes is logged with full context:
+- Input parameters
+- Return values  
+- Execution time
+- Error details
+- Correlation IDs for tracing
+
+This isn't just logging - it's a complete record of your application's execution that can be replayed.
+
+### Event Replay Capability
+
+Reproduce any execution exactly as it happened:
+```typescript
+// Replay a previous execution from logs
+const result = await qpqExecuteLog(
+  executionLog,
+  story,
+  customActionOverrides
+);
+```
+
+This enables:
+- Debugging production issues locally
+- Understanding complex user scenarios
+- Regression testing with real data
+- Audit compliance
+
+### Time-Travel Debugging
+
+Step through any execution action by action:
+- See the exact state at each point
+- Understand decision branches taken
+- Identify where errors occurred
+- Replay with modifications to test fixes
+
+### Deterministic Execution
+
+Generator functions ensure predictable execution:
+- Same inputs always produce same outputs
+- No hidden side effects
+- Easily testable
+- Reproducible across environments
+
+### Platform-Agnostic Architecture
+
+Your application consists of three layers:
+
+1. **Stories** (your business logic) - Platform independent
+2. **Actions** (what to do) - Standardized interfaces
+3. **Processors** (how to do it) - Platform specific
+
+This separation means your business logic never changes, only the processors.
+
+### Generator-Based Composition
+
+Compose complex workflows from simple building blocks:
+```typescript
+function* processOrder(orderId: string) {
+  // Compose multiple actions
+  const order = yield* askKeyValueStoreGet('orders', orderId);
+  const inventory = yield* askCheckInventory(order.items);
+  
+  if (inventory.available) {
+    yield* askQueueSendMessage('fulfillment', order);
+    yield* askEventBusSendMessage('order-confirmed', { orderId });
+  }
+  
+  return { success: inventory.available };
+}
+```
+
+### Pure Functional Approach
+
+- No side effects in business logic
+- Composable and reusable stories
+- Easy to reason about
+- Simple to test
+
+## Use Cases
+
+Quidproquo excels in numerous scenarios, from microservices to serverless applications. [Explore comprehensive use cases →](./use-cases.md)
+
+## Architecture
+
+Dive deep into the architecture that powers Quidproquo's platform independence and observability. [Explore the architecture →](./architecture-overview.md)
+
+## Next Steps
+
+Ready to get started with Quidproquo?
+
+<div className="row">
+  <div className="col col--6">
+    <div className="card">
+      <div className="card__header">
+        <h3>🚀 Quick Start</h3>
+      </div>
+      <div className="card__body">
+        <p>Get up and running in 5 minutes with our quick start guide.</p>
+      </div>
+      <div className="card__footer">
+        <a href="/getting-started" className="button button--primary button--block">Get Started</a>
+      </div>
+    </div>
+  </div>
+  <div className="col col--6">
+    <div className="card">
+      <div className="card__header">
+        <h3>📚 Core Concepts</h3>
+      </div>
+      <div className="card__body">
+        <p>Understand the architecture and patterns that power Quidproquo.</p>
+      </div>
+      <div className="card__footer">
+        <a href="/core-concepts" className="button button--secondary button--block">Learn More</a>
+      </div>
+    </div>
+  </div>
+</div>

package/template/docusaurus/docs/intro.md

@@ -0,0 +1,47 @@
+---
+sidebar_position: 1
+---
+
+# Tutorial Intro
+
+Let's discover **Docusaurus in less than 5 minutes**.
+
+## Getting Started
+
+Get started by **creating a new site**.
+
+Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
+
+### What you'll need
+
+- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
+  - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
+
+## Generate a new site
+
+Generate a new Docusaurus site using the **classic template**.
+
+The classic template will automatically be added to your project after you run the command:
+
+```bash
+npm init docusaurus@latest my-website classic
+```
+
+You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
+
+The command also installs all necessary dependencies you need to run Docusaurus.
+
+## Start your site
+
+Run the development server:
+
+```bash
+cd my-website
+npm run start
+```
+
+The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
+
+The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
+
+Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.

package/template/docusaurus/docs/tutorial-basics/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Tutorial - Basics",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "5 minutes to learn the most important Docusaurus concepts."
+  }
+}

package/template/docusaurus/docs/tutorial-basics/congratulations.md

@@ -0,0 +1,23 @@
+---
+sidebar_position: 6
+---
+
+# Congratulations!
+
+You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
+
+Docusaurus has **much more to offer**!
+
+Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**.
+
+Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)
+
+## What's next?
+
+- Read the [official documentation](https://docusaurus.io/)
+- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config)
+- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration)
+- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
+- Add a [search bar](https://docusaurus.io/docs/search)
+- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
+- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)

package/template/docusaurus/docs/tutorial-basics/create-a-blog-post.md

@@ -0,0 +1,34 @@
+---
+sidebar_position: 3
+---
+
+# Create a Blog Post
+
+Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
+
+## Create your first Post
+
+Create a file at `blog/2021-02-28-greetings.md`:
+
+```md title="blog/2021-02-28-greetings.md"
+---
+slug: greetings
+title: Greetings!
+authors:
+  - name: Joel Marcey
+    title: Co-creator of Docusaurus 1
+    url: https://github.com/JoelMarcey
+    image_url: https://github.com/JoelMarcey.png
+  - name: Sébastien Lorber
+    title: Docusaurus maintainer
+    url: https://sebastienlorber.com
+    image_url: https://github.com/slorber.png
+tags: [greetings]
+---
+
+Congratulations, you have made your first post!
+
+Feel free to play around and edit this post as much as you like.
+```
+
+A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).

package/template/docusaurus/docs/tutorial-basics/create-a-document.md

@@ -0,0 +1,57 @@
+---
+sidebar_position: 2
+---
+
+# Create a Document
+
+Documents are **groups of pages** connected through:
+
+- a **sidebar**
+- **previous/next navigation**
+- **versioning**
+
+## Create your first Doc
+
+Create a Markdown file at `docs/hello.md`:
+
+```md title="docs/hello.md"
+# Hello
+
+This is my **first Docusaurus document**!
+```
+
+A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
+
+## Configure the Sidebar
+
+Docusaurus automatically **creates a sidebar** from the `docs` folder.
+
+Add metadata to customize the sidebar label and position:
+
+```md title="docs/hello.md" {1-4}
+---
+sidebar_label: 'Hi!'
+sidebar_position: 3
+---
+
+# Hello
+
+This is my **first Docusaurus document**!
+```
+
+It is also possible to create your sidebar explicitly in `sidebars.js`:
+
+```js title="sidebars.js"
+export default {
+  tutorialSidebar: [
+    'intro',
+    // highlight-next-line
+    'hello',
+    {
+      type: 'category',
+      label: 'Tutorial',
+      items: ['tutorial-basics/create-a-document'],
+    },
+  ],
+};
+```

package/template/docusaurus/docs/tutorial-basics/create-a-page.md

@@ -0,0 +1,43 @@
+---
+sidebar_position: 1
+---
+
+# Create a Page
+
+Add **Markdown or React** files to `src/pages` to create a **standalone page**:
+
+- `src/pages/index.js` → `localhost:3000/`
+- `src/pages/foo.md` → `localhost:3000/foo`
+- `src/pages/foo/bar.js` → `localhost:3000/foo/bar`
+
+## Create your first React Page
+
+Create a file at `src/pages/my-react-page.js`:
+
+```jsx title="src/pages/my-react-page.js"
+import React from 'react';
+import Layout from '@theme/Layout';
+
+export default function MyReactPage() {
+  return (
+    <Layout>
+      <h1>My React page</h1>
+      <p>This is a React page</p>
+    </Layout>
+  );
+}
+```
+
+A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page).
+
+## Create your first Markdown Page
+
+Create a file at `src/pages/my-markdown-page.md`:
+
+```mdx title="src/pages/my-markdown-page.md"
+# My Markdown page
+
+This is a Markdown page
+```
+
+A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page).

package/template/docusaurus/docs/tutorial-basics/deploy-your-site.md

@@ -0,0 +1,31 @@
+---
+sidebar_position: 5
+---
+
+# Deploy your site
+
+Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
+
+It builds your site as simple **static HTML, JavaScript and CSS files**.
+
+## Build your site
+
+Build your site **for production**:
+
+```bash
+npm run build
+```
+
+The static files are generated in the `build` folder.
+
+## Deploy your site
+
+Test your production build locally:
+
+```bash
+npm run serve
+```
+
+The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/).
+
+You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).

package/template/docusaurus/docs/tutorial-basics/markdown-features.mdx

@@ -0,0 +1,152 @@
+---
+sidebar_position: 4
+---
+
+# Markdown Features
+
+Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**.
+
+## Front Matter
+
+Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/):
+
+```text title="my-doc.md"
+// highlight-start
+---
+id: my-doc-id
+title: My document title
+description: My document description
+slug: /my-custom-url
+---
+// highlight-end
+
+## Markdown heading
+
+Markdown text with [links](./hello.md)
+```
+
+## Links
+
+Regular Markdown links are supported, using url paths or relative file paths.
+
+```md
+Let's see how to [Create a page](/create-a-page).
+```
+
+```md
+Let's see how to [Create a page](./create-a-page.md).
+```
+
+**Result:** Let's see how to [Create a page](./create-a-page.md).
+
+## Images
+
+Regular Markdown images are supported.
+
+You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`):
+
+```md
+![Docusaurus logo](/img/docusaurus.png)
+```
+
+![Docusaurus logo](/img/docusaurus.png)
+
+You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them:
+
+```md
+![Docusaurus logo](./img/docusaurus.png)
+```
+
+## Code Blocks
+
+Markdown code blocks are supported with Syntax highlighting.
+
+````md
+```jsx title="src/components/HelloDocusaurus.js"
+function HelloDocusaurus() {
+  return <h1>Hello, Docusaurus!</h1>;
+}
+```
+````
+
+```jsx title="src/components/HelloDocusaurus.js"
+function HelloDocusaurus() {
+  return <h1>Hello, Docusaurus!</h1>;
+}
+```
+
+## Admonitions
+
+Docusaurus has a special syntax to create admonitions and callouts:
+
+```md
+:::tip My tip
+
+Use this awesome feature option
+
+:::
+
+:::danger Take care
+
+This action is dangerous
+
+:::
+```
+
+:::tip My tip
+
+Use this awesome feature option
+
+:::
+
+:::danger Take care
+
+This action is dangerous
+
+:::
+
+## MDX and React Components
+
+[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**:
+
+```jsx
+export const Highlight = ({children, color}) => (
+  <span
+    style={{
+      backgroundColor: color,
+      borderRadius: '20px',
+      color: '#fff',
+      padding: '10px',
+      cursor: 'pointer',
+    }}
+    onClick={() => {
+      alert(`You clicked the color ${color} with label ${children}`)
+    }}>
+    {children}
+  </span>
+);
+
+This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
+
+This is <Highlight color="#1877F2">Facebook blue</Highlight> !
+```
+
+export const Highlight = ({children, color}) => (
+  <span
+    style={{
+      backgroundColor: color,
+      borderRadius: '20px',
+      color: '#fff',
+      padding: '10px',
+      cursor: 'pointer',
+    }}
+    onClick={() => {
+      alert(`You clicked the color ${color} with label ${children}`);
+    }}>
+    {children}
+  </span>
+);
+
+This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
+
+This is <Highlight color="#1877F2">Facebook blue</Highlight> !

package/template/docusaurus/docs/tutorial-extras/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "Tutorial - Extras",
+  "position": 3,
+  "link": {
+    "type": "generated-index"
+  }
+}

package/template/docusaurus/docs/tutorial-extras/manage-docs-versions.md

@@ -0,0 +1,55 @@
+---
+sidebar_position: 1
+---
+
+# Manage Docs Versions
+
+Docusaurus can manage multiple versions of your docs.
+
+## Create a docs version
+
+Release a version 1.0 of your project:
+
+```bash
+npm run docusaurus docs:version 1.0
+```
+
+The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created.
+
+Your docs now have 2 versions:
+
+- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs
+- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs**
+
+## Add a Version Dropdown
+
+To navigate seamlessly across versions, add a version dropdown.
+
+Modify the `docusaurus.config.js` file:
+
+```js title="docusaurus.config.js"
+export default {
+  themeConfig: {
+    navbar: {
+      items: [
+        // highlight-start
+        {
+          type: 'docsVersionDropdown',
+        },
+        // highlight-end
+      ],
+    },
+  },
+};
+```
+
+The docs version dropdown appears in your navbar:
+
+![Docs Version Dropdown](./img/docsVersionDropdown.png)
+
+## Update an existing version
+
+It is possible to edit versioned docs in their respective folder:
+
+- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello`
+- `docs/hello.md` updates `http://localhost:3000/docs/next/hello`