rimecms 0.31.4 → 0.32.0

package/dist/util/access/index.d.ts

@@ -1,73 +0,0 @@
-import type { User } from '../../core/collections/auth/types.js';
-/**
- * Checks if a user has admin privileges.
- *
- * @example
- * // Check if current user is an admin
- * if (isAdmin(currentUser)) {
- *   // Perform admin-only operations
- * }
- */
-export declare const isAdmin: (user?: User) => boolean;
-/**
- * Checks if a user is from the staff collection.
- *
- * @example
- * // const user = {
- * //  isStaff: true
- * //  ...
- * // }
- * isStaff(user) // true
- *
- */
-export declare const isStaff: (user?: User) => boolean;
-/**
- * Checks if a user has any of the specified roles.
- *
- * @example
- * // Check if user has either editor or reviewer role
- * if (hasRoles(user, 'editor', 'reviewer')) {
- *   // Allow access to editing features
- * }
- */
-export declare const hasRoles: (user?: User, ...roles: string[]) => boolean;
-/**
- * Checks if a user is an admin or matches the specified ID.
- * Useful for operations that should be allowed for admins or the user themselves.
- *
- * @example
- * // Check if user can edit a profile (either as admin or as the profile owner)
- * if (isAdminOrMe(currentUser, profileId)) {
- *   // Allow profile editing
- * }
- */
-export declare const isAdminOrMe: (user?: User, id?: string) => boolean;
-/**
- * Checks if a user's ID matches the specified ID.
- * Used for operations that should only be allowed for the user themselves.
- *
- * @example
- * // Check if user is accessing their own settings
- * if (isMe(currentUser, requestedUserId)) {
- *   // Allow access to personal settings
- * }
- */
-export declare const isMe: (user?: User, id?: string) => boolean;
-/**
- * Collection of access control utility functions.
- * Provides methods for checking user permissions and roles.
- */
-export declare const access: {
-    isAdmin: (user?: User) => boolean;
-    hasRoles: (user?: User, ...roles: string[]) => boolean;
-    isAdminOrMe: (user?: User, id?: string) => boolean;
-    isMe: (user?: User, id?: string) => boolean;
-    isStaff: (user?: User) => boolean;
-};
-declare const _default: {
-    isAdmin: (user?: User) => boolean;
-    hasRoles: (user?: User, ...roles: string[]) => boolean;
-    isAdminOrMe: (user?: User, id?: string) => boolean;
-    isMe: (user?: User, id?: string) => boolean;
-};
-export default _default;

package/dist/util/cases.d.ts

@@ -1,39 +0,0 @@
-/**
- * Returns an object with the first matching key and all keys for reference
- * @example
- * const auth = cases({
- *   IS_STAFF: user.role === 'staff',
- *   IS_ADMIN: user.role === 'admin'
- * });
- *
- * switch (auth.value) {
- *   case auth.IS_STAFF:
- *     // Type-safe access
- * }
- */
-export declare const cases: <T extends Record<string, boolean>>(map: T) => {
-    value: ExtractTrueKeys<T> extends never ? keyof T | undefined : keyof T;
-} & { [K in keyof T]: K; };
-type ExtractTrueKeys<T> = {
-    [K in keyof T]: T[K] extends true ? K : never;
-}[keyof T];
-/**
- * Executes the action associated with the given key
- * @example
- * const time = cases({
- *   morning: config.isMorning,
- *   afternoon: config.isAfterNoon,
- *   night: true // default case
- * });
- *
- * const whatToDo = when(time.value, {
- *   morning: takeCoffee(),
- *   afternoon: doRunning(),
- *   night: takeAdring(),
- *   default: 'code'
- * });
- */
-export declare const when: <K extends string | number | symbol, V>(key: K | "default", actions: Record<string, V> & {
-    default?: V;
-}) => V;
-export {};

package/dist/util/cases.js

@@ -1,58 +0,0 @@
-/**
- * Returns an object with the first matching key and all keys for reference
- * @example
- * const auth = cases({
- *   IS_STAFF: user.role === 'staff',
- *   IS_ADMIN: user.role === 'admin'
- * });
- *
- * switch (auth.value) {
- *   case auth.IS_STAFF:
- *     // Type-safe access
- * }
- */
-export const cases = (map) => {
-    // Find the first matching key
-    let value;
-    for (const [key, condition] of Object.entries(map)) {
-        if (condition) {
-            value = key;
-            break;
-        }
-    }
-    // Create the result object with value and all keys
-    const result = { value };
-    // Add each key as a property
-    for (const key of Object.keys(map)) {
-        result[key] = key;
-    }
-    return result;
-};
-/**
- * Executes the action associated with the given key
- * @example
- * const time = cases({
- *   morning: config.isMorning,
- *   afternoon: config.isAfterNoon,
- *   night: true // default case
- * });
- *
- * const whatToDo = when(time.value, {
- *   morning: takeCoffee(),
- *   afternoon: doRunning(),
- *   night: takeAdring(),
- *   default: 'code'
- * });
- */
-export const when = (key, actions) => {
-    // If the key exists in actions, return that value
-    if (key in actions) {
-        return actions[key];
-    }
-    // Otherwise return the default value if it exists
-    if ('default' in actions) {
-        return actions.default;
-    }
-    // If no match and no default, return undefined
-    return undefined;
-};

package/dist/util/doc.d.ts

@@ -1,50 +0,0 @@
-import type { GenericDoc } from '../core/types/doc.js';
-import type { BuiltArea, BuiltCollection } from '../types.js';
-import type { Dic } from './types.js';
-import type { RequestEvent } from '@sveltejs/kit';
-/**
- * Creates a blank document based on a collection or area configuration.
- * Initializes all fields with appropriate default values based on their type.
- *
- * @returns A new blank document with default values for all fields
- *
- * @example
- * // Create a blank document for the 'pages' collection
- * const blankPage = createBlankDocument(config.getCollection('pages'));
- */
-export declare const createBlankDocument: <C extends BuiltCollection | BuiltArea, T extends GenericDoc = GenericDoc>(config: C, event?: RequestEvent) => T;
-/**
- * Converts a flat array of documents into a nested tree structure based on parent-child relationships.
- * Documents are organized hierarchically with each document containing its children in the _children property.
- *
- * @param documents - Array of documents with parent properties indicating their relationships
- * @returns A nested tree structure where each document contains its children
- *
- * @example
- * // Convert a flat list of pages into a hierarchical structure
- * const pageTree = toNestedStructure(pagesList);
- * // Result: [{ id: '1', _children: [{ id: '2', _children: [] }] }]
- */
-/**
- * Converts a flat array of documents into a nested tree structure
- * based on _parent and _position fields
- */
-export declare const toNestedStructure: (documents: GenericDoc[]) => GenericDoc[];
-/**
- * Remove block type in path
- * @example
- * normalizePath('foo.bar.0:content.baz')
- *
- * // return foo.bar.0.baz
- */
-export declare const normalizeFieldPath: (path: string) => string;
-/**
- * Ensure path exists, meaning the path hold anything else than undefined.
- *
- * @example
- * const obj = { foo: { baz: null }, bar: 1 };
- * ensurePathExists('foo.bar', obj); // false
- * ensurePathExists('foo.baz', obj); // true
- * ensurePathExists('bar', obj); // true
- */
-export declare const ensurePathExists: (path: string, obj: Dic) => boolean;

package/dist/util/doc.js

@@ -1,140 +0,0 @@
-import { isUploadConfig } from '../core/collections/upload/util/config.js';
-import { FormFieldBuilder } from '../core/fields/builders/form-field-builder.js';
-import { GroupFieldBuilder } from '../fields/group/index.js';
-import { TabsBuilder } from '../fields/tabs/index.js';
-import { getValueAtPath } from './object.js';
-import { snapshot } from './state.js';
-/**
- * Creates a blank document based on a collection or area configuration.
- * Initializes all fields with appropriate default values based on their type.
- *
- * @returns A new blank document with default values for all fields
- *
- * @example
- * // Create a blank document for the 'pages' collection
- * const blankPage = createBlankDocument(config.getCollection('pages'));
- */
-export const createBlankDocument = (config, event) => {
-    /**
-     * Recursively processes field definitions to create a blank document structure.
-     * Handles special field types like tabs, blocks, relations, and nested fields.
-     */
-    function reduceFieldsToBlankDocument(prev, curr) {
-        try {
-            if (curr instanceof TabsBuilder) {
-                curr.get.tabs.forEach((tab) => {
-                    prev[tab.name] = tab.get.fields.reduce(reduceFieldsToBlankDocument, {});
-                });
-            }
-            else if (['blocks', 'relation', 'tree'].includes(curr.type)) {
-                prev[curr.name] = [];
-            }
-            else if (curr instanceof GroupFieldBuilder) {
-                prev[curr.name] = curr.get.fields.reduce(reduceFieldsToBlankDocument, {});
-            }
-            else if (curr instanceof FormFieldBuilder) {
-                // Presentational fields (separator, bare component()) are plain
-                // FieldBuilder, never FormFieldBuilder, and get skipped here rather
-                // than assigned `prev['']` (they never got a real name) — that used
-                // to corrupt the parent object into looking array-like once
-                // flattened/unflattened.
-                const defaultValue = curr.use.defaultValue({ event });
-                prev[curr.name] = defaultValue !== undefined ? defaultValue : null;
-            }
-        }
-        catch (err) {
-            console.error(curr);
-            throw err;
-        }
-        return prev;
-    }
-    const fields = config.fields.reduce(reduceFieldsToBlankDocument, {});
-    const empty = {
-        ...fields,
-        _type: config.slug,
-        _prototype: config.type
-    };
-    if (config.type === 'collection' &&
-        isUploadConfig(config) &&
-        'imageSizes' in config &&
-        config.imageSizes) {
-        empty.sizes = {};
-    }
-    return empty;
-};
-/**
- * Converts a flat array of documents into a nested tree structure based on parent-child relationships.
- * Documents are organized hierarchically with each document containing its children in the _children property.
- *
- * @param documents - Array of documents with parent properties indicating their relationships
- * @returns A nested tree structure where each document contains its children
- *
- * @example
- * // Convert a flat list of pages into a hierarchical structure
- * const pageTree = toNestedStructure(pagesList);
- * // Result: [{ id: '1', _children: [{ id: '2', _children: [] }] }]
- */
-/**
- * Converts a flat array of documents into a nested tree structure
- * based on _parent and _position fields
- */
-export const toNestedStructure = (documents) => {
-    const incomingDocs = snapshot(documents);
-    // Create a map for quick document lookup by ID
-    const docById = new Map();
-    incomingDocs.forEach((doc) => docById.set(doc.id, doc));
-    // Track processed documents to prevent infinite recursion
-    const processed = new Set();
-    // Process documents recursively
-    const processDocument = (doc) => {
-        if (!doc || processed.has(doc.id)) {
-            return doc;
-        }
-        processed.add(doc.id);
-        const result = { ...doc };
-        // Process children first (depth-first)
-        if (Array.isArray(result._children)) {
-            result._children = result._children
-                .map((id) => {
-                const childDoc = docById.get(id);
-                return childDoc ? processDocument(childDoc) : null;
-            })
-                .filter(Boolean);
-        }
-        // Only set the parent ID, don't process it recursively
-        if (result._parent && typeof result._parent === 'string') {
-            result._parent = docById.get(result._parent)?.id || null;
-        }
-        return result;
-    };
-    const output = incomingDocs
-        .filter((doc) => !doc._parent)
-        .map(processDocument)
-        .sort((a, b) => (a._position || 0) - (b._position || 0));
-    // Filter to get root documents and process them
-    return output;
-};
-/**
- * Remove block type in path
- * @example
- * normalizePath('foo.bar.0:content.baz')
- *
- * // return foo.bar.0.baz
- */
-export const normalizeFieldPath = (path) => {
-    const regExpBlockType = /:[a-zA-Z0-9]+/g;
-    return path.replace(regExpBlockType, '');
-};
-/**
- * Ensure path exists, meaning the path hold anything else than undefined.
- *
- * @example
- * const obj = { foo: { baz: null }, bar: 1 };
- * ensurePathExists('foo.bar', obj); // false
- * ensurePathExists('foo.baz', obj); // true
- * ensurePathExists('bar', obj); // true
- */
-export const ensurePathExists = (path, obj) => {
-    const value = getValueAtPath(path, obj);
-    return value !== undefined;
-};

package/dist/util/validate.js

@@ -1,171 +0,0 @@
-import { RimeFormError } from '../core/errors/index.js';
-/**
- * Validates a password string against security requirements.
- * Checks for minimum length, lowercase, uppercase, numbers, and special characters.
- *
- * @example
- * // Returns true for a valid password
- * password("Secure1Password!");
- *
- * // Returns an error code for an invalid password
- * password("weak"); // Returns RimeFormError.PASSWORD_MIN_8
- */
-export const password = (value) => {
-    if (typeof value !== 'string') {
-        return RimeFormError.NOT_A_STRING;
-    }
-    if (value.length < 8) {
-        return RimeFormError.PASSWORD_MIN_8;
-    }
-    else if (!/[a-z]/.test(value)) {
-        return RimeFormError.PASSWORD_LOWERCASE_MISSING;
-    }
-    else if (!/[A-Z]/.test(value)) {
-        return RimeFormError.PASSWORD_UPPERCASE_MISSING;
-    }
-    else if (!/\d/.test(value)) {
-        return RimeFormError.PASSWORD_NUMBER_MISSING;
-    }
-    else if (!/[#.?"'(§)_=!+:;@$%^&*-]/.test(value)) {
-        return RimeFormError.PASSWORD_SPECIAL_CHAR_MISSING;
-    }
-    return true;
-};
-/**
- * Validates an email address string.
- * Ensures the email follows standard format with proper characters and domain structure.
- *
- * @example
- * // Returns true for a valid email
- * email("user@example.com");
- *
- * // Returns an error code for an invalid email
- * email("invalid-email"); // Returns RimeFormError.INVALID_EMAIL
- */
-export const email = (value) => {
-    if (typeof value !== 'string') {
-        return RimeFormError.NOT_A_STRING;
-    }
-    // This regex ensures:
-    // 1. Starts with letter/number
-    // 2. Can contain .-_ between letters/numbers
-    // 3. Can't have consecutive dots
-    // 4. Can't end with .-_ before @
-    if (!/^[a-zA-Z0-9](?:[a-zA-Z0-9._-]*[a-zA-Z0-9])?@[^\s@]+\.[^\s@]+$/.test(value)) {
-        return RimeFormError.INVALID_EMAIL;
-    }
-    return true;
-};
-/**
- * Validates a telephone number string.
- * Ensures the phone number contains only digits, spaces, and the plus sign.
- *
- * @example
- * // Returns true for a valid phone number
- * tel("+1 555 123 4567");
- *
- * // Returns an error code for an invalid phone number
- * tel("abc123"); // Returns RimeFormError.INVALID_PHONE
- */
-export const tel = (value) => {
-    if (typeof value !== 'string') {
-        return RimeFormError.NOT_A_STRING;
-    }
-    if (!/^[+\d\s]+$/.test(value)) {
-        return RimeFormError.INVALID_PHONE;
-    }
-    return true;
-};
-/**
- * Validates a URL string.
- * Ensures the URL follows standard HTTP/HTTPS format with proper domain structure.
- *
- * @example
- * // Returns true for a valid URL
- * url("https://example.com/page");
- *
- * // Returns an error code for an invalid URL
- * url("not-a-url"); // Returns RimeFormError.INVALID_URL
- */
-export const url = (value) => {
-    if (typeof value !== 'string') {
-        return RimeFormError.NOT_A_STRING;
-    }
-    try {
-        const url = new URL(value);
-        // Only allow http and https protocols
-        if (!['http:', 'https:'].includes(url.protocol)) {
-            return RimeFormError.INVALID_URL;
-        }
-        return true;
-    }
-    catch {
-        return RimeFormError.INVALID_URL;
-    }
-};
-/**
- * Validates a slug string.
- * Ensures the slug contains only lowercase letters, numbers, and hyphens.
- *
- * @example
- * // Returns true for a valid slug
- * slug("my-page-slug-123");
- *
- * // Returns an error code for an invalid slug
- * slug("Invalid Slug!"); // Returns RimeFormError.INVALID_SLUG
- */
-export const slug = (value) => {
-    if (typeof value !== 'string') {
-        return RimeFormError.NOT_A_STRING;
-    }
-    if (!/^[a-z0-9-]+$/.test(value)) {
-        return RimeFormError.INVALID_SLUG;
-    }
-    return true;
-};
-/**
- * Validates a link object with different validation based on link type.
- * Supports tel, email, url, and anchor link types.
- *
- * @example
- * // Returns true for a valid email link
- * link({ type: 'email', value: 'user@example.com' });
- *
- * // Returns an error string for an invalid URL link
- * link({ type: 'url', value: 'invalid-url' }); // Returns "url::INVALID_URL"
- */
-export const link = (link) => {
-    const { type, value } = link;
-    if (value === '')
-        return true;
-    if (type === 'tel') {
-        const valid = validate.tel(value);
-        return typeof valid === 'string' ? `tel::${valid}` : true;
-    }
-    if (type === 'email') {
-        const valid = validate.email(value);
-        return typeof valid === 'string' ? `email::${valid}` : true;
-    }
-    if (type === 'url') {
-        const valid = validate.url(value);
-        return typeof valid === 'string' ? `url::${valid}` : true;
-    }
-    if (type === 'anchor') {
-        const valid = validate.slug(value);
-        return typeof valid === 'string' ? `anchor::${valid}` : true;
-    }
-    return true;
-};
-/**
- * Collection of validation utility functions for common data types.
- * Each function returns true if the value is valid, or an error code/message if invalid.
- */
-const validate = {
-    password,
-    email,
-    slug,
-    url,
-    tel,
-    link
-};
-export default validate;