@ta-interaktiv/newsnet-api-flow-types - npm Package Compare versions

Comparing version 0.3.0 to 0.4.0

CHANGELOG.md

@@ -0,1 +1,16 @@
+<a name="0.4.0"></a>
+# [0.4.0](https://gitlab.com/ta-interaktiv/newsnet-api-flow-types/compare/0.3.0...0.4.0) (2017-08-16)
+
+
+### Feature
+
+* Added information from '/api/sites/default' ([5282831ecd80c185a18d5324c7cb1b3998e7f961](https://gitlab.com/ta-interaktiv/newsnet-api-flow-types/commit/5282831ecd80c185a18d5324c7cb1b3998e7f961))
+
+### Fix
+
+* Change package.json scripts to not git-tag on `npm version` ([7af300e06c61bd99bd2d508753dae377ad44829e](https://gitlab.com/ta-interaktiv/newsnet-api-flow-types/commit/7af300e06c61bd99bd2d508753dae377ad44829e))
+* Export Site and SiteContent. ([d866049bcba3c4c9899bc9ce639160b19ebf7344](https://gitlab.com/ta-interaktiv/newsnet-api-flow-types/commit/d866049bcba3c4c9899bc9ce639160b19ebf7344))
+
+
+
 <a name="0.3.0"></a>
@@ -2,0 +17,0 @@ # [0.3.0](https://gitlab.com/ta-interaktiv/newsnet-api-flow-types/compare/0.2.0...0.3.0) (2017-08-15)

index.js

 // @flow
 
-export type { Article, ArticleContent } from './api/articles/article/index'
-export type { Author } from './api/articles/article/author'
-export type { Statistic } from './api/articles/article/external_services/statistic'
-export type { Community } from './api/articles/article/communities/community'
-export type { Communities } from './api/articles/article/communities/index'
+export type {Article, ArticleContent} from './api/articles/article/index'
+export type {Author} from './api/articles/article/author'
+export type {Statistic} from './api/articles/article/external_services/statistic'
+export type {Community} from './api/articles/article/communities/community'
+export type {Communities} from './api/articles/article/communities/index'
+export type {Site, SiteContent} from './api/sites/default'

package.json

 {
   "name": "@ta-interaktiv/newsnet-api-flow-types",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Flow type definitions for stuff the Newsnet API returns.",
@@ -9,7 +9,7 @@ "main": "index.js",
     "docs": "documentation readme ./api --section=API",
-    "version:patch": "npm version patch && yarn run docs && yarn run changelog && git commit -am 'Patch Version bump, changelog and documentation update.' && yarn run git-tag",
-    "version:minor": "npm version minor && yarn run docs && yarn run changelog && git commit -am 'Minor Version bump, changelog and documentation update.' && yarn run git-tag",
-    "version:major": "npm version major && yarn run docs && yarn run changelog && git commit -am 'Major Version bump, changelog and documentation update.' && yarn run git-tag",
+    "version:patch": "npm version patch --no-git-tag-version && yarn run docs && yarn run changelog && git commit -am 'Patch Version bump, changelog and documentation update.' && yarn run git-tag",
+    "version:minor": "npm version minor --no-git-tag-version && yarn run docs && yarn run changelog && git commit -am 'Minor Version bump, changelog and documentation update.' && yarn run git-tag",
+    "version:major": "npm version major --no-git-tag-version && yarn run docs && yarn run changelog && git commit -am 'Major Version bump, changelog and documentation update.' && yarn run git-tag",
     "changelog": "conventional-changelog -p eslint -i CHANGELOG.md -s",
-    "git-tag": "PACKAGE_VERSION=$(node -p \"require('./package.json').version\") && git tag -a $PACKAGE_VERSION -m 'New version ${PACKAGE_VERSION}'"
+    "git-tag": "PACKAGE_VERSION=$(node -p \"require('./package.json').version\") && git tag -a $PACKAGE_VERSION -m \"New version ${PACKAGE_VERSION}\""
   },
@@ -16,0 +16,0 @@ "files": [

README.md

@@ -150,2 +150,37 @@ # Newsnet API Flow Types
 
+### Site
+
+General information about the site.
+
+Provided by `/api/sites/default`
+
+Type: {site: [SiteContent](#sitecontent)}
+
+**Properties**
+
+-   `site` **[SiteContent](#sitecontent)** 
+
+### SiteContent
+
+Common information about the site.
+
+Type: {id: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), name_short: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), name: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), title: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), language: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), feedback_url: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), facebook_id: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), facebook_url: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), twitter_via: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), gtm_id: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), paywall_status: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), statistics: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Statistic](#statistic)>, external_services: {statistics: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Statistic](#statistic)>}}
+
+**Properties**
+
+-   `id` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+-   `name_short` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+-   `name` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+-   `title` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+-   `language` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+-   `feedback_url` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+-   `facebook_id` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+-   `facebook_url` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+-   `twitter_via` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+-   `gtm_id` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+-   `paywall_status` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** 
+-   `statistics` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Statistic](#statistic)>** 
+-   `external_services` **{statistics: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Statistic](#statistic)>}** 
+-   `external_services.statistics` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Statistic](#statistic)>** 
+
 ## Contributing
@@ -152,0 +187,0 @@

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

24683

increased by25.92%

Number of package files

11

increased by10%

Lines of code

156

increased by27.87%

Number of lines in readme file

206

increased by20.47%

No dependency changes