Files
jlinc-sdk-node/dist/index.d.ts
2026-04-21 19:19:56 +00:00

59 lines
2.0 KiB
TypeScript

export type JLINCConfig = {
debug?: boolean | undefined;
systemPrefix?: string | undefined;
defaultAgreementId?: string | undefined;
domain?: string | null | undefined;
dataStoreApiUrl?: string | null | undefined;
dataStoreApiKey?: string | null | undefined;
archiveApiUrl?: string | null | undefined;
archiveApiKey?: string | null | undefined;
};
export type JLINCProduceEventData = {
to?: string | undefined;
from?: string | undefined;
agreementId?: string | null | undefined;
payload?: any;
auth?: any;
};
export type JLINCProcessEventData = {
to?: string | undefined;
eventId?: string | undefined;
auth?: any;
};
export type JLINCProduceAgreementData = {
requiredSigners?: string[] | undefined;
signer?: string | undefined;
uri?: string | undefined;
purposes?: string[] | undefined;
caveats?: string[] | undefined;
validRoles?: string[] | undefined;
role?: string | undefined;
auth?: any;
};
export type JLINCProcessAgreementData = {
agreementId?: string | undefined;
signer?: string | undefined;
role?: string | undefined;
auth?: any;
};
/**
* @param {JLINCConfig} data - The configuration object for the application.
*/
export function jlincInit(data: JLINCConfig): void;
/**
* @param {JLINCProduceEventData} data - The data required for producing an event.
*/
export function jlincProduceEvent(data: JLINCProduceEventData): Promise<any>;
/**
* @param {JLINCProcessEventData} data - The data required for processing an event.
*/
export function jlincProcessEvent(data: JLINCProcessEventData): Promise<any>;
/**
* @param {JLINCProduceAgreementData} data - The data required for producing an agreement.
*/
export function jlincProduceAgreement(data: JLINCProduceAgreementData): Promise<any>;
/**
* @param {JLINCProcessAgreementData} data - The data required for processing an agreement.
*/
export function jlincProcessAgreement(data: JLINCProcessAgreementData): Promise<any>;