@fusebase/fusebase-gate-sdk 1.0.2-sdk.4 → 2.0.7

package/dist/types/dashboard/index.d.ts

@@ -1,215 +0,0 @@
-/**
- * Index Schemas
- *
- * Generated from OpenAPI specification
- * Source: schemas/dashboard/index.yaml
- */
-/**
- * A set of filter conditions with logic
- */
-export interface DashboardViewFilterContract {
-    logic: DashboardViewFilterLogicContract;
-    /**
-     * List of filter conditions
-     */
-    conditions: DashboardViewFilterConditionContract[];
-}
-/**
- * A single filter condition
- */
-export interface DashboardViewFilterConditionContract {
-    /**
-     * Field key (alias)
-     */
-    key: string;
-    operator: DashboardViewFilterOperatorContract;
-    /**
-     * Value or list of values to compare to (not needed for empty/not_empty)
-     *
-     * @openapi-union-type anyOf
-     */
-    value?: string | number | boolean | string[];
-    payload?: DashboardViewFilterConditionPayloadContract;
-}
-/**
- * Additional data for the condition (for future use)
- */
-export interface DashboardViewFilterConditionPayloadContract {
-    /**
-     * Start value (for "custom" date range)
-     */
-    start?: number;
-    /**
-     * End value (for "custom" date range)
-     */
-    end?: number;
-    /**
-     * Time zone (for date conditions)
-     */
-    timeZone?: string;
-}
-/**
- * Logic operator for combining filter conditions
- *
- * @enum "AND", "OR"
- */
-export type DashboardViewFilterLogicContract = "AND" | "OR";
-/**
- * Operator to apply in filter conditions
- *
- * @enum "is", "is_not", "contains", "contains_not", "starts_with", "ends_with", "empty", "not_empty", "has_any_of", "has_none_of", "greater_than", "less_than", "greater_than_or_equal", "less_than_or_equal"
- */
-export type DashboardViewFilterOperatorContract = "is" | "is_not" | "contains" | "contains_not" | "starts_with" | "ends_with" | "empty" | "not_empty" | "has_any_of" | "has_none_of" | "greater_than" | "less_than" | "greater_than_or_equal" | "less_than_or_equal";
-/**
- * Filters and sorting for dashboard views
- */
-export interface DashboardViewFiltersConfigContract {
-    sort?: DashboardViewSortContract;
-    filters?: DashboardViewFilterContract;
-}
-/**
- * Sorting configuration
- */
-export interface DashboardViewSortContract {
-    /**
-     * Field key (alias) to sort by
-     */
-    by?: string;
-    /**
-     * Sort order
-     *
-     * @enum "ASC", "DESC"
-     */
-    order?: "ASC" | "DESC";
-}
-/**
- * Indexing configuration for a single SchemaItem
- */
-export interface IndexConfigContract {
-    /**
-     * Include this item in index? Default is false.
-     */
-    enabled?: boolean;
-    /**
-     * Conditions type to apply for the item
-     *
-     * @enum "text", "label", "list", "number", "checkbox", "date", "file"
-     */
-    conditions?: "text" | "label" | "list" | "number" | "checkbox" | "date" | "file";
-    /**
-     * Set of fields to add to SCHEMA
-     */
-    fields?: IndexFieldContract[];
-    textWithExactTag?: TextWithExactTagContract;
-}
-/**
- * Description of a single index field
- */
-export interface IndexFieldContract {
-    /**
-     * JSONPath (from document object root)
-     */
-    path: string;
-    /**
-     * Alias (how referenced in FT.SEARCH)
-     */
-    alias: string;
-    source?: IndexFieldSourceContract;
-    type: IndexTypeContract;
-    options?: IndexFieldOptionsContract;
-}
-/**
- * Index field options
- */
-export interface IndexFieldOptionsContract {
-    /**
-     * Allows sorting by this field (FT.SEARCH SORTBY)
-     */
-    sortable?: boolean;
-    /**
-     * List of operators allowed for this field in filters (FT.SEARCH FILTER)
-     */
-    allow_operator?: DashboardViewFilterOperatorContract[];
-    /**
-     * Use this field as default sort for the dashboard
-     */
-    isDefaultSort?: boolean;
-    /**
-     * Disables stemming (used for names, codes, exact words)
-     */
-    noStem?: boolean;
-    /**
-     * For TAG fields case-sensitive search
-     */
-    caseSensitive?: boolean;
-    /**
-     * Sets field importance for result ranking (TEXT only). Default is 1.
-     */
-    weight?: number;
-    /**
-     * Enables phonetic search (Double Metaphone, TEXT only)
-     *
-     * @enum "dm:en", "dm:fr", "dm:pt", "dm:es"
-     */
-    phonetic?: "dm:en" | "dm:fr" | "dm:pt" | "dm:es";
-}
-/**
- * Source transformation for the field value
- */
-export interface IndexFieldSourceContract {
-    /**
-     * JSONPath (from document object root)
-     */
-    path?: string;
-    /**
-     * Transformation function name
-     *
-     * @enum "ISOtoUnixTimestamp", "toLowerCase"
-     */
-    transform_func?: "ISOtoUnixTimestamp" | "toLowerCase";
-}
-/**
- * RediSearch field type
- *
- * @enum "TEXT", "TAG", "NUMERIC"
- */
-export type IndexTypeContract = "TEXT" | "TAG" | "NUMERIC";
-/**
- * Helper to create both TEXT and TAG fields from one string
- */
-export interface TextWithExactTagContract {
-    /**
-     * JSONPath (from document object root)
-     */
-    path: string;
-    /**
-     * Base alias for generated fields
-     */
-    baseAlias: string;
-    options?: IndexFieldOptionsContract;
-}
-export declare const DashboardViewFilterLogicContract: {
-    readonly And: "AND";
-    readonly Or: "OR";
-};
-export declare const DashboardViewFilterOperatorContract: {
-    readonly Is: "is";
-    readonly IsNot: "is_not";
-    readonly Contains: "contains";
-    readonly ContainsNot: "contains_not";
-    readonly StartsWith: "starts_with";
-    readonly EndsWith: "ends_with";
-    readonly Empty: "empty";
-    readonly NotEmpty: "not_empty";
-    readonly HasAnyOf: "has_any_of";
-    readonly HasNoneOf: "has_none_of";
-    readonly GreaterThan: "greater_than";
-    readonly LessThan: "less_than";
-    readonly GreaterThanOrEqual: "greater_than_or_equal";
-    readonly LessThanOrEqual: "less_than_or_equal";
-};
-export declare const IndexTypeContract: {
-    readonly Text: "TEXT";
-    readonly Tag: "TAG";
-    readonly Numeric: "NUMERIC";
-};

package/dist/types/dashboard/index.js

@@ -1,34 +0,0 @@
-"use strict";
-/**
- * Index Schemas
- *
- * Generated from OpenAPI specification
- * Source: schemas/dashboard/index.yaml
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IndexTypeContract = exports.DashboardViewFilterOperatorContract = exports.DashboardViewFilterLogicContract = void 0;
-exports.DashboardViewFilterLogicContract = {
-    And: "AND",
-    Or: "OR"
-};
-exports.DashboardViewFilterOperatorContract = {
-    Is: "is",
-    IsNot: "is_not",
-    Contains: "contains",
-    ContainsNot: "contains_not",
-    StartsWith: "starts_with",
-    EndsWith: "ends_with",
-    Empty: "empty",
-    NotEmpty: "not_empty",
-    HasAnyOf: "has_any_of",
-    HasNoneOf: "has_none_of",
-    GreaterThan: "greater_than",
-    LessThan: "less_than",
-    GreaterThanOrEqual: "greater_than_or_equal",
-    LessThanOrEqual: "less_than_or_equal"
-};
-exports.IndexTypeContract = {
-    Text: "TEXT",
-    Tag: "TAG",
-    Numeric: "NUMERIC"
-};

package/dist/types/dashboard/intent.d.ts

@@ -1,243 +0,0 @@
-/**
- * Intent Schemas
- *
- * Generated from OpenAPI specification
- * Source: schemas/dashboard/intent.yaml
- */
-import type { AliasContract, ScopeContract } from "../shared/common";
-import type { RootEntityContract } from "../shared/enums";
-import type { DashboardMetadataContract } from "./metadata";
-import type { SchemaItemRender, SchemaItemRenderIntentContract, SchemaItemRenderTypeContract } from "./render";
-import type { SchemaItemSource, SchemaItemSourceIntentContract } from "./schema";
-export interface CreateDashboardIntentRequestContract {
-    /**
-     * Database ID. If provided, dashboard will be associated with this database.
-     * If null, dashboard is standalone.
-     *
-     *
-     * @format uuid
-     * @nullable true
-     */
-    database_id: string | null;
-    /**
-     * Dashboard name
-     *
-     * @minLength 1
-     * @maxLength 255
-     */
-    name: string;
-    /**
-     * Optional dashboard alias. If not provided, will be auto-generated.
-     */
-    alias?: AliasContract;
-    /**
-     * Optional dashboard title (alternative to name)
-     */
-    title?: string;
-    /**
-     * Optional dashboard description
-     */
-    description?: string;
-    /**
-     * Root entity type. If not provided, will be inferred from database or defaulted to "custom".
-     * Used to determine which allowed-items templates to use for enrichment.
-     *
-     */
-    root_entity?: RootEntityContract;
-    schema: {
-        items_intent: DashboardItemIntentContract[];
-    };
-    /**
-     * Required scopes for the dashboard.
-     * Must include at least one org scope.
-     *
-     */
-    scopes: ScopeContract[];
-    /**
-     * Whether the dashboard is public
-     *
-     * @default false
-     */
-    is_public?: boolean;
-    metadata?: DashboardMetadataContract;
-}
-/**
- * Request body schema for createDashboardIntent (MCP describe). Narrower than CreateDashboardIntentRequestContract:
- * items_intent use DashboardItemIntentNarrowContract (render: label | auto; source: lookup only) so tools_describe stays small.
- * Controller still accepts CreateDashboardIntentRequestContract at runtime.
- */
-export interface CreateDashboardIntentRequestNarrowContract {
-    database_id: string | null;
-    name: string;
-    alias?: AliasContract;
-    title?: string;
-    description?: string;
-    root_entity?: RootEntityContract;
-    schema: {
-        items_intent: DashboardItemIntentNarrowContract[];
-    };
-    scopes: ScopeContract[];
-    is_public?: boolean;
-    metadata?: DashboardMetadataContract;
-}
-export interface CreateViewIntentRequestContract {
-    /**
-     * View name
-     *
-     * @minLength 1
-     * @maxLength 255
-     */
-    name: string;
-    /**
-     * Optional view alias. If not provided, will be auto-generated.
-     */
-    alias?: AliasContract;
-    /**
-     * List of schema item keys from the dashboard to include in this view.
-     * Items must already exist in the dashboard schema.
-     * If empty, view will include all dashboard columns.
-     *
-     */
-    column_keys: string[];
-    /**
-     * Whether this should be the default view for the dashboard
-     *
-     * @default false
-     */
-    default_view?: boolean;
-    /**
-     * Optional view metadata
-     */
-    metadata?: DashboardMetadataContract;
-}
-export interface DashboardItemIntentContract {
-    /**
-     * Type of the item. Must match a valid render type from allowed-items templates.
-     *
-     */
-    type: SchemaItemRenderTypeContract;
-    /**
-     * Display name for the item
-     *
-     * @minLength 1
-     * @maxLength 255
-     */
-    name: string;
-    /**
-     * Optional item key. If not provided, will be auto-generated using nanoid.
-     * Must be unique within the dashboard schema.
-     *
-     */
-    key?: string;
-    /**
-     * Optional alias. If not provided, will be auto-generated from name using slugify.
-     * Must meet minLength=5 and pattern requirements.
-     *
-     */
-    alias?: AliasContract;
-    /**
-     * Optional description for the item
-     */
-    description?: string;
-    /**
-     * Whether this field is required
-     *
-     * @default false
-     */
-    required?: boolean;
-    /**
-     * Whether this field value must be unique
-     *
-     * @default false
-     */
-    unique?: boolean;
-    /**
-     * Whether this field is read-only
-     *
-     * @default false
-     */
-    readonly?: boolean;
-    /**
-     * Whether this field is hidden by default
-     *
-     * @default false
-     */
-    hidden?: boolean;
-    /**
-     * Optional overrides for specific item properties.
-     * Only known keys are allowed; unknown keys will be rejected with validation errors.
-     *
-     */
-    overrides?: {
-        render?: SchemaItemRender;
-        source?: SchemaItemSource;
-        metadata?: {
-            width?: number;
-        };
-        show_mode?: {
-            dashboard?: boolean;
-            detailed?: boolean;
-        };
-    };
-}
-/**
- * Item intent for createDashboardIntent / updateViewIntent (MCP describe). Narrower overrides (render: label | auto; source: lookup only)
- * so tools_describe stays small; API still accepts full DashboardItemIntentContract / UpdateSchemaIntentRequest at runtime.
- */
-export interface DashboardItemIntentNarrowContract {
-    type: SchemaItemRenderTypeContract;
-    name: string;
-    key?: string;
-    alias?: AliasContract;
-    description?: string;
-    required?: boolean;
-    unique?: boolean;
-    readonly?: boolean;
-    hidden?: boolean;
-    overrides?: {
-        render?: SchemaItemRenderIntentContract;
-        source?: SchemaItemSourceIntentContract;
-        metadata?: {
-            width?: number;
-        };
-        show_mode?: {
-            dashboard?: boolean;
-            detailed?: boolean;
-        };
-    };
-}
-/**
- * Request body schema for updateViewIntent. Narrower than UpdateSchemaIntentRequest
- * (only label + auto render in overrides) so MCP describe payload is smaller.
- * Controller still accepts UpdateSchemaIntentRequestContract at runtime.
- */
-export interface UpdateViewIntentRequestContract {
-    schema_patch: {
-        add?: DashboardItemIntentNarrowContract[];
-        update?: {
-            key: string;
-            patch: DashboardItemIntentNarrowContract;
-        }[];
-        remove?: {
-            key: string;
-        }[];
-    };
-}
-export interface UpdateSchemaIntentRequestContract {
-    /**
-     * Patch operations for schema items (dashboard schema or view projection).
-     * Only items specified will be modified; others remain unchanged.
-     * At least one patch operation (add, update, or remove) must be specified.
-     *
-     */
-    schema_patch: {
-        add?: DashboardItemIntentContract[];
-        update?: {
-            key: string;
-            patch: DashboardItemIntentContract;
-        }[];
-        remove?: {
-            key: string;
-        }[];
-    };
-}

package/dist/types/dashboard/intent.js

@@ -1,8 +0,0 @@
-"use strict";
-/**
- * Intent Schemas
- *
- * Generated from OpenAPI specification
- * Source: schemas/dashboard/intent.yaml
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/dashboard/items.d.ts

@@ -1,14 +0,0 @@
-/**
- * Items Schemas
- *
- * Generated from OpenAPI specification
- * Source: schemas/dashboard/items.yaml
- */
-import type { SchemaItemContract, SchemaItemGroupContract } from "./schema";
-export interface DashboardAllowedSchemaItemsResponseContract {
-    items: SchemaItemContract[];
-    /**
-     * List of groups for items grouping (optional)
-     */
-    groups: SchemaItemGroupContract[];
-}

package/dist/types/dashboard/items.js

@@ -1,8 +0,0 @@
-"use strict";
-/**
- * Items Schemas
- *
- * Generated from OpenAPI specification
- * Source: schemas/dashboard/items.yaml
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/dashboard/metadata.d.ts

@@ -1,12 +0,0 @@
-/**
- * Metadata Schemas
- *
- * Generated from OpenAPI specification
- * Source: schemas/dashboard/metadata.yaml
- */
-export interface DashboardMetadataContract {
-    /**
-     * Description of the dashboard metadata
-     */
-    description?: string;
-}

package/dist/types/dashboard/metadata.js

@@ -1,8 +0,0 @@
-"use strict";
-/**
- * Metadata Schemas
- *
- * Generated from OpenAPI specification
- * Source: schemas/dashboard/metadata.yaml
- */
-Object.defineProperty(exports, "__esModule", { value: true });