@kernhq/module-quire 0.5.0 → 0.6.1

package/dist/server/services/databases.d.ts

@@ -0,0 +1,330 @@
+import type { Principal } from '@kernhq/contracts';
+import { type Kernel, type Tx } from '@kernhq/kernel';
+import type { Database, Property, Row, View, ViewConfig } from '../../contract/index.js';
+import { pages, properties, views } from '../schema.js';
+import type { QuireAccess } from './access.js';
+type PropertyRow = typeof properties.$inferSelect;
+type ViewRow = typeof views.$inferSelect;
+type PageRow = typeof pages.$inferSelect;
+export declare const toProperty: (r: PropertyRow) => Property;
+export declare const toView: (r: ViewRow) => View;
+export declare const toRow: (p: PageRow) => Row;
+export declare function quireDatabases(kernel: Kernel, access: QuireAccess): {
+    get(tx: Tx, workspaceId: string, databaseId: string): Promise<Database>;
+    /**
+     * Create a database on a page.
+     *
+     * It arrives with a title property and a table view, because a database with no columns and no
+     * view is a screen with nothing on it and no obvious way forward.
+     */
+    create(tx: Tx, principal: Principal, workspaceId: string, input: {
+        spaceId: string;
+        pageId: string;
+        name: string;
+        inline: boolean;
+    }): Promise<{
+        id: string;
+        workspaceId: string;
+        spaceId: string;
+        pageId: string;
+        name: string;
+        description: string;
+        inline: boolean;
+        properties: {
+            id: string;
+            databaseId: string;
+            key: string;
+            name: string;
+            type: "number" | "date" | "email" | "text" | "select" | "multi_select" | "status" | "person" | "files" | "checkbox" | "url" | "phone" | "relation" | "rollup" | "formula" | "created_time" | "created_by" | "edited_time" | "edited_by";
+            config: {
+                options?: {
+                    id: string;
+                    label: string;
+                    colour: string;
+                    group?: "todo" | "doing" | "done" | undefined;
+                }[] | undefined;
+                format?: string | undefined;
+                precision?: number | undefined;
+                includeTime?: boolean | undefined;
+                isRange?: boolean | undefined;
+                relationDatabaseId?: string | undefined;
+                relationPropertyId?: string | undefined;
+                rollupRelationPropertyId?: string | undefined;
+                rollupTargetPropertyId?: string | undefined;
+                rollupFunction?: "count" | "count_values" | "count_unique" | "sum" | "average" | "min" | "max" | "range" | "show_original" | "checked" | "unchecked" | "percent_checked" | undefined;
+                expression?: string | undefined;
+                multiple?: boolean | undefined;
+            };
+            position: string;
+            hidden: boolean;
+        }[];
+        views: {
+            id: string;
+            databaseId: string;
+            name: string;
+            kind: "table" | "board" | "calendar" | "gallery" | "list" | "timeline";
+            config: {
+                filters: {
+                    propertyKey: string;
+                    operator: "equals" | "not_equals" | "contains" | "not_contains" | "starts_with" | "ends_with" | "is_empty" | "is_not_empty" | "greater_than" | "less_than" | "on_or_before" | "on_or_after" | "is_any_of" | "is_none_of";
+                    value?: unknown;
+                }[];
+                filterMode: "and" | "or";
+                sorts: {
+                    propertyKey: string;
+                    direction: "asc" | "desc";
+                }[];
+                groupBy: string | null;
+                dateProperty: string | null;
+                visibleProperties: string[] | null;
+                columnWidths: Record<string, number>;
+                cardSize: "small" | "medium" | "large";
+                coverProperty: string | null;
+            };
+            position: string;
+            isDefault: boolean;
+        }[];
+        createdAt: string;
+        updatedAt: string;
+    }>;
+    addProperty(tx: Tx, workspaceId: string, databaseId: string, input: {
+        name: string;
+        type: Property["type"];
+        config?: Property["config"];
+    }): Promise<{
+        id: string;
+        databaseId: string;
+        key: string;
+        name: string;
+        type: "number" | "date" | "email" | "text" | "select" | "multi_select" | "status" | "person" | "files" | "checkbox" | "url" | "phone" | "relation" | "rollup" | "formula" | "created_time" | "created_by" | "edited_time" | "edited_by";
+        config: {
+            options?: {
+                id: string;
+                label: string;
+                colour: string;
+                group?: "todo" | "doing" | "done" | undefined;
+            }[] | undefined;
+            format?: string | undefined;
+            precision?: number | undefined;
+            includeTime?: boolean | undefined;
+            isRange?: boolean | undefined;
+            relationDatabaseId?: string | undefined;
+            relationPropertyId?: string | undefined;
+            rollupRelationPropertyId?: string | undefined;
+            rollupTargetPropertyId?: string | undefined;
+            rollupFunction?: "count" | "count_values" | "count_unique" | "sum" | "average" | "min" | "max" | "range" | "show_original" | "checked" | "unchecked" | "percent_checked" | undefined;
+            expression?: string | undefined;
+            multiple?: boolean | undefined;
+        };
+        position: string;
+        hidden: boolean;
+    }>;
+    /**
+     * Rename, retype or reconfigure a column.
+     *
+     * The `key` never changes, because it is what every row's `props` is keyed by — renaming a
+     * column must not empty it. That is the whole reason a key exists separately from a name.
+     */
+    updateProperty(tx: Tx, workspaceId: string, propertyId: string, patch: Partial<Pick<PropertyRow, "name" | "type" | "config" | "hidden" | "position">>): Promise<{
+        id: string;
+        databaseId: string;
+        key: string;
+        name: string;
+        type: "number" | "date" | "email" | "text" | "select" | "multi_select" | "status" | "person" | "files" | "checkbox" | "url" | "phone" | "relation" | "rollup" | "formula" | "created_time" | "created_by" | "edited_time" | "edited_by";
+        config: {
+            options?: {
+                id: string;
+                label: string;
+                colour: string;
+                group?: "todo" | "doing" | "done" | undefined;
+            }[] | undefined;
+            format?: string | undefined;
+            precision?: number | undefined;
+            includeTime?: boolean | undefined;
+            isRange?: boolean | undefined;
+            relationDatabaseId?: string | undefined;
+            relationPropertyId?: string | undefined;
+            rollupRelationPropertyId?: string | undefined;
+            rollupTargetPropertyId?: string | undefined;
+            rollupFunction?: "count" | "count_values" | "count_unique" | "sum" | "average" | "min" | "max" | "range" | "show_original" | "checked" | "unchecked" | "percent_checked" | undefined;
+            expression?: string | undefined;
+            multiple?: boolean | undefined;
+        };
+        position: string;
+        hidden: boolean;
+    }>;
+    removeProperty(tx: Tx, workspaceId: string, propertyId: string): Promise<{
+        id: string;
+        databaseId: string;
+        key: string;
+        name: string;
+        type: "number" | "date" | "email" | "text" | "select" | "multi_select" | "status" | "person" | "files" | "checkbox" | "url" | "phone" | "relation" | "rollup" | "formula" | "created_time" | "created_by" | "edited_time" | "edited_by";
+        config: {
+            options?: {
+                id: string;
+                label: string;
+                colour: string;
+                group?: "todo" | "doing" | "done" | undefined;
+            }[] | undefined;
+            format?: string | undefined;
+            precision?: number | undefined;
+            includeTime?: boolean | undefined;
+            isRange?: boolean | undefined;
+            relationDatabaseId?: string | undefined;
+            relationPropertyId?: string | undefined;
+            rollupRelationPropertyId?: string | undefined;
+            rollupTargetPropertyId?: string | undefined;
+            rollupFunction?: "count" | "count_values" | "count_unique" | "sum" | "average" | "min" | "max" | "range" | "show_original" | "checked" | "unchecked" | "percent_checked" | undefined;
+            expression?: string | undefined;
+            multiple?: boolean | undefined;
+        };
+        position: string;
+        hidden: boolean;
+    }>;
+    addView(tx: Tx, workspaceId: string, databaseId: string, input: {
+        name: string;
+        kind: View["kind"];
+        config?: Partial<ViewConfig>;
+    }): Promise<{
+        id: string;
+        databaseId: string;
+        name: string;
+        kind: "table" | "board" | "calendar" | "gallery" | "list" | "timeline";
+        config: {
+            filters: {
+                propertyKey: string;
+                operator: "equals" | "not_equals" | "contains" | "not_contains" | "starts_with" | "ends_with" | "is_empty" | "is_not_empty" | "greater_than" | "less_than" | "on_or_before" | "on_or_after" | "is_any_of" | "is_none_of";
+                value?: unknown;
+            }[];
+            filterMode: "and" | "or";
+            sorts: {
+                propertyKey: string;
+                direction: "asc" | "desc";
+            }[];
+            groupBy: string | null;
+            dateProperty: string | null;
+            visibleProperties: string[] | null;
+            columnWidths: Record<string, number>;
+            cardSize: "small" | "medium" | "large";
+            coverProperty: string | null;
+        };
+        position: string;
+        isDefault: boolean;
+    }>;
+    updateView(tx: Tx, workspaceId: string, viewId: string, patch: Partial<Pick<ViewRow, "name" | "kind" | "config" | "position">>): Promise<{
+        id: string;
+        databaseId: string;
+        name: string;
+        kind: "table" | "board" | "calendar" | "gallery" | "list" | "timeline";
+        config: {
+            filters: {
+                propertyKey: string;
+                operator: "equals" | "not_equals" | "contains" | "not_contains" | "starts_with" | "ends_with" | "is_empty" | "is_not_empty" | "greater_than" | "less_than" | "on_or_before" | "on_or_after" | "is_any_of" | "is_none_of";
+                value?: unknown;
+            }[];
+            filterMode: "and" | "or";
+            sorts: {
+                propertyKey: string;
+                direction: "asc" | "desc";
+            }[];
+            groupBy: string | null;
+            dateProperty: string | null;
+            visibleProperties: string[] | null;
+            columnWidths: Record<string, number>;
+            cardSize: "small" | "medium" | "large";
+            coverProperty: string | null;
+        };
+        position: string;
+        isDefault: boolean;
+    }>;
+    removeView(tx: Tx, workspaceId: string, viewId: string): Promise<{
+        id: string;
+        databaseId: string;
+        name: string;
+        kind: "table" | "board" | "calendar" | "gallery" | "list" | "timeline";
+        config: {
+            filters: {
+                propertyKey: string;
+                operator: "equals" | "not_equals" | "contains" | "not_contains" | "starts_with" | "ends_with" | "is_empty" | "is_not_empty" | "greater_than" | "less_than" | "on_or_before" | "on_or_after" | "is_any_of" | "is_none_of";
+                value?: unknown;
+            }[];
+            filterMode: "and" | "or";
+            sorts: {
+                propertyKey: string;
+                direction: "asc" | "desc";
+            }[];
+            groupBy: string | null;
+            dateProperty: string | null;
+            visibleProperties: string[] | null;
+            columnWidths: Record<string, number>;
+            cardSize: "small" | "medium" | "large";
+            coverProperty: string | null;
+        };
+        position: string;
+        isDefault: boolean;
+    }>;
+    /**
+     * The rows of a database, filtered and ordered by a view.
+     *
+     * Filtering happens in SQL rather than after the fact: a page of fifty rows filtered down to
+     * three is not a page of three, and the caller has no way to ask for the rest.
+     */
+    rows(tx: Tx, workspaceId: string, databaseId: string, opts: {
+        view?: View | null;
+        limit: number;
+        cursor: string | null;
+    }): Promise<{
+        items: {
+            id: string;
+            databaseId: string;
+            title: string;
+            icon: string | null;
+            props: Record<string, unknown>;
+            computed: Record<string, unknown>;
+            createdBy: (string & import("zod").$brand<"UserId">) | null;
+            updatedBy: (string & import("zod").$brand<"UserId">) | null;
+            createdAt: string;
+            updatedAt: string;
+        }[];
+        nextCursor: string | null;
+    }>;
+    /**
+     * Recompute the formulas and rollups of one row.
+     *
+     * Written into `computed` rather than calculated on read, so a view can filter and sort by a
+     * formula in SQL like any other column. The cost is that a change has to say what it invalidates
+     * — which is what `formulaDependencies` is for.
+     */
+    recompute(tx: Tx, workspaceId: string, pageId: string): Promise<Record<string, unknown> | null>;
+    /** Gather the values on the other side of a relation and reduce them. */
+    rollup(tx: Tx, workspaceId: string, pageId: string, property: Property, all: Property[]): Promise<unknown>;
+    /**
+     * Set both ends of a relation.
+     *
+     * Symmetric by construction rather than by convention: a link set from one side that is not
+     * visible from the other is the bug people report as "the rollup is wrong".
+     */
+    setRelation(tx: Tx, workspaceId: string, propertyId: string, fromPageId: string, toPageIds: string[]): Promise<void>;
+    /**
+     * Which other rows have to be recomputed because this one changed.
+     *
+     * Only the rows that roll up *through* a relation that reaches this one — recomputing the whole
+     * database on every keystroke would be correct and unusable.
+     */
+    dependentsOf(tx: Tx, workspaceId: string, pageId: string): Promise<string[]>;
+    /** One row, after it has been written. */
+    rowById(tx: Tx, workspaceId: string, pageId: string): Promise<Row>;
+    /**
+     * Write cells, merging rather than replacing.
+     *
+     * A table sends the cell somebody edited, not the whole row — replacing would blank every
+     * column the client happened not to know about, which is every column added since it loaded.
+     */
+    setRowFields(tx: Tx, workspaceId: string, pageId: string, databaseId: string | null, props: Record<string, unknown>): Promise<void>;
+    /** The columns a formula reads, so a property rename can report what it would break. */
+    dependenciesOf(expression: string): string[];
+    kernel: Kernel;
+};
+export type QuireDatabases = ReturnType<typeof quireDatabases>;
+export {};
+//# sourceMappingURL=databases.d.ts.map

package/dist/server/services/databases.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"databases.d.ts","sourceRoot":"","sources":["../../../src/server/services/databases.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EAAa,KAAK,MAAM,EAAE,KAAK,EAAE,EAAU,MAAM,gBAAgB,CAAA;AAGxE,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAQxF,OAAO,EAAa,KAAK,EAAE,UAAU,EAAa,KAAK,EAAE,MAAM,cAAc,CAAA;AAC7E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAG9C,KAAK,WAAW,GAAG,OAAO,UAAU,CAAC,YAAY,CAAA;AACjD,KAAK,OAAO,GAAG,OAAO,KAAK,CAAC,YAAY,CAAA;AACxC,KAAK,OAAO,GAAG,OAAO,KAAK,CAAC,YAAY,CAAA;AAExC,eAAO,MAAM,UAAU,GAAI,GAAG,WAAW,KAAG,QAS1C,CAAA;AAEF,eAAO,MAAM,MAAM,GAAI,GAAG,OAAO,KAAG,IAQlC,CAAA;AAEF,eAAO,MAAM,KAAK,GAAI,GAAG,OAAO,KAAG,GAWjC,CAAA;AAgBF,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW;YAYhD,EAAE,eAAe,MAAM,cAAc,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAkC7E;;;;;OAKG;eAEG,EAAE,aACK,SAAS,eACP,MAAM,SACZ;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBA8CrE,EAAE,eACO,MAAM,cACP,MAAM,SACX;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAA;KAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAuB9E;;;;;OAKG;uBAEG,EAAE,eACO,MAAM,cACP,MAAM,SACX,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBAW9D,EAAE,eAAe,MAAM,cAAc,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAmB9D,EAAE,eACO,MAAM,cACP,MAAM,SACX;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAA;KAAE;;;;;;;;;;;;;;;;;;;;;;;;;;mBAwBrE,EAAE,eACO,MAAM,UACX,MAAM,SACP,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;mBAWnD,EAAE,eAAe,MAAM,UAAU,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;IAY5D;;;;;OAKG;aAEG,EAAE,eACO,MAAM,cACP,MAAM,QACZ;QAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE;;;;;;;;;;;;;;;IAuCpE;;;;;;OAMG;kBACiB,EAAE,eAAe,MAAM,UAAU,MAAM;IAiD3D,yEAAyE;eAEnE,EAAE,eACO,MAAM,UACX,MAAM,YACJ,QAAQ,OACb,QAAQ,EAAE,GACd,OAAO,CAAC,OAAO,CAAC;IA8EnB;;;;;OAKG;oBAEG,EAAE,eACO,MAAM,cACP,MAAM,cACN,MAAM,aACP,MAAM,EAAE;IA2DrB;;;;;OAKG;qBACoB,EAAE,eAAe,MAAM,UAAU,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAQlF,0CAA0C;gBACxB,EAAE,eAAe,MAAM,UAAU,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAUxE;;;;;OAKG;qBAEG,EAAE,eACO,MAAM,UACX,MAAM,cACF,MAAM,GAAG,IAAI,SAClB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAmBhC,wFAAwF;+BAC7D,MAAM,GAAG,MAAM,EAAE;;EAU/C;AACD,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAA"}