@quietloudlab/ai-interaction-atlas 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 quietloudlab
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,493 @@
+# AI Interaction Atlas
+
+[![npm version](https://img.shields.io/npm/v/@quietloudlab/ai-interaction-atlas)](https://www.npmjs.com/package/@quietloudlab/ai-interaction-atlas)
+[![License](https://img.shields.io/npm/l/@quietloudlab/ai-interaction-atlas)](https://opensource.org/licenses/Apache-2.0)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.0-blue)](https://www.typescriptlang.org/)
+
+A shared language for designing AI experiences across human actions, AI tasks, system operations, data, constraints, and touchpoints.
+
+**100+ interaction patterns** organized into **6 system dimensions** to help you design inspectable, responsible AI systems.
+
+🌐 [**Explore the Atlas**](https://ai-interaction.com) | 📖 [**Documentation**](https://ai-interaction.com/rationale) | 🐙 [**GitHub**](https://github.com/quietloudlab/ai-interaction-atlas)
+
+---
+
+## Why Use This Package?
+
+The AI Interaction Atlas provides structured data for:
+
+- 🤖 **Building AI coding assistants** that understand interaction design patterns
+- 🛠️ **Creating design tools** that reference the taxonomy
+- 📊 **Validating AI workflows** against established patterns
+- 🔍 **Searching patterns programmatically** by keyword or dimension
+- 📝 **Generating documentation** from interaction flows
+- 🧪 **Training and education** with structured AI design patterns
+
+---
+
+## Installation
+
+```bash
+npm install @quietloudlab/ai-interaction-atlas
+```
+
+```bash
+yarn add @quietloudlab/ai-interaction-atlas
+```
+
+```bash
+pnpm add @quietloudlab/ai-interaction-atlas
+```
+
+---
+
+## Quick Start
+
+```typescript
+import {
+  AI_TASKS,
+  HUMAN_TASKS,
+  SYSTEM_TASKS,
+  searchPatterns,
+  getPattern,
+  getAtlasStats
+} from '@quietloudlab/ai-interaction-atlas';
+
+// Get all AI capabilities
+console.log(`${AI_TASKS.length} AI task patterns available`);
+
+// Search for patterns
+const reviewPatterns = searchPatterns('review', { dimensions: ['human'] });
+console.log(reviewPatterns);
+
+// Get a specific pattern by ID
+const classifyTask = getPattern('classify-intent');
+console.log(classifyTask?.description);
+
+// Get Atlas statistics
+const stats = getAtlasStats();
+console.log(`Total patterns: ${stats.total}`);
+```
+
+---
+
+## The Six Dimensions
+
+The Atlas organizes AI interactions into six core dimensions:
+
+| Dimension | Description | Count |
+|-----------|-------------|-------|
+| **AI Tasks** | Probabilistic capabilities (detect, classify, generate, transform) | 45+ |
+| **Human Tasks** | Human actions in the loop (review, approve, configure, decide) | 28+ |
+| **System Tasks** | Infrastructure operations (routing, caching, logging, state) | 31+ |
+| **Data Artifacts** | Information types that flow through the system | 52+ |
+| **Constraints** | Boundaries that shape design (latency, privacy, cost, quality) | 42+ |
+| **Touchpoints** | Where interactions happen (UI, API, voice, AR) | 18+ |
+
+---
+
+## Core Exports
+
+### Data Collections
+
+```typescript
+import {
+  AI_TASKS,           // Array of AI capability patterns
+  HUMAN_TASKS,        // Array of human action patterns
+  SYSTEM_TASKS,       // Array of system operation patterns
+  DATA_ARTIFACTS,     // Array of data type definitions
+  CONSTRAINTS,        // Array of constraint definitions
+  TOUCHPOINTS,        // Array of touchpoint definitions
+  LAYERS,             // Array of processing layer definitions
+  WORKFLOW_TEMPLATES, // Array of pre-built workflow templates
+  EXAMPLES,           // Array of real-world examples
+  ATLAS_DATA          // All data in one object
+} from '@quietloudlab/ai-interaction-atlas';
+```
+
+### Types
+
+```typescript
+import type {
+  AiTask,
+  HumanTask,
+  SystemTask,
+  DataArtifactDefinition,
+  ConstraintDefinition,
+  TouchpointDefinition,
+  Layer,
+  WorkflowTemplate,
+  AtlasData
+} from '@quietloudlab/ai-interaction-atlas';
+```
+
+---
+
+## API Reference
+
+### Search Functions
+
+#### `searchPatterns(query, options?)`
+
+Search across all Atlas patterns by keyword.
+
+```typescript
+import { searchPatterns } from '@quietloudlab/ai-interaction-atlas';
+
+// Search all dimensions
+const results = searchPatterns('review');
+
+// Search specific dimensions
+const humanResults = searchPatterns('review', {
+  dimensions: ['human']
+});
+
+// Case-sensitive search
+const exactMatches = searchPatterns('API', {
+  caseSensitive: true
+});
+
+// Limit results
+const topResults = searchPatterns('generate', {
+  dimensions: ['ai'],
+  limit: 5
+});
+```
+
+**Options:**
+- `dimensions?: Array<'ai' | 'human' | 'system' | 'data' | 'constraints' | 'touchpoints'>` - Dimensions to search (default: all)
+- `caseSensitive?: boolean` - Case sensitive search (default: false)
+- `searchDescription?: boolean` - Search in description field (default: true)
+- `limit?: number` - Limit number of results (default: no limit)
+
+---
+
+#### `getPattern(id)`
+
+Get a specific pattern by ID (slug or target_id).
+
+```typescript
+import { getPattern } from '@quietloudlab/ai-interaction-atlas';
+
+const task = getPattern('classify-intent');
+const artifact = getPattern('embedding');
+const constraint = getPattern('privacy-compliance');
+
+if (task) {
+  console.log(task.name);
+  console.log(task.description);
+  console.log(task.inputs);
+  console.log(task.outputs);
+}
+```
+
+---
+
+#### `getPatternsByDimension(dimension)`
+
+Get all patterns from a specific dimension.
+
+```typescript
+import { getPatternsByDimension } from '@quietloudlab/ai-interaction-atlas';
+
+const aiTasks = getPatternsByDimension('ai');
+const constraints = getPatternsByDimension('constraints');
+```
+
+---
+
+### Filter Functions
+
+#### `filterByLayer(tasks, layerId)`
+
+Filter tasks by processing layer.
+
+```typescript
+import { AI_TASKS, filterByLayer } from '@quietloudlab/ai-interaction-atlas';
+
+const inboundTasks = filterByLayer(AI_TASKS, 'layer_inbound');
+const internalTasks = filterByLayer(AI_TASKS, 'layer_internal');
+```
+
+---
+
+#### `getTasksByLayer(layerId)`
+
+Get all tasks (AI, Human, System) in a specific layer.
+
+```typescript
+import { getTasksByLayer } from '@quietloudlab/ai-interaction-atlas';
+
+const inbound = getTasksByLayer('layer_inbound');
+console.log(inbound.ai);     // AI tasks in inbound layer
+console.log(inbound.human);  // Human tasks in inbound layer
+console.log(inbound.system); // System tasks in inbound layer
+```
+
+---
+
+#### `filterArtifactsByCategory(category)`
+
+Filter data artifacts by category.
+
+```typescript
+import { filterArtifactsByCategory } from '@quietloudlab/ai-interaction-atlas';
+
+const textArtifacts = filterArtifactsByCategory('text');
+const visualArtifacts = filterArtifactsByCategory('visual');
+```
+
+---
+
+#### `getAtlasStats()`
+
+Get statistics about the Atlas.
+
+```typescript
+import { getAtlasStats } from '@quietloudlab/ai-interaction-atlas';
+
+const stats = getAtlasStats();
+console.log(stats);
+// {
+//   ai: 45,
+//   human: 28,
+//   system: 31,
+//   data: 52,
+//   constraints: 42,
+//   touchpoints: 18,
+//   layers: 4,
+//   total: 216
+// }
+```
+
+---
+
+### Validation Functions
+
+#### `isValidTaskId(taskId)`
+
+Check if a task ID exists in the Atlas.
+
+```typescript
+import { isValidTaskId } from '@quietloudlab/ai-interaction-atlas';
+
+if (isValidTaskId('ai_classify_intent')) {
+  console.log('Valid task!');
+}
+```
+
+---
+
+#### `validateWorkflow(nodeIds)`
+
+Validate a workflow design.
+
+```typescript
+import { validateWorkflow } from '@quietloudlab/ai-interaction-atlas';
+
+const result = validateWorkflow([
+  'ai_classify_intent',
+  'human_review_output',
+  'system_log_event'
+]);
+
+if (!result.valid) {
+  console.error('Invalid IDs:', result.invalidIds);
+}
+```
+
+---
+
+#### Type Guards
+
+```typescript
+import { isAiTask, isHumanTask, isSystemTask } from '@quietloudlab/ai-interaction-atlas';
+
+if (isAiTask(someTask)) {
+  // TypeScript knows this is an AiTask
+  console.log(someTask.layer);
+}
+```
+
+---
+
+## Real-World Use Cases
+
+### 1. LLM System Prompt
+
+Include Atlas patterns in your AI assistant's context:
+
+```typescript
+import { AI_TASKS, HUMAN_TASKS } from '@quietloudlab/ai-interaction-atlas';
+
+const systemPrompt = `
+You are an AI workflow designer. Use these interaction patterns from the AI Interaction Atlas:
+
+AI Capabilities:
+${AI_TASKS.map(t => `- ${t.name}: ${t.description}`).join('\n')}
+
+Human Actions:
+${HUMAN_TASKS.map(t => `- ${t.name}: ${t.description}`).join('\n')}
+
+Design workflows that combine these patterns effectively.
+`;
+```
+
+---
+
+### 2. Validate Workflow Designs
+
+Ensure workflows use valid patterns:
+
+```typescript
+import { validateWorkflow, getPattern } from '@quietloudlab/ai-interaction-atlas';
+
+function analyzeWorkflow(nodeIds: string[]) {
+  const validation = validateWorkflow(nodeIds);
+
+  if (!validation.valid) {
+    console.error('Invalid patterns:', validation.invalidIds);
+    return false;
+  }
+
+  // Analyze each node
+  nodeIds.forEach(id => {
+    const pattern = getPattern(id);
+    console.log(`✓ ${pattern?.name}`);
+  });
+
+  return true;
+}
+```
+
+---
+
+### 3. Generate Documentation
+
+Auto-generate workflow documentation:
+
+```typescript
+import { getPattern } from '@quietloudlab/ai-interaction-atlas';
+
+function documentWorkflow(nodeIds: string[]) {
+  const docs = nodeIds.map(id => {
+    const pattern = getPattern(id);
+    if (!pattern) return null;
+
+    return {
+      name: pattern.name,
+      description: pattern.description,
+      inputs: pattern.inputs,
+      outputs: pattern.outputs
+    };
+  }).filter(Boolean);
+
+  return docs;
+}
+```
+
+---
+
+### 4. Build a Pattern Search Tool
+
+Create a CLI tool for exploring patterns:
+
+```typescript
+import { searchPatterns, getAtlasStats } from '@quietloudlab/ai-interaction-atlas';
+
+function searchCLI(query: string) {
+  console.log('Searching Atlas...\n');
+
+  const results = searchPatterns(query);
+
+  console.log(`Found ${results.length} patterns:\n`);
+
+  results.forEach(pattern => {
+    console.log(`- ${pattern.name}`);
+    console.log(`  ${pattern.description}\n`);
+  });
+
+  const stats = getAtlasStats();
+  console.log(`\nAtlas contains ${stats.total} total patterns.`);
+}
+```
+
+---
+
+### 5. Filter by Constraint
+
+Find patterns compatible with specific constraints:
+
+```typescript
+import {
+  AI_TASKS,
+  CONSTRAINTS,
+  filterConstraintsByCategory
+} from '@quietloudlab/ai-interaction-atlas';
+
+// Get all privacy-related constraints
+const privacyConstraints = filterConstraintsByCategory('Quality & Safety');
+
+// Find AI tasks suitable for high-privacy scenarios
+const privateTasks = AI_TASKS.filter(task => {
+  // Your custom logic to check compatibility
+  return task.description.toLowerCase().includes('privacy');
+});
+```
+
+---
+
+## TypeScript Support
+
+This package is written in TypeScript and includes full type definitions.
+
+```typescript
+import type {
+  AiTask,
+  HumanTask,
+  IOSpec,
+  AtlasData
+} from '@quietloudlab/ai-interaction-atlas';
+
+function analyzeTask(task: AiTask) {
+  // Full type safety and autocomplete
+  const inputs: IOSpec | undefined = task.inputs;
+  const outputs: IOSpec | undefined = task.outputs;
+  const layer: string = task.layer;
+}
+```
+
+---
+
+## Bundle Size
+
+- **~220KB** uncompressed
+- **Tree-shakeable** - import only what you need
+- **Zero dependencies** - pure data
+
+---
+
+## License
+
+Apache 2.0 - see [LICENSE](LICENSE) file for details.
+
+---
+
+## About
+
+Created by [Brandon Harwood](https://www.linkedin.com/in/brandon-harwood/) at [quietloudlab](https://quietloudlab.com), a design and research studio specializing in human-centered AI.
+
+---
+
+## Links
+
+- 🌐 [Live Atlas](https://ai-interaction.com)
+- 📖 [Rationale](https://ai-interaction.com/rationale)
+- 🐙 [GitHub Repository](https://github.com/quietloudlab/ai-interaction-atlas)
+- 🐛 [Report Issues](https://github.com/quietloudlab/ai-interaction-atlas/issues)
+
+---
+
+## Contributing
+
+The Atlas is open source and contributions are welcome! See the main repository for contribution guidelines.