@fedify/vocab 2.2.0-dev.635 → 2.2.0-dev.731

package/dist/mod.d.ts

@@ -1,6 +1,6 @@
 import { Temporal } from "@js-temporal/polyfill";
 import { Span, TracerProvider } from "@opentelemetry/api";
-import { DocumentLoader, DocumentLoader as DocumentLoader$1, GetUserAgentOptions, GetUserAgentOptions as GetUserAgentOptions$1, LanguageString, LanguageString as LanguageString$1, RemoteDocument } from "@fedify/vocab-runtime";
+import { Decimal, DocumentLoader, DocumentLoader as DocumentLoader$1, GetUserAgentOptions, GetUserAgentOptions as GetUserAgentOptions$1, LanguageString, LanguageString as LanguageString$1, RemoteDocument } from "@fedify/vocab-runtime";
 
 //#region src/vocab.d.ts
 /** Describes an object of any kind. The Object type serves as the base type for
@@ -1960,6 +1960,102 @@ declare class PropertyValue {
   }): Promise<PropertyValue>;
   protected _getCustomInspectProxy(): Record<string, unknown>;
 }
+/** A quantity with a unit of measure.
+*/
+declare class Measure {
+  #private;
+  readonly id: URL | null;
+  protected get _documentLoader(): DocumentLoader$1 | undefined;
+  protected get _contextLoader(): DocumentLoader$1 | undefined;
+  protected get _tracerProvider(): TracerProvider | undefined;
+  protected get _warning(): {
+    category: string[];
+    message: string;
+    values?: Record<string, unknown>;
+  } | undefined;
+  protected get _cachedJsonLd(): unknown | undefined;
+  protected set _cachedJsonLd(value: unknown | undefined);
+  /**
+  * The type URI of {@link Measure}: `http://www.ontology-of-units-of-measure.org/resource/om-2/Measure`.
+  */
+  static get typeId(): URL;
+  /**
+  * Constructs a new instance of Measure with the given values.
+  * @param values The values to initialize the instance with.
+  * @param options The options to use for initialization.
+  */
+  constructor(values: {
+    id?: URL | null;
+    unit?: string | null;
+    numericalValue?: Decimal | null;
+  }, options?: {
+    documentLoader?: DocumentLoader$1;
+    contextLoader?: DocumentLoader$1;
+    tracerProvider?: TracerProvider;
+  });
+  /**
+  * Clones this instance, optionally updating it with the given values.
+  * @param values The values to update the clone with.
+  * @param options The options to use for cloning.
+  * @returns The cloned instance.
+  */
+  clone(values?: {
+    id?: URL | null;
+    unit?: string | null;
+    numericalValue?: Decimal | null;
+  }, options?: {
+    documentLoader?: DocumentLoader$1;
+    contextLoader?: DocumentLoader$1;
+  }): Measure;
+  /** The name of the unit, according to the Ontology of units of Measure
+  * classification.  The recommended unit for countable items is `"one"`.
+  */
+  get unit(): string | null;
+  /** The amount of the resource.  If not specified, arbitrary amounts can be
+  * used when responding to the proposal.
+  */
+  get numericalValue(): Decimal | null;
+  /**
+  * Converts this object to a JSON-LD structure.
+  * @param options The options to use.
+  *                - `format`: The format of the output: `compact` or
+  `expand`.
+  *                - `contextLoader`: The loader for remote JSON-LD contexts.
+  *                - `context`: The JSON-LD context to use.  Not applicable
+  when `format` is set to `'expand'`.
+  * @returns The JSON-LD representation of this object.
+  */
+  toJsonLd(options?: {
+    format?: "compact" | "expand";
+    contextLoader?: DocumentLoader$1;
+    context?: string | Record<string, string> | (string | Record<string, string>)[];
+  }): Promise<unknown>;
+  protected isCompactable(): boolean;
+  /**
+  * Converts a JSON-LD structure to an object of this type.
+  * @param json The JSON-LD structure to convert.
+  * @param options The options to use.
+  *                - `documentLoader`: The loader for remote JSON-LD documents.
+  *                - `contextLoader`: The loader for remote JSON-LD contexts.
+  *                - `tracerProvider`: The OpenTelemetry tracer provider to use.
+  *                  If omitted, the global tracer provider is used.
+  * @returns The object of this type.
+  * @throws {TypeError} If the given `json` is invalid.
+  */
+  static fromJsonLd(json: unknown, options?: {
+    documentLoader?: DocumentLoader$1;
+    contextLoader?: DocumentLoader$1;
+    tracerProvider?: TracerProvider;
+    baseUrl?: URL;
+  }): Promise<Measure>;
+  protected static __fromJsonLd__Measure__(json: unknown, span: Span, options?: {
+    documentLoader?: DocumentLoader$1;
+    contextLoader?: DocumentLoader$1;
+    tracerProvider?: TracerProvider;
+    baseUrl?: URL;
+  }): Promise<Measure>;
+  protected _getCustomInspectProxy(): Record<string, unknown>;
+}
 /** Proves that an {@link Announce} interaction has been approved by
 * the post author.
 *
@@ -4022,6 +4118,330 @@ declare class Multikey {
   }): Promise<Multikey>;
   protected _getCustomInspectProxy(): Record<string, unknown>;
 }
+/** A proposed economic transaction describing what is being offered or requested
+* in a {@link Proposal}.
+*/
+declare class Intent {
+  #private;
+  readonly id: URL | null;
+  protected get _documentLoader(): DocumentLoader$1 | undefined;
+  protected get _contextLoader(): DocumentLoader$1 | undefined;
+  protected get _tracerProvider(): TracerProvider | undefined;
+  protected get _warning(): {
+    category: string[];
+    message: string;
+    values?: Record<string, unknown>;
+  } | undefined;
+  protected get _cachedJsonLd(): unknown | undefined;
+  protected set _cachedJsonLd(value: unknown | undefined);
+  /**
+  * The type URI of {@link Intent}: `https://w3id.org/valueflows/ont/vf#Intent`.
+  */
+  static get typeId(): URL;
+  /**
+  * Constructs a new instance of Intent with the given values.
+  * @param values The values to initialize the instance with.
+  * @param options The options to use for initialization.
+  */
+  constructor(values: {
+    id?: URL | null;
+    action?: string | null;
+    resourceConformsTo?: URL | null;
+    resourceQuantity?: Measure | null;
+    availableQuantity?: Measure | null;
+    minimumQuantity?: Measure | null;
+  }, options?: {
+    documentLoader?: DocumentLoader$1;
+    contextLoader?: DocumentLoader$1;
+    tracerProvider?: TracerProvider;
+  });
+  /**
+  * Clones this instance, optionally updating it with the given values.
+  * @param values The values to update the clone with.
+  * @param options The options to use for cloning.
+  * @returns The cloned instance.
+  */
+  clone(values?: {
+    id?: URL | null;
+    action?: string | null;
+    resourceConformsTo?: URL | null;
+    resourceQuantity?: Measure | null;
+    availableQuantity?: Measure | null;
+    minimumQuantity?: Measure | null;
+  }, options?: {
+    documentLoader?: DocumentLoader$1;
+    contextLoader?: DocumentLoader$1;
+  }): Intent;
+  /** The type of economic transaction.  The value of this property should be
+  * either `"deliverService"` or `"transfer"`.
+  */
+  get action(): string | null;
+  /** The type of an economic resource.  Could be any URI.
+  */
+  get resourceConformsTo(): URL | null;
+  /** The amount and unit of the economic resource.
+  */
+  get resourceQuantity(): Measure | null;
+  /** The quantity of the offered resource currently available.
+  */
+  get availableQuantity(): Measure | null;
+  /** The minimum possible quantity of the resource.
+  */
+  get minimumQuantity(): Measure | null;
+  /**
+  * Converts this object to a JSON-LD structure.
+  * @param options The options to use.
+  *                - `format`: The format of the output: `compact` or
+  `expand`.
+  *                - `contextLoader`: The loader for remote JSON-LD contexts.
+  *                - `context`: The JSON-LD context to use.  Not applicable
+  when `format` is set to `'expand'`.
+  * @returns The JSON-LD representation of this object.
+  */
+  toJsonLd(options?: {
+    format?: "compact" | "expand";
+    contextLoader?: DocumentLoader$1;
+    context?: string | Record<string, string> | (string | Record<string, string>)[];
+  }): Promise<unknown>;
+  protected isCompactable(): boolean;
+  /**
+  * Converts a JSON-LD structure to an object of this type.
+  * @param json The JSON-LD structure to convert.
+  * @param options The options to use.
+  *                - `documentLoader`: The loader for remote JSON-LD documents.
+  *                - `contextLoader`: The loader for remote JSON-LD contexts.
+  *                - `tracerProvider`: The OpenTelemetry tracer provider to use.
+  *                  If omitted, the global tracer provider is used.
+  * @returns The object of this type.
+  * @throws {TypeError} If the given `json` is invalid.
+  */
+  static fromJsonLd(json: unknown, options?: {
+    documentLoader?: DocumentLoader$1;
+    contextLoader?: DocumentLoader$1;
+    tracerProvider?: TracerProvider;
+    baseUrl?: URL;
+  }): Promise<Intent>;
+  protected static __fromJsonLd__Intent__(json: unknown, span: Span, options?: {
+    documentLoader?: DocumentLoader$1;
+    contextLoader?: DocumentLoader$1;
+    tracerProvider?: TracerProvider;
+    baseUrl?: URL;
+  }): Promise<Intent>;
+  protected _getCustomInspectProxy(): Record<string, unknown>;
+}
+/** A published request or offer, sometimes with what is expected in return.
+*
+* Proposals contain a primary {@link Intent} (via `publishes`) describing
+* what is being offered or requested, and optionally a reciprocal
+* {@link Intent} describing what is expected or offered in return.
+*
+* Note: This type extends ActivityStreams `Object` for practical
+* interoperability within ActivityPub federation, even though FEP-0837
+* defines `Proposal` as a pure ValueFlows type.  Extending `Object`
+* provides useful inherited properties such as `name`, `content`,
+* `attributedTo`, `published`, `to`, and `location` without needing to
+* redefine them.
+*/
+declare class Proposal extends Object$1 {
+  #private;
+  /**
+  * The type URI of {@link Proposal}: `https://w3id.org/valueflows/ont/vf#Proposal`.
+  */
+  static override get typeId(): URL;
+  /**
+  * Constructs a new instance of Proposal with the given values.
+  * @param values The values to initialize the instance with.
+  * @param options The options to use for initialization.
+  */
+  constructor(values: {
+    id?: URL | null;
+    attachments?: (Object$1 | Link | PropertyValue | URL)[];
+    attribution?: Application | Group | Organization | Person | Service | URL | null;
+    attributions?: (Application | Group | Organization | Person | Service | URL)[];
+    audience?: Object$1 | URL | null;
+    audiences?: (Object$1 | URL)[];
+    content?: string | LanguageString$1 | null;
+    contents?: ((string | LanguageString$1))[];
+    contexts?: (Object$1 | Link | URL)[];
+    name?: string | LanguageString$1 | null;
+    names?: ((string | LanguageString$1))[];
+    endTime?: Temporal.Instant | null;
+    generators?: (Object$1 | Link | URL)[];
+    icon?: Image | URL | null;
+    icons?: (Image | URL)[];
+    image?: Image | URL | null;
+    images?: (Image | URL)[];
+    replyTarget?: Object$1 | Link | URL | null;
+    replyTargets?: (Object$1 | Link | URL)[];
+    location?: Object$1 | Link | URL | null;
+    locations?: (Object$1 | Link | URL)[];
+    preview?: Link | Object$1 | URL | null;
+    previews?: (Link | Object$1 | URL)[];
+    published?: Temporal.Instant | null;
+    replies?: Collection | URL | null;
+    shares?: Collection | URL | null;
+    likes?: Collection | URL | null;
+    emojiReactions?: Collection | URL | null;
+    startTime?: Temporal.Instant | null;
+    summary?: string | LanguageString$1 | null;
+    summaries?: ((string | LanguageString$1))[];
+    tags?: (Object$1 | Link | URL)[];
+    updated?: Temporal.Instant | null;
+    url?: URL | Link | null;
+    urls?: ((URL | Link))[];
+    to?: Object$1 | URL | null;
+    tos?: (Object$1 | URL)[];
+    bto?: Object$1 | URL | null;
+    btos?: (Object$1 | URL)[];
+    cc?: Object$1 | URL | null;
+    ccs?: (Object$1 | URL)[];
+    bcc?: Object$1 | URL | null;
+    bccs?: (Object$1 | URL)[];
+    mediaType?: string | null;
+    duration?: Temporal.Duration | null;
+    sensitive?: boolean | null;
+    source?: Source | null;
+    proof?: DataIntegrityProof | URL | null;
+    proofs?: (DataIntegrityProof | URL)[];
+    interactionPolicy?: InteractionPolicy | null;
+    approvedBy?: URL | null;
+    likeAuthorization?: LikeAuthorization | URL | null;
+    replyAuthorization?: ReplyAuthorization | URL | null;
+    announceAuthorization?: AnnounceAuthorization | URL | null;
+    purpose?: string | null;
+    publishes?: Intent | null;
+    reciprocal?: Intent | null;
+    unitBased?: boolean | null;
+  }, options?: {
+    documentLoader?: DocumentLoader$1;
+    contextLoader?: DocumentLoader$1;
+    tracerProvider?: TracerProvider;
+  });
+  /**
+  * Clones this instance, optionally updating it with the given values.
+  * @param values The values to update the clone with.
+  * @param options The options to use for cloning.
+  * @returns The cloned instance.
+  */
+  override clone(values?: {
+    id?: URL | null;
+    attachments?: (Object$1 | Link | PropertyValue | URL)[];
+    attribution?: Application | Group | Organization | Person | Service | URL | null;
+    attributions?: (Application | Group | Organization | Person | Service | URL)[];
+    audience?: Object$1 | URL | null;
+    audiences?: (Object$1 | URL)[];
+    content?: string | LanguageString$1 | null;
+    contents?: ((string | LanguageString$1))[];
+    contexts?: (Object$1 | Link | URL)[];
+    name?: string | LanguageString$1 | null;
+    names?: ((string | LanguageString$1))[];
+    endTime?: Temporal.Instant | null;
+    generators?: (Object$1 | Link | URL)[];
+    icon?: Image | URL | null;
+    icons?: (Image | URL)[];
+    image?: Image | URL | null;
+    images?: (Image | URL)[];
+    replyTarget?: Object$1 | Link | URL | null;
+    replyTargets?: (Object$1 | Link | URL)[];
+    location?: Object$1 | Link | URL | null;
+    locations?: (Object$1 | Link | URL)[];
+    preview?: Link | Object$1 | URL | null;
+    previews?: (Link | Object$1 | URL)[];
+    published?: Temporal.Instant | null;
+    replies?: Collection | URL | null;
+    shares?: Collection | URL | null;
+    likes?: Collection | URL | null;
+    emojiReactions?: Collection | URL | null;
+    startTime?: Temporal.Instant | null;
+    summary?: string | LanguageString$1 | null;
+    summaries?: ((string | LanguageString$1))[];
+    tags?: (Object$1 | Link | URL)[];
+    updated?: Temporal.Instant | null;
+    url?: URL | Link | null;
+    urls?: ((URL | Link))[];
+    to?: Object$1 | URL | null;
+    tos?: (Object$1 | URL)[];
+    bto?: Object$1 | URL | null;
+    btos?: (Object$1 | URL)[];
+    cc?: Object$1 | URL | null;
+    ccs?: (Object$1 | URL)[];
+    bcc?: Object$1 | URL | null;
+    bccs?: (Object$1 | URL)[];
+    mediaType?: string | null;
+    duration?: Temporal.Duration | null;
+    sensitive?: boolean | null;
+    source?: Source | null;
+    proof?: DataIntegrityProof | URL | null;
+    proofs?: (DataIntegrityProof | URL)[];
+    interactionPolicy?: InteractionPolicy | null;
+    approvedBy?: URL | null;
+    likeAuthorization?: LikeAuthorization | URL | null;
+    replyAuthorization?: ReplyAuthorization | URL | null;
+    announceAuthorization?: AnnounceAuthorization | URL | null;
+    purpose?: string | null;
+    publishes?: Intent | null;
+    reciprocal?: Intent | null;
+    unitBased?: boolean | null;
+  }, options?: {
+    documentLoader?: DocumentLoader$1;
+    contextLoader?: DocumentLoader$1;
+  }): Proposal;
+  /** The type of proposal.  Possible values are `"offer"` and `"request"`.
+  */
+  get purpose(): string | null;
+  /** The primary intent of this proposal, describing what is being offered
+  * or requested.
+  */
+  get publishes(): Intent | null;
+  /** The reciprocal intent of this proposal, describing what is expected
+  * or offered in return.
+  */
+  get reciprocal(): Intent | null;
+  /** Indicates whether the quantities expressed in the proposal can be
+  * multiplied or not.  The default is `false`.
+  */
+  get unitBased(): boolean | null;
+  /**
+  * Converts this object to a JSON-LD structure.
+  * @param options The options to use.
+  *                - `format`: The format of the output: `compact` or
+  `expand`.
+  *                - `contextLoader`: The loader for remote JSON-LD contexts.
+  *                - `context`: The JSON-LD context to use.  Not applicable
+  when `format` is set to `'expand'`.
+  * @returns The JSON-LD representation of this object.
+  */
+  override toJsonLd(options?: {
+    format?: "compact" | "expand";
+    contextLoader?: DocumentLoader$1;
+    context?: string | Record<string, string> | (string | Record<string, string>)[];
+  }): Promise<unknown>;
+  protected override isCompactable(): boolean;
+  /**
+  * Converts a JSON-LD structure to an object of this type.
+  * @param json The JSON-LD structure to convert.
+  * @param options The options to use.
+  *                - `documentLoader`: The loader for remote JSON-LD documents.
+  *                - `contextLoader`: The loader for remote JSON-LD contexts.
+  *                - `tracerProvider`: The OpenTelemetry tracer provider to use.
+  *                  If omitted, the global tracer provider is used.
+  * @returns The object of this type.
+  * @throws {TypeError} If the given `json` is invalid.
+  */
+  static override fromJsonLd(json: unknown, options?: {
+    documentLoader?: DocumentLoader$1;
+    contextLoader?: DocumentLoader$1;
+    tracerProvider?: TracerProvider;
+    baseUrl?: URL;
+  }): Promise<Proposal>;
+  protected static __fromJsonLd__Proposal__(json: unknown, span: Span, options?: {
+    documentLoader?: DocumentLoader$1;
+    contextLoader?: DocumentLoader$1;
+    tracerProvider?: TracerProvider;
+    baseUrl?: URL;
+  }): Promise<Proposal>;
+  protected override _getCustomInspectProxy(): Record<string, unknown>;
+}
 /** Indicates that the `actor` accepts the `object`.  The `target` property can be
 * used in certain circumstances to indicate the context into which the `object`
 * has been accepted.
@@ -17479,4 +17899,4 @@ declare function getTypeId(object: Object$1 | Link | null): URL | null;
 */
 declare function getTypeId(object: Object$1 | Link | null | undefined): URL | null | undefined;
 //#endregion
-export { Accept, Activity, Actor, ActorTypeName, Add, Announce, AnnounceAuthorization, AnnounceRequest, Application, Arrive, Article, Audio, Block, ChatMessage, Collection, CollectionPage, Create, CryptographicKey, DataIntegrityProof, Delete, DidService, Dislike, Document, type DocumentLoader, Emoji, EmojiReact, Endpoints, Event, Export, FediverseHandle, Flag, Follow, GetActorHandleOptions, type GetUserAgentOptions, Group, Hashtag, Ignore, Image, InteractionPolicy, InteractionRule, IntransitiveActivity, Invite, Join, LanguageString, Leave, Like, LikeAuthorization, LikeRequest, Link, Listen, LookupObjectOptions, Mention, Move, Multikey, NormalizeActorHandleOptions, Note, Object$1 as Object, Offer, OrderedCollection, OrderedCollectionPage, Organization, PUBLIC_COLLECTION, Page, Person, Place, Profile, PropertyValue, Question, Read, Recipient, Reject, Relationship, type RemoteDocument, Remove, ReplyAuthorization, ReplyRequest, Service, Source, TentativeAccept, TentativeReject, Tombstone, Travel, TraverseCollectionOptions, Undo, Update, Video, View, getActorClassByTypeName, getActorHandle, getActorTypeName, getTypeId, isActor, isFediverseHandle, lookupObject, normalizeActorHandle, parseFediverseHandle, toAcctUrl, traverseCollection };
+export { Accept, Activity, Actor, ActorTypeName, Add, Announce, AnnounceAuthorization, AnnounceRequest, Application, Arrive, Article, Audio, Block, ChatMessage, Collection, CollectionPage, Create, CryptographicKey, DataIntegrityProof, Delete, DidService, Dislike, Document, type DocumentLoader, Emoji, EmojiReact, Endpoints, Event, Export, FediverseHandle, Flag, Follow, GetActorHandleOptions, type GetUserAgentOptions, Group, Hashtag, Ignore, Image, Intent, InteractionPolicy, InteractionRule, IntransitiveActivity, Invite, Join, LanguageString, Leave, Like, LikeAuthorization, LikeRequest, Link, Listen, LookupObjectOptions, Measure, Mention, Move, Multikey, NormalizeActorHandleOptions, Note, Object$1 as Object, Offer, OrderedCollection, OrderedCollectionPage, Organization, PUBLIC_COLLECTION, Page, Person, Place, Profile, PropertyValue, Proposal, Question, Read, Recipient, Reject, Relationship, type RemoteDocument, Remove, ReplyAuthorization, ReplyRequest, Service, Source, TentativeAccept, TentativeReject, Tombstone, Travel, TraverseCollectionOptions, Undo, Update, Video, View, getActorClassByTypeName, getActorHandle, getActorTypeName, getTypeId, isActor, isFediverseHandle, lookupObject, normalizeActorHandle, parseFediverseHandle, toAcctUrl, traverseCollection };