Cleanup, Documented Impose

client-tauri/src/utils/pdf-operations.ts

@@ -7,8 +7,7 @@ import { PdfFile } from "@stirling-pdf/shared-operations/src/wrappers/PdfFile"
 import * as pdfcpuWrapper from "@stirling-pdf/shared-operations/wasm/pdfcpu/pdfcpu-wrapper-browser.js";
 
 async function impose(params: ImposeParamsType): Promise<PdfFile> {
-    const paramsToUse = { ...params, pdfcpuWrapper: pdfcpuWrapper };
+    return SharedOperations.impose(params, pdfcpuWrapper);
-    return SharedOperations.impose(paramsToUse);
 }
 
 const toExport: OperationsType = {

server-node/src/utils/pdf-operations.ts

@@ -7,8 +7,7 @@ import { PdfFile } from "@stirling-pdf/shared-operations/src/wrappers/PdfFile"
 import * as pdfcpuWrapper from "@stirling-pdf/shared-operations/src/wasm/pdfcpu/pdfcpu-wrapper-node.js";
 
 async function impose(params: ImposeParamsType): Promise<PdfFile> {
-    const paramsToUse = { ...params, pdfcpuWrapper: pdfcpuWrapper };
+    return SharedOperations.impose(params, pdfcpuWrapper);
-    return SharedOperations.impose(paramsToUse);
 }
 
 const toExport: OperationsType = {

shared-operations/declarations/Action.d.ts

@@ -7,3 +7,15 @@ export interface Action {
 export interface WaitAction extends Action {
     values: { id: number }
 }
+
+export interface ExtractAction extends Action {
+    values: { indecies: string | number[] }
+}
+
+export interface ImposeAction extends Action {
+    values: { nup: number, format: string }
+}
+
+export interface WaitAction extends Action {
+    values: { id: number }
+}

shared-operations/src/functions/extractPages.ts

@@ -5,19 +5,19 @@ import { parsePageIndexSpecification } from './common/pageIndexesUtils'
 
 export type ExtractPagesParamsType = {
     file: PdfFile;
-    pageIndexes: string | number[];
+    pageIndecies: string | number[];
 }
 export async function extractPages(params: ExtractPagesParamsType): Promise<PdfFile> {
-    const { file, pageIndexes } = params;
+    const { file, pageIndecies: pageIndecies } = params;
     const pdfLibDocument = await file.pdfLibDocument;
 
-    var indexes = pageIndexes;
+    var indecies = pageIndecies;
 
-    if (!Array.isArray(indexes)) {
+    if (!Array.isArray(indecies)) {
-        indexes = parsePageIndexSpecification(indexes, pdfLibDocument.getPageCount());
+        indecies = parsePageIndexSpecification(indecies, pdfLibDocument.getPageCount());
     }
 
-    const newFile = await getPages(file, indexes);
+    const newFile = await getPages(file, indecies);
     newFile.filename += "_extractedPages"
     return newFile;
 }

shared-operations/src/functions/impose.ts

@@ -2,17 +2,16 @@ import { PdfFile, RepresentationType } from "../wrappers/PdfFile";
 
 export type ImposeParamsType = {
     file: PdfFile;
+    /** Accepted values are 2, 3, 4, 8, 9, 12, 16 - see: {@link https://pdfcpu.io/generate/nup.html#n-up-value} */
     nup: number;
+    /** A0-A10, other formats available - see: {@link https://pdfcpu.io/paper.html} */
     format: string;
 }
-export type ImposeParamsBaseType = {
+
-    file: PdfFile;
+/** PDF-Imposition, PDF-N-Up: Put multiple pages of the input document into a single page of the output document. - see: {@link https://en.wikipedia.org/wiki/N-up}  */
-    nup: number;
+export async function impose(params: ImposeParamsType, pdfcpuWrapper: any): Promise<PdfFile> {
-    format: string;
+    // https://pdfcpu.io/generate/nup.html
-    pdfcpuWrapper: any;
+    const uint8Array = await pdfcpuWrapper.oneToOne(
-}
-export async function impose(params: ImposeParamsBaseType): Promise<PdfFile> {
-    const uint8Array = await params.pdfcpuWrapper.oneToOne(
         [
             "pdfcpu.wasm",
             "nup",

shared-operations/src/index.ts

@@ -1,7 +1,7 @@
 
 import { arrangePages, ArrangePagesParamsType } from './functions/arrangePages'
 import { extractPages, ExtractPagesParamsType } from "./functions/extractPages";
-import { impose, ImposeParamsBaseType, ImposeParamsType } from "./functions/impose";
+import { impose, ImposeParamsType } from "./functions/impose";
 import { mergePDFs, MergeParamsType } from './functions/mergePDFs';
 import { removeBlankPages, RemoveBlankPagesParamsType } from "./functions/removeBlankPages";
 import { rotatePages, RotateParamsType } from './functions/rotatePages';
@@ -34,7 +34,7 @@ export default toExport;
 export type OperationsParametersBaseType = {
     arrangePages: ArrangePagesParamsType
     extractPages: ExtractPagesParamsType;
-    impose: ImposeParamsBaseType;
+    impose: ImposeParamsType;
     mergePDFs: MergeParamsType;
     removeBlankPages: RemoveBlankPagesParamsType;
     rotatePages: RotateParamsType;

shared-operations/src/workflow/traverseOperations.ts

@@ -54,7 +54,7 @@ export async function * traverseOperations(operations: Action[], input: PdfFile[
                 break;
             case "extract":
                 yield* nToN(input, action, async (input) => {
-                    const newPdf = await Operations.extractPages({file: input, pageIndexes: action.values["pageIndexes"]});
+                    const newPdf = await Operations.extractPages({file: input, pageIndecies: action.values["pageIndecies"]});
                     return newPdf;
                 });
                 break;