@stencila/schema - npm Package Compare versions

Comparing version 1.5.2 to 1.5.3

CHANGELOG.md

@@ -0,1 +1,8 @@
+## [1.5.3](https://github.com/stencila/schema/compare/v1.5.2...v1.5.3) (2021-05-06)
+
+
+### Bug Fixes
+
+* **Works:** Put all types derived from CreativeWork in works category ([1b72009](https://github.com/stencila/schema/commit/1b720096ce7d0b7c9ac617129b2ad911a28d8aa6))
+
 ## [1.5.2](https://github.com/stencila/schema/compare/v1.5.1...v1.5.2) (2021-05-06)
@@ -2,0 +9,0 @@

dist/Article.schema.json

@@ -5,6 +5,7 @@ {
   "extends": "CreativeWork",
+  "category": "works",
   "role": "primary",
   "status": "unstable",
-  "category": "other",
   "description": "An article, including news and scholarly articles.",
+  "$comment": "This is an implementation, and extension, of schema.org [`Article`](https://schema.org/Article).\nIt extends schema.org `Article` by, adding a `content` property which must be\nan array of [`BlockContent`](./BlockContent), as well as the properties added by\n[`CreativeWork`](./CreativeWork) which it extends.\n\nAn `Article` is analogous, and structurally similar to, the JATS XML\n[`<article>`](https://jats.nlm.nih.gov/articleauthoring/tag-library/1.2/element/article.html)\nelement.\n",
   "properties": {
@@ -506,2 +507,25 @@ "type": {
   },
+  "examples": [
+    {
+      "type": "Article",
+      "title": "Recherches sur les substances radioactives",
+      "authors": [
+        {
+          "type": "Person",
+          "honorificPrefix": "Dr",
+          "givenNames": [
+            "Marie",
+            "Skłodowska"
+          ],
+          "familyNames": [
+            "Curie"
+          ],
+          "honorificSuffix": "PhD"
+        }
+      ],
+      "content": [
+        "Le présent travail a pour but d'exposer les recherches que je poursuis depuis"
+      ]
+    }
+  ],
   "file": "Article.schema.yaml",
@@ -508,0 +532,0 @@ "children": [],

dist/AudioObject.schema.json

@@ -7,3 +7,3 @@ {
   "status": "stable",
-  "category": "media",
+  "category": "works",
   "description": "An audio file",
@@ -520,2 +520,12 @@ "properties": {
   },
+  "examples": [
+    {
+      "type": "AudioObject",
+      "caption": "Example Audio File",
+      "contentSize": 54321,
+      "contentUrl": "http://www.example.com/file.mp3",
+      "encodingFormat": "audio/mpeg3",
+      "transcript": "This is the transcript for the audio file..."
+    }
+  ],
   "file": "AudioObject.schema.yaml",
@@ -522,0 +532,0 @@ "children": [],

dist/Brand.schema.json

@@ -161,2 +161,17 @@ {
   ],
+  "examples": [
+    {
+      "type": "Brand",
+      "name": "XYZ",
+      "logo": {
+        "type": "ImageObject",
+        "url": "https://example.com/xyz.png",
+        "caption": "Logo of Brand YXZ"
+      },
+      "reviews": [
+        "Rather average product",
+        "Not sure if would use again"
+      ]
+    }
+  ],
   "file": "Brand.schema.yaml",
@@ -163,0 +178,0 @@ "children": [],

dist/browser/schema.umd.js

@@ -1,2 +0,2 @@
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e||self).schema={})}(this,function(e){function t(){return(t=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var o=arguments[t];for(var n in o)Object.prototype.hasOwnProperty.call(o,n)&&(e[n]=o[n])}return e}).apply(this,arguments)}var o,n=function(e){return Object.entries(e).reduce(function(e,o){var n,i=o[1];return void 0===i?e:t({},e,((n={})[o[0]]=i,n))},{})};(o=e.CitationIntentEnumeration||(e.CitationIntentEnumeration={})).AgreesWith="AgreesWith",o.CitesAsAuthority="CitesAsAuthority",o.CitesAsDataSource="CitesAsDataSource",o.CitesAsEvidence="CitesAsEvidence",o.CitesAsMetadataDocument="CitesAsMetadataDocument",o.CitesAsPotentialSolution="CitesAsPotentialSolution",o.CitesAsRecommendedReading="CitesAsRecommendedReading",o.CitesAsRelated="CitesAsRelated",o.CitesAsSourceDocument="CitesAsSourceDocument",o.CitesForInformation="CitesForInformation",o.Compiles="Compiles",o.Confirms="Confirms",o.ContainsAssertionFrom="ContainsAssertionFrom",o.Corrects="Corrects",o.Credits="Credits",o.Critiques="Critiques",o.Derides="Derides",o.Describes="Describes",o.DisagreesWith="DisagreesWith",o.Discusses="Discusses",o.Disputes="Disputes",o.Documents="Documents",o.Extends="Extends",o.GivesBackgroundTo="GivesBackgroundTo",o.GivesSupportTo="GivesSupportTo",o.HasReplyFrom="HasReplyFrom",o.IncludesExcerptFrom="IncludesExcerptFrom",o.IncludesQuotationFrom="IncludesQuotationFrom",o.IsAgreedWithBy="IsAgreedWithBy",o.IsCitedAsAuthorityBy="IsCitedAsAuthorityBy",o.IsCitedAsDataSourceBy="IsCitedAsDataSourceBy",o.IsCitedAsEvidenceBy="IsCitedAsEvidenceBy",o.IsCitedAsMetadataDocumentBy="IsCitedAsMetadataDocumentBy",o.IsCitedAsPontentialSolutionBy="IsCitedAsPontentialSolutionBy",o.IsCitedAsRecommendedReadingBy="IsCitedAsRecommendedReadingBy",o.IsCitedAsRelatedBy="IsCitedAsRelatedBy",o.IsCitedAsSourceDocumentBy="IsCitedAsSourceDocumentBy",o.IsCitedBy="IsCitedBy",o.IsCitedForInformationBy="IsCitedForInformationBy",o.IsCompiledBy="IsCompiledBy",o.IsConfirmedBy="IsConfirmedBy",o.IsCorrectedBy="IsCorrectedBy",o.IsCreditedBy="IsCreditedBy",o.IsCritiquedBy="IsCritiquedBy",o.IsDeridedBy="IsDeridedBy",o.IsDescribedBy="IsDescribedBy",o.IsDisagreedWithBy="IsDisagreedWithBy",o.IsDiscussedBy="IsDiscussedBy",o.IsDisputedBy="IsDisputedBy",o.IsDocumentedBy="IsDocumentedBy",o.IsExtendedBy="IsExtendedBy",o.IsLinkedToBy="IsLinkedToBy",o.IsParodiedBy="IsParodiedBy",o.IsPlagiarizedBy="IsPlagiarizedBy",o.IsQualifiedBy="IsQualifiedBy",o.IsRefutedBy="IsRefutedBy",o.IsRetractedBy="IsRetractedBy",o.IsReviewedBy="IsReviewedBy",o.IsRidiculedBy="IsRidiculedBy",o.IsSpeculatedOnBy="IsSpeculatedOnBy",o.IsSupportedBy="IsSupportedBy",o.IsUpdatedBy="IsUpdatedBy",o.Likes="Likes",o.LinksTo="LinksTo",o.ObtainsBackgroundFrom="ObtainsBackgroundFrom",o.ObtainsSupportFrom="ObtainsSupportFrom",o.Parodies="Parodies",o.Plagiarizes="Plagiarizes",o.ProvidesAssertionFor="ProvidesAssertionFor",o.ProvidesConclusionsFor="ProvidesConclusionsFor",o.ProvidesDataFor="ProvidesDataFor",o.ProvidesExcerptFor="ProvidesExcerptFor",o.ProvidesMethodFor="ProvidesMethodFor",o.ProvidesQuotationFor="ProvidesQuotationFor",o.Qualifies="Qualifies",o.Refutes="Refutes",o.RepliesTo="RepliesTo",o.Retracts="Retracts",o.Reviews="Reviews",o.Ridicules="Ridicules",o.SharesAuthorInstitutionWith="SharesAuthorInstitutionWith",o.SharesAuthorWith="SharesAuthorWith",o.SharesFundingAgencyWith="SharesFundingAgencyWith",o.SharesJournalWith="SharesJournalWith",o.SharesPublicationVenueWith="SharesPublicationVenueWith",o.SpeculatesOn="SpeculatesOn",o.Supports="Supports",o.Updates="Updates",o.UsesConclusionsFrom="UsesConclusionsFrom",o.UsesDataFrom="UsesDataFrom",o.UsesMethodIn="UsesMethodIn";var i={Code:"Code",CodeBlock:"CodeBlock",CodeChunk:"CodeChunk",CodeExpression:"CodeExpression",CodeFragment:"CodeFragment"},r={CreativeWork:"CreativeWork",Article:"Article",AudioObject:"AudioObject",Claim:"Claim",Collection:"Collection",Comment:"Comment",Datatable:"Datatable",Figure:"Figure",ImageObject:"ImageObject",MediaObject:"MediaObject",Periodical:"Periodical",PublicationIssue:"PublicationIssue",PublicationVolume:"PublicationVolume",Review:"Review",SoftwareApplication:"SoftwareApplication",SoftwareSourceCode:"SoftwareSourceCode",Table:"Table",VideoObject:"VideoObject"},a={Claim:"Claim",CodeBlock:"CodeBlock",CodeChunk:"CodeChunk",Collection:"Collection",Figure:"Figure",Heading:"Heading",List:"List",ListItem:"ListItem",MathBlock:"MathBlock",Paragraph:"Paragraph",QuoteBlock:"QuoteBlock",Table:"Table",ThematicBreak:"ThematicBreak"},u={AudioObject:"AudioObject",Cite:"Cite",CiteGroup:"CiteGroup",CodeExpression:"CodeExpression",CodeFragment:"CodeFragment",Delete:"Delete",Emphasis:"Emphasis",ImageObject:"ImageObject",Link:"Link",MathFragment:"MathFragment",MediaObject:"MediaObject",NontextualAnnotation:"NontextualAnnotation",Note:"Note",Quote:"Quote",Strong:"Strong",Subscript:"Subscript",Superscript:"Superscript",VideoObject:"VideoObject"},s=function(e){return function(t){return Object.keys(e).includes(t)}},d=function(e){return function(t){return!!y(t)&&s(e)(t.type)}},c=function(e){var t,o=((t={})[e]=e,t);return d(o)},l=function(e,t){return y(t)&&t.type===e},p=function(e){var t=typeof e;return null===e||"boolean"===t||"number"===t||"string"===t},y=function(e){return null!=e&&Object.prototype.hasOwnProperty.call(e,"type")},m=function(e){return!("object"!=typeof e||!y(e))&&s(u)(e.type)},C=d(a),f=d(r),b=d(i),I=c("Article"),g=c("Paragraph"),B=c("ListItem"),h="1.5.1",A=h.split(".")[0],v=h.split(".").slice(0,2).join(".");e.arrayValidator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"ArrayValidator"})},e.article=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Article"})},e.audioObject=function(e){return t({},n(e),{type:"AudioObject"})},e.blockContentTypes=a,e.booleanValidator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"BooleanValidator"})},e.brand=function(e){return t({},n(e),{type:"Brand"})},e.cite=function(e){return t({},n(e),{type:"Cite"})},e.citeGroup=function(e){return t({},n(e),{type:"CiteGroup"})},e.claim=function(e){return t({},n(e),{type:"Claim"})},e.code=function(e){return t({},n(e),{type:"Code"})},e.codeBlock=function(e){return t({},n(e),{type:"CodeBlock"})},e.codeBlockTypes={CodeBlock:"CodeBlock",CodeChunk:"CodeChunk"},e.codeChunk=function(e){return t({},n(e),{type:"CodeChunk"})},e.codeError=function(e){return t({},n(e),{type:"CodeError"})},e.codeExpression=function(e){return t({},n(e),{type:"CodeExpression"})},e.codeFragment=function(e){return t({},n(e),{type:"CodeFragment"})},e.codeFragmentTypes={CodeFragment:"CodeFragment",CodeExpression:"CodeExpression"},e.codeTypes=i,e.collection=function(e){return t({},n(e),{type:"Collection"})},e.comment=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Comment"})},e.constantValidator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"ConstantValidator"})},e.contactPoint=function(e){return void 0===e&&(e={}),t({},n(e),{type:"ContactPoint"})},e.contactPointTypes={ContactPoint:"ContactPoint",PostalAddress:"PostalAddress"},e.creativeWork=function(e){return void 0===e&&(e={}),t({},n(e),{type:"CreativeWork"})},e.creativeWorkTypes=r,e.datatable=function(e){return t({},n(e),{type:"Datatable"})},e.datatableColumn=function(e){return t({},n(e),{type:"DatatableColumn"})},e.date=function(e){return t({},n(e),{type:"Date"})},e.definedTerm=function(e){return t({},n(e),{type:"DefinedTerm"})},e.del=function(e){return t({},n(e),{type:"Delete"})},e.emphasis=function(e){return t({},n(e),{type:"Emphasis"})},e.entity=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Entity"})},e.entityTypes={Entity:"Entity",ArrayValidator:"ArrayValidator",Article:"Article",AudioObject:"AudioObject",BooleanValidator:"BooleanValidator",Brand:"Brand",CitationIntentEnumeration:"CitationIntentEnumeration",Cite:"Cite",CiteGroup:"CiteGroup",Claim:"Claim",Code:"Code",CodeBlock:"CodeBlock",CodeChunk:"CodeChunk",CodeError:"CodeError",CodeExpression:"CodeExpression",CodeFragment:"CodeFragment",Collection:"Collection",Comment:"Comment",ConstantValidator:"ConstantValidator",ContactPoint:"ContactPoint",CreativeWork:"CreativeWork",Datatable:"Datatable",DatatableColumn:"DatatableColumn",Date:"Date",DefinedTerm:"DefinedTerm",Delete:"Delete",Emphasis:"Emphasis",EnumValidator:"EnumValidator",Enumeration:"Enumeration",Figure:"Figure",Function:"Function",Grant:"Grant",Heading:"Heading",ImageObject:"ImageObject",Include:"Include",IntegerValidator:"IntegerValidator",Link:"Link",List:"List",ListItem:"ListItem",Mark:"Mark",Math:"Math",MathBlock:"MathBlock",MathFragment:"MathFragment",MediaObject:"MediaObject",MonetaryGrant:"MonetaryGrant",NontextualAnnotation:"NontextualAnnotation",Note:"Note",NumberValidator:"NumberValidator",Organization:"Organization",Paragraph:"Paragraph",Parameter:"Parameter",Periodical:"Periodical",Person:"Person",PostalAddress:"PostalAddress",Product:"Product",PropertyValue:"PropertyValue",PublicationIssue:"PublicationIssue",PublicationVolume:"PublicationVolume",Quote:"Quote",QuoteBlock:"QuoteBlock",Review:"Review",SoftwareApplication:"SoftwareApplication",SoftwareEnvironment:"SoftwareEnvironment",SoftwareSession:"SoftwareSession",SoftwareSourceCode:"SoftwareSourceCode",StringValidator:"StringValidator",Strong:"Strong",Subscript:"Subscript",Superscript:"Superscript",Table:"Table",TableCell:"TableCell",TableRow:"TableRow",ThematicBreak:"ThematicBreak",Thing:"Thing",TupleValidator:"TupleValidator",Validator:"Validator",Variable:"Variable",VideoObject:"VideoObject",VolumeMount:"VolumeMount"},e.enumValidator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"EnumValidator"})},e.enumeration=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Enumeration"})},e.enumerationTypes={Enumeration:"Enumeration",CitationIntentEnumeration:"CitationIntentEnumeration"},e.figure=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Figure"})},e.function_=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Function"})},e.grant=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Grant"})},e.grantTypes={Grant:"Grant",MonetaryGrant:"MonetaryGrant"},e.heading=function(e){return t({},n(e),{type:"Heading"})},e.imageObject=function(e){return t({},n(e),{type:"ImageObject"})},e.include=function(e){return t({},n(e),{type:"Include"})},e.inlineContentTypes=u,e.integerValidator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"IntegerValidator"})},e.is=c,e.isA=l,e.isArticle=I,e.isBlockContent=C,e.isCode=b,e.isCreativeWork=f,e.isEntity=y,e.isInlineContent=function(e){return p(e)||m(e)},e.isInlineEntity=m,e.isInstanceOf=function(e,t){return y(t)&&Object.keys(e).includes(t.type)},e.isListItem=B,e.isParagraph=g,e.isPrimitive=p,e.isType=function(e){return function(t){return void 0!==t&&l(e,t)}},e.link=function(e){return t({},n(e),{type:"Link"})},e.list=function(e){return t({},n(e),{type:"List"})},e.listItem=function(e){return void 0===e&&(e={}),t({},n(e),{type:"ListItem"})},e.mark=function(e){return t({},n(e),{type:"Mark"})},e.markTypes={Mark:"Mark",Delete:"Delete",Emphasis:"Emphasis",NontextualAnnotation:"NontextualAnnotation",Quote:"Quote",Strong:"Strong",Subscript:"Subscript",Superscript:"Superscript"},e.math=function(e){return t({},n(e),{type:"Math"})},e.mathBlock=function(e){return t({},n(e),{type:"MathBlock"})},e.mathFragment=function(e){return t({},n(e),{type:"MathFragment"})},e.mathTypes={Math:"Math",MathBlock:"MathBlock",MathFragment:"MathFragment"},e.mediaObject=function(e){return t({},n(e),{type:"MediaObject"})},e.mediaObjectTypes={MediaObject:"MediaObject",AudioObject:"AudioObject",ImageObject:"ImageObject",VideoObject:"VideoObject"},e.monetaryGrant=function(e){return void 0===e&&(e={}),t({},n(e),{type:"MonetaryGrant"})},e.nodeIs=d,e.nodeType=function(e){return null===e?"Null":"boolean"==typeof e?"Boolean":"number"==typeof e?"Number":"string"==typeof e?"Text":Array.isArray(e)?"Array":y(e)?e.type:"Object"},e.nontextualAnnotation=function(e){return t({},n(e),{type:"NontextualAnnotation"})},e.note=function(e){return t({},n(e),{type:"Note"})},e.numberValidator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"NumberValidator"})},e.organization=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Organization"})},e.paragraph=function(e){return t({},n(e),{type:"Paragraph"})},e.parameter=function(e){return t({},n(e),{type:"Parameter"})},e.periodical=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Periodical"})},e.person=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Person"})},e.postalAddress=function(e){return void 0===e&&(e={}),t({},n(e),{type:"PostalAddress"})},e.product=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Product"})},e.propertyValue=function(e){return t({},n(e),{type:"PropertyValue"})},e.publicationIssue=function(e){return void 0===e&&(e={}),t({},n(e),{type:"PublicationIssue"})},e.publicationVolume=function(e){return void 0===e&&(e={}),t({},n(e),{type:"PublicationVolume"})},e.quote=function(e){return t({},n(e),{type:"Quote"})},e.quoteBlock=function(e){return t({},n(e),{type:"QuoteBlock"})},e.review=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Review"})},e.softwareApplication=function(e){return void 0===e&&(e={}),t({},n(e),{type:"SoftwareApplication"})},e.softwareEnvironment=function(e){return t({},n(e),{type:"SoftwareEnvironment"})},e.softwareSession=function(e){return void 0===e&&(e={}),t({},n(e),{type:"SoftwareSession"})},e.softwareSourceCode=function(e){return void 0===e&&(e={}),t({},n(e),{type:"SoftwareSourceCode"})},e.stringValidator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"StringValidator"})},e.strong=function(e){return t({},n(e),{type:"Strong"})},e.subscript=function(e){return t({},n(e),{type:"Subscript"})},e.superscript=function(e){return t({},n(e),{type:"Superscript"})},e.table=function(e){return t({},n(e),{type:"Table"})},e.tableCell=function(e){return t({},n(e),{type:"TableCell"})},e.tableRow=function(e){return t({},n(e),{type:"TableRow"})},e.thematicBreak=function(e){return void 0===e&&(e={}),t({},n(e),{type:"ThematicBreak"})},e.thing=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Thing"})},e.thingTypes={Thing:"Thing",Article:"Article",AudioObject:"AudioObject",Brand:"Brand",CitationIntentEnumeration:"CitationIntentEnumeration",Claim:"Claim",Collection:"Collection",Comment:"Comment",ContactPoint:"ContactPoint",CreativeWork:"CreativeWork",Datatable:"Datatable",DatatableColumn:"DatatableColumn",DefinedTerm:"DefinedTerm",Enumeration:"Enumeration",Figure:"Figure",Grant:"Grant",ImageObject:"ImageObject",ListItem:"ListItem",MediaObject:"MediaObject",MonetaryGrant:"MonetaryGrant",Organization:"Organization",Periodical:"Periodical",Person:"Person",PostalAddress:"PostalAddress",Product:"Product",PropertyValue:"PropertyValue",PublicationIssue:"PublicationIssue",PublicationVolume:"PublicationVolume",Review:"Review",SoftwareApplication:"SoftwareApplication",SoftwareEnvironment:"SoftwareEnvironment",SoftwareSession:"SoftwareSession",SoftwareSourceCode:"SoftwareSourceCode",Table:"Table",VideoObject:"VideoObject",VolumeMount:"VolumeMount"},e.tupleValidator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"TupleValidator"})},e.typeIs=s,e.validator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Validator"})},e.validatorTypes={Validator:"Validator",ArrayValidator:"ArrayValidator",BooleanValidator:"BooleanValidator",ConstantValidator:"ConstantValidator",EnumValidator:"EnumValidator",IntegerValidator:"IntegerValidator",NumberValidator:"NumberValidator",StringValidator:"StringValidator",TupleValidator:"TupleValidator"},e.variable=function(e){return t({},n(e),{type:"Variable"})},e.variableTypes={Variable:"Variable",Parameter:"Parameter"},e.version=h,e.versionMajor=A,e.versionMinor=v,e.videoObject=function(e){return t({},n(e),{type:"VideoObject"})},e.volumeMount=function(e){return t({},n(e),{type:"VolumeMount"})}});
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e||self).schema={})}(this,function(e){function t(){return(t=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var o=arguments[t];for(var n in o)Object.prototype.hasOwnProperty.call(o,n)&&(e[n]=o[n])}return e}).apply(this,arguments)}var o,n=function(e){return Object.entries(e).reduce(function(e,o){var n,i=o[1];return void 0===i?e:t({},e,((n={})[o[0]]=i,n))},{})};(o=e.CitationIntentEnumeration||(e.CitationIntentEnumeration={})).AgreesWith="AgreesWith",o.CitesAsAuthority="CitesAsAuthority",o.CitesAsDataSource="CitesAsDataSource",o.CitesAsEvidence="CitesAsEvidence",o.CitesAsMetadataDocument="CitesAsMetadataDocument",o.CitesAsPotentialSolution="CitesAsPotentialSolution",o.CitesAsRecommendedReading="CitesAsRecommendedReading",o.CitesAsRelated="CitesAsRelated",o.CitesAsSourceDocument="CitesAsSourceDocument",o.CitesForInformation="CitesForInformation",o.Compiles="Compiles",o.Confirms="Confirms",o.ContainsAssertionFrom="ContainsAssertionFrom",o.Corrects="Corrects",o.Credits="Credits",o.Critiques="Critiques",o.Derides="Derides",o.Describes="Describes",o.DisagreesWith="DisagreesWith",o.Discusses="Discusses",o.Disputes="Disputes",o.Documents="Documents",o.Extends="Extends",o.GivesBackgroundTo="GivesBackgroundTo",o.GivesSupportTo="GivesSupportTo",o.HasReplyFrom="HasReplyFrom",o.IncludesExcerptFrom="IncludesExcerptFrom",o.IncludesQuotationFrom="IncludesQuotationFrom",o.IsAgreedWithBy="IsAgreedWithBy",o.IsCitedAsAuthorityBy="IsCitedAsAuthorityBy",o.IsCitedAsDataSourceBy="IsCitedAsDataSourceBy",o.IsCitedAsEvidenceBy="IsCitedAsEvidenceBy",o.IsCitedAsMetadataDocumentBy="IsCitedAsMetadataDocumentBy",o.IsCitedAsPontentialSolutionBy="IsCitedAsPontentialSolutionBy",o.IsCitedAsRecommendedReadingBy="IsCitedAsRecommendedReadingBy",o.IsCitedAsRelatedBy="IsCitedAsRelatedBy",o.IsCitedAsSourceDocumentBy="IsCitedAsSourceDocumentBy",o.IsCitedBy="IsCitedBy",o.IsCitedForInformationBy="IsCitedForInformationBy",o.IsCompiledBy="IsCompiledBy",o.IsConfirmedBy="IsConfirmedBy",o.IsCorrectedBy="IsCorrectedBy",o.IsCreditedBy="IsCreditedBy",o.IsCritiquedBy="IsCritiquedBy",o.IsDeridedBy="IsDeridedBy",o.IsDescribedBy="IsDescribedBy",o.IsDisagreedWithBy="IsDisagreedWithBy",o.IsDiscussedBy="IsDiscussedBy",o.IsDisputedBy="IsDisputedBy",o.IsDocumentedBy="IsDocumentedBy",o.IsExtendedBy="IsExtendedBy",o.IsLinkedToBy="IsLinkedToBy",o.IsParodiedBy="IsParodiedBy",o.IsPlagiarizedBy="IsPlagiarizedBy",o.IsQualifiedBy="IsQualifiedBy",o.IsRefutedBy="IsRefutedBy",o.IsRetractedBy="IsRetractedBy",o.IsReviewedBy="IsReviewedBy",o.IsRidiculedBy="IsRidiculedBy",o.IsSpeculatedOnBy="IsSpeculatedOnBy",o.IsSupportedBy="IsSupportedBy",o.IsUpdatedBy="IsUpdatedBy",o.Likes="Likes",o.LinksTo="LinksTo",o.ObtainsBackgroundFrom="ObtainsBackgroundFrom",o.ObtainsSupportFrom="ObtainsSupportFrom",o.Parodies="Parodies",o.Plagiarizes="Plagiarizes",o.ProvidesAssertionFor="ProvidesAssertionFor",o.ProvidesConclusionsFor="ProvidesConclusionsFor",o.ProvidesDataFor="ProvidesDataFor",o.ProvidesExcerptFor="ProvidesExcerptFor",o.ProvidesMethodFor="ProvidesMethodFor",o.ProvidesQuotationFor="ProvidesQuotationFor",o.Qualifies="Qualifies",o.Refutes="Refutes",o.RepliesTo="RepliesTo",o.Retracts="Retracts",o.Reviews="Reviews",o.Ridicules="Ridicules",o.SharesAuthorInstitutionWith="SharesAuthorInstitutionWith",o.SharesAuthorWith="SharesAuthorWith",o.SharesFundingAgencyWith="SharesFundingAgencyWith",o.SharesJournalWith="SharesJournalWith",o.SharesPublicationVenueWith="SharesPublicationVenueWith",o.SpeculatesOn="SpeculatesOn",o.Supports="Supports",o.Updates="Updates",o.UsesConclusionsFrom="UsesConclusionsFrom",o.UsesDataFrom="UsesDataFrom",o.UsesMethodIn="UsesMethodIn";var i={Code:"Code",CodeBlock:"CodeBlock",CodeChunk:"CodeChunk",CodeExpression:"CodeExpression",CodeFragment:"CodeFragment"},r={CreativeWork:"CreativeWork",Article:"Article",AudioObject:"AudioObject",Claim:"Claim",Collection:"Collection",Comment:"Comment",Datatable:"Datatable",Figure:"Figure",ImageObject:"ImageObject",MediaObject:"MediaObject",Periodical:"Periodical",PublicationIssue:"PublicationIssue",PublicationVolume:"PublicationVolume",Review:"Review",SoftwareApplication:"SoftwareApplication",SoftwareSourceCode:"SoftwareSourceCode",Table:"Table",VideoObject:"VideoObject"},a={Claim:"Claim",CodeBlock:"CodeBlock",CodeChunk:"CodeChunk",Collection:"Collection",Figure:"Figure",Heading:"Heading",List:"List",ListItem:"ListItem",MathBlock:"MathBlock",Paragraph:"Paragraph",QuoteBlock:"QuoteBlock",Table:"Table",ThematicBreak:"ThematicBreak"},u={AudioObject:"AudioObject",Cite:"Cite",CiteGroup:"CiteGroup",CodeExpression:"CodeExpression",CodeFragment:"CodeFragment",Delete:"Delete",Emphasis:"Emphasis",ImageObject:"ImageObject",Link:"Link",MathFragment:"MathFragment",MediaObject:"MediaObject",NontextualAnnotation:"NontextualAnnotation",Note:"Note",Quote:"Quote",Strong:"Strong",Subscript:"Subscript",Superscript:"Superscript",VideoObject:"VideoObject"},s=function(e){return function(t){return Object.keys(e).includes(t)}},d=function(e){return function(t){return!!y(t)&&s(e)(t.type)}},c=function(e){var t,o=((t={})[e]=e,t);return d(o)},l=function(e,t){return y(t)&&t.type===e},p=function(e){var t=typeof e;return null===e||"boolean"===t||"number"===t||"string"===t},y=function(e){return null!=e&&Object.prototype.hasOwnProperty.call(e,"type")},m=function(e){return!("object"!=typeof e||!y(e))&&s(u)(e.type)},C=d(a),f=d(r),b=d(i),I=c("Article"),g=c("Paragraph"),B=c("ListItem"),h="1.5.2",A=h.split(".")[0],v=h.split(".").slice(0,2).join(".");e.arrayValidator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"ArrayValidator"})},e.article=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Article"})},e.audioObject=function(e){return t({},n(e),{type:"AudioObject"})},e.blockContentTypes=a,e.booleanValidator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"BooleanValidator"})},e.brand=function(e){return t({},n(e),{type:"Brand"})},e.cite=function(e){return t({},n(e),{type:"Cite"})},e.citeGroup=function(e){return t({},n(e),{type:"CiteGroup"})},e.claim=function(e){return t({},n(e),{type:"Claim"})},e.code=function(e){return t({},n(e),{type:"Code"})},e.codeBlock=function(e){return t({},n(e),{type:"CodeBlock"})},e.codeBlockTypes={CodeBlock:"CodeBlock",CodeChunk:"CodeChunk"},e.codeChunk=function(e){return t({},n(e),{type:"CodeChunk"})},e.codeError=function(e){return t({},n(e),{type:"CodeError"})},e.codeExpression=function(e){return t({},n(e),{type:"CodeExpression"})},e.codeFragment=function(e){return t({},n(e),{type:"CodeFragment"})},e.codeFragmentTypes={CodeFragment:"CodeFragment",CodeExpression:"CodeExpression"},e.codeTypes=i,e.collection=function(e){return t({},n(e),{type:"Collection"})},e.comment=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Comment"})},e.constantValidator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"ConstantValidator"})},e.contactPoint=function(e){return void 0===e&&(e={}),t({},n(e),{type:"ContactPoint"})},e.contactPointTypes={ContactPoint:"ContactPoint",PostalAddress:"PostalAddress"},e.creativeWork=function(e){return void 0===e&&(e={}),t({},n(e),{type:"CreativeWork"})},e.creativeWorkTypes=r,e.datatable=function(e){return t({},n(e),{type:"Datatable"})},e.datatableColumn=function(e){return t({},n(e),{type:"DatatableColumn"})},e.date=function(e){return t({},n(e),{type:"Date"})},e.definedTerm=function(e){return t({},n(e),{type:"DefinedTerm"})},e.del=function(e){return t({},n(e),{type:"Delete"})},e.emphasis=function(e){return t({},n(e),{type:"Emphasis"})},e.entity=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Entity"})},e.entityTypes={Entity:"Entity",ArrayValidator:"ArrayValidator",Article:"Article",AudioObject:"AudioObject",BooleanValidator:"BooleanValidator",Brand:"Brand",CitationIntentEnumeration:"CitationIntentEnumeration",Cite:"Cite",CiteGroup:"CiteGroup",Claim:"Claim",Code:"Code",CodeBlock:"CodeBlock",CodeChunk:"CodeChunk",CodeError:"CodeError",CodeExpression:"CodeExpression",CodeFragment:"CodeFragment",Collection:"Collection",Comment:"Comment",ConstantValidator:"ConstantValidator",ContactPoint:"ContactPoint",CreativeWork:"CreativeWork",Datatable:"Datatable",DatatableColumn:"DatatableColumn",Date:"Date",DefinedTerm:"DefinedTerm",Delete:"Delete",Emphasis:"Emphasis",EnumValidator:"EnumValidator",Enumeration:"Enumeration",Figure:"Figure",Function:"Function",Grant:"Grant",Heading:"Heading",ImageObject:"ImageObject",Include:"Include",IntegerValidator:"IntegerValidator",Link:"Link",List:"List",ListItem:"ListItem",Mark:"Mark",Math:"Math",MathBlock:"MathBlock",MathFragment:"MathFragment",MediaObject:"MediaObject",MonetaryGrant:"MonetaryGrant",NontextualAnnotation:"NontextualAnnotation",Note:"Note",NumberValidator:"NumberValidator",Organization:"Organization",Paragraph:"Paragraph",Parameter:"Parameter",Periodical:"Periodical",Person:"Person",PostalAddress:"PostalAddress",Product:"Product",PropertyValue:"PropertyValue",PublicationIssue:"PublicationIssue",PublicationVolume:"PublicationVolume",Quote:"Quote",QuoteBlock:"QuoteBlock",Review:"Review",SoftwareApplication:"SoftwareApplication",SoftwareEnvironment:"SoftwareEnvironment",SoftwareSession:"SoftwareSession",SoftwareSourceCode:"SoftwareSourceCode",StringValidator:"StringValidator",Strong:"Strong",Subscript:"Subscript",Superscript:"Superscript",Table:"Table",TableCell:"TableCell",TableRow:"TableRow",ThematicBreak:"ThematicBreak",Thing:"Thing",TupleValidator:"TupleValidator",Validator:"Validator",Variable:"Variable",VideoObject:"VideoObject",VolumeMount:"VolumeMount"},e.enumValidator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"EnumValidator"})},e.enumeration=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Enumeration"})},e.enumerationTypes={Enumeration:"Enumeration",CitationIntentEnumeration:"CitationIntentEnumeration"},e.figure=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Figure"})},e.function_=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Function"})},e.grant=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Grant"})},e.grantTypes={Grant:"Grant",MonetaryGrant:"MonetaryGrant"},e.heading=function(e){return t({},n(e),{type:"Heading"})},e.imageObject=function(e){return t({},n(e),{type:"ImageObject"})},e.include=function(e){return t({},n(e),{type:"Include"})},e.inlineContentTypes=u,e.integerValidator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"IntegerValidator"})},e.is=c,e.isA=l,e.isArticle=I,e.isBlockContent=C,e.isCode=b,e.isCreativeWork=f,e.isEntity=y,e.isInlineContent=function(e){return p(e)||m(e)},e.isInlineEntity=m,e.isInstanceOf=function(e,t){return y(t)&&Object.keys(e).includes(t.type)},e.isListItem=B,e.isParagraph=g,e.isPrimitive=p,e.isType=function(e){return function(t){return void 0!==t&&l(e,t)}},e.link=function(e){return t({},n(e),{type:"Link"})},e.list=function(e){return t({},n(e),{type:"List"})},e.listItem=function(e){return void 0===e&&(e={}),t({},n(e),{type:"ListItem"})},e.mark=function(e){return t({},n(e),{type:"Mark"})},e.markTypes={Mark:"Mark",Delete:"Delete",Emphasis:"Emphasis",NontextualAnnotation:"NontextualAnnotation",Quote:"Quote",Strong:"Strong",Subscript:"Subscript",Superscript:"Superscript"},e.math=function(e){return t({},n(e),{type:"Math"})},e.mathBlock=function(e){return t({},n(e),{type:"MathBlock"})},e.mathFragment=function(e){return t({},n(e),{type:"MathFragment"})},e.mathTypes={Math:"Math",MathBlock:"MathBlock",MathFragment:"MathFragment"},e.mediaObject=function(e){return t({},n(e),{type:"MediaObject"})},e.mediaObjectTypes={MediaObject:"MediaObject",AudioObject:"AudioObject",ImageObject:"ImageObject",VideoObject:"VideoObject"},e.monetaryGrant=function(e){return void 0===e&&(e={}),t({},n(e),{type:"MonetaryGrant"})},e.nodeIs=d,e.nodeType=function(e){return null===e?"Null":"boolean"==typeof e?"Boolean":"number"==typeof e?"Number":"string"==typeof e?"Text":Array.isArray(e)?"Array":y(e)?e.type:"Object"},e.nontextualAnnotation=function(e){return t({},n(e),{type:"NontextualAnnotation"})},e.note=function(e){return t({},n(e),{type:"Note"})},e.numberValidator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"NumberValidator"})},e.organization=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Organization"})},e.paragraph=function(e){return t({},n(e),{type:"Paragraph"})},e.parameter=function(e){return t({},n(e),{type:"Parameter"})},e.periodical=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Periodical"})},e.person=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Person"})},e.postalAddress=function(e){return void 0===e&&(e={}),t({},n(e),{type:"PostalAddress"})},e.product=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Product"})},e.propertyValue=function(e){return t({},n(e),{type:"PropertyValue"})},e.publicationIssue=function(e){return void 0===e&&(e={}),t({},n(e),{type:"PublicationIssue"})},e.publicationVolume=function(e){return void 0===e&&(e={}),t({},n(e),{type:"PublicationVolume"})},e.quote=function(e){return t({},n(e),{type:"Quote"})},e.quoteBlock=function(e){return t({},n(e),{type:"QuoteBlock"})},e.review=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Review"})},e.softwareApplication=function(e){return void 0===e&&(e={}),t({},n(e),{type:"SoftwareApplication"})},e.softwareEnvironment=function(e){return t({},n(e),{type:"SoftwareEnvironment"})},e.softwareSession=function(e){return void 0===e&&(e={}),t({},n(e),{type:"SoftwareSession"})},e.softwareSourceCode=function(e){return void 0===e&&(e={}),t({},n(e),{type:"SoftwareSourceCode"})},e.stringValidator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"StringValidator"})},e.strong=function(e){return t({},n(e),{type:"Strong"})},e.subscript=function(e){return t({},n(e),{type:"Subscript"})},e.superscript=function(e){return t({},n(e),{type:"Superscript"})},e.table=function(e){return t({},n(e),{type:"Table"})},e.tableCell=function(e){return t({},n(e),{type:"TableCell"})},e.tableRow=function(e){return t({},n(e),{type:"TableRow"})},e.thematicBreak=function(e){return void 0===e&&(e={}),t({},n(e),{type:"ThematicBreak"})},e.thing=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Thing"})},e.thingTypes={Thing:"Thing",Article:"Article",AudioObject:"AudioObject",Brand:"Brand",CitationIntentEnumeration:"CitationIntentEnumeration",Claim:"Claim",Collection:"Collection",Comment:"Comment",ContactPoint:"ContactPoint",CreativeWork:"CreativeWork",Datatable:"Datatable",DatatableColumn:"DatatableColumn",DefinedTerm:"DefinedTerm",Enumeration:"Enumeration",Figure:"Figure",Grant:"Grant",ImageObject:"ImageObject",ListItem:"ListItem",MediaObject:"MediaObject",MonetaryGrant:"MonetaryGrant",Organization:"Organization",Periodical:"Periodical",Person:"Person",PostalAddress:"PostalAddress",Product:"Product",PropertyValue:"PropertyValue",PublicationIssue:"PublicationIssue",PublicationVolume:"PublicationVolume",Review:"Review",SoftwareApplication:"SoftwareApplication",SoftwareEnvironment:"SoftwareEnvironment",SoftwareSession:"SoftwareSession",SoftwareSourceCode:"SoftwareSourceCode",Table:"Table",VideoObject:"VideoObject",VolumeMount:"VolumeMount"},e.tupleValidator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"TupleValidator"})},e.typeIs=s,e.validator=function(e){return void 0===e&&(e={}),t({},n(e),{type:"Validator"})},e.validatorTypes={Validator:"Validator",ArrayValidator:"ArrayValidator",BooleanValidator:"BooleanValidator",ConstantValidator:"ConstantValidator",EnumValidator:"EnumValidator",IntegerValidator:"IntegerValidator",NumberValidator:"NumberValidator",StringValidator:"StringValidator",TupleValidator:"TupleValidator"},e.variable=function(e){return t({},n(e),{type:"Variable"})},e.variableTypes={Variable:"Variable",Parameter:"Parameter"},e.version=h,e.versionMajor=A,e.versionMinor=v,e.videoObject=function(e){return t({},n(e),{type:"VideoObject"})},e.volumeMount=function(e){return t({},n(e),{type:"VolumeMount"})}});
 //# sourceMappingURL=schema.umd.js.map

dist/Cite.schema.json

@@ -8,3 +8,4 @@ {
   "status": "unstable",
-  "description": "A reference to a CreativeWork that is cited in another CreativeWork.\n",
+  "description": "A reference to a CreativeWork that is cited in another CreativeWork.",
+  "$comment": "A `Cite` node is used within a [`CreativeWork`](./CreativeWork), usually an\n[`Article`](./Article), to refer to an other `CreativeWork`.\nOften a `Cite` will be associated with other citations, in a [`CiteGroup`](./CiteGroup).\n",
   "properties": {
@@ -126,2 +127,52 @@ "type": {
   ],
+  "examples": [
+    {
+      "type": "Article",
+      "title": "An example of using the Cite node type",
+      "authors": [
+        {
+          "type": "Person",
+          "givenNames": [
+            "Joe"
+          ],
+          "familyNames": [
+            "Bloggs"
+          ]
+        }
+      ],
+      "content": [
+        {
+          "type": "Paragraph",
+          "content": [
+            "A citation of ",
+            {
+              "type": "Cite",
+              "target": "some-one-else-1991"
+            },
+            "."
+          ]
+        }
+      ],
+      "references": [
+        {
+          "type": "Article",
+          "id": "some-one-else-1991",
+          "title": "Another article by someone else",
+          "authors": [
+            {
+              "type": "Person",
+              "givenNames": [
+                "Some",
+                "One"
+              ],
+              "familyNames": [
+                "Else"
+              ]
+            }
+          ],
+          "datePublished": "1991"
+        }
+      ]
+    }
+  ],
   "file": "Cite.schema.yaml",
@@ -128,0 +179,0 @@ "children": [],

dist/CiteGroup.schema.json

@@ -8,4 +8,4 @@ {
   "status": "unstable",
-  "description": "A group of `Cite` nodes",
-  "$comment": "This type allows us to group associated citations together.\nAt present we do not give a `citationMode` property to a `CiteGroup` since\nthey will almost always be parenthetical as opposed to narrative.\nIn other words, it usually only makes sense for individual `Cite` nodes to be\nnarrative (although they may be connected together within `content` using words\nsuch as \"and\").\n",
+  "description": "A group of Cite nodes.",
+  "$comment": "This type allows you to group associated citations together.\nWhen some content in a [`Creative Work`](./CreativeWork) cites more than one\nreference for a particular piece of text, use a `CiteGroup` to encapsulate\nmultiple [`Cite`](./Cite) nodes.\n\nAt present we do not give a `citationMode` property to a `CiteGroup` since\nthey will almost always be parenthetical as opposed to narrative.\nIn other words, it usually only makes sense for individual `Cite` nodes to be\nnarrative (although they may be connected together within `content` using words\nsuch as \"and\").\n",
   "properties": {
@@ -53,2 +53,79 @@ "type": {
   ],
+  "examples": [
+    {
+      "type": "Article",
+      "title": "An example of using the CiteGroup node type",
+      "authors": [
+        {
+          "type": "Person",
+          "givenNames": [
+            "Joe"
+          ],
+          "familyNames": [
+            "Bloggs"
+          ]
+        }
+      ],
+      "content": [
+        {
+          "type": "Paragraph",
+          "content": [
+            "Citing two articles ",
+            {
+              "type": "CiteGroup",
+              "items": [
+                {
+                  "type": "Cite",
+                  "target": "some-one-else-1991"
+                },
+                {
+                  "type": "Cite",
+                  "target": "updated-works-2009"
+                }
+              ]
+            },
+            "."
+          ]
+        }
+      ],
+      "references": [
+        {
+          "type": "Article",
+          "id": "some-one-else-1991",
+          "title": "Another article by someone else",
+          "authors": [
+            {
+              "type": "Person",
+              "givenNames": [
+                "Some",
+                "One"
+              ],
+              "familyNames": [
+                "Else"
+              ]
+            }
+          ],
+          "datePublished": "1991"
+        },
+        {
+          "type": "Article",
+          "id": "update-works-2009",
+          "title": "A Better Updated Work",
+          "authors": [
+            {
+              "type": "Person",
+              "givenNames": [
+                "Some",
+                "Better"
+              ],
+              "familyNames": [
+                "Person"
+              ]
+            }
+          ],
+          "datePublished": "2009"
+        }
+      ]
+    }
+  ],
   "file": "CiteGroup.schema.yaml",
@@ -55,0 +132,0 @@ "children": [],

dist/Claim.schema.json

@@ -5,3 +5,3 @@ {
   "extends": "CreativeWork",
-  "category": "prose",
+  "category": "works",
   "role": "secondary",
@@ -8,0 +8,0 @@ "status": "unstable",

dist/Code.schema.json

@@ -8,3 +8,4 @@ {
   "category": "code",
-  "description": "Base type for code nodes e.g. `CodeBlock`, `CodeExpression`.",
+  "description": "Base type for code nodes e.g. CodeBlock, CodeExpression.",
+  "$comment": "The most important, and only required, property of a `Code` node is `text`.\nThis property is a `string` of the source code.\nThere are no restrictions on the length or content of `text`\nand it is possible for it to be syntactically invalid for the\nspecified `programmingLanguage`.\n",
   "properties": {
@@ -11,0 +12,0 @@ "type": {

dist/Collection.schema.json

@@ -5,6 +5,7 @@ {
   "extends": "CreativeWork",
+  "category": "works",
   "role": "secondary",
   "status": "stable",
-  "category": "other",
-  "description": "A created collection of CreativeWorks or other artefacts.",
+  "description": "A collection of CreativeWorks or other artifacts.",
+  "$comment": "This is an implementation of schema.org [`Collection`](https://schema.org/Collection).\nThe `Collection` type allows you to represent a collection of various `CreativeWork`\nnode types, such as [`Article`](./Article), [`Datatable`](./Datatable) or [`Table`](./Table).\n\nThe schema.org `Collection` has a `collectionSize` property but has not been added here\nbecause it is somewhat redundant e.g. a developer could use `collection.parts.length` instead.\n",
   "properties": {
@@ -11,0 +12,0 @@ "type": {

dist/Comment.schema.json

@@ -5,5 +5,5 @@ {
   "extends": "CreativeWork",
+  "category": "works",
   "role": "secondary",
   "status": "stable",
-  "category": "other",
   "description": "A comment on an item, e.g on a Article, or SoftwareSourceCode.",
@@ -10,0 +10,0 @@ "$comment": "Use the `about` property to define the item that a comment is on and\n`commentAspect` to point to a specific part of aspect of that item.\nThe `content` property should be used for the structured content of the\ncomment, in preference to the schema.org `text` property (which is expected to\nbe plain text). Replies to a comment can be added to its `comments` property\nor have their `parentItem` set to the parent comment.\n",

dist/CreativeWork.schema.json

@@ -5,6 +5,7 @@ {
   "extends": "Thing",
+  "category": "works",
   "role": "base",
   "status": "stable",
-  "category": "other",
   "description": "A creative work, including books, movies, photographs, software programs, etc.\n",
+  "$comment": "This is an implementation, and extension, of schema.org [`CreativeWork`](https://schema.org/CreativeWork).\nIt extends schema.org `CreativeWork` by, adding several properties including `dateAccepted`\nand `fundedBy`.\n",
   "properties": {
@@ -11,0 +12,0 @@ "type": {

dist/CreativeWorkTypes.schema.json

@@ -5,3 +5,3 @@ {
   "title": "CreativeWorkTypes",
-  "category": "other",
+  "category": "works",
   "description": "All type schemas that are derived from CreativeWork",
@@ -8,0 +8,0 @@ "anyOf": [

dist/Datatable.schema.json

@@ -5,5 +5,5 @@ {
   "extends": "CreativeWork",
+  "category": "works",
   "role": "primary",
   "status": "unstable",
-  "category": "data",
   "description": "A table of data.",
@@ -10,0 +10,0 @@ "properties": {

dist/Figure.schema.json

@@ -5,5 +5,5 @@ {
   "extends": "CreativeWork",
+  "category": "works",
   "role": "primary",
   "status": "unstable",
-  "category": "prose",
   "description": "Encapsulates one or more images, videos, tables, etc, and provides captions and labels for them.",
@@ -10,0 +10,0 @@ "properties": {

dist/ImageObject.schema.json

@@ -5,5 +5,5 @@ {
   "extends": "MediaObject",
+  "category": "works",
   "role": "secondary",
   "status": "stable",
-  "category": "media",
   "description": "An image file.",
@@ -10,0 +10,0 @@ "properties": {

dist/MediaObject.schema.json

@@ -5,5 +5,5 @@ {
   "extends": "CreativeWork",
+  "category": "works",
   "role": "base",
   "status": "stable",
-  "category": "media",
   "description": "A media object, such as an image, video, or audio object embedded in a web page or a\ndownloadable dataset.\n",
@@ -515,2 +515,12 @@ "properties": {
   ],
+  "examples": [
+    {
+      "type": "MediaObject",
+      "bitrate": "44",
+      "contentSize": "2",
+      "contentUrl": "http://www.example.com/file.mp3",
+      "encodingFormat": "audio/mpeg3",
+      "embedUrl": "http://www.example.com/full_size/file.mp3"
+    }
+  ],
   "file": "MediaObject.schema.yaml",
@@ -517,0 +527,0 @@ "children": [

dist/MediaObjectTypes.schema.json

@@ -5,3 +5,3 @@ {
   "title": "MediaObjectTypes",
-  "category": "media",
+  "category": "works",
   "description": "All type schemas that are derived from MediaObject",
@@ -8,0 +8,0 @@ "anyOf": [

dist/Periodical.schema.json

@@ -5,6 +5,7 @@ {
   "extends": "CreativeWork",
+  "category": "works",
   "role": "secondary",
   "status": "unstable",
-  "category": "other",
   "description": "A periodical publication.",
+  "$comment": "A publication in any medium issued in successive parts bearing numerical or chronological designations and intended,\nsuch as a magazine, scholarly journal, or newspaper to continue indefinitely. Often embedded as the `isPartOf` property\nin a [`PublicationVolume`](./PublicationVolume).\n",
   "properties": {
@@ -499,2 +500,14 @@ "type": {
   },
+  "examples": [
+    {
+      "type": "Periodical",
+      "title": "Nature",
+      "issns": [
+        "0028-0836",
+        "1476-4687"
+      ],
+      "dateStart": "1869-11-04T00:00:00.000Z",
+      "url": "https://www.nature.com/"
+    }
+  ],
   "file": "Periodical.schema.yaml",
@@ -501,0 +514,0 @@ "children": [],

dist/Product.schema.json

@@ -9,2 +9,3 @@ {
   "description": "Any offered product or service. For example, a pair of shoes;\na haircut; or an episode of a TV show streamed online.\n",
+  "$comment": "The `Product` type allows you to provide details about a product such as the product\nbrand, logo and ID. This type can be used as any kind of product that is not [`CreativeWork`](./CreativeWork) item.\n\n`Product` is analogous, and structurally similar to, the \nJATS XML [`<product>`](https://jats.nlm.nih.gov/archiving/tag-library/1.1/element/product.html) element which\ncontains the metadata concerning one product (for example, a book, software package, website, or\nhardware component) discussed in an article.\n\nTo meet Google's guidelines for [`Product`](https://developers.google.com/search/docs/data-types/product#product)\ninstances are required to have `image` and `name` properties.\n",
   "properties": {
@@ -163,2 +164,18 @@ "type": {
   },
+  "examples": [
+    {
+      "type": "Product",
+      "brand": {
+        "type": "Brand",
+        "name": "Astro"
+      },
+      "name": "Astrolabe",
+      "logo": {
+        "type": "ImageObject",
+        "contentUrl": "http://www.product-astrolabe.com/logo.png",
+        "caption": "Astrolabe Logo"
+      },
+      "productID": "AA55"
+    }
+  ],
   "file": "Product.schema.yaml",
@@ -165,0 +182,0 @@ "children": [],

dist/PublicationIssue.schema.json

@@ -5,5 +5,5 @@ {
   "extends": "CreativeWork",
+  "category": "works",
   "role": "secondary",
   "status": "unstable",
-  "category": "other",
   "description": "A part of a successively published publication such as a periodical or publication\nvolume, often numbered.\n",
@@ -517,2 +517,18 @@ "properties": {
   },
+  "examples": [
+    {
+      "type": "PublicationIssue",
+      "url": "https://www.nature.com/nature/volumes/571/issues/7766",
+      "issueNumber": 571,
+      "datePublished": "2019-07-25T00:00:00.000Z",
+      "isPartOf": {
+        "type": "PublicationVolume",
+        "volumeNumber": 571,
+        "isPartOf": {
+          "type": "Periodical",
+          "title": "Nature"
+        }
+      }
+    }
+  ],
   "file": "PublicationIssue.schema.yaml",
@@ -519,0 +535,0 @@ "children": [],

dist/PublicationVolume.schema.json

@@ -5,6 +5,7 @@ {
   "extends": "CreativeWork",
+  "category": "works",
   "role": "secondary",
   "status": "unstable",
-  "category": "other",
   "description": "A part of a successively published publication such as a periodical or multi-volume work.\n",
+  "$comment": "Often embedded as the `isPartOf` property in a [`PublicationIssue`](./PublicationIssue).\n",
   "properties": {
@@ -517,2 +518,12 @@ "type": {
   },
+  "examples": [
+    {
+      "type": "PublicationVolume",
+      "volumeNumber": 571,
+      "isPartOf": {
+        "type": "Periodical",
+        "title": "Nature"
+      }
+    }
+  ],
   "file": "PublicationVolume.schema.yaml",
@@ -519,0 +530,0 @@ "children": [],

dist/Review.schema.json

@@ -5,5 +5,5 @@ {
   "extends": "CreativeWork",
+  "category": "works",
   "role": "secondary",
   "status": "stable",
-  "category": "other",
   "description": "A review of an item, e.g of an Article, or SoftwareSourceCode.",
@@ -10,0 +10,0 @@ "$comment": "Use the `content` property for the structured content of the review in\npreference to the schema.org `text` or `reviewBody` properties (which\nhave plain text as the expected type).\n",

dist/SoftwareApplication.schema.json

@@ -5,6 +5,7 @@ {
   "extends": "CreativeWork",
+  "category": "works",
   "role": "primary",
   "status": "unstable",
-  "category": "code",
   "description": "A software application.\n",
+  "$comment": "`SoftwareApplication` represents a software application that can be located by name and version.\nIt may be fetched in binary format or some package manager (npm, pip, etc) could fetch and compile the source code.\nAlthough by using the `softwareRequirements` property it is possible to represent a full hierarchy\nof required packages, normally it is adequate to only list the immediate dependencies and allow\nthe system/language package manager to resolve the rest.\n",
   "properties": {
@@ -11,0 +12,0 @@ "type": {

dist/SoftwareSession.schema.json

@@ -9,3 +9,3 @@ {
   "description": "Definition of a compute session, including its software and compute resource\nrequirements and status.\n",
-  "$comment": "Usually used to define the environment that is required to execute an\nexecutable document.\n",
+  "$comment": "Usually used to define the environment that is required to execute an\nexecutable document.\n\nThis is \"inspired\" by the [OCI Runtime Config Schema](https://github.com/opencontainers/runtime-spec/blob/master/schema/config-schema.json)\nThere are a number of properties that did not seem relevant to our use as well as some\nreferences that did not seem to be required. We try to stay consistent with the naming\nused but have dereferenced and combined the config schema and \n[Linux Schema](https://github.com/opencontainers/runtime-spec/blob/master/schema/defs-linux.json) \nto use the cpu and memory limits.\n",
   "properties": {
@@ -12,0 +12,0 @@ "type": {

dist/SoftwareSourceCode.schema.json

@@ -5,5 +5,5 @@ {
   "extends": "CreativeWork",
+  "category": "works",
   "role": "primary",
   "status": "unstable",
-  "category": "code",
   "description": "Computer programming source code. Example: Full (compile ready) solutions, code snippet samples, scripts, templates.\n",
@@ -10,0 +10,0 @@ "properties": {

dist/Table.schema.json

@@ -5,5 +5,5 @@ {
   "extends": "CreativeWork",
+  "category": "works",
   "role": "primary",
   "status": "unstable",
-  "category": "prose",
   "description": "A table.",
@@ -10,0 +10,0 @@ "properties": {

dist/VideoObject.schema.json

@@ -5,6 +5,7 @@ {
   "extends": "MediaObject",
+  "category": "works",
   "role": "secondary",
   "status": "stable",
-  "category": "media",
   "description": "A video file.",
+  "$comment": "The `VideoObject` type allows you to provide details such as caption and transcript,\nand the details which are included in [`MediaObject`](./MediaObject)\nwhich `VideoObject` extends.\n",
   "properties": {
@@ -530,2 +531,12 @@ "type": {
   },
+  "examples": [
+    {
+      "type": "VideoObject",
+      "caption": "Example Video File",
+      "contentSize": "45",
+      "contentUrl": "http://www.example.com/file.mp4",
+      "encodingFormat": "video/mpeg",
+      "transcript": "This is the transcript for the video file..."
+    }
+  ],
   "file": "VideoObject.schema.yaml",
@@ -532,0 +543,0 @@ "children": [],

package.json

 {
   "name": "@stencila/schema",
-  "version": "1.5.2",
+  "version": "1.5.3",
   "description": "Extensions to schema.org to support semantic, composable, parameterize-able and executable documents",
@@ -175,4 +175,3 @@ "files": [
         }
-      ],
-      "@qiwi/semantic-release-gh-pages-plugin"
+      ]
     ]
@@ -179,0 +178,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

1359462

increased by0.74%

Lines of code

24576

increased by1.1%

No dependency changes