@fedify/vocab-runtime 2.3.0-dev.994 → 2.3.0-pr.809.36

package/dist/mod.d.cts

@@ -1,4 +1,6 @@
+/// <reference lib="esnext.temporal" />
 import { Logger } from "@logtape/logtape";
+import { TracerProvider } from "@opentelemetry/api";
 
 //#region src/contexts.d.ts
 declare const preloadedContexts: Record<string, unknown>;
@@ -421,6 +423,39 @@ declare function decodeMultibase(data: Uint8Array | string): Uint8Array;
 */
 declare function encodingFromBaseData(data: string | Uint8Array): Base;
 //#endregion
+//#region src/preprocessor.d.ts
+/**
+* JSON value shape passed to property preprocessors.
+* @since 2.3.0
+*/
+type Json = string | number | boolean | null | readonly Json[] | {
+  readonly [key: string]: Json;
+};
+/**
+* Runtime context provided to property preprocessors.
+* @since 2.3.0
+*/
+interface PropertyPreprocessorContext {
+  /** Loader for remote JSON-LD documents. */
+  documentLoader?: DocumentLoader;
+  /** Loader for remote JSON-LD contexts. */
+  contextLoader?: DocumentLoader;
+  /** OpenTelemetry tracer provider for instrumentation. */
+  tracerProvider?: TracerProvider;
+  /** Base URL for resolving relative references. */
+  baseUrl?: URL;
+}
+/**
+* Function signature for schema-configured property preprocessors.
+*
+* Receives an expanded JSON-LD property value and returns a vocabulary
+* object when the value is handled, `undefined` when the value should
+* fall through to the normal range decoder, or an `Error` when the value
+* is recognized but cannot be converted.
+* @since 2.3.0
+*/
+type PropertyPreprocessor<T = unknown> = (value: Json, context: PropertyPreprocessorContext) => T | undefined | Error | Promise<T | undefined | Error>;
+//#endregion
 //#region src/url.d.ts
 declare class UrlError extends Error {
   constructor(message: string);
@@ -433,4 +468,4 @@ declare function isValidPublicIPv4Address(address: string): boolean;
 declare function isValidPublicIPv6Address(address: string): boolean;
 declare function expandIPv6Address(address: string): string;
 //#endregion
-export { type AuthenticatedDocumentLoaderFactory, type CreateRequestOptions, type Decimal, type DocumentLoader, type DocumentLoaderFactory, type DocumentLoaderFactoryOptions, type DocumentLoaderOptions, FetchError, type GetDocumentLoaderOptions, type GetUserAgentOptions, LanguageString, type RemoteDocument, UrlError, canParseDecimal, createActivityPubRequest, decodeMultibase, encodeMultibase, encodingFromBaseData, expandIPv6Address, exportMultibaseKey, exportSpki, getDocumentLoader, getRemoteDocument, getUserAgent, importMultibaseKey, importPem, importPkcs1, importSpki, isDecimal, isValidPublicIPv4Address, isValidPublicIPv6Address, logRequest, parseDecimal, preloadedContexts, validatePublicUrl };
+export { type AuthenticatedDocumentLoaderFactory, type CreateRequestOptions, type Decimal, type DocumentLoader, type DocumentLoaderFactory, type DocumentLoaderFactoryOptions, type DocumentLoaderOptions, FetchError, type GetDocumentLoaderOptions, type GetUserAgentOptions, type Json, LanguageString, type PropertyPreprocessor, type PropertyPreprocessorContext, type RemoteDocument, UrlError, canParseDecimal, createActivityPubRequest, decodeMultibase, encodeMultibase, encodingFromBaseData, expandIPv6Address, exportMultibaseKey, exportSpki, getDocumentLoader, getRemoteDocument, getUserAgent, importMultibaseKey, importPem, importPkcs1, importSpki, isDecimal, isValidPublicIPv4Address, isValidPublicIPv6Address, logRequest, parseDecimal, preloadedContexts, validatePublicUrl };

package/dist/mod.d.ts

@@ -1,4 +1,6 @@
+/// <reference lib="esnext.temporal" />
 import { Logger } from "@logtape/logtape";
+import { TracerProvider } from "@opentelemetry/api";
 
 //#region src/contexts.d.ts
 declare const preloadedContexts: Record<string, unknown>;
@@ -421,6 +423,39 @@ declare function decodeMultibase(data: Uint8Array | string): Uint8Array;
 */
 declare function encodingFromBaseData(data: string | Uint8Array): Base;
 //#endregion
+//#region src/preprocessor.d.ts
+/**
+* JSON value shape passed to property preprocessors.
+* @since 2.3.0
+*/
+type Json = string | number | boolean | null | readonly Json[] | {
+  readonly [key: string]: Json;
+};
+/**
+* Runtime context provided to property preprocessors.
+* @since 2.3.0
+*/
+interface PropertyPreprocessorContext {
+  /** Loader for remote JSON-LD documents. */
+  documentLoader?: DocumentLoader;
+  /** Loader for remote JSON-LD contexts. */
+  contextLoader?: DocumentLoader;
+  /** OpenTelemetry tracer provider for instrumentation. */
+  tracerProvider?: TracerProvider;
+  /** Base URL for resolving relative references. */
+  baseUrl?: URL;
+}
+/**
+* Function signature for schema-configured property preprocessors.
+*
+* Receives an expanded JSON-LD property value and returns a vocabulary
+* object when the value is handled, `undefined` when the value should
+* fall through to the normal range decoder, or an `Error` when the value
+* is recognized but cannot be converted.
+* @since 2.3.0
+*/
+type PropertyPreprocessor<T = unknown> = (value: Json, context: PropertyPreprocessorContext) => T | undefined | Error | Promise<T | undefined | Error>;
+//#endregion
 //#region src/url.d.ts
 declare class UrlError extends Error {
   constructor(message: string);
@@ -433,4 +468,4 @@ declare function isValidPublicIPv4Address(address: string): boolean;
 declare function isValidPublicIPv6Address(address: string): boolean;
 declare function expandIPv6Address(address: string): string;
 //#endregion
-export { type AuthenticatedDocumentLoaderFactory, type CreateRequestOptions, type Decimal, type DocumentLoader, type DocumentLoaderFactory, type DocumentLoaderFactoryOptions, type DocumentLoaderOptions, FetchError, type GetDocumentLoaderOptions, type GetUserAgentOptions, LanguageString, type RemoteDocument, UrlError, canParseDecimal, createActivityPubRequest, decodeMultibase, encodeMultibase, encodingFromBaseData, expandIPv6Address, exportMultibaseKey, exportSpki, getDocumentLoader, getRemoteDocument, getUserAgent, importMultibaseKey, importPem, importPkcs1, importSpki, isDecimal, isValidPublicIPv4Address, isValidPublicIPv6Address, logRequest, parseDecimal, preloadedContexts, validatePublicUrl };
+export { type AuthenticatedDocumentLoaderFactory, type CreateRequestOptions, type Decimal, type DocumentLoader, type DocumentLoaderFactory, type DocumentLoaderFactoryOptions, type DocumentLoaderOptions, FetchError, type GetDocumentLoaderOptions, type GetUserAgentOptions, type Json, LanguageString, type PropertyPreprocessor, type PropertyPreprocessorContext, type RemoteDocument, UrlError, canParseDecimal, createActivityPubRequest, decodeMultibase, encodeMultibase, encodingFromBaseData, expandIPv6Address, exportMultibaseKey, exportSpki, getDocumentLoader, getRemoteDocument, getUserAgent, importMultibaseKey, importPem, importPkcs1, importSpki, isDecimal, isValidPublicIPv4Address, isValidPublicIPv6Address, logRequest, parseDecimal, preloadedContexts, validatePublicUrl };