@evenicanpm/portal-dms-adapaters 1.4.0 → 1.6.0

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./paperless/client";
+export * from "./paperless/config";

package/dist/paperless/client.d.ts

@@ -0,0 +1,108 @@
+/**
+ *
+ * @module PaperlessProvider
+ * @category dms-provider
+ * Pure functions for extracting data from paperless-ngx
+ */
+import type { TableViewParams } from "@evenicanpm/storefront-portal-types-schemas";
+/**
+ * Paperless-Specific document config parameters.
+ */
+export interface PaperlessDocConfig {
+    /** Paperless uses type for broad category of document */
+    type: string;
+    /** Paperless tags */
+    tags: string[];
+    /** Property names to map back from papaless to the UI */
+    paperlessToPortalMap: Record<string, string>;
+}
+/**
+ * Configuration for Paperless Client
+ */
+export interface PaperlessClientConfig {
+    /** Credentials username */
+    username: string;
+    /** Credentials password */
+    password: string;
+    /** Base of paperless web-server */
+    baseUrl: string;
+    /** The endpoint prefix to fetch docs from paperless */
+    documentEndpoint: string;
+    tenantField: string;
+    customFieldsEndpoint: string;
+}
+/**
+ * Input for building a REST URL to fetch documents from Paperless
+ */
+interface PaperlessUrlInput {
+    config: PaperlessClientConfig;
+    params: TableViewParams;
+    paperlessParams: PaperlessDocConfig;
+    /** Property name to filter by for multi-tenancy so customer only sees their own docs */
+    customerId: string;
+    canViewAll: boolean;
+    docId?: string;
+}
+/**
+ *
+ * Builds URL for fetching documents from Paperless.
+ * Takes credentials, parameters and document settings and Builds
+ * a fetch-ready URL.
+ *
+ * @param PaperlessAuth Credentials for paperless basic auth.
+ *
+ */
+export declare const buildPaperlessRESTUrl: ({ config, params, paperlessParams, customerId, canViewAll, }: PaperlessUrlInput) => Request;
+/**
+ * Builds a fetch-ready request for downloading a single document
+ * from Paperless.
+ *
+ * Uses Paperless basic authentication and the provided document ID
+ * to construct the download endpoint URL and required headers.
+ *
+ * @param input.config Paperless configuration containing base URL and credentials
+ * @param input.docId  ID of the document to download
+ */
+export declare const buildPaperlessDownloadRequest: (input: {
+    config: PaperlessClientConfig;
+    docId: string;
+}) => Request;
+export declare const buildCustomFieldsRequest: (input: {
+    config: PaperlessClientConfig;
+}) => Request;
+interface PaperlessResponse {
+    /** an array with all id's of docs */
+    all?: number[];
+    /** Property name from paperless */
+    results: PaperlessDoc[];
+}
+export type PaperlessCustomFieldEntry = {
+    field: number;
+    value: unknown;
+    name?: string;
+};
+export interface PaperlessDoc {
+    id: string | number;
+    title: string;
+    created_date: string;
+    document_type: string;
+    customer_id: string;
+    custom_fields: PaperlessCustomFieldEntry[];
+}
+export type CustomFieldsMap = Record<number, string>;
+interface TransformPaperlessResponseInput {
+    paperlessResponse: PaperlessResponse;
+    customFieldsMap: Record<number, string>;
+    transformDoc: (data: PaperlessDoc, cfMap: Record<number, string>) => unknown;
+}
+/**
+ * TODO: CREATE ZOD SCHEMA FOR PAPERLESS RESPONSE
+ * TODO:
+ * @param
+ * @returns
+ */
+export declare const transformPaperlessResponse: ({ paperlessResponse: { results, all }, customFieldsMap, transformDoc, }: TransformPaperlessResponseInput) => {
+    data: unknown[];
+    items: number;
+};
+export {};

package/dist/paperless/config.d.ts

@@ -0,0 +1,14 @@
+import type { PaperlessClientConfig } from "./client";
+export declare const createPaperlessConfig: (input: {
+    username: string;
+    password: string;
+    baseUrl: string;
+    documentEndpoint?: string;
+    tenantField?: string;
+    customFieldsEndpoint?: string;
+}) => PaperlessClientConfig;
+export declare const createPaperlessAssets: (input?: {
+    logoUrl?: string;
+}) => {
+    logoUrl: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@evenicanpm/portal-dms-adapaters",
-	"version": "1.4.0",
+	"version": "1.6.0",
 	"description": "",
 	"license": "ISC",
 	"author": "",
@@ -13,6 +13,10 @@
 	"exports": {
 		".": "./src/index.ts"
 	},
+	"files": [
+		"dist",
+		"src"
+	],
 	"types": "./dist/index.d.ts",
 	"devDependencies": {
 		"@types/node": "^25.3.0",
@@ -22,5 +26,5 @@
 		"@evenicanpm/storefront-portal-types-schemas": "*",
 		"zod": "^3.0.0"
 	},
-	"gitHead": "0614726ec6b7ce9564706514a6b756b390a13e96"
+	"gitHead": "9b18fe6294cc0e57332ec8703825a609ac7b73b2"
 }

package/tsconfig.json

@@ -1,28 +0,0 @@
-{
-	"compilerOptions": {
-		"target": "ES6",
-		"useDefineForClassFields": true,
-		"lib": ["ES2022", "DOM", "DOM.Iterable"],
-		"module": "ESNext",
-		"moduleResolution": "bundler",
-		"sourceMap": true,
-		"esModuleInterop": true,
-		"skipLibCheck": true,
-		"declaration": true,
-		"preserveSymlinks": true,
-		"resolveJsonModule": true,
-		"isolatedModules": true,
-		"emitDeclarationOnly": true,
-		"jsx": "preserve",
-		"strict": true,
-		"noUnusedLocals": true,
-		"noUnusedParameters": true,
-		"noFallthroughCasesInSwitch": true,
-		"allowJs": true,
-		"forceConsistentCasingInFileNames": true,
-		"incremental": true,
-		"rootDir": "./src",
-		"outDir": "./dist"
-	},
-	"include": ["src"]
-}