docs(samples): add API reference and Kitchen Sink for Presence #3551

sreenara · 2024-04-20T18:03:33Z

COMPLETES #SPARK-492000

This pull request addresses

webex.github.io/webex-js-sdk/ main page should now feature a Presence link as well. There should also be an API reference link for the Presence API so developers can refer to this.
Presence kitchen sink page should allow a developer to input an access token like the remaining pages and initialize the plugin
Once the plugin is initialized, a developer should be able to do these functions:

Subscribe to another user's presence and receive updates. Updates can be displayed in a text box
Set presence for the user

by making the following changes

Created a new page in the docs/samples folder for presence which fulfills the requirements for the Jira.
Added typedoc package to @webex/plugin-presence and modified tsconfig.json to generate the API reference documents for presence.

Change Type

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation update
Tooling change
Internal code refactor

The following scenarios were tested

Initialize webex token in the new page
Get presence status for the user that's logged in
Get presence status for another user
Set presence for the user that's logged in
Subscribe to presence notifications from another user
Unsubscribe from presence notifications from another user
Check the API reference for Presence and ensure the details mentioned are correct

API Reference walkthrough:
https://github.com/webex/webex-js-sdk/assets/131740035/a17bf88e-236d-4e9c-9735-128614b21b2b

Kitchen sink walkthrough:
https://github.com/webex/webex-js-sdk/assets/131740035/c724c5e8-250d-46fe-acd9-0fcce144be1c - Part 1
https://github.com/webex/webex-js-sdk/assets/131740035/135dc844-bc12-4d0a-8943-b30ed1828074 - Part 2

Setting presence status for self:
https://github.com/webex/webex-js-sdk/assets/131740035/09b2d238-189d-4ac7-8ea4-eef8fa4a8d02

I certified that

I have read and followed contributing guidelines
I discussed changes with code owners prior to submitting this pull request
I have not skipped any automated checks
All existing and new tests passed
I have updated the documentation accordingly

Make sure to have followed the contributing guidelines before submitting.

…main package

… user ids

docs/samples/browser-plugin-presence/app.js

docs/samples/browser-plugin-presence/index.html

rarajes2 · 2024-04-22T09:33:37Z

docs/samples/browser-plugin-presence/style.css

+  padding: 0;
+  background-color: #eee;
+  font-family: sans-serif;
+  font-size: 15px;


By default we should use 16px

rarajes2 · 2024-04-22T09:34:22Z

docs/samples/browser-plugin-presence/style.css

+  font-size: 15px;
+}
+
+video {


We don't have any video element so, we can remove this

rarajes2 · 2024-04-22T09:38:04Z

docs/samples/browser-plugin-presence/style.css

+button.btn--green:disabled, input[type="button"].btn--green:disabled{
+  opacity: .5;
+}
+button.btn--red, input[type="button"].btn--red {


Let's add a new line between all the css selectors (individual or composite)

rarajes2 · 2024-04-22T09:40:13Z

packages/@webex/plugin-presence/package.json

@@ -31,7 +31,8 @@
    "@webex/test-helper-test-users": "workspace:*",
    "eslint": "^8.24.0",
    "prettier": "^2.7.1",
-    "sinon": "^9.2.4"
+    "sinon": "^9.2.4",


We should remove the caret from existing dependencies as well.

cc- @Shreyas281299

I've made the versions constant

rarajes2 · 2024-04-22T09:43:21Z

docs/samples/browser-plugin-presence/style.css

+  margin-left: 1rem;
+}
+
+.ServiceData{


class name should be kebab-case

Removed this class as it's not needed

rarajes2 · 2024-04-22T09:43:39Z

docs/samples/browser-plugin-presence/style.css

+  border-bottom: 0.125rem solid #009879;
+}
+
+#transfer-options {


If possible, let's avoid id selector

Removed this class as it's not needed

packages/@webex/plugin-presence/src/interface.ts

docs/samples/browser-plugin-presence/index.html

docs/samples/browser-plugin-presence/style.css

docs/samples/browser-plugin-presence/index.html

docs/samples/browser-plugin-presence/app.js

…sence/samples

rarajes2

LGTM

Kesari3008 · 2024-04-23T11:29:11Z

docs/samples/browser-plugin-presence/style.css

+
+.styled-table th,
+.styled-table td {
+    padding: 1.25rem 1.25rem;


this is still same

docs(samples): add new docs for the presence kitchen sink

ddd6b7d

sreenara added the validated If the pull request is validated for automation. label Apr 20, 2024

sreenara requested a review from a team as a code owner April 20, 2024 18:03

docs(plugin-presence): added api reference for presence plugin

c2e39d7

sreenara changed the title ~~docs(samples): add new docs for the presence kitchen sink~~ docs(samples): add API reference and Kitchen Sink for Presence Apr 21, 2024

sreenara added 3 commits April 21, 2024 12:33

docs(plugin-presence): fix typo and add building of presence docs to …

36f4ff2

…main package

docs(presence): add new enum for presence status types and note about…

1ebfc11

… user ids

docs(presence): fix setting self presence

f7bd0e1

sreenara assigned Kesari3008 and rarajes2 Apr 22, 2024

rarajes2 reviewed Apr 22, 2024

View reviewed changes

fix(next): merge with upstream next

08b5b9f

sreenara requested a review from a team as a code owner April 23, 2024 05:08

Kesari3008 requested changes Apr 23, 2024

View reviewed changes

sreenara added 3 commits April 23, 2024 16:30

docs(plugin-presence): incorporate comments

a20752c

docs(plugin-presence): review comment

84181cc

Merge branch 'next' of github.com:sreenara/webex-js-sdk into feat/pre…

dbfa8ba

…sence/samples

rarajes2 approved these changes Apr 23, 2024

View reviewed changes

Kesari3008 approved these changes Apr 23, 2024

View reviewed changes

sreenara merged commit d5e0804 into webex:next Apr 23, 2024
9 of 10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(samples): add API reference and Kitchen Sink for Presence #3551

docs(samples): add API reference and Kitchen Sink for Presence #3551

sreenara commented Apr 20, 2024 •

edited

rarajes2 Apr 22, 2024

sreenara Apr 23, 2024

rarajes2 Apr 22, 2024

sreenara Apr 23, 2024

rarajes2 Apr 22, 2024

sreenara Apr 23, 2024

rarajes2 Apr 22, 2024

sreenara Apr 23, 2024

rarajes2 Apr 22, 2024

sreenara Apr 23, 2024 •

edited

rarajes2 Apr 22, 2024

sreenara Apr 23, 2024

rarajes2 left a comment

Kesari3008 Apr 23, 2024

docs(samples): add API reference and Kitchen Sink for Presence #3551

docs(samples): add API reference and Kitchen Sink for Presence #3551

Conversation

sreenara commented Apr 20, 2024 • edited

COMPLETES #SPARK-492000

This pull request addresses

by making the following changes

Change Type

The following scenarios were tested

I certified that

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sreenara Apr 23, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rarajes2 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sreenara commented Apr 20, 2024 •

edited

sreenara Apr 23, 2024 •

edited