UNPKG

68.7 kBTypeScriptView Raw
1declare type Integer = number;
2export interface Types {
3 Array: Array<Primitive>;
4 ArrayValidator: ArrayValidator;
5 Article: Article;
6 AudioObject: AudioObject;
7 BlockContent: BlockContent;
8 Boolean: boolean;
9 BooleanValidator: BooleanValidator;
10 Brand: Brand;
11 CitationIntentEnumeration: CitationIntentEnumeration;
12 Cite: Cite;
13 CiteGroup: CiteGroup;
14 Claim: Claim;
15 Code: Code;
16 CodeBlock: CodeBlock;
17 CodeChunk: CodeChunk;
18 CodeError: CodeError;
19 CodeExecutable: CodeExecutable;
20 CodeExecutableTypes: CodeExecutableTypes;
21 CodeExpression: CodeExpression;
22 CodeFragment: CodeFragment;
23 CodeTypes: CodeTypes;
24 Collection: Collection;
25 Comment: Comment;
26 ConstantValidator: ConstantValidator;
27 ContactPoint: ContactPoint;
28 ContactPointTypes: ContactPointTypes;
29 CreativeWork: CreativeWork;
30 CreativeWorkTypes: CreativeWorkTypes;
31 Datatable: Datatable;
32 DatatableColumn: DatatableColumn;
33 Date: Date;
34 DefinedTerm: DefinedTerm;
35 Delete: Delete;
36 Emphasis: Emphasis;
37 Entity: Entity;
38 EntityTypes: EntityTypes;
39 EnumValidator: EnumValidator;
40 Enumeration: Enumeration;
41 EnumerationTypes: EnumerationTypes;
42 Figure: Figure;
43 Function: Function;
44 Grant: Grant;
45 GrantTypes: GrantTypes;
46 Heading: Heading;
47 ImageObject: ImageObject;
48 Include: Include;
49 InlineContent: InlineContent;
50 Integer: Integer;
51 IntegerValidator: IntegerValidator;
52 Link: Link;
53 List: List;
54 ListItem: ListItem;
55 Mark: Mark;
56 MarkTypes: MarkTypes;
57 Math: Math;
58 MathBlock: MathBlock;
59 MathFragment: MathFragment;
60 MathTypes: MathTypes;
61 MediaObject: MediaObject;
62 MediaObjectTypes: MediaObjectTypes;
63 MonetaryGrant: MonetaryGrant;
64 Node: Node;
65 NontextualAnnotation: NontextualAnnotation;
66 Note: Note;
67 Null: null;
68 Number: number;
69 NumberValidator: NumberValidator;
70 Object: {
71 [property: string]: Primitive;
72 };
73 Organization: Organization;
74 Paragraph: Paragraph;
75 Parameter: Parameter;
76 Periodical: Periodical;
77 Person: Person;
78 PostalAddress: PostalAddress;
79 Primitive: Primitive;
80 Product: Product;
81 PropertyValue: PropertyValue;
82 PublicationIssue: PublicationIssue;
83 PublicationVolume: PublicationVolume;
84 Quote: Quote;
85 QuoteBlock: QuoteBlock;
86 Review: Review;
87 SoftwareApplication: SoftwareApplication;
88 SoftwareEnvironment: SoftwareEnvironment;
89 SoftwareSession: SoftwareSession;
90 SoftwareSourceCode: SoftwareSourceCode;
91 String: string;
92 StringValidator: StringValidator;
93 Strong: Strong;
94 Subscript: Subscript;
95 Superscript: Superscript;
96 Table: Table;
97 TableCell: TableCell;
98 TableRow: TableRow;
99 ThematicBreak: ThematicBreak;
100 Thing: Thing;
101 ThingTypes: ThingTypes;
102 TupleValidator: TupleValidator;
103 Validator: Validator;
104 ValidatorTypes: ValidatorTypes;
105 Variable: Variable;
106 VideoObject: VideoObject;
107 VolumeMount: VolumeMount;
108}
109/**
110 * The most simple compound (ie. non-atomic like `number`, `string` etc) type.
111 */
112export declare type Entity = {
113 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';
114 id?: string;
115 meta?: {
116 [property: string]: Primitive;
117 };
118};
119/**
120 * Create a `Entity` node
121 * @param props Object containing Entity schema properties as key/value pairs
122 * @returns {Entity} Entity schema node
123 */
124export declare const entity: (props?: Omit<Entity, 'type'>) => Entity;
125/**
126 * A reference to a CreativeWork that is cited in another CreativeWork.
127 */
128export declare type Cite = Entity & {
129 type: 'Cite';
130 target: string;
131 citationIntent?: Array<CitationIntentEnumeration>;
132 citationMode?: 'Parenthetical' | 'Narrative' | 'NarrativeAuthor' | 'NarrativeYear' | 'normal' | 'suppressAuthor';
133 citationPrefix?: string;
134 citationSuffix?: string;
135 content?: Array<InlineContent>;
136 pageEnd?: Integer | string;
137 pageStart?: Integer | string;
138 pagination?: string;
139};
140/**
141 * Create a `Cite` node
142 * @param props Object containing Cite schema properties as key/value pairs
143 * @returns {Cite} Cite schema node
144 */
145export declare const cite: (props: Omit<Cite, 'type'>) => Cite;
146/**
147 * A group of Cite nodes.
148 */
149export declare type CiteGroup = Entity & {
150 type: 'CiteGroup';
151 items: Array<Cite>;
152};
153/**
154 * Create a `CiteGroup` node
155 * @param props Object containing CiteGroup schema properties as key/value pairs
156 * @returns {CiteGroup} CiteGroup schema node
157 */
158export declare const citeGroup: (props: Omit<CiteGroup, 'type'>) => CiteGroup;
159/**
160 * Base type for non-executable (e.g. `CodeBlock`) and executable (e.g. `CodeExpression`) code nodes.
161 */
162export declare type Code = Entity & {
163 type: 'Code' | 'CodeBlock' | 'CodeChunk' | 'CodeExecutable' | 'CodeExpression' | 'CodeFragment';
164 text: string;
165 mediaType?: string;
166 programmingLanguage?: string;
167};
168/**
169 * Create a `Code` node
170 * @param props Object containing Code schema properties as key/value pairs
171 * @returns {Code} Code schema node
172 */
173export declare const code: (props: Omit<Code, 'type'>) => Code;
174/**
175 * A code block.
176 */
177export declare type CodeBlock = Code & {
178 type: 'CodeBlock';
179};
180/**
181 * Create a `CodeBlock` node
182 * @param props Object containing CodeBlock schema properties as key/value pairs
183 * @returns {CodeBlock} CodeBlock schema node
184 */
185export declare const codeBlock: (props: Omit<CodeBlock, 'type'>) => CodeBlock;
186/**
187 * Base type for executable code nodes (i.e. `CodeChunk` and `CodeExpression`).
188 */
189export declare type CodeExecutable = Code & {
190 type: 'CodeExecutable' | 'CodeChunk' | 'CodeExpression';
191 programmingLanguage: string;
192 codeDependencies?: Array<CodeChunk | Parameter>;
193 codeDependents?: Array<CodeChunk | CodeExpression>;
194 compileDigest?: string;
195 errors?: Array<CodeError>;
196 executeCount?: Integer;
197 executeDigest?: string;
198 executeDuration?: number;
199 executeEnded?: Date;
200 executeRequired?: 'No' | 'NeverExecuted' | 'SemanticsChanged' | 'DependenciesChanged' | 'DependenciesFailed';
201 executeStatus?: 'Scheduled' | 'ScheduledPreviouslyFailed' | 'Running' | 'RunningPreviouslyFailed' | 'Succeeded' | 'Failed' | 'Cancelled';
202};
203/**
204 * Create a `CodeExecutable` node
205 * @param props Object containing CodeExecutable schema properties as key/value pairs
206 * @returns {CodeExecutable} CodeExecutable schema node
207 */
208export declare const codeExecutable: (props: Omit<CodeExecutable, 'type'>) => CodeExecutable;
209/**
210 * A executable chunk of code.
211 */
212export declare type CodeChunk = CodeExecutable & {
213 type: 'CodeChunk';
214 programmingLanguage: string;
215 caption?: Array<BlockContent> | string;
216 executeAuto?: 'Never' | 'Needed' | 'Always';
217 executePure?: boolean;
218 label?: string;
219 outputs?: Array<Node>;
220};
221/**
222 * Create a `CodeChunk` node
223 * @param props Object containing CodeChunk schema properties as key/value pairs
224 * @returns {CodeChunk} CodeChunk schema node
225 */
226export declare const codeChunk: (props: Omit<CodeChunk, 'type'>) => CodeChunk;
227/**
228 * An executable programming code expression.
229 */
230export declare type CodeExpression = CodeExecutable & {
231 type: 'CodeExpression';
232 programmingLanguage: string;
233 output?: Node;
234};
235/**
236 * Create a `CodeExpression` node
237 * @param props Object containing CodeExpression schema properties as key/value pairs
238 * @returns {CodeExpression} CodeExpression schema node
239 */
240export declare const codeExpression: (props: Omit<CodeExpression, 'type'>) => CodeExpression;
241/**
242 * Inline code.
243 */
244export declare type CodeFragment = Code & {
245 type: 'CodeFragment';
246};
247/**
248 * Create a `CodeFragment` node
249 * @param props Object containing CodeFragment schema properties as key/value pairs
250 * @returns {CodeFragment} CodeFragment schema node
251 */
252export declare const codeFragment: (props: Omit<CodeFragment, 'type'>) => CodeFragment;
253/**
254 * An error that occurred when parsing, compiling or executing a Code node.
255 */
256export declare type CodeError = Entity & {
257 type: 'CodeError';
258 errorMessage: string;
259 errorType?: string;
260 stackTrace?: string;
261};
262/**
263 * Create a `CodeError` node
264 * @param props Object containing CodeError schema properties as key/value pairs
265 * @returns {CodeError} CodeError schema node
266 */
267export declare const codeError: (props: Omit<CodeError, 'type'>) => CodeError;
268/**
269 * A date encoded as a ISO 8601 string.
270 */
271export declare type Date = Entity & {
272 type: 'Date';
273 value: string;
274};
275/**
276 * Create a `Date` node
277 * @param props Object containing Date schema properties as key/value pairs
278 * @returns {Date} Date schema node
279 */
280export declare const date: (props: Omit<Date, 'type'>) => Date;
281/**
282 * A base class for nodes that mark some other inline content
283 * in some way (e.g. as being emphasised, or quoted).
284 */
285export declare type Mark = Entity & {
286 type: 'Mark' | 'Delete' | 'Emphasis' | 'NontextualAnnotation' | 'Quote' | 'Strong' | 'Subscript' | 'Superscript';
287 content: Array<InlineContent>;
288};
289/**
290 * Create a `Mark` node
291 * @param props Object containing Mark schema properties as key/value pairs
292 * @returns {Mark} Mark schema node
293 */
294export declare const mark: (props: Omit<Mark, 'type'>) => Mark;
295/**
296 * Content that is marked for deletion
297 */
298export declare type Delete = Mark & {
299 type: 'Delete';
300};
301/**
302 * Create a `Delete` node
303 * @param props Object containing Delete schema properties as key/value pairs
304 * @returns {Delete} Delete schema node
305 */
306export declare const del: (props: Omit<Delete, 'type'>) => Delete;
307/**
308 * Emphasised content.
309 */
310export declare type Emphasis = Mark & {
311 type: 'Emphasis';
312};
313/**
314 * Create a `Emphasis` node
315 * @param props Object containing Emphasis schema properties as key/value pairs
316 * @returns {Emphasis} Emphasis schema node
317 */
318export declare const emphasis: (props: Omit<Emphasis, 'type'>) => Emphasis;
319/**
320 * The most generic type of item.
321 */
322export declare type Thing = Entity & {
323 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';
324 alternateNames?: Array<string>;
325 description?: Array<BlockContent> | Array<InlineContent> | string;
326 identifiers?: Array<PropertyValue | string>;
327 images?: Array<ImageObject | string>;
328 name?: string;
329 url?: string;
330};
331/**
332 * Create a `Thing` node
333 * @param props Object containing Thing schema properties as key/value pairs
334 * @returns {Thing} Thing schema node
335 */
336export declare const thing: (props?: Omit<Thing, 'type'>) => Thing;
337/**
338 * A brand used by an organization or person for labeling a product,
339 * product group, or similar.
340 */
341export declare type Brand = Thing & {
342 type: 'Brand';
343 name: string;
344 logo?: ImageObject | string;
345 reviews?: Array<string>;
346};
347/**
348 * Create a `Brand` node
349 * @param props Object containing Brand schema properties as key/value pairs
350 * @returns {Brand} Brand schema node
351 */
352export declare const brand: (props: Omit<Brand, 'type'>) => Brand;
353/**
354 * A contact point, usually within an organization.
355 */
356export declare type ContactPoint = Thing & {
357 type: 'ContactPoint' | 'PostalAddress';
358 availableLanguages?: Array<string>;
359 emails?: Array<string>;
360 telephoneNumbers?: Array<string>;
361};
362/**
363 * Create a `ContactPoint` node
364 * @param props Object containing ContactPoint schema properties as key/value pairs
365 * @returns {ContactPoint} ContactPoint schema node
366 */
367export declare const contactPoint: (props?: Omit<ContactPoint, 'type'>) => ContactPoint;
368/**
369 * A creative work, including books, movies, photographs, software programs, etc.
370 */
371export declare type CreativeWork = Thing & {
372 type: 'CreativeWork' | 'Article' | 'AudioObject' | 'Claim' | 'Collection' | 'Comment' | 'Datatable' | 'Figure' | 'ImageObject' | 'MediaObject' | 'Periodical' | 'PublicationIssue' | 'PublicationVolume' | 'Review' | 'SoftwareApplication' | 'SoftwareSourceCode' | 'Table' | 'VideoObject';
373 about?: Array<ThingTypes>;
374 authors?: Array<Person | Organization>;
375 comments?: Array<Comment>;
376 content?: Array<Node> | string;
377 dateAccepted?: Date;
378 dateCreated?: Date;
379 dateModified?: Date;
380 datePublished?: Date;
381 dateReceived?: Date;
382 editors?: Array<Person>;
383 fundedBy?: Array<Grant | MonetaryGrant>;
384 funders?: Array<Person | Organization>;
385 genre?: Array<string>;
386 isPartOf?: CreativeWorkTypes;
387 keywords?: Array<string>;
388 licenses?: Array<CreativeWorkTypes | string>;
389 maintainers?: Array<Person | Organization>;
390 parts?: Array<CreativeWorkTypes>;
391 publisher?: Person | Organization;
392 references?: Array<CreativeWorkTypes | string>;
393 text?: string;
394 title?: Array<InlineContent> | string;
395 version?: string | number;
396};
397/**
398 * Create a `CreativeWork` node
399 * @param props Object containing CreativeWork schema properties as key/value pairs
400 * @returns {CreativeWork} CreativeWork schema node
401 */
402export declare const creativeWork: (props?: Omit<CreativeWork, 'type'>) => CreativeWork;
403/**
404 * An article, including news and scholarly articles.
405 */
406export declare type Article = CreativeWork & {
407 type: 'Article';
408 content?: Array<BlockContent>;
409 pageEnd?: Integer | string;
410 pageStart?: Integer | string;
411 pagination?: string;
412};
413/**
414 * Create a `Article` node
415 * @param props Object containing Article schema properties as key/value pairs
416 * @returns {Article} Article schema node
417 */
418export declare const article: (props?: Omit<Article, 'type'>) => Article;
419/**
420 * A claim represents specific reviewable facts or statements.
421 */
422export declare type Claim = CreativeWork & {
423 type: 'Claim';
424 content: Array<BlockContent>;
425 claimType?: 'Statement' | 'Theorem' | 'Lemma' | 'Proof' | 'Postulate' | 'Hypothesis' | 'Proposition' | 'Corollary';
426 label?: string;
427};
428/**
429 * Create a `Claim` node
430 * @param props Object containing Claim schema properties as key/value pairs
431 * @returns {Claim} Claim schema node
432 */
433export declare const claim: (props: Omit<Claim, 'type'>) => Claim;
434/**
435 * A collection of CreativeWorks or other artifacts.
436 */
437export declare type Collection = CreativeWork & {
438 type: 'Collection';
439 parts: Array<CreativeWorkTypes>;
440};
441/**
442 * Create a `Collection` node
443 * @param props Object containing Collection schema properties as key/value pairs
444 * @returns {Collection} Collection schema node
445 */
446export declare const collection: (props: Omit<Collection, 'type'>) => Collection;
447/**
448 * A comment on an item, e.g on a Article, or SoftwareSourceCode.
449 */
450export declare type Comment = CreativeWork & {
451 type: 'Comment';
452 commentAspect?: string;
453 parentItem?: Comment;
454};
455/**
456 * Create a `Comment` node
457 * @param props Object containing Comment schema properties as key/value pairs
458 * @returns {Comment} Comment schema node
459 */
460export declare const comment: (props?: Omit<Comment, 'type'>) => Comment;
461/**
462 * A table of data.
463 */
464export declare type Datatable = CreativeWork & {
465 type: 'Datatable';
466 columns: Array<DatatableColumn>;
467};
468/**
469 * Create a `Datatable` node
470 * @param props Object containing Datatable schema properties as key/value pairs
471 * @returns {Datatable} Datatable schema node
472 */
473export declare const datatable: (props: Omit<Datatable, 'type'>) => Datatable;
474/**
475 * A media object, such as an image, video, or audio object embedded in a web page or a
476 * downloadable dataset.
477 */
478export declare type MediaObject = CreativeWork & {
479 type: 'MediaObject' | 'AudioObject' | 'ImageObject' | 'VideoObject';
480 contentUrl: string;
481 bitrate?: number;
482 contentSize?: number;
483 embedUrl?: string;
484 mediaType?: string;
485};
486/**
487 * Create a `MediaObject` node
488 * @param props Object containing MediaObject schema properties as key/value pairs
489 * @returns {MediaObject} MediaObject schema node
490 */
491export declare const mediaObject: (props: Omit<MediaObject, 'type'>) => MediaObject;
492/**
493 * An audio file
494 */
495export declare type AudioObject = MediaObject & {
496 type: 'AudioObject';
497 caption?: string;
498 transcript?: string;
499};
500/**
501 * Create a `AudioObject` node
502 * @param props Object containing AudioObject schema properties as key/value pairs
503 * @returns {AudioObject} AudioObject schema node
504 */
505export declare const audioObject: (props: Omit<AudioObject, 'type'>) => AudioObject;
506/**
507 * A column of data within a Datatable.
508 */
509export declare type DatatableColumn = Thing & {
510 type: 'DatatableColumn';
511 name: string;
512 values: Array<Node>;
513 validator?: ArrayValidator;
514};
515/**
516 * Create a `DatatableColumn` node
517 * @param props Object containing DatatableColumn schema properties as key/value pairs
518 * @returns {DatatableColumn} DatatableColumn schema node
519 */
520export declare const datatableColumn: (props: Omit<DatatableColumn, 'type'>) => DatatableColumn;
521/**
522 * A word, name, acronym, phrase, etc. with a formal definition.
523 */
524export declare type DefinedTerm = Thing & {
525 type: 'DefinedTerm';
526 name: string;
527 termCode?: string;
528};
529/**
530 * Create a `DefinedTerm` node
531 * @param props Object containing DefinedTerm schema properties as key/value pairs
532 * @returns {DefinedTerm} DefinedTerm schema node
533 */
534export declare const definedTerm: (props: Omit<DefinedTerm, 'type'>) => DefinedTerm;
535/**
536 * A base for all validator types.
537 */
538export declare type Validator = Entity & {
539 type: 'Validator' | 'ArrayValidator' | 'BooleanValidator' | 'ConstantValidator' | 'EnumValidator' | 'IntegerValidator' | 'NumberValidator' | 'StringValidator' | 'TupleValidator';
540};
541/**
542 * Create a `Validator` node
543 * @param props Object containing Validator schema properties as key/value pairs
544 * @returns {Validator} Validator schema node
545 */
546export declare const validator: (props?: Omit<Validator, 'type'>) => Validator;
547/**
548 * A validator specifying constraints on an array node.
549 */
550export declare type ArrayValidator = Validator & {
551 type: 'ArrayValidator';
552 contains?: ValidatorTypes;
553 itemsValidator?: ValidatorTypes;
554 maxItems?: Integer;
555 minItems?: Integer;
556 uniqueItems?: boolean;
557};
558/**
559 * Create a `ArrayValidator` node
560 * @param props Object containing ArrayValidator schema properties as key/value pairs
561 * @returns {ArrayValidator} ArrayValidator schema node
562 */
563export declare const arrayValidator: (props?: Omit<ArrayValidator, 'type'>) => ArrayValidator;
564/**
565 * A schema specifying that a node must be a boolean value.
566 */
567export declare type BooleanValidator = Validator & {
568 type: 'BooleanValidator';
569};
570/**
571 * Create a `BooleanValidator` node
572 * @param props Object containing BooleanValidator schema properties as key/value pairs
573 * @returns {BooleanValidator} BooleanValidator schema node
574 */
575export declare const booleanValidator: (props?: Omit<BooleanValidator, 'type'>) => BooleanValidator;
576/**
577 * A validator specifying a constant value that a node must have.
578 */
579export declare type ConstantValidator = Validator & {
580 type: 'ConstantValidator';
581 value?: Node;
582};
583/**
584 * Create a `ConstantValidator` node
585 * @param props Object containing ConstantValidator schema properties as key/value pairs
586 * @returns {ConstantValidator} ConstantValidator schema node
587 */
588export declare const constantValidator: (props?: Omit<ConstantValidator, 'type'>) => ConstantValidator;
589/**
590 * A schema specifying that a node must be one of several values.
591 */
592export declare type EnumValidator = Validator & {
593 type: 'EnumValidator';
594 values?: Array<Node>;
595};
596/**
597 * Create a `EnumValidator` node
598 * @param props Object containing EnumValidator schema properties as key/value pairs
599 * @returns {EnumValidator} EnumValidator schema node
600 */
601export declare const enumValidator: (props?: Omit<EnumValidator, 'type'>) => EnumValidator;
602/**
603 * Lists or enumerations, for example, a list of cuisines or music genres, etc.
604 */
605export declare type Enumeration = Thing & {
606 type: 'Enumeration' | 'CitationIntentEnumeration';
607};
608/**
609 * Create a `Enumeration` node
610 * @param props Object containing Enumeration schema properties as key/value pairs
611 * @returns {Enumeration} Enumeration schema node
612 */
613export declare const enumeration: (props?: Omit<Enumeration, 'type'>) => Enumeration;
614/**
615 * Encapsulates one or more images, videos, tables, etc, and provides captions and labels for them.
616 */
617export declare type Figure = CreativeWork & {
618 type: 'Figure';
619 caption?: Array<BlockContent> | string;
620 label?: string;
621};
622/**
623 * Create a `Figure` node
624 * @param props Object containing Figure schema properties as key/value pairs
625 * @returns {Figure} Figure schema node
626 */
627export declare const figure: (props?: Omit<Figure, 'type'>) => Figure;
628/**
629 * A function with a name, which might take Parameters and return a value of a certain type.
630 */
631export declare type Function = Entity & {
632 type: 'Function';
633 name?: string;
634 parameters?: Array<Parameter>;
635 returns?: ValidatorTypes;
636};
637/**
638 * Create a `Function` node
639 * @param props Object containing Function schema properties as key/value pairs
640 * @returns {Function} Function schema node
641 */
642export declare const function_: (props?: Omit<Function, 'type'>) => Function;
643/**
644 * A grant, typically financial or otherwise quantifiable, of resources.
645 */
646export declare type Grant = Thing & {
647 type: 'Grant' | 'MonetaryGrant';
648 fundedItems?: Array<Thing>;
649 sponsors?: Array<Person | Organization>;
650};
651/**
652 * Create a `Grant` node
653 * @param props Object containing Grant schema properties as key/value pairs
654 * @returns {Grant} Grant schema node
655 */
656export declare const grant: (props?: Omit<Grant, 'type'>) => Grant;
657/**
658 * A heading.
659 */
660export declare type Heading = Entity & {
661 type: 'Heading';
662 content: Array<InlineContent>;
663 depth?: Integer;
664};
665/**
666 * Create a `Heading` node
667 * @param props Object containing Heading schema properties as key/value pairs
668 * @returns {Heading} Heading schema node
669 */
670export declare const heading: (props: Omit<Heading, 'type'>) => Heading;
671/**
672 * An image file.
673 */
674export declare type ImageObject = MediaObject & {
675 type: 'ImageObject';
676 caption?: string;
677 thumbnail?: ImageObject;
678};
679/**
680 * Create a `ImageObject` node
681 * @param props Object containing ImageObject schema properties as key/value pairs
682 * @returns {ImageObject} ImageObject schema node
683 */
684export declare const imageObject: (props: Omit<ImageObject, 'type'>) => ImageObject;
685/**
686 * Include content from an external source (e.g. file, URL).
687 */
688export declare type Include = Entity & {
689 type: 'Include';
690 source: string;
691 buildDigest?: string;
692 content?: Array<BlockContent>;
693 mediaType?: string;
694};
695/**
696 * Create a `Include` node
697 * @param props Object containing Include schema properties as key/value pairs
698 * @returns {Include} Include schema node
699 */
700export declare const include: (props: Omit<Include, 'type'>) => Include;
701/**
702 * A validator specifying the constraints on an integer node.
703 */
704export declare type IntegerValidator = Validator & {
705 type: 'IntegerValidator';
706};
707/**
708 * Create a `IntegerValidator` node
709 * @param props Object containing IntegerValidator schema properties as key/value pairs
710 * @returns {IntegerValidator} IntegerValidator schema node
711 */
712export declare const integerValidator: (props?: Omit<IntegerValidator, 'type'>) => IntegerValidator;
713/**
714 * A hyperlink to other pages, sections within the same document, resources, or any URL.
715 */
716export declare type Link = Entity & {
717 type: 'Link';
718 content: Array<InlineContent>;
719 target: string;
720 exportFrom?: string;
721 importTo?: string;
722 relation?: string;
723 title?: string;
724};
725/**
726 * Create a `Link` node
727 * @param props Object containing Link schema properties as key/value pairs
728 * @returns {Link} Link schema node
729 */
730export declare const link: (props: Omit<Link, 'type'>) => Link;
731/**
732 * A list of items.
733 */
734export declare type List = Entity & {
735 type: 'List';
736 items: Array<ListItem>;
737 order?: 'Ascending' | 'Descending' | 'Unordered';
738};
739/**
740 * Create a `List` node
741 * @param props Object containing List schema properties as key/value pairs
742 * @returns {List} List schema node
743 */
744export declare const list: (props: Omit<List, 'type'>) => List;
745/**
746 * A single item in a list.
747 */
748export declare type ListItem = Thing & {
749 type: 'ListItem';
750 content?: Array<BlockContent> | Array<InlineContent>;
751 isChecked?: boolean;
752 item?: Node;
753 position?: Integer;
754};
755/**
756 * Create a `ListItem` node
757 * @param props Object containing ListItem schema properties as key/value pairs
758 * @returns {ListItem} ListItem schema node
759 */
760export declare const listItem: (props?: Omit<ListItem, 'type'>) => ListItem;
761/**
762 * A mathematical variable or equation.
763 */
764export declare type Math = Entity & {
765 type: 'Math' | 'MathBlock' | 'MathFragment';
766 text: string;
767 errors?: Array<string>;
768 mathLanguage?: string;
769};
770/**
771 * Create a `Math` node
772 * @param props Object containing Math schema properties as key/value pairs
773 * @returns {Math} Math schema node
774 */
775export declare const math: (props: Omit<Math, 'type'>) => Math;
776/**
777 * A block of math, e.g an equation, to be treated as block content.
778 */
779export declare type MathBlock = Math & {
780 type: 'MathBlock';
781 label?: string;
782};
783/**
784 * Create a `MathBlock` node
785 * @param props Object containing MathBlock schema properties as key/value pairs
786 * @returns {MathBlock} MathBlock schema node
787 */
788export declare const mathBlock: (props: Omit<MathBlock, 'type'>) => MathBlock;
789/**
790 * A fragment of math, e.g a variable name, to be treated as inline content.
791 */
792export declare type MathFragment = Math & {
793 type: 'MathFragment';
794};
795/**
796 * Create a `MathFragment` node
797 * @param props Object containing MathFragment schema properties as key/value pairs
798 * @returns {MathFragment} MathFragment schema node
799 */
800export declare const mathFragment: (props: Omit<MathFragment, 'type'>) => MathFragment;
801/**
802 * A monetary grant.
803 */
804export declare type MonetaryGrant = Grant & {
805 type: 'MonetaryGrant';
806 amounts?: number;
807 funders?: Array<Person | Organization>;
808};
809/**
810 * Create a `MonetaryGrant` node
811 * @param props Object containing MonetaryGrant schema properties as key/value pairs
812 * @returns {MonetaryGrant} MonetaryGrant schema node
813 */
814export declare const monetaryGrant: (props?: Omit<MonetaryGrant, 'type'>) => MonetaryGrant;
815/**
816 * Inline text that has a non-textual annotation.
817 */
818export declare type NontextualAnnotation = Mark & {
819 type: 'NontextualAnnotation';
820};
821/**
822 * Create a `NontextualAnnotation` node
823 * @param props Object containing NontextualAnnotation schema properties as key/value pairs
824 * @returns {NontextualAnnotation} NontextualAnnotation schema node
825 */
826export declare const nontextualAnnotation: (props: Omit<NontextualAnnotation, 'type'>) => NontextualAnnotation;
827/**
828 * Additional content which is not part of the main content of a document.
829 */
830export declare type Note = Entity & {
831 type: 'Note';
832 content: Array<BlockContent>;
833 noteType?: 'Footnote' | 'Endnote' | 'Sidenote';
834};
835/**
836 * Create a `Note` node
837 * @param props Object containing Note schema properties as key/value pairs
838 * @returns {Note} Note schema node
839 */
840export declare const note: (props: Omit<Note, 'type'>) => Note;
841/**
842 * A validator specifying the constraints on a numeric node.
843 */
844export declare type NumberValidator = Validator & {
845 type: 'NumberValidator';
846 exclusiveMaximum?: number;
847 exclusiveMinimum?: number;
848 maximum?: number;
849 minimum?: number;
850 multipleOf?: number;
851};
852/**
853 * Create a `NumberValidator` node
854 * @param props Object containing NumberValidator schema properties as key/value pairs
855 * @returns {NumberValidator} NumberValidator schema node
856 */
857export declare const numberValidator: (props?: Omit<NumberValidator, 'type'>) => NumberValidator;
858/**
859 * An organization such as a school, NGO, corporation, club, etc.
860 */
861export declare type Organization = Thing & {
862 type: 'Organization';
863 address?: PostalAddress | string;
864 brands?: Array<Brand>;
865 contactPoints?: Array<ContactPoint>;
866 departments?: Array<Organization>;
867 funders?: Array<Organization | Person>;
868 legalName?: string;
869 logo?: ImageObject | string;
870 members?: Array<Organization | Person>;
871 parentOrganization?: Organization;
872};
873/**
874 * Create a `Organization` node
875 * @param props Object containing Organization schema properties as key/value pairs
876 * @returns {Organization} Organization schema node
877 */
878export declare const organization: (props?: Omit<Organization, 'type'>) => Organization;
879/**
880 * Paragraph
881 */
882export declare type Paragraph = Entity & {
883 type: 'Paragraph';
884 content: Array<InlineContent>;
885};
886/**
887 * Create a `Paragraph` node
888 * @param props Object containing Paragraph schema properties as key/value pairs
889 * @returns {Paragraph} Paragraph schema node
890 */
891export declare const paragraph: (props: Omit<Paragraph, 'type'>) => Paragraph;
892/**
893 * A parameter of a document or function.
894 */
895export declare type Parameter = Entity & {
896 type: 'Parameter';
897 name: string;
898 default?: Node;
899 executeDigest?: string;
900 isExtensible?: boolean;
901 isRequired?: boolean;
902 isVariadic?: boolean;
903 validator?: ValidatorTypes;
904 value?: Node;
905};
906/**
907 * Create a `Parameter` node
908 * @param props Object containing Parameter schema properties as key/value pairs
909 * @returns {Parameter} Parameter schema node
910 */
911export declare const parameter: (props: Omit<Parameter, 'type'>) => Parameter;
912/**
913 * A periodical publication.
914 */
915export declare type Periodical = CreativeWork & {
916 type: 'Periodical';
917 dateEnd?: Date;
918 dateStart?: Date;
919 issns?: Array<string>;
920};
921/**
922 * Create a `Periodical` node
923 * @param props Object containing Periodical schema properties as key/value pairs
924 * @returns {Periodical} Periodical schema node
925 */
926export declare const periodical: (props?: Omit<Periodical, 'type'>) => Periodical;
927/**
928 * A person (alive, dead, undead, or fictional).
929 */
930export declare type Person = Thing & {
931 type: 'Person';
932 address?: PostalAddress | string;
933 affiliations?: Array<Organization>;
934 emails?: Array<string>;
935 familyNames?: Array<string>;
936 funders?: Array<Organization | Person>;
937 givenNames?: Array<string>;
938 honorificPrefix?: string;
939 honorificSuffix?: string;
940 jobTitle?: string;
941 memberOf?: Array<Organization>;
942 telephoneNumbers?: Array<string>;
943};
944/**
945 * Create a `Person` node
946 * @param props Object containing Person schema properties as key/value pairs
947 * @returns {Person} Person schema node
948 */
949export declare const person: (props?: Omit<Person, 'type'>) => Person;
950/**
951 * A physical mailing address.
952 */
953export declare type PostalAddress = ContactPoint & {
954 type: 'PostalAddress';
955 addressCountry?: string;
956 addressLocality?: string;
957 addressRegion?: string;
958 postOfficeBoxNumber?: string;
959 postalCode?: string;
960 streetAddress?: string;
961};
962/**
963 * Create a `PostalAddress` node
964 * @param props Object containing PostalAddress schema properties as key/value pairs
965 * @returns {PostalAddress} PostalAddress schema node
966 */
967export declare const postalAddress: (props?: Omit<PostalAddress, 'type'>) => PostalAddress;
968/**
969 * Any offered product or service. For example, a pair of shoes;
970 * a haircut; or an episode of a TV show streamed online.
971 */
972export declare type Product = Thing & {
973 type: 'Product';
974 brands?: Array<Brand>;
975 logo?: ImageObject | string;
976 productID?: string;
977};
978/**
979 * Create a `Product` node
980 * @param props Object containing Product schema properties as key/value pairs
981 * @returns {Product} Product schema node
982 */
983export declare const product: (props?: Omit<Product, 'type'>) => Product;
984/**
985 * A property-value pair.
986 */
987export declare type PropertyValue = Thing & {
988 type: 'PropertyValue';
989 value: boolean | Integer | number | string;
990 propertyID?: string;
991};
992/**
993 * Create a `PropertyValue` node
994 * @param props Object containing PropertyValue schema properties as key/value pairs
995 * @returns {PropertyValue} PropertyValue schema node
996 */
997export declare const propertyValue: (props: Omit<PropertyValue, 'type'>) => PropertyValue;
998/**
999 * A part of a successively published publication such as a periodical or publication
1000 * volume, often numbered.
1001 */
1002export declare type PublicationIssue = CreativeWork & {
1003 type: 'PublicationIssue';
1004 issueNumber?: Integer | string;
1005 pageEnd?: Integer | string;
1006 pageStart?: Integer | string;
1007 pagination?: string;
1008};
1009/**
1010 * Create a `PublicationIssue` node
1011 * @param props Object containing PublicationIssue schema properties as key/value pairs
1012 * @returns {PublicationIssue} PublicationIssue schema node
1013 */
1014export declare const publicationIssue: (props?: Omit<PublicationIssue, 'type'>) => PublicationIssue;
1015/**
1016 * A part of a successively published publication such as a periodical or multi-volume work.
1017 */
1018export declare type PublicationVolume = CreativeWork & {
1019 type: 'PublicationVolume';
1020 pageEnd?: Integer | string;
1021 pageStart?: Integer | string;
1022 pagination?: string;
1023 volumeNumber?: Integer | string;
1024};
1025/**
1026 * Create a `PublicationVolume` node
1027 * @param props Object containing PublicationVolume schema properties as key/value pairs
1028 * @returns {PublicationVolume} PublicationVolume schema node
1029 */
1030export declare const publicationVolume: (props?: Omit<PublicationVolume, 'type'>) => PublicationVolume;
1031/**
1032 * Inline, quoted content.
1033 */
1034export declare type Quote = Mark & {
1035 type: 'Quote';
1036 cite?: Cite | string;
1037};
1038/**
1039 * Create a `Quote` node
1040 * @param props Object containing Quote schema properties as key/value pairs
1041 * @returns {Quote} Quote schema node
1042 */
1043export declare const quote: (props: Omit<Quote, 'type'>) => Quote;
1044/**
1045 * A section quoted from somewhere else.
1046 */
1047export declare type QuoteBlock = Entity & {
1048 type: 'QuoteBlock';
1049 content: Array<BlockContent>;
1050 cite?: Cite | string;
1051};
1052/**
1053 * Create a `QuoteBlock` node
1054 * @param props Object containing QuoteBlock schema properties as key/value pairs
1055 * @returns {QuoteBlock} QuoteBlock schema node
1056 */
1057export declare const quoteBlock: (props: Omit<QuoteBlock, 'type'>) => QuoteBlock;
1058/**
1059 * A review of an item, e.g of an Article, or SoftwareSourceCode.
1060 */
1061export declare type Review = CreativeWork & {
1062 type: 'Review';
1063 itemReviewed?: Thing;
1064 reviewAspect?: string;
1065};
1066/**
1067 * Create a `Review` node
1068 * @param props Object containing Review schema properties as key/value pairs
1069 * @returns {Review} Review schema node
1070 */
1071export declare const review: (props?: Omit<Review, 'type'>) => Review;
1072/**
1073 * A software application.
1074 */
1075export declare type SoftwareApplication = CreativeWork & {
1076 type: 'SoftwareApplication';
1077 softwareRequirements?: Array<SoftwareApplication>;
1078 softwareVersion?: string;
1079};
1080/**
1081 * Create a `SoftwareApplication` node
1082 * @param props Object containing SoftwareApplication schema properties as key/value pairs
1083 * @returns {SoftwareApplication} SoftwareApplication schema node
1084 */
1085export declare const softwareApplication: (props?: Omit<SoftwareApplication, 'type'>) => SoftwareApplication;
1086/**
1087 * A computational environment.
1088 */
1089export declare type SoftwareEnvironment = Thing & {
1090 type: 'SoftwareEnvironment';
1091 name: string;
1092 adds?: Array<SoftwareSourceCode>;
1093 extends?: Array<SoftwareEnvironment>;
1094 removes?: Array<SoftwareSourceCode>;
1095};
1096/**
1097 * Create a `SoftwareEnvironment` node
1098 * @param props Object containing SoftwareEnvironment schema properties as key/value pairs
1099 * @returns {SoftwareEnvironment} SoftwareEnvironment schema node
1100 */
1101export declare const softwareEnvironment: (props: Omit<SoftwareEnvironment, 'type'>) => SoftwareEnvironment;
1102/**
1103 * Definition of a compute session, including its software and compute resource
1104 * requirements and status.
1105 */
1106export declare type SoftwareSession = Thing & {
1107 type: 'SoftwareSession';
1108 clientsLimit?: number;
1109 clientsRequest?: number;
1110 cpuLimit?: number;
1111 cpuRequest?: number;
1112 dateEnd?: Date;
1113 dateStart?: Date;
1114 durationLimit?: number;
1115 durationRequest?: number;
1116 environment?: SoftwareEnvironment;
1117 memoryLimit?: number;
1118 memoryRequest?: number;
1119 networkTransferLimit?: number;
1120 networkTransferRequest?: number;
1121 status?: 'Unknown' | 'Starting' | 'Started' | 'Stopping' | 'Stopped' | 'Failed';
1122 timeoutLimit?: number;
1123 timeoutRequest?: number;
1124 volumeMounts?: Array<VolumeMount>;
1125};
1126/**
1127 * Create a `SoftwareSession` node
1128 * @param props Object containing SoftwareSession schema properties as key/value pairs
1129 * @returns {SoftwareSession} SoftwareSession schema node
1130 */
1131export declare const softwareSession: (props?: Omit<SoftwareSession, 'type'>) => SoftwareSession;
1132/**
1133 * Computer programming source code. Example: Full (compile ready) solutions, code snippet samples, scripts, templates.
1134 */
1135export declare type SoftwareSourceCode = CreativeWork & {
1136 type: 'SoftwareSourceCode';
1137 codeRepository?: string;
1138 codeSampleType?: string;
1139 programmingLanguage?: string;
1140 runtimePlatform?: Array<string>;
1141 softwareRequirements?: Array<SoftwareSourceCode | SoftwareApplication | string>;
1142 targetProducts?: Array<SoftwareApplication>;
1143};
1144/**
1145 * Create a `SoftwareSourceCode` node
1146 * @param props Object containing SoftwareSourceCode schema properties as key/value pairs
1147 * @returns {SoftwareSourceCode} SoftwareSourceCode schema node
1148 */
1149export declare const softwareSourceCode: (props?: Omit<SoftwareSourceCode, 'type'>) => SoftwareSourceCode;
1150/**
1151 * A schema specifying constraints on a string node.
1152 */
1153export declare type StringValidator = Validator & {
1154 type: 'StringValidator';
1155 maxLength?: Integer;
1156 minLength?: Integer;
1157 pattern?: string;
1158};
1159/**
1160 * Create a `StringValidator` node
1161 * @param props Object containing StringValidator schema properties as key/value pairs
1162 * @returns {StringValidator} StringValidator schema node
1163 */
1164export declare const stringValidator: (props?: Omit<StringValidator, 'type'>) => StringValidator;
1165/**
1166 * Strongly emphasised content.
1167 */
1168export declare type Strong = Mark & {
1169 type: 'Strong';
1170};
1171/**
1172 * Create a `Strong` node
1173 * @param props Object containing Strong schema properties as key/value pairs
1174 * @returns {Strong} Strong schema node
1175 */
1176export declare const strong: (props: Omit<Strong, 'type'>) => Strong;
1177/**
1178 * Subscripted content.
1179 */
1180export declare type Subscript = Mark & {
1181 type: 'Subscript';
1182};
1183/**
1184 * Create a `Subscript` node
1185 * @param props Object containing Subscript schema properties as key/value pairs
1186 * @returns {Subscript} Subscript schema node
1187 */
1188export declare const subscript: (props: Omit<Subscript, 'type'>) => Subscript;
1189/**
1190 * Superscripted content.
1191 */
1192export declare type Superscript = Mark & {
1193 type: 'Superscript';
1194};
1195/**
1196 * Create a `Superscript` node
1197 * @param props Object containing Superscript schema properties as key/value pairs
1198 * @returns {Superscript} Superscript schema node
1199 */
1200export declare const superscript: (props: Omit<Superscript, 'type'>) => Superscript;
1201/**
1202 * A table.
1203 */
1204export declare type Table = CreativeWork & {
1205 type: 'Table';
1206 rows: Array<TableRow>;
1207 caption?: Array<BlockContent> | string;
1208 label?: string;
1209};
1210/**
1211 * Create a `Table` node
1212 * @param props Object containing Table schema properties as key/value pairs
1213 * @returns {Table} Table schema node
1214 */
1215export declare const table: (props: Omit<Table, 'type'>) => Table;
1216/**
1217 * A cell within a `Table`.
1218 */
1219export declare type TableCell = Entity & {
1220 type: 'TableCell';
1221 cellType?: 'Data' | 'Header';
1222 colspan?: Integer;
1223 content?: Array<BlockContent> | Array<InlineContent>;
1224 name?: string;
1225 rowspan?: Integer;
1226};
1227/**
1228 * Create a `TableCell` node
1229 * @param props Object containing TableCell schema properties as key/value pairs
1230 * @returns {TableCell} TableCell schema node
1231 */
1232export declare const tableCell: (props?: Omit<TableCell, 'type'>) => TableCell;
1233/**
1234 * A row within a Table.
1235 */
1236export declare type TableRow = Entity & {
1237 type: 'TableRow';
1238 cells: Array<TableCell>;
1239 rowType?: 'Header' | 'Footer';
1240};
1241/**
1242 * Create a `TableRow` node
1243 * @param props Object containing TableRow schema properties as key/value pairs
1244 * @returns {TableRow} TableRow schema node
1245 */
1246export declare const tableRow: (props: Omit<TableRow, 'type'>) => TableRow;
1247/**
1248 * A thematic break, such as a scene change in a story, a transition to another topic, or a new document.
1249 */
1250export declare type ThematicBreak = Entity & {
1251 type: 'ThematicBreak';
1252};
1253/**
1254 * Create a `ThematicBreak` node
1255 * @param props Object containing ThematicBreak schema properties as key/value pairs
1256 * @returns {ThematicBreak} ThematicBreak schema node
1257 */
1258export declare const thematicBreak: (props?: Omit<ThematicBreak, 'type'>) => ThematicBreak;
1259/**
1260 * A validator specifying constraints on an array of heterogeneous items.
1261 */
1262export declare type TupleValidator = Validator & {
1263 type: 'TupleValidator';
1264 items?: Array<ValidatorTypes>;
1265};
1266/**
1267 * Create a `TupleValidator` node
1268 * @param props Object containing TupleValidator schema properties as key/value pairs
1269 * @returns {TupleValidator} TupleValidator schema node
1270 */
1271export declare const tupleValidator: (props?: Omit<TupleValidator, 'type'>) => TupleValidator;
1272/**
1273 * A variable representing a name / value pair.
1274 */
1275export declare type Variable = Entity & {
1276 type: 'Variable';
1277 name: string;
1278 isReadonly?: boolean;
1279 validator?: ValidatorTypes;
1280 value?: Node;
1281};
1282/**
1283 * Create a `Variable` node
1284 * @param props Object containing Variable schema properties as key/value pairs
1285 * @returns {Variable} Variable schema node
1286 */
1287export declare const variable: (props: Omit<Variable, 'type'>) => Variable;
1288/**
1289 * A video file.
1290 */
1291export declare type VideoObject = MediaObject & {
1292 type: 'VideoObject';
1293 caption?: string;
1294 thumbnail?: ImageObject;
1295 transcript?: string;
1296};
1297/**
1298 * Create a `VideoObject` node
1299 * @param props Object containing VideoObject schema properties as key/value pairs
1300 * @returns {VideoObject} VideoObject schema node
1301 */
1302export declare const videoObject: (props: Omit<VideoObject, 'type'>) => VideoObject;
1303/**
1304 * Describes a volume mount from a host to container.
1305 */
1306export declare type VolumeMount = Thing & {
1307 type: 'VolumeMount';
1308 mountDestination: string;
1309 mountOptions?: Array<string>;
1310 mountSource?: string;
1311 mountType?: string;
1312};
1313/**
1314 * Create a `VolumeMount` node
1315 * @param props Object containing VolumeMount schema properties as key/value pairs
1316 * @returns {VolumeMount} VolumeMount schema node
1317 */
1318export declare const volumeMount: (props: Omit<VolumeMount, 'type'>) => VolumeMount;
1319/**
1320 * Union type for valid block content.
1321 */
1322export declare type BlockContent = Claim | CodeBlock | CodeChunk | Collection | Figure | Heading | Include | List | MathBlock | Paragraph | QuoteBlock | Table | ThematicBreak;
1323/**
1324 * All type schemas that are derived from CodeExecutable
1325 */
1326export declare type CodeExecutableTypes = CodeExecutable | CodeChunk | CodeExpression;
1327/**
1328 * All type schemas that are derived from Code
1329 */
1330export declare type CodeTypes = Code | CodeBlock | CodeChunk | CodeExecutable | CodeExpression | CodeFragment;
1331/**
1332 * All type schemas that are derived from ContactPoint
1333 */
1334export declare type ContactPointTypes = ContactPoint | PostalAddress;
1335/**
1336 * All type schemas that are derived from CreativeWork
1337 */
1338export declare type CreativeWorkTypes = CreativeWork | Article | AudioObject | Claim | Collection | Comment | Datatable | Figure | ImageObject | MediaObject | Periodical | PublicationIssue | PublicationVolume | Review | SoftwareApplication | SoftwareSourceCode | Table | VideoObject;
1339/**
1340 * All type schemas that are derived from Entity
1341 */
1342export 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;
1343/**
1344 * All type schemas that are derived from Enumeration
1345 */
1346export declare type EnumerationTypes = Enumeration | CitationIntentEnumeration;
1347/**
1348 * All type schemas that are derived from Grant
1349 */
1350export declare type GrantTypes = Grant | MonetaryGrant;
1351/**
1352 * Union type for valid inline content.
1353 */
1354export 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;
1355/**
1356 * All type schemas that are derived from Mark
1357 */
1358export declare type MarkTypes = Mark | Delete | Emphasis | NontextualAnnotation | Quote | Strong | Subscript | Superscript;
1359/**
1360 * All type schemas that are derived from Math
1361 */
1362export declare type MathTypes = Math | MathBlock | MathFragment;
1363/**
1364 * All type schemas that are derived from MediaObject
1365 */
1366export declare type MediaObjectTypes = MediaObject | AudioObject | ImageObject | VideoObject;
1367/**
1368 * Union type for all types of nodes in this schema, including primitives and entities
1369 */
1370export 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 | {
1371 [property: string]: Primitive;
1372} | Array<Primitive>;
1373/**
1374 * Union type for all primitives values
1375 */
1376export declare type Primitive = null | boolean | Integer | number | string | {
1377 [property: string]: Primitive;
1378} | Array<Primitive>;
1379/**
1380 * All type schemas that are derived from Thing
1381 */
1382export 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;
1383/**
1384 * All type schemas that are derived from Validator
1385 */
1386export declare type ValidatorTypes = Validator | ArrayValidator | BooleanValidator | ConstantValidator | EnumValidator | IntegerValidator | NumberValidator | StringValidator | TupleValidator;
1387/**
1388 * The type or nature of a citation, both factually and rhetorically.
1389 */
1390export declare enum CitationIntentEnumeration {
1391 /**
1392 * The citing entity agrees with statements, ideas or conclusions presented in the cited entity
1393 */
1394 AgreesWith = "AgreesWith",
1395 /**
1396 * The citing entity cites the cited entity as one that provides an authoritative description or definition of the subject under discussion
1397 */
1398 CitesAsAuthority = "CitesAsAuthority",
1399 /**
1400 * The citing entity cites the cited entity as source of data
1401 */
1402 CitesAsDataSource = "CitesAsDataSource",
1403 /**
1404 * The citing entity cites the cited entity as source of factual evidence for statements it contains
1405 */
1406 CitesAsEvidence = "CitesAsEvidence",
1407 /**
1408 * The citing entity cites the cited entity as being the container of metadata describing the citing entity
1409 */
1410 CitesAsMetadataDocument = "CitesAsMetadataDocument",
1411 /**
1412 * The citing entity cites the cited entity as providing or containing a possible solution to the issues being discussed
1413 */
1414 CitesAsPotentialSolution = "CitesAsPotentialSolution",
1415 /**
1416 * The citing entity cites the cited entity as an item of recommended reading
1417 */
1418 CitesAsRecommendedReading = "CitesAsRecommendedReading",
1419 /**
1420 * The citing entity cites the cited entity as one that is related
1421 */
1422 CitesAsRelated = "CitesAsRelated",
1423 /**
1424 * 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
1425 */
1426 CitesAsSourceDocument = "CitesAsSourceDocument",
1427 /**
1428 * The citing entity cites the cited entity as a source of information on the subject under discussion
1429 */
1430 CitesForInformation = "CitesForInformation",
1431 /**
1432 * The citing entity is used to create or compile the cited entity
1433 */
1434 Compiles = "Compiles",
1435 /**
1436 * The citing entity confirms facts, ideas or statements presented in the cited entity
1437 */
1438 Confirms = "Confirms",
1439 /**
1440 * 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
1441 */
1442 ContainsAssertionFrom = "ContainsAssertionFrom",
1443 /**
1444 * The citing entity corrects statements, ideas or conclusions presented in the cited entity
1445 */
1446 Corrects = "Corrects",
1447 /**
1448 * The citing entity acknowledges contributions made by the cited entity
1449 */
1450 Credits = "Credits",
1451 /**
1452 * The citing entity critiques statements, ideas or conclusions presented in the cited entity
1453 */
1454 Critiques = "Critiques",
1455 /**
1456 * The citing entity express derision for the cited entity, or for ideas or conclusions contained within it
1457 */
1458 Derides = "Derides",
1459 /**
1460 * The citing entity describes the cited entity
1461 */
1462 Describes = "Describes",
1463 /**
1464 * The citing entity disagrees with statements, ideas or conclusions presented in the cited entity
1465 */
1466 DisagreesWith = "DisagreesWith",
1467 /**
1468 * The citing entity discusses statements, ideas or conclusions presented in the cited entity
1469 */
1470 Discusses = "Discusses",
1471 /**
1472 * The citing entity disputes statements, ideas or conclusions presented in the cited entity
1473 */
1474 Disputes = "Disputes",
1475 /**
1476 * The citing entity documents information about the cited entity
1477 */
1478 Documents = "Documents",
1479 /**
1480 * The citing entity extends facts, ideas or understandings presented in the cited entity
1481 */
1482 Extends = "Extends",
1483 /**
1484 * The cited entity provides background information for the citing entity
1485 */
1486 GivesBackgroundTo = "GivesBackgroundTo",
1487 /**
1488 * The cited entity provides intellectual or factual support for the citing entity
1489 */
1490 GivesSupportTo = "GivesSupportTo",
1491 /**
1492 * The cited entity evokes a reply from the citing entity
1493 */
1494 HasReplyFrom = "HasReplyFrom",
1495 /**
1496 * The citing entity includes one or more excerpts from the cited entity
1497 */
1498 IncludesExcerptFrom = "IncludesExcerptFrom",
1499 /**
1500 * The citing entity includes one or more quotations from the cited entity
1501 */
1502 IncludesQuotationFrom = "IncludesQuotationFrom",
1503 /**
1504 * The cited entity contains statements, ideas or conclusions with which the citing entity agrees
1505 */
1506 IsAgreedWithBy = "IsAgreedWithBy",
1507 /**
1508 * The cited entity is cited as providing an authoritative description or definition of the subject under discussion in the citing entity
1509 */
1510 IsCitedAsAuthorityBy = "IsCitedAsAuthorityBy",
1511 /**
1512 * The cited entity is cited as a data source by the citing entity
1513 */
1514 IsCitedAsDataSourceBy = "IsCitedAsDataSourceBy",
1515 /**
1516 * The cited entity is cited for providing factual evidence to the citing entity
1517 */
1518 IsCitedAsEvidenceBy = "IsCitedAsEvidenceBy",
1519 /**
1520 * The cited entity is cited as being the container of metadata relating to the citing entity
1521 */
1522 IsCitedAsMetadataDocumentBy = "IsCitedAsMetadataDocumentBy",
1523 /**
1524 * The cited entity is cited as providing or containing a possible solution to the issues being discussed in the citing entity
1525 */
1526 IsCitedAsPontentialSolutionBy = "IsCitedAsPontentialSolutionBy",
1527 /**
1528 * The cited entity is cited by the citing entity as an item of recommended reading
1529 */
1530 IsCitedAsRecommendedReadingBy = "IsCitedAsRecommendedReadingBy",
1531 /**
1532 * The cited entity is cited as being related to the citing entity
1533 */
1534 IsCitedAsRelatedBy = "IsCitedAsRelatedBy",
1535 /**
1536 * The cited entity is cited as being the entity from which the citing entity is derived, or about which the citing entity contains metadata
1537 */
1538 IsCitedAsSourceDocumentBy = "IsCitedAsSourceDocumentBy",
1539 /**
1540 * The cited entity (the subject of the RDF triple) is cited by the citing entity (the object of the triple)
1541 */
1542 IsCitedBy = "IsCitedBy",
1543 /**
1544 * The cited entity is cited as a source of information on the subject under discussion in the citing entity
1545 */
1546 IsCitedForInformationBy = "IsCitedForInformationBy",
1547 /**
1548 * The cited entity is the result of a compile or creation event using the citing entity
1549 */
1550 IsCompiledBy = "IsCompiledBy",
1551 /**
1552 * The cited entity presents facts, ideas or statements that are confirmed by the citing entity
1553 */
1554 IsConfirmedBy = "IsConfirmedBy",
1555 /**
1556 * The cited entity presents statements, ideas or conclusions that are corrected by the citing entity
1557 */
1558 IsCorrectedBy = "IsCorrectedBy",
1559 /**
1560 * The cited entity makes contributions that are acknowledged by the citing entity
1561 */
1562 IsCreditedBy = "IsCreditedBy",
1563 /**
1564 * The cited entity presents statements, ideas or conclusions that are critiqued by the citing entity
1565 */
1566 IsCritiquedBy = "IsCritiquedBy",
1567 /**
1568 * The cited entity contains ideas or conclusions for which the citing entity express derision
1569 */
1570 IsDeridedBy = "IsDeridedBy",
1571 /**
1572 * The cited entity is described by the citing entity
1573 */
1574 IsDescribedBy = "IsDescribedBy",
1575 /**
1576 * The cited entity presents statements, ideas or conclusions that are disagreed with by the citing entity
1577 */
1578 IsDisagreedWithBy = "IsDisagreedWithBy",
1579 /**
1580 * The cited entity presents statements, ideas or conclusions that are discussed by the citing entity
1581 */
1582 IsDiscussedBy = "IsDiscussedBy",
1583 /**
1584 * The cited entity presents statements, ideas or conclusions that are disputed by the citing entity
1585 */
1586 IsDisputedBy = "IsDisputedBy",
1587 /**
1588 * Information about the cited entity is documented by the citing entity
1589 */
1590 IsDocumentedBy = "IsDocumentedBy",
1591 /**
1592 * The cited entity presents facts, ideas or understandings that are extended by the citing entity
1593 */
1594 IsExtendedBy = "IsExtendedBy",
1595 /**
1596 * The cited entity is the target for an HTTP Uniform Resource Locator (URL) link within the citing entity
1597 */
1598 IsLinkedToBy = "IsLinkedToBy",
1599 /**
1600 * The characteristic style or content of the cited entity is imitated by the citing entity for comic effect, usually without explicit citation
1601 */
1602 IsParodiedBy = "IsParodiedBy",
1603 /**
1604 * 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
1605 */
1606 IsPlagiarizedBy = "IsPlagiarizedBy",
1607 /**
1608 * The cited entity presents statements, ideas or conclusions that are qualified or have conditions placed upon them by the citing entity
1609 */
1610 IsQualifiedBy = "IsQualifiedBy",
1611 /**
1612 * The cited entity presents statements, ideas or conclusions that are refuted by the citing entity
1613 */
1614 IsRefutedBy = "IsRefutedBy",
1615 /**
1616 * The cited entity is formally retracted by the citing entity
1617 */
1618 IsRetractedBy = "IsRetractedBy",
1619 /**
1620 * The cited entity presents statements, ideas or conclusions that are reviewed by the citing entity
1621 */
1622 IsReviewedBy = "IsReviewedBy",
1623 /**
1624 * The cited entity or aspects of its contents are ridiculed by the citing entity
1625 */
1626 IsRidiculedBy = "IsRidiculedBy",
1627 /**
1628 * The cited entity is cited because the citing article contains speculations on its content or ideas
1629 */
1630 IsSpeculatedOnBy = "IsSpeculatedOnBy",
1631 /**
1632 * The cited entity receives intellectual or factual support from the citing entity
1633 */
1634 IsSupportedBy = "IsSupportedBy",
1635 /**
1636 * The cited entity presents statements, ideas, hypotheses or understanding that are updated by the cited entity
1637 */
1638 IsUpdatedBy = "IsUpdatedBy",
1639 /**
1640 * 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
1641 */
1642 Likes = "Likes",
1643 /**
1644 * The citing entity provides a link, in the form of an HTTP Uniform Resource Locator (URL), to the cited entity
1645 */
1646 LinksTo = "LinksTo",
1647 /**
1648 * The citing entity obtains background information from the cited entity
1649 */
1650 ObtainsBackgroundFrom = "ObtainsBackgroundFrom",
1651 /**
1652 * The citing entity obtains intellectual or factual support from the cited entity
1653 */
1654 ObtainsSupportFrom = "ObtainsSupportFrom",
1655 /**
1656 * The citing entity imitates the characteristic style or content of the cited entity for comic effect, usually without explicit citation
1657 */
1658 Parodies = "Parodies",
1659 /**
1660 * 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
1661 */
1662 Plagiarizes = "Plagiarizes",
1663 /**
1664 * 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
1665 */
1666 ProvidesAssertionFor = "ProvidesAssertionFor",
1667 /**
1668 * The cited entity presents conclusions that are used in work described in the citing entity
1669 */
1670 ProvidesConclusionsFor = "ProvidesConclusionsFor",
1671 /**
1672 * The cited entity presents data that are used in work described in the citing entity
1673 */
1674 ProvidesDataFor = "ProvidesDataFor",
1675 /**
1676 * The cited entity contains information, usually of a textual nature, that is excerpted by (used as an excerpt within) the citing entity
1677 */
1678 ProvidesExcerptFor = "ProvidesExcerptFor",
1679 /**
1680 * The cited entity details a method that is used in work described by the citing entity
1681 */
1682 ProvidesMethodFor = "ProvidesMethodFor",
1683 /**
1684 * The cited entity contains information, usually of a textual nature, that is quoted by (used as a quotation within) the citing entity
1685 */
1686 ProvidesQuotationFor = "ProvidesQuotationFor",
1687 /**
1688 * The citing entity qualifies or places conditions or restrictions upon statements, ideas or conclusions presented in the cited entity
1689 */
1690 Qualifies = "Qualifies",
1691 /**
1692 * The citing entity refutes statements, ideas or conclusions presented in the cited entity
1693 */
1694 Refutes = "Refutes",
1695 /**
1696 * The citing entity replies to statements, ideas or criticisms presented in the cited entity
1697 */
1698 RepliesTo = "RepliesTo",
1699 /**
1700 * The citing entity constitutes a formal retraction of the cited entity
1701 */
1702 Retracts = "Retracts",
1703 /**
1704 * The citing entity reviews statements, ideas or conclusions presented in the cited entity
1705 */
1706 Reviews = "Reviews",
1707 /**
1708 * The citing entity ridicules the cited entity or aspects of its contents
1709 */
1710 Ridicules = "Ridicules",
1711 /**
1712 * Each entity has at least one author that shares a common institutional affiliation with an author of the other entity
1713 */
1714 SharesAuthorInstitutionWith = "SharesAuthorInstitutionWith",
1715 /**
1716 * Each entity has at least one author in common with the other entity
1717 */
1718 SharesAuthorWith = "SharesAuthorWith",
1719 /**
1720 * The two entities result from activities that have been funded by the same funding agency
1721 */
1722 SharesFundingAgencyWith = "SharesFundingAgencyWith",
1723 /**
1724 * The citing and cited bibliographic resources are published in the same journal
1725 */
1726 SharesJournalWith = "SharesJournalWith",
1727 /**
1728 * The citing and cited bibliographic resources are published in same publication venue
1729 */
1730 SharesPublicationVenueWith = "SharesPublicationVenueWith",
1731 /**
1732 * The citing entity speculates on something within or related to the cited entity, without firm evidence
1733 */
1734 SpeculatesOn = "SpeculatesOn",
1735 /**
1736 * The citing entity provides intellectual or factual support for statements, ideas or conclusions presented in the cited entity
1737 */
1738 Supports = "Supports",
1739 /**
1740 * The citing entity updates statements, ideas, hypotheses or understanding presented in the cited entity
1741 */
1742 Updates = "Updates",
1743 /**
1744 * The citing entity describes work that uses conclusions presented in the cited entity
1745 */
1746 UsesConclusionsFrom = "UsesConclusionsFrom",
1747 /**
1748 * The citing entity describes work that uses data presented in the cited entity
1749 */
1750 UsesDataFrom = "UsesDataFrom",
1751 /**
1752 * The citing entity describes work that uses a method detailed in the cited entity
1753 */
1754 UsesMethodIn = "UsesMethodIn"
1755}
1756export declare type TypeMap<T extends Entity = Entity> = {
1757 [key in T['type']]: key;
1758};
1759export declare const codeExecutableTypes: TypeMap<Exclude<CodeExecutableTypes, Primitive>>;
1760export declare const codeTypes: TypeMap<Exclude<CodeTypes, Primitive>>;
1761export declare const contactPointTypes: TypeMap<Exclude<ContactPointTypes, Primitive>>;
1762export declare const creativeWorkTypes: TypeMap<Exclude<CreativeWorkTypes, Primitive>>;
1763export declare const entityTypes: TypeMap<Exclude<EntityTypes, Primitive>>;
1764export declare const enumerationTypes: TypeMap<Exclude<EnumerationTypes, Primitive>>;
1765export declare const grantTypes: TypeMap<Exclude<GrantTypes, Primitive>>;
1766export declare const markTypes: TypeMap<Exclude<MarkTypes, Primitive>>;
1767export declare const mathTypes: TypeMap<Exclude<MathTypes, Primitive>>;
1768export declare const mediaObjectTypes: TypeMap<Exclude<MediaObjectTypes, Primitive>>;
1769export declare const thingTypes: TypeMap<Exclude<ThingTypes, Primitive>>;
1770export declare const validatorTypes: TypeMap<Exclude<ValidatorTypes, Primitive>>;
1771export declare const blockContentTypes: TypeMap<Exclude<BlockContent, Primitive>>;
1772export declare const inlineContentTypes: TypeMap<Exclude<InlineContent, Primitive>>;
1773export interface Unions {
1774 CodeExecutableTypes: CodeExecutableTypes;
1775 CodeTypes: CodeTypes;
1776 ContactPointTypes: ContactPointTypes;
1777 CreativeWorkTypes: CreativeWorkTypes;
1778 EntityTypes: EntityTypes;
1779 EnumerationTypes: EnumerationTypes;
1780 GrantTypes: GrantTypes;
1781 MarkTypes: MarkTypes;
1782 MathTypes: MathTypes;
1783 MediaObjectTypes: MediaObjectTypes;
1784 ThingTypes: ThingTypes;
1785 ValidatorTypes: ValidatorTypes;
1786 BlockContent: BlockContent;
1787 InlineContent: InlineContent;
1788}
1789export declare const unions: {
1790 CodeExecutableTypes: TypeMap<never>;
1791 CodeTypes: TypeMap<never>;
1792 ContactPointTypes: TypeMap<never>;
1793 CreativeWorkTypes: TypeMap<never>;
1794 EntityTypes: TypeMap<never>;
1795 EnumerationTypes: TypeMap<never>;
1796 GrantTypes: TypeMap<never>;
1797 MarkTypes: TypeMap<never>;
1798 MathTypes: TypeMap<never>;
1799 MediaObjectTypes: TypeMap<never>;
1800 ThingTypes: TypeMap<never>;
1801 ValidatorTypes: TypeMap<never>;
1802 BlockContent: TypeMap<never>;
1803 InlineContent: TypeMap<never>;
1804};
1805export {};