@prismicio/types - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

CHANGELOG.md

@@ -5,2 +5,19 @@ # Changelog
 
+### [0.0.4](https://github.com/prismicio/prismic-types/compare/v0.0.3...v0.0.4) (2021-05-17)
+
+
+### Bug Fixes
+
+* **document:** alternate language typing ([bce6ceb](https://github.com/prismicio/prismic-types/commit/bce6ceb6f0a8f6ff3aaea288aa87c687e69f6d95))
+
+
+### Chore
+
+* **deps:** maintain dependencies ([c113013](https://github.com/prismicio/prismic-types/commit/c113013ba5519462e16d2f9a67ff8344771de7b3))
+
+
+### Documentation
+
+* update readme and issue template ([f9bb134](https://github.com/prismicio/prismic-types/commit/f9bb13422b39ce4126acdec2ccce0cf30b01023f))
+
 ### [0.0.3](https://github.com/prismicio/prismic-types/compare/v0.0.2...v0.0.3) (2021-05-11)
@@ -7,0 +24,0 @@

dist/index.d.ts

@@ -114,2 +114,8 @@ declare type EmptyObjectField = {
 
+interface AlternateLanguage {
+    id: string;
+    uid?: string;
+    type: string;
+    lang: string;
+}
 interface PrismicDocumentHeader<TypeEnum = string, LangEnum = string> {
@@ -127,3 +133,3 @@ id: string;
     lang: LangEnum;
-    alternate_languages: LangEnum[];
+    alternate_languages: AlternateLanguage[];
 }
@@ -130,0 +136,0 @@ interface PrismicDocument<DataInterface = {

package.json

 {
   "name": "@prismicio/types",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Type definitions for Prismic related structure",
@@ -38,3 +38,3 @@ "keywords": [
     "dev": "siroc build --watch",
-    "release": "yarn build && yarn test && standard-version --release-as=patch && git push --follow-tags && yarn build && npm publish",
+    "release": "yarn build && yarn test && standard-version && git push --follow-tags && yarn build && npm publish",
     "release:dry": "standard-version --dry-run",
@@ -47,14 +47,14 @@ "release:alpha": "yarn build && yarn test && standard-version --release-as minor --prerelease alpha && git push --follow-tags && yarn build && npm publish --tag alpha",
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "4.22.1",
-    "@typescript-eslint/parser": "4.22.1",
-    "eslint": "7.26.0",
-    "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-prettier": "3.4.0",
-    "prettier": "2.3.0",
-    "siroc": "0.9.2",
-    "standard-version": "9.3.0",
-    "typescript": "4.2.4"
+    "@typescript-eslint/eslint-plugin": "^4.23.0",
+    "@typescript-eslint/parser": "^4.23.0",
+    "eslint": "^7.26.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "prettier": "^2.3.0",
+    "siroc": "^0.10.0",
+    "standard-version": "^9.3.0",
+    "typescript": "^4.2.4"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=12.7.0"
   },
@@ -61,0 +61,0 @@ "publishConfig": {

README.md

 # @prismicio/types
 
+[![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]
+
 > ⚠ This project is in an experimental state and therefore primarily meant to be used by Prismic kits. Use it at your own risks or stay tuned for the official release!
 
+Type definitions for [Prismic][prismic] related structure.
+
+- 📄  Per-field type definitions;
+- 🌐  Dedicated GraphQL API support.
+
+## Install
+
+```bash
+npm install --save-dev @prismicio/types
+```
+
+## Documentation
+
+To discover what's new on this package check out [the changelog][changelog]. For full documentation, visit the [official Prismic documentation][prismic-docs].
+
+## Contributing
+
+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!
+
+**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.
+
+**Reporting a bug**: [Open an issue][repo-bug-report] explaining your application's setup and the bug you're encountering.
+
+**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 PR][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.
+
 ## License
@@ -22,1 +56,26 @@
 ```
+
+<!-- Links -->
+
+[prismic]: https://prismic.io
+[prismic-docs]: https://prismic.io/docs/technologies/javascript
+[changelog]: /CHANGELOG.md
+[forum-question]: https://community.prismic.io/c/kits-and-dev-languages/javascript/14
+[repo-bug-report]: https://github.com/prismicio/prismic-types/issues/new?assignees=&labels=bug&template=bug_report.md&title=
+[repo-feature-request]: https://github.com/prismicio/prismic-types/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
+[repo-pull-requests]: https://github.com/prismicio/prismic-types/pulls
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/@prismicio/types/latest.svg
+[npm-version-href]: https://npmjs.com/package/@prismicio/types
+[npm-downloads-src]: https://img.shields.io/npm/dm/@prismicio/types.svg
+[npm-downloads-href]: https://npmjs.com/package/@prismicio/types
+[github-actions-ci-src]: https://github.com/prismicio/prismic-types/workflows/ci/badge.svg
+[github-actions-ci-href]: https://github.com/prismicio/prismic-types/actions?query=workflow%3Aci
+[codecov-src]: https://img.shields.io/codecov/c/github/prismicio/prismic-types.svg
+[codecov-href]: https://codecov.io/gh/prismicio/prismic-types
+[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/types.svg
+[license-href]: https://npmjs.com/package/@prismicio/types

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

28673

increased by15.03%

Lines of code

229

increased by2.69%

Number of lines in readme file

81

increased by268.18%

No dependency changes