rimecms 0.28.10 → 0.29.0

package/README.md

@@ -93,7 +93,7 @@ export default defineConfig({
 ```typescript
 // src/hooks.server.ts (should be created)
 import config from '$lib/+rime.generated/rime.config.server.js';
-import { handlers } from 'rimecms';
+import { handlers } from 'rimecms/server';
 import { sequence } from '@sveltejs/kit/hooks';
 
 export const handle = sequence(...(await handlers(config)));
@@ -131,7 +131,7 @@ curl -v POST http://localhost:5173/api/init \
 ```typescript
 // ./src/lib/+rime/rime.config.ts
 import { rime, Collection, Area } from '$rime/config';
-import { adapterSqlite } from 'rimecms/sqlite';
+import { adapterSqlite } from 'rimecms/adapter-sqlite';
 import { Settings2 } from '@lucide/svelte';
 import { relation, link, richText, text, toggle } from 'rimecms/fields';
 import { access } from "rimecms/util";
@@ -261,10 +261,10 @@ It's doing bascically `vite build` under the hood and create the polka server fi
 - [x] more better-auth integration
 - [x] Handle relation poperties in queries
 - [~] Documentation
+- [ ] Live Edit system in practice
 - [ ] configurable files storage adapter (local, s3, etc)
 - [ ] other storage adapter (postgress, turso, etc)
 - [ ] auto-saved draft
-- [ ] Live Edit system in practice
 - [ ] Put bin commands in a separate package ex: @rime/kit
 
 ## Acknowledgments

package/dist/adapter-sqlite/generate-schema/{util.d.ts → util.server.d.ts}

@@ -33,8 +33,8 @@ export declare const getBlocksTableNames: (slug: string, tables: Record<string,
  */
 export declare const makeBlockTableSlug: (slug: string, blockType: string) => string;
 /**
- * Generate the column's names for a given field name and its parent path
- * Snake case is used for sqlite column name and Camel case is user for the drizzle column property name
+ * Generate the column and property names for a field given its name and its parent path.
+ * Snake case is used for the sqlite column name and Camel case is used for the drizzle column property name.
  *
  * @example
  * // returns { camel : 'groupTitle', snake: 'group__title' }

package/dist/adapter-sqlite/generate-schema/{util.js → util.server.js}

@@ -34,8 +34,8 @@ export const getBlocksTableNames = (slug, tables) => Object.keys(tables).filter(
  */
 export const makeBlockTableSlug = (slug, blockType) => `${slug}Blocks${toPascalCase(blockType)}`;
 /**
- * Generate the column's names for a given field name and its parent path
- * Snake case is used for sqlite column name and Camel case is user for the drizzle column property name
+ * Generate the column and property names for a field given its name and its parent path.
+ * Snake case is used for the sqlite column name and Camel case is used for the drizzle column property name.
  *
  * @example
  * // returns { camel : 'groupTitle', snake: 'group__title' }

package/dist/adapter-sqlite/generate-schema/write.server.js

@@ -1,5 +1,5 @@
 import cache from '../../core/dev/cache/index.server.js';
-import { getPackageManager } from '../../core/dev/cli/init/package-manager-util.server.js';
+import { getPackageManager } from '../../core/dev/cli/util/package-manager.server.js';
 import { logger } from '../../core/logger/index.server.js';
 import fs from 'fs';
 import { spawnSync } from 'node:child_process';

package/dist/adapter-sqlite/index.server.d.ts

@@ -15,6 +15,8 @@ import createTreeFacade from './tree.server.js';
 import type { GenericTable } from './types.server.js';
 import { updateDocumentUrl } from './url.server.js';
 import { updateTableRecord } from './util.server.js';
+export * as templates from './generate-schema/templates.server.js';
+export * as util from './generate-schema/util.server.js';
 type Schema = GetRegisterType<'Schema'>;
 export declare function adapterSqlite(database: string): {
     createAdapter: <C extends Config>(configCtx: ConfigContext<C>) => Promise<Adapter>;
@@ -36,4 +38,3 @@ export type Adapter = {
     readonly schema: Schema;
     readonly relationFieldsMap: RelationFieldsMap;
 };
-export {};

package/dist/adapter-sqlite/index.server.js

@@ -10,6 +10,8 @@ import { transformerFacade } from './transform.server.js';
 import createTreeFacade from './tree.server.js';
 import { updateDocumentUrl } from './url.server.js';
 import { updateTableRecord } from './util.server.js';
+export * as templates from './generate-schema/templates.server.js';
+export * as util from './generate-schema/util.server.js';
 export function adapterSqlite(database) {
     //
     return {

package/dist/adapter-sqlite/transform.server.js

@@ -5,7 +5,7 @@ import { flatten, unflatten } from 'flat';
 import { logger } from '../core/logger/index.server.js';
 import { extractFieldName } from '../fields/tree/util.js';
 import { isObjectLiteral, omit } from '../util/object.js';
-import { getBlocksTableNames, getTreeTableNames, makeBlockTableSlug, makeTreeTableSlug } from './generate-schema/util.js';
+import { getBlocksTableNames, getTreeTableNames, makeBlockTableSlug, makeTreeTableSlug } from './generate-schema/util.server.js';
 import { transformDatabaseColumnsToPaths } from './util.server.js';
 /**
  * Facade responsible of converting raw database document

package/dist/adapter-sqlite/with.server.js

@@ -4,7 +4,7 @@ import { isBlocksFieldRaw } from '../fields/blocks/index.js';
 import { isRelationField } from '../fields/relation/index.js';
 import { isTreeFieldRaw } from '../fields/tree/index.js';
 import { asc, eq, getTableColumns, or, SQL } from 'drizzle-orm';
-import { getBlocksTableNames, getTreeTableNames } from './generate-schema/util.js';
+import { getBlocksTableNames, getTreeTableNames } from './generate-schema/util.server.js';
 export const buildWithParam = (args) => {
     const { slug, select = [], locale, tables, config: documentConfig } = args;
     if (!select.length) {

package/dist/core/areas/{api → rest}/get.server.d.ts

@@ -1,6 +1,8 @@
-import type { AreaSlug } from '../../types/doc.js';
 import { type RequestEvent } from '@sveltejs/kit';
-export default function (slug: AreaSlug): (event: RequestEvent) => Promise<Response | import("@sveltejs/kit").ActionFailure<{
+/**
+ * GET handler for the area API endpoint.
+ */
+export declare function restGet(event: RequestEvent): Promise<Response | import("@sveltejs/kit").ActionFailure<{
     form: Record<string, any>;
     errors: import("../../../types").FormErrors;
 }> | import("@sveltejs/kit").ActionFailure<{

package/dist/core/areas/rest/get.server.js

@@ -0,0 +1,45 @@
+import { PARAMS } from '../../constant.js';
+import { RimeError } from '../../errors/index.js';
+import { handleError } from '../../errors/handler.server.js';
+import { trycatch } from '../../../util/function.js';
+import { json } from '@sveltejs/kit';
+/**
+ * GET handler for the area API endpoint.
+ */
+export async function restGet(event) {
+    //
+    const { rime } = event.locals;
+    // Check if the slug corresponds to a valid area
+    const slug = event.params.slug;
+    if (!rime.config.isArea(slug)) {
+        return handleError(new RimeError(RimeError.NOT_FOUND), { context: 'api' });
+    }
+    const params = event.url.searchParams;
+    const areaAPI = rime.area(slug);
+    // Build the select parameter for the API call based on the request parameters
+    function buildSelect(params) {
+        const paramSelect = params.get(PARAMS.SELECT)
+            ? params.get(PARAMS.SELECT).split(',')
+            : undefined;
+        if (paramSelect &&
+            paramSelect.includes('title') &&
+            !paramSelect.includes(areaAPI.config.asTitle)) {
+            paramSelect.push(areaAPI.config.asTitle);
+        }
+        return paramSelect;
+    }
+    // Prepare the parameters for the API call to find the area document
+    const apiParams = {
+        locale: rime.getLocale(),
+        draft: params.get(PARAMS.DRAFT) ? params.get(PARAMS.DRAFT) === 'true' : undefined,
+        versionId: params.get(PARAMS.VERSION_ID) || undefined,
+        depth: params.get(PARAMS.DEPTH) ? parseInt(params.get(PARAMS.DEPTH)) : 0,
+        select: buildSelect(params)
+    };
+    // Call the area API to find the document based on the prepared parameters
+    const [error, doc] = await trycatch(() => rime.area(slug).find(apiParams));
+    if (error) {
+        return handleError(error, { context: 'api' });
+    }
+    return json({ doc });
+}

package/dist/core/areas/rest/index.server.d.ts

@@ -0,0 +1,6 @@
+import { restGet } from './get.server.js';
+import { restUpdate } from './update.server.js';
+export declare const rest: {
+    get: typeof restGet;
+    update: typeof restUpdate;
+};

package/dist/core/areas/rest/index.server.js

@@ -0,0 +1,3 @@
+import { restGet } from './get.server.js';
+import { restUpdate } from './update.server.js';
+export const rest = { get: restGet, update: restUpdate };

package/dist/core/areas/{api → rest}/update.server.d.ts

@@ -1,6 +1,8 @@
-import type { AreaSlug } from '../../types/doc.js';
 import { type RequestEvent } from '@sveltejs/kit';
-export default function (slug: AreaSlug): (event: RequestEvent) => Promise<Response | import("@sveltejs/kit").ActionFailure<{
+/**
+ * POST handler for the area API endpoint.
+ */
+export declare function restUpdate(event: RequestEvent): Promise<Response | import("@sveltejs/kit").ActionFailure<{
     form: Record<string, any>;
     errors: import("../../../types").FormErrors;
 }> | import("@sveltejs/kit").ActionFailure<{

package/dist/core/areas/rest/update.server.js

@@ -0,0 +1,43 @@
+import { PARAMS } from '../../constant.js';
+import { RimeError } from '../../errors/index.js';
+import { ERROR_CONTEXT, handleError } from '../../errors/handler.server.js';
+import { extractData } from '../../operations/extract-data.server.js';
+import { trycatch } from '../../../util/function.js';
+import { json } from '@sveltejs/kit';
+/**
+ * POST handler for the area API endpoint.
+ */
+export async function restUpdate(event) {
+    //
+    const { rime } = event.locals;
+    const slug = event.params.slug;
+    // Check if the slug corresponds to a valid area
+    if (!rime.config.isArea(slug)) {
+        return handleError(new RimeError(RimeError.NOT_FOUND), { context: ERROR_CONTEXT.API });
+    }
+    // Extract versionId and draft parameters from the request URL
+    const versionId = event.url.searchParams.get(PARAMS.VERSION_ID) || undefined;
+    const draft = event.url.searchParams.get(PARAMS.DRAFT)
+        ? event.url.searchParams.get(PARAMS.DRAFT) === 'true'
+        : undefined;
+    // Extract data from the request body
+    const [extractError, data] = await trycatch(() => extractData(event.request));
+    if (extractError) {
+        return handleError(extractError, { context: ERROR_CONTEXT.API });
+    }
+    // Set the locale if provided in the data
+    if (data.locale) {
+        rime.setLocale(data.locale);
+    }
+    // Update the area with the extracted data, versionId, draft status, and current locale
+    const [error, doc] = await trycatch(() => rime.area(slug).update({
+        data,
+        versionId,
+        draft,
+        locale: rime.getLocale()
+    }));
+    if (error) {
+        return handleError(error, { context: ERROR_CONTEXT.API });
+    }
+    return json({ doc });
+}

package/dist/core/collections/auth/hooks/before-upsert/augment-fields-password.server.d.ts

@@ -3,4 +3,4 @@
  * add fields password and confirmPassword
  * to add validations
  */
-export declare const augmentFieldsPassword: import("../../../../operations/hooks/index.server.js").Hook<"auth", "create" | "update", "before">;
+export declare const augmentFieldsPassword: import("../../../../operations/hooks/index.server.js").Hook<"auth", "update" | "create", "before">;

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

@@ -1,4 +1,4 @@
-import type { CollectionPanelConfig, UploadConfig } from '../../config/types';
+import type { CollectionPanelConfig, UploadConfig } from '../../config/types.js';
 type Input = {
     panel?: CollectionPanelConfig;
     upload?: UploadConfig;

package/dist/core/collections/operations/duplicate.js

@@ -1,7 +1,7 @@
 import { VERSIONS_STATUS } from '../../constant.js';
 import { buildConfigMap } from '../../operations/configMap/index.js';
 import { isBlocksFieldRaw } from '../../../fields/blocks/index.js';
-import { isJSONContent } from '../../../fields/rich-text';
+import { isJSONContent } from '../../../fields/rich-text/index.js';
 import { richTextJSONToText } from '../../../fields/rich-text/index.js';
 import { isTreeFieldRaw } from '../../../fields/tree/index.js';
 import { getValueAtPath, isObjectLiteral, matchStructure, omitId, setValueAtPath } from '../../../util/object.js';
@@ -32,7 +32,7 @@ export const duplicate = async (args) => {
      */
     function prepareDuplicate(doc, locale, keepIds) {
         let data = setCopyTitle(doc);
-        data.satus = data.satus ? VERSIONS_STATUS.DRAFT : undefined;
+        data.status = data.status ? VERSIONS_STATUS.DRAFT : undefined;
         data = normalizeProps(data, locale, keepIds);
         delete data.id;
         return data;

package/dist/core/collections/{api → rest}/create.server.d.ts

@@ -1,6 +1,8 @@
-import type { CollectionSlug } from '../../types/doc.js';
 import { type RequestEvent } from '@sveltejs/kit';
-export default function (slug: CollectionSlug): (event: RequestEvent) => Promise<Response | import("@sveltejs/kit").ActionFailure<{
+/**
+ * POST handler for the collection API endpoint.
+ */
+export declare function restCreate(event: RequestEvent): Promise<Response | import("@sveltejs/kit").ActionFailure<{
     form: Record<string, any>;
     errors: import("../../../types.js").FormErrors;
 }> | import("@sveltejs/kit").ActionFailure<{

package/dist/core/collections/rest/create.server.js

@@ -0,0 +1,37 @@
+import { ERROR_CONTEXT, handleError } from '../../errors/handler.server.js';
+import { RimeError } from '../../errors/index.js';
+import { extractData } from '../../operations/extract-data.server.js';
+import { trycatch } from '../../../util/function.js';
+import { json } from '@sveltejs/kit';
+import { isAuthConfig } from '../auth/util.js';
+/**
+ * POST handler for the collection API endpoint.
+ */
+export async function restCreate(event) {
+    //
+    const { rime } = event.locals;
+    // Check if the slug corresponds to a valid collection
+    const slug = event.params.slug;
+    if (!rime.config.isCollection(slug)) {
+        return handleError(new RimeError(RimeError.NOT_FOUND), { context: ERROR_CONTEXT.API });
+    }
+    const collection = rime.collection(slug);
+    // Extract data from the request body
+    const [extractError, data] = await trycatch(() => extractData(event.request));
+    if (extractError) {
+        return handleError(extractError, { context: ERROR_CONTEXT.API });
+    }
+    // Bypass confirm password for api auth collection creation calls
+    if (isAuthConfig(collection.config) && 'password' in data) {
+        data.confirmPassword = data.password;
+    }
+    // Set the locale if provided in the data
+    if (data.locale) {
+        rime.setLocale(data.locale);
+    }
+    const [error, document] = await trycatch(() => collection.create({ data, locale: rime.getLocale() }));
+    if (error) {
+        return handleError(error, { context: ERROR_CONTEXT.API });
+    }
+    return json({ doc: document });
+}

package/dist/core/collections/{api → rest}/delete.server.d.ts

@@ -1,6 +1,8 @@
-import type { CollectionSlug } from '../../types/doc.js';
 import { type RequestEvent } from '@sveltejs/kit';
-export default function (slug: CollectionSlug): (event: RequestEvent) => Promise<Response | import("@sveltejs/kit").ActionFailure<{
+/**
+ * DELETE handler for the collection API endpoint.
+ */
+export declare function restDelete(event: RequestEvent): Promise<Response | import("@sveltejs/kit").ActionFailure<{
     form: Record<string, any>;
     errors: import("../../../types").FormErrors;
 }> | import("@sveltejs/kit").ActionFailure<{

package/dist/core/collections/rest/delete.server.js

@@ -0,0 +1,37 @@
+import { normalizeQuery } from '../../../adapter-sqlite/util.server.js';
+import { PARAMS } from '../../constant.js';
+import { RimeError } from '../../errors/index.js';
+import { handleError } from '../../errors/handler.server.js';
+import { trycatch } from '../../../util/function.js';
+import { json } from '@sveltejs/kit';
+/**
+ * DELETE handler for the collection API endpoint.
+ */
+export async function restDelete(event) {
+    //
+    const { rime } = event.locals;
+    const slug = event.params.slug;
+    if (!rime.config.isCollection(slug)) {
+        return handleError(new RimeError(RimeError.NOT_FOUND), { context: 'api' });
+    }
+    const params = event.url.searchParams;
+    const hasQueryParams = !!params
+        .keys()
+        .filter((key) => key.startsWith('where'))
+        .toArray().length;
+    const query = hasQueryParams ? normalizeQuery(event.url.search.substring(1)) : undefined;
+    const apiParams = {
+        locale: rime.getLocale(),
+        sort: params.get(PARAMS.SORT) || undefined,
+        depth: params.get(PARAMS.DEPTH) ? parseInt(params.get(PARAMS.DEPTH)) : 0,
+        limit: params.get(PARAMS.LIMIT) ? parseInt(params.get(PARAMS.LIMIT)) : undefined,
+        offset: params.get(PARAMS.OFFSET) ? parseInt(params.get(PARAMS.OFFSET)) : undefined,
+        query,
+        select: params.get(PARAMS.SELECT) ? params.get(PARAMS.SELECT).split(',') : undefined
+    };
+    const [error, docs] = await trycatch(() => rime.collection(slug).delete(apiParams));
+    if (error) {
+        return handleError(error, { context: 'api' });
+    }
+    return json({ docs }, { status: 200 });
+}

package/dist/core/collections/{api → rest}/deleteById.server.d.ts

@@ -1,6 +1,8 @@
-import type { CollectionSlug } from '../../types/doc.js';
 import { type RequestEvent } from '@sveltejs/kit';
-export default function (slug: CollectionSlug): (event: RequestEvent) => Promise<Response | import("@sveltejs/kit").ActionFailure<{
+/**
+ * DELETE handler for the collection API endpoint to delete a document by its ID.
+ */
+export declare function restDeleteById(event: RequestEvent): Promise<Response | import("@sveltejs/kit").ActionFailure<{
     form: Record<string, any>;
     errors: import("../../../types").FormErrors;
 }> | import("@sveltejs/kit").ActionFailure<{

package/dist/core/collections/rest/deleteById.server.js

@@ -0,0 +1,21 @@
+import { RimeError } from '../../errors/index.js';
+import { handleError } from '../../errors/handler.server.js';
+import { trycatch } from '../../../util/function.js';
+import { json } from '@sveltejs/kit';
+/**
+ * DELETE handler for the collection API endpoint to delete a document by its ID.
+ */
+export async function restDeleteById(event) {
+    //
+    const { rime } = event.locals;
+    const slug = event.params.slug;
+    if (!rime.config.isCollection(slug)) {
+        return handleError(new RimeError(RimeError.NOT_FOUND), { context: 'api' });
+    }
+    const id = event.params.id || '';
+    const [error] = await trycatch(() => rime.collection(slug).deleteById({ id }));
+    if (error) {
+        return handleError(error, { context: 'api' });
+    }
+    return json({ id });
+}

package/dist/core/collections/{api → rest}/duplicate.server.d.ts

@@ -1,5 +1,5 @@
 import { type RequestEvent } from '@sveltejs/kit';
-export default function (slug: string): (event: RequestEvent) => Promise<Response | import("@sveltejs/kit").ActionFailure<{
+export declare function restDuplicate(event: RequestEvent): Promise<Response | import("@sveltejs/kit").ActionFailure<{
     form: Record<string, any>;
     errors: import("../../../types").FormErrors;
 }> | import("@sveltejs/kit").ActionFailure<{

package/dist/core/collections/rest/duplicate.server.js

@@ -0,0 +1,16 @@
+import { handleError } from '../../errors/handler.server.js';
+import { RimeError } from '../../errors/index.js';
+import { error, json } from '@sveltejs/kit';
+export async function restDuplicate(event) {
+    //
+    const { rime } = event.locals;
+    const slug = event.params.slug;
+    if (!rime.config.isCollection(slug)) {
+        return handleError(new RimeError(RimeError.NOT_FOUND), { context: 'api' });
+    }
+    const collection = rime.collection(slug);
+    if (!event.params.id)
+        throw error(404);
+    const newId = await collection.duplicate({ id: event.params.id });
+    return json({ id: newId });
+}

package/dist/core/collections/{api → rest}/get.server.d.ts

@@ -1,6 +1,8 @@
-import type { CollectionSlug } from '../../types/doc.js';
 import { type RequestEvent } from '@sveltejs/kit';
-export default function (slug: CollectionSlug): (event: RequestEvent) => Promise<Response | import("@sveltejs/kit").ActionFailure<{
+/**
+ * GET handler for the collection API endpoint.
+ */
+export declare function restGet(event: RequestEvent): Promise<Response | import("@sveltejs/kit").ActionFailure<{
     form: Record<string, any>;
     errors: import("../../../types").FormErrors;
 }> | import("@sveltejs/kit").ActionFailure<{

package/dist/core/collections/rest/get.server.js

@@ -0,0 +1,50 @@
+import { normalizeQuery } from '../../../adapter-sqlite/util.server.js';
+import { PARAMS } from '../../constant.js';
+import { RimeError } from '../../errors/index.js';
+import { handleError } from '../../errors/handler.server.js';
+import { trycatch } from '../../../util/function.js';
+import { json } from '@sveltejs/kit';
+/**
+ * GET handler for the collection API endpoint.
+ */
+export async function restGet(event) {
+    //
+    const { rime } = event.locals;
+    const slug = event.params.slug;
+    if (!rime.config.isCollection(slug)) {
+        return handleError(new RimeError(RimeError.NOT_FOUND), { context: 'api' });
+    }
+    const params = event.url.searchParams;
+    const hasQueryParams = !!params
+        .keys()
+        .filter((key) => key.startsWith('where'))
+        .toArray().length;
+    const collectionAPI = rime.collection(slug);
+    function buildSelect(params) {
+        const paramSelect = params.get(PARAMS.SELECT)
+            ? params.get(PARAMS.SELECT).split(',')
+            : undefined;
+        if (paramSelect &&
+            paramSelect.includes('title') &&
+            !paramSelect.includes(collectionAPI.config.asTitle)) {
+            paramSelect.push(collectionAPI.config.asTitle);
+        }
+        return paramSelect;
+    }
+    const query = hasQueryParams ? normalizeQuery(event.url.search.substring(1)) : undefined;
+    const apiParams = {
+        locale: rime.getLocale(),
+        sort: params.get(PARAMS.SORT) || undefined,
+        depth: params.get(PARAMS.DEPTH) ? parseInt(params.get(PARAMS.DEPTH)) : 0,
+        limit: params.get(PARAMS.LIMIT) ? parseInt(params.get(PARAMS.LIMIT)) : undefined,
+        offset: params.get(PARAMS.OFFSET) ? parseInt(params.get(PARAMS.OFFSET)) : undefined,
+        draft: params.get(PARAMS.DRAFT) ? params.get(PARAMS.DRAFT) === 'true' : undefined,
+        query,
+        select: buildSelect(params)
+    };
+    const [error, docs] = await trycatch(() => collectionAPI.find(apiParams));
+    if (error) {
+        return handleError(error, { context: 'api' });
+    }
+    return json({ docs }, { status: 200 });
+}

package/dist/core/collections/{api → rest}/getById.server.d.ts

@@ -1,6 +1,8 @@
-import type { CollectionSlug } from '../../types/doc.js';
 import { type RequestEvent } from '@sveltejs/kit';
-export default function (slug: CollectionSlug): (event: RequestEvent) => Promise<Response | import("@sveltejs/kit").ActionFailure<{
+/**
+ * GET handler for the collection API endpoint to retrieve a document by its ID.
+ */
+export declare function restGetById(event: RequestEvent): Promise<Response | import("@sveltejs/kit").ActionFailure<{
     form: Record<string, any>;
     errors: import("../../../types").FormErrors;
 }> | import("@sveltejs/kit").ActionFailure<{

package/dist/core/collections/rest/getById.server.js

@@ -0,0 +1,35 @@
+import { PARAMS } from '../../constant.js';
+import { RimeError } from '../../errors/index.js';
+import { handleError } from '../../errors/handler.server.js';
+import { trycatch } from '../../../util/function.js';
+import { json } from '@sveltejs/kit';
+/**
+ * GET handler for the collection API endpoint to retrieve a document by its ID.
+ */
+export async function restGetById(event) {
+    //
+    const { rime } = event.locals;
+    const slug = event.params.slug;
+    const id = event.params.id;
+    if (!rime.config.isCollection(slug) || !id) {
+        return handleError(new RimeError(RimeError.NOT_FOUND), { context: 'api' });
+    }
+    const paramDepth = event.url.searchParams.get(PARAMS.DEPTH);
+    const paramDraft = event.url.searchParams.get(PARAMS.DRAFT);
+    const versionId = event.url.searchParams.get(PARAMS.VERSION_ID) || undefined;
+    const draft = paramDraft ? paramDraft === 'true' : undefined;
+    const depth = typeof paramDepth === 'string' ? parseInt(paramDepth) : 0;
+    const select = event.url.searchParams.get(PARAMS.SELECT)?.split(',') || undefined;
+    const [error, document] = await trycatch(() => rime.collection(slug).findById({
+        id,
+        locale: rime.getLocale(),
+        depth,
+        draft,
+        versionId,
+        select
+    }));
+    if (error) {
+        return handleError(error, { context: 'api' });
+    }
+    return json({ doc: document });
+}

package/dist/core/collections/rest/index.server.d.ts

@@ -0,0 +1,16 @@
+import { restCreate } from './create.server.js';
+import { restDelete } from './delete.server.js';
+import { restDeleteById } from './deleteById.server.js';
+import { restDuplicate } from './duplicate.server.js';
+import { restGet } from './get.server.js';
+import { restGetById } from './getById.server.js';
+import { restUpdateById } from './updateById.server.js';
+export declare const rest: {
+    get: typeof restGet;
+    getById: typeof restGetById;
+    deleteById: typeof restDeleteById;
+    delete: typeof restDelete;
+    create: typeof restCreate;
+    updateById: typeof restUpdateById;
+    duplicate: typeof restDuplicate;
+};

package/dist/core/collections/rest/index.server.js

@@ -0,0 +1,16 @@
+import { restCreate } from './create.server.js';
+import { restDelete } from './delete.server.js';
+import { restDeleteById } from './deleteById.server.js';
+import { restDuplicate } from './duplicate.server.js';
+import { restGet } from './get.server.js';
+import { restGetById } from './getById.server.js';
+import { restUpdateById } from './updateById.server.js';
+export const rest = {
+    get: restGet,
+    getById: restGetById,
+    deleteById: restDeleteById,
+    delete: restDelete,
+    create: restCreate,
+    updateById: restUpdateById,
+    duplicate: restDuplicate
+};

package/dist/core/collections/{api → rest}/updateById.server.d.ts

@@ -1,6 +1,8 @@
-import type { CollectionSlug } from '../../types/doc.js';
 import { type RequestEvent } from '@sveltejs/kit';
-export default function (slug: CollectionSlug): (event: RequestEvent) => Promise<Response | import("@sveltejs/kit").ActionFailure<{
+/**
+ * PATCH handler for the collection API endpoint to update a document by its ID.
+ */
+export declare function restUpdateById(event: RequestEvent): Promise<Response | import("@sveltejs/kit").ActionFailure<{
     form: Record<string, any>;
     errors: import("../../../types").FormErrors;
 }> | import("@sveltejs/kit").ActionFailure<{

package/dist/core/collections/rest/updateById.server.js

@@ -0,0 +1,44 @@
+import { PARAMS } from '../../constant.js';
+import { ERROR_CONTEXT, handleError } from '../../errors/handler.server.js';
+import { RimeError } from '../../errors/index.js';
+import { extractData } from '../../operations/extract-data.server.js';
+import { trycatch } from '../../../util/function.js';
+import { json } from '@sveltejs/kit';
+/**
+ * PATCH handler for the collection API endpoint to update a document by its ID.
+ */
+export async function restUpdateById(event) {
+    //
+    const { rime } = event.locals;
+    const slug = event.params.slug;
+    const id = event.params.id;
+    // Check if the slug corresponds to a valid collection and if the ID is provided
+    if (!rime.config.isCollection(slug) || !id) {
+        return handleError(new RimeError(RimeError.NOT_FOUND), { context: ERROR_CONTEXT.API });
+    }
+    // Extract query parameters for versioning and draft status
+    const versionId = event.url.searchParams.get(PARAMS.VERSION_ID) || undefined;
+    const draft = event.url.searchParams.get(PARAMS.DRAFT)
+        ? event.url.searchParams.get(PARAMS.DRAFT) === 'true'
+        : undefined;
+    // Extract data from the request body
+    const [extractError, data] = await trycatch(() => extractData(event.request));
+    if (extractError) {
+        return handleError(extractError, { context: ERROR_CONTEXT.API });
+    }
+    // Set the locale if provided in the data
+    if (data.locale) {
+        rime.setLocale(data.locale);
+    }
+    const [error, document] = await trycatch(() => rime.collection(slug).updateById({
+        id,
+        data,
+        locale: rime.getLocale(),
+        versionId,
+        draft
+    }));
+    if (error) {
+        return handleError(error, { context: ERROR_CONTEXT.API });
+    }
+    return json({ doc: document });
+}