├── README.md
└── LICENSE


/README.md:
--------------------------------------------------------------------------------
  1 | # unity-component-specification
  2 | This is a WIP draft of the Unity (Single File Web Component) Specification
  3 | 
  4 | # Abstract
  5 | Unity Component Specification describes a new hypertext-like file format for creating Single-File Web Components (SFWC).
  6 | 
  7 | ## Goals
  8 | * rosetta stone-like capabilities component interop between frameworks.
  9 |   * provides a promise for users, companies, lib authors to have a single "meta" description of how their "ui component" should function, meanwhile using modern tooling, and small compiler chains, could compile this "meta" information into the framework's actual representation. 
 10 | 
 11 | * allow users to ship way less JavaScript and CSS to the browser
 12 | 
 13 | * 60fps scroll lists, fast dom changes, fast paints. "Does it beat the Ken Wheeler Test" (long term platform goal)
 14 | 
 15 | ## Scenario:
 16 | Giant company (A) is silo'd and has a variety of different frameworks that they use in house, and they all love the workflows that they have, however there is massive amounts of overlap because they cannot write components that both teams can use. 
 17 | 
 18 | With "unity components" (Single File Components) this could be possible: Team A using `Preact` _(Figure 1)_, could use this component in the same way that Team B using 'Vue' _(Figure 2)_ does. 
 19 | 
 20 | **Figure 1: Using `Button.sfc` in `.js` file and consumed with preact `render()` fn**
 21 | ```js
 22 | import {Button} from "material-unity" // returns a SFC "module" .sfc or .vue, etc whatever
 23 | 
 24 | render(
 25 |     <Button someProp="whatever" />,
 26 |     document.body
 27 | );
 28 | ```
 29 | 
 30 | **Figure 2: Using same `Button.sfc` inside of a Vue single file component**
 31 | ```html
 32 | <template>
 33 |     <div>
 34 |         <button some-prop="whatever"></button>
 35 |     </div>
 36 | </template>
 37 | <script>
 38 | import {Button} from "material-unity" // returns a SFC "module" .sfc or .vue, etc whatever
 39 | export default {
 40 |   components: {
 41 |     Button
 42 |   }
 43 | }
 44 | </script>
 45 | <style>
 46 |   /* ... */
 47 | </style>
 48 | ```
 49 | 
 50 | The point is that the framework-specific implementation details of how this "meta information" represented in the Single File Component are hidden through the compiler toolchains.
 51 | 
 52 | So although you might see `data(){}` function that returns state for the component, it may instead compile to `state` in react/preact, or `@tracked` in GlimmerJS. 
 53 | 
 54 | ## How this relates to the platform (the long term idea if frameworks buy in  @first)
 55 | Although this statement may be opinionated, it is observed that the number one problem with web components currently is that it is a write only target, not something a framework could consume and then use (like their own systems components) without potentially substantial changes to their respective api's, renders, etc. This poses a huge challenge for adoption. 
 56 | 
 57 | In addition, until there is cross-platform adoption for Web Components completely, there is really no interest for a majority of users or framework teams to start integrating with this system.
 58 | 
 59 | ## Abstraction not only for Frameworks, but also the Platform
 60 | The magic behind what makes Vue's single file component structure so flexible and powerful, is that everything inside of their respective tags, is only a "likeness" to some extent.
 61 | 
 62 | For example: 
 63 | ```html
 64 | <template>
 65 |   <div>I look and smell like HTML, but I'm not HTML. I'm HTML-like</div>
 66 | </template>
 67 | <style>
 68 | .div {
 69 |   likeness: to-css;
 70 | }
 71 | </style>
 72 | <script>
 73 | export default {
 74 |   data() {
 75 |     maybe: "Interpreted through the context of the component, but technically this could _not_ really be JavaScript, just a state machine's instructions"
 76 |   }
 77 | }
 78 | </script>
 79 | ```
 80 | 
 81 | In the same way that:
 82 | ```jsx
 83 | render(
 84 |    <JSX>I look and smell like HTML, but I'm not html, I'm JSX, I'm html-like</JSX>,
 85 |    document.body
 86 | )
 87 | ```
 88 | 
 89 | So in the same way that a loader, compiler, etc. statically analyzes a `.vue` file to create a JavaScript implementation of that components Dom API functionality (via VDOM), we can apply the same principle for the platform to accomplish the same thing. 
 90 | 
 91 | *In a real index.html file*
 92 | 
 93 | ```html
 94 | <head>
 95 | <module type="unity" name="unity-button" src="./unity-components/button.sfc" />
 96 | <head>
 97 | 
 98 | <body>
 99 |   <unity-button some-prop="whatever">Click Me</unity-button>
100 | </body>
101 | ```
102 | 
103 | We have fed a single component to the browser, which consumes the SFC module, and instead of creating render functions, vdom, JSX, javascript, or anything else, it is interpreted and compiled to _native instructions_ for the lifecycle, state, and the visual representation and behavior for that element on the DOM. 
104 | 
105 | ## Side Notes:
106 | Here's some things I want to clarify before they get mentioned
107 | 
108 | ### Template "Directives" 
109 | A huge motivation for the use of these universal directives, is the same reason why they are great in VueJs. Although at any time, in a single-file `.vue` component, a user can drop `<template></template>` and instead opt-in to using `render(<JSX/>, document.body)` instead. 
110 | 
111 | But in the end (for vue): 
112 | ```html
113 | <template>
114 |   <div v-for="item of 1000000items">{{item}}</div>
115 | </template>
116 | ```
117 | is just an abstraction that compiles to VDOM/Render functions to perform that ginormous scrolling list. The benefit of the platform consuming this, is that it can read that directive as an instruction to perform the same results, but in a far more, Ken Wheeler-defying-90fps-fashion (because its not DOM, or JS, its native instructions interpreted from the file).
118 | 
119 | ### JSX inside of `<script>`
120 | In the same way that `<template></template>` can be statically analyzed and compiled, you can take this a step further and say the use of JSX inside of `<script></script>` could have a similar outcome. 
121 | 
122 | ### Pros: 
123 | * Native calls are fast, no JavaScript DOM API's are called, the render, layout engines, etc. now can compile and manage these just like another implementation detail as direct "assembly like instructions" for how things must be viewed, laid out, painted et al.
124 | * There is no need to Custom Elements, it is native instructions, there needs to be no extension of existing elements or behaviors. 
125 | * What might compile to a couple hundred lines of code, and be shipped inside of JS, CSS, could now be shipped in a single file, in a non blocking fashion. 
126 | * (Maybe? I'm not an expert in the browser to understand this piece yet) patterns like `<style scoped>` provides a css-like scoping solution that doesn't have to rely on shadow dom, etc.
127 | * It doesn't rely on pieces of the existing web component specification, and browsers, (as long as its implemented), could implement this however they would like for their respective platforms, etc.
128 | * Using in the browser outside of the FW, could be as simple as just dropping the component into a `<tag>` and using. And this could potentially create a Rosetta Stone-like api for interop between a variety of frameworks (if not all). 
129 | * webpack users could still leverage their own styling and template tools/preprocessors of choice, and webpack will (if this spec is pushed, or at the least 3+ frameworks can adopt it), create an output target for `.sfc`. That way loaders can still be used to allow one to customize, extend etc while still compiling to `.sfc` in browserland.
130 | 
131 | ### Cons:
132 | * Silver bullet syndrome: things that become abstracted, can lose flexibility, or have features removed to create interop. This should be carefully balanced and thought out. 
133 | 
134 | * Not all frameworks can statically compile these formats? (If not what is the MVP amount of changes that we could make to ensure that not only VDOM-frameworks, but also observer, watcher, and bind based libraries can leverage as well. 
135 | 
136 | * Can dilute the framework capabilities of a specific component type? What may work with a full rich featureset in `.vue`, may need to have limited capabilities in GlimmerJS, or Polymer. (Or am I wrong. I don't know enough about them to make this assumption, but would like feedback on this.)
137 | 
138 | * Pushback in browserland vs WC v2.: Although this could arise, I'm hopeful that because the `.sfc` format doesn't mandate creation of API's that affect DOM (besides a new module/script type), that this could be easily worked around, and potentially alongside WC v2.
139 | 
140 | # Use Cases
141 | Currently there are multiple JavaScript web frameworks that use an interoperable Single-File Web Component format. Not only are they a unifying formate between frameworks, but should aim to be a native platform implementation.
142 | 
143 | # Unity Component Module
144 | **hello-world.ucm**
145 | ```html
146 | <template>
147 |     <h1>Hello {{world}}!</h1>
148 | </template>
149 | 
150 | <style>
151 |     h1 {
152 |         background: "red";
153 |     };
154 | </style>
155 | 
156 | <script>
157 |   export default {
158 |     data() {
159 |       return {
160 |         world: "world"
161 |       }
162 |     }
163 |   }
164 | </script>
165 | ```
166 | 
167 | ## Interface
168 | This file format will support a strict subset of hypertext markup tags that will delimit and distinguish the use of JavaScript, HTML, and CSS in the single file. 
169 | 
170 | ### `<template></template>` tags
171 | 
172 | #### Syntax
173 | * Any uses of valid HTML, will be valid inside of the `<template></template>` tags.
174 | * Always single element root? (like vdom'y stuff or not needed for native implementation)
175 | 
176 | #### Data Binding
177 | * `{{ }}` will be the syntax. (should we even try to allow this to be overriden?)
178 | * Any valid expression within braces
179 | * `v-bind=` mentioned here?
180 | 
181 | #### Directives 
182 | * Explain what the hell a directive does. Could this specification allow for the creation of JS directives, but all built ins are native for performance? 
183 | * List of Built in Directives? 
184 | 
185 | ### `<style></style>` tags
186 | 
187 | #### Syntax
188 | * Any uses of valid CSS is permitted inside of the `<style></style>` tags.
189 | 
190 | #### Scoped? 😬
191 | 
192 | ### `<script></script>` tags
193 | 
194 | #### Syntax
195 | * Any uses of valid JS is permitted inside of the `<script></script>` tags.
196 | * Must `export default` a object of properties describing available data bindings, props, computed properties, other registered UCM's, declarations and all other Unity Component Module options. 
197 | 
198 | #### UCM Options Object
199 | * // TODO: Add all the Vue Component options here. 
200 | 
201 | 
202 | 
203 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "{}"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright {yyyy} {name of copyright owner}
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 


--------------------------------------------------------------------------------