@chronicle.app/schema 0.4.0 → 0.5.0

package/README.md

@@ -115,6 +115,16 @@ typing; use validators at runtime to enforce identity requirements.
 - A datatype is an `rdfs:Datatype` defined over XSD. Each accepts the plain
   strings that Chronicle JSON becomes in JSON-LD as well as typed values, such
   as an `xsd:dateTime` for an instant.
+- A property can name its inverse with `:inverseName`, such as `hasPart` on
+  `:isPartOf`. A record can give the relation under either name, so a whole
+  can list its parts, and only the forward edge is stored. The generated
+  `INVERSE_PROPERTIES` maps each inverse name to its forward property.
+- A number property can say what form its values take with `:metric`. A
+  `gauge` is a level or a rate, such as a heart rate, and combines as a mean,
+  minimum, or maximum. A `sum` is an amount, such as a number of steps, and
+  adds up. A metric's `:unit` is the one unit all its values are in, as a UCUM
+  code such as `/min`. The generated `METRIC_PROPERTIES` gives each metric's
+  form and unit.
 - A SHACL property shape after a property holds its record rules. `sh:maxCount 1`
   makes it take one value. A shape with `sh:targetClass` and `sh:minCount 1`
   makes it required on that class.
@@ -125,7 +135,8 @@ The generator turns the ontology into TypeScript types and Zod validators. It
 reads terms through `scripts/terms.js`, which the schema site also uses. It
 handles inheritance, including a class with two parents, domains and ranges,
 and SHACL counts, and it fails for cyclic inheritance, undeclared referenced
-classes, or a property with two domains or ranges. The package has no
+classes, a property with two domains or ranges, or a metric that isn't a
+gauge or a sum of numbers in one unit. The package has no
 persistence metadata, derived effects, or runtime filesystem parser.
 Generated runtime code depends only on Zod; the TTL is also included in the package.
 
@@ -156,8 +167,10 @@ documentation under the same release path. Published snapshots must never be
 overwritten or removed by later deployments. The unversioned `/chronicle.ttl`
 and term pages serve `main`, so `main` holds only vocabulary that is ready to
 publish: work on new terms in a branch until it is ready. Any change to
-`chronicle.ttl` after a release must raise `owl:versionInfo`;
-`npm run schema:check` enforces this against the latest release tag. See [Preparing a release](../../RELEASING.md) for the
+`chronicle.ttl` after a release must raise `owl:versionInfo`. While the
+vocabulary is in flux, `npm run schema:check` doesn't check this, so run
+`npm run version:check` before a release to compare against the latest release
+tag. See [Preparing a release](../../RELEASING.md) for the
 release procedure.
 
 The vocabulary is intentionally small. Add terms only when a plugin needs them;

package/chronicle.ttl

@@ -14,11 +14,33 @@
 @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
 
 : a owl:Ontology;
-  owl:versionInfo "0.3.0" .
+  owl:versionInfo "0.4.0" .
 
-# Annotations on properties, for tools rather than records.
+# Annotations on properties, for tools rather than records. :inverseName on
+# a property names its inverse: a record can give the relation under either
+# name, and a store keeps only the forward property. :assertedBy and
+# :retractedBy on a standing relation name the actions that start and end it,
+# and :runPredicate names the relation as those actions' history.
+#
+# :metric on a number property says what form its values take, and so how
+# its values over a time combine. A "gauge" is a level or a rate, such as a
+# heart rate, and combines as a mean, minimum, or maximum. A "sum" is an
+# amount, such as a number of steps, and adds up. Each value is for its
+# action's time: its :timestamp, or its :startTime to its :endTime. A
+# metric's :unit is the one unit all its values are in, as a UCUM code such
+# as `/min`, so values from any source can be compared. Values of two
+# properties can't be, even in the same unit.
 :abstract a owl:AnnotationProperty .
 :propagatesEncounter a owl:AnnotationProperty .
+:metric a owl:AnnotationProperty .
+:unit a owl:AnnotationProperty .
+:inverseName a owl:AnnotationProperty .
+:assertedBy a owl:AnnotationProperty .
+:retractedBy a owl:AnnotationProperty .
+:runPredicate a owl:AnnotationProperty .
+
+# Derived query vocabulary. These are not rdf:Property payload fields.
+:DerivedProperty a rdfs:Class .
 
 :Base a owl:Class;
   rdfs:comment "Anything a source describes, either an :Entity or an :Action. Each one has an identity, so other records can refer to it.";
@@ -65,7 +87,7 @@
   skos:exactMatch schemaorg:url .
 [] a sh:PropertyShape; sh:path :url; sh:targetSubjectsOf :url; sh:maxCount 1 .
 :object a owl:ObjectProperty;
-  rdfs:comment "The entity an action was carried out on, such as the article read, the message sent, or the place visited. For a movement, such as a :TravelAction, the :object is where it began.";
+  rdfs:comment "The entity an action was carried out on, such as the article read, the photo shared, or the place visited. For a movement, such as a :TravelAction, the :object is where it began.";
   rdfs:domain :Action;
   rdfs:range :Entity;
   skos:exactMatch schemaorg:object .
@@ -147,10 +169,19 @@
   rdfs:range :Text .
 [] a sh:PropertyShape; sh:path :handle; sh:targetSubjectsOf :handle; sh:maxCount 1 .
 :isPartOf a owl:ObjectProperty;
-  rdfs:comment "A whole that the entity is part of, such as a task's project or the page an excerpt comes from.";
+  rdfs:comment "A whole that the entity is part of, such as a task's project, the page an excerpt comes from, or the transaction a posting belongs to. Seen from the whole, its parts are its `hasPart` values.";
+  :inverseName "hasPart";
   rdfs:domain :Entity;
   rdfs:range :Entity;
   skos:exactMatch schemaorg:isPartOf .
+:isStageOf a owl:ObjectProperty;
+  rdfs:comment "The session that this session is a stage of, such as the night that a stretch of deep sleep is a stage of. A stage is part of how the whole went and does not happen apart from it. A whole's stages of the same type do not overlap, though together they need not cover it. Seen from the whole, its stages are its `hasStage` values.";
+  :inverseName "hasStage";
+  rdfs:subPropertyOf :isPartOf;
+  rdfs:domain :Session;
+  rdfs:range :Session;
+  skos:broadMatch schemaorg:isPartOf .
+[] a sh:PropertyShape; sh:path :isStageOf; sh:targetSubjectsOf :isStageOf; sh:maxCount 1 .
 :about a owl:ObjectProperty;
   rdfs:comment "What the entity is about, such as a topic or a tag.";
   rdfs:domain :Entity;
@@ -188,14 +219,14 @@
   skos:broadMatch schemaorg:Message .
 :MessageAction a owl:Class;
   rdfs:subClassOf :Action;
-  rdfs:comment "The agent sent a message. The :object is the message." .
+  rdfs:comment "The agent sent a message. Its :result is the :Message." .
 :MediaObject a owl:Class;
   rdfs:subClassOf :CreativeWork;
   rdfs:comment "A media file, such as an image, an audio recording, a video, or a document. Its :contentPath or :url locates the file, and its :mimeType gives its format.";
   skos:broadMatch schemaorg:MediaObject .
 :ImageObject a owl:Class;
   rdfs:subClassOf :MediaObject;
-  rdfs:comment "An image, such as a photograph, a screenshot, or an image attachment.";
+  rdfs:comment "An image file, such as a photo's file, a screenshot, or an image attachment.";
   skos:broadMatch schemaorg:ImageObject .
 :AudioObject a owl:Class;
   rdfs:subClassOf :MediaObject;
@@ -203,22 +234,35 @@
   skos:broadMatch schemaorg:AudioObject .
 :VideoObject a owl:Class;
   rdfs:subClassOf :MediaObject;
-  rdfs:comment "A video, such as a recorded clip or a video attachment. It can include sound.";
+  rdfs:comment "A video file, such as a recorded clip or a video attachment. It can include sound.";
   skos:broadMatch schemaorg:VideoObject .
+:StillImage a owl:Class;
+  rdfs:subClassOf :CreativeWork;
+  rdfs:comment "A still picture as a work, such as a photograph or a screenshot: what it shows, apart from the files that hold it. Each file is one of its :rendition values, usually an :ImageObject. A picture captured with a moment of motion also has a short :VideoObject.";
+  skos:narrowMatch schemaorg:Photograph .
+:MovingImage a owl:Class;
+  rdfs:subClassOf :CreativeWork;
+  rdfs:comment "A video as a work, such as one recorded with a camera or of a screen: what it shows, apart from the files that hold it. Each file is one of its :rendition values, a :VideoObject." .
+:rendition a owl:ObjectProperty;
+  rdfs:comment "A file that holds the work, such as a picture's image file, a video's video file, or an episode's audio file. A work can have several, such as a picture's image and the short video captured with it, or the same picture in two formats. Seen from the file, the work is its `renditionOf` value.";
+  :inverseName "renditionOf";
+  rdfs:domain :CreativeWork;
+  rdfs:range :MediaObject;
+  skos:exactMatch schemaorg:encoding .
 :DocumentObject a owl:Class;
   rdfs:subClassOf :MediaObject;
   rdfs:comment "A document file, such as a PDF, a text file, or a document attachment." .
 :recipient a owl:ObjectProperty;
-  rdfs:comment "An agent the message or call was directed to, such as each other participant in a group conversation.";
+  rdfs:comment "An agent the message, call, or transaction was directed to, such as each other participant in a group conversation or the merchant that was paid.";
   rdfs:subPropertyOf :involvement;
-  rdfs:domain [ a owl:Class; owl:unionOf ( :Message :CallSession ) ];
+  rdfs:domain [ a owl:Class; owl:unionOf ( :Message :CallSession :FinancialTransaction ) ];
   rdfs:range :Agent;
   skos:exactMatch schemaorg:recipient .
 :contains a owl:ObjectProperty;
-  rdfs:comment "A media file the entity is made of, such as the photo in a :Post, the images and videos in a carousel, or an attachment to a :Message. Each one has its most specific type, such as :ImageObject.";
+  rdfs:comment "A media file that is part of the entity, such as an attachment to a :Message, the photo in a :Post, or the images and videos in a carousel. Each one has its most specific type, such as :ImageObject.";
   rdfs:domain :Entity;
   rdfs:range :MediaObject;
-  skos:closeMatch schemaorg:associatedMedia .
+  skos:broadMatch schemaorg:hasPart .
 :contentPath a owl:DatatypeProperty;
   rdfs:comment "The absolute filesystem path of the local file that holds the media.";
   rdfs:domain :MediaObject;
@@ -231,6 +275,12 @@
   rdfs:range :Text;
   skos:closeMatch schemaorg:encodingFormat .
 [] a sh:PropertyShape; sh:path :mimeType; sh:targetSubjectsOf :mimeType; sh:maxCount 1 .
+:contentSize a owl:DatatypeProperty;
+  rdfs:comment "The size of the file, in bytes.";
+  rdfs:domain :MediaObject;
+  rdfs:range :Number;
+  skos:closeMatch schemaorg:contentSize .
+[] a sh:PropertyShape; sh:path :contentSize; sh:targetSubjectsOf :contentSize; sh:maxCount 1 .
 :transcript a owl:DatatypeProperty;
   rdfs:comment "The words spoken in a recording or an episode, written out, such as a voice memo's transcript, a podcast episode's transcript, or a video's captions. It is plain text with no timings. It belongs to the work rather than to one of its files, so a podcast episode's transcript is the episode's, not its audio file's. Spoken words are a :transcript, not a :body.";
   rdfs:domain [ a owl:Class; owl:unionOf ( :AudioObject :VideoObject :PodcastEpisode ) ];
@@ -277,9 +327,9 @@
   rdfs:range :Realm .
 [] a sh:PropertyShape; sh:path :inRealm; sh:targetSubjectsOf :inRealm; sh:maxCount 1 .
 :inAccount a owl:ObjectProperty;
-  rdfs:comment "The agent whose account holds the entity, as that account's service knows them, such as the owner of an email account a message was delivered to. An entity held in several accounts is :inAccount each. Identifiers an account issues are unique within it.";
+  rdfs:comment "The account that holds the entity. For an account with a service, it is the agent whose account it is, as that service knows them, such as the owner of an email account a message was delivered to. For a :FinancialAccount, it is the account itself, such as the one a :FinancialPosting is on or a :PaymentCard draws on. An entity held in several accounts is :inAccount each. Identifiers an account issues are unique within it.";
   rdfs:domain :Entity;
-  rdfs:range :Agent .
+  rdfs:range [ a owl:Class; owl:unionOf ( :Agent :FinancialAccount ) ] .
 
 :ConsumeAction a owl:Class;
   rdfs:comment "The agent took in the :object, such as by reading, watching, listening to, eating, or drinking it. The subclasses name how. A :ConsumeAction of no subclass records consumption in progress with no known start.";
@@ -296,6 +346,8 @@
   owl:equivalentClass [ a rdfs:Datatype; owl:unionOf ( xsd:decimal
     [ a rdfs:Datatype; owl:onDatatype xsd:double; owl:withRestrictions ( [ xsd:minExclusive "-INF"^^xsd:double ] [ xsd:maxExclusive "INF"^^xsd:double ] ) ] ) ];
   skos:broadMatch schemaorg:Number .
+:JSONObject a rdfs:Datatype;
+  rdfs:comment "A JSON object whose values are text or numbers, such as `{\"FNumber\": 1.8, \"LensModel\": \"EF50mm f/1.8 STM\"}`. The property that takes it says what its keys are. Not allowed: an array (`[1.8]`), a nested object (`{\"Lens\": {\"Model\": \"EF50mm\"}}`), or `true`, `false`, or `null` as a value." .
 :startTime a owl:DatatypeProperty;
   rdfs:comment "When the action started. A date gives the start at that date's precision.";
   rdfs:domain :Action;
@@ -309,7 +361,8 @@
   skos:exactMatch schemaorg:endTime .
 [] a sh:PropertyShape; sh:path :endTime; sh:targetSubjectsOf :endTime; sh:maxCount 1 .
 :result a owl:ObjectProperty;
-  rdfs:comment "What the action produced, such as a work or a session.";
+  rdfs:comment "What the action produced, such as a work or a session. Seen from what it produced, the action is its `resultOf` value.";
+  :inverseName "resultOf";
   rdfs:domain :Action;
   rdfs:range :Entity;
   skos:exactMatch schemaorg:result .
@@ -375,7 +428,7 @@
   skos:broadMatch schemaorg:TravelAction .
 :Journey a owl:Class;
   rdfs:comment "A recorded stretch of travel, with its :travelMode, its :distance, and its route as its :path. It is the :result of a :TravelAction, which gives its start and end.";
-  rdfs:subClassOf :Entity .
+  rdfs:subClassOf :Session .
 :travelMode a owl:DatatypeProperty;
   rdfs:comment "How the journey was made, such as `walking`, `cycling`, or `metro`.";
   rdfs:domain :Journey;
@@ -462,11 +515,24 @@
 :CallAction a owl:Class;
   rdfs:comment "The agent made a phone or video call. Its :result is the :CallSession.";
   rdfs:subClassOf :CommunicateAction .
+:ShareAction a owl:Class;
+  rdfs:comment "The agent shared the :object with others, such as by sending a photo in a conversation.";
+  rdfs:subClassOf :CommunicateAction;
+  skos:exactMatch schemaorg:ShareAction .
 :Session a owl:Class;
-  rdfs:comment "A described period of the subject's activity, such as a block of app use, a manually logged block of time, or a call. Unlike an :Event, it is not a named happening. Its :scheduledStart and :scheduledEnd give a planned period. The action that records it gives when it actually happened.";
+  rdfs:comment "A period of one person's activity or experience, such as a night's sleep, a logged block of work, a trip across town, or their time on a call. The action that records it gives when it actually happened. Others who took part have sessions of their own. Something they shared, such as a concert or a meeting, is an :Event that each session :isPartOf. Its :scheduledStart and :scheduledEnd give a planned period.";
   rdfs:subClassOf :Entity .
 :CallSession a owl:Class;
-  rdfs:comment "A phone or video call, as a period of time. It is the :result of a :CallAction. Its :recipient is who received the call. A group call :isPartOf a :Channel whose :member values are the participants. A missed call has zero length.";
+  rdfs:comment "One person's time on a phone or video call. It is the :result of a :CallAction. Its :recipient is who received the call. A group call's session :isPartOf a :Channel whose :member values are the participants. A missed call has zero length.";
+  rdfs:subClassOf :Session .
+:SleepAction a owl:Class;
+  rdfs:comment "The agent slept from :startTime to :endTime, such as for a night or a nap, including any brief wakings. Its :result is the :SleepSession.";
+  rdfs:subClassOf :ExperienceAction .
+:SleepSession a owl:Class;
+  rdfs:comment "A period of sleep, such as a night or a nap. It is the :result of a :SleepAction, which gives its start and end. Each tracked stage of it is a :SleepStage that :isStageOf it.";
+  rdfs:subClassOf :Session .
+:SleepStage a owl:Class;
+  rdfs:comment "A stretch of one stage of sleep, such as deep sleep, that :isStageOf a :SleepSession. It is the :result of an :ExperienceAction, which gives its start and end. Its :category is the stage: `awake`, `light`, `deep`, `REM`, or `asleep` when the stage is not known. Not allowed: another name for one of these, such as `core` for light sleep.";
   rdfs:subClassOf :Session .
 :EatAction a owl:Class;
   rdfs:comment "The agent ate the :object, a :Meal. Where they ate is the action's :location.";
@@ -479,12 +545,113 @@
 :Meal a owl:Class;
   rdfs:comment "A meal or snack that the subject ate. Its :category is its slot, such as breakfast, lunch, or dinner.";
   rdfs:subClassOf :Entity .
+
+:MeasureAction a owl:Class;
+  rdfs:comment "The agent took a measurement of the :object, such as a person's heart rate or weight. Each value measured is a property of the :object, such as its :heartRate. A value measured over a period, such as a daily resting heart rate or the steps taken in a few minutes, has a :startTime and :endTime.";
+  rdfs:subClassOf :Action .
+:heartRate a owl:DatatypeProperty;
+  :metric "gauge";
+  :unit "/min";
+  rdfs:comment "The heart rate, in beats per minute.";
+  rdfs:domain :Person;
+  rdfs:range :Number .
+[] a sh:PropertyShape; sh:path :heartRate; sh:targetSubjectsOf :heartRate; sh:maxCount 1 .
+:restingHeartRate a owl:DatatypeProperty;
+  :metric "gauge";
+  :unit "/min";
+  rdfs:comment "The heart rate at rest, in beats per minute.";
+  rdfs:domain :Person;
+  rdfs:range :Number .
+[] a sh:PropertyShape; sh:path :restingHeartRate; sh:targetSubjectsOf :restingHeartRate; sh:maxCount 1 .
+:walkingHeartRate a owl:DatatypeProperty;
+  :metric "gauge";
+  :unit "/min";
+  rdfs:comment "The average heart rate while walking, in beats per minute.";
+  rdfs:domain :Person;
+  rdfs:range :Number .
+[] a sh:PropertyShape; sh:path :walkingHeartRate; sh:targetSubjectsOf :walkingHeartRate; sh:maxCount 1 .
+:heartRateVariabilitySdnn a owl:DatatypeProperty;
+  :metric "gauge";
+  :unit "ms";
+  rdfs:comment "The variation in time between heartbeats as SDNN: the standard deviation of the intervals between beats over the measurement's period, in milliseconds. It grows with the length of the period, so values over periods of different lengths don't compare. Other measures of the variation, such as RMSSD, differ from it.";
+  rdfs:domain :Person;
+  rdfs:range :Number .
+[] a sh:PropertyShape; sh:path :heartRateVariabilitySdnn; sh:targetSubjectsOf :heartRateVariabilitySdnn; sh:maxCount 1 .
+:heartRateRecovery a owl:DatatypeProperty;
+  :metric "gauge";
+  :unit "/min";
+  rdfs:comment "How far the heart rate fell in the minute after exercise, in beats per minute.";
+  rdfs:domain :Person;
+  rdfs:range :Number .
+[] a sh:PropertyShape; sh:path :heartRateRecovery; sh:targetSubjectsOf :heartRateRecovery; sh:maxCount 1 .
+:heartRhythm a owl:DatatypeProperty;
+  rdfs:comment "The rhythm of the heart, as an electrocardiogram classifies it, such as `sinus rhythm` or `atrial fibrillation`.";
+  rdfs:domain :Person;
+  rdfs:range :Text .
+[] a sh:PropertyShape; sh:path :heartRhythm; sh:targetSubjectsOf :heartRhythm; sh:maxCount 1 .
+:respiratoryRate a owl:DatatypeProperty;
+  :metric "gauge";
+  :unit "/min";
+  rdfs:comment "The breathing rate, in breaths per minute.";
+  rdfs:domain :Person;
+  rdfs:range :Number .
+[] a sh:PropertyShape; sh:path :respiratoryRate; sh:targetSubjectsOf :respiratoryRate; sh:maxCount 1 .
+:oxygenSaturation a owl:DatatypeProperty;
+  :metric "gauge";
+  :unit "1";
+  rdfs:comment "The fraction of hemoglobin in the blood that carries oxygen, from `0` to `1`, such as `0.97`.";
+  rdfs:domain :Person;
+  rdfs:range :Number .
+[] a sh:PropertyShape; sh:path :oxygenSaturation; sh:targetSubjectsOf :oxygenSaturation; sh:maxCount 1 .
+:sleepingWristTemperature a owl:DatatypeProperty;
+  :metric "gauge";
+  :unit "Cel";
+  rdfs:comment "The skin temperature at the wrist during sleep, in degrees Celsius.";
+  rdfs:domain :Person;
+  rdfs:range :Number .
+[] a sh:PropertyShape; sh:path :sleepingWristTemperature; sh:targetSubjectsOf :sleepingWristTemperature; sh:maxCount 1 .
+:weight a owl:DatatypeProperty;
+  :metric "gauge";
+  :unit "kg";
+  rdfs:comment "The person's body weight, as a mass in kilograms.";
+  rdfs:domain :Person;
+  rdfs:range :Number;
+  skos:closeMatch schemaorg:weight .
+[] a sh:PropertyShape; sh:path :weight; sh:targetSubjectsOf :weight; sh:maxCount 1 .
+:systolicBloodPressure a owl:DatatypeProperty;
+  :metric "gauge";
+  :unit "mm[Hg]";
+  rdfs:comment "The blood pressure while the heart beats, in millimeters of mercury.";
+  rdfs:domain :Person;
+  rdfs:range :Number .
+[] a sh:PropertyShape; sh:path :systolicBloodPressure; sh:targetSubjectsOf :systolicBloodPressure; sh:maxCount 1 .
+:diastolicBloodPressure a owl:DatatypeProperty;
+  :metric "gauge";
+  :unit "mm[Hg]";
+  rdfs:comment "The blood pressure between heartbeats, in millimeters of mercury.";
+  rdfs:domain :Person;
+  rdfs:range :Number .
+[] a sh:PropertyShape; sh:path :diastolicBloodPressure; sh:targetSubjectsOf :diastolicBloodPressure; sh:maxCount 1 .
+:stepCount a owl:DatatypeProperty;
+  :metric "sum";
+  :unit "{steps}";
+  rdfs:comment "The number of steps taken.";
+  rdfs:domain :Person;
+  rdfs:range :Number .
+[] a sh:PropertyShape; sh:path :stepCount; sh:targetSubjectsOf :stepCount; sh:maxCount 1 .
+:activeEnergyBurned a owl:DatatypeProperty;
+  :metric "sum";
+  :unit "kcal";
+  rdfs:comment "The energy burned by moving, beyond what the body burns at rest, in kilocalories.";
+  rdfs:domain :Person;
+  rdfs:range :Number .
+[] a sh:PropertyShape; sh:path :activeEnergyBurned; sh:targetSubjectsOf :activeEnergyBurned; sh:maxCount 1 .
 :Post a owl:Class;
   rdfs:comment "A work published to a social or media platform, such as a feed post, a story, a reel, or a tweet. It can have a text :body and media files that it :contains. Its :sourceFormat is the platform's own format for it.";
   rdfs:subClassOf :CreativeWork;
   skos:broadMatch schemaorg:SocialMediaPosting .
 :PublishAction a owl:Class;
-  rdfs:comment "The agent published or released the :object. The work's :datePublished is when this happened.";
+  rdfs:comment "The agent published or released a work, such as a post, a video, or a pull request. Its :result is the work, and the work's :datePublished is when this happened.";
   rdfs:subClassOf :CreateAction .
 :CreateAction a owl:Class;
   rdfs:comment "The agent brought a work into being. Its :result is the work. The subclasses name the kind of making.";
@@ -497,10 +664,26 @@
   rdfs:comment "The agent took a photograph. Its :result is the :ImageObject.";
   rdfs:subClassOf :CreateAction;
   skos:exactMatch schemaorg:PhotographAction .
+:ScreenshotAction a owl:Class;
+  rdfs:comment "The agent captured what a screen showed, such as a web page or an app. Its :result is the :ImageObject. The image is a :snapshotOf the resource it shows, and the :object can name the page it was captured from.";
+  rdfs:subClassOf :CreateAction .
 :LikeAction a owl:Class;
   rdfs:comment "The agent liked the :object.";
   rdfs:subClassOf :ReactAction;
   skos:broadMatch schemaorg:LikeAction .
+:UnlikeAction a owl:Class;
+  rdfs:comment "The agent withdrew a like of the :object, such as by removing a favorite.";
+  rdfs:subClassOf :ReactAction .
+:likes a owl:ObjectProperty;
+  rdfs:comment "An entity the agent likes. A :LikeAction adds an entity to the agent's likes, and an :UnlikeAction removes it. A source can also give the agent's likes directly.";
+  rdfs:subPropertyOf :relation;
+  :assertedBy :LikeAction;
+  :retractedBy :UnlikeAction;
+  :runPredicate :liked;
+  rdfs:domain :Agent;
+  rdfs:range :Entity .
+:liked a :DerivedProperty;
+  rdfs:comment "An agent's standing like for the object, opened by LikeAction and closed by UnlikeAction. The writable relationship is likes; this derived query name preserves the object-and-agent view of the action history." .
 :ReactAction a owl:Class;
   rdfs:comment "The agent took a stance on the :object with no content, such as a like. A reaction with content, such as an emoji or a comment, is a :RespondAction.";
   rdfs:subClassOf :AssessAction;
@@ -586,6 +769,10 @@
   rdfs:comment "One episode of a podcast.";
   rdfs:subClassOf :CreativeWork;
   skos:broadMatch schemaorg:PodcastEpisode .
+:PodcastSeries a owl:Class;
+  rdfs:comment "A podcast, a series of episodes published through a :webFeed by a :publisher.";
+  rdfs:subClassOf :CreativeWork;
+  skos:broadMatch schemaorg:PodcastSeries .
 :attribution a owl:ObjectProperty;
   rdfs:comment "An agent responsible for bringing a work into being.";
   rdfs:subPropertyOf :relation;
@@ -629,6 +816,18 @@
   rdfs:range :MusicAlbum;
   skos:exactMatch schemaorg:inAlbum .
 [] a sh:PropertyShape; sh:path :inAlbum; sh:targetSubjectsOf :inAlbum; sh:maxCount 1 .
+:series a owl:ObjectProperty;
+  :propagatesEncounter true;
+  rdfs:comment "The series that this work is one of, such as the podcast an episode belongs to or the series a book was published in.";
+  rdfs:subPropertyOf :partOf;
+  rdfs:domain :CreativeWork;
+  rdfs:range :CreativeWork;
+  skos:closeMatch schemaorg:partOfSeries .
+:webFeed a owl:DatatypeProperty;
+  rdfs:comment "The URL of an RSS or Atom feed that publishes the work's items, such as a podcast's episodes or a blog's posts.";
+  rdfs:domain :CreativeWork;
+  rdfs:range :URL;
+  skos:exactMatch schemaorg:webFeed .
 :duration a owl:DatatypeProperty;
   rdfs:comment "How long the recording or media lasts.";
   rdfs:domain [ a owl:Class; owl:unionOf ( :AudioObject :VideoObject :MusicRecording :PodcastEpisode ) ];
@@ -717,10 +916,10 @@
   rdfs:comment "A period of using a device, such as a block of time with one app in focus. It is the :result of an :ExecuteAction, which gives its start and end. Its :subject is the resource in focus, and it :isPartOf a project. When no resource is in focus, its :name is the window's title.";
   rdfs:subClassOf :Session .
 :PhysicalObject a owl:Class;
-  rdfs:comment "A physical object the subject owns or uses, such as a device, a vehicle, or a musical instrument. Its :category is its kind, such as `computer` or `car`, and its :model is its make and model. The subclasses name the roles an object plays in actions, such as :Device.";
+  rdfs:comment "A physical object the subject owns or uses, such as a device, a vehicle, or a musical instrument. Its :model is its make and model. The subclasses name the roles an object plays in actions, such as :Device.";
   rdfs:subClassOf :Entity .
 :Device a owl:Class;
-  rdfs:comment "A physical computing device the subject runs software on, such as a computer, a phone, or a tablet. It is the :instrument of an :ExecuteAction. It names a role, not a kind, so its :category says what kind of device it is. It is :inRealm the logical machine, which can outlive the hardware.";
+  rdfs:comment "A physical computing device the subject runs software on, such as a computer, a phone, a tablet, or a watch. It is the :instrument of the actions done with it, such as an :ExecuteAction or a :MeasureAction. It names a role, not a kind, so its :model says what kind of device it is. It is :inRealm the logical machine, which can outlive the hardware.";
   rdfs:subClassOf :PhysicalObject .
 :ProductModel a owl:Class;
   rdfs:comment "A kind of product, such as a line of phones or one model of camera, rather than one particular product. One particular computing device is a :Device.";
@@ -740,7 +939,7 @@
   rdfs:domain :Session;
   rdfs:range :Entity .
 :model a owl:DatatypeProperty;
-  rdfs:comment "The make and model of the object, such as `Mac17,9` or `iPhone15,2`. It is not the object's :name or its :category.";
+  rdfs:comment "The make and model of the object, such as `Mac17,9` or `iPhone15,2`. It is not the object's :name.";
   rdfs:domain :PhysicalObject;
   rdfs:range :Text;
   skos:exactMatch schemaorg:model .
@@ -803,6 +1002,10 @@
   rdfs:comment "A written piece published on the web or in a periodical, such as a news story, a blog post, or a feed item.";
   rdfs:subClassOf :CreativeWork;
   skos:broadMatch schemaorg:Article .
+:Note a owl:Class;
+  rdfs:comment "A text that its author keeps and edits, such as a note in a notes app or a page in a personal wiki. Its :body is its text. A document file, such as a PDF or an attachment, is a :DocumentObject.";
+  rdfs:subClassOf :CreativeWork;
+  skos:closeMatch schemaorg:NoteDigitalDocument .
 :snapshotOf a owl:ObjectProperty;
   rdfs:comment "The resource this media captured at a moment, such as the web page in a screenshot or an archive. The value is the resource itself, the entity with the URL. The media's type tells a screenshot from an archive.";
   rdfs:subPropertyOf :relation;
@@ -840,11 +1043,22 @@
   rdfs:range :Text;
   skos:closeMatch schemaorg:keywords .
 :caption a owl:DatatypeProperty;
-  rdfs:comment "A caption or description of the image.";
-  rdfs:domain :ImageObject;
+  rdfs:comment "A caption or description of the picture or video, written by a person.";
+  rdfs:domain [ a owl:Class; owl:unionOf ( :StillImage :MovingImage :ImageObject ) ];
   rdfs:range :Text;
   skos:exactMatch schemaorg:caption .
 [] a sh:PropertyShape; sh:path :caption; sh:targetSubjectsOf :caption; sh:maxCount 1 .
+:exifData a owl:DatatypeProperty;
+  rdfs:comment "What the image's file records about how it was taken, as EXIF tags. Each key is the tag's name in EXIF 3.0, such as `FNumber`, `ExposureTime`, or `LensModel`. Each value is the tag's value as EXIF defines it. A fraction is a decimal (`0.008`), a code is its number (`5`), and text is as written. Not allowed: another name for a tag (`ISO` for `PhotographicSensitivity`), a fraction as text (`1/125`), or a code's meaning (`Pattern`).";
+  rdfs:domain :ImageObject;
+  rdfs:range :JSONObject;
+  skos:closeMatch schemaorg:exifData .
+[] a sh:PropertyShape; sh:path :exifData; sh:targetSubjectsOf :exifData; sh:maxCount 1 .
+:depicts a owl:ObjectProperty;
+  rdfs:comment "Something that appears in the picture or video, such as a person, an animal, or a building.";
+  rdfs:subPropertyOf :relation;
+  rdfs:domain [ a owl:Class; owl:unionOf ( :StillImage :MovingImage ) ];
+  rdfs:range :Entity .
 :SoftwareSourceCode a owl:Class;
   rdfs:comment "Source code as a work, such as a snippet, a script, or a program's code.";
   rdfs:subClassOf :CreativeWork;
@@ -853,7 +1067,7 @@
   rdfs:comment "A store of files and their history under version control, hosted on a forge or kept locally. It can hold source code, data, documents, or anything else. Work filed against it, such as tasks and changesets, :isPartOf it.";
   rdfs:subClassOf :CreativeWork .
 :Changeset a owl:Class;
-  rdfs:comment "A set of changes to a work, proposed or applied as a unit, that can be revised until it is decided, such as a pull request or a suggested edit to a document. It :isPartOf the work it changes. A :PublishAction puts it forward. An :AcceptAction, :RejectAction, or :CancelAction then decides it.";
+  rdfs:comment "A set of changes to a work, made as a unit, such as a pull request, a suggested edit to a document, or the text a writer added to a note in one sitting. Its :body is the text it adds. It :isPartOf the work it changes. One applied directly is the :result of the :UpdateAction that made it. One proposed is put forward by a :PublishAction and can be revised until an :AcceptAction, :RejectAction, or :CancelAction decides it. A version of a work, such as a commit, is a :Revision.";
   rdfs:subClassOf :CreativeWork .
 :AcceptAction a owl:Class;
   rdfs:comment "The agent accepted what was put forward, such as merging a changeset into the work it changes. The :object is what was accepted.";
@@ -872,3 +1086,52 @@
   skos:exactMatch schemaorg:isBasedOn;
   rdfs:domain :CreativeWork;
   rdfs:range :CreativeWork .
+
+:TradeAction a owl:Class;
+  rdfs:comment "The agent exchanged something of value with another agent, such as by buying, selling, or paying.";
+  rdfs:subClassOf :Action;
+  skos:broadMatch schemaorg:TradeAction .
+:PayAction a owl:Class;
+  rdfs:comment "The agent paid money to another agent, such as for a purchase with a card. Its :result is the :FinancialTransaction, which gives how much was paid and to whom.";
+  rdfs:subClassOf :TradeAction;
+  skos:closeMatch schemaorg:PayAction .
+:FinancialTransaction a owl:Class;
+  rdfs:comment "A movement of money, such as a card purchase, a transfer between accounts, or a trade. It is the :result of the action that moved the money, such as a :PayAction, which gives when it happened and who paid. Its :amount gives how much moved, and its :recipient is who received it. Its change to each account is a :FinancialPosting that is :isPartOf it.";
+  rdfs:subClassOf :Intangible .
+:PaymentCard a owl:Class;
+  rdfs:comment "A numbered card that payments draw on, such as a credit card or a debit card. It is the card as issued, so a card reissued with a new number is a new :PaymentCard, while the account behind it continues. The same card added to several devices is one :PaymentCard. It is the :instrument of a :PayAction, and the account it draws on is its :inAccount. Its :category is its kind, such as `credit` or `debit`.";
+  rdfs:subClassOf :Intangible;
+  skos:closeMatch schemaorg:PaymentCard .
+:MonetaryAmount a owl:Class;
+  rdfs:comment "A sum of money: its :value in its :currency. It has no identity of its own.";
+  rdfs:subClassOf :StructuredValue;
+  skos:closeMatch schemaorg:MonetaryAmount .
+:value a owl:DatatypeProperty;
+  rdfs:comment "The number of units of the :currency, such as `69.93`.";
+  rdfs:domain :MonetaryAmount;
+  rdfs:range :Number;
+  skos:exactMatch schemaorg:value .
+[] a sh:PropertyShape; sh:path :value; sh:targetSubjectsOf :value; sh:maxCount 1 .
+:currency a owl:DatatypeProperty;
+  rdfs:comment "The currency the :value is in, as its ISO 4217 code, such as `CAD` or `USD`. Not allowed: a symbol (`$`) or a name (`dollars`).";
+  rdfs:domain :MonetaryAmount;
+  rdfs:range :Text;
+  skos:closeMatch schemaorg:currency .
+[] a sh:PropertyShape; sh:path :currency; sh:targetSubjectsOf :currency; sh:maxCount 1 .
+:amount a owl:ObjectProperty;
+  rdfs:comment "How much money moved. On a :FinancialTransaction, it is the whole amount, and its :value is positive. The action that produced the transaction says who paid and who was paid. On a :FinancialPosting, it is the change to the posting's account, and its :value is signed. It is negative where the money came from and positive where it went. A positive value increases an asset or an expense account, and a negative one increases a liability, an income, or an equity account, so a purchase paid with a card is negative on the card's account.";
+  rdfs:domain [ a owl:Class; owl:unionOf ( :FinancialTransaction :FinancialPosting ) ];
+  rdfs:range :MonetaryAmount;
+  skos:closeMatch schemaorg:amount .
+[] a sh:PropertyShape; sh:path :amount; sh:targetSubjectsOf :amount; sh:maxCount 1 .
+:FinancialAccount a owl:Class;
+  rdfs:comment "An account that money is counted in, as one line of a chart of accounts. It is a real account held with an institution, such as a bank account or a credit card account, or a nominal one that classifies money, such as an expense or income category. Its :financialAccountType says which of the five kinds it is. The account above it in the chart is what it :isPartOf.";
+  rdfs:subClassOf :Intangible .
+:FinancialPosting a owl:Class;
+  rdfs:comment "One side of a :FinancialTransaction: the change it made to one :FinancialAccount. It is :isPartOf the transaction, its :inAccount is the account, and its :amount is the change. A negative amount is where the money came from, and a positive one is where it went. A transaction whose postings sum to zero is complete.";
+  rdfs:subClassOf :Intangible .
+:financialAccountType a owl:DatatypeProperty;
+  rdfs:comment "The kind of :FinancialAccount, one of `asset`, `liability`, `equity`, `income`, or `expense`. An asset is money held, a liability is money owed, income is where money comes from, expense is where it goes, and equity is what is left when liabilities are taken from assets. Not allowed: another kind (`credit-card`) or another case (`Asset`).";
+  rdfs:domain :FinancialAccount;
+  rdfs:range :Text .
+[] a sh:PropertyShape; sh:path :financialAccountType; sh:targetSubjectsOf :financialAccountType; sh:maxCount 1 .

package/dist/identity.d.ts

@@ -0,0 +1,59 @@
+import type { KeyField } from './schema.js';
+/**
+ * A node's identity as one string, whatever its source or the shape of its
+ * `@key`: the hash of its keyset, the values of the fields its `@key` names.
+ * Extractors and stores derive it the same way, so one node can name another
+ * by it, such as from its text, without knowing how the other is keyed. The
+ * hash must never change: every stored identity is one.
+ */
+/** A node, as far as its identity goes: its `@key` or `@id`, and the fields they name. */
+export interface KeyedNode {
+    '@type'?: unknown;
+    '@key'?: KeyField[];
+    '@id'?: unknown;
+}
+/**
+ * The source a node identified by nothing but its URL belongs to. A URL is a
+ * portable identifier, like an email address or a phone number, so it belongs
+ * to no product, whichever source saw it.
+ */
+export declare const URL_SOURCE = "url";
+/**
+ * Deep, recursive, stable-key canonicalization: object keys are sorted at
+ * every level and undefined values dropped, so equal content always produces
+ * identical bytes. Array order is kept, since it means something. A `Date` is
+ * the ISO string a store gets for it, once it's serialized.
+ */
+export declare function canonicalize(value: unknown): unknown;
+/** Canonical JSON: the same string whatever order the keys were added in. */
+export declare function canonicalJson(value: unknown): string;
+/**
+ * Lowercase base32 (RFC 4648, no padding) of the sha256 of the bytes: 52
+ * characters, shorter than hex and safe in URLs and on case-insensitive
+ * filesystems.
+ */
+export declare function base32Sha256(bytes: Uint8Array): string;
+/**
+ * The hash of a keyset: the base32 sha256 of its canonical JSON, the same
+ * however its keys are ordered.
+ */
+export declare function generateKeysetCID(keyset: Record<string, unknown>): string;
+/**
+ * The keyset a node's `@key` names: each field's value by its path, with dots
+ * and `[*]` splats followed into nested values and a list joined with commas.
+ * `source` is the source given, and an `action.` field is read from the action
+ * the node is in. A computed entry `{ key, value }` is `key:value`. Fields
+ * with no value are left out, and a keyset with none is null, so it never
+ * names one node shared by unrelated records. A key of nothing but `url` is
+ * the `url` source's, so it names the same node whichever source saw it.
+ */
+export declare function keysetOf(node: KeyedNode, source: string | undefined, actionContext?: Record<string, unknown>): Record<string, unknown> | null;
+/**
+ * A node's identity: the hash of the keyset its `@key` names, or its `@id`,
+ * which is that hash already. With both, they must agree. With neither, it's
+ * its `url`, as the `url` source's, or else its `attachmentCid`, the stored
+ * file it is. `source` is the node's own unless given, as for a node in a
+ * record of that source that names none.
+ */
+export declare function nodeKey(node: KeyedNode, source?: string | undefined, actionContext?: Record<string, unknown>): string;
+//# sourceMappingURL=identity.d.ts.map