rimecms 0.31.5 → 0.32.0

package/dist/core/collections/config/augment-url.js

@@ -1,14 +0,0 @@
-import { text } from '../../../fields/text/index.js';
-/**
- * Add url field
- */
-export const augmentUrl = (config) => {
-    let fields = [...(config.fields || [])];
-    if (config.$url) {
-        fields = [...fields, text('url').localized().hidden()];
-    }
-    return {
-        ...config,
-        fields
-    };
-};

package/dist/core/collections/config/augment-versions.d.ts

@@ -1,14 +0,0 @@
-import type { VersionsConfig } from '../../config/types.js';
-import type { Collection } from '../../../types.js';
-type Input = {
-    versions?: Collection<any>['versions'];
-    fields?: Collection<any>['fields'];
-};
-type WithVersionsConfig<T> = Omit<T, 'versions'> & {
-    versions?: Required<VersionsConfig>;
-};
-/**
- * Normalize versions prop and add status field if config.versions.draft is true
- */
-export declare const augmentVersions: <T extends Input>(config: T) => WithVersionsConfig<T>;
-export {};

package/dist/core/collections/config/augment-versions.js

@@ -1,24 +0,0 @@
-import { VERSIONS_STATUS } from '../../constant.js';
-import { text } from '../../../fields/text/index.js';
-/**
- * Normalize versions prop and add status field if config.versions.draft is true
- */
-export const augmentVersions = (config) => {
-    const fields = [...(config.fields || [])];
-    const { versions, ...rest } = config;
-    let normalizedVersions;
-    if (versions) {
-        normalizedVersions = {
-            draft: typeof versions === 'boolean' ? false : (versions.draft ?? false),
-            autoSave: typeof versions === 'boolean' ? false : (versions.autoSave ?? false),
-            maxVersions: typeof versions === 'boolean' ? 12 : (versions.maxVersions ?? 12)
-        };
-        if (normalizedVersions.draft) {
-            fields.push(text('status').defaultValue(VERSIONS_STATUS.DRAFT).hidden());
-        }
-    }
-    else {
-        normalizedVersions = undefined;
-    }
-    return { ...rest, versions: normalizedVersions, fields };
-};

package/dist/core/collections/config/builder.d.ts

@@ -1,3 +0,0 @@
-import type { CollectionWithoutSlug } from './types.js';
-import type { BuiltCollection } from '../../config/types.js';
-export declare const create: <S extends string>(slug: S, incomingConfig: CollectionWithoutSlug<S>) => BuiltCollection;

package/dist/core/collections/config/builder.js

@@ -1,51 +0,0 @@
-import { augmentAuth } from './augment-auth.js';
-import { augmentMetas } from './augment-metas.js';
-import { augmentNested } from './augment-nested.js';
-import { augmentTitle } from './augment-title.js';
-import { augmentUpload } from './augment-upload.js';
-import { augmentUrl } from './augment-url.js';
-import { augmentVersions } from './augment-versions.js';
-import { access } from '../../../util/index.js';
-import { toKebabCase } from '../../../util/string.js';
-import { FileText } from '@lucide/svelte';
-import { augmentLabel } from './augment-label.js';
-import { augmentPanel } from './augment-panel.js';
-import { augmentThumbnail } from './augment-thumbnail.js';
-export const create = (slug, incomingConfig) => {
-    //
-    const collection = { ...incomingConfig, slug };
-    const initial = { ...collection };
-    const withLabel = augmentLabel(initial);
-    const withUpload = augmentUpload(withLabel);
-    const withNested = augmentNested(withUpload);
-    const withVersions = augmentVersions(withNested);
-    const withUrl = augmentUrl(withVersions);
-    const withAuth = augmentAuth(withUrl);
-    const withMetas = augmentMetas(withAuth);
-    const withTitle = augmentTitle(withMetas);
-    const withPanel = augmentPanel(withTitle);
-    const augmented = augmentThumbnail(withPanel);
-    return {
-        type: 'collection',
-        slug: augmented.slug,
-        kebab: toKebabCase(augmented.slug),
-        label: augmented.label,
-        auth: augmented.auth,
-        nested: augmented.nested,
-        upload: augmented.upload,
-        fields: augmented.fields || [],
-        asTitle: augmented.asTitle,
-        asThumbnail: augmented.asThumbnail,
-        versions: augmented.versions,
-        icon: augmented.icon || FileText,
-        live: incomingConfig.live || false,
-        panel: incomingConfig.panel,
-        access: {
-            create: (user) => access.isStaff(user),
-            read: (user) => access.isStaff(user),
-            update: (user) => access.isStaff(user),
-            delete: (user) => access.isStaff(user),
-            ...(incomingConfig.access || {})
-        }
-    };
-};

package/dist/core/collections/config/builder.server.d.ts

@@ -1,15 +0,0 @@
-import type { CollectionWithoutSlug } from './types.js';
-import type { BuiltCollection } from '../../config/types.js';
-export declare const create: <S extends string>(slug: S, incomingConfig: CollectionWithoutSlug<S>) => BuiltCollection;
-export declare const hook: {
-    beforeOperation: <S extends import("../../types/doc.js").DocType = "raw">(handler: import("../../operations/hooks/index.server.js").HookBeforeOperation<S, import("../../operations/hooks/index.server.js").Operation>) => import("../../operations/hooks/index.server.js").HookBeforeOperation<S, import("../../operations/hooks/index.server.js").Operation>;
-    beforeRead: <S extends import("../../types/doc.js").DocType = "raw">(handler: import("../../operations/hooks/index.server.js").Hook<S, "read", "before">) => import("../../operations/hooks/index.server.js").Hook<S, "read", "before">;
-    beforeCreate: <S extends import("../../types/doc.js").DocType = "raw">(handler: import("../../operations/hooks/index.server.js").Hook<S, "create", "before">) => import("../../operations/hooks/index.server.js").Hook<S, "create", "before">;
-    beforeUpsert: <S extends import("../../types/doc.js").DocType = "raw">(handler: import("../../operations/hooks/index.server.js").Hook<S, "create" | "update", "before">) => import("../../operations/hooks/index.server.js").Hook<S, "create" | "update", "before">;
-    beforeUpdate: <S extends import("../../types/doc.js").DocType = "raw">(handler: import("../../operations/hooks/index.server.js").Hook<S, "update", "before">) => import("../../operations/hooks/index.server.js").Hook<S, "update", "before">;
-    beforeDelete: <S extends import("../../types/doc.js").DocType = "raw">(handler: import("../../operations/hooks/index.server.js").Hook<S, "delete", "before">) => import("../../operations/hooks/index.server.js").Hook<S, "delete", "before">;
-    afterCreate: <S extends import("../../types/doc.js").DocType = "raw">(handler: import("../../operations/hooks/index.server.js").Hook<S, "create", "after">) => import("../../operations/hooks/index.server.js").Hook<S, "create", "after">;
-    afterUpsert: <S extends import("../../types/doc.js").DocType = "raw">(handler: import("../../operations/hooks/index.server.js").Hook<S, "create" | "update", "after">) => import("../../operations/hooks/index.server.js").Hook<S, "create" | "update", "after">;
-    afterUpdate: <S extends import("../../types/doc.js").DocType = "raw">(handler: import("../../operations/hooks/index.server.js").Hook<S, "update", "after">) => import("../../operations/hooks/index.server.js").Hook<S, "update", "after">;
-    afterDelete: <S extends import("../../types/doc.js").DocType = "raw">(handler: import("../../operations/hooks/index.server.js").Hook<S, "delete", "after">) => import("../../operations/hooks/index.server.js").Hook<S, "delete", "after">;
-};

package/dist/core/collections/config/builder.server.js

@@ -1,47 +0,0 @@
-import { augmentAuthServer } from './augment-auth.server.js';
-import { augmentHooks } from './augment-hooks.server.js';
-import { augmentMetas } from './augment-metas.js';
-import { augmentNestedServer } from './augment-nested.server.js';
-import { augmentTitle } from './augment-title.js';
-import { augmentUploadServer } from './augment-upload.server.js';
-import { augmentUrl } from './augment-url.js';
-import { augmentVersions } from './augment-versions.js';
-import { Hooks } from '../../operations/hooks/index.server.js';
-import { toKebabCase } from '../../../util/string.js';
-import { FileText } from '@lucide/svelte';
-import { augmentLabel } from './augment-label.js';
-import { augmentPanel } from './augment-panel.js';
-import { augmentThumbnail } from './augment-thumbnail.js';
-export const create = (slug, incomingConfig) => {
-    //
-    const collection = { ...incomingConfig, slug };
-    const initial = { ...collection };
-    const withLabel = augmentLabel(initial);
-    const withUpload = augmentUploadServer(withLabel);
-    const withNested = augmentNestedServer(withUpload);
-    const withVersions = augmentVersions(withNested);
-    const withUrl = augmentUrl(withVersions);
-    const withPanel = augmentPanel(withUrl);
-    const withAuth = augmentAuthServer(withPanel);
-    const withMetas = augmentMetas(withAuth);
-    const withHooks = augmentHooks(withMetas);
-    const withTitle = augmentTitle(withHooks);
-    const augmented = augmentThumbnail(withTitle);
-    return {
-        ...augmented,
-        fields: augmented.fields || [],
-        $url: augmented.$url,
-        slug: augmented.slug,
-        kebab: toKebabCase(augmented.slug),
-        type: 'collection',
-        icon: augmented.icon || FileText,
-        access: {
-            create: (user) => !!user && !!user.isStaff,
-            read: (user) => !!user && !!user.isStaff,
-            update: (user) => !!user && !!user.isStaff,
-            delete: (user) => !!user && !!user.isStaff,
-            ...augmented.access
-        }
-    };
-};
-export const hook = Hooks;

package/dist/core/collections/config/types.d.ts

@@ -1,3 +0,0 @@
-import type { Collection } from '../../config/types.js';
-import type { OmitPreservingDiscrimination } from '../../../util/types.js';
-export type CollectionWithoutSlug<S> = OmitPreservingDiscrimination<Collection<S>, 'slug'>;

package/dist/core/collections/local-api.server.d.ts

@@ -1,166 +0,0 @@
-import { type RegisterCollection } from '../../index.js';
-import type { RequestEvent } from '@sveltejs/kit';
-import type { BuiltCollection } from '../config/types.js';
-import type { CollectionSlug } from '../types/doc.js';
-import { create } from './operations/create.js';
-import { deleteDocs } from './operations/delete.js';
-import { deleteById } from './operations/deleteById.js';
-import { duplicate } from './operations/duplicate.js';
-import { find } from './operations/find.js';
-import { findById } from './operations/findById.js';
-import { updateById } from './operations/updateById.js';
-type Args = {
-    config: BuiltCollection;
-    defaultLocale: string | undefined;
-    event: RequestEvent;
-};
-/**
- * Facade for interacting with a collection
- *
- * Provides methods to create, retrieve, update, and delete documents within a collection.
- * Handles versioning, drafts, authentication, and localization according to the collection configuration.
- */
-declare class CollectionAPI<Doc extends RegisterCollection[CollectionSlug]> {
-    #private;
-    defaultLocale: string | undefined;
-    config: BuiltCollection;
-    isSystemOperation: boolean;
-    /**
-     * Initializes the collection facade
-     */
-    constructor({ config, defaultLocale, event }: Args);
-    system(isSytem?: boolean): CollectionAPI<never>;
-    /**
-     * Creates a blank document based on the collection schema
-     * For auth collections, private fields are filtered out
-     *
-     * @returns A blank document with default values
-     *
-     * @example
-     * const emptyDoc = rime.collection('posts').blank();
-     */
-    blank(): Doc;
-    /**
-     * Checks if this collection is an authentication collection
-     *
-     * @returns True if this is an auth collection
-     */
-    get isAuth(): boolean;
-    /**
-     * Creates a new document in the collection
-     *
-     * @example
-     * const post = await rime.collection('posts').create({
-     *   data: { title: 'Hello World', content: 'My first post' },
-     *   locale: 'en'
-     * });
-     */
-    create(args: APIMethodArgs<typeof create>): Promise<Doc>;
-    /**
-     * Duplicate a document in the collection
-     *
-     * @example
-     * const post = await rime.collection('posts').duplicate({
-     *   id: '1234'
-     * });
-     */
-    duplicate(args: APIMethodArgs<typeof duplicate>): Promise<string>;
-    /**
-     * Finds documents in the collection matching the query
-     *
-     * @example
-     * // Find published posts sorted by creation date
-     * const posts = await rime.collection('posts').find({
-     *   query: { published: true },
-     *   sort: '-createdAt',
-     *   limit: 10
-     * });
-     */
-    find(args?: APIMethodArgs<typeof find>): Promise<Doc[]>;
-    /**
-     * Finds a document in the collection by ID
-     *
-     * For collections with versioning:
-     * - If versionId is provided: Retrieves that specific version
-     * - If no versionId and draft=true: Retrieves the latest draft if available
-     * - If no versionId and draft=false: Retrieves the published version
-     *
-     * @example
-     * // Get published version
-     * const post = await rime.collection('posts').findById({ id: '12345' });
-     *
-     * // Get specific version
-     * const post = await rime.collection('posts').findById({
-     *   id: '12345',
-     *   versionId: 'v2',
-     *   locale: 'en'
-     * });
-     *
-     * // Get latest draft version
-     * const post = await rime.collection('posts').findById({
-     *   id: '12345',
-     *   draft: true
-     * });
-     */
-    findById(args: APIMethodArgs<typeof findById>): Promise<Doc>;
-    /**
-     * Updates a document in the collection by ID
-     *
-     * For collections with versioning:
-     * - For non-versioned collections: Simply updates the document
-     * - For versioned collections without draft support:
-     *   - If versionId is provided: Updates that specific version
-     *   - If no versionId is provided: Creates a new version based on the latest
-     * - For versioned collections with draft support:
-     *   - If versionId is provided: Updates that specific version
-     *   - If no versionId and draft !== true: Updates the published version
-     *   - If no versionId and draft === true: Creates a new draft from the published version
-     *
-     * @example
-     * // Update published version
-     * const post = await rime.collection('posts').updateById({
-     *   id: '12345',
-     *   data: { title: 'New title' },
-     *   locale: 'en'
-     * });
-     *
-     * // Update specific version
-     * const post = await rime.collection('posts').updateById({
-     *   id: '12345',
-     *   versionId: 'v2',
-     *   data: { title: 'New title' },
-     *   locale: 'en'
-     * });
-     *
-     * // Create or update draft version
-     * const post = await rime.collection('posts').updateById({
-     *   id: '12345',
-     *   data: { title: 'Draft title' },
-     *   draft: true
-     * });
-     */
-    updateById(args: APIMethodArgs<typeof updateById>): Promise<Doc>;
-    /**
-     * Deletes a document in the collection by ID
-     *
-     * @example
-     * const post = await rime.collection('posts').deleteById('12345');
-     */
-    deleteById: ({ id }: APIMethodArgs<typeof deleteById>) => Promise<string>;
-    /**
-     * Deletes multiple documents in the collection. No query means no filter —
-     * `delete()` with no args deletes every document in the collection.
-     *
-     * @example
-     * const posts = await rime.collection('posts').delete({
-     *   query: { published: true },
-     *   limit: 10
-     * });
-     */
-    delete: (args?: APIMethodArgs<typeof deleteDocs>) => Promise<string[]>;
-}
-export { CollectionAPI };
-/****************************************************
-/* Types
-/****************************************************/
-type APIMethodArgs<T extends (...args: any) => any> = Omit<Parameters<T>[0], 'rime' | 'event' | 'config' | 'slug'>;

package/dist/core/collections/local-api.server.js

@@ -1,303 +0,0 @@
-import { RimeError } from '../errors/index.js';
-import {} from '../../index.js';
-import { createBlankDocument } from '../../util/doc.js';
-import { FormFieldBuilder } from '../fields/builders/index.js';
-import { PRIVATE_FIELDS } from './auth/constant.server.js';
-import { isAuthConfig } from './auth/util.js';
-import { create } from './operations/create.js';
-import { deleteDocs } from './operations/delete.js';
-import { deleteById } from './operations/deleteById.js';
-import { duplicate } from './operations/duplicate.js';
-import { find } from './operations/find.js';
-import { findById } from './operations/findById.js';
-import { updateById } from './operations/updateById.js';
-/**
- * Facade for interacting with a collection
- *
- * Provides methods to create, retrieve, update, and delete documents within a collection.
- * Handles versioning, drafts, authentication, and localization according to the collection configuration.
- */
-class CollectionAPI {
-    #event;
-    defaultLocale;
-    config;
-    isSystemOperation;
-    /**
-     * Initializes the collection facade
-     */
-    constructor({ config, defaultLocale, event }) {
-        this.config = config;
-        this.defaultLocale = defaultLocale;
-        this.#event = event;
-        this.create = this.create.bind(this);
-        this.find = this.find.bind(this);
-        this.findById = this.findById.bind(this);
-        this.updateById = this.updateById.bind(this);
-        this.deleteById = this.deleteById.bind(this);
-        this.isSystemOperation = false;
-    }
-    system(isSytem = true) {
-        if (isSytem === false)
-            return this;
-        // Return a proxy or new instance with system flag
-        const systemCollection = new CollectionAPI({
-            config: this.config,
-            defaultLocale: this.defaultLocale,
-            event: this.#event
-        });
-        systemCollection.isSystemOperation = true;
-        return systemCollection;
-    }
-    /**
-     * Returns the locale to use, with fallback logic
-     * Prioritizes provided locale, then event locale, then default locale
-     *
-     * @returns The locale to use
-     */
-    #fallbackLocale(locale) {
-        return locale || this.#event.locals.locale || this.defaultLocale;
-    }
-    /**
-     * Creates a blank document based on the collection schema
-     * For auth collections, private fields are filtered out
-     *
-     * @returns A blank document with default values
-     *
-     * @example
-     * const emptyDoc = rime.collection('posts').blank();
-     */
-    blank() {
-        if (isAuthConfig(this.config)) {
-            const withoutPrivateFields = this.config.fields
-                .filter((f) => f instanceof FormFieldBuilder)
-                .filter((f) => !PRIVATE_FIELDS.includes(f.name));
-            return createBlankDocument({
-                ...this.config,
-                fields: [...withoutPrivateFields]
-            }, this.#event);
-        }
-        return createBlankDocument(this.config, this.#event);
-    }
-    /**
-     * Checks if this collection is an authentication collection
-     *
-     * @returns True if this is an auth collection
-     */
-    get isAuth() {
-        return !!this.config.auth;
-    }
-    /**
-     * Creates a new document in the collection
-     *
-     * @example
-     * const post = await rime.collection('posts').create({
-     *   data: { title: 'Hello World', content: 'My first post' },
-     *   locale: 'en'
-     * });
-     */
-    create(args) {
-        return create({
-            //@ts-expect-error args.data is DeepPartial<RegisterCollection[CollectionSlug]> and expect exactlly this
-            data: args.data,
-            locale: this.#fallbackLocale(args.locale),
-            config: this.config,
-            event: this.#event,
-            isSystemOperation: this.isSystemOperation
-        });
-    }
-    /**
-     * Duplicate a document in the collection
-     *
-     * @example
-     * const post = await rime.collection('posts').duplicate({
-     *   id: '1234'
-     * });
-     */
-    duplicate(args) {
-        return duplicate({
-            id: args.id,
-            config: this.config,
-            event: this.#event,
-            isSystemOperation: this.isSystemOperation
-        });
-    }
-    /**
-     * Finds documents in the collection matching the query
-     *
-     * @example
-     * // Find published posts sorted by creation date
-     * const posts = await rime.collection('posts').find({
-     *   query: { published: true },
-     *   sort: '-createdAt',
-     *   limit: 10
-     * });
-     */
-    find(args = {}) {
-        const { query, locale, sort = '-updatedAt', depth = 0, limit, offset, draft } = args;
-        const params = {
-            select: args.select,
-            query,
-            locale: this.#fallbackLocale(locale),
-            config: this.config,
-            event: this.#event,
-            sort,
-            depth,
-            limit,
-            draft,
-            offset,
-            isSystemOperation: this.isSystemOperation
-        };
-        if (this.#event.locals.cacheEnabled && !this.isSystemOperation) {
-            const key = this.#event.locals.rime.cache.createKey('collection.find', {
-                slug: this.config.slug,
-                select: args.select,
-                userEmail: this.#event.locals.user?.email,
-                userRoles: this.#event.locals.user?.roles,
-                sort,
-                depth,
-                limit,
-                offset,
-                locale,
-                draft,
-                query
-            });
-            return this.#event.locals.rime.cache.get(key, () => find(params));
-        }
-        return find(params);
-    }
-    /**
-     * Finds a document in the collection by ID
-     *
-     * For collections with versioning:
-     * - If versionId is provided: Retrieves that specific version
-     * - If no versionId and draft=true: Retrieves the latest draft if available
-     * - If no versionId and draft=false: Retrieves the published version
-     *
-     * @example
-     * // Get published version
-     * const post = await rime.collection('posts').findById({ id: '12345' });
-     *
-     * // Get specific version
-     * const post = await rime.collection('posts').findById({
-     *   id: '12345',
-     *   versionId: 'v2',
-     *   locale: 'en'
-     * });
-     *
-     * // Get latest draft version
-     * const post = await rime.collection('posts').findById({
-     *   id: '12345',
-     *   draft: true
-     * });
-     */
-    findById(args) {
-        const { id, versionId, locale, select, draft, depth = 0 } = args;
-        if (!id) {
-            throw new RimeError(RimeError.NOT_FOUND);
-        }
-        const params = {
-            id,
-            versionId,
-            locale: this.#fallbackLocale(locale),
-            config: this.config,
-            event: this.#event,
-            draft,
-            depth,
-            select,
-            isSystemOperation: this.isSystemOperation
-        };
-        if (this.#event.locals.cacheEnabled && !this.isSystemOperation) {
-            const key = this.#event.locals.rime.cache.createKey('collection.findById', {
-                slug: this.config.slug,
-                userEmail: this.#event.locals.user?.email,
-                userRoles: this.#event.locals.user?.roles,
-                id,
-                versionId,
-                select,
-                depth,
-                draft,
-                locale
-            });
-            return this.#event.locals.rime.cache.get(key, () => findById(params));
-        }
-        return findById(params);
-    }
-    /**
-     * Updates a document in the collection by ID
-     *
-     * For collections with versioning:
-     * - For non-versioned collections: Simply updates the document
-     * - For versioned collections without draft support:
-     *   - If versionId is provided: Updates that specific version
-     *   - If no versionId is provided: Creates a new version based on the latest
-     * - For versioned collections with draft support:
-     *   - If versionId is provided: Updates that specific version
-     *   - If no versionId and draft !== true: Updates the published version
-     *   - If no versionId and draft === true: Creates a new draft from the published version
-     *
-     * @example
-     * // Update published version
-     * const post = await rime.collection('posts').updateById({
-     *   id: '12345',
-     *   data: { title: 'New title' },
-     *   locale: 'en'
-     * });
-     *
-     * // Update specific version
-     * const post = await rime.collection('posts').updateById({
-     *   id: '12345',
-     *   versionId: 'v2',
-     *   data: { title: 'New title' },
-     *   locale: 'en'
-     * });
-     *
-     * // Create or update draft version
-     * const post = await rime.collection('posts').updateById({
-     *   id: '12345',
-     *   data: { title: 'Draft title' },
-     *   draft: true
-     * });
-     */
-    updateById(args) {
-        return updateById({
-            ...args,
-            locale: this.#fallbackLocale(args.locale),
-            config: this.config,
-            event: this.#event,
-            isSystemOperation: this.isSystemOperation
-        });
-    }
-    /**
-     * Deletes a document in the collection by ID
-     *
-     * @example
-     * const post = await rime.collection('posts').deleteById('12345');
-     */
-    deleteById = ({ id }) => {
-        return deleteById({
-            id,
-            config: this.config,
-            event: this.#event,
-            isSystemOperation: this.isSystemOperation
-        });
-    };
-    /**
-     * Deletes multiple documents in the collection. No query means no filter —
-     * `delete()` with no args deletes every document in the collection.
-     *
-     * @example
-     * const posts = await rime.collection('posts').delete({
-     *   query: { published: true },
-     *   limit: 10
-     * });
-     */
-    delete = (args = {}) => {
-        return deleteDocs({
-            config: this.config,
-            event: this.#event,
-            isSystemOperation: this.isSystemOperation,
-            ...args
-        });
-    };
-}
-export { CollectionAPI };

package/dist/core/collections/nested/hooks/index.server.d.ts

@@ -1,4 +0,0 @@
-/**
- * Hook to populate _children property on document from a nested collection
- */
-export declare const addChildrenProperty: import("../../../operations/hooks/index.server.js").Hook<"raw", "read", "before">;