@fusebase/dashboard-service-sdk 1.23.3-client.7

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/shared/common.d.ts

@@ -0,0 +1,122 @@
+/**
+ * Common Schemas
+ *
+ * Generated from OpenAPI specification
+ * Source: schemas/shared/common.yaml
+ */
+import type { DashboardViewFiltersConfigContract } from "../dashboard/index";
+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";
+export interface FilterConfigContract {
+    required?: DashboardViewFiltersConfigContract;
+    optional?: DashboardViewFiltersConfigContract;
+}
+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 with common permissions and extensible patterns
+ *
+ * @pattern ^(token|dashboard|database|view|data|row)\.(w+)\.(write|read|delete)$
+ */
+export type PermissionContract = string & {
+    __pattern: "^(token|dashboard|database|view|data|row)\\.(\\w+)\\.(write|read|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 = /^(token|dashboard|database|view|data|row)\\.(\\w+)\\.(write|read|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,100 @@
+import type { SchemaItemRenderEditTypeContract, SchemaItemRenderTypeContract } from "../dashboard/render";
+import type { SectionTypeContract } from "../dashboard/rows";
+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 = SectionTypeContract;
+/**
+ * @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;
+export interface mappingInQueryRequiredContract {
+    /**
+     * Array of column mappings
+     */
+    columns?: {
+        /**
+         * Column index in the CSV file (0-based)
+         *
+         * @minimum 0
+         */
+        index: number;
+        type: SchemaItemRenderTypeContract;
+        edit_type: SchemaItemRenderEditTypeContract;
+    }[];
+}
+/**
+ * @format uuid
+ */
+export type viewIdInQueryRequired = string;
+export type sectionTypeInQueryRequired = SectionTypeContract;
+/**
+ * @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;

package/dist/types/shared/parameters.js

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

package/dist/types/template/template.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Template Schemas
+ *
+ * Generated from OpenAPI specification
+ * Source: schemas/template/template.yaml
+ */
+import type { DashboardMetadataContract } from "../dashboard/metadata";
+import type { DashboardSchemaContract } from "../dashboard/schema";
+import type { FilterConfigContract, StandardApiResponseContract } from "../shared/common";
+import type { RootEntityContract } from "../shared/enums";
+export interface CreateTemplateRequestContract {
+    /**
+     * Unique identifier
+     *
+     * @format uuid
+     */
+    global_id: string;
+    /**
+     * Template name
+     *
+     * @minLength 1
+     * @maxLength 255
+     */
+    name: string;
+    root_entity: RootEntityContract;
+    schema: DashboardSchemaContract;
+    filters: FilterConfigContract;
+    metadata?: DashboardMetadataContract;
+}
+export interface TemplateContract {
+    /**
+     * Unique identifier
+     *
+     * @format uuid
+     */
+    global_id: string;
+    /**
+     * Template name
+     */
+    name: string;
+    root_entity: RootEntityContract;
+    schema: DashboardSchemaContract;
+    filters: FilterConfigContract;
+    metadata: DashboardMetadataContract;
+    /**
+     * @format date-time
+     */
+    created_at: Date;
+    /**
+     * @format date-time
+     */
+    updated_at: Date;
+    /**
+     * @format date-time
+     * @nullable true
+     */
+    deleted_at?: Date | null;
+}
+export interface TemplateListResponseContract extends StandardApiResponseContract {
+    data: TemplateContract[];
+}
+export interface TemplateResponseContract extends StandardApiResponseContract {
+    data: TemplateContract;
+}
+export interface UpdateTemplateRequestContract {
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    name?: string;
+    schema?: DashboardSchemaContract;
+    filters?: FilterConfigContract;
+    metadata?: DashboardMetadataContract;
+}

package/dist/types/template/template.js

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

package/dist/types/token/token.d.ts

@@ -0,0 +1,206 @@
+/**
+ * Token Schemas
+ *
+ * Generated from OpenAPI specification
+ * Source: schemas/token/token.yaml
+ */
+import type { ScopeContract } from "../shared/common";
+import type { PermissionContract } from "../shared/enums";
+export interface CreateTokenRequestContract {
+    /**
+     * Array of scopes for the token. Must include org scope.
+     */
+    scopes: ScopeContract[];
+    /**
+     * Array of permission strings. Users can only grant permissions they themselves possess.
+     * See Permission enum for available permissions.
+     *
+     */
+    permissions: PermissionContract[];
+    /**
+     * Resource scope defining which resources this token can access.
+     * Required to explicitly define access restrictions.
+     *
+     */
+    resource_scope: ResourceScopeContract;
+    /**
+     * Optional name for the token
+     *
+     * @nullable true
+     */
+    name?: string | null;
+    /**
+     * Optional expiration date for the token
+     *
+     * @format date-time
+     * @nullable true
+     */
+    expires_at?: Date | null;
+}
+export interface CreateTokenResponseContract {
+    success: boolean;
+    /**
+     * @nullable true
+     */
+    message?: string | null;
+    data: {
+        /**
+         * The token value (only returned once on creation)
+         */
+        token: string;
+        /**
+         * @format uuid
+         */
+        global_id: string;
+        /**
+         * @nullable true
+         */
+        name?: string | null;
+        permissions: string[];
+        /**
+         * @format date-time
+         * @nullable true
+         */
+        expires_at?: Date | null;
+        /**
+         * @format date-time
+         */
+        created_at: Date;
+    };
+}
+/**
+ * Resource scope defining which resources a token can access.
+ * If both allow and deny are omitted/null, all resources are allowed.
+ *
+ */
+export interface ResourceScopeContract {
+    /**
+     * Allow rules. If null/undefined, all resources are allowed unless denied.
+     * If empty array, all resources are denied.
+     *
+     */
+    allow?: ResourceScopeRuleContract[];
+    /**
+     * Deny rules. Resources matching deny rules are always denied, even if they match allow rules.
+     *
+     */
+    deny?: ResourceScopeRuleContract[];
+}
+/**
+ * A resource scope rule. Parent constraints (where) are calculated automatically from resources.
+ * At least one of databases, dashboards, or views should be provided.
+ *
+ */
+export interface ResourceScopeRuleContract {
+    /**
+     * Array of pattern strings for databases:
+     * - "*" for all databases
+     * - "globalId:<uuid-v4>" for specific database by global ID
+     * - "aliasLike:<glob>" or bare "<glob>" for alias pattern matching
+     *
+     */
+    databases: string[];
+    /**
+     * Array of pattern strings for dashboards:
+     * - "*" for all dashboards
+     * - "globalId:<uuid-v4>" for specific dashboard by global ID
+     * - "aliasLike:<glob>" or bare "<glob>" for alias pattern matching
+     *
+     */
+    dashboards: string[];
+    /**
+     * Array of pattern strings for views:
+     * - "*" for all views
+     * - "globalId:<uuid-v4>" for specific view by global ID
+     * - "aliasLike:<glob>" or bare "<glob>" for alias pattern matching
+     *
+     */
+    views: string[];
+}
+export interface RevokeTokenResponseContract {
+    success: boolean;
+    message: string;
+}
+export interface TokenContract {
+    /**
+     * Unique identifier for the token
+     *
+     * @format uuid
+     */
+    global_id: string;
+    /**
+     * Token name
+     *
+     * @nullable true
+     */
+    name?: string | null;
+    /**
+     * Array of permission strings granted to this token
+     */
+    permissions: PermissionContract[];
+    /**
+     * Array of scopes associated with the token
+     *
+     * @nullable true
+     */
+    scopes?: ScopeContract[];
+    /**
+     * Token expiration date
+     *
+     * @format date-time
+     * @nullable true
+     */
+    expires_at?: Date | null;
+    /**
+     * Last time the token was used
+     *
+     * @format date-time
+     * @nullable true
+     */
+    last_used_at?: Date | null;
+    /**
+     * Token creation date
+     *
+     * @format date-time
+     */
+    created_at: Date;
+}
+export interface TokenListResponseContract {
+    success: boolean;
+    /**
+     * @nullable true
+     */
+    message?: string | null;
+    data: TokenContract[];
+}
+export interface TokenResponseContract {
+    success: boolean;
+    /**
+     * @nullable true
+     */
+    message?: string | null;
+    data: TokenContract;
+}
+export interface UpdateTokenRequestContract {
+    /**
+     * Token name
+     *
+     * @nullable true
+     */
+    name?: string | null;
+    /**
+     * Array of permission strings. Users can only grant permissions they themselves possess.
+     * See Permission enum for available permissions.
+     *
+     *
+     * @nullable true
+     */
+    permissions?: PermissionContract[];
+    /**
+     * Expiration date for the token. Set to null to remove expiration.
+     *
+     * @format date-time
+     * @nullable true
+     */
+    expires_at?: Date | null;
+}