@evenicanpm/portal-dms-adapaters 1.6.0 → 1.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@evenicanpm/portal-dms-adapaters",
-	"version": "1.6.0",
+	"version": "1.8.0",
 	"description": "",
 	"license": "ISC",
 	"author": "",
@@ -23,8 +23,8 @@
 		"typescript": "^5.6.3"
 	},
 	"dependencies": {
-		"@evenicanpm/storefront-portal-types-schemas": "*",
+		"@evenicanpm/portal-types-schemas": "^1.8.0",
 		"zod": "^3.0.0"
 	},
-	"gitHead": "9b18fe6294cc0e57332ec8703825a609ac7b73b2"
+	"gitHead": "485f77c5cce7c36849fb9d416d1e503d0f9299a3"
 }

package/src/paperless/client.ts

@@ -4,7 +4,7 @@
  * @category dms-provider
  * Pure functions for extracting data from paperless-ngx
  */
-import type { TableViewParams } from "@evenicanpm/storefront-portal-types-schemas";
+import type { TableViewParams } from "@evenicanpm/portal-types-schemas";
 
 /**
  * Paperless-Specific document config parameters.
@@ -149,7 +149,7 @@ export const buildCustomFieldsRequest = (input: {
  */
 interface PaperlessMapperInput {
 	/**
-	 * TableViewParams - The params that the portal-ui/feature/table generates
+	 * TableViewParams - The params that the portal-table-ui/feature/table generates
 	 * from the view.
 	 */
 	params: TableViewParams;

package/dist/index.d.ts

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

package/dist/paperless/client.d.ts

@@ -1,108 +0,0 @@
-/**
- *
- * @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

@@ -1,14 +0,0 @@
-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;
-};