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

Comparing version 0.2.0 to 0.3.0

CHANGELOG.md

@@ -0,1 +1,15 @@
+<a name="0.3.0"></a>
+# [0.3.0](https://gitlab.com/ta-interaktiv/newsnet-api-flow-types/compare/0.2.0...0.3.0) (2017-08-15)
+
+
+### Chore
+
+* Updated documentation ([b473438b1bb3904fd561230d6e189ede12750866](https://gitlab.com/ta-interaktiv/newsnet-api-flow-types/commit/b473438b1bb3904fd561230d6e189ede12750866))
+
+### Feature
+
+* Added "community" documentation. ([3c5bf0a2852edc7723aee16a53ac9084056f9c5b](https://gitlab.com/ta-interaktiv/newsnet-api-flow-types/commit/3c5bf0a2852edc7723aee16a53ac9084056f9c5b))
+
+
+
 <a name="0.2.0"></a>
@@ -2,0 +16,0 @@ # [0.2.0](https://gitlab.com/ta-interaktiv/newsnet-api-flow-types/compare/0.1.1...0.2.0) (2017-08-10)

index.js

 // @flow
 
-export type { Article, ArticleContent } from './src/article'
-export type { Author } from './src/author'
-export type { Statistic } from './src/statistic'
+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'

package.json

 {
   "name": "@ta-interaktiv/newsnet-api-flow-types",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Flow type definitions for stuff the Newsnet API returns.",
@@ -8,3 +8,3 @@ "main": "index.js",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "docs": "documentation readme ./src --section=API",
+    "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",
@@ -18,3 +18,3 @@ "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",
     "index.js",
-    "src"
+    "api"
   ],
@@ -21,0 +21,0 @@ "keywords": [

README.md

@@ -11,2 +11,100 @@ # Newsnet API Flow Types
 
+### Author
+
+-   **See: [Article](#article)**
+
+Author object, being part of `/api/articles/<legacy_id>`
+
+Type: {type: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), id: [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), description: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?, url: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), picture: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?, twitter: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?, rss: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)}
+
+**Properties**
+
+-   `type` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+-   `id` **[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)** 
+-   `description` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
+-   `url` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+-   `picture` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
+-   `twitter` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
+-   `rss` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+
+### CommunityType
+
+The available types of communities so far.
+
+Type: (`"dark"` \| `"facebook"` \| `"twitter"` \| `"whatsapp"` \| `"share"` \| `"comment"`)
+
+### DateString
+
+Date string, of the form "dd.MM.YYYY HH:mm:SS".
+
+Type: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
+
+### Community
+
+Community object, used for providing social media information.
+
+Type: {type: [CommunityType](#communitytype), count: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), article_id: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), refresh: [DateString](#datestring), cache: ([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)), share_type_id: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), url: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?, description: [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)?, description: [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)?, via: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?, allow_comments_weekdays: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?, allow_comments_weekends: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?, comment_count_text: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?}
+
+**Properties**
+
+-   `type` **[CommunityType](#communitytype)** 
+-   `count` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** 
+-   `article_id` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+-   `refresh` **[DateString](#datestring)** 
+-   `cache` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean))** 
+-   `share_type_id` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+-   `url` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
+-   `description` **[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)?** 
+-   `description` **[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)?** 
+-   `via` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
+-   `allow_comments_weekdays` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** 
+-   `allow_comments_weekends` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** 
+-   `comment_count_text` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
+
+### Communities
+
+Community list, as provided by `/api/articles/<legacy_id>/communities`
+
+Type: {communities: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Community](#community)>}
+
+**Properties**
+
+-   `communities` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Community](#community)>** 
+
+### External_Services
+
+External services combines several meta data about an article.
+
+Provided by `/api/articles/<legacy_id>/external_services`
+
+Type: {configs: any, paywall: any, ads: any, statistics: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Statistic](#statistic)>, communities: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Community](#community)>}
+
+**Properties**
+
+-   `configs` **any** 
+-   `paywall` **any** 
+-   `ads` **any** 
+-   `statistics` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Statistic](#statistic)>** 
+-   `communities` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Community](#community)>** 
+
+### Statistic
+
+-   **See: [Article](#article)**
+
+Basic statistic object. 
+
+Part of `/api/articles/<legacy_id>` and
+`/api/articles/<legacy_id>/external_services`.
+
+Type: {provider: (`"wemf"` \| `"webseismo"` \| `"gtm"`), type: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)}
+
+**Properties**
+
+-   `provider` **(`"wemf"` \| `"webseismo"` \| `"gtm"`)** 
+-   `type` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+
 ### Article
@@ -53,37 +151,2 @@
 
-### Author
-
--   **See: [Article](#article)**
-
-Author object, being part of `/api/articles/<legacy_id>`
-
-Type: {type: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), id: [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), description: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?, url: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), picture: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?, twitter: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?, rss: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)}
-
-**Properties**
-
--   `type` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
--   `id` **[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)** 
--   `description` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
--   `url` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
--   `picture` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
--   `twitter` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
--   `rss` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-
-### Statistic
-
--   **See: [Article](#article)**
-
-Basic statistic object. 
-
-Part of `/api/articles/<legacy_id>` and
-`/api/articles/<legacy_id>/external_services`.
-
-Type: {provider: (`"wemf"` \| `"webseismo"` \| `"gtm"`), type: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)}
-
-**Properties**
-
--   `provider` **(`"wemf"` \| `"webseismo"` \| `"gtm"`)** 
--   `type` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-
 ## Contributing
@@ -90,0 +153,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

19602

increased by60.47%

Number of package files

10

increased by42.86%

Lines of code

122

increased by74.29%

Number of lines in readme file

171

increased by58.33%

No dependency changes