@wix/auto-patterns 1.33.0 → 1.34.0

package/docs/GETTING_STARTED.md

@@ -0,0 +1,98 @@
+# Getting Started
+*Build your first dashboard page on Patterns using Cursor.*
+
+## Library Installations
+Run the following command to install the library and its peer dependencies:
+```bash
+yarn add @wix/auto-patterns @wix/patterns @wix/design-system react-router-dom
+```
+
+## MCP Installations
+
+* [Install Business Schema MCP in Cursor](cursor://anysphere.cursor-deeplink/mcp/install?name=business-schema&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyJAd2l4L2J1c2luZXNzLXNjaGVtYS1tY3AiXX0%3D)
+* [Install Auto Patterns MCP in Cursor](cursor://anysphere.cursor-deeplink/mcp/install?name=auto-patterns&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyJAd2l4L2F1dG8tcGF0dGVybnMtbWNwIl19)
+
+## Working with Auto Patterns
+A typical usage of Auto Patterns is to render a `AutoPatternsApp` component with a configuration object. You don't need to do it manually, but generate it through Cursor's chat.
+You can write a prompt like this:
+```
+I want a dashboard page for sessions, use wix.bookings.v1.sessions fqdn for that.
+```
+
+Then Cursor will retrieve the schema for the `wix.bookings.v1.sessions` FQDN and create an Auto Patterns configuration with custom data source.
+
+Then, you can run your app and see the results.
+According to the results, you can ask Cursor to improve the configuration.
+For example, you can ask Cursor to add specific filters, actions, or custom columns.
+
+## Handling Translations
+You should provide translated values everywhere you configure or render text content, just like you do in the rest of your app.
+
+Example to properties in the configuration that need a translated content:
+- Page titles
+- Column names
+- Action labels
+
+Code Example: (props that are not relevant to translation are omitted)
+```ts
+import { AppConfig, AutoPatternsApp } from '@wix/auto-patterns';
+import { useTranslation } from 'react-i18next';
+
+const MyPage = () => {
+  const { t } = useTranslation();
+
+  const config: AppConfig = {
+    pages: [
+      {
+        id: 'wixPets-collection',
+        type: 'collectionPage',
+        collectionPage: {
+          title: { text: t('pages.pets.title') },
+          actions: {
+            primaryActions: {
+              type: 'action',
+              action: {
+                item: {
+                  id: 'createPet',
+                  label: t('actions.create'),
+                  type: 'create',
+                  create: { mode: 'page', page: { id: 'wixPets-entity' } },
+                },
+              },
+            },
+          },
+          components: [
+            {
+              type: 'collection',
+              entityPageId: 'wixPets-entity',
+              layout: [
+                {
+                  type: 'Table',
+                  table: {
+                    columns: [
+                      { id: 'name', name: t('columns.name') },
+                      { id: 'age', name: t('columns.age') },
+                      { id: 'owner', name: t('columns.owner') },
+                    ],
+                  },
+                },
+              ],
+            },
+          ],
+        },
+      },
+      {
+        id: 'wixPets-entity',
+        type: 'entityPage',
+        entityPage: {
+          title: { text: t('pages.pets.detailsTitle') },
+        },
+      },
+    ],
+  };
+
+  return <AutoPatternsApp configuration={config} />;
+};
+
+export default MyPage;
+```

package/docs/OVERVIEW.md

@@ -0,0 +1,54 @@
+# Auto Patterns Overview
+
+## What is Auto Patterns?
+
+Auto Patterns is our AI-oriented library that lets anyone (Devs, PMs, UX) create rich dashboards with ease using Cursor.
+
+## Key Concepts
+
+### Configuration-Driven Development
+Instead of manually building collection pages, entity forms, and data management interfaces, Auto Patterns allows you to define everything through a TypeScript configuration object that conforms to the `AppConfig` interface. This approach:
+
+- Reduces development time
+- Makes experience intuitive and expected
+- Minimizes bugs
+- Simplifies maintenance
+
+### Relationship with @wix/patterns
+Auto Patterns serves as a **configuration layer** on top of `@wix/patterns` by:
+
+- **Configuration-driven approach**: Instead of imperatively composing `@wix/patterns` components, you define behavior through TypeScript configuration objects
+- **Pre-built component combinations**: Uses existing `@wix/patterns` components like `CollectionPage`, `Table`, `Grid`, and `EntityPage`, but configures them automatically based on your AppConfig
+- **Simplified integration**: Handles the wiring between `@wix/patterns` components, hooks, and providers so you don't need to set them up manually
+- **Declarative API**: Transforms complex component composition patterns into simple configuration properties
+
+## When to Use Auto Patterns
+
+### Perfect For:
+- **Collection management pages** (lists, tables, grids)
+- **Entity detail/edit pages** (forms, CRUD operations)
+- **Teams standardizing** UI patterns across applications
+
+## Core Components
+
+### AutoPatternsApp
+The main component that renders your entire application based on configuration:
+
+```tsx
+import { AutoPatternsApp } from '@wix/auto-patterns';
+import { config } from './myConfig.patterns';
+
+const MyPage = () => (
+  <AutoPatternsApp configuration={config} />
+);
+```
+
+### AppConfig Structure
+The heart of Auto Patterns - a TypeScript configuration that defines:
+
+- **Pages**: Collection pages (lists/tables) and entity pages (forms)
+- **Data sources**: FQDN-based Wix entities, Wix Data Collections (CMS) or custom data sources
+- **Actions**: Create, edit, delete, and custom operations
+- **Filters**: Search and filtering capabilities
+- **Layouts**: Table, grid, and form layouts
+- **Customizations**: Column overrides, custom components, and styling

package/docs/documentation.yaml

@@ -0,0 +1,11 @@
+apiDoc:
+  title: Auto Patterns
+  description: Auto Patterns documentation
+  category: fe-guild
+  markdownOnlyAutoUpdate: true
+  gitUrl: https://github.com/wix-private/auto-cairo/
+  docs:
+    - file: ./GETTING_STARTED.md
+      title: Getting Started
+    - file:  ./OVERVIEW.md
+      title: Overview

package/{dist/docs → mcp-docs}/auto-patterns-guide.md

@@ -4317,5 +4317,3 @@ Before deploying your custom data source, ensure:
 ✅ **External API calls are NOT wrapped** with errorHandler (e.g., fetch(), axios, third-party HTTP clients)
 ✅ **SDK actions are used directly** without error handling (e.g., `sdk.getOptimisticActions()`, `sdk.getSchema()`)
 ✅ **@wix/essentials** is installed as a dependency
-
----

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto-patterns",
-  "version": "1.33.0",
+  "version": "1.34.0",
   "license": "UNLICENSED",
   "author": {
     "name": "Matvey Oklander",
@@ -18,13 +18,14 @@
     "!dist/**/__tests__",
     "types",
     "react",
-    "form"
+    "form",
+    "docs",
+    "mcp-docs"
   ],
   "scripts": {
+    "build": "npm run generate-guide && yoshi-library build",
+    "start": "npm run generate-guide && yoshi-library start",
     "generate-guide": "node scripts/generate-guide.js",
-    "build": "yoshi-library build && npm run generate-guide",
-    "prestart": "npm run generate-guide",
-    "start": "yoshi-library start",
     "test": "yoshi-library test",
     "test:watch": "yoshi-library test --watch",
     "lint": "yoshi-library lint",
@@ -35,9 +36,8 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.28.4",
-    "@wix/data": "^1.0.286",
+    "@wix/data": "^1.0.289",
     "@wix/wix-ui-icons-common": "^3.87.3",
-    "ejs": "^3.1.10",
     "lodash": "^4.17.21"
   },
   "publishConfig": {
@@ -46,22 +46,21 @@
   },
   "devDependencies": {
     "@testing-library/react": "^11.2.7",
-    "@types/ejs": "^3.1.5",
     "@types/jest": "^27.5.2",
     "@types/lodash": "^4.17.20",
     "@types/node": "^16.18.126",
     "@types/node-fetch": "^2.6.13",
     "@types/react": "^16.14.66",
-    "@wix/crm": "^1.0.1008",
+    "@wix/crm": "^1.0.1021",
     "@wix/design-system": "^1.214.3",
     "@wix/eslint-config-yoshi": "^6.158.0",
     "@wix/fe-essentials-standalone": "^1.1380.0",
     "@wix/jest-yoshi-preset": "^6.158.0",
-    "@wix/patterns": "^1.276.0",
-    "@wix/sdk": "^1.15.27",
+    "@wix/patterns": "^1.277.0",
+    "@wix/sdk": "^1.16.0",
     "@wix/sdk-testkit": ">=0.1.7",
-    "@wix/wix-data-items-common": "^1.0.234",
-    "@wix/wix-data-items-sdk": "^1.0.427",
+    "@wix/wix-data-items-common": "^1.0.235",
+    "@wix/wix-data-items-sdk": "^1.0.428",
     "@wix/yoshi-flow-library": "^6.158.0",
     "@wix/yoshi-style-dependencies": "^6.158.0",
     "chance": "^1.1.13",
@@ -126,5 +125,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "e334cdcca9d1178fdb528c8285b392ab2856be464988610a88518d39"
+  "falconPackageHash": "3b95f950e8cf046662d2a6326593abe425912fede0ff9c0711897c1f"
 }