@prismicio/vue 2.0.11 → 2.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,176 +1,108 @@
-![alt text](https://prismic.io/...1b58998/images/logo-dark.svg)
+<!--
 
-[![npm version](https://badge.fury.io/js/%40prismicio%2Fvue.svg)](http://badge.fury.io/js/@prismicio/vue)
+Replace all on all files (README.md, CONTRIBUTING.md, bug_report.md, package.json):
+- @prismicio/vue
+- Vue plugin, components, and composables to fetch and present Prismic content
+- prismicio/prismic-vue
+- prismic-vue
 
-# @prismicio/vue V₂
+-->
 
-> Vue.js plugin to facilitate integration of content managed with [Prismic.io](https://prismic.io).
-Looking for a Nuxt solution? Here you go 👉 [@nuxtjs/prismic plugin](https://github.com/nuxt-community/prismic)
+# @prismicio/vue
 
-# Install
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
+[![Codecov][codecov-src]][codecov-href]
+[![Conventional Commits][conventional-commits-src]][conventional-commits-href]
+[![License][license-src]][license-href]
 
-⚠️ We've moved `prismic-vue` to `@prismicio/vue`. You can safely replace the former with the latter to your node modules ✌️
+<!-- TODO: Replacing link to Prismic with [Prismic][prismic] is useful here -->
 
-`@prismic/vue` relies on `@prismicio/client` and `prismic-dom`.
-If you are migrating from V1, make sure to install them too as they are now peer dependencies.
-``` bash
-npm install @prismicio/vue @prismicio/client prismic-dom
-```
-👉 quick note: @prismicio/client is a library responsible for _making requests to your Prismic endpoint_,
-while prismic-dom is responsible for serializing html from RichText ([RichText you said?](https://user-guides.prismic.io/en/articles/383762-rich-text)).
-
-# What it does
-
-This package serves two purposes and can actually be split into two different parts.
+[Vue][vue] plugin and components to fetch and present [Prismic][prismic] content.
 
-#### 1- Queries
-The first purpose of `@prismicio/vue` is to offer an easy way to fetch your Prismic content. When registering `PrismicVue`, we directly inject a `@prismicio/client` instance, to be used anywhere in your Vue project.
+- 📝 &nbsp;Display content from Prismic like [Rich Text][prismic-rich-text] and [Link][prismic-link] fields;
+- 🍡 &nbsp;Render Prismic [Slice Zones][prismic-slices] declaratively with Vue components;
+- 🎣 &nbsp;Fetch Prismic content using Vue [options-api].
 
-``` javascript
-import prismicJS from 'prismic-js';
+## Install
 
-const PrismicVue = {
-  install: function (Vue, options) {
-    Vue.prototype.$prismic = prismicJS
-    Vue.prototype.$prismic.endpoint = options.endpoint
-    Vue.prototype.$prismic.linkResolver = options.linkResolver
-    Vue.prototype.$prismic.client = prismicJS.client(options.endpoint, options.apiOptions)
-    ...
-  }
-}
+```bash
+npm install @prismicio/vue
 ```
 
-### 2 - Components
-
-The second purpose of `@prismicio/vue` is to globally register components that will help you _display content queried via your Prismic API_. Their purpose is (mostly) to serialize Prismic data into html. These components being used in other libraries (like `@nuxtjs/prismic`), note that you can actually import them without registering `PrismicVue`.
-
-
-# Usage
+## Documentation
 
-This [getting started guide](https://prismic.io/docs/vuejs/getting-started/integrating-with-existing-project) should be of great help to kickstart your first Prismic/Vue project.
-In case you're more into markdown, you can alternatevely keep reading ☺️
+<!-- To discover what's new on this package check out [the changelog][changelog]. -->
 
-### 1/Register PrismicVue
-First, you should register the plugin:
-```javascript
-import PrismicVue from '@prismicio/vue'
-
-Vue.use(PrismicVue, {
-  endpoint: 'https://your-api-endpoint.prismic.io/api/v2',
-  linkResolver: function(doc) {
-    if (doc.type === 'home') {
-        return '/';
-    }
-  },
-});
-```
-
-When registering the plugin, you may pass these options. Although `linkResolver` and `htmlSerializer` are not required, they are usually pretty useful. Make sure to check them out! ✌️
-
-
-| Option name    	| Type     	| Required 	| Default value 	| Description                                                                                                          	|
-|----------------	|----------	|----------	|---------------	|----------------------------------------------------------------------------------------------------------------------	|
-| endpoint       	| string   	| yes      	| none          	| Your Prismic api endpoint                                                                                            	|
-| linkResolver   	| function 	| no       	| none          	| See [Link Resolving in Javascript](https://prismic.io/docs/javascript/beyond-the-api/link-resolving)                 	|
-| htmlSerializer 	| function 	| no       	| none          	| See [html Serializer documentation](https://prismic.io/docs/javascript/beyond-the-api/html-serializer)               	|
-| linkType       	| string   	| no       	| vueRouter     	| Link components may be handled differently based on what you use. Currently accepted values: 'vueRouter' and 'nuxt'. 	|
-
-### 2/Query your content
-Because we inject a `@prismicio/client` instance into Vue, each of its method are accessible from your components. Make sure to check [its documentation](https://github.com/prismicio/prismic-javascript)!
-
-A bare bone example that fetches data from a `home` document and then sets a `fields` data object:
-```javascript
-export default {
-  name: 'MyComponent',
-  data() {
-    return {
-      fields: {
-        title: [],
-        logo: {},
-        somethingRich: []
-      }
-    }
-  },
-  methods: {
-    getContent () {
-      this.$prismic.client.getSingle('home')
-        .then((document) => {
-          this.fields = document.data
-        })
-    }
-  },
-  created () {
-    this.getContent();
-  }
-}
-```
-
-### 3/use components
-Following the example above, let's write the associated template:
-
-```html
-<template>
-  <section>
-    <prismic-image :field="fields.logo" />
-    <prismic-rich-text :field="fields.title" />
-    <prismic-rich-text :field="fields.somethingRich" />
-  </section>
-</template>
-```
+For full documentation, visit the [official Prismic documentation][prismic-docs].
 
-> :warning: In-dom templates don't support self-closing tags, close them manually instead, e.g.: `<prismic-image :field="fields.logo"></prismic-image>` 
+## Contributing
 
-👆 If you were to log `document.data` in our previous query, you would notice that `title` and `somethingRich` are actually arrays instead of strings. This is because Prismic provides content writers with a WYSIWYG editor. It's awesome for formatting text but harder to deal with on client side. Fortunately, `prismic-rich-text` is a component made to deal with this format.
+Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!
 
-Obviously, `prismic-image` works the same way on image fields, stored in your Prismic API.
+**Asking a question**: [Open a new topic][forum-question] on our community forum explaining what you want to achieve / your question. Our support team will get back to you shortly.
 
-# List of components
+**Reporting a bug**: [Open an issue][repo-bug-report] explaining your application's setup and the bug you're encountering.
 
-List of available components and use cases:
+**Suggesting an improvement**: [Open an issue][repo-feature-request] explaining your improvement or feature so we can discuss and learn more.
 
+**Submitting code changes**: For small fixes, feel free to [open a pull request][repo-pull-requests] with a description of your changes. For large changes, please first [open an issue][repo-feature-request] so we can discuss if and how the changes should be implemented.
 
-| Component         	| Prismic type      	| Use case                                                         	| Example use                                                                                         	|
-|-------------------	|-------------------	|------------------------------------------------------------------	|-----------------------------------------------------------------------------------------------------	|
-| prismic-rich-text 	| Rich Text, Title 	| Used when you need formatting fir text (bold, italic, embeds...) 	| `<prismic-rich-text :field="field.description" wrapper="div" :htmlSerializer="myLocalSerializer"/>` 	|
-| prismic-link      	| Link              	| Used to resolve links stored in your Prismic content.            	| `<prismic-link :field="menuLink.link">My link</prismic-link>`                                       	|
-| prismic-image     	| Image             	| Used to display images stored in Prismic.                        	| `<prismic-image :field="fields.logo" />`                                                            	|
-| prismic-embed     	| Embed             	| Used to display embeds stored in Prismic.                        	| `<prismic-embed :field="fields.embed" wrapper="div" />`                                             	|
+<!-- For more clarity on this project and its structure you can also check out the detailed [CONTRIBUTING.md][contributing] document. -->
 
-👆 Make sure to have a look at their source code: it is quite short, does simple things and might help you understand how we convert a Prismic API response into something that can actually be committed to the DOM.
-
-# Integrate @prismicio/vue components
-
-If you are working on a `@prismicio/vue` integration (like Nuxt does for example), you might find the need to use the components, without using the actual `PrismicVue` plugin. We've got you covered:
-
-```javascript
-import { common, vueRouter, nuxt } from '@prismicio/vue/components';
-
-console.log(common) // { Embed, Image, RichText ...}
-console.log(nuxt) // { Link }
-// etc.
-
-Vue.prototype.$prismic = {
-  // because some components
-  // require a link resolver
-  linkResolver() { /* ... */}
-}
+## License
 
-// Register common components
-Object.entries(common).forEach(([_, component]) => {
-    Vue.component(component.name, component)
-})
 ```
+   Copyright 2013-2021 Prismic <contact@prismic.io> (https://prismic.io)
 
-Thanks for reading 👋
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
 
----
+       http://www.apache.org/licenses/LICENSE-2.0
 
-## License
-
-This software is licensed under the Apache 2 license, quoted below.
-
-Copyright 2013-2020 Prismic (http://prismic.io).
-
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+```
 
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+<!-- Links -->
+
+[prismic]: https://prismic.io
+
+<!-- TODO: Replace link with a more useful one if available -->
+
+[prismic-docs]: https://prismic.io/docs/technologies/vuejs
+[changelog]: ./CHANGELOG.md
+[contributing]: ./CONTRIBUTING.md
+[vue]: https://v3.vuejs.org
+[prismic-rich-text]: https://prismic.io/docs/core-concepts/rich-text-title
+[prismic-link]: https://prismic.io/docs/core-concepts/link-content-relationship
+[prismic-slices]: https://prismic.io/docs/core-concepts/slices
+[vue-composition]: https://v3.vuejs.org/guide/composition-api-introduction.html
+[vue-options]: https://v3.vuejs.org/guide/introduction.html
+
+<!-- TODO: Replace link with a more useful one if available -->
+
+[forum-question]: https://community.prismic.io/c/kits-and-dev-languages/vue-js/16
+[repo-bug-report]: https://github.com/prismicio/prismic-vue/issues/new?assignees=&labels=bug&template=bug_report.md&title=
+[repo-feature-request]: https://github.com/prismicio/prismic-vue/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
+[repo-pull-requests]: https://github.com/prismicio/prismic-vue/pulls
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/@prismicio/vue/latest.svg
+[npm-version-href]: https://npmjs.com/package/@prismicio/vue
+[npm-downloads-src]: https://img.shields.io/npm/dm/@prismicio/vue.svg
+[npm-downloads-href]: https://npmjs.com/package/@prismicio/vue
+[github-actions-ci-src]: https://github.com/prismicio/prismic-vue/workflows/ci/badge.svg
+[github-actions-ci-href]: https://github.com/prismicio/prismic-vue/actions?query=workflow%3Aci
+[codecov-src]: https://img.shields.io/codecov/c/github/prismicio/prismic-vue.svg
+[codecov-href]: https://codecov.io/gh/prismicio/prismic-vue
+[conventional-commits-src]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
+[conventional-commits-href]: https://conventionalcommits.org
+[license-src]: https://img.shields.io/npm/l/@prismicio/vue.svg
+[license-href]: https://npmjs.com/package/@prismicio/vue