@fusebase/fusebase-gate-sdk 1.0.2-sdk.0

package/dist/types/relations/relations.d.ts

@@ -0,0 +1,138 @@
+/**
+ * Relations Schemas
+ *
+ * Generated from OpenAPI specification
+ * Source: schemas/relations/relations.yaml
+ */
+import type { DashboardContract } from "../dashboard/dashboard";
+import type { StandardApiResponseContract } from "../shared/common";
+export interface AddRelationRowsRequestContract {
+    /**
+     * Row mappings to add. Each item has source_index (row in source dashboard) and target_index (row in target dashboard). Does not remove existing mappings.
+     */
+    rows: CreateRelationRowRequestContract[];
+}
+export interface CreateDashboardRelationRequestContract {
+    /**
+     * Dashboard you fetch lookup data FROM (the table whose columns are displayed in relation/lookup columns).
+     *
+     * @format uuid
+     */
+    source_dashboard_id: string;
+    /**
+     * Dashboard you are ON (the view where relation/lookup columns live).
+     *
+     * @format uuid
+     */
+    target_dashboard_id: string;
+    relation_type: RelationTypeContract;
+}
+export interface CreateRelationRowRequestContract {
+    /**
+     * Row ID in the source dashboard (dashboard you fetch lookup data FROM). Use root_index_value from getDashboardViewData.
+     */
+    source_index: string;
+    /**
+     * Row ID in the target dashboard (dashboard where relation/lookup columns live). Use root_index_value from getDashboardViewData.
+     */
+    target_index: string;
+}
+export interface DashboardRelationContract {
+    /**
+     * Relation UUID. Use in updateViewIntent relations[].relation_id and addRelationRows/updateRelationRows.
+     *
+     * @format uuid
+     */
+    global_id: string;
+    /**
+     * Dashboard you fetch lookup data FROM (the table whose columns are displayed in relation/lookup columns).
+     *
+     * @format uuid
+     */
+    source_dashboard_id: string;
+    /**
+     * Dashboard you are ON (the view where relation/lookup columns live).
+     *
+     * @format uuid
+     */
+    target_dashboard_id: string;
+    relation_type: RelationTypeContract;
+    /**
+     * @format date-time
+     */
+    created_at: Date;
+    /**
+     * @format date-time
+     */
+    updated_at: Date;
+    /**
+     * @format date-time
+     * @nullable true
+     */
+    deleted_at?: Date | null;
+    /**
+     * Pairs of source_index (row in source dashboard) and target_index (row in target dashboard) linking rows.
+     */
+    relation_rows?: DashboardRelationRowContract[];
+    source_dashboard?: DashboardContract;
+    target_dashboard?: DashboardContract;
+}
+export interface DashboardRelationListResponseContract extends StandardApiResponseContract {
+    data?: DashboardRelationContract[];
+}
+export interface DashboardRelationResponseContract extends StandardApiResponseContract {
+    data?: DashboardRelationContract;
+}
+export interface DashboardRelationRowContract {
+    /**
+     * Auto-incrementing primary key
+     */
+    id: number;
+    /**
+     * Relation UUID (global_id from createDashboardRelation).
+     *
+     * @format uuid
+     */
+    relation_id: string;
+    /**
+     * Row ID in the source dashboard (dashboard you fetch lookup data FROM).
+     */
+    source_index: string;
+    /**
+     * Row ID in the target dashboard (dashboard where relation/lookup columns live).
+     */
+    target_index: string;
+    /**
+     * @format date-time
+     */
+    created_at: Date;
+    /**
+     * @format date-time
+     */
+    updated_at: Date;
+    /**
+     * @format date-time
+     * @nullable true
+     */
+    deleted_at?: Date | null;
+}
+/**
+ * one_to_one - one source row ↔ one target row.
+ * one_to_many - one source row can link to many target rows (e.g. Author → Books).
+ * many_to_many - many-to-many (e.g. Tags ↔ Content).
+ *
+ *
+ * @enum "one_to_one", "one_to_many", "many_to_many"
+ */
+export type RelationTypeContract = "one_to_one" | "one_to_many" | "many_to_many";
+export interface UpdateRelationRowsRequestContract {
+    /**
+     * Replaces only the mappings for the target_index values present in this array; other existing mappings are unchanged.
+     */
+    rows: CreateRelationRowRequestContract[];
+}
+export declare const RelationTypeContract: {
+    readonly OneToOne: "one_to_one";
+    readonly OneToMany: "one_to_many";
+    readonly ManyToMany: "many_to_many";
+};

package/dist/types/relations/relations.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * Relations Schemas
+ *
+ * Generated from OpenAPI specification
+ * Source: schemas/relations/relations.yaml
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RelationTypeContract = void 0;
+exports.RelationTypeContract = {
+    OneToOne: "one_to_one",
+    OneToMany: "one_to_many",
+    ManyToMany: "many_to_many"
+};

package/dist/types/resolve/resolve.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Resolve Aliases Schemas
+ *
+ * Request/response contracts for resolving database, dashboard, and view
+ * by alias or id within an organization scope.
+ */
+import type { AliasContract, ScopeOrgContract, StandardApiResponseContract } from "../shared/common";
+export type ResolveEntityTypeContract = "database" | "dashboard" | "view";
+export type ResolveErrorCodeContract = "ALIAS_NOT_FOUND" | "ID_NOT_FOUND" | "SCOPE_MISMATCH" | "PARENT_NOT_FOUND";
+/**
+ * Single item to resolve: one entity (database, dashboard, or view) with optional parent refs.
+ * For dashboard: database_id or database_alias is required.
+ * For view: database_id or database_alias and dashboard_id or dashboard_alias are required.
+ */
+export interface ResolveItemRequestContract {
+    /** What to resolve */
+    entity_type: ResolveEntityTypeContract;
+    /** Alias of the entity (at least one of alias or id required) */
+    alias?: AliasContract | null;
+    /**
+     * Global ID of the entity
+     * @format uuid
+     * @nullable true
+     */
+    id?: string | null;
+    /** For dashboard/view: parent database alias. One of database_alias or database_id required. */
+    database_alias?: AliasContract | null;
+    /**
+     * For dashboard/view: parent database global ID
+     * @format uuid
+     * @nullable true
+     */
+    database_id?: string | null;
+    /** For view: parent dashboard alias. One of dashboard_alias or dashboard_id required. */
+    dashboard_alias?: AliasContract | null;
+    /**
+     * For view: parent dashboard global ID
+     * @format uuid
+     * @nullable true
+     */
+    dashboard_id?: string | null;
+}
+export interface ResolveAliasesRequestContract {
+    /** Organization scope to resolve within */
+    scope: ScopeOrgContract;
+    /** Flat list of items to resolve (order preserved in response) */
+    items: ResolveItemRequestContract[];
+}
+/**
+ * Result for one resolved (or unresolved) entity.
+ */
+export interface ResolvedItemContract {
+    entity_type: ResolveEntityTypeContract;
+    /**
+     * Resolved global_id or null if not found
+     * @format uuid
+     * @nullable true
+     */
+    id: string | null;
+    /** Resolved alias or null */
+    alias: string | null;
+    /** Whether the entity was found and resolved */
+    resolved: boolean;
+    /**
+     * Error code when resolved is false
+     * @nullable true
+     */
+    error_code?: ResolveErrorCodeContract | null;
+}
+export interface ResolveAliasesResponseDataContract {
+    results: ResolvedItemContract[];
+}
+export interface ResolveAliasesResponseContract extends StandardApiResponseContract {
+    data?: ResolveAliasesResponseDataContract;
+}
+export declare const ResolveEntityTypeContract: {
+    readonly Database: "database";
+    readonly Dashboard: "dashboard";
+    readonly View: "view";
+};
+export declare const ResolveErrorCodeContract: {
+    readonly AliasNotFound: "ALIAS_NOT_FOUND";
+    readonly IdNotFound: "ID_NOT_FOUND";
+    readonly ScopeMismatch: "SCOPE_MISMATCH";
+    readonly ParentNotFound: "PARENT_NOT_FOUND";
+};

package/dist/types/resolve/resolve.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * Resolve Aliases Schemas
+ *
+ * Request/response contracts for resolving database, dashboard, and view
+ * by alias or id within an organization scope.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResolveErrorCodeContract = exports.ResolveEntityTypeContract = void 0;
+exports.ResolveEntityTypeContract = {
+    Database: "database",
+    Dashboard: "dashboard",
+    View: "view"
+};
+exports.ResolveErrorCodeContract = {
+    AliasNotFound: "ALIAS_NOT_FOUND",
+    IdNotFound: "ID_NOT_FOUND",
+    ScopeMismatch: "SCOPE_MISMATCH",
+    ParentNotFound: "PARENT_NOT_FOUND"
+};

package/dist/types/shared/common.d.ts

@@ -0,0 +1,122 @@
+/**
+ * Common Schemas
+ *
+ * Generated from OpenAPI specification
+ * Source: schemas/shared/common.yaml
+ */
+import type { ScopeTypeContract, ScopeTypeOrgContract } from "./enums";
+/**
+ * Human-readable alias (5-64 chars, lowercase letters, numbers, dots, underscores, and hyphens). Unique within org scope for databases/dashboards, unique within dashboard for views.
+ *
+ * @minLength 5
+ * @maxLength 64
+ * @pattern ^[a-z0-9._-]+$
+ * @nullable true
+ */
+export type AliasContract = (string & {
+    __pattern: "^[a-z0-9._-]+$";
+}) | null;
+export type ApiErrorCodeContract = "INTERNAL_ERROR" | "COLUMN_VALUE_NOT_UNIQUE" | "DATA_LOSS_CHILD_TABLE_LINK";
+/** Filter config (Gate: no dashboard view filters) */
+export interface FilterConfigContract {
+    required?: Record<string, unknown>;
+    optional?: Record<string, unknown>;
+}
+export interface GetHealthResponseContract extends StandardApiResponseContract {
+    data: {
+        status: string;
+    };
+}
+/**
+ * Optional predefined mapping of old global IDs to new global IDs for copying entities
+ */
+export interface GlobalIdsToReplaceMapContract {
+    /**
+     * Mapping of old database IDs to new database IDs
+     */
+    database?: Record<string, string>;
+    /**
+     * Mapping of old dashboard IDs to new dashboard IDs
+     */
+    dashboard?: Record<string, string>;
+    /**
+     * Mapping of old view IDs to new view IDs
+     */
+    view?: Record<string, string>;
+    /**
+     * Mapping of old representation IDs to new representation IDs
+     */
+    representation?: Record<string, string>;
+    /**
+     * Mapping of old row UUIDs to new row UUIDs
+     */
+    row?: Record<string, string>;
+    /**
+     * Mapping of old section UUIDs to new section UUIDs
+     */
+    section?: Record<string, string>;
+    /**
+     * Mapping of old relation IDs to new relation IDs
+     */
+    relation?: Record<string, string>;
+    /**
+     * Mapping of old value IDs to new value IDs
+     */
+    value?: Record<string, string>;
+}
+export interface PaginatedResponseContract {
+    /**
+     * Array of items
+     */
+    data: unknown[];
+    meta: {
+        total: number;
+        page: number;
+        limit: number;
+        total_pages: number;
+    };
+}
+export interface ScopeContract {
+    /**
+     * Type of scope (e.g., workspace, portal)
+     */
+    scope_type: ScopeTypeContract;
+    /**
+     * ID of the scoped entity
+     */
+    scope_id: string;
+}
+export interface ScopeOrgContract {
+    /**
+     * Type of org scope (org)
+     */
+    scope_type: ScopeTypeOrgContract;
+    /**
+     * ID of the org scope
+     */
+    scope_id: string;
+}
+/**
+ * Standard API response format
+ */
+export interface StandardApiResponseContract {
+    /**
+     * Whether the operation was successful
+     */
+    success: boolean;
+    /**
+     * Response message
+     */
+    message: string;
+    error_code?: ApiErrorCodeContract;
+    /**
+     * Response data (optional)
+     */
+    data?: object;
+}
+export declare const ApiErrorCodeContract: {
+    readonly InternalError: "INTERNAL_ERROR";
+    readonly ColumnValueNotUnique: "COLUMN_VALUE_NOT_UNIQUE";
+    readonly DataLossChildTableLink: "DATA_LOSS_CHILD_TABLE_LINK";
+};
+export declare function asAlias(value: string | null): AliasContract;

package/dist/types/shared/common.js

@@ -0,0 +1,24 @@
+"use strict";
+/**
+ * Common Schemas
+ *
+ * Generated from OpenAPI specification
+ * Source: schemas/shared/common.yaml
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiErrorCodeContract = void 0;
+exports.asAlias = asAlias;
+exports.ApiErrorCodeContract = {
+    InternalError: "INTERNAL_ERROR",
+    ColumnValueNotUnique: "COLUMN_VALUE_NOT_UNIQUE",
+    DataLossChildTableLink: "DATA_LOSS_CHILD_TABLE_LINK"
+};
+const ALIAS_RE = /^[a-z0-9._-]+$/;
+function asAlias(value) {
+    if (value === null)
+        return null;
+    if (!ALIAS_RE.test(value)) {
+        throw new Error(`Invalid alias: ${value}`);
+    }
+    return value;
+}

package/dist/types/shared/enums.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Enums Schemas
+ *
+ * Generated from OpenAPI specification
+ * Source: schemas/shared/enums.yaml
+ */
+/**
+ * Organization role that determines default permissions
+ *
+ * @enum "owner", "manager", "member", "client", "guest", "visitor"
+ */
+export type OrgRoleContract = "owner" | "manager" | "member" | "client" | "guest" | "visitor";
+/**
+ * Permission contract: domain.action format (e.g. token.read, automation.workflow.write).
+ *
+ * @pattern ^[a-z][a-z0-9_]*(\.[a-z0-9_]+)*\.(read|write|delete)$
+ */
+export type PermissionContract = string & {
+    __pattern: "^[a-z][a-z0-9_]*(\\.[a-z0-9_]+)*\\.(read|write|delete)$";
+};
+/**
+ * The type of entity that the dashboard is based on
+ *
+ * @enum "custom", "portal", "workspace", "org", "user", "client", "form", "form-response", "tracker", "tracker-result", "meeting"
+ */
+export type RootEntityContract = "custom" | "portal" | "workspace" | "org" | "user" | "client" | "form" | "form-response" | "tracker" | "tracker-result" | "meeting";
+export type ScopeTypeContract = "org" | "workspace" | "portal" | "user" | "client" | "block" | "tracker" | "parent_row" | "parent_table";
+export type ScopeTypeOrgContract = "org";
+export declare const OrgRoleContract: {
+    readonly Owner: "owner";
+    readonly Manager: "manager";
+    readonly Member: "member";
+    readonly Client: "client";
+    readonly Guest: "guest";
+    readonly Visitor: "visitor";
+};
+export declare const RootEntityContract: {
+    readonly Custom: "custom";
+    readonly Portal: "portal";
+    readonly Workspace: "workspace";
+    readonly Org: "org";
+    readonly User: "user";
+    readonly Client: "client";
+    readonly Form: "form";
+    readonly FormResponse: "form-response";
+    readonly Tracker: "tracker";
+    readonly TrackerResult: "tracker-result";
+    readonly Meeting: "meeting";
+};
+export declare const ScopeTypeContract: {
+    readonly Org: "org";
+    readonly Workspace: "workspace";
+    readonly Portal: "portal";
+    readonly User: "user";
+    readonly Client: "client";
+    readonly Block: "block";
+    readonly Tracker: "tracker";
+    readonly ParentRow: "parent_row";
+    readonly ParentTable: "parent_table";
+};
+export declare const ScopeTypeOrgContract: {
+    readonly Org: "org";
+};
+export declare function asPermission(value: string): PermissionContract;

package/dist/types/shared/enums.js

@@ -0,0 +1,52 @@
+"use strict";
+/**
+ * Enums Schemas
+ *
+ * Generated from OpenAPI specification
+ * Source: schemas/shared/enums.yaml
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScopeTypeOrgContract = exports.ScopeTypeContract = exports.RootEntityContract = exports.OrgRoleContract = void 0;
+exports.asPermission = asPermission;
+exports.OrgRoleContract = {
+    Owner: "owner",
+    Manager: "manager",
+    Member: "member",
+    Client: "client",
+    Guest: "guest",
+    Visitor: "visitor"
+};
+exports.RootEntityContract = {
+    Custom: "custom",
+    Portal: "portal",
+    Workspace: "workspace",
+    Org: "org",
+    User: "user",
+    Client: "client",
+    Form: "form",
+    FormResponse: "form-response",
+    Tracker: "tracker",
+    TrackerResult: "tracker-result",
+    Meeting: "meeting"
+};
+exports.ScopeTypeContract = {
+    Org: "org",
+    Workspace: "workspace",
+    Portal: "portal",
+    User: "user",
+    Client: "client",
+    Block: "block",
+    Tracker: "tracker",
+    ParentRow: "parent_row",
+    ParentTable: "parent_table"
+};
+exports.ScopeTypeOrgContract = {
+    Org: "org"
+};
+const PERMISSION_RE = /^[a-z][a-z0-9_]*(\\.[a-z0-9_]+)*\\.(read|write|delete)$/;
+function asPermission(value) {
+    if (!PERMISSION_RE.test(value)) {
+        throw new Error(`Invalid permission: ${value}`);
+    }
+    return value;
+}

package/dist/types/shared/health.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Health Schemas
+ *
+ * Generated from OpenAPI specification
+ * Source: schemas/shared/health.yaml
+ */
+import type { StandardApiResponseContract } from "./common";
+export interface GetHealth200ResponseContract extends StandardApiResponseContract {
+    data?: {
+        status?: string;
+    };
+}

package/dist/types/shared/health.js

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

package/dist/types/shared/parameters.d.ts

@@ -0,0 +1,95 @@
+import type { AliasContract } from "./common";
+import type { RootEntityContract, ScopeTypeContract, ScopeTypeOrgContract } from "./enums";
+/**
+ * Parameter Schemas
+ *
+ * Generated from OpenAPI parameter $refs
+ */
+export type scopeTypeOrgInQueryRequired = ScopeTypeOrgContract;
+export type scopeIdInQueryRequired = string;
+export type copyViewsInQueryRequired = boolean;
+export type copyDataInQueryRequired = boolean;
+export type copyRelationsInQueryRequired = boolean;
+/**
+ * @default false
+ */
+export type createDefaultRowsInQuery = boolean;
+export type rootEntitiesInQueryOptional = RootEntityContract[];
+export type nameInQueryOptional = string;
+export type aliasInQueryOptional = AliasContract;
+export type scopeTypeInQueryRequired = ScopeTypeContract;
+/**
+ * @format uuid
+ */
+export type dashboardIdInPathRequired = string;
+/**
+ * @format uuid
+ */
+export type viewIdInPathRequired = string;
+/**
+ * @default "use"
+ */
+export type cacheStrategyInQueryOptional = "use" | "bypass" | "reset";
+export type sectionTypeInQueryOptional = string;
+/**
+ * @maxLength 32
+ */
+export type sectionKeyInQueryOptional = string;
+export type sourceDashboardIdInQueryRequired = string;
+export type sourceIndexInQueryRequired = string;
+export type rootEntityInQueryOptional = RootEntityContract;
+/**
+ * @format uuid
+ */
+export type viewIdInQueryOptional = string;
+export type aliasInQueryRequired = AliasContract;
+/**
+ * @format uuid
+ */
+export type databaseIdInQueryRequired = string;
+/** Column mapping (Gate: minimal stub) */
+export interface mappingInQueryRequiredContract {
+    columns?: {
+        index: number;
+        type: string;
+        edit_type: string;
+    }[];
+}
+/**
+ * @format uuid
+ */
+export type viewIdInQueryRequired = string;
+export type sectionTypeInQueryRequired = string;
+/**
+ * @maxLength 32
+ */
+export type sectionKeyInQueryRequired = string;
+export type copyTablesInQueryRequired = boolean;
+/**
+ * @minimum 1
+ * @default 1
+ */
+export type pageInQueryOptional = number;
+/**
+ * @minimum 1
+ * @maximum 100
+ * @default 20
+ */
+export type limitInQueryOptional = number;
+export type targetDashboardIdInQueryRequired = string;
+/**
+ * @format uuid
+ */
+export type relationId = string;
+/**
+ * @default true
+ */
+export type includeRows = boolean;
+/**
+ * @format uuid
+ */
+export type templateIdInPathRequired = string;
+/**
+ * Organization global ID (path param for org-scoped routes, e.g. /:orgId/users).
+ */
+export type orgIdInPathRequired = string;

package/dist/types/shared/parameters.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });