@wix/auto-patterns 1.23.0 → 1.25.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto-patterns",
-  "version": "1.23.0",
+  "version": "1.25.0",
   "license": "UNLICENSED",
   "author": {
     "name": "Matvey Oklander",
@@ -34,9 +34,9 @@
     "*.{js,ts}": "yarn lint"
   },
   "dependencies": {
-    "@babel/runtime": "^7.27.6",
+    "@babel/runtime": "^7.28.2",
     "@wix/data": "^1.0.222",
-    "@wix/wix-ui-icons-common": "^3.79.0",
+    "@wix/wix-ui-icons-common": "^3.84.1",
     "ejs": "^3.1.10",
     "lodash": "^4.17.21"
   },
@@ -50,20 +50,20 @@
     "@types/jest": "^27.5.2",
     "@types/lodash": "^4.17.20",
     "@types/node": "^16.18.126",
-    "@types/node-fetch": "^2.6.12",
+    "@types/node-fetch": "^2.6.13",
     "@types/react": "^16.14.65",
     "@wix/crm": "^1.0.385",
-    "@wix/design-system": "^1.206.0",
-    "@wix/eslint-config-yoshi": "^6.153.0",
-    "@wix/fe-essentials-standalone": "^1.1366.0",
-    "@wix/jest-yoshi-preset": "^6.153.0",
-    "@wix/patterns": "^1.241.0",
-    "@wix/sdk": "^1.15.24",
+    "@wix/design-system": "^1.211.1",
+    "@wix/eslint-config-yoshi": "^6.155.0",
+    "@wix/fe-essentials-standalone": "^1.1380.0",
+    "@wix/jest-yoshi-preset": "^6.155.0",
+    "@wix/patterns": "^1.253.0",
+    "@wix/sdk": "^1.15.26",
     "@wix/sdk-testkit": ">=0.1.6",
-    "@wix/wix-data-items-common": "^1.0.196",
-    "@wix/wix-data-items-sdk": "^1.0.387",
-    "@wix/yoshi-flow-library": "^6.153.0",
-    "@wix/yoshi-style-dependencies": "^6.153.0",
+    "@wix/wix-data-items-common": "^1.0.211",
+    "@wix/wix-data-items-sdk": "^1.0.403",
+    "@wix/yoshi-flow-library": "^6.155.0",
+    "@wix/yoshi-style-dependencies": "^6.155.0",
     "chance": "^1.1.13",
     "date-fns": "^2.30.0",
     "express": "^4.21.2",
@@ -77,6 +77,7 @@
   "peerDependencies": {
     "@wix/dashboard": "^1.3.33",
     "@wix/design-system": "^1.204.0",
+    "@wix/essentials": "^0.1.26",
     "@wix/patterns": "^1.239.0",
     "react": "^16.8.0",
     "react-router-dom": "^6.0.0 || ^7.0.0"
@@ -125,5 +126,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "2268b5e199bc79736a93acc5d94e7939e96a85206dcebaba62823671"
+  "falconPackageHash": "119b38014c45a67246d7f9e40fc3b9aa80010c9acbcf25504fff365c"
 }

package/dist/docs/config_schema.md

@@ -1,184 +0,0 @@
-## SchemaConfig Usage
-
-SchemaConfig provides complete collection metadata and server actions. Essential for dynamic operations and accessing collection structure information.
-
-### TypeScript Interface Definition
-
-```typescript
-export interface SchemaConfig {
-  id: string;
-  fields: Record<string, Field | undefined>;
-  displayField: string;
-  idField: string;
-  actions: {
-    get: (entityId: string) => Promise<any>;
-    create: (newEntity: Partial<any>) => Promise<any>;
-    update: (updatedEntity: any) => Promise<any>;
-    delete: (entityId: string) => Promise<any>;
-    bulkDelete: (entityIds: string[]) => Promise<any>;
-    find: (
-      query: ComputedQuery<any>,
-      options?: {
-        searchableFieldIds?: string[];
-        filterFieldMapping?: Record<string, { fieldId: string }>;
-      },
-    ) => Promise<{ items: any[]; total: number }>;
-  };
-}
-```
-
-### Supporting Type Definitions
-
-```typescript
-export type PatternsFieldType =
-  | 'SHORT_TEXT'
-  | 'LONG_TEXT'
-  | 'NUMBER'
-  | 'BOOLEAN'
-  | 'DATE'
-  | 'DATETIME'
-  | 'URL'
-  | 'ARRAY'
-  | 'REFERENCE'
-  | 'IMAGE';
-
-interface BaseField {
-  id: string;
-  displayName: string;
-  validation?: {
-    numberRange?: NumberRange;
-    stringLengthRange?: StringLengthRange;
-    required: boolean;
-  };
-  capabilities: {
-    supportedQueryOperators: QueryOperator[];
-    sortable: boolean;
-  };
-}
-
-export interface ReferenceField extends BaseField {
-  type: 'REFERENCE';
-  referenceMetadata: {
-    referencedCollectionId: string;
-  };
-}
-
-export interface NonReferenceField extends BaseField {
-  type: Exclude<PatternsFieldType, 'REFERENCE'>;
-}
-
-export type Field = ReferenceField | NonReferenceField;
-```
-
-### Key Properties
-
-• **id** - `string`
-  - Collection identifier (e.g., "WixPets")
-  - Example: `schema.id === "WixPets"`
-
-• **idField** - `string`
-  - Primary key field name (usually "_id")
-  - Required for all update/delete operations
-  - Example: `const id = item[schema.idField]`
-
-• **displayField** - `string`
-  - Main field for displaying items (name, title, etc.)
-  - Used in UI components for item identification
-  - Example: `const label = item[schema.displayField]`
-
-• **fields** - `Record<string, Field | undefined>`
-  - Complete field definitions with types and metadata
-  - Useful for dynamic form generation or validation
-  - Each field contains type information, validation rules, and capabilities
-  - Example: `schema.fields.name.type === 'SHORT_TEXT'`
-
-• **actions** - Server operation functions
-  - Pre-configured API calls for CRUD operations
-  - Use with optimistic actions for best UX
-  - All actions return Promises and handle server communication
-  - Example: `await schema.actions.update(item)`
-
-### Available Schema Actions
-
-#### Individual Entity Operations
-- **schema.actions.get(entityId)** - Retrieve a single entity by ID
-- **schema.actions.create(newEntity)** - Create a new entity
-- **schema.actions.update(updatedEntity)** - Update an existing entity
-- **schema.actions.delete(entityId)** - Delete a single entity by ID
-
-#### Bulk Operations
-- **schema.actions.bulkDelete(entityIds)** - Delete multiple entities by their IDs
-
-#### Query Operations
-- **schema.actions.find(query, options)** - Search and filter entities
-  - `query`: ComputedQuery object with filtering and sorting criteria
-  - `options.searchableFieldIds`: Array of field IDs that support text search
-  - `options.filterFieldMapping`: Maps filter IDs to actual field IDs for complex filtering
-  - Returns: `{ items: any[], total: number }`
-
-### Field Type Information
-
-Each field in the `fields` record contains:
-
-- **id**: Unique field identifier
-- **displayName**: Human-readable field name
-- **type**: One of the supported `PatternsFieldType` values
-- **validation**: Optional validation rules including:
-  - `numberRange`: Min/max values for numeric fields
-  - `stringLengthRange`: Min/max length for text fields
-  - `required`: Whether the field is mandatory
-- **capabilities**: Field behavior configuration:
-  - `supportedQueryOperators`: Array of operators this field supports for filtering
-  - `sortable`: Whether this field can be used for sorting
-
-### Reference Fields
-
-Reference fields have additional metadata:
-- **referenceMetadata.referencedCollectionId**: ID of the collection being referenced
-- Used for establishing relationships between different collections
-
-### Schema Validation Checklist
-
-Before using schema in operations:
-
-✓ Check if schema exists: `if (!schema) return;`
-✓ Verify required fields exist on items
-✓ Use `schema.idField` for ID operations
-✓ Use `schema.displayField` for UI display
-✓ Use `schema.actions` for server operations
-✓ Check field capabilities before applying filters or sorting
-
-### Common Usage Patterns
-
-- **ActionCell**: Use `schema.actions.update()` or `schema.actions.delete()` for single item operations
-- **BulkActions**: Use `schema.actions.bulkDelete()` for multiple items
-- **Dynamic UI**: Use `schema.fields` to build forms or validate data
-- **Error Messages**: Use `schema.displayField` to create meaningful user feedback
-- **Field Validation**: Use `schema.fields[fieldId].validation` for form validation rules
-- **Query Building**: Use `schema.fields[fieldId].capabilities.supportedQueryOperators` to build dynamic filters
-
-### Example Usage
-
-```typescript
-// Using schema for dynamic operations
-const handleUpdateEntity = async (updatedItem: any) => {
-  const schema = sdk.getSchema(collectionId);
-
-  if (!schema) {
-    throw new Error('Schema not available');
-  }
-
-  // Validate required fields
-  const nameField = schema.fields.name;
-  if (nameField?.validation?.required && !updatedItem.name) {
-    throw new Error(`${nameField.displayName} is required`);
-  }
-
-  // Perform update
-  await schema.actions.update(updatedItem);
-
-  // Show success message using display field
-  const displayValue = updatedItem[schema.displayField];
-  console.log(`Updated ${displayValue} successfully`);
-};
-```