proto-player-wc 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Richard Hess
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,58 @@
+# proto-player-wc
+
+a technology POC...
+
+![architecture](./architecture.png)
+
+## usage
+
+```
+yarn install
+yarn demo
+```
+
+## features
+
+- stencil based web component
+- uses mitt for an eventbus
+- a single player component (on the root page)
+- many activator components (can be floating elements)
+- activators use the eventbus to communicate to the player
+- player has an overlay and iframe
+- player uses postMessage to communicate to/from iframe
+- uses a `resize-iframe` message to pass size back to the player web component
+
+## architecture
+
+The architecture for this is a decoupled (ie. loosely-coupled) one, where there's a single player component (on the root page) and potentially many activator components on a page.  A simple event bus is used to tie everything together and the only connector is `activate` events which the player component listens for.  This means it's also possible to create and emit these `activate` events directly from code on the page, even if you choose not to use the activator web components.
+
+This approach allows for the activator web components to be placed anywhere on the page (simple or floating elements).  The only real coupling is the event bus `name`, which you pass to all of the individual web components on the page.  This allows for the integrator (ie. consuming application) to define the name used for the event bus on the `window` object.
+
+The player component lives on the root of the page and is essentially an invisible element (0x0) on that page.  It provides a simple overly and a psuedo modal which displays the actual player within it.  The toplevel wrapper in this modal is an iframe which gives us the ability to isolate ALL of the idiosyncrasies of the actual player from the composing application.
+
+We recommend using [mitt][mitt-io] for the event bus because of both it's simplicity and size (only 200 bytes).
+
+## integration
+
+At a minimum, an integrator would need to add the following to their page:
+
+1. create an event bus using [mitt][mitt-io]
+2. store this event bus on the `window` object with a `name`
+3. add the `proto-player` web component to the base page
+4. add one or more `proto-activator` web components on this same page
+5. pass the `name` of the event bus to all of these web components, using attributes
+6. Done, it just works...
+
+## articles
+
+- [The ultimate guide to iframes][u-iframes] - _LogRocket_
+
+## references
+
+- [mitt][mitt-io] - _tiny 200 byte functional event emitter / pubsub._
+
+[float-ui]: https://github.com/floating-ui/floating-ui
+[mitt-io]: https://github.com/developit/mitt
+[nano-id]: https://github.com/ai/nanoid
+[nano-uuid]: https://blog.bitsrc.io/why-is-nanoid-replacing-uuid-1b5100e62ed2
+[u-iframes]: https://blog.logrocket.com/the-ultimate-guide-to-iframes/

package/dist/cjs/app-globals-3a1e7e63.js

@@ -0,0 +1,5 @@
+'use strict';
+
+const globalScripts = () => {};
+
+exports.globalScripts = globalScripts;