From 7965f92edb07f8e5201a79330ffd548e86d16a3c Mon Sep 17 00:00:00 2001 From: ryangec Date: Wed, 31 Jul 2024 11:03:12 +0300 Subject: [PATCH] DocWorks for js-wixcode-sdk - 12 changes detected, but 15 issue detected changes: Service $w.Effects has changed summary Service $w.Effects has changed description Service $w.Effects property activeEffects has changed description Service $w.Effects property allEffects has changed description Service $w.Effects operation applyEffects has changed description Service $w.Effects operation removeAllEffects has changed description Service $w.Effects operation removeEffects has changed description Service $w.Effects operation toggleEffects has changed description Service $w.EffectsMixin has changed summary Service $w.EffectsMixin has changed description Service $w.EffectsMixin property effects has changed summary Service $w.WixComments operation onCommentCreate.examples[0] has changed body issues: Message ViewChangeEventOptions has an unknown property type * (ApppointmentFieldEvent.js (8)) Property target is missing a type annotation (GalleryNavigationStartEvent.js (15)) Operation postMessage has an unknown param type * (HtmlComponent.js (97)) Property data has an unknown type * (HtmlComponentMessageEvent.js (17)) Property fileLimit has mismatching types for get (number) and set (string) (UploadButton.js (128, 149)) Operation set has an unknown param type * (window-frontend.js (201)) Operation get has an unknown return type * (window-frontend.js (234)) Operation set has an unknown param type * (window.js (235)) Operation get has an unknown return type * (window.js (269)) Callback ViewChangeOperation is defined two or more times (AppointmentField.js (347), DatePicker.js (472)) Callback ViewChangeOperation has an unknown return type * (AppointmentField.js (347)) Callback ViewChangeEventHandler is defined two or more times (AppointmentField.js (362), DatePicker.js (466)) Callback Validator has an unknown param type * (ValidatableMixin.js (143)) Property value has an unknown type * (ValueMixin.js (62)) Property value has an unknown type * (ValueMixin.js (89)) --- js-wixcode-sdk/$w.service.json | 3 +- js-wixcode-sdk/$w/Effects.service.json | 49 +++++++++++-------- js-wixcode-sdk/$w/EffectsMixin.service.json | 14 +++--- js-wixcode-sdk/$w/WixComments.service.json | 8 +-- js-wixcode-sdk/site-monitoring.service.json | 3 +- .../site-monitoring/LogEntry.service.json | 6 +-- 6 files changed, 45 insertions(+), 38 deletions(-) diff --git a/js-wixcode-sdk/$w.service.json b/js-wixcode-sdk/$w.service.json index 84e5f28054..feaec7ba86 100644 --- a/js-wixcode-sdk/$w.service.json +++ b/js-wixcode-sdk/$w.service.json @@ -1,7 +1,6 @@ { "name": "$w", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "wixCode.js" }, diff --git a/js-wixcode-sdk/$w/Effects.service.json b/js-wixcode-sdk/$w/Effects.service.json index 6813ac5687..d985ff6bc5 100644 --- a/js-wixcode-sdk/$w/Effects.service.json +++ b/js-wixcode-sdk/$w/Effects.service.json @@ -1,27 +1,29 @@ { "name": "Effects", "memberOf": "$w", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 50, "filename": "EffectsMixin.js" }, "docs": - { "summary": "Functionality for displaying the [effects](https://support.wix.com/en/article/editor-x-about-click-and-hover-interactions-beta#choosing-and-customizing-effects) defined for an element using Editor X.", + { "summary": "Functionality for displaying the [effects](https://support.wix.com/en/article/studio-editor-about-animations#:~:text=client%27s%20exact%20needs.-,Hover%20and%20click%20interactions,-Add%20cool%20effects) defined for an element using Wix Studio.", "description": - [ ">**Note:** This API can only be used in Editor X.", + [ ">**Note:** This API can only be used in Wix Studio.", "", - "Editor X allows you to create [effects](https://support.wix.com/en/article/editor-x-about-click-and-hover-interactions-beta#choosing-and-customizing-effects) that change the way elements are displayed on your site.", + "Wix Studio allows you to create [effects](https://support.wix.com/en/article/studio-editor-about-animations#:~:text=client%27s%20exact%20needs.-,Hover%20and%20click%20interactions,-Add%20cool%20effects) that change the way elements are displayed on your site.", "The Effects API allows you to programatically display the effects defined for an element. ", "", "For example, with the API you can trigger an effect using anything happening on your site or in your code. ", - "This means you can expand the set of effects [triggers](https://support.wix.com/en/article/editor-x-about-click-and-hover-interactions#how-do-interactions-work) provided in Editor X to suit your needs." ], + "This means you can expand the set of effects triggers provided in Wix Studio to suit your needs." ], "links": [], "examples": [], "extra": { } }, "properties": [ { "name": "activeEffects", - "labels": [], + "labels": + [ "changed" ], "get": true, "set": false, "type": @@ -37,7 +39,7 @@ [ "This property contains the names of all of an element's currently applied effects.", "", ">**Note:**", - ">This property can only be used in Editor X." ], + ">This property can only be used in Wix Studio." ], "links": [], "examples": [ { "title": "Retrieve all of an element's applied effects", @@ -68,7 +70,8 @@ "extra": { } }, { "name": "allEffects", - "labels": [], + "labels": + [ "changed" ], "get": true, "set": false, "type": @@ -81,10 +84,10 @@ "docs": { "summary": "Gets all of the effects defined for an element.", "description": - [ "This property contains the names of all the effects that were defined for an element using Editor X.", + [ "This property contains the names of all the effects that were defined for an element using Wix Studio.", "", ">**Note:**", - ">This property can only be used in Editor X." ], + ">This property can only be used in Wix Studio." ], "links": [], "examples": [ { "title": "Retrieve all of the effects defined for an element", @@ -116,7 +119,8 @@ { } } ], "operations": [ { "name": "applyEffects", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "effects", @@ -133,11 +137,11 @@ "docs": { "summary": "Applies one or more of an element's effects.", "description": - [ "This function applies effects that you previously defined for an element using Editor X, making the effects visible on your site.", + [ "This function applies effects that you previously defined for an element using Wix Studio, making the effects visible on your site.", "", "You can find the names of the effects defined for an element using the [`allEffects`](#allEffects) property.", "", - "The Effects panel in Editor X has two sections, **Adjust** and **Design**, that allow you to adjust the appearance of an element or change its design characteristics.", + "The Effects panel in Wix Studio has two sections, **Adjust** and **Design**, that allow you to adjust the appearance of an element or change its design characteristics.", "You can't simultaneously apply 2 effects that both change properties in the same section. ", "If you try to do this, only one of the effects is visible on your site. ", "You can, however, apply 1 effect that changes the **Adjust** properties and another effect that changes the **Design** properties simultaneously.", @@ -149,7 +153,7 @@ "If you create 2 effects that each change properties in the **Adjust** section and try to apply them together, only", "one is visible on your site. The same is true for 2 effects that change properties in the **Design** section.", "", - ">**Note:** This function can only be used in Editor X." ], + ">**Note:** This function can only be used in Wix Studio." ], "links": [], "examples": [ { "title": "Apply one of an element's effects", @@ -174,7 +178,8 @@ "extra": { } }, { "name": "removeAllEffects", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [], "ret": @@ -188,7 +193,7 @@ [ "This function removes all of an element's previously applied effects. Once you remove effects, they're unapplied from an element and no longer visible on your site.", "", ">**Note:**", - ">This function can only be used in Editor X." ], + ">This function can only be used in Wix Studio." ], "links": [], "examples": [ { "title": "Remove all of an element's applied effects", @@ -217,7 +222,8 @@ "extra": { } }, { "name": "removeEffects", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "effects", @@ -240,7 +246,7 @@ "You can find the names of the effects defined for an element using the [`allEffects`](#allEffects) property.", "", ">**Note:**", - ">This function can only be used in Editor X." ], + ">This function can only be used in Wix Studio." ], "links": [], "examples": [ { "title": "Remove one of an element's effects", @@ -265,7 +271,8 @@ "extra": { } }, { "name": "toggleEffects", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "effects", @@ -288,7 +295,7 @@ "", "You can find the names of the effects defined for an element using the [`allEffects`](#allEffects) property.", "", - "The Effects panel in Editor X has two sections, **Adjust** and **Design**, that allow you to adjust the appearance of an element or change its design characteristics.", + "The Effects panel in Wix Studio has two sections, **Adjust** and **Design**, that allow you to adjust the appearance of an element or change its design characteristics.", "You can't simultaneously apply 2 effects that both change properties in the same section. ", "If you try to do this, only one of the effects is visible on your site. ", "You can, however, apply 1 effect that changes the **Adjust** properties and another effect that changes the **Design** properties simultaneously.", @@ -301,7 +308,7 @@ "one is visible on your site. The same is true for 2 effects that change properties in the **Design** section.", "", ">**Note:**", - ">This function can only be used in Editor X." ], + ">This function can only be used in Wix Studio." ], "links": [], "examples": [ { "title": "Toggle one of an element's effects", diff --git a/js-wixcode-sdk/$w/EffectsMixin.service.json b/js-wixcode-sdk/$w/EffectsMixin.service.json index 537e1c2a69..14970ee39b 100644 --- a/js-wixcode-sdk/$w/EffectsMixin.service.json +++ b/js-wixcode-sdk/$w/EffectsMixin.service.json @@ -1,20 +1,21 @@ { "name": "EffectsMixin", "memberOf": "$w", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "EffectsMixin.js" }, "docs": - { "summary": "Provides functionality for elements with [effects](https://support.wix.com/en/article/editor-x-about-click-and-hover-interactions-beta#choosing-and-customizing-effects) defined using Editor X.", + { "summary": "Provides functionality for elements with [effects](https://support.wix.com/en/article/studio-editor-adding-a-preset-click-or-hover-interaction) defined using Wix Studio.", "description": - [ "Editor X allows you to create [effects](https://support.wix.com/en/article/editor-x-about-click-and-hover-interactions-beta#choosing-and-customizing-effects) that change the way elements are displayed on your site.", + [ "Wix Studio allows you to create [effects](https://support.wix.com/en/article/studio-editor-creating-a-custom-click-or-hover-interaction) that change the way elements are displayed on your site.", "", "This mixin provides functionality that allows you to control the display of effects defined for an element.", "", "", " >**Note:** ", - " >This mixin can only be used in Editor X.", + " >This mixin can only be used in Wix Studio.", "", " **About Mixins**", "", @@ -41,7 +42,8 @@ { } }, "properties": [ { "name": "effects", - "labels": [], + "labels": + [ "changed" ], "get": true, "set": false, "type": "$w.Effects", @@ -49,7 +51,7 @@ [ { "lineno": 36, "filename": "EffectsMixin.js" } ], "docs": - { "summary": "An object containing functionality for displaying the [effects](https://support.wix.com/en/article/editor-x-about-click-and-hover-interactions-beta#choosing-and-customizing-effects) defined for an element using Editor X.\n\n>**Note:** This API can only be used in Editor X.", + { "summary": "An object containing functionality for displaying the [effects](https://support.wix.com/en/article/studio-editor-adding-a-preset-click-or-hover-interaction) defined for an element using Wix Studio.\n\n>**Note:** This API can only be used in Wix Studio.", "links": [], "examples": [ { "title": "Get an element's effects", diff --git a/js-wixcode-sdk/$w/WixComments.service.json b/js-wixcode-sdk/$w/WixComments.service.json index 55cd221c71..e9dbd2e847 100644 --- a/js-wixcode-sdk/$w/WixComments.service.json +++ b/js-wixcode-sdk/$w/WixComments.service.json @@ -2,7 +2,8 @@ "memberOf": "$w", "mixes": [ "$w.Element" ], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "WixComments.js" }, @@ -189,7 +190,8 @@ "extra": { } }, { "name": "onCommentCreate", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "callback", @@ -212,7 +214,7 @@ "examples": [ { "title": "Add an event handler for when a new comment is created", "body": - [ "$w(\"#myCommentsWidget\").onCreateComment((widgetComment) => { ", + [ "$w(\"#myCommentsWidget\").onCommentCreate((widgetComment) => { ", " console.log(widgetComment);", "});" ], "extra": diff --git a/js-wixcode-sdk/site-monitoring.service.json b/js-wixcode-sdk/site-monitoring.service.json index c319eb00e2..3d81479cab 100644 --- a/js-wixcode-sdk/site-monitoring.service.json +++ b/js-wixcode-sdk/site-monitoring.service.json @@ -1,7 +1,6 @@ { "name": "site-monitoring", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "siteMonitoring.js" }, diff --git a/js-wixcode-sdk/site-monitoring/LogEntry.service.json b/js-wixcode-sdk/site-monitoring/LogEntry.service.json index d665319720..5f4aa2568f 100644 --- a/js-wixcode-sdk/site-monitoring/LogEntry.service.json +++ b/js-wixcode-sdk/site-monitoring/LogEntry.service.json @@ -1,8 +1,7 @@ { "name": "LogEntry", "memberOf": "site-monitoring", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 68, "filename": "siteMonitoring.js" }, @@ -331,8 +330,7 @@ "extra": { } }, { "name": "timestamp", - "labels": - [ "changed" ], + "labels": [], "get": true, "set": false, "type": "string",