@musakui/fedi/lib/activitystreams/extendedTypes.d.ts

tools for the fediverse

import {
	ObjectRef,
	ObjectRefs,
	CoreObject,
	CoreIntransitiveActivity,
} from './coreTypes'

import {
	LINK_TYPES,
	ACTOR_TYPES,
	OBJECT_TYPES,
	TRANSITIVE_ACTIVITY_TYPES,
	INTRANSITIVE_ACTIVITY_TYPES,
} from './extended.js'

type CoreRef = string | URL | CoreObject<string>

/** @see https://www.w3.org/TR/activitystreams-core/#link */
export type LinkTypes = typeof LINK_TYPES[number]

/** @see https://www.w3.org/TR/activitystreams-core/#actors */
export type ActorTypes = typeof ACTOR_TYPES[number]

/** @see https://www.w3.org/TR/activitystreams-core/#object */
export type ExtendedObjectTypes = typeof OBJECT_TYPES[number]

/** @see https://www.w3.org/TR/activitystreams-core/#activities */
export type TransitiveActivityTypes = typeof TRANSITIVE_ACTIVITY_TYPES[number]

/** @see https://www.w3.org/TR/activitystreams-core/#intransitiveactivities */
export type IntransitiveActivityTypes = typeof INTRANSITIVE_ACTIVITY_TYPES[number]

export type ExtendedActivityTypes = TransitiveActivityTypes | IntransitiveActivityTypes

interface BaseQuestion extends CoreIntransitiveActivity<'Question'> {
	/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-closed */
	closed?: boolean | Date | ObjectRef<string>
}

interface SingleChoiceQuestion extends BaseQuestion {
	/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-oneof */
	oneOf: ObjectRefs
	anyOf?: never
}

interface MultiChoiceQuestion extends BaseQuestion {
	/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-anyof */
	anyOf: ObjectRefs
	oneOf?: never
}

/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-question */
export type QuestionActivity = SingleChoiceQuestion | MultiChoiceQuestion

/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-relationship */
export interface RelationshipObject extends CoreObject<'Relationship'> {
	relationship?: CoreRef

	/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-subject */
	subject?: ObjectRef<string>

	/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object-term */
	object?: ObjectRefs
}

/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-profile */
export interface ProfileObject extends CoreObject<'Profile'> {
	/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-describes */
	describes?: CoreRef
}

/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-place */
export interface PlaceObject extends CoreObject<'Place'> {
	/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-accuracy */
	accuracy?: number

	/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-altitude */
	altitude?: number

	/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-latitude */
	latitude?: number

	/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-longitude */
	longitude?: number

	/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-radius */
	radius?: number

	/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-units */
	units?: string
}

/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-tombstone */
export interface TombstoneObject extends CoreObject<'Tombstone'> {
	/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-formertype */
	formerType?: string | string[]

	/** @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-deleted */
	deleted?: string | Date
}