mapping passthrough

docs/schema/Mapping.json

@@ -39,7 +39,7 @@
             "type": ["array", "null"],
             "description": "The cast of this mapping object."
         },
-        "passTrough": {
+        "passThrough": {
             "type": ["boolean", "null"],
             "default": true,
             "description": "The passThrough of this mapping object."

lib/Db/Mapping.php

@@ -16,7 +16,7 @@ class Mapping extends Entity implements JsonSerializable
 	protected ?array $mapping = null;
 	protected ?array $unset = null;
 	protected ?array $cast = null;
-	protected ?bool $passTrough = null;
+	protected ?bool $passThrough = null;
 	protected ?DateTime $dateCreated = null;
 	protected ?DateTime $dateModified = null;
 
@@ -29,7 +29,7 @@ public function __construct() {
 		$this->addType('mapping', 'json');
 		$this->addType('unset', 'json');
 		$this->addType('cast', 'json');
-		$this->addType('passTrough', 'boolean');
+		$this->addType('passThrough', 'boolean');
 		$this->addType('dateCreated', 'datetime');
 		$this->addType('dateModified', 'datetime');
 	}
@@ -76,7 +76,7 @@ public function jsonSerialize(): array
 			'mapping' => $this->mapping,
 			'unset' => $this->unset,
 			'cast' => $this->cast,
-			'passTrough' => $this->passTrough,
+			'passThrough' => $this->passThrough,
 			'dateCreated' => isset($this->dateCreated) ? $this->dateCreated->format('c') : null,
 			'dateModified' => isset($this->dateModified) ? $this->dateModified->format('c') : null,
 		];

lib/Migration/Version0Date20240826193657.php

@@ -102,7 +102,7 @@ public function changeSchema(IOutput $output, Closure $schemaClosure, array $opt
 			$table->addColumn('mapping', Types::TEXT, ['notnull' => false]);
 			$table->addColumn('unset', Types::TEXT, ['notnull' => false]);
 			$table->addColumn('cast', Types::TEXT, ['notnull' => false]);
-			$table->addColumn('pass_trough', Types::BOOLEAN, ['notnull' => false]);
+			$table->addColumn('pass_through', Types::BOOLEAN, ['notnull' => false]);
 			$table->addColumn('date_created', Types::DATETIME, ['notnull' => true, 'default' => 'CURRENT_TIMESTAMP']);
 			$table->addColumn('date_modified', Types::DATETIME, ['notnull' => true, 'default' => 'CURRENT_TIMESTAMP']);
 			$table->setPrimaryKey(['id']);

lib/Service/MappingService.php

@@ -107,7 +107,7 @@ public function mapping(Mapping $mappingObject, array $input, bool $list = false
 
         // Determine pass trough.
         // Let's get the dot array based on https://github.com/adbario/php-dot-notation.
-        if ($mappingObject->getPassTrough()) {
+        if ($mappingObject->getPassThrough()) {
             $dotArray = new Dot($input);
             // @todo: error loging
             // isset($this->style) === true && $this->style->info('Mapping *with* pass trough');
@@ -188,7 +188,7 @@ public function mapping(Mapping $mappingObject, array $input, bool $list = false
             [
                 'input'      => $input,
                 'output'     => $output,
-                'passTrough' => $mappingObject->getPassTrough(),
+                'passThrough' => $mappingObject->getPassThrough(),
                 'mapping'    => $mappingObject->getMapping(),
             ]
         );

src/entities/mapping/mapping.mock.ts

@@ -3,7 +3,8 @@ import { TMapping } from './mapping.types'
 
 export const mockMappingData = (): TMapping[] => [
 	{
-		id: '5137a1e5-b54d-43ad-abd1-4b5bff5fcd3f',
+		id: 1,
+		uuid: '5137a1e5-b54d-43ad-abd1-4b5bff5fcd3f',
 		name: 'User Data Mapping',
 		version: '1.0.0',
 		description: 'Maps user data from source to target system',
@@ -12,10 +13,16 @@ export const mockMappingData = (): TMapping[] => [
 			{ source: 'lastName', target: 'family_name' },
 			{ source: 'email', target: 'email_address' },
 		],
-		passTrough: true,
+		passThrough: true,
+		reference: '',
+		unset: [],
+		cast: [],
+		dateCreated: '',
+		dateModified: '',
 	},
 	{
-		id: '4c3edd34-a90d-4d2a-8894-adb5836ecde8',
+		id: 2,
+		uuid: '5137a1e5-b54d-43ad-abd1-4b5bff5fcd3f',
 		name: 'Product Mapping',
 		version: '1.1.0',
 		description: 'Maps product data between systems',
@@ -24,12 +31,15 @@ export const mockMappingData = (): TMapping[] => [
 			{ source: 'productPrice', target: 'price' },
 			{ source: 'productDescription', target: 'description' },
 		],
-		passTrough: false,
+		passThrough: false,
 		unset: ['internal_id', 'created_by'],
 		cast: [
 			{ field: 'price', type: 'float' },
 			{ field: 'inStock', type: 'boolean' },
 		],
+		reference: '',
+		dateCreated: '',
+		dateModified: '',
 	},
 ]
 

src/entities/mapping/mapping.ts

@@ -4,38 +4,48 @@ import { TMapping } from './mapping.types'
 
 export class Mapping implements TMapping {
 
-	public id: string
-	public reference: string | null
+	public id: number
+	public uuid: string
+	public reference: string
 	public version: string
 	public name: string
-	public description: string | null
+	public description: string
 	public mapping: any[]
-	public unset: any[] | null
-	public cast: any[] | null
-	public passTrough: boolean | null
-	public dateCreated: string | null
-	public dateModified: string | null
+	public unset: any[]
+	public cast: any[]
+	public passThrough: boolean
+	public dateCreated: string
+	public dateModified: string
 
 	constructor(mapping: TMapping) {
-		this.id = mapping.id || ''
-		this.reference = mapping.reference || null
+		this.id = mapping.id || null
+		this.uuid = mapping.uuid || null
+		this.reference = mapping.reference || ''
 		this.version = mapping.version || '0.0.0'
 		this.name = mapping.name || ''
-		this.description = mapping.description || null
+		this.description = mapping.description || ''
 		this.mapping = mapping.mapping || []
-		this.unset = mapping.unset || null
-		this.cast = mapping.cast || null
-		this.passTrough = mapping.passTrough ?? true
-		this.dateCreated = mapping.dateCreated || null
-		this.dateModified = mapping.dateModified || null
+		this.unset = mapping.unset || []
+		this.cast = mapping.cast || []
+		this.passThrough = mapping.passThrough ?? false
+		this.dateCreated = mapping.dateCreated || ''
+		this.dateModified = mapping.dateModified || ''
 	}
 
 	public validate(): SafeParseReturnType<TMapping, unknown> {
 		const schema = z.object({
-			id: z.string().uuid(),
+			id: z.number().or(z.null()),
+			uuid: z.string().uuid().max(36).or(z.null()),
+			reference: z.string().max(255),
+			version: z.string().max(255),
 			name: z.string().max(255),
-			version: z.string(),
+			description: z.string(),
 			mapping: z.array(z.any()),
+			unset: z.array(z.any()),
+			cast: z.array(z.any()),
+			passThrough: z.boolean(),
+			dateCreated: z.string().or(z.literal('')),
+			dateModified: z.string().or(z.literal('')),
 		})
 
 		return schema.safeParse({ ...this })

src/entities/mapping/mapping.types.ts

@@ -1,14 +1,15 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 export type TMapping = {
-    id?: string
-    reference?: string | null
+    id: number
+    uuid: string
+    reference: string
     version: string
     name: string
-    description?: string | null
+    description: string
     mapping: any[]
-    unset?: any[] | null
-    cast?: any[] | null
-    passTrough?: boolean | null
-    dateCreated?: string | null
-    dateModified?: string | null
+    unset: any[]
+    cast: any[]
+    passThrough: boolean
+    dateCreated: string
+    dateModified: string
 }

src/main.js

@@ -1,10 +1,12 @@
 import Vue from 'vue'
 import { PiniaVuePlugin } from 'pinia'
+import Tooltip from '@nextcloud/vue/dist/Directives/Tooltip.js'
 import pinia from './pinia.js'
 import App from './App.vue'
 Vue.mixin({ methods: { t, n } })
 
 Vue.use(PiniaVuePlugin)
+Vue.directive('tooltip', Tooltip)
 
 new Vue(
 	{

src/modals/Mapping/EditMapping.vue

@@ -9,6 +9,7 @@ import { mappingStore, navigationStore } from '../../store/store.js'
 		@close="closeModal">
 		<div class="modalContent">
 			<h2>Mapping {{ mappingStore.mappingItem?.id ? 'Edit' : 'Add' }}</h2>
+
 			<NcNoteCard v-if="success" type="success">
 				<p>Mapping successfully added</p>
 			</NcNoteCard>
@@ -27,20 +28,32 @@ import { mappingStore, navigationStore } from '../../store/store.js'
 						id="description"
 						label="Description"
 						:value.sync="mappingItem.description" />
+
+					<span class="flex-container">
+						<NcCheckboxRadioSwitch
+							:checked.sync="mappingItem.passThrough">
+							Pass Through
+						</NcCheckboxRadioSwitch>
+						<a v-tooltip="'When turning passThrough on, all data from the original object is copied to the new object (passed through the mapper)'"
+							href="https://commongateway.github.io/CoreBundle/pages/Features/Mappings"
+							target="_blank">
+							<HelpCircleOutline :size="20" />
+						</a>
+					</span>
 				</div>
 			</form>
 
-			<NcButton
-				v-if="!success"
-				:disabled="loading"
-				type="primary"
-				@click="editMapping()">
-				<template #icon>
-					<NcLoadingIcon v-if="loading" :size="20" />
-					<ContentSaveOutline v-if="!loading" :size="20" />
-				</template>
-				Save
-			</NcButton>
+			<div v-if="!success" class="buttons">
+				<NcButton :disabled="loading"
+					type="primary"
+					@click="editMapping()">
+					<template #icon>
+						<NcLoadingIcon v-if="loading" :size="20" />
+						<ContentSaveOutline v-if="!loading" :size="20" />
+					</template>
+					Save
+				</NcButton>
+			</div>
 		</div>
 	</NcModal>
 </template>
@@ -53,8 +66,10 @@ import {
 	NcNoteCard,
 	NcTextField,
 	NcTextArea,
+	NcCheckboxRadioSwitch,
 } from '@nextcloud/vue'
 import ContentSaveOutline from 'vue-material-design-icons/ContentSaveOutline.vue'
+import HelpCircleOutline from 'vue-material-design-icons/HelpCircleOutline.vue'
 
 export default {
 	name: 'EditMapping',
@@ -65,6 +80,7 @@ export default {
 		NcNoteCard,
 		NcTextField,
 		NcTextArea,
+		NcCheckboxRadioSwitch,
 		// Icons
 		ContentSaveOutline,
 	},
@@ -73,8 +89,9 @@ export default {
 			mappingItem: {
 				name: '',
 				description: '',
+				passThrough: false,
 			},
-			success: false,
+			success: null,
 			loading: false,
 			error: false,
 			hasUpdated: false,
@@ -101,30 +118,44 @@ export default {
 		closeModal() {
 			navigationStore.setModal(false)
 			clearTimeout(this.closeTimeoutFunc)
-			this.success = false
+			this.success = null
 			this.loading = false
 			this.error = false
 			this.hasUpdated = false
 			this.mappingItem = {
 				id: null,
 				name: '',
 				description: '',
+				passThrough: false,
 			}
 		},
 		async editMapping() {
 			this.loading = true
-			try {
-				await mappingStore.saveMapping(this.mappingItem)
-				// Close modal or show success message
-				this.success = true
-				this.loading = false
+
+			mappingStore.saveMapping({
+				...this.mappingItem,
+			}).then(({ response }) => {
+				this.success = response.ok
 				this.closeTimeoutFunc = setTimeout(this.closeModal, 2000)
-			} catch (error) {
-				this.loading = false
-				this.success = false
+			}).catch((error) => {
 				this.error = error.message || 'An error occurred while saving the mapping'
-			}
+			}).finally(() => {
+				this.loading = false
+			})
 		},
 	},
 }
 </script>
+
+<style scoped>
+.buttons {
+    display: flex;
+    gap: 10px;
+}
+
+.flex-container {
+    display: flex;
+    align-items: center;
+    gap: 10px;
+}
+</style>

src/services/openLink.js

@@ -0,0 +1,3 @@
+export default function openLink(url, target = '') {
+	window.open(url, target)
+}