From 22e3ccb508d09e777cfb7dd48d222d05b9a80019 Mon Sep 17 00:00:00 2001 From: idanlib-wix Date: Tue, 30 Jul 2024 14:45:44 +0300 Subject: [PATCH] DocWorks for js-wixcode-sdk - 7 changes detected, but 15 issue detected changes: Service $w has changed description Service site-monitoring.LogEntry has changed summary Service site-monitoring.LogEntry has changed description Service site-monitoring.LogEntry property timestamp has changed summary Service site-monitoring.LogEntry property timestamp has changed description Service site-monitoring has changed summary Service site-monitoring has changed description 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 | 19 +++++---- js-wixcode-sdk/site-monitoring.service.json | 41 ++++++++++--------- .../site-monitoring/LogEntry.service.json | 14 ++++--- .../wix-window-frontend/Lightbox.service.json | 6 +-- 4 files changed, 42 insertions(+), 38 deletions(-) diff --git a/js-wixcode-sdk/$w.service.json b/js-wixcode-sdk/$w.service.json index 1bae312e07..84e5f28054 100644 --- a/js-wixcode-sdk/$w.service.json +++ b/js-wixcode-sdk/$w.service.json @@ -1,6 +1,7 @@ { "name": "$w", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "wixCode.js" }, @@ -15,10 +16,12 @@ "", " You do not need to import `$w`.", "", - " > **Note:** Most `$w` elements, nodes, and events are described here under Wix Editor Elements. Some `$w` ", - " elements are described in context of their functionality. For example, the [`WixForms`](wix-crm-frontend.html#$w-wixforms) ", - " element is described under the `wix-crm-frontend` namespace because using the API for the Wix Forms app is most relevant in the ", - " context of site contacts and visitors. ", + " > **Notes:**", + " > - Most `$w` elements, nodes, and events are described here under Wix Editor Elements. Some `$w`", + " elements are described in context of their functionality. For example, the [`WixForms`](wix-crm-frontend.html#$w-wixforms)", + " element is described under the `wix-crm-frontend` namespace because using the API for the Wix Forms app is most relevant in the", + " context of site contacts and visitors.", + " > - Some `$w` elements change their size dynamically, which can [affect the page layout](https://dev.wix.com/docs/develop-websites/articles/wix-editor-elements/formatting-layout/how-page-layout-is-affected-when-elements-change-size).", "", " Get hands-on experience with the `$w` API on our [Hello World](https://www.wix.com/velo/example/hello-world) example page." ], "links": [], @@ -42,7 +45,7 @@ [ "$w.Element" ] } ], "doc": "A single selected element or an array of selected elements." }, "locations": - [ { "lineno": 23, + [ { "lineno": 24, "filename": "wixCode.js" } ], "docs": { "summary": "Selects and returns elements from a page.", @@ -129,7 +132,7 @@ { "type": "$w.$w", "doc": "A selector function for the given context." }, "locations": - [ { "lineno": 127, + [ { "lineno": 125, "filename": "wixCode.js" } ], "docs": { "summary": "Gets a selector function for a specific context.", @@ -165,7 +168,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 72, + [ { "lineno": 71, "filename": "wixCode.js" } ], "docs": { "summary": "Sets the function that runs when all the page elements have finished loading.", diff --git a/js-wixcode-sdk/site-monitoring.service.json b/js-wixcode-sdk/site-monitoring.service.json index b26007e3ff..c319eb00e2 100644 --- a/js-wixcode-sdk/site-monitoring.service.json +++ b/js-wixcode-sdk/site-monitoring.service.json @@ -1,21 +1,23 @@ { "name": "site-monitoring", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "siteMonitoring.js" }, "docs": - { "summary": "JSON representation of Wix site events for exposure to external site monitoring tools.", + { "summary": "JSON representation of logs for exposure to external site monitoring tools.", "description": [ "Velo's [site monitoring](https://support.wix.com/en/article/about-site-monitoring)", - " feature lets you view, analyze, and debug Wix site events. You can examine", - " live site events in real time, or connect site events to an external monitoring", - " tool to generate event metrics and perform error log analysis.", + " feature lets you view, analyze, and debug logs. You can examine", + " logs in real time, or connect Wix Logs to an external monitoring", + " tool to generate log metrics and perform error log analysis.", "", "## How It Works", "", - " Velo's site monitoring tool records Wix site events as [log entries](site-monitoring.LogEntry.html).", - " Each log entry is a JSON object representing a single site event.", + " Velo's site monitoring tool records Wix logs as [log entries](site-monitoring.LogEntry.html).", + " Each log entry is a JSON object representing a single log.", + "", "", "The following is an example of a `logEntry`:", "", @@ -50,23 +52,22 @@ "", " For a detailed description of the JSON representation of a log entry, click [here](site-monitoring.LogEntry.html).", "", - "## Viewing Site Events", + "## Viewing logs", "", - " Velo's site monitoring feature lets you investigate your site events in 3 ways:", + " You can investigate your logs in the following ways:", "", - " + **View live site events in real time:** You can quickly scan basic site event", - " information or view the JSON object representing each event. Events are loaded", - " as they occur. [Learn more](https://support.wix.com/en/article/viewing-live-site-events).", - " + **Connect to Google Stackdriver:** You can easily connect your Wix site events", - " to Google's external monitoring tool. Stackdriver performs log analysis and ", - " generates visual depictions of site event data, allowing you to extract meaningful ", - " insights from your site events. [Learn more](https://support.wix.com/en/article/velo-connecting-site-events-to-google-stackdriver).", - " + **Connect to an external monitoring tool:** You can connect your Wix site", - " events to a monitoring tool of your choice to generate metrics and analyze", - " logs. [Learn more](https://support.wix.com/en/article/connecting-site-events-to-a-monitoring-tool).", + " + **View logs in real time:** You can quickly scan basic log information or view the JSON object representing each log. ", + " Logs are loaded as they occur. [Learn more](https://support.wix.com/en/article/viewing-live-site-events).", + " + **Connect to Google Cloud Logs:** You can easily connect your site's logs to Google's external monitoring tool. ", + " Google Cloud Logs performs log analysis and generates visual depictions of log data, ", + " allowing you to extract meaningful insights ", + " from your logs. [Learn more](https://support.wix.com/en/article/velo-connecting-wix-logs-to-google-cloud-logs).", + " + **Connect to an external monitoring tool:** You can connect your Wix Logs to a ", + " monitoring tool of your choice to generate metrics and ", + " analyze logs. [Learn more](https://support.wix.com/en/article/velo-connecting-wix-logs-to-a-monitoring-tool-advanced).", "", "", - "To learn how to trigger events on your site, click [here](https://support.wix.com/en/article/velo-generating-a-site-monitoring-event-to-debug-your-site)." ], + "To learn how to generate logs on your site, click [here](https://dev.wix.com/docs/develop-websites/articles/workspace-tools/testing-monitoring/testing-troubleshooting/testing-and-troubleshooting-your-code#debugging-with-logs)." ], "links": [], "examples": [], "extra": diff --git a/js-wixcode-sdk/site-monitoring/LogEntry.service.json b/js-wixcode-sdk/site-monitoring/LogEntry.service.json index f55b6ba50e..d665319720 100644 --- a/js-wixcode-sdk/site-monitoring/LogEntry.service.json +++ b/js-wixcode-sdk/site-monitoring/LogEntry.service.json @@ -1,16 +1,17 @@ { "name": "LogEntry", "memberOf": "site-monitoring", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 68, "filename": "siteMonitoring.js" }, "docs": - { "summary": "A single record of a Wix site event in JSON format.", + { "summary": "A single record of a log in JSON format.", "description": [ "Note the following terminology:", "", - " + **Log entry:** Single record of a Wix site event.", + " + **Log entry:** Single record of a Wix log.", " + **Log:** Collection of log entries associated with the same site and namespace.", "", " The following is an example of a `LogEntry`:", @@ -330,7 +331,8 @@ "extra": { } }, { "name": "timestamp", - "labels": [], + "labels": + [ "changed" ], "get": true, "set": false, "type": "string", @@ -338,9 +340,9 @@ [ { "lineno": 113, "filename": "siteMonitoring.js" } ], "docs": - { "summary": "Time the site event occurred.", + { "summary": "Time the log occurred.", "description": - [ "Time the event recorded by the log entry occurred. Displayed as UTC time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." ], + [ "Time the log occurred. Displayed as UTC time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." ], "links": [], "examples": [ { "title": "Log entry timestamp", diff --git a/js-wixcode-sdk/wix-window-frontend/Lightbox.service.json b/js-wixcode-sdk/wix-window-frontend/Lightbox.service.json index 2388f007ca..09aafbded4 100644 --- a/js-wixcode-sdk/wix-window-frontend/Lightbox.service.json +++ b/js-wixcode-sdk/wix-window-frontend/Lightbox.service.json @@ -1,8 +1,7 @@ { "name": "Lightbox", "memberOf": "wix-window-frontend", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 327, "filename": "window-frontend.js" }, @@ -175,8 +174,7 @@ "extra": { } }, { "name": "getContext", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [], "ret":