extract, comma seperated list fields in Joi & genericField

This commit is contained in:
Felix Kaspar 2024-05-12 20:54:34 +02:00
parent 534a7776cf
commit a91dd0e502
7 changed files with 85 additions and 102 deletions

View File

@ -1,64 +0,0 @@
module.exports = {
"env": {
"browser": true,
"es2021": true
},
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/strict-type-checked",
"plugin:@typescript-eslint/stylistic-type-checked"
],
"overrides": [
{
"env": {
"node": true
},
"files": [
".eslintrc.{js,cjs}"
],
"parserOptions": {
"sourceType": "script"
}
}
],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": "latest",
"sourceType": "module",
"project": [
"./client-tauri/tsconfig.json",
"./server-node/tsconfig.json",
"./shared-operations/tsconfig.json"
]
},
"plugins": [
"@typescript-eslint"
],
"ignorePatterns": [
"node_modules/",
"**/*.js",
"**/*.jsx"
],
"rules": {
"indent": [
"error",
4
],
"linebreak-style": [
"error",
"unix"
],
"quotes": [
"error",
"double"
],
"semi": [
"error",
"always",
{
"omitLastInOneLineBlock": true,
"omitLastInOneLineClassBody": true
}
]
}
};

View File

@ -2,18 +2,25 @@ import Joi from "@stirling-tools/joi";
import { Fragment } from "react";
interface GenericFieldProps {
fieldName: string
joiDefinition: Joi.Description;
fieldName: string,
joiDefinition: Joi.Description
}
interface Flags {
label: string,
description: string,
}
export function GenericField({ fieldName, joiDefinition }: GenericFieldProps) {
const flags = joiDefinition.flags as Flags;
switch (joiDefinition.type) {
case "number":
var validValues = joiDefinition.allow;
if(validValues) { // Restrained text input
if(validValues) { // Restrained number input
return (
<Fragment>
<label htmlFor={fieldName}>{fieldName}:</label>
<label htmlFor={fieldName}>{flags.label}:</label>
<input type="number" list={fieldName} name={fieldName}/>
<datalist id={fieldName}>
{joiDefinition.allow.map((e: string) => {
@ -24,17 +31,22 @@ export function GenericField({ fieldName, joiDefinition }: GenericFieldProps) {
</Fragment>
);
}
else {
// TODO: Implement unrestrained text input
return (<pre>{JSON.stringify(joiDefinition, null, 2)}</pre>)
else { // Unrestrained number input
// TODO: Check if integer or not.
return (
<Fragment>
<label htmlFor={fieldName}>{flags.label}:</label>
<input type="number" list={fieldName} name={fieldName}/>
<br/>
</Fragment>
);
}
break;
case "string":
var validValues = joiDefinition.allow;
if(validValues) { // Restrained text input
if(joiDefinition.allow) { // Restrained text input
return (
<Fragment>
<label htmlFor={fieldName}>{fieldName}:</label>
<label htmlFor={fieldName}>{flags.label}:</label>
<input type="text" list={fieldName} name={fieldName}/>
<datalist id={fieldName}>
{joiDefinition.allow.map((e: string) => {
@ -47,11 +59,38 @@ export function GenericField({ fieldName, joiDefinition }: GenericFieldProps) {
}
else {
// TODO: Implement unrestrained text input
return (<pre>{JSON.stringify(joiDefinition, null, 2)}</pre>)
return (<div>string, unrestrained text input is not implemented</div>)
}
break;
case "comma_array":
if(joiDefinition.items.length == 1) {
const item: Joi.Description = joiDefinition.items[0];
if(item.type == "number") {
if(item.rules.length == 1) {
return (
<Fragment>
<label htmlFor={fieldName}>{flags.label}:</label>
<input type="text" pattern="(\d+)(,\s*\d+)*" list={fieldName} name={fieldName}/>
<br/>
</Fragment>
);
}
else {
return (<div>comma_array, item rules are empty or bigger than one, this is not implemented.</div>);
}
}
else {
return (<div>comma_array, other types than numbers are not implemented yet.</div>);
}
}
else {
// TODO: Implement multiple items if necessary
return (<div>comma_array, joi items are empty or bigger than one, this is not implemented</div>);
}
break;
default:
return (<div>Field "{fieldName}": <br /> requested type "{joiDefinition.type}" not found</div>)
console.log(joiDefinition);
return (<div>GenericField.tsx: <br/> "{fieldName}": requested type "{joiDefinition.type}" not found. Check console for further info.</div>)
}
}

View File

@ -30,6 +30,8 @@ function Dynamic() {
LoadingModule.then((Module) => {
const Operator = Module[capitalizeFirstLetter(selectedValue)];
const description = Operator.schema.describe();
console.log(Operator.schema);
console.log(description);
activeOperator.current = Operator;
// This will update children

View File

@ -1,4 +1,3 @@
import { PdfFile, RepresentationType } from "../wrappers/PdfFile";
import { Operator, Progress, oneToOne } from ".";
@ -9,26 +8,7 @@ import i18next from "i18next";
import { getPages } from "./common/getPagesByIndex";
import { parsePageIndexSpecification } from "./common/pageIndexesUtils";
export interface ExtractPagesParamsType {
file: PdfFile;
pageIndexes: string | number[];
}
export async function extractPages(params: ExtractPagesParamsType): Promise<PdfFile> {
const { file, pageIndexes } = params;
const pdfLibDocument = await file.pdfLibDocument;
let indexes = pageIndexes;
if (!Array.isArray(indexes)) {
indexes = parsePageIndexSpecification(indexes, pdfLibDocument.getPageCount());
}
const newFile = await getPages(file, indexes);
newFile.filename += "_extractedPages";
return newFile;
}
import CommaArrayJoiExt from "../wrappers/CommaArrayJoiExt";
export class ExtractPages extends Operator {
static type = "extractPages";
@ -39,9 +19,9 @@ export class ExtractPages extends Operator {
protected static inputSchema = JoiPDFFileSchema.label(i18next.t("inputs.pdffile.name")).description(i18next.t("inputs.pdffile.description"));
protected static valueSchema = Joi.object({
pageIndexes: Joi.array().items(Joi.number().integer()).required()
pageIndexes: CommaArrayJoiExt.comma_array().items(Joi.number().integer()).required()
.label(i18next.t("values.pageIndexes.friendlyName", { ns: "extractPages" })).description(i18next.t("values.pageIndexes.description", { ns: "extractPages" }))
.example("3").example("4").required()
.example("1").example("1, 2, 3, 4").example("4, 2, 4, 3").required()
});
protected static outputSchema = JoiPDFFileSchema.label(i18next.t("outputs.pdffile.name")).description(i18next.t("outputs.pdffile.description"));

View File

@ -1,4 +1,3 @@
import { PDFPage } from "pdf-lib";
import { PdfFile, RepresentationType } from "../wrappers/PdfFile";

View File

@ -0,0 +1,27 @@
import Joi from "@stirling-tools/joi";
export default Joi.extend((joi) => {
return {
// e.g. "'1', '2', '3', '10', '100', 'hello'"
type: 'comma_array',
base: joi.array(),
messages: {
'million.base': '{{#label}} must be a comma seperated list',
},
coerce: {
from: 'string',
method(value, helpers) {
if (typeof value !== 'string' || !/(\d+)(,\s*\d+)*/.test(value)) {
return;
}
try {
return { value: value.split(",").map(v => v.trim()) };
}
catch (ignoreErr) { }
}
}
}
});

View File

@ -20,7 +20,7 @@ export const JoiPDFFileSchema = Joi.custom((value: Express.Multer.File[] /* <- a
throw new Error("an invalid type (unhandeled, non-file-type) was provided to pdf validation process. Please report this to maintainers.");
}
}
}, "pdffile validation");
}, "pdffile");
function isPdfFileArray(value: any[]): value is PdfFile[] { // "is" is a ts-typeguard - https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates
return value.every((e) => e instanceof PdfFile);