json-ld-types
Advanced tools
Comparing version 2.2.0 to 2.2.1
# @atlassian/json-ld-types | ||
## 2.2.1 | ||
### Patch Changes | ||
- 9f3d22f: Fix up some of the types. Make sure new `atlassian:aspectRatio` property is added everywhere where `preview` prop is. | ||
## 2.2.0 | ||
@@ -4,0 +10,0 @@ |
import { Action as ActionSchema, AssignAction, CommentAction, DeleteAction, DownloadAction, ReplyAction, ShareAction, SubscribeAction, ViewAction, WatchAction } from 'schema-dts'; | ||
export declare namespace JsonLd { | ||
namespace Primitives { | ||
type Access = 'granted' | 'forbidden' | 'unauthorized' | 'not_found'; | ||
type Visibility = 'public' | 'restricted' | 'other' | 'not_found'; | ||
type LeafType = 'Object' | 'Link' | 'Collection'; | ||
type ObjectType = 'Collection' | 'Application' | 'Group' | 'Person' | 'Service' | 'Organization' | 'Relationship' | 'Object' | 'Article' | 'Document' | 'Audio' | 'Image' | 'Video' | 'Note' | 'Page' | 'Event' | 'Place' | 'Profile' | 'Tombstone' | 'schema:BlogPosting' | 'schema:TextDigitalDocument' | 'schema:DigitalDocument' | 'schema:PresentationDigitalDocument' | 'schema:SpreadsheetDigitalDocument' | 'schema:Message' | 'atlassian:Project' | 'atlassian:SourceCodeReference' | 'atlassian:SourceCodeRepository' | 'atlassian:SourceCodePullRequest' | 'atlassian:SourceCodeCommit' | 'atlassian:Task' | 'atlassian:UndefinedLink'; | ||
type LinkType = 'Mention'; | ||
type CollectionType = 'Collection' | 'CollectionPage'; | ||
type Type = ObjectType | LinkType | CollectionType | LeafType; | ||
interface AuthService { | ||
export type Access = 'granted' | 'forbidden' | 'unauthorized' | 'not_found'; | ||
export type Visibility = 'public' | 'restricted' | 'other' | 'not_found'; | ||
export type LeafType = 'Object' | 'Link' | 'Collection'; | ||
export type ObjectType = 'Collection' | 'Application' | 'Group' | 'Person' | 'Service' | 'Organization' | 'Relationship' | 'Object' | 'Article' | 'Document' | 'Audio' | 'Image' | 'Video' | 'Note' | 'Page' | 'Event' | 'Place' | 'Profile' | 'Tombstone' | 'schema:BlogPosting' | 'schema:TextDigitalDocument' | 'schema:DigitalDocument' | 'schema:PresentationDigitalDocument' | 'schema:SpreadsheetDigitalDocument' | 'schema:Message' | 'atlassian:Project' | 'atlassian:SourceCodeReference' | 'atlassian:SourceCodeRepository' | 'atlassian:SourceCodePullRequest' | 'atlassian:SourceCodeCommit' | 'atlassian:Task' | 'atlassian:UndefinedLink'; | ||
export type LinkType = 'Mention'; | ||
export type CollectionType = 'Collection' | 'CollectionPage'; | ||
export type Type = ObjectType | LinkType | CollectionType | LeafType; | ||
export interface AuthService { | ||
key: string; | ||
@@ -16,5 +16,5 @@ displayName: string; | ||
} | ||
type Property<T> = T | T[]; | ||
type TypeProperty<ResourceType extends Type, ParentType extends Type = 'Object'> = ResourceType | Array<ParentType | ResourceType>; | ||
interface Context { | ||
export type Property<T> = T | T[]; | ||
export type TypeProperty<ResourceType extends Type, ParentType extends Type = 'Object'> = ResourceType | Array<ParentType | ResourceType>; | ||
export interface Context { | ||
'@vocab': 'https://www.w3.org/ns/activitystreams#'; | ||
@@ -24,3 +24,7 @@ atlassian: 'https://schema.atlassian.com/ns/vocabulary#'; | ||
} | ||
interface Object<T = any> { | ||
interface PreviewExtension { | ||
'atlassian:supportedPlatforms'?: Primitives.Platforms[]; | ||
'atlassian:aspectRatio'?: number; | ||
} | ||
export interface Object<T = any> { | ||
'@id'?: string; | ||
@@ -45,5 +49,3 @@ '@type': Property<'Object' | ObjectType>; | ||
closed?: Primitives.Object | Primitives.Link | string | boolean; | ||
preview?: string | ((Primitives.LinkModel | Primitives.Object) & { | ||
'atlassian:supportedPlatforms'?: Primitives.Platforms[]; | ||
}); | ||
preview?: string | ((Primitives.LinkModel | Primitives.Object) & PreviewExtension); | ||
replies?: Collection<T>; | ||
@@ -66,4 +68,4 @@ tag?: Property<Primitives.Object | Primitives.Link>; | ||
} | ||
type Link = string | LinkModel; | ||
interface LinkModel { | ||
export type Link = string | LinkModel; | ||
export interface LinkModel { | ||
'@type': 'Link'; | ||
@@ -78,8 +80,5 @@ href?: string; | ||
width?: number; | ||
preview?: string | ((Primitives.LinkModel | Primitives.Object) & { | ||
'atlassian:supportedPlatforms'?: Primitives.Platforms[]; | ||
'atlassian:aspectRatio'?: number; | ||
}); | ||
preview?: string | ((Primitives.LinkModel | Primitives.Object) & PreviewExtension); | ||
} | ||
interface Activity { | ||
export interface Activity { | ||
actor?: Primitives.Object | Primitives.Link; | ||
@@ -92,4 +91,4 @@ object?: Primitives.Object | Primitives.Link; | ||
} | ||
type IntransitiveActivity = Omit<Activity, 'object'>; | ||
interface Collection<T> { | ||
export type IntransitiveActivity = Omit<Activity, 'object'>; | ||
export interface Collection<T> { | ||
totalItems?: number; | ||
@@ -101,4 +100,4 @@ current?: CollectionPage<T> | Primitives.Link; | ||
} | ||
type OrderedCollection<T> = Collection<T>; | ||
interface CollectionPage<T = any> extends Collection<T> { | ||
export type OrderedCollection<T> = Collection<T>; | ||
export interface CollectionPage<T = any> extends Collection<T> { | ||
partOf?: Primitives.Link | Collection<T>; | ||
@@ -108,21 +107,21 @@ next?: CollectionPage<T> | Primitives.Link; | ||
} | ||
interface OrderedCollectionPage<T> extends CollectionPage<T> { | ||
export interface OrderedCollectionPage<T> extends CollectionPage<T> { | ||
startIndex?: number; | ||
} | ||
interface Application<T = any> extends Primitives.Object<T> { | ||
export interface Application<T = any> extends Primitives.Object<T> { | ||
'@type': TypeProperty<'Application'>; | ||
} | ||
interface Group<T = any> extends Primitives.Object<T> { | ||
export interface Group<T = any> extends Primitives.Object<T> { | ||
'@type': TypeProperty<'Group'>; | ||
} | ||
interface Organization<T = any> extends Primitives.Object<T> { | ||
export interface Organization<T = any> extends Primitives.Object<T> { | ||
'@type': TypeProperty<'Organization'>; | ||
} | ||
interface Person<T = any> extends Primitives.Object<T> { | ||
export interface Person<T = any> extends Primitives.Object<T> { | ||
'@type': TypeProperty<'Person'>; | ||
} | ||
interface Service<T = any> extends Primitives.Object<T> { | ||
export interface Service<T = any> extends Primitives.Object<T> { | ||
'@type': TypeProperty<'Service'>; | ||
} | ||
interface Relationship extends Primitives.Object { | ||
export interface Relationship extends Primitives.Object { | ||
'@type': TypeProperty<'Relationship'>; | ||
@@ -133,27 +132,27 @@ subject?: Primitives.Link | Primitives.Object; | ||
} | ||
interface Article extends Primitives.Object { | ||
export interface Article extends Primitives.Object { | ||
'@type': TypeProperty<'Article'>; | ||
} | ||
interface Document extends Primitives.Object { | ||
export interface Document extends Primitives.Object { | ||
'@type': TypeProperty<'Document'>; | ||
} | ||
interface Audio extends Primitives.Object { | ||
export interface Audio extends Primitives.Object { | ||
'@type': TypeProperty<'Audio'>; | ||
} | ||
interface Image extends Primitives.Object { | ||
export interface Image extends Primitives.Object { | ||
'@type': TypeProperty<'Image'>; | ||
} | ||
interface Video extends Primitives.Object { | ||
export interface Video extends Primitives.Object { | ||
'@type': TypeProperty<'Video'>; | ||
} | ||
interface Note extends Primitives.Object { | ||
export interface Note extends Primitives.Object { | ||
'@type': TypeProperty<'Note'>; | ||
} | ||
interface Page extends Primitives.Object { | ||
export interface Page extends Primitives.Object { | ||
'@type': TypeProperty<'Page'>; | ||
} | ||
interface Event extends Primitives.Object { | ||
export interface Event extends Primitives.Object { | ||
'@type': TypeProperty<'Event'>; | ||
} | ||
interface Place extends Primitives.Object { | ||
export interface Place extends Primitives.Object { | ||
'@type': TypeProperty<'Place'>; | ||
@@ -167,10 +166,10 @@ accuracy?: number; | ||
} | ||
type Mention = Primitives.Link & { | ||
export type Mention = Primitives.Link & { | ||
'@type': TypeProperty<'Mention', 'Link'>; | ||
}; | ||
interface Profile extends Primitives.Object { | ||
export interface Profile extends Primitives.Object { | ||
'@type': TypeProperty<'Profile'>; | ||
describes?: Primitives.Object; | ||
} | ||
interface Tombstone extends Primitives.Object { | ||
export interface Tombstone extends Primitives.Object { | ||
'@type': TypeProperty<'Tombstone'>; | ||
@@ -180,4 +179,4 @@ formerType?: Primitives.Object; | ||
} | ||
type AssignedObjectActions = AssignAction | SubscribeAction; | ||
interface AssignedObject { | ||
export type AssignedObjectActions = AssignAction | SubscribeAction; | ||
export interface AssignedObject { | ||
'atlassian:assignedTo'?: Primitives.Link | Person; | ||
@@ -189,10 +188,11 @@ 'atlassian:assignedBy'?: Primitives.Link | Person; | ||
} | ||
type PreviewAction = ActionSchema & { | ||
export type PreviewAction = ActionSchema & { | ||
'@type': 'PreviewAction'; | ||
}; | ||
type AtlassianActionSchema = PreviewAction; | ||
type ClientAction = DownloadAction | ViewAction | AtlassianActionSchema; | ||
type ServerAction = AssignAction | CommentAction | DeleteAction | ReplyAction | ShareAction | SubscribeAction | WatchAction; | ||
type Action = ServerAction | ClientAction; | ||
type Platforms = 'web' | 'mobile'; | ||
export type AtlassianActionSchema = PreviewAction; | ||
export type ClientAction = DownloadAction | ViewAction | AtlassianActionSchema; | ||
export type ServerAction = AssignAction | CommentAction | DeleteAction | ReplyAction | ShareAction | SubscribeAction | WatchAction; | ||
export type Action = ServerAction | ClientAction; | ||
export type Platforms = 'web' | 'mobile'; | ||
export {}; | ||
} | ||
@@ -199,0 +199,0 @@ namespace Meta { |
{ | ||
"name": "json-ld-types", | ||
"version": "2.2.0", | ||
"version": "2.2.1", | ||
"contributors": [ | ||
@@ -5,0 +5,0 @@ { |
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
49947