@wix/ditto-codegen-public 1.0.162 → 1.0.163

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/ditto-codegen-public",
-  "version": "1.0.162",
+  "version": "1.0.163",
   "description": "AI-powered Wix CLI app generator - standalone executable",
   "scripts": {
     "build": "node build.mjs",
@@ -24,5 +24,5 @@
     "@wix/ditto-codegen": "1.0.0",
     "esbuild": "^0.25.9"
   },
-  "falconPackageHash": "9fc5049b2a527b2bac7e0bad772c1de1a75f9b1bfbe0d687169ce8fe"
+  "falconPackageHash": "8c620e7ce5339a5513154b10ae3f96ffccdd916e1ea413b15bf5763b"
 }

package/dist/docs-output/api-docs/data-items-onDataItemCreated.txt

@@ -1,103 +0,0 @@
-<data_items_onDataItemCreated>
-<purpose>Registers a callback function as an event handler. Triggered when a data item is inserted. This method registers a callback function as an event handler. When developing websites or building apps with Blocks, use a Velo backend event instead of this method. The way you call this method differs depending on the framework you are working in: When using the CLI, run the generate command to add an event extension, and then call this method within the extension code. When building a self-hosted app, subscribe your app to the relevant event, and then call this method on your server.</purpose>
-<use_cases>
-- Log or audit new records inserted into collections
-- Sync newly created items to external systems or data warehouses
-- Trigger automations/workflows when specific collections receive new items
-- Enrich or validate inserted items asynchronously
-- Notify admins or stakeholders when critical items are added
-</use_cases>
-
-<method_declaration>
-data.items.onDataItemCreated(handler)
-</method_declaration>
-<required_parameters>
-- handler: function - handler(event: DataItemCreatedEnvelope): void | Promise<void>
-</required_parameters>
-<optional_parameters>
-None
-</optional_parameters>
-<import>import { data } from '@wix/data'</import>
-<types>
-
-**DataItemCreatedEnvelope**
-Properties:
-- event: DataItemCreatedEnvelope - The data item creation event envelope
-
-**DataItemCreatedEvent**
-Properties:
-- entity: DataItemEntity - The created item event data
-- metadata: EventMetadata - Event metadata
-
-**DataItemEntity**
-Properties:
-- _id: string - Data item ID
-- data: WixDataItem - Data item contents
-- dataCollectionId: string - ID of the collection to which this item belongs.
-
-**WixDataItem**
-Properties:
-- createdDate: Date - Date and time the item was added to the collection.
-- _id: string - Data item ID
-- _owner: string - ID of the user who created the item. Can be modified with site owner permissions.
-- _updatedDate: Date - Date and time the item was last modified. When the item is first inserted, _createdDate and _updatedDate have the same value.
-
-**EventMetadata**
-Properties:
-- _id: string - Unique event ID. Allows clients to ignore duplicate webhooks.
-- entityEventSequence: string - A sequence number defining the order of updates to the underlying entity.
-- entityFqdn: string - Assumes actions are also always typed to an entity_type Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
-- entityId: string - ID of the entity associated with the event.
-- eventTime: Date - Event timestamp in ISO-8601 format and UTC time.
-- eventType: string - Event type
-- identity: IdentificationData - The identification type and identity data.
-- instanceId: string - App instance ID.
-- originatedFrom: string - If present, indicates the action that triggered the event.
-- slug: string - This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug) This is although the created/updated/deleted notion is duplication of the oneof types
-- triggeredByAnonymizeRequest: boolean - Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
-
-</types>
-<important_notes>
-- This method registers a callback function as an event handler
-- When developing websites or building apps with Blocks, use a Velo backend event instead of this method
-- The way you call this method differs depending on the framework you are working in:
-  - When using the CLI, run the generate command to add an event extension, and then call this method within the extension code
-  - When building a self-hosted app, subscribe your app to the relevant event, and then call this method on your server
-- The handler function can be either synchronous (void) or asynchronous (Promise<void>)
-- Triggered when a data item is inserted
-- Required Permission: 'SCOPE.DC-DATA.READ'
-</important_notes>
-
-<event_triggers>
-- Data Item Created: This event is triggered automatically when a new item is inserted into a collection
-</event_triggers>
-<example_usage>
-```typescript
-import { items } from '@wix/data';
-
-// Register event handler for data item creation
-export default items.onDataItemCreated((event) => {
-  const created = event.entity;
-  console.log('Item created in collection:', created.dataCollectionId);
-  console.log('New item ID:', created._id);
-  // Access the inserted item payload
-  console.log('Item payload:', created.data);
-});
-
-// Async handler example
-export default items.onDataItemCreated(async (event) => {
-  const created = event.entity;
-  const createdItem = await items.get(created.dataCollectionId, created._id);
-  console.log('Created item:', createdItem);
-});
-```
-</example_usage>
-<related_methods>
-- data.items.onDataItemUpdated() - Event handler for item updates
-- data.items.onDataItemDeleted() - Event handler for item deletions
-- data.items.insert() - Insert a new item into a collection
-- data.items.get() - Retrieve an item by ID
-- data.items.query() - Query items in a collection
-</related_methods>
-</data_items_onDataItemCreated>
-

package/dist/docs-output/api-docs/stores-product-onProductCreated-doc.txt

@@ -1,118 +0,0 @@
-<stores_product_onProductCreated>
-<purpose>Registers a callback function as an event handler. Triggered when a product is created. This method registers a callback function as an event handler. When developing websites or building apps with Blocks, use a Velo backend event instead of this method. The way you call this method differs depending on the framework you are working in: When using the CLI, run the generate command to add an event extension, and then call this method within the extension code. When building a self-hosted app, subscribe your app to the relevant event, and then call this method on your server.</purpose>
-<use_cases>
-- Send notifications when new products are added to the catalog
-- Synchronize product data with external systems or databases
-- Trigger automated workflows for new product onboarding
-- Log product creation events for analytics and monitoring
-- Send welcome emails or notifications to relevant stakeholders
-- Update inventory systems or third-party services
-- Perform data validation or enrichment on new products
-- Trigger marketing campaigns for new product launches
-</use_cases>
-
-<method_declaration>
-products.onProductCreated(handler)
-</method_declaration>
-<required_parameters>
-- handler: function - handler(event: ProductCreatedEnvelope): void | Promise<void>
-</required_parameters>
-<optional_parameters>
-None
-</optional_parameters>
-<import>import { products } from '@wix/stores'</import>
-<types>
-
-**ProductCreatedEnvelope**
-Properties:
-- event: ProductCreatedEnvelope - The product creation event data
-
-**ProductCreatedEvent**
-Properties:
-- data: ProductCreated - The created product data
-- metadata: BaseEventMetadata - Additional event metadata
-
-**ProductData**
-Properties:
-- productId: string - Unique product identifier
-- name: string - Product name
-- price: Price - Product pricing information
-- visible: boolean - Whether the product is visible to customers.
-- media: Media - Media items (images, videos, etc.) associated with this product.
-- sku: string - Product stock keeping unit (SKU). If variants are being managed, this will be empty.
-- productPageUrl: ProductPageUrl - Product page URL for this product (generated automatically by the server).
-- brand: string - Product brand.
-- costAndProfitData: CostAndProfitData - cost and profit data.
-- originatedFromVersion: string - Information about the version of the catalog from where this event was triggered.
-- slug: string - Event slug. A human readable identifier of the event.
-
-**Price**
-Properties:
-- price: number - Product price
-- currency: string - Product price currency
-- formatted: Formatted - Formatted price display
-- discountedPrice: number - Discounted product price (if no discounted price is set, the product price is returned)
-- pricePerUnit: number - Price per unit
-
-**Formatted**
-Properties:
-- price: string - Product price formatted with the currency
-- discountedPrice: string - Discounted product price formatted with the currency (if no discounted price is set, the product formatted price is returned)
-- pricePerUnit: string - Price per unit
-
-**Media**
-Properties:
-- mainMedia: MainMedia - Primary media (image, video etc) associated with this product.
-- items: MediaItem[]
-
-**BaseEventMetadata**
-Properties:
-- eventType: string - The type of event that occurred
-- instanceId: string - App instance ID.
-- identity: IdentificationData - The identification type and identity data.
-</types>
-<important_notes>
-- This method registers a callback function as an event handler
-- When developing websites or building apps with Blocks, use a Velo backend event instead of this method
-- The way you call this method differs depending on the framework you are working in:
-  - When using the CLI, run the generate command to add an event extension, and then call this method within the extension code
-  - When building a self-hosted app, subscribe your app to the relevant event, and then call this method on your server
-- The handler function can be either synchronous (void) or asynchronous (Promise<void>)
-- Triggered when a product is created
-- **Required Permission**: In order to use this method, the app must have the permission scope named "SCOPE.DC-STORES.READ-PRODUCTS"
-</important_notes>
-
-<event_triggers>
-- Product Created: This event is triggered automatically when a new product is successfully created in the Wix Stores catalog
-</event_triggers>
-<example_usage>
-```typescript
-import { products } from '@wix/stores';
-
-// Register event handler for product creation
-export default products.onProductCreated((event) => {
-  console.log('New product created:', event.data.name);
-  console.log('Product ID:', event.data.productId);
-});
-
-// Async event handler example
-export default products.onProductCreated(async (event) => {
-  try {
-    console.log('Processing product creation event');
-    // Perform async operations
-    await processNewProduct(event.data);
-  } catch (error) {
-    console.error('Error processing product creation:', error);
-  }
-});
-```
-</example_usage>
-<related_methods>
-- products.onProductChanged() - Event handler for product modifications
-- products.onProductDeleted() - Event handler for product deletions
-- products.createProduct() - Method to create new products
-- products.getProduct() - Method to retrieve product details
-- products.updateProduct() - Method to update existing products
-- products.queryProducts() - Method to query products with filters
-</related_methods>
-</stores_product_onProductCreated>

package/dist/docs-output/api-docs/stores-productV3-onProductCreated-doc.txt

@@ -1,184 +0,0 @@
-<stores_productsV3_onProductCreated>
-<purpose>
-Registers an event handler that is triggered when a new product is created in your Wix Stores catalog.  
-This function allows you to perform custom logic such as synchronizing data, sending notifications, or triggering workflows when a new product is added.
-</purpose>
-
-<use_cases>
-- Send notifications when new products are added to the catalog
-- Synchronize product data with external systems or databases
-- Trigger automated workflows for product onboarding
-- Log product creation events for analytics or monitoring
-- Update inventory or pricing in external systems
-- Trigger marketing campaigns or product announcements
-- Perform data validation or enrichment upon product creation
-</use_cases>
-
-<method_declaration>
-productsV3.onProductCreated(handler)
-</method_declaration>
-
-<required_parameters>
-- handler: function — A callback function to handle the event.  
-  Signature: (event: ProductCreatedEnvelope) => void | Promise<void>
-</required_parameters>
-
-<optional_parameters>
-None
-</optional_parameters>
-
-<import>
-import { productsV3 } from '@wix/stores';
-</import>
-
-<types>
-
-**ProductCreatedEnvelope**
-Properties:
-- entity: V3Product — The created product data
-- metadata: EventMetadata — Event metadata information
-
-**V3Product**
-Properties:
-- _createdDate: Date — Date and time the product was created.
-- _id: string — Unique product identifier
-- actualPriceRange: PriceRange - Product actualPrice range - minimum and maximum prices of all product variants.
-- allCategoriesInfo: ProductCategoriesInfo - List of categories that directly contain this product, as well as their parent categories.
-- breadcrumbsInfo: BreadcrumbsInfo - Breadcrumbs of the mainCategoryId. Used to navigate to parent categories.
-- compareAtPriceRange: PriceRange - Product compareAtPrice range - minimum and maximum compare at prices of all product variants.
-- costRange: PriceRange - Product cost range - minimum and maximum costs of all product variants.
-- currency: string - Currency used for the pricing of this product, in ISO-4217 format. Defaults to the currency defined in the site settings, unless specified in x-wix-currency header.
-- description: RichContent - Product description using rich content.
-- directCategoriesInfo: ProductCategoriesInfo - List of categories that directly contain this product.
-- extendedFields: ExtendedFields - Custom extended fields for the product object.
-- handle: string - A unique human-friendly identifier for the product. Unlike the product ID, the handle can be set by the user to ensure consistency across multiple platforms. In case handle wasn't given, the handle will be automatically generated.
-- infoSections: InfoSection[] — Additional information sections
-- inventroy: Inventory - Product inventory info.
-- mainCategoryId: string - The ID of the product's primary direct category, which defines the product’s breadcrumbs path. For example, if the product's main category is "T-Shirts" (which is a subcategory of "Clothing"), the breadcrumbs path will be "Clothing > T-Shirts".
-- media: Media - Product media items.
-- modifiers: ConnectedModifier[] - Product modifiers.
-- name: string - Product name. Translatable.
-- options: ConnectedOption[] - Product options. Allows the customer to customize the product. For example, selecting color, size, and more.
-- plainDescription: string - Product description in HTML.
-- productType: ProductType - Product type.
-- revision: string - Revision number, which increments by 1 each time the product is updated. To prevent conflicting changes, the current revision must be passed when updating the product.
-- ribbon: Ribbon - Product ribbon.
-- seoData: SeoSchema - Product SEO data.
-- slug: string - Product slug
-- subscriptionDetails: SubscriptionDetails - Product subscriptions.
-- taxGroupId: string - Tax group ID
-- url: string - URL to the site's product page.
-- variantSummary: VariantSummary - The total number of variants for the product.
-- variantsInfo: VariantsInfo - Product variants. Each variant must reference all product options via its choices array. Each choice references an option using optionChoiceNames for all requests.
-- visible: boolean - Whether the product is visible to site visitors on the site. Default: true
-- visibleInPos: boolean - Whether the product is visible in POS (point of sale). Default: true
-- physicalProperties: PhysicalProperties - Physical properties. Required when productType: PHYSICAL.
-
-**PriceRange**
-Properties:
-- maxValue: FixedMonetaryAmount - Maximum value
-- minValue: FixedMonetaryAmount - Minimum value
-
-**FixedMonetaryAmount**
-Properties:
-- amount: string - Monetary amount. For example, "3.99", or "-4.99" for a negative amount.
-- formattedAmount: string - Formatted monetary amount. For example, "$3.99".
-- brand: Brand — Product brand information
-
-**ProductCategoriesInfo**
-Properties:
-- categories: ProductCategory[] - A list of categories related to product.
-
-**ProductCategory**
-Properties:
-- _id: string - Category ID
-- index: number - Index location of the product within the category, which can be utilized for sorting products in a specific category.
-
-**Brand**
-Properties:
-- _id: string - Brand ID
-- name: string - Brand name
-
-**Inventory**
-Properties:
-- availabilityStatus: InventoryAvailabilityStatus - Current availability status.
-- preorderAvailability: ProductPreorderAvailability - Preorder availability status.
-- preorderStatus: PreorderStatus — Current preorder status.
-
-**Ribbon**
-Properties:
-- _id: string - Ribbon ID
-- name: string - Ribbon name
-
-**PhysicalProperties**
-Properties:
-- deliveryProfileId: string - Delivery profile ID.
-- fulfillerId: string - Fulfiller ID.
-- pricePerUnit: PricePerUnitSettings - Price per unit settings.
-- pricePerUnitRange: PricePerUnitRange - Product price per unit range. The minimum and maximum price per unit of all the variants.
-- shippingWeightRange: WeightRange - Product shipping weight range - Calculated from the lightest and heaviest variant shipping weights.
-- weightMeasurementUnitInfo: WeightMeasurementUnitInfo - Weight measurement unit.
-
-**PricePerUnit**
-Properties:
-- measurementUnit: MeasurementUnit - Measurement unit. For example, to define price per 100 grams, set this field to "G".
-- quantity: number - Quantity. For example, to define price per per 100 grams, set this field to 100.
-
-**PricePerUnitRange**
-Properties:
-- maxValue: PricePerUnitRangePricePerUnit - Maximum price per unit across all variants.
-- minValue: PricePerUnitRangePricePerUnit - Minimum price per unit across all variants.
-
-**PricePerUnitRangePricePerUnit**
-Properties:
-- description: string - Price per unit info in the format of variant specific data / product setting, for example €4.00 / 1 Kg.
-- value: string - Calculated value of price per unit. Takes into account pricePerUnit settings of product and variants and price of variants.
-
-**WeightRange**
-Properties:
-- maxValue: number - Maximum weight across all variants associated with this product.
-- minValue: number - Minimum weight across all variants associated with this product.
-
-**WeightMeasurementUnitInfo**
-Properties:
-- weightMeasurementUnit: WeightUnit - Weight measurement unit.
-</types>
-
-<important_notes>
-- Triggered automatically when a new product is created in Wix Stores.
-- The `handler` can be synchronous (void) or asynchronous (Promise<void>).
-- When developing with Wix Blocks, use a Velo backend event instead of this SDK event.
-- Usage differs by environment:
-  - **CLI Apps:** Run the `generate` command to add an event extension, then call this method within the generated code.
-  - **Self-Hosted Apps:** Subscribe to the "Product Created" event on your server and call this method in your app.
-- **Permission Required:** `SCOPE.STORES.PRODUCT_READ` — Required scope for this event handler.
-</important_notes>
-
-<event_triggers>
-- Triggered automatically when a new product is successfully created in the Wix Stores catalog.
-</event_triggers>
-
-<example_usage>
-```typescript
-import { productsV3 } from '@wix/stores';
-
-// Basic example
-export default productsV3.onProductCreated(async (event) => {
-  console.log('New product created:', event.entity.name);
-  console.log('Product ID:', event.entity._id);
-  console.log('Visible:', event.entity.visible);
-  console.log('Inventory:', event.entity.inventory);
-  console.log('Brand:', event.entity.brand);
-  console.log('Event ID:', event.metadata._id);
-  console.log('Event Time:', event.metadata.eventTime);
-});
-
-// Async example
-export default productsV3.onProductCreated(async (event) => {
-  try {
-    console.log('Processing product creation for:', event.entity.name);
-    await syncProductToExternalSystem(event.entity);
-  } catch (err) {
-    console.error('Error processing product creation:', err);
-  }
-});