@brifle/brifle-sdk 0.0.2

package/dist/index.d.ts

@@ -0,0 +1,309 @@
+import { AxiosError } from 'axios';
+
+declare class ApiResponse<ResponseType> {
+    private _data?;
+    private _error?;
+    private constructor();
+    /**
+     * create a success response from data
+     * @param data - The data to return
+     */
+    static success<ResponseType>(data: ResponseType): ApiResponse<ResponseType>;
+    /**
+     * create an error response from an AxiosError
+     * @param error - The AxiosError object
+     */
+    static error<ResponseType>(error: ErrorResponse): ApiResponse<ResponseType>;
+    /**
+     * create an error response from an AxiosError
+     * @param error - The AxiosError object
+     */
+    static errorAxios<ResponseType>(error: AxiosError): ApiResponse<ResponseType>;
+    /**
+     * check if the response is a success
+     */
+    get isSuccess(): boolean;
+    /**
+     * check if the response is an error
+     */
+    get isError(): boolean;
+    /**
+     * get the data from the response
+     */
+    get data(): ResponseType | undefined;
+    /**
+     * get the error from the response
+     */
+    get error(): ErrorResponse | undefined;
+}
+interface ErrorResponse {
+    code: number;
+    message: string;
+    status: number;
+}
+
+interface LoginRequest {
+    key: string;
+    secret: string;
+}
+interface LogoutRequest {
+    token: string;
+}
+
+interface LoginResponse {
+    access_token: string;
+    created_at: string;
+    expires_in: number;
+    refresh_token: string;
+    token_type: string;
+    scope: string;
+}
+
+declare class AuthenticationEndpoints {
+    private endpoint;
+    private readonly VERSION;
+    private state;
+    constructor(api: ApiV1);
+    /**
+     * builds the full path
+     * @param path - The path to the endpoint, e.g. "authentication/login"
+     * @returns
+     */
+    private getPath;
+    /**
+     * login to the API
+     * @param loginRequest - The login request object
+     * @returns the login response object
+     */
+    login(loginRequest: LoginRequest): Promise<ApiResponse<LoginResponse>>;
+}
+
+interface SendContentResponse {
+    id: string;
+}
+interface CheckReceiverResponse {
+    receiver: {
+        type: string;
+    };
+}
+interface ContentMeta {
+    delivered: boolean;
+    delivered_date: string;
+    read: boolean;
+    read_date: string;
+    receiver?: string;
+    sender?: string;
+    receiver_state?: 'unread' | 'read' | 'archived' | 'trashed' | 'deleted' | 'pending';
+    sender_state?: 'activate' | 'activated' | 'trashed' | 'deleted' | 'pending';
+    sent_date: string;
+    size: number;
+    subject: string;
+    type: string;
+}
+interface ContentResponse {
+    content: {
+        content: string;
+        type: string;
+    };
+    meta: ContentMeta;
+}
+interface ContentActionsPaymentResponse {
+    details: {
+        amount: number;
+        currency: string;
+        due_date: string;
+        market: string;
+        reference: string;
+        iban: string;
+        tink_payment_id: string;
+    };
+    link: string;
+}
+interface ContentActionsSignatureResponse {
+    document_signatures: {
+        signature_ids: string[];
+        signature_reference: string;
+    };
+    embedded_signatures: {
+        created_by: string;
+        created_date: string;
+        document_signature_id: string;
+        due_date: string;
+        field_name: string;
+        history?: string;
+        purpose: string;
+        request_date: string;
+        requested_to: string;
+        signature_date: string;
+        signed_by: string;
+        signed_for: string;
+        value: string;
+    }[];
+    signature_reference: string;
+}
+interface ContentActionsResponse {
+    payments: ContentActionsPaymentResponse[];
+    signatures: ContentActionsSignatureResponse[];
+}
+
+interface ReceiverRequest {
+    account_id?: string;
+    birth_information?: BirthInformation;
+    email?: string;
+    tel?: string;
+    vad_id?: string;
+    ssn?: string;
+    first_name?: string;
+    last_name?: string;
+    full_name?: string;
+    date_of_birth?: string;
+}
+interface BirthInformation {
+    birth_name?: string;
+    date_of_birth: string;
+    place_of_birth: string;
+    nationality?: string;
+    given_names?: string;
+    last_name?: string;
+    postaL_address?: string;
+}
+interface PaymentDetails {
+    amount: number;
+    currency: 'EUR';
+    description: string;
+    due_date: string;
+    iban: string;
+    reference: string;
+}
+interface SendContentRequest {
+    to: ReceiverRequest;
+    type: 'letter' | 'invoice' | 'contract';
+    subject: string;
+    body: {
+        type: 'application/pdf';
+        content: string;
+    }[];
+    payment_info?: {
+        details?: PaymentDetails;
+        payable: boolean;
+    };
+    signature_info?: {
+        signature_reference: string;
+        requesting_signer: {
+            field: string;
+            signer: 'sender' | 'receiver';
+        }[];
+    };
+}
+
+declare class ContentEndpoints {
+    private endpoint;
+    private readonly VERSION;
+    private state;
+    constructor(api: ApiV1);
+    /**
+     * builds the full path
+     * @param path - The path to the endpoint, e.g. "authentication/login"
+     * @returns
+     */
+    private getPath;
+    /**
+     * get the content of a document
+     * @param documentId - The id of the document
+     * @returns the content of the document
+     */
+    getContent(documentId: string): Promise<ApiResponse<ContentResponse>>;
+    /**
+     * get the actions of a document
+     * @param documentId - The id of the document
+     * @returns the actions of the document
+     */
+    getContentActions(documentId: string): Promise<ApiResponse<ContentActionsResponse>>;
+    /**
+     * checks if a receiver is existing in Brifle
+     * @param receiver - The receiver object to check
+     * @returns
+     */
+    checkReceiver(receiver: ReceiverRequest): Promise<ApiResponse<CheckReceiverResponse>>;
+    /**
+     * send a content to a receiver
+     * @param tenantId - The tenant id of the receiver
+     * @param request - The request object to send
+     * @returns
+     */
+    sendContent(tenantId: string, request: SendContentRequest): Promise<ApiResponse<SendContentResponse>>;
+}
+
+interface CreateSignatureReferenceRequest {
+    fields: {
+        name: string;
+        purpose: string;
+        role: string;
+    }[];
+}
+
+interface CreateSignatureReferenceResponse {
+    id: string;
+    managed_by: string;
+    signature_fields: {
+        name: string;
+        purpose: string;
+        role: string;
+    }[];
+}
+
+declare class SignaturesEndpoint {
+    private endpoint;
+    private readonly VERSION;
+    private state;
+    constructor(api: ApiV1);
+    /**
+     * builds the full path
+     * @param path - The path to the endpoint, e.g. "authentication/login"
+     * @returns
+     */
+    private getPath;
+    /**
+     * creates a signature reference
+     * @param tenantId - The id of the tenant
+     * @param request - The request object
+     * @returns the response object
+     */
+    createSignatureReference(tenantId: string, request: CreateSignatureReferenceRequest): Promise<ApiResponse<CreateSignatureReferenceResponse>>;
+    /**
+     * gets a signature reference
+     * @param signatureId - The id of the signature
+     * @returns the response object
+     */
+    exportSignature(signatureId: string, format: 'xml'): Promise<ApiResponse<any>>;
+}
+
+declare class ApiV1 {
+    readonly endpoint: string;
+    readonly apiState: ApiV1State;
+    constructor(endpoint: string);
+    static get sandbox(): ApiV1;
+    static get production(): ApiV1;
+    /**
+     * gets an instance of the AuthenticationEndpoints
+     * @returns AuthenticationEndpoints
+     */
+    authentication(): AuthenticationEndpoints;
+    /**
+     * gets an instance of the ContentEndpoints
+     * @returns ContentEndpoints
+     */
+    content(): ContentEndpoints;
+    /**
+     * gets an instance of the SignatureEndpoints
+     * @returns ContentEndpoints
+     */
+    signature(): SignaturesEndpoint;
+}
+interface ApiV1State {
+    auth_token?: string;
+    auth_token_expire_date?: Date;
+}
+
+export { ApiResponse, ApiV1, AuthenticationEndpoints, ContentEndpoints, SignaturesEndpoint };
+export type { ApiV1State, BirthInformation, CheckReceiverResponse, ContentActionsResponse, ContentMeta, ContentResponse, CreateSignatureReferenceRequest, CreateSignatureReferenceResponse, ErrorResponse, LoginRequest, LoginResponse, LogoutRequest, PaymentDetails, ReceiverRequest, SendContentRequest, SendContentResponse };

package/dist/types/api/api.d.ts

@@ -0,0 +1,30 @@
+import { AuthenticationEndpoints } from "../endpoints/v1/authentication";
+import { ContentEndpoints } from "../endpoints/v1/content";
+import { SignaturesEndpoint } from "../endpoints/v1/signatures";
+declare class ApiV1 {
+    readonly endpoint: string;
+    readonly apiState: ApiV1State;
+    constructor(endpoint: string);
+    static get sandbox(): ApiV1;
+    static get production(): ApiV1;
+    /**
+     * gets an instance of the AuthenticationEndpoints
+     * @returns AuthenticationEndpoints
+     */
+    authentication(): AuthenticationEndpoints;
+    /**
+     * gets an instance of the ContentEndpoints
+     * @returns ContentEndpoints
+     */
+    content(): ContentEndpoints;
+    /**
+     * gets an instance of the SignatureEndpoints
+     * @returns ContentEndpoints
+     */
+    signature(): SignaturesEndpoint;
+}
+export interface ApiV1State {
+    auth_token?: string;
+    auth_token_expire_date?: Date;
+}
+export { ApiV1 };

package/dist/types/endpoints/v1/apiResponse.d.ts

@@ -0,0 +1,42 @@
+import { AxiosError } from "axios";
+export declare class ApiResponse<ResponseType> {
+    private _data?;
+    private _error?;
+    private constructor();
+    /**
+     * create a success response from data
+     * @param data - The data to return
+     */
+    static success<ResponseType>(data: ResponseType): ApiResponse<ResponseType>;
+    /**
+     * create an error response from an AxiosError
+     * @param error - The AxiosError object
+     */
+    static error<ResponseType>(error: ErrorResponse): ApiResponse<ResponseType>;
+    /**
+     * create an error response from an AxiosError
+     * @param error - The AxiosError object
+     */
+    static errorAxios<ResponseType>(error: AxiosError): ApiResponse<ResponseType>;
+    /**
+     * check if the response is a success
+     */
+    get isSuccess(): boolean;
+    /**
+     * check if the response is an error
+     */
+    get isError(): boolean;
+    /**
+     * get the data from the response
+     */
+    get data(): ResponseType | undefined;
+    /**
+     * get the error from the response
+     */
+    get error(): ErrorResponse | undefined;
+}
+export interface ErrorResponse {
+    code: number;
+    message: string;
+    status: number;
+}

package/dist/types/endpoints/v1/authentication.d.ts

@@ -0,0 +1,23 @@
+import { ApiV1 } from "../../api/api";
+import { ApiResponse } from "./apiResponse";
+import { LoginRequest } from "./requests/authentication";
+import { LoginResponse } from "./responses/authentication";
+declare class AuthenticationEndpoints {
+    private endpoint;
+    private readonly VERSION;
+    private state;
+    constructor(api: ApiV1);
+    /**
+     * builds the full path
+     * @param path - The path to the endpoint, e.g. "authentication/login"
+     * @returns
+     */
+    private getPath;
+    /**
+     * login to the API
+     * @param loginRequest - The login request object
+     * @returns the login response object
+     */
+    login(loginRequest: LoginRequest): Promise<ApiResponse<LoginResponse>>;
+}
+export { AuthenticationEndpoints };

package/dist/types/endpoints/v1/content.d.ts

@@ -0,0 +1,42 @@
+import { ApiResponse } from "./apiResponse";
+import { CheckReceiverResponse, ContentActionsResponse, ContentResponse, SendContentResponse } from "./responses/content";
+import { ApiV1 } from "../../api/api";
+import { ReceiverRequest, SendContentRequest } from "./requests/content";
+declare class ContentEndpoints {
+    private endpoint;
+    private readonly VERSION;
+    private state;
+    constructor(api: ApiV1);
+    /**
+     * builds the full path
+     * @param path - The path to the endpoint, e.g. "authentication/login"
+     * @returns
+     */
+    private getPath;
+    /**
+     * get the content of a document
+     * @param documentId - The id of the document
+     * @returns the content of the document
+     */
+    getContent(documentId: string): Promise<ApiResponse<ContentResponse>>;
+    /**
+     * get the actions of a document
+     * @param documentId - The id of the document
+     * @returns the actions of the document
+     */
+    getContentActions(documentId: string): Promise<ApiResponse<ContentActionsResponse>>;
+    /**
+     * checks if a receiver is existing in Brifle
+     * @param receiver - The receiver object to check
+     * @returns
+     */
+    checkReceiver(receiver: ReceiverRequest): Promise<ApiResponse<CheckReceiverResponse>>;
+    /**
+     * send a content to a receiver
+     * @param tenantId - The tenant id of the receiver
+     * @param request - The request object to send
+     * @returns
+     */
+    sendContent(tenantId: string, request: SendContentRequest): Promise<ApiResponse<SendContentResponse>>;
+}
+export { ContentEndpoints };

package/dist/types/endpoints/v1/requests/authentication.d.ts

@@ -0,0 +1,7 @@
+export interface LoginRequest {
+    key: string;
+    secret: string;
+}
+export interface LogoutRequest {
+    token: string;
+}

package/dist/types/endpoints/v1/requests/content.d.ts

@@ -0,0 +1,50 @@
+interface ReceiverRequest {
+    account_id?: string;
+    birth_information?: BirthInformation;
+    email?: string;
+    tel?: string;
+    vad_id?: string;
+    ssn?: string;
+    first_name?: string;
+    last_name?: string;
+    full_name?: string;
+    date_of_birth?: string;
+}
+interface BirthInformation {
+    birth_name?: string;
+    date_of_birth: string;
+    place_of_birth: string;
+    nationality?: string;
+    given_names?: string;
+    last_name?: string;
+    postaL_address?: string;
+}
+interface PaymentDetails {
+    amount: number;
+    currency: 'EUR';
+    description: string;
+    due_date: string;
+    iban: string;
+    reference: string;
+}
+interface SendContentRequest {
+    to: ReceiverRequest;
+    type: 'letter' | 'invoice' | 'contract';
+    subject: string;
+    body: {
+        type: 'application/pdf';
+        content: string;
+    }[];
+    payment_info?: {
+        details?: PaymentDetails;
+        payable: boolean;
+    };
+    signature_info?: {
+        signature_reference: string;
+        requesting_signer: {
+            field: string;
+            signer: 'sender' | 'receiver';
+        }[];
+    };
+}
+export type { SendContentRequest, ReceiverRequest, BirthInformation, PaymentDetails };

package/dist/types/endpoints/v1/requests/signatures.d.ts

@@ -0,0 +1,8 @@
+interface CreateSignatureReferenceRequest {
+    fields: {
+        name: string;
+        purpose: string;
+        role: string;
+    }[];
+}
+export type { CreateSignatureReferenceRequest };

package/dist/types/endpoints/v1/responses/authentication.d.ts

@@ -0,0 +1,8 @@
+export interface LoginResponse {
+    access_token: string;
+    created_at: string;
+    expires_in: number;
+    refresh_token: string;
+    token_type: string;
+    scope: string;
+}

package/dist/types/endpoints/v1/responses/content.d.ts

@@ -0,0 +1,68 @@
+interface SendContentResponse {
+    id: string;
+}
+interface CheckReceiverResponse {
+    receiver: {
+        type: string;
+    };
+}
+interface ContentMeta {
+    delivered: boolean;
+    delivered_date: string;
+    read: boolean;
+    read_date: string;
+    receiver?: string;
+    sender?: string;
+    receiver_state?: 'unread' | 'read' | 'archived' | 'trashed' | 'deleted' | 'pending';
+    sender_state?: 'activate' | 'activated' | 'trashed' | 'deleted' | 'pending';
+    sent_date: string;
+    size: number;
+    subject: string;
+    type: string;
+}
+interface ContentResponse {
+    content: {
+        content: string;
+        type: string;
+    };
+    meta: ContentMeta;
+}
+interface ContentActionsPaymentResponse {
+    details: {
+        amount: number;
+        currency: string;
+        due_date: string;
+        market: string;
+        reference: string;
+        iban: string;
+        tink_payment_id: string;
+    };
+    link: string;
+}
+interface ContentActionsSignatureResponse {
+    document_signatures: {
+        signature_ids: string[];
+        signature_reference: string;
+    };
+    embedded_signatures: {
+        created_by: string;
+        created_date: string;
+        document_signature_id: string;
+        due_date: string;
+        field_name: string;
+        history?: string;
+        purpose: string;
+        request_date: string;
+        requested_to: string;
+        signature_date: string;
+        signed_by: string;
+        signed_for: string;
+        value: string;
+    }[];
+    signature_reference: string;
+}
+interface ContentActionsResponse {
+    payments: ContentActionsPaymentResponse[];
+    signatures: ContentActionsSignatureResponse[];
+}
+export type { SendContentResponse, CheckReceiverResponse, ContentMeta, ContentResponse, ContentActionsResponse };

package/dist/types/endpoints/v1/responses/signatures.d.ts

@@ -0,0 +1,10 @@
+interface CreateSignatureReferenceResponse {
+    id: string;
+    managed_by: string;
+    signature_fields: {
+        name: string;
+        purpose: string;
+        role: string;
+    }[];
+}
+export type { CreateSignatureReferenceResponse };

package/dist/types/endpoints/v1/signatures.d.ts

@@ -0,0 +1,30 @@
+import { ApiV1 } from "../../api/api";
+import { CreateSignatureReferenceRequest } from "./requests/signatures";
+import { ApiResponse } from "./apiResponse";
+import { CreateSignatureReferenceResponse } from "./responses/signatures";
+declare class SignaturesEndpoint {
+    private endpoint;
+    private readonly VERSION;
+    private state;
+    constructor(api: ApiV1);
+    /**
+     * builds the full path
+     * @param path - The path to the endpoint, e.g. "authentication/login"
+     * @returns
+     */
+    private getPath;
+    /**
+     * creates a signature reference
+     * @param tenantId - The id of the tenant
+     * @param request - The request object
+     * @returns the response object
+     */
+    createSignatureReference(tenantId: string, request: CreateSignatureReferenceRequest): Promise<ApiResponse<CreateSignatureReferenceResponse>>;
+    /**
+     * gets a signature reference
+     * @param signatureId - The id of the signature
+     * @returns the response object
+     */
+    exportSignature(signatureId: string, format: 'xml'): Promise<ApiResponse<any>>;
+}
+export { SignaturesEndpoint };

package/dist/types/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./api/api";
+export * from "./endpoints/v1/requests/authentication";
+export * from "./endpoints/v1/responses/authentication";
+export * from "./endpoints/v1/requests/content";
+export * from "./endpoints/v1/responses/content";
+export * from "./endpoints/v1/requests/signatures";
+export * from "./endpoints/v1/responses/signatures";
+export * from "./endpoints/v1/apiResponse";
+export * from "./endpoints/v1/authentication";
+export * from "./endpoints/v1/content";
+export * from "./endpoints/v1/signatures";

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@brifle/brifle-sdk",
+  "version": "0.0.2",
+  "description": "The JavaScript SDK to interact with the API of Brifle",
+  "files": [
+    "dist",
+    "README",
+    "LICENSE"
+  ],
+  "type": "module",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.mjs",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.mjs",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "jest --setupFiles dotenv/config",
+    "test-jest": "jest",
+    "rollup": "tsc --project tsconfig.types.json && rollup -c",
+    "build": "tsc",
+    "publish": "npm run rollup && npm publish --access public"
+  },
+  "keywords": [
+    "Brifle"
+  ],
+  "author": "Brifle GmbH",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.4.3",
+    "jest": "^29.5.0",
+    "rollup": "^4.40.0",
+    "rollup-plugin-dts": "^6.2.1",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "ts-jest": "^29.3.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "axios": "^1.8.4",
+    "dotenv": "^16.1.4"
+  }
+}