declare type Integer = number; export interface Types { Array: Array; ArrayValidator: ArrayValidator; Article: Article; AudioObject: AudioObject; BlockContent: BlockContent; Boolean: boolean; BooleanValidator: BooleanValidator; Brand: Brand; CitationIntentEnumeration: CitationIntentEnumeration; Cite: Cite; CiteGroup: CiteGroup; Claim: Claim; Code: Code; CodeBlock: CodeBlock; CodeChunk: CodeChunk; CodeError: CodeError; CodeExecutable: CodeExecutable; CodeExecutableTypes: CodeExecutableTypes; CodeExpression: CodeExpression; CodeFragment: CodeFragment; CodeTypes: CodeTypes; Collection: Collection; Comment: Comment; ConstantValidator: ConstantValidator; ContactPoint: ContactPoint; ContactPointTypes: ContactPointTypes; CreativeWork: CreativeWork; CreativeWorkTypes: CreativeWorkTypes; Datatable: Datatable; DatatableColumn: DatatableColumn; Date: Date; DefinedTerm: DefinedTerm; Delete: Delete; Emphasis: Emphasis; Entity: Entity; EntityTypes: EntityTypes; EnumValidator: EnumValidator; Enumeration: Enumeration; EnumerationTypes: EnumerationTypes; Figure: Figure; Function: Function; Grant: Grant; GrantTypes: GrantTypes; Heading: Heading; ImageObject: ImageObject; Include: Include; InlineContent: InlineContent; Integer: Integer; IntegerValidator: IntegerValidator; Link: Link; List: List; ListItem: ListItem; Mark: Mark; MarkTypes: MarkTypes; Math: Math; MathBlock: MathBlock; MathFragment: MathFragment; MathTypes: MathTypes; MediaObject: MediaObject; MediaObjectTypes: MediaObjectTypes; MonetaryGrant: MonetaryGrant; Node: Node; NontextualAnnotation: NontextualAnnotation; Note: Note; Null: null; Number: number; NumberValidator: NumberValidator; Object: { [property: string]: Primitive; }; Organization: Organization; Paragraph: Paragraph; Parameter: Parameter; Periodical: Periodical; Person: Person; PostalAddress: PostalAddress; Primitive: Primitive; Product: Product; PropertyValue: PropertyValue; PublicationIssue: PublicationIssue; PublicationVolume: PublicationVolume; Quote: Quote; QuoteBlock: QuoteBlock; Review: Review; SoftwareApplication: SoftwareApplication; SoftwareEnvironment: SoftwareEnvironment; SoftwareSession: SoftwareSession; SoftwareSourceCode: SoftwareSourceCode; String: string; StringValidator: StringValidator; Strong: Strong; Subscript: Subscript; Superscript: Superscript; Table: Table; TableCell: TableCell; TableRow: TableRow; ThematicBreak: ThematicBreak; Thing: Thing; ThingTypes: ThingTypes; TupleValidator: TupleValidator; Validator: Validator; ValidatorTypes: ValidatorTypes; Variable: Variable; VideoObject: VideoObject; VolumeMount: VolumeMount; } /** * The most simple compound (ie. non-atomic like `number`, `string` etc) type. */ export declare type Entity = { type: 'Entity' | 'ArrayValidator' | 'Article' | 'AudioObject' | 'BooleanValidator' | 'Brand' | 'CitationIntentEnumeration' | 'Cite' | 'CiteGroup' | 'Claim' | 'Code' | 'CodeBlock' | 'CodeChunk' | 'CodeError' | 'CodeExecutable' | 'CodeExpression' | 'CodeFragment' | 'Collection' | 'Comment' | 'ConstantValidator' | 'ContactPoint' | 'CreativeWork' | 'Datatable' | 'DatatableColumn' | 'Date' | 'DefinedTerm' | 'Delete' | 'Emphasis' | 'EnumValidator' | 'Enumeration' | 'Figure' | 'Function' | 'Grant' | 'Heading' | 'ImageObject' | 'Include' | 'IntegerValidator' | 'Link' | 'List' | 'ListItem' | 'Mark' | 'Math' | 'MathBlock' | 'MathFragment' | 'MediaObject' | 'MonetaryGrant' | 'NontextualAnnotation' | 'Note' | 'NumberValidator' | 'Organization' | 'Paragraph' | 'Parameter' | 'Periodical' | 'Person' | 'PostalAddress' | 'Product' | 'PropertyValue' | 'PublicationIssue' | 'PublicationVolume' | 'Quote' | 'QuoteBlock' | 'Review' | 'SoftwareApplication' | 'SoftwareEnvironment' | 'SoftwareSession' | 'SoftwareSourceCode' | 'StringValidator' | 'Strong' | 'Subscript' | 'Superscript' | 'Table' | 'TableCell' | 'TableRow' | 'ThematicBreak' | 'Thing' | 'TupleValidator' | 'Validator' | 'Variable' | 'VideoObject' | 'VolumeMount'; id?: string; meta?: { [property: string]: Primitive; }; }; /** * Create a `Entity` node * @param props Object containing Entity schema properties as key/value pairs * @returns {Entity} Entity schema node */ export declare const entity: (props?: Omit) => Entity; /** * A reference to a CreativeWork that is cited in another CreativeWork. */ export declare type Cite = Entity & { type: 'Cite'; target: string; citationIntent?: Array; citationMode?: 'Parenthetical' | 'Narrative' | 'NarrativeAuthor' | 'NarrativeYear' | 'normal' | 'suppressAuthor'; citationPrefix?: string; citationSuffix?: string; content?: Array; pageEnd?: Integer | string; pageStart?: Integer | string; pagination?: string; }; /** * Create a `Cite` node * @param props Object containing Cite schema properties as key/value pairs * @returns {Cite} Cite schema node */ export declare const cite: (props: Omit) => Cite; /** * A group of Cite nodes. */ export declare type CiteGroup = Entity & { type: 'CiteGroup'; items: Array; }; /** * Create a `CiteGroup` node * @param props Object containing CiteGroup schema properties as key/value pairs * @returns {CiteGroup} CiteGroup schema node */ export declare const citeGroup: (props: Omit) => CiteGroup; /** * Base type for non-executable (e.g. `CodeBlock`) and executable (e.g. `CodeExpression`) code nodes. */ export declare type Code = Entity & { type: 'Code' | 'CodeBlock' | 'CodeChunk' | 'CodeExecutable' | 'CodeExpression' | 'CodeFragment'; text: string; mediaType?: string; programmingLanguage?: string; }; /** * Create a `Code` node * @param props Object containing Code schema properties as key/value pairs * @returns {Code} Code schema node */ export declare const code: (props: Omit) => Code; /** * A code block. */ export declare type CodeBlock = Code & { type: 'CodeBlock'; }; /** * Create a `CodeBlock` node * @param props Object containing CodeBlock schema properties as key/value pairs * @returns {CodeBlock} CodeBlock schema node */ export declare const codeBlock: (props: Omit) => CodeBlock; /** * Base type for executable code nodes (i.e. `CodeChunk` and `CodeExpression`). */ export declare type CodeExecutable = Code & { type: 'CodeExecutable' | 'CodeChunk' | 'CodeExpression'; programmingLanguage: string; codeDependencies?: Array; codeDependents?: Array; compileDigest?: string; errors?: Array; executeCount?: Integer; executeDigest?: string; executeDuration?: number; executeEnded?: Date; executeRequired?: 'No' | 'NeverExecuted' | 'SemanticsChanged' | 'DependenciesChanged' | 'DependenciesFailed'; executeStatus?: 'Scheduled' | 'ScheduledPreviouslyFailed' | 'Running' | 'RunningPreviouslyFailed' | 'Succeeded' | 'Failed' | 'Cancelled'; }; /** * Create a `CodeExecutable` node * @param props Object containing CodeExecutable schema properties as key/value pairs * @returns {CodeExecutable} CodeExecutable schema node */ export declare const codeExecutable: (props: Omit) => CodeExecutable; /** * A executable chunk of code. */ export declare type CodeChunk = CodeExecutable & { type: 'CodeChunk'; programmingLanguage: string; caption?: Array | string; executeAuto?: 'Never' | 'Needed' | 'Always'; executePure?: boolean; label?: string; outputs?: Array; }; /** * Create a `CodeChunk` node * @param props Object containing CodeChunk schema properties as key/value pairs * @returns {CodeChunk} CodeChunk schema node */ export declare const codeChunk: (props: Omit) => CodeChunk; /** * An executable programming code expression. */ export declare type CodeExpression = CodeExecutable & { type: 'CodeExpression'; programmingLanguage: string; output?: Node; }; /** * Create a `CodeExpression` node * @param props Object containing CodeExpression schema properties as key/value pairs * @returns {CodeExpression} CodeExpression schema node */ export declare const codeExpression: (props: Omit) => CodeExpression; /** * Inline code. */ export declare type CodeFragment = Code & { type: 'CodeFragment'; }; /** * Create a `CodeFragment` node * @param props Object containing CodeFragment schema properties as key/value pairs * @returns {CodeFragment} CodeFragment schema node */ export declare const codeFragment: (props: Omit) => CodeFragment; /** * An error that occurred when parsing, compiling or executing a Code node. */ export declare type CodeError = Entity & { type: 'CodeError'; errorMessage: string; errorType?: string; stackTrace?: string; }; /** * Create a `CodeError` node * @param props Object containing CodeError schema properties as key/value pairs * @returns {CodeError} CodeError schema node */ export declare const codeError: (props: Omit) => CodeError; /** * A date encoded as a ISO 8601 string. */ export declare type Date = Entity & { type: 'Date'; value: string; }; /** * Create a `Date` node * @param props Object containing Date schema properties as key/value pairs * @returns {Date} Date schema node */ export declare const date: (props: Omit) => Date; /** * A base class for nodes that mark some other inline content * in some way (e.g. as being emphasised, or quoted). */ export declare type Mark = Entity & { type: 'Mark' | 'Delete' | 'Emphasis' | 'NontextualAnnotation' | 'Quote' | 'Strong' | 'Subscript' | 'Superscript'; content: Array; }; /** * Create a `Mark` node * @param props Object containing Mark schema properties as key/value pairs * @returns {Mark} Mark schema node */ export declare const mark: (props: Omit) => Mark; /** * Content that is marked for deletion */ export declare type Delete = Mark & { type: 'Delete'; }; /** * Create a `Delete` node * @param props Object containing Delete schema properties as key/value pairs * @returns {Delete} Delete schema node */ export declare const del: (props: Omit) => Delete; /** * Emphasised content. */ export declare type Emphasis = Mark & { type: 'Emphasis'; }; /** * Create a `Emphasis` node * @param props Object containing Emphasis schema properties as key/value pairs * @returns {Emphasis} Emphasis schema node */ export declare const emphasis: (props: Omit) => Emphasis; /** * The most generic type of item. */ export declare type Thing = Entity & { type: 'Thing' | 'Article' | 'AudioObject' | 'Brand' | 'CitationIntentEnumeration' | 'Claim' | 'Collection' | 'Comment' | 'ContactPoint' | 'CreativeWork' | 'Datatable' | 'DatatableColumn' | 'DefinedTerm' | 'Enumeration' | 'Figure' | 'Grant' | 'ImageObject' | 'ListItem' | 'MediaObject' | 'MonetaryGrant' | 'Organization' | 'Periodical' | 'Person' | 'PostalAddress' | 'Product' | 'PropertyValue' | 'PublicationIssue' | 'PublicationVolume' | 'Review' | 'SoftwareApplication' | 'SoftwareEnvironment' | 'SoftwareSession' | 'SoftwareSourceCode' | 'Table' | 'VideoObject' | 'VolumeMount'; alternateNames?: Array; description?: Array | Array | string; identifiers?: Array; images?: Array; name?: string; url?: string; }; /** * Create a `Thing` node * @param props Object containing Thing schema properties as key/value pairs * @returns {Thing} Thing schema node */ export declare const thing: (props?: Omit) => Thing; /** * A brand used by an organization or person for labeling a product, * product group, or similar. */ export declare type Brand = Thing & { type: 'Brand'; name: string; logo?: ImageObject | string; reviews?: Array; }; /** * Create a `Brand` node * @param props Object containing Brand schema properties as key/value pairs * @returns {Brand} Brand schema node */ export declare const brand: (props: Omit) => Brand; /** * A contact point, usually within an organization. */ export declare type ContactPoint = Thing & { type: 'ContactPoint' | 'PostalAddress'; availableLanguages?: Array; emails?: Array; telephoneNumbers?: Array; }; /** * Create a `ContactPoint` node * @param props Object containing ContactPoint schema properties as key/value pairs * @returns {ContactPoint} ContactPoint schema node */ export declare const contactPoint: (props?: Omit) => ContactPoint; /** * A creative work, including books, movies, photographs, software programs, etc. */ export declare type CreativeWork = Thing & { type: 'CreativeWork' | 'Article' | 'AudioObject' | 'Claim' | 'Collection' | 'Comment' | 'Datatable' | 'Figure' | 'ImageObject' | 'MediaObject' | 'Periodical' | 'PublicationIssue' | 'PublicationVolume' | 'Review' | 'SoftwareApplication' | 'SoftwareSourceCode' | 'Table' | 'VideoObject'; about?: Array; authors?: Array; comments?: Array; content?: Array | string; dateAccepted?: Date; dateCreated?: Date; dateModified?: Date; datePublished?: Date; dateReceived?: Date; editors?: Array; fundedBy?: Array; funders?: Array; genre?: Array; isPartOf?: CreativeWorkTypes; keywords?: Array; licenses?: Array; maintainers?: Array; parts?: Array; publisher?: Person | Organization; references?: Array; text?: string; title?: Array | string; version?: string | number; }; /** * Create a `CreativeWork` node * @param props Object containing CreativeWork schema properties as key/value pairs * @returns {CreativeWork} CreativeWork schema node */ export declare const creativeWork: (props?: Omit) => CreativeWork; /** * An article, including news and scholarly articles. */ export declare type Article = CreativeWork & { type: 'Article'; content?: Array; pageEnd?: Integer | string; pageStart?: Integer | string; pagination?: string; }; /** * Create a `Article` node * @param props Object containing Article schema properties as key/value pairs * @returns {Article} Article schema node */ export declare const article: (props?: Omit) => Article; /** * A claim represents specific reviewable facts or statements. */ export declare type Claim = CreativeWork & { type: 'Claim'; content: Array; claimType?: 'Statement' | 'Theorem' | 'Lemma' | 'Proof' | 'Postulate' | 'Hypothesis' | 'Proposition' | 'Corollary'; label?: string; }; /** * Create a `Claim` node * @param props Object containing Claim schema properties as key/value pairs * @returns {Claim} Claim schema node */ export declare const claim: (props: Omit) => Claim; /** * A collection of CreativeWorks or other artifacts. */ export declare type Collection = CreativeWork & { type: 'Collection'; parts: Array; }; /** * Create a `Collection` node * @param props Object containing Collection schema properties as key/value pairs * @returns {Collection} Collection schema node */ export declare const collection: (props: Omit) => Collection; /** * A comment on an item, e.g on a Article, or SoftwareSourceCode. */ export declare type Comment = CreativeWork & { type: 'Comment'; commentAspect?: string; parentItem?: Comment; }; /** * Create a `Comment` node * @param props Object containing Comment schema properties as key/value pairs * @returns {Comment} Comment schema node */ export declare const comment: (props?: Omit) => Comment; /** * A table of data. */ export declare type Datatable = CreativeWork & { type: 'Datatable'; columns: Array; }; /** * Create a `Datatable` node * @param props Object containing Datatable schema properties as key/value pairs * @returns {Datatable} Datatable schema node */ export declare const datatable: (props: Omit) => Datatable; /** * A media object, such as an image, video, or audio object embedded in a web page or a * downloadable dataset. */ export declare type MediaObject = CreativeWork & { type: 'MediaObject' | 'AudioObject' | 'ImageObject' | 'VideoObject'; contentUrl: string; bitrate?: number; contentSize?: number; embedUrl?: string; mediaType?: string; }; /** * Create a `MediaObject` node * @param props Object containing MediaObject schema properties as key/value pairs * @returns {MediaObject} MediaObject schema node */ export declare const mediaObject: (props: Omit) => MediaObject; /** * An audio file */ export declare type AudioObject = MediaObject & { type: 'AudioObject'; caption?: string; transcript?: string; }; /** * Create a `AudioObject` node * @param props Object containing AudioObject schema properties as key/value pairs * @returns {AudioObject} AudioObject schema node */ export declare const audioObject: (props: Omit) => AudioObject; /** * A column of data within a Datatable. */ export declare type DatatableColumn = Thing & { type: 'DatatableColumn'; name: string; values: Array; validator?: ArrayValidator; }; /** * Create a `DatatableColumn` node * @param props Object containing DatatableColumn schema properties as key/value pairs * @returns {DatatableColumn} DatatableColumn schema node */ export declare const datatableColumn: (props: Omit) => DatatableColumn; /** * A word, name, acronym, phrase, etc. with a formal definition. */ export declare type DefinedTerm = Thing & { type: 'DefinedTerm'; name: string; termCode?: string; }; /** * Create a `DefinedTerm` node * @param props Object containing DefinedTerm schema properties as key/value pairs * @returns {DefinedTerm} DefinedTerm schema node */ export declare const definedTerm: (props: Omit) => DefinedTerm; /** * A base for all validator types. */ export declare type Validator = Entity & { type: 'Validator' | 'ArrayValidator' | 'BooleanValidator' | 'ConstantValidator' | 'EnumValidator' | 'IntegerValidator' | 'NumberValidator' | 'StringValidator' | 'TupleValidator'; }; /** * Create a `Validator` node * @param props Object containing Validator schema properties as key/value pairs * @returns {Validator} Validator schema node */ export declare const validator: (props?: Omit) => Validator; /** * A validator specifying constraints on an array node. */ export declare type ArrayValidator = Validator & { type: 'ArrayValidator'; contains?: ValidatorTypes; itemsValidator?: ValidatorTypes; maxItems?: Integer; minItems?: Integer; uniqueItems?: boolean; }; /** * Create a `ArrayValidator` node * @param props Object containing ArrayValidator schema properties as key/value pairs * @returns {ArrayValidator} ArrayValidator schema node */ export declare const arrayValidator: (props?: Omit) => ArrayValidator; /** * A schema specifying that a node must be a boolean value. */ export declare type BooleanValidator = Validator & { type: 'BooleanValidator'; }; /** * Create a `BooleanValidator` node * @param props Object containing BooleanValidator schema properties as key/value pairs * @returns {BooleanValidator} BooleanValidator schema node */ export declare const booleanValidator: (props?: Omit) => BooleanValidator; /** * A validator specifying a constant value that a node must have. */ export declare type ConstantValidator = Validator & { type: 'ConstantValidator'; value?: Node; }; /** * Create a `ConstantValidator` node * @param props Object containing ConstantValidator schema properties as key/value pairs * @returns {ConstantValidator} ConstantValidator schema node */ export declare const constantValidator: (props?: Omit) => ConstantValidator; /** * A schema specifying that a node must be one of several values. */ export declare type EnumValidator = Validator & { type: 'EnumValidator'; values?: Array; }; /** * Create a `EnumValidator` node * @param props Object containing EnumValidator schema properties as key/value pairs * @returns {EnumValidator} EnumValidator schema node */ export declare const enumValidator: (props?: Omit) => EnumValidator; /** * Lists or enumerations, for example, a list of cuisines or music genres, etc. */ export declare type Enumeration = Thing & { type: 'Enumeration' | 'CitationIntentEnumeration'; }; /** * Create a `Enumeration` node * @param props Object containing Enumeration schema properties as key/value pairs * @returns {Enumeration} Enumeration schema node */ export declare const enumeration: (props?: Omit) => Enumeration; /** * Encapsulates one or more images, videos, tables, etc, and provides captions and labels for them. */ export declare type Figure = CreativeWork & { type: 'Figure'; caption?: Array | string; label?: string; }; /** * Create a `Figure` node * @param props Object containing Figure schema properties as key/value pairs * @returns {Figure} Figure schema node */ export declare const figure: (props?: Omit) => Figure; /** * A function with a name, which might take Parameters and return a value of a certain type. */ export declare type Function = Entity & { type: 'Function'; name?: string; parameters?: Array; returns?: ValidatorTypes; }; /** * Create a `Function` node * @param props Object containing Function schema properties as key/value pairs * @returns {Function} Function schema node */ export declare const function_: (props?: Omit) => Function; /** * A grant, typically financial or otherwise quantifiable, of resources. */ export declare type Grant = Thing & { type: 'Grant' | 'MonetaryGrant'; fundedItems?: Array; sponsors?: Array; }; /** * Create a `Grant` node * @param props Object containing Grant schema properties as key/value pairs * @returns {Grant} Grant schema node */ export declare const grant: (props?: Omit) => Grant; /** * A heading. */ export declare type Heading = Entity & { type: 'Heading'; content: Array; depth?: Integer; }; /** * Create a `Heading` node * @param props Object containing Heading schema properties as key/value pairs * @returns {Heading} Heading schema node */ export declare const heading: (props: Omit) => Heading; /** * An image file. */ export declare type ImageObject = MediaObject & { type: 'ImageObject'; caption?: string; thumbnail?: ImageObject; }; /** * Create a `ImageObject` node * @param props Object containing ImageObject schema properties as key/value pairs * @returns {ImageObject} ImageObject schema node */ export declare const imageObject: (props: Omit) => ImageObject; /** * Include content from an external source (e.g. file, URL). */ export declare type Include = Entity & { type: 'Include'; source: string; buildDigest?: string; content?: Array; mediaType?: string; }; /** * Create a `Include` node * @param props Object containing Include schema properties as key/value pairs * @returns {Include} Include schema node */ export declare const include: (props: Omit) => Include; /** * A validator specifying the constraints on an integer node. */ export declare type IntegerValidator = Validator & { type: 'IntegerValidator'; }; /** * Create a `IntegerValidator` node * @param props Object containing IntegerValidator schema properties as key/value pairs * @returns {IntegerValidator} IntegerValidator schema node */ export declare const integerValidator: (props?: Omit) => IntegerValidator; /** * A hyperlink to other pages, sections within the same document, resources, or any URL. */ export declare type Link = Entity & { type: 'Link'; content: Array; target: string; exportFrom?: string; importTo?: string; relation?: string; title?: string; }; /** * Create a `Link` node * @param props Object containing Link schema properties as key/value pairs * @returns {Link} Link schema node */ export declare const link: (props: Omit) => Link; /** * A list of items. */ export declare type List = Entity & { type: 'List'; items: Array; order?: 'Ascending' | 'Descending' | 'Unordered'; }; /** * Create a `List` node * @param props Object containing List schema properties as key/value pairs * @returns {List} List schema node */ export declare const list: (props: Omit) => List; /** * A single item in a list. */ export declare type ListItem = Thing & { type: 'ListItem'; content?: Array | Array; isChecked?: boolean; item?: Node; position?: Integer; }; /** * Create a `ListItem` node * @param props Object containing ListItem schema properties as key/value pairs * @returns {ListItem} ListItem schema node */ export declare const listItem: (props?: Omit) => ListItem; /** * A mathematical variable or equation. */ export declare type Math = Entity & { type: 'Math' | 'MathBlock' | 'MathFragment'; text: string; errors?: Array; mathLanguage?: string; }; /** * Create a `Math` node * @param props Object containing Math schema properties as key/value pairs * @returns {Math} Math schema node */ export declare const math: (props: Omit) => Math; /** * A block of math, e.g an equation, to be treated as block content. */ export declare type MathBlock = Math & { type: 'MathBlock'; label?: string; }; /** * Create a `MathBlock` node * @param props Object containing MathBlock schema properties as key/value pairs * @returns {MathBlock} MathBlock schema node */ export declare const mathBlock: (props: Omit) => MathBlock; /** * A fragment of math, e.g a variable name, to be treated as inline content. */ export declare type MathFragment = Math & { type: 'MathFragment'; }; /** * Create a `MathFragment` node * @param props Object containing MathFragment schema properties as key/value pairs * @returns {MathFragment} MathFragment schema node */ export declare const mathFragment: (props: Omit) => MathFragment; /** * A monetary grant. */ export declare type MonetaryGrant = Grant & { type: 'MonetaryGrant'; amounts?: number; funders?: Array; }; /** * Create a `MonetaryGrant` node * @param props Object containing MonetaryGrant schema properties as key/value pairs * @returns {MonetaryGrant} MonetaryGrant schema node */ export declare const monetaryGrant: (props?: Omit) => MonetaryGrant; /** * Inline text that has a non-textual annotation. */ export declare type NontextualAnnotation = Mark & { type: 'NontextualAnnotation'; }; /** * Create a `NontextualAnnotation` node * @param props Object containing NontextualAnnotation schema properties as key/value pairs * @returns {NontextualAnnotation} NontextualAnnotation schema node */ export declare const nontextualAnnotation: (props: Omit) => NontextualAnnotation; /** * Additional content which is not part of the main content of a document. */ export declare type Note = Entity & { type: 'Note'; content: Array; noteType?: 'Footnote' | 'Endnote' | 'Sidenote'; }; /** * Create a `Note` node * @param props Object containing Note schema properties as key/value pairs * @returns {Note} Note schema node */ export declare const note: (props: Omit) => Note; /** * A validator specifying the constraints on a numeric node. */ export declare type NumberValidator = Validator & { type: 'NumberValidator'; exclusiveMaximum?: number; exclusiveMinimum?: number; maximum?: number; minimum?: number; multipleOf?: number; }; /** * Create a `NumberValidator` node * @param props Object containing NumberValidator schema properties as key/value pairs * @returns {NumberValidator} NumberValidator schema node */ export declare const numberValidator: (props?: Omit) => NumberValidator; /** * An organization such as a school, NGO, corporation, club, etc. */ export declare type Organization = Thing & { type: 'Organization'; address?: PostalAddress | string; brands?: Array; contactPoints?: Array; departments?: Array; funders?: Array; legalName?: string; logo?: ImageObject | string; members?: Array; parentOrganization?: Organization; }; /** * Create a `Organization` node * @param props Object containing Organization schema properties as key/value pairs * @returns {Organization} Organization schema node */ export declare const organization: (props?: Omit) => Organization; /** * Paragraph */ export declare type Paragraph = Entity & { type: 'Paragraph'; content: Array; }; /** * Create a `Paragraph` node * @param props Object containing Paragraph schema properties as key/value pairs * @returns {Paragraph} Paragraph schema node */ export declare const paragraph: (props: Omit) => Paragraph; /** * A parameter of a document or function. */ export declare type Parameter = Entity & { type: 'Parameter'; name: string; default?: Node; executeDigest?: string; isExtensible?: boolean; isRequired?: boolean; isVariadic?: boolean; validator?: ValidatorTypes; value?: Node; }; /** * Create a `Parameter` node * @param props Object containing Parameter schema properties as key/value pairs * @returns {Parameter} Parameter schema node */ export declare const parameter: (props: Omit) => Parameter; /** * A periodical publication. */ export declare type Periodical = CreativeWork & { type: 'Periodical'; dateEnd?: Date; dateStart?: Date; issns?: Array; }; /** * Create a `Periodical` node * @param props Object containing Periodical schema properties as key/value pairs * @returns {Periodical} Periodical schema node */ export declare const periodical: (props?: Omit) => Periodical; /** * A person (alive, dead, undead, or fictional). */ export declare type Person = Thing & { type: 'Person'; address?: PostalAddress | string; affiliations?: Array; emails?: Array; familyNames?: Array; funders?: Array; givenNames?: Array; honorificPrefix?: string; honorificSuffix?: string; jobTitle?: string; memberOf?: Array; telephoneNumbers?: Array; }; /** * Create a `Person` node * @param props Object containing Person schema properties as key/value pairs * @returns {Person} Person schema node */ export declare const person: (props?: Omit) => Person; /** * A physical mailing address. */ export declare type PostalAddress = ContactPoint & { type: 'PostalAddress'; addressCountry?: string; addressLocality?: string; addressRegion?: string; postOfficeBoxNumber?: string; postalCode?: string; streetAddress?: string; }; /** * Create a `PostalAddress` node * @param props Object containing PostalAddress schema properties as key/value pairs * @returns {PostalAddress} PostalAddress schema node */ export declare const postalAddress: (props?: Omit) => PostalAddress; /** * Any offered product or service. For example, a pair of shoes; * a haircut; or an episode of a TV show streamed online. */ export declare type Product = Thing & { type: 'Product'; brands?: Array; logo?: ImageObject | string; productID?: string; }; /** * Create a `Product` node * @param props Object containing Product schema properties as key/value pairs * @returns {Product} Product schema node */ export declare const product: (props?: Omit) => Product; /** * A property-value pair. */ export declare type PropertyValue = Thing & { type: 'PropertyValue'; value: boolean | Integer | number | string; propertyID?: string; }; /** * Create a `PropertyValue` node * @param props Object containing PropertyValue schema properties as key/value pairs * @returns {PropertyValue} PropertyValue schema node */ export declare const propertyValue: (props: Omit) => PropertyValue; /** * A part of a successively published publication such as a periodical or publication * volume, often numbered. */ export declare type PublicationIssue = CreativeWork & { type: 'PublicationIssue'; issueNumber?: Integer | string; pageEnd?: Integer | string; pageStart?: Integer | string; pagination?: string; }; /** * Create a `PublicationIssue` node * @param props Object containing PublicationIssue schema properties as key/value pairs * @returns {PublicationIssue} PublicationIssue schema node */ export declare const publicationIssue: (props?: Omit) => PublicationIssue; /** * A part of a successively published publication such as a periodical or multi-volume work. */ export declare type PublicationVolume = CreativeWork & { type: 'PublicationVolume'; pageEnd?: Integer | string; pageStart?: Integer | string; pagination?: string; volumeNumber?: Integer | string; }; /** * Create a `PublicationVolume` node * @param props Object containing PublicationVolume schema properties as key/value pairs * @returns {PublicationVolume} PublicationVolume schema node */ export declare const publicationVolume: (props?: Omit) => PublicationVolume; /** * Inline, quoted content. */ export declare type Quote = Mark & { type: 'Quote'; cite?: Cite | string; }; /** * Create a `Quote` node * @param props Object containing Quote schema properties as key/value pairs * @returns {Quote} Quote schema node */ export declare const quote: (props: Omit) => Quote; /** * A section quoted from somewhere else. */ export declare type QuoteBlock = Entity & { type: 'QuoteBlock'; content: Array; cite?: Cite | string; }; /** * Create a `QuoteBlock` node * @param props Object containing QuoteBlock schema properties as key/value pairs * @returns {QuoteBlock} QuoteBlock schema node */ export declare const quoteBlock: (props: Omit) => QuoteBlock; /** * A review of an item, e.g of an Article, or SoftwareSourceCode. */ export declare type Review = CreativeWork & { type: 'Review'; itemReviewed?: Thing; reviewAspect?: string; }; /** * Create a `Review` node * @param props Object containing Review schema properties as key/value pairs * @returns {Review} Review schema node */ export declare const review: (props?: Omit) => Review; /** * A software application. */ export declare type SoftwareApplication = CreativeWork & { type: 'SoftwareApplication'; softwareRequirements?: Array; softwareVersion?: string; }; /** * Create a `SoftwareApplication` node * @param props Object containing SoftwareApplication schema properties as key/value pairs * @returns {SoftwareApplication} SoftwareApplication schema node */ export declare const softwareApplication: (props?: Omit) => SoftwareApplication; /** * A computational environment. */ export declare type SoftwareEnvironment = Thing & { type: 'SoftwareEnvironment'; name: string; adds?: Array; extends?: Array; removes?: Array; }; /** * Create a `SoftwareEnvironment` node * @param props Object containing SoftwareEnvironment schema properties as key/value pairs * @returns {SoftwareEnvironment} SoftwareEnvironment schema node */ export declare const softwareEnvironment: (props: Omit) => SoftwareEnvironment; /** * Definition of a compute session, including its software and compute resource * requirements and status. */ export declare type SoftwareSession = Thing & { type: 'SoftwareSession'; clientsLimit?: number; clientsRequest?: number; cpuLimit?: number; cpuRequest?: number; dateEnd?: Date; dateStart?: Date; durationLimit?: number; durationRequest?: number; environment?: SoftwareEnvironment; memoryLimit?: number; memoryRequest?: number; networkTransferLimit?: number; networkTransferRequest?: number; status?: 'Unknown' | 'Starting' | 'Started' | 'Stopping' | 'Stopped' | 'Failed'; timeoutLimit?: number; timeoutRequest?: number; volumeMounts?: Array; }; /** * Create a `SoftwareSession` node * @param props Object containing SoftwareSession schema properties as key/value pairs * @returns {SoftwareSession} SoftwareSession schema node */ export declare const softwareSession: (props?: Omit) => SoftwareSession; /** * Computer programming source code. Example: Full (compile ready) solutions, code snippet samples, scripts, templates. */ export declare type SoftwareSourceCode = CreativeWork & { type: 'SoftwareSourceCode'; codeRepository?: string; codeSampleType?: string; programmingLanguage?: string; runtimePlatform?: Array; softwareRequirements?: Array; targetProducts?: Array; }; /** * Create a `SoftwareSourceCode` node * @param props Object containing SoftwareSourceCode schema properties as key/value pairs * @returns {SoftwareSourceCode} SoftwareSourceCode schema node */ export declare const softwareSourceCode: (props?: Omit) => SoftwareSourceCode; /** * A schema specifying constraints on a string node. */ export declare type StringValidator = Validator & { type: 'StringValidator'; maxLength?: Integer; minLength?: Integer; pattern?: string; }; /** * Create a `StringValidator` node * @param props Object containing StringValidator schema properties as key/value pairs * @returns {StringValidator} StringValidator schema node */ export declare const stringValidator: (props?: Omit) => StringValidator; /** * Strongly emphasised content. */ export declare type Strong = Mark & { type: 'Strong'; }; /** * Create a `Strong` node * @param props Object containing Strong schema properties as key/value pairs * @returns {Strong} Strong schema node */ export declare const strong: (props: Omit) => Strong; /** * Subscripted content. */ export declare type Subscript = Mark & { type: 'Subscript'; }; /** * Create a `Subscript` node * @param props Object containing Subscript schema properties as key/value pairs * @returns {Subscript} Subscript schema node */ export declare const subscript: (props: Omit) => Subscript; /** * Superscripted content. */ export declare type Superscript = Mark & { type: 'Superscript'; }; /** * Create a `Superscript` node * @param props Object containing Superscript schema properties as key/value pairs * @returns {Superscript} Superscript schema node */ export declare const superscript: (props: Omit) => Superscript; /** * A table. */ export declare type Table = CreativeWork & { type: 'Table'; rows: Array; caption?: Array | string; label?: string; }; /** * Create a `Table` node * @param props Object containing Table schema properties as key/value pairs * @returns {Table} Table schema node */ export declare const table: (props: Omit) => Table; /** * A cell within a `Table`. */ export declare type TableCell = Entity & { type: 'TableCell'; cellType?: 'Data' | 'Header'; colspan?: Integer; content?: Array | Array; name?: string; rowspan?: Integer; }; /** * Create a `TableCell` node * @param props Object containing TableCell schema properties as key/value pairs * @returns {TableCell} TableCell schema node */ export declare const tableCell: (props?: Omit) => TableCell; /** * A row within a Table. */ export declare type TableRow = Entity & { type: 'TableRow'; cells: Array; rowType?: 'Header' | 'Footer'; }; /** * Create a `TableRow` node * @param props Object containing TableRow schema properties as key/value pairs * @returns {TableRow} TableRow schema node */ export declare const tableRow: (props: Omit) => TableRow; /** * A thematic break, such as a scene change in a story, a transition to another topic, or a new document. */ export declare type ThematicBreak = Entity & { type: 'ThematicBreak'; }; /** * Create a `ThematicBreak` node * @param props Object containing ThematicBreak schema properties as key/value pairs * @returns {ThematicBreak} ThematicBreak schema node */ export declare const thematicBreak: (props?: Omit) => ThematicBreak; /** * A validator specifying constraints on an array of heterogeneous items. */ export declare type TupleValidator = Validator & { type: 'TupleValidator'; items?: Array; }; /** * Create a `TupleValidator` node * @param props Object containing TupleValidator schema properties as key/value pairs * @returns {TupleValidator} TupleValidator schema node */ export declare const tupleValidator: (props?: Omit) => TupleValidator; /** * A variable representing a name / value pair. */ export declare type Variable = Entity & { type: 'Variable'; name: string; isReadonly?: boolean; validator?: ValidatorTypes; value?: Node; }; /** * Create a `Variable` node * @param props Object containing Variable schema properties as key/value pairs * @returns {Variable} Variable schema node */ export declare const variable: (props: Omit) => Variable; /** * A video file. */ export declare type VideoObject = MediaObject & { type: 'VideoObject'; caption?: string; thumbnail?: ImageObject; transcript?: string; }; /** * Create a `VideoObject` node * @param props Object containing VideoObject schema properties as key/value pairs * @returns {VideoObject} VideoObject schema node */ export declare const videoObject: (props: Omit) => VideoObject; /** * Describes a volume mount from a host to container. */ export declare type VolumeMount = Thing & { type: 'VolumeMount'; mountDestination: string; mountOptions?: Array; mountSource?: string; mountType?: string; }; /** * Create a `VolumeMount` node * @param props Object containing VolumeMount schema properties as key/value pairs * @returns {VolumeMount} VolumeMount schema node */ export declare const volumeMount: (props: Omit) => VolumeMount; /** * Union type for valid block content. */ export declare type BlockContent = Claim | CodeBlock | CodeChunk | Collection | Figure | Heading | Include | List | MathBlock | Paragraph | QuoteBlock | Table | ThematicBreak; /** * All type schemas that are derived from CodeExecutable */ export declare type CodeExecutableTypes = CodeExecutable | CodeChunk | CodeExpression; /** * All type schemas that are derived from Code */ export declare type CodeTypes = Code | CodeBlock | CodeChunk | CodeExecutable | CodeExpression | CodeFragment; /** * All type schemas that are derived from ContactPoint */ export declare type ContactPointTypes = ContactPoint | PostalAddress; /** * All type schemas that are derived from CreativeWork */ export declare type CreativeWorkTypes = CreativeWork | Article | AudioObject | Claim | Collection | Comment | Datatable | Figure | ImageObject | MediaObject | Periodical | PublicationIssue | PublicationVolume | Review | SoftwareApplication | SoftwareSourceCode | Table | VideoObject; /** * All type schemas that are derived from Entity */ export declare type EntityTypes = Entity | ArrayValidator | Article | AudioObject | BooleanValidator | Brand | CitationIntentEnumeration | Cite | CiteGroup | Claim | Code | CodeBlock | CodeChunk | CodeError | CodeExecutable | CodeExpression | CodeFragment | Collection | Comment | ConstantValidator | ContactPoint | CreativeWork | Datatable | DatatableColumn | Date | DefinedTerm | Delete | Emphasis | EnumValidator | Enumeration | Figure | Function | Grant | Heading | ImageObject | Include | IntegerValidator | Link | List | ListItem | Mark | Math | MathBlock | MathFragment | MediaObject | MonetaryGrant | NontextualAnnotation | Note | NumberValidator | Organization | Paragraph | Parameter | Periodical | Person | PostalAddress | Product | PropertyValue | PublicationIssue | PublicationVolume | Quote | QuoteBlock | Review | SoftwareApplication | SoftwareEnvironment | SoftwareSession | SoftwareSourceCode | StringValidator | Strong | Subscript | Superscript | Table | TableCell | TableRow | ThematicBreak | Thing | TupleValidator | Validator | Variable | VideoObject | VolumeMount; /** * All type schemas that are derived from Enumeration */ export declare type EnumerationTypes = Enumeration | CitationIntentEnumeration; /** * All type schemas that are derived from Grant */ export declare type GrantTypes = Grant | MonetaryGrant; /** * Union type for valid inline content. */ export declare type InlineContent = AudioObject | Cite | CiteGroup | CodeExpression | CodeFragment | Delete | Emphasis | ImageObject | Link | MathFragment | NontextualAnnotation | Note | Parameter | Quote | Strong | Subscript | Superscript | VideoObject | null | boolean | Integer | number | string; /** * All type schemas that are derived from Mark */ export declare type MarkTypes = Mark | Delete | Emphasis | NontextualAnnotation | Quote | Strong | Subscript | Superscript; /** * All type schemas that are derived from Math */ export declare type MathTypes = Math | MathBlock | MathFragment; /** * All type schemas that are derived from MediaObject */ export declare type MediaObjectTypes = MediaObject | AudioObject | ImageObject | VideoObject; /** * Union type for all types of nodes in this schema, including primitives and entities */ export declare type Node = Entity | ArrayValidator | Article | AudioObject | BooleanValidator | Brand | CitationIntentEnumeration | Cite | CiteGroup | Claim | Code | CodeBlock | CodeChunk | CodeError | CodeExecutable | CodeExpression | CodeFragment | Collection | Comment | ConstantValidator | ContactPoint | CreativeWork | Datatable | DatatableColumn | Date | DefinedTerm | Delete | Emphasis | EnumValidator | Enumeration | Figure | Function | Grant | Heading | ImageObject | Include | IntegerValidator | Link | List | ListItem | Mark | Math | MathBlock | MathFragment | MediaObject | MonetaryGrant | NontextualAnnotation | Note | NumberValidator | Organization | Paragraph | Parameter | Periodical | Person | PostalAddress | Product | PropertyValue | PublicationIssue | PublicationVolume | Quote | QuoteBlock | Review | SoftwareApplication | SoftwareEnvironment | SoftwareSession | SoftwareSourceCode | StringValidator | Strong | Subscript | Superscript | Table | TableCell | TableRow | ThematicBreak | Thing | TupleValidator | Validator | Variable | VideoObject | VolumeMount | null | boolean | Integer | number | string | { [property: string]: Primitive; } | Array; /** * Union type for all primitives values */ export declare type Primitive = null | boolean | Integer | number | string | { [property: string]: Primitive; } | Array; /** * All type schemas that are derived from Thing */ export declare type ThingTypes = Thing | Article | AudioObject | Brand | CitationIntentEnumeration | Claim | Collection | Comment | ContactPoint | CreativeWork | Datatable | DatatableColumn | DefinedTerm | Enumeration | Figure | Grant | ImageObject | ListItem | MediaObject | MonetaryGrant | Organization | Periodical | Person | PostalAddress | Product | PropertyValue | PublicationIssue | PublicationVolume | Review | SoftwareApplication | SoftwareEnvironment | SoftwareSession | SoftwareSourceCode | Table | VideoObject | VolumeMount; /** * All type schemas that are derived from Validator */ export declare type ValidatorTypes = Validator | ArrayValidator | BooleanValidator | ConstantValidator | EnumValidator | IntegerValidator | NumberValidator | StringValidator | TupleValidator; /** * The type or nature of a citation, both factually and rhetorically. */ export declare enum CitationIntentEnumeration { /** * The citing entity agrees with statements, ideas or conclusions presented in the cited entity */ AgreesWith = "AgreesWith", /** * The citing entity cites the cited entity as one that provides an authoritative description or definition of the subject under discussion */ CitesAsAuthority = "CitesAsAuthority", /** * The citing entity cites the cited entity as source of data */ CitesAsDataSource = "CitesAsDataSource", /** * The citing entity cites the cited entity as source of factual evidence for statements it contains */ CitesAsEvidence = "CitesAsEvidence", /** * The citing entity cites the cited entity as being the container of metadata describing the citing entity */ CitesAsMetadataDocument = "CitesAsMetadataDocument", /** * The citing entity cites the cited entity as providing or containing a possible solution to the issues being discussed */ CitesAsPotentialSolution = "CitesAsPotentialSolution", /** * The citing entity cites the cited entity as an item of recommended reading */ CitesAsRecommendedReading = "CitesAsRecommendedReading", /** * The citing entity cites the cited entity as one that is related */ CitesAsRelated = "CitesAsRelated", /** * The citing entity cites the cited entity as being the entity from which the citing entity is derived, or about which the citing entity contains metadata */ CitesAsSourceDocument = "CitesAsSourceDocument", /** * The citing entity cites the cited entity as a source of information on the subject under discussion */ CitesForInformation = "CitesForInformation", /** * The citing entity is used to create or compile the cited entity */ Compiles = "Compiles", /** * The citing entity confirms facts, ideas or statements presented in the cited entity */ Confirms = "Confirms", /** * The citing entity contains a statement of fact or a logical assertion (or a collection of such facts and/or assertions) originally present in the cited entity */ ContainsAssertionFrom = "ContainsAssertionFrom", /** * The citing entity corrects statements, ideas or conclusions presented in the cited entity */ Corrects = "Corrects", /** * The citing entity acknowledges contributions made by the cited entity */ Credits = "Credits", /** * The citing entity critiques statements, ideas or conclusions presented in the cited entity */ Critiques = "Critiques", /** * The citing entity express derision for the cited entity, or for ideas or conclusions contained within it */ Derides = "Derides", /** * The citing entity describes the cited entity */ Describes = "Describes", /** * The citing entity disagrees with statements, ideas or conclusions presented in the cited entity */ DisagreesWith = "DisagreesWith", /** * The citing entity discusses statements, ideas or conclusions presented in the cited entity */ Discusses = "Discusses", /** * The citing entity disputes statements, ideas or conclusions presented in the cited entity */ Disputes = "Disputes", /** * The citing entity documents information about the cited entity */ Documents = "Documents", /** * The citing entity extends facts, ideas or understandings presented in the cited entity */ Extends = "Extends", /** * The cited entity provides background information for the citing entity */ GivesBackgroundTo = "GivesBackgroundTo", /** * The cited entity provides intellectual or factual support for the citing entity */ GivesSupportTo = "GivesSupportTo", /** * The cited entity evokes a reply from the citing entity */ HasReplyFrom = "HasReplyFrom", /** * The citing entity includes one or more excerpts from the cited entity */ IncludesExcerptFrom = "IncludesExcerptFrom", /** * The citing entity includes one or more quotations from the cited entity */ IncludesQuotationFrom = "IncludesQuotationFrom", /** * The cited entity contains statements, ideas or conclusions with which the citing entity agrees */ IsAgreedWithBy = "IsAgreedWithBy", /** * The cited entity is cited as providing an authoritative description or definition of the subject under discussion in the citing entity */ IsCitedAsAuthorityBy = "IsCitedAsAuthorityBy", /** * The cited entity is cited as a data source by the citing entity */ IsCitedAsDataSourceBy = "IsCitedAsDataSourceBy", /** * The cited entity is cited for providing factual evidence to the citing entity */ IsCitedAsEvidenceBy = "IsCitedAsEvidenceBy", /** * The cited entity is cited as being the container of metadata relating to the citing entity */ IsCitedAsMetadataDocumentBy = "IsCitedAsMetadataDocumentBy", /** * The cited entity is cited as providing or containing a possible solution to the issues being discussed in the citing entity */ IsCitedAsPontentialSolutionBy = "IsCitedAsPontentialSolutionBy", /** * The cited entity is cited by the citing entity as an item of recommended reading */ IsCitedAsRecommendedReadingBy = "IsCitedAsRecommendedReadingBy", /** * The cited entity is cited as being related to the citing entity */ IsCitedAsRelatedBy = "IsCitedAsRelatedBy", /** * The cited entity is cited as being the entity from which the citing entity is derived, or about which the citing entity contains metadata */ IsCitedAsSourceDocumentBy = "IsCitedAsSourceDocumentBy", /** * The cited entity (the subject of the RDF triple) is cited by the citing entity (the object of the triple) */ IsCitedBy = "IsCitedBy", /** * The cited entity is cited as a source of information on the subject under discussion in the citing entity */ IsCitedForInformationBy = "IsCitedForInformationBy", /** * The cited entity is the result of a compile or creation event using the citing entity */ IsCompiledBy = "IsCompiledBy", /** * The cited entity presents facts, ideas or statements that are confirmed by the citing entity */ IsConfirmedBy = "IsConfirmedBy", /** * The cited entity presents statements, ideas or conclusions that are corrected by the citing entity */ IsCorrectedBy = "IsCorrectedBy", /** * The cited entity makes contributions that are acknowledged by the citing entity */ IsCreditedBy = "IsCreditedBy", /** * The cited entity presents statements, ideas or conclusions that are critiqued by the citing entity */ IsCritiquedBy = "IsCritiquedBy", /** * The cited entity contains ideas or conclusions for which the citing entity express derision */ IsDeridedBy = "IsDeridedBy", /** * The cited entity is described by the citing entity */ IsDescribedBy = "IsDescribedBy", /** * The cited entity presents statements, ideas or conclusions that are disagreed with by the citing entity */ IsDisagreedWithBy = "IsDisagreedWithBy", /** * The cited entity presents statements, ideas or conclusions that are discussed by the citing entity */ IsDiscussedBy = "IsDiscussedBy", /** * The cited entity presents statements, ideas or conclusions that are disputed by the citing entity */ IsDisputedBy = "IsDisputedBy", /** * Information about the cited entity is documented by the citing entity */ IsDocumentedBy = "IsDocumentedBy", /** * The cited entity presents facts, ideas or understandings that are extended by the citing entity */ IsExtendedBy = "IsExtendedBy", /** * The cited entity is the target for an HTTP Uniform Resource Locator (URL) link within the citing entity */ IsLinkedToBy = "IsLinkedToBy", /** * The characteristic style or content of the cited entity is imitated by the citing entity for comic effect, usually without explicit citation */ IsParodiedBy = "IsParodiedBy", /** * The cited entity is plagiarized by the author of the citing entity, who includes within the citing entity textual or other elements from the cited entity without formal acknowledgement of their source */ IsPlagiarizedBy = "IsPlagiarizedBy", /** * The cited entity presents statements, ideas or conclusions that are qualified or have conditions placed upon them by the citing entity */ IsQualifiedBy = "IsQualifiedBy", /** * The cited entity presents statements, ideas or conclusions that are refuted by the citing entity */ IsRefutedBy = "IsRefutedBy", /** * The cited entity is formally retracted by the citing entity */ IsRetractedBy = "IsRetractedBy", /** * The cited entity presents statements, ideas or conclusions that are reviewed by the citing entity */ IsReviewedBy = "IsReviewedBy", /** * The cited entity or aspects of its contents are ridiculed by the citing entity */ IsRidiculedBy = "IsRidiculedBy", /** * The cited entity is cited because the citing article contains speculations on its content or ideas */ IsSpeculatedOnBy = "IsSpeculatedOnBy", /** * The cited entity receives intellectual or factual support from the citing entity */ IsSupportedBy = "IsSupportedBy", /** * The cited entity presents statements, ideas, hypotheses or understanding that are updated by the cited entity */ IsUpdatedBy = "IsUpdatedBy", /** * A property that permits you to express appreciation of or interest in something that is the object of the RDF triple, or to express that it is worth thinking about even if you do not agree with its content, enabling social media 'likes' statements to be encoded in RDF */ Likes = "Likes", /** * The citing entity provides a link, in the form of an HTTP Uniform Resource Locator (URL), to the cited entity */ LinksTo = "LinksTo", /** * The citing entity obtains background information from the cited entity */ ObtainsBackgroundFrom = "ObtainsBackgroundFrom", /** * The citing entity obtains intellectual or factual support from the cited entity */ ObtainsSupportFrom = "ObtainsSupportFrom", /** * The citing entity imitates the characteristic style or content of the cited entity for comic effect, usually without explicit citation */ Parodies = "Parodies", /** * A property indicating that the author of the citing entity plagiarizes the cited entity, by including textual or other elements from the cited entity without formal acknowledgement of their source */ Plagiarizes = "Plagiarizes", /** * The cited entity contains and is the original source of a statement of fact or a logical assertion (or a collection of such facts and/or assertions) that is to be found in the citing entity */ ProvidesAssertionFor = "ProvidesAssertionFor", /** * The cited entity presents conclusions that are used in work described in the citing entity */ ProvidesConclusionsFor = "ProvidesConclusionsFor", /** * The cited entity presents data that are used in work described in the citing entity */ ProvidesDataFor = "ProvidesDataFor", /** * The cited entity contains information, usually of a textual nature, that is excerpted by (used as an excerpt within) the citing entity */ ProvidesExcerptFor = "ProvidesExcerptFor", /** * The cited entity details a method that is used in work described by the citing entity */ ProvidesMethodFor = "ProvidesMethodFor", /** * The cited entity contains information, usually of a textual nature, that is quoted by (used as a quotation within) the citing entity */ ProvidesQuotationFor = "ProvidesQuotationFor", /** * The citing entity qualifies or places conditions or restrictions upon statements, ideas or conclusions presented in the cited entity */ Qualifies = "Qualifies", /** * The citing entity refutes statements, ideas or conclusions presented in the cited entity */ Refutes = "Refutes", /** * The citing entity replies to statements, ideas or criticisms presented in the cited entity */ RepliesTo = "RepliesTo", /** * The citing entity constitutes a formal retraction of the cited entity */ Retracts = "Retracts", /** * The citing entity reviews statements, ideas or conclusions presented in the cited entity */ Reviews = "Reviews", /** * The citing entity ridicules the cited entity or aspects of its contents */ Ridicules = "Ridicules", /** * Each entity has at least one author that shares a common institutional affiliation with an author of the other entity */ SharesAuthorInstitutionWith = "SharesAuthorInstitutionWith", /** * Each entity has at least one author in common with the other entity */ SharesAuthorWith = "SharesAuthorWith", /** * The two entities result from activities that have been funded by the same funding agency */ SharesFundingAgencyWith = "SharesFundingAgencyWith", /** * The citing and cited bibliographic resources are published in the same journal */ SharesJournalWith = "SharesJournalWith", /** * The citing and cited bibliographic resources are published in same publication venue */ SharesPublicationVenueWith = "SharesPublicationVenueWith", /** * The citing entity speculates on something within or related to the cited entity, without firm evidence */ SpeculatesOn = "SpeculatesOn", /** * The citing entity provides intellectual or factual support for statements, ideas or conclusions presented in the cited entity */ Supports = "Supports", /** * The citing entity updates statements, ideas, hypotheses or understanding presented in the cited entity */ Updates = "Updates", /** * The citing entity describes work that uses conclusions presented in the cited entity */ UsesConclusionsFrom = "UsesConclusionsFrom", /** * The citing entity describes work that uses data presented in the cited entity */ UsesDataFrom = "UsesDataFrom", /** * The citing entity describes work that uses a method detailed in the cited entity */ UsesMethodIn = "UsesMethodIn" } export declare type TypeMap = { [key in T['type']]: key; }; export declare const codeExecutableTypes: TypeMap>; export declare const codeTypes: TypeMap>; export declare const contactPointTypes: TypeMap>; export declare const creativeWorkTypes: TypeMap>; export declare const entityTypes: TypeMap>; export declare const enumerationTypes: TypeMap>; export declare const grantTypes: TypeMap>; export declare const markTypes: TypeMap>; export declare const mathTypes: TypeMap>; export declare const mediaObjectTypes: TypeMap>; export declare const thingTypes: TypeMap>; export declare const validatorTypes: TypeMap>; export declare const blockContentTypes: TypeMap>; export declare const inlineContentTypes: TypeMap>; export interface Unions { CodeExecutableTypes: CodeExecutableTypes; CodeTypes: CodeTypes; ContactPointTypes: ContactPointTypes; CreativeWorkTypes: CreativeWorkTypes; EntityTypes: EntityTypes; EnumerationTypes: EnumerationTypes; GrantTypes: GrantTypes; MarkTypes: MarkTypes; MathTypes: MathTypes; MediaObjectTypes: MediaObjectTypes; ThingTypes: ThingTypes; ValidatorTypes: ValidatorTypes; BlockContent: BlockContent; InlineContent: InlineContent; } export declare const unions: { CodeExecutableTypes: TypeMap; CodeTypes: TypeMap; ContactPointTypes: TypeMap; CreativeWorkTypes: TypeMap; EntityTypes: TypeMap; EnumerationTypes: TypeMap; GrantTypes: TypeMap; MarkTypes: TypeMap; MathTypes: TypeMap; MediaObjectTypes: TypeMap; ThingTypes: TypeMap; ValidatorTypes: TypeMap; BlockContent: TypeMap; InlineContent: TypeMap; }; export {};