@dinoxx/dinox-cli 2.2.0 → 2.4.0

package/dist/vendor/electron/shared/saved-views.d.ts

@@ -0,0 +1,394 @@
+import { z } from 'zod';
+import type { AiErrorCode } from './ai-errors.js';
+import { type PropertyDefConfig, type PropertyOption, type PropertyType } from './note-properties.js';
+export declare const SAVED_VIEW_DISPLAY_ONLY_SYSTEM_FIELDS: readonly ["cover", "audio", "video", "file"];
+export declare const SAVED_VIEW_SYSTEM_FIELDS: readonly ["title", "created_at", "updated_at", "tags", "zettel_boxes", "source", "type", "primary_resource_type", "starred_at", "images", "cover", "audio", "video", "file"];
+export type SavedViewSystemField = (typeof SAVED_VIEW_SYSTEM_FIELDS)[number];
+export type SavedViewFieldRef = `sys.${SavedViewSystemField}` | `prop.${string}`;
+/** Host note id. Valid only as a `$self` value source, never as a column. */
+export declare const SAVED_VIEW_SELF_ID_FIELD: "sys.id";
+export type SavedViewSelfSourceFieldRef = SavedViewFieldRef | typeof SAVED_VIEW_SELF_ID_FIELD;
+export declare const SAVED_VIEW_PRIMARY_RESOURCE_TYPES: readonly ["audio", "video", "file", "image"];
+export type SavedViewPrimaryResourceType = (typeof SAVED_VIEW_PRIMARY_RESOURCE_TYPES)[number];
+export declare function isSavedViewDisplayOnlyField(field: SavedViewFieldRef): boolean;
+export declare function isSavedViewFieldRef(value: unknown): value is SavedViewFieldRef;
+export declare function isSavedViewSelfSourceFieldRef(value: unknown): value is SavedViewSelfSourceFieldRef;
+export declare const savedViewFieldRefSchema: z.ZodCustom<SavedViewFieldRef, SavedViewFieldRef>;
+export declare const SAVED_VIEW_FILTER_OPERATORS: readonly ["equals", "notEquals", "contains", "notContains", "greaterThan", "greaterThanOrEqual", "lessThan", "lessThanOrEqual", "isEmpty", "isNotEmpty", "withinLastDays", "isToday", "isThisWeek", "isThisMonth"];
+export type SavedViewFilterOperator = (typeof SAVED_VIEW_FILTER_OPERATORS)[number];
+export type SavedViewFilterValue = string | number | boolean | null;
+export declare const MAX_SAVED_VIEW_RELATIVE_DAYS = 3650;
+export declare const SAVED_VIEW_DYNAMIC_DATE_FILTER_OPERATORS: readonly ["withinLastDays", "isToday", "isThisWeek", "isThisMonth"];
+export declare function isSavedViewDynamicDateFilterOperator(operator: SavedViewFilterOperator): operator is (typeof SAVED_VIEW_DYNAMIC_DATE_FILTER_OPERATORS)[number];
+export declare function getSavedViewFilterOperatorsForPropertyType(type: PropertyType): SavedViewFilterOperator[];
+export declare function getSavedViewFilterOperatorsForField(field: SavedViewFieldRef, type: PropertyType): SavedViewFilterOperator[];
+export declare function canSortSavedViewPropertyType(type: PropertyType): boolean;
+export declare function canSortSavedViewField(field: SavedViewFieldRef, type: PropertyType): boolean;
+export declare function dedupeSavedViewFieldRefs(fields: SavedViewFieldRef[]): SavedViewFieldRef[];
+export declare function normalizeSavedViewColumnFieldRefs(fields: SavedViewFieldRef[]): SavedViewFieldRef[];
+/** Filter value taken from the note that hosts this view. Compiled before SQL runs. */
+export interface SavedViewFilterSelfValueRef {
+    kind: 'self';
+    field: SavedViewSelfSourceFieldRef;
+}
+export interface SavedViewFilterCondition {
+    kind: 'condition';
+    field: SavedViewFieldRef;
+    operator: SavedViewFilterOperator;
+    value?: SavedViewFilterValue;
+    /** Mutually exclusive with `value`. Requires filter version 3. */
+    valueRef?: SavedViewFilterSelfValueRef;
+}
+export interface SavedViewFilterGroup {
+    kind: 'group';
+    operator: 'and' | 'or';
+    children: SavedViewFilterNode[];
+}
+export interface SavedViewFilterNot {
+    kind: 'not';
+    child: SavedViewFilterNode;
+}
+export type SavedViewFilterNode = SavedViewFilterCondition | SavedViewFilterGroup | SavedViewFilterNot;
+export interface SavedViewFilter {
+    version: 1 | 2 | 3;
+    root: SavedViewFilterNode | null;
+}
+export declare function isSavedViewSelfValueRef(value: unknown): value is SavedViewFilterSelfValueRef;
+export declare function canSavedViewFilterConditionUseSelfValue(field: SavedViewFieldRef, operator: SavedViewFilterOperator): boolean;
+export declare function canSavedViewSelfSourceField(field: SavedViewSelfSourceFieldRef): boolean;
+export declare const savedViewFilterConditionSchema: z.ZodType<SavedViewFilterCondition>;
+export declare const savedViewFilterNodeSchema: z.ZodType<SavedViewFilterNode>;
+export declare const savedViewFilterGroupSchema: z.ZodType<SavedViewFilterGroup>;
+export declare function savedViewFilterNodeUsesDynamicDate(node: SavedViewFilterNode | null): boolean;
+export declare function savedViewFilterUsesDynamicDate(filter: SavedViewFilter): boolean;
+export declare function savedViewFilterNodeUsesSelf(node: SavedViewFilterNode | null): boolean;
+export declare function savedViewFilterUsesSelf(filter: SavedViewFilter | null | undefined): boolean;
+export declare function createSavedViewFilter(root: SavedViewFilterNode | null): SavedViewFilter;
+export declare function resolveStandaloneSavedViewFilter(config: Pick<SavedViewConfig, 'noteDetail'>, filter: SavedViewFilter): SavedViewFilter;
+export type SavedViewSelfPropertyValue = string | number | boolean | readonly (string | number | boolean)[];
+/** The open note that a `$self` filter is evaluated against. */
+export interface SavedViewSelfHost {
+    id?: string | null;
+    title?: string | null;
+    source?: string | null;
+    type?: string | null;
+    createdAt?: string | null;
+    updatedAt?: string | null;
+    starredAt?: string | null;
+    tags?: readonly string[] | null;
+    zettelBoxes?: readonly string[] | null;
+    properties?: Readonly<Record<string, SavedViewSelfPropertyValue | null>> | null;
+}
+export interface SavedViewSelfBindContext {
+    resolve(field: SavedViewSelfSourceFieldRef): SavedViewFilterValue | undefined;
+}
+export declare function createSavedViewSelfBindContext(host: SavedViewSelfHost): SavedViewSelfBindContext;
+/** Replace resolved `$self` refs with literals. Unresolved refs stay and fail closed in SQL. */
+export declare function bindSavedViewFilter(filter: SavedViewFilter | null | undefined, context: SavedViewSelfBindContext | null | undefined): SavedViewFilter | null;
+/**
+ * A detail section appears only when `noteDetail` matches this note.
+ * The returned filter is the view filter with `$self` bound to the note.
+ */
+export declare function bindDetailSavedView(view: {
+    config: Pick<SavedViewConfig, 'noteDetail'>;
+    filter: SavedViewFilter;
+}, host: SavedViewSelfHost): SavedViewFilter | null;
+export declare const savedViewFilterSchema: z.ZodType<SavedViewFilter>;
+export declare const SAVED_VIEW_LAYOUTS: readonly ["table", "list", "card"];
+export type SavedViewLayout = (typeof SAVED_VIEW_LAYOUTS)[number];
+export interface SavedViewColumn {
+    field: SavedViewFieldRef;
+}
+export interface SavedViewSort {
+    field: SavedViewFieldRef;
+    direction: 'asc' | 'desc';
+}
+/**
+ * Analytics layer on `config_json` (shared contract with dinox-app).
+ * Both clients author and render these keys; every config write must round-trip them.
+ */
+export declare const SAVED_VIEW_CHART_TYPES: readonly ["bar", "line", "pie", "area", "contribute", "waterfall", "ring", "funnel", "scatter", "treemap"];
+export type SavedViewChartType = (typeof SAVED_VIEW_CHART_TYPES)[number];
+export declare const SAVED_VIEW_CHART_AGGREGATIONS: readonly ["count", "sum", "avg"];
+export type SavedViewChartAggregation = (typeof SAVED_VIEW_CHART_AGGREGATIONS)[number];
+export declare const SAVED_VIEW_CHART_TIME_BUCKETS: readonly ["hour", "day", "week", "month"];
+export type SavedViewChartTimeBucket = (typeof SAVED_VIEW_CHART_TIME_BUCKETS)[number];
+export declare const SAVED_VIEW_CHART_EXPR_OPS: readonly ["*", "/", "+", "-"];
+export type SavedViewChartExprOp = (typeof SAVED_VIEW_CHART_EXPR_OPS)[number];
+export declare const MAX_SAVED_VIEW_CHARTS = 5;
+export declare const MAX_SAVED_VIEW_STATS = 6;
+export declare const MAX_SAVED_VIEW_CHART_TITLE_LENGTH = 80;
+export declare const MAX_SAVED_VIEW_STAT_TITLE_LENGTH = 80;
+export declare const MAX_SAVED_VIEW_STAT_UNIT_LENGTH = 16;
+export declare const MAX_SAVED_VIEW_CHART_LIMIT = 500;
+export declare const MAX_SAVED_VIEW_COMPUTED_COLUMNS = 10;
+export declare const MAX_SAVED_VIEW_SUMMARY_ITEMS = 20;
+export declare const MAX_SAVED_VIEW_COMPUTED_COLUMN_TITLE_LENGTH = 80;
+export interface SavedViewChartDimension {
+    field: SavedViewFieldRef;
+    /** Required for date fields; forbidden elsewhere. */
+    timeBucket?: SavedViewChartTimeBucket;
+}
+export interface SavedViewChartBinaryExpr {
+    op: SavedViewChartExprOp;
+    left: SavedViewFieldRef;
+    right: SavedViewFieldRef;
+}
+export interface SavedViewChartMeasure {
+    /** null = COUNT(*); non-null only for number props (sum/avg). Mutually exclusive with `expr`. */
+    field: SavedViewFieldRef | null;
+    aggregation: SavedViewChartAggregation;
+    expr?: SavedViewChartBinaryExpr;
+}
+export interface SavedViewChartOrderBy {
+    by: 'bucket' | 'value';
+    direction: 'asc' | 'desc';
+}
+export interface SavedViewChart {
+    id: string;
+    title?: string;
+    type: SavedViewChartType;
+    dimensions: [SavedViewChartDimension];
+    measures: [SavedViewChartMeasure];
+    orderBy?: SavedViewChartOrderBy;
+    limit?: number;
+}
+export interface SavedViewStat {
+    id: string;
+    title?: string;
+    unit?: string;
+    measure: SavedViewChartMeasure;
+}
+/** `calc.*` is display-only and must not enter SavedViewFieldRef (filter/sort/dimension). */
+export type SavedViewTableColumnKey = SavedViewFieldRef | `calc.${string}`;
+export interface SavedViewComputedColumn {
+    id: string;
+    title?: string;
+    expr: SavedViewChartBinaryExpr;
+}
+export interface SavedViewSummaryItem {
+    column: SavedViewTableColumnKey;
+    aggregation: SavedViewChartAggregation;
+}
+export interface SavedViewNoteDetailRule {
+    field: SavedViewFieldRef;
+    value: string | number | boolean;
+}
+export interface SavedViewConfig {
+    version: 1;
+    /** When a filter uses `$self`, a standalone open lists notes matching this rule. */
+    noteDetail?: SavedViewNoteDetailRule;
+    layout: SavedViewLayout;
+    columns: SavedViewColumn[];
+    sort?: SavedViewSort[];
+    /** KPI blocks over the whole filtered scope. */
+    stats?: SavedViewStat[];
+    /** Aggregate charts over the whole filtered scope. */
+    charts?: SavedViewChart[];
+    /** Row-level binary expressions shown after `columns` as `calc.<id>`. */
+    computedColumns?: SavedViewComputedColumn[];
+    /** Table footer aggregates keyed by column. */
+    summary?: SavedViewSummaryItem[];
+}
+export declare const savedViewColumnSchema: z.ZodType<SavedViewColumn>;
+export declare const savedViewSortSchema: z.ZodType<SavedViewSort>;
+export declare function isSavedViewDateField(field: SavedViewFieldRef, type?: PropertyType): boolean;
+export declare function isSavedViewMultiValueField(field: SavedViewFieldRef, type?: PropertyType): boolean;
+export declare function canGroupSavedViewChartByField(field: SavedViewFieldRef, type?: PropertyType): boolean;
+export declare function getSavedViewChartTimeBucketsForField(field: SavedViewFieldRef, type?: PropertyType): SavedViewChartTimeBucket[];
+export declare function canUseSavedViewChartMeasureField(field: SavedViewFieldRef, type?: PropertyType): boolean;
+export declare function getSavedViewChartAggregationsForDimension(dimensionField: SavedViewFieldRef, dimensionType?: PropertyType): SavedViewChartAggregation[];
+export declare const savedViewChartSchema: z.ZodType<SavedViewChart>;
+export declare const savedViewStatSchema: z.ZodType<SavedViewStat>;
+export declare function isSavedViewTableColumnKey(value: unknown): value is SavedViewTableColumnKey;
+export declare const savedViewComputedColumnSchema: z.ZodType<SavedViewComputedColumn>;
+export declare const savedViewSummaryItemSchema: z.ZodType<SavedViewSummaryItem>;
+export declare const savedViewConfigSchema: z.ZodType<SavedViewConfig>;
+export declare function createDefaultSavedViewFilter(): SavedViewFilter;
+export declare function createDefaultSavedViewConfig(): SavedViewConfig;
+export interface SavedViewPlanFieldInput {
+    field: SavedViewFieldRef;
+    label: string;
+    type: PropertyType;
+    description?: string;
+    options?: PropertyOption[];
+    config?: PropertyDefConfig;
+    configInvalid?: boolean;
+    optionsInvalid?: boolean;
+    optionsMigrationPending?: boolean;
+}
+export interface GeneratedSavedViewPlan {
+    name: string;
+    filter: SavedViewFilter;
+    config: SavedViewConfig;
+}
+export interface AiGenerateSavedViewPlanRequest {
+    prompt: string;
+    /** Secret-free selector resolved against the authenticated user's model rows. */
+    modelSelector?: string;
+    locale?: string;
+    timeZone?: string;
+}
+export interface AiGenerateSavedViewPlanResponse {
+    ok: boolean;
+    plan?: GeneratedSavedViewPlan;
+    error?: string;
+    errorCode?: AiErrorCode;
+    metadata?: Record<string, unknown>;
+}
+export declare const aiGenerateSavedViewPlanRequestSchema: z.ZodType<AiGenerateSavedViewPlanRequest>;
+export interface SavedViewCatalogInput {
+    userId: string;
+    limit?: number;
+}
+export interface SavedViewCatalogRow {
+    id: string;
+    user_id: string | null;
+    name: string | null;
+    emoji: string | null;
+    filter_json: string | null;
+    view_type: string | null;
+    config_json: string | null;
+    template_id: string | null;
+    group_id: string | null;
+    sort_rank: number | null;
+    pinned_at: string | null;
+    created_at: string | null;
+    updated_at: string | null;
+    is_del: number | null;
+}
+export interface SavedViewCreateInput {
+    userId: string;
+    name: string;
+    emoji?: string | null;
+    filter: SavedViewFilter;
+    config: SavedViewConfig;
+    templateId?: string | null;
+    groupId?: string | null;
+    sortRank?: number | null;
+    pinnedAt?: string | null;
+    updatedAt: string;
+}
+export interface SavedViewUpdateInput {
+    id: string;
+    userId: string;
+    name?: string;
+    emoji?: string | null;
+    filter?: SavedViewFilter;
+    config?: SavedViewConfig;
+    templateId?: string | null;
+    groupId?: string | null;
+    sortRank?: number | null;
+    pinnedAt?: string | null;
+    updatedAt: string;
+}
+export interface SavedViewSoftDeleteInput {
+    id: string;
+    userId: string;
+    updatedAt: string;
+}
+export interface SavedViewPageInput {
+    viewId: string;
+    userId: string;
+    timeZone?: string;
+    limit?: number;
+    offset?: number;
+}
+export interface SavedViewPageRow {
+    id: string;
+    title: string | null;
+    created_at: string | null;
+    updated_at: string | null;
+    tags: string | null;
+    zettel_boxes: string | null;
+    zettel_box_details: string | null;
+    source: string | null;
+    type: string | null;
+    starred_at: string | null;
+    properties: string | null;
+    images?: string | null;
+    primary_resource_type?: string | null;
+}
+declare const savedViewZettelBoxDetailsSchema: z.ZodArray<z.ZodObject<{
+    fullPath: z.ZodString;
+    color: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>>;
+export type SavedViewZettelBoxDetails = z.infer<typeof savedViewZettelBoxDetailsSchema>;
+export declare function parseSavedViewZettelBoxDetails(value: string | null | undefined): SavedViewZettelBoxDetails;
+export interface SavedViewCountInput {
+    viewId: string;
+    userId: string;
+    timeZone?: string;
+}
+/** A page and its count resolved from the same database snapshot. */
+export interface SavedViewSnapshotRow {
+    rows: SavedViewPageRow[];
+    total_count: number;
+}
+export interface SavedViewCountRow {
+    total_count: number;
+}
+export declare const savedViewCatalogInputSchema: z.ZodType<SavedViewCatalogInput>;
+export declare const savedViewCreateInputSchema: z.ZodType<SavedViewCreateInput>;
+export declare const savedViewUpdateInputSchema: z.ZodType<SavedViewUpdateInput>;
+export declare const savedViewSoftDeleteInputSchema: z.ZodType<SavedViewSoftDeleteInput>;
+export declare const savedViewPageInputSchema: z.ZodType<SavedViewPageInput>;
+export declare const savedViewCountInputSchema: z.ZodType<SavedViewCountInput>;
+/**
+ * Analytics layer (stats / charts / summary row) for one saved view.
+ * Aggregates run over the same scope as the table (owner + not deleted + view filter),
+ * never over the visible page. `draft` lets editors preview unsaved items; when omitted
+ * the stored config is used.
+ */
+export interface SavedViewAnalyticsDraft {
+    stats?: SavedViewStat[];
+    charts?: SavedViewChart[];
+    computedColumns?: SavedViewComputedColumn[];
+    summary?: SavedViewSummaryItem[];
+}
+export interface SavedViewAnalyticsInput {
+    viewId: string;
+    userId: string;
+    timeZone?: string;
+    draft?: SavedViewAnalyticsDraft;
+}
+export interface SavedViewChartResultRow {
+    bucket: string | number | null;
+    value: number | null;
+    /** Display label resolved in SQL when the bucket is an id (e.g. card boxes). */
+    label?: string | null;
+}
+export interface SavedViewAnalyticsRow {
+    stats: Array<{
+        id: string;
+        value: number | null;
+        unavailable: boolean;
+    }>;
+    charts: Array<{
+        id: string;
+        rows: SavedViewChartResultRow[];
+        unavailable: boolean;
+    }>;
+    summary: Array<{
+        column: SavedViewTableColumnKey;
+        aggregation: SavedViewChartAggregation;
+        value: number | null;
+        unavailable: boolean;
+    }>;
+}
+export declare const savedViewAnalyticsInputSchema: z.ZodType<SavedViewAnalyticsInput>;
+export interface SavedViewNoteDetailInput {
+    userId: string;
+    noteId: string;
+    timeZone?: string;
+    limit?: number;
+}
+export interface SavedViewNoteDetailSection {
+    view_id: string;
+    name: string;
+    emoji: string | null;
+    total_count: number;
+    rows: SavedViewPageRow[];
+}
+export declare const savedViewNoteDetailInputSchema: z.ZodType<SavedViewNoteDetailInput>;
+export {};