@conduction/nextcloud-vue 0.1.0-beta.3 → 0.1.0-beta.4

package/src/types/shared.d.ts

@@ -1,79 +1,79 @@
-/**
- * Shared utility types used across OpenRegister entities.
- */
-
-/** Standard paginated API response shape. */
-export interface TPaginated<T = unknown> {
-	results: T[]
-	total: number
-	page: number
-	pages: number
-	limit: number
-	offset: number
-}
-
-/** Empty paginated response (used as initial state). */
-export type TEmptyPaginated = TPaginated<never>
-
-/** Resource quota limits. Used by registers, organisations, views, applications. */
-export interface TQuota {
-	storage?: number | null
-	bandwidth?: number | null
-	requests?: number | null
-	users?: number | null
-	groups?: number | null
-}
-
-/** Resource usage tracking. Mirrors TQuota but values are always numbers. */
-export interface TUsage {
-	storage?: number
-	bandwidth?: number
-	requests?: number
-	users?: number
-	groups?: number
-}
-
-/** Aggregate statistics for objects, logs, and files. Used by schemas and registers. */
-export interface TEntityStats {
-	objects: {
-		total: number
-		size: number
-		invalid: number
-		deleted: number
-		locked: number
-		published: number
-	}
-	logs: {
-		total: number
-		size: number
-	}
-	files: {
-		total: number
-		size: number
-	}
-}
-
-/** CRUD authorization configuration per entity type. */
-export interface TCrudAuthorization {
-	create?: string[]
-	read?: string[]
-	update?: string[]
-	delete?: string[]
-}
-
-/** Unified API error shape returned by all store actions. */
-export interface TApiError {
-	status: number | null
-	message: string
-	details: unknown | null
-	isValidation: boolean
-	fields: Record<string, string> | null
-	toString(): string
-}
-
-/** Object path reference for routing. */
-export interface TObjectPath {
-	register: string
-	schema: string
-	objectId?: string
-}
+/**
+ * Shared utility types used across OpenRegister entities.
+ */
+
+/** Standard paginated API response shape. */
+export interface TPaginated<T = unknown> {
+	results: T[]
+	total: number
+	page: number
+	pages: number
+	limit: number
+	offset: number
+}
+
+/** Empty paginated response (used as initial state). */
+export type TEmptyPaginated = TPaginated<never>
+
+/** Resource quota limits. Used by registers, organisations, views, applications. */
+export interface TQuota {
+	storage?: number | null
+	bandwidth?: number | null
+	requests?: number | null
+	users?: number | null
+	groups?: number | null
+}
+
+/** Resource usage tracking. Mirrors TQuota but values are always numbers. */
+export interface TUsage {
+	storage?: number
+	bandwidth?: number
+	requests?: number
+	users?: number
+	groups?: number
+}
+
+/** Aggregate statistics for objects, logs, and files. Used by schemas and registers. */
+export interface TEntityStats {
+	objects: {
+		total: number
+		size: number
+		invalid: number
+		deleted: number
+		locked: number
+		published: number
+	}
+	logs: {
+		total: number
+		size: number
+	}
+	files: {
+		total: number
+		size: number
+	}
+}
+
+/** CRUD authorization configuration per entity type. */
+export interface TCrudAuthorization {
+	create?: string[]
+	read?: string[]
+	update?: string[]
+	delete?: string[]
+}
+
+/** Unified API error shape returned by all store actions. */
+export interface TApiError {
+	status: number | null
+	message: string
+	details: unknown | null
+	isValidation: boolean
+	fields: Record<string, string> | null
+	toString(): string
+}
+
+/** Object path reference for routing. */
+export interface TObjectPath {
+	register: string
+	schema: string
+	objectId?: string
+}

package/src/types/source.d.ts

@@ -1,14 +1,14 @@
-/**
- * OpenRegister Source entity type.
- *
- * A data source backing a register (database connection).
- */
-export interface TSource {
-	id?: string | number
-	title: string
-	description: string
-	databaseUrl: string
-	type: 'internal' | 'mongodb'
-	updated: string
-	created: string
-}
+/**
+ * OpenRegister Source entity type.
+ *
+ * A data source backing a register (database connection).
+ */
+export interface TSource {
+	id?: string | number
+	title: string
+	description: string
+	databaseUrl: string
+	type: 'internal' | 'mongodb'
+	updated: string
+	created: string
+}

package/src/types/task.d.ts

@@ -1,31 +1,31 @@
-/**
- * OpenRegister Task entity type.
- *
- * Tasks are CalDAV-based (iCalendar VTODO) and linked to objects.
- * Fetched via the /tasks sub-resource endpoint and normalized from
- * iCal format to this frontend-friendly shape.
- */
-export interface TTask {
-	id: string
-	uid?: string
-	calendarId?: string
-	taskUri?: string
-	title: string
-	description?: string
-	reference?: string
-	objectUuid?: string
-	deadline?: string | null
-	daysText?: string
-	isOverdue?: boolean
-	isCompleted?: boolean
-	priority: TTaskPriority
-	status: TTaskStatus
-	created?: string
-	updated?: string
-}
-
-/** CalDAV task priority levels (mapped from iCal 0-9 range). */
-export type TTaskPriority = 'urgent' | 'high' | 'normal' | 'low'
-
-/** CalDAV task status values. */
-export type TTaskStatus = 'needs-action' | 'in-process' | 'completed' | 'cancelled'
+/**
+ * OpenRegister Task entity type.
+ *
+ * Tasks are CalDAV-based (iCalendar VTODO) and linked to objects.
+ * Fetched via the /tasks sub-resource endpoint and normalized from
+ * iCal format to this frontend-friendly shape.
+ */
+export interface TTask {
+	id: string
+	uid?: string
+	calendarId?: string
+	taskUri?: string
+	title: string
+	description?: string
+	reference?: string
+	objectUuid?: string
+	deadline?: string | null
+	daysText?: string
+	isOverdue?: boolean
+	isCompleted?: boolean
+	priority: TTaskPriority
+	status: TTaskStatus
+	created?: string
+	updated?: string
+}
+
+/** CalDAV task priority levels (mapped from iCal 0-9 range). */
+export type TTaskPriority = 'urgent' | 'high' | 'normal' | 'low'
+
+/** CalDAV task status values. */
+export type TTaskStatus = 'needs-action' | 'in-process' | 'completed' | 'cancelled'

package/src/utils/errors.js

@@ -1,96 +1,96 @@
-/**
- * Unified error shape returned by all store actions.
- *
- * @typedef {object} ApiError
- * @property {number} status HTTP status code (0 for network errors)
- * @property {string} message Human-readable error message
- * @property {object|null} details Validation errors or additional details
- * @property {boolean} isValidation Whether this is a validation error (400/422)
- * @property {object|null} fields Per-field validation errors
- */
-
-/**
- * Parse an HTTP error response into a unified ApiError shape.
- *
- * Merges the best of Pipelinq's _parseResponseError (field extraction)
- * and Procest's _parseError (status-specific messages, isValidation flag).
- *
- * @param {Response} response The fetch Response object
- * @param {string} type The object type slug (used in error messages)
- * @return {Promise<ApiError>} Parsed error object
- */
-export async function parseResponseError(response, type) {
-	const status = response.status
-	let details = null
-	let fields = null
-	let message = ''
-
-	try {
-		const body = await response.json()
-		details = body.errors || body.error || body.message || null
-		fields = body.validationErrors || body.errors || null
-	} catch {
-		// Response body is not JSON
-	}
-
-	switch (true) {
-	case status === 400 || status === 422:
-		message = details && typeof details === 'string'
-			? details
-			: `Validation failed for ${type}`
-		return { status, message, details, isValidation: true, fields, toString() { return this.message } }
-	case status === 401:
-		message = 'Session expired, please log in again'
-		break
-	case status === 403:
-		message = 'You do not have permission to perform this action'
-		break
-	case status === 404:
-		message = `The requested ${type} could not be found`
-		break
-	case status === 409:
-		message = `This ${type} was modified by another user. Please reload.`
-		break
-	case status >= 500:
-		message = 'An unexpected server error occurred. Please try again.'
-		break
-	default:
-		message = response.statusText || 'An unexpected error occurred'
-	}
-
-	return { status, message, details, isValidation: false, fields, toString() { return this.message } }
-}
-
-/**
- * Create a network error object for fetch failures (no response).
- *
- * @param {Error} error The caught error
- * @return {ApiError} Network error object
- */
-export function networkError(error) {
-	return {
-		status: 0,
-		message: error.message || 'A network error occurred. Check your connection and try again.',
-		details: null,
-		isValidation: false,
-		fields: null,
-		toString() { return this.message },
-	}
-}
-
-/**
- * Create a generic error object from a caught exception.
- *
- * @param {Error} error The caught error
- * @return {ApiError} Generic error object
- */
-export function genericError(error) {
-	return {
-		status: null,
-		message: error.message,
-		details: null,
-		isValidation: false,
-		fields: null,
-		toString() { return this.message },
-	}
-}
+/**
+ * Unified error shape returned by all store actions.
+ *
+ * @typedef {object} ApiError
+ * @property {number} status HTTP status code (0 for network errors)
+ * @property {string} message Human-readable error message
+ * @property {object|null} details Validation errors or additional details
+ * @property {boolean} isValidation Whether this is a validation error (400/422)
+ * @property {object|null} fields Per-field validation errors
+ */
+
+/**
+ * Parse an HTTP error response into a unified ApiError shape.
+ *
+ * Merges the best of Pipelinq's _parseResponseError (field extraction)
+ * and Procest's _parseError (status-specific messages, isValidation flag).
+ *
+ * @param {Response} response The fetch Response object
+ * @param {string} type The object type slug (used in error messages)
+ * @return {Promise<ApiError>} Parsed error object
+ */
+export async function parseResponseError(response, type) {
+	const status = response.status
+	let details = null
+	let fields = null
+	let message = ''
+
+	try {
+		const body = await response.json()
+		details = body.errors || body.error || body.message || null
+		fields = body.validationErrors || body.errors || null
+	} catch {
+		// Response body is not JSON
+	}
+
+	switch (true) {
+	case status === 400 || status === 422:
+		message = details && typeof details === 'string'
+			? details
+			: `Validation failed for ${type}`
+		return { status, message, details, isValidation: true, fields, toString() { return this.message } }
+	case status === 401:
+		message = 'Session expired, please log in again'
+		break
+	case status === 403:
+		message = 'You do not have permission to perform this action'
+		break
+	case status === 404:
+		message = `The requested ${type} could not be found`
+		break
+	case status === 409:
+		message = `This ${type} was modified by another user. Please reload.`
+		break
+	case status >= 500:
+		message = 'An unexpected server error occurred. Please try again.'
+		break
+	default:
+		message = response.statusText || 'An unexpected error occurred'
+	}
+
+	return { status, message, details, isValidation: false, fields, toString() { return this.message } }
+}
+
+/**
+ * Create a network error object for fetch failures (no response).
+ *
+ * @param {Error} error The caught error
+ * @return {ApiError} Network error object
+ */
+export function networkError(error) {
+	return {
+		status: 0,
+		message: error.message || 'A network error occurred. Check your connection and try again.',
+		details: null,
+		isValidation: false,
+		fields: null,
+		toString() { return this.message },
+	}
+}
+
+/**
+ * Create a generic error object from a caught exception.
+ *
+ * @param {Error} error The caught error
+ * @return {ApiError} Generic error object
+ */
+export function genericError(error) {
+	return {
+		status: null,
+		message: error.message,
+		details: null,
+		isValidation: false,
+		fields: null,
+		toString() { return this.message },
+	}
+}

package/src/utils/headers.js

@@ -1,50 +1,68 @@
-/**
- * Build standard Nextcloud request headers for API calls.
- *
- * Includes the CSRF request token and OCS API request header
- * required by Nextcloud's API layer.
- *
- * @param {string} [contentType='application/json'] Content-Type header value
- * @return {object} Headers object for use with fetch()
- */
-export function buildHeaders(contentType = 'application/json') {
-	const headers = {
-		requesttoken: OC.requestToken,
-		'OCS-APIREQUEST': 'true',
-	}
-	if (contentType) {
-		headers['Content-Type'] = contentType
-	}
-	return headers
-}
-
-/**
- * Build a query string from a params object.
- *
- * Handles _order serialization (JSON.stringify for objects) and skips
- * null/undefined/empty values.
- *
- * @param {object} params Key-value pairs for query parameters
- * @return {string} Query string including leading '?' or empty string
- */
-export function buildQueryString(params = {}) {
-	const queryParams = new URLSearchParams()
-
-	for (const [key, value] of Object.entries(params)) {
-		if (value === undefined || value === null || value === '') continue
-		if (Array.isArray(value)) {
-			for (const item of value) {
-				if (item !== undefined && item !== null && item !== '') {
-					queryParams.append(key, String(item))
-				}
-			}
-		} else if (key === '_order' && typeof value === 'object') {
-			queryParams.set(key, JSON.stringify(value))
-		} else {
-			queryParams.set(key, String(value))
-		}
-	}
-
-	const str = queryParams.toString()
-	return str ? '?' + str : ''
-}
+/**
+ * Prepend `/index.php` to a URL path when the current page is served via index.php.
+ * Unless the given path already contains `/index.php`.
+ *
+ * Nextcloud can be hosted with or without index.php in the URL. API calls must
+ * use the same prefix as the page, otherwise the request is rejected.
+ *
+ * @param {string} path URL path (e.g. '/apps/openregister/api/objects')
+ * @return {string} Path with optional /index.php prefix
+ */
+export function prefixUrl(path) {
+	if (path.startsWith('/index.php')) return path
+	if (typeof window !== 'undefined' && window.location.pathname.includes('/index.php')) {
+		return `/index.php${path}`
+	}
+	return path
+}
+
+/**
+ * Build standard Nextcloud request headers for API calls.
+ *
+ * Includes the CSRF request token and OCS API request header
+ * required by Nextcloud's API layer.
+ *
+ * @param {string} [contentType] Content-Type header value
+ * @return {object} Headers object for use with fetch()
+ */
+export function buildHeaders(contentType = 'application/json') {
+	const headers = {
+		requesttoken: OC.requestToken,
+		'OCS-APIREQUEST': 'true',
+	}
+	if (contentType) {
+		headers['Content-Type'] = contentType
+	}
+	return headers
+}
+
+/**
+ * Build a query string from a params object.
+ *
+ * Handles _order serialization (JSON.stringify for objects) and skips
+ * null/undefined/empty values.
+ *
+ * @param {object} params Key-value pairs for query parameters
+ * @return {string} Query string including leading '?' or empty string
+ */
+export function buildQueryString(params = {}) {
+	const queryParams = new URLSearchParams()
+
+	for (const [key, value] of Object.entries(params)) {
+		if (value === undefined || value === null || value === '') continue
+		if (Array.isArray(value)) {
+			for (const item of value) {
+				if (item !== undefined && item !== null && item !== '') {
+					queryParams.append(key, String(item))
+				}
+			}
+		} else if (key === '_order' && typeof value === 'object') {
+			queryParams.set(key, JSON.stringify(value))
+		} else {
+			queryParams.set(key, String(value))
+		}
+	}
+
+	const str = queryParams.toString()
+	return str ? '?' + str : ''
+}

package/src/utils/id.js

@@ -0,0 +1,13 @@
+/**
+ * Extract the ID from a given value.
+ *
+ * primarily supports objects with a id or \@self.id property
+ * @param {string|object} value - object value
+ * @return {string} id
+ */
+export const extractId = (value) => {
+	if (typeof value === 'string') return value
+	if (typeof value === 'object' && value?.id) return value.id
+	if (typeof value === 'object' && value?.['@self']?.id) { return value['@self'].id }
+	return value
+}

package/src/utils/index.js

@@ -1,3 +1,3 @@
-export { buildHeaders, buildQueryString } from './headers.js'
-export { parseResponseError, networkError, genericError } from './errors.js'
-export { columnsFromSchema, formatValue, filtersFromSchema, fieldsFromSchema } from './schema.js'
+export { buildHeaders, buildQueryString } from './headers.js'
+export { parseResponseError, networkError, genericError } from './errors.js'
+export { columnsFromSchema, formatValue, filtersFromSchema, fieldsFromSchema } from './schema.js'