@lightdash/common 0.1464.3 → 0.1466.0

package/dist/ee/scim/errors.d.ts

@@ -0,0 +1,32 @@
+import { type ScimSchemaType } from '..';
+import { type ScimErrorPayload } from './types';
+export declare class ScimError extends Error {
+    /**
+     * a SCIM-specific error type that provides additional context for the error.
+     * @type {ScimErrorPayload['scimType']}
+     */
+    scimType?: ScimErrorPayload['scimType'];
+    /**
+     * The "schemas" attribute is an array of Strings which allows the service provider to declare
+     * the schemas it supports. Each String is a URI and can be used to declare both standard and
+     * custom schemas.
+     * @type {ScimSchemaType[]}
+     */
+    schemas: ScimSchemaType.ERROR[];
+    /**
+     * A human-readable message in English, providing more information about the error.
+     * @type {string}
+     */
+    detail: string;
+    /**
+     * The HTTP status code applicable to this error, expressed as a string value.
+     * @type {string}
+     * */
+    status: string;
+    constructor({ detail, scimType, status, }: {
+        detail: string;
+        scimType?: ScimErrorPayload['scimType'];
+        status: number;
+    });
+    toJSON(): ScimErrorPayload;
+}

package/dist/ee/scim/errors.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScimError = void 0;
+class ScimError extends Error {
+    constructor({ detail, scimType, status, }) {
+        super(detail);
+        this.scimType = scimType;
+        this.schemas = [
+            'urn:ietf:params:scim:api:messages:2.0:Error',
+        ];
+        this.detail = detail;
+        this.status = status.toString();
+    }
+    // Override the toJSON method to return the desired structure directly
+    toJSON() {
+        return {
+            ...(this.scimType && { scimType: this.scimType }),
+            schemas: this.schemas,
+            detail: this.detail,
+            status: this.status,
+        };
+    }
+}
+exports.ScimError = ScimError;

package/dist/ee/scim/types.d.ts

@@ -0,0 +1,119 @@
+import { type ScimSchemaType } from '..';
+export type SessionServiceAccount = {
+    organizationUuid: string;
+};
+export interface ScimResource {
+    schemas: string[];
+    id: string;
+    meta?: {
+        resourceType?: string;
+        created?: Date;
+        lastModified?: Date;
+        location?: string;
+        version?: string;
+    };
+}
+export interface ScimUser extends ScimResource {
+    schemas: string[];
+    userName: string;
+    name: {
+        givenName: string;
+        familyName: string;
+    };
+    active: boolean;
+    emails?: {
+        value: string;
+        primary: boolean;
+    }[];
+}
+export interface ScimGroup extends ScimResource {
+    schemas: string[];
+    id: string;
+    displayName: string;
+    members: ScimGroupMember[];
+    meta: ScimResource['meta'] & {
+        resourceType: 'Group';
+        created: Date;
+        lastModified: Date;
+        location: string;
+    };
+}
+export interface ScimGroupMember {
+    value: string;
+    display: string;
+}
+export type ScimErrorPayload = {
+    /**
+     * NOTE: this is taken from the SCIM spec here: https://datatracker.ietf.org/doc/html/rfc7644#section-3.7.3
+     * A SCIM-specific error type that provides additional context for the error.
+     * - 'invalidFilter': The specified filter syntax was invalid or the attribute and comparison combination is not supported.
+     *   Applicable for GET (Section 3.4.2), POST (Search - Section 3.4.3), PATCH (Path Filter - Section 3.5.2).
+     * - 'tooMany': The filter yields too many results for the server to process.
+     *   Applicable for GET (Section 3.4.2), POST (Search - Section 3.4.3).
+     * - 'uniqueness': One or more attribute values are already in use or reserved.
+     *   Applicable for POST (Create - Section 3.3), PUT (Section 3.5.1), PATCH (Section 3.5.2).
+     * - 'mutability': The modification is incompatible with the target attribute's mutability.
+     *   Applicable for PUT (Section 3.5.1), PATCH (Section 3.5.2).
+     * - 'invalidSyntax': The request body structure was invalid or did not conform to the schema.
+     *   Applicable for POST (Search - Section 3.4.3, Create - Section 3.3, Bulk - Section 3.7), PUT (Section 3.5.1).
+     * - 'invalidPath': The "path" attribute was invalid or malformed.
+     *   Applicable for PATCH (Section 3.5.2).
+     * - 'noTarget': The specified "path" did not yield an attribute that could be operated on.
+     *   Applicable for PATCH (Section 3.5.2).
+     * - 'invalidValue': A required value was missing, or the value specified was not compatible with the operation.
+     *   Applicable for GET (Section 3.4.2), POST (Create - Section 3.3, Query - Section 3.4.3), PUT (Section 3.5.1), PATCH (Section 3.5.2).
+     * - 'invalidVers': The specified SCIM protocol version is not supported.
+     *   Applicable for GET (Section 3.4.2), POST (ALL), PUT (Section 3.5.1), PATCH (Section 3.5.2), DELETE (Section 3.6).
+     * - 'sensitive': The request cannot be completed due to sensitive information passed in the URI.
+     *   Applicable for GET (Section 3.4.2).
+     */
+    scimType?: 'invalidFilter' | 'tooMany' | 'uniqueness' | 'mutability' | 'invalidSyntax' | 'invalidPath' | 'noTarget' | 'invalidValue' | 'invalidVers' | 'sensitive';
+    /**
+     * Array of schema URIs that describe the structure of the SCIM error response.
+     * Typically includes "urn:ietf:params:scim:api:messages:2.0:Error".
+     */
+    schemas: ScimSchemaType.ERROR[];
+    /**
+     * Human-readable description of the error, providing details about why the error occurred.
+     */
+    detail: string;
+    /**
+     * HTTP status code as a string, indicating the status of the response.
+     * For example: "400" for bad requests, "404" for not found, "500" for server errors.
+     */
+    status: string;
+};
+export interface ScimListResponse<T extends ScimResource> {
+    schemas: ScimSchemaType.LIST_RESPONSE[];
+    totalResults: number;
+    itemsPerPage: number;
+    startIndex: number;
+    Resources: T[];
+}
+export interface ScimUpsertGroup {
+    schemas: ScimSchemaType.GROUP[];
+    displayName: string;
+    members: ScimGroupMember[];
+}
+export type ScimUpsertUser = Omit<ScimUser, 'id'> & {
+    password?: string;
+    title?: string;
+};
+export type ScimOrganizationAccessToken = {
+    uuid: string;
+    organizationUuid: string;
+    createdAt: Date;
+    expiresAt: Date | null;
+    description: string;
+    lastUsedAt: Date | null;
+    rotatedAt: Date | null;
+};
+export type ScimOrganizationAccessTokenWithToken = ScimOrganizationAccessToken & {
+    token: string;
+};
+export type ApiCreateScimTokenRequest = Pick<ScimOrganizationAccessToken, 'expiresAt' | 'description'>;
+export type ApiCreateScimTokenResponse = {
+    token: string;
+    expiresAt: Date;
+};
+export type CreateScimOrganizationAccessToken = Pick<ScimOrganizationAccessToken, 'organizationUuid' | 'expiresAt' | 'description'>;

package/dist/ee/scim/types.js

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

package/dist/index.d.ts

@@ -36,6 +36,7 @@ import { type TableBase } from './types/table';
 import { type LightdashUser, type LoginOptions, type UserAllowedOrganization } from './types/user';
 import { type UserWarehouseCredentials } from './types/userWarehouseCredentials';
 import { type ValidationResponse } from './types/validation';
+import type { ApiAiConversationMessages, ApiAiConversationResponse, ApiAiConversations, DecodedEmbed, EmbedUrl } from './ee';
 import { type AnyType } from './types/any';
 import { type ApiGetSpotlightTableConfig } from './types/api/spotlight';
 import { type ApiCatalogAnalyticsResults, type ApiCatalogMetadataResults, type ApiGetMetricsTree, type ApiMetricsCatalog } from './types/catalog';
@@ -53,6 +54,7 @@ export * from './compiler/exploreCompiler';
 export * from './compiler/filtersCompiler';
 export * from './compiler/translator';
 export * from './dbt/validation';
+export * from './ee/index';
 export * from './pivotTable/pivotQueryResults';
 export { default as lightdashDbtYamlSchema } from './schemas/json/lightdash-dbt-2.0.json';
 export { default as lightdashProjectConfigSchema } from './schemas/json/lightdash-project-config-1.0.json';
@@ -216,6 +218,7 @@ export declare const SEED_ORG_2_ADMIN_EMAIL: {
 export declare const SEED_ORG_2_ADMIN_PASSWORD: {
     password: string;
 };
+export declare const SEED_EMBED_SECRET = "zU3h50saDOO20czNFNRok";
 export declare const SEED_PROJECT: {
     project_uuid: string;
     name: string;
@@ -390,7 +393,7 @@ export type ApiAiGetDashboardSummaryResponse = {
     status: 'ok';
     results: DashboardSummary;
 };
-type ApiResults = ApiQueryResults | ApiSqlQueryResults | ApiCompiledQueryResults | ApiExploresResults | ApiExploreResults | ApiStatusResults | ApiRefreshResults | ApiHealthResults | Organization | LightdashUser | LoginOptions | SavedChart | SavedChart[] | Space[] | InviteLink | OrganizationProject[] | Project | WarehouseCredentials | OrganizationMemberProfile[] | ProjectCatalog | TablesConfiguration | Dashboard | DashboardBasicDetails[] | OnboardingStatus | Dashboard[] | DeleteOpenIdentity | ApiFlashResults | Record<OpenIdIdentitySummary['issuerType'], OpenIdIdentitySummary[]> | FilterableField[] | DashboardAvailableFilters | ProjectSavedChartStatus | null | Array<unknown> | ApiJobStartedResults | ApiCreateUserTokenResults | CreatePersonalAccessToken | PersonalAccessToken | ProjectMemberProfile[] | ProjectGroupAccess | SearchResults | Space | ShareUrl | SlackSettings | ApiSlackChannelsResponse['results'] | UserActivity | SchedulerAndTargets | SchedulerAndTargets[] | FieldValueSearchResult | ApiDownloadCsv | AllowedEmailDomains | UpdateAllowedEmailDomains | UserAllowedOrganization[] | EmailStatusExpiring | ApiScheduledDownloadCsv | PinnedItems | ViewStatistics | SchedulerWithLogs | ValidationResponse[] | ChartHistory | ChartVersion | Array<GitRepo> | PullRequestCreated | GitIntegrationConfiguration | UserWarehouseCredentials | ApiJobStatusResponse['results'] | ApiJobScheduledResponse['results'] | ApiSshKeyPairResponse['results'] | MostPopularAndRecentlyUpdated | ApiCalculateTotalResponse['results'] | Record<string, DbtExposure> | ApiCreateComment['results'] | ApiGetComments['results'] | ApiDeleteComment | ApiSuccessEmpty | ApiCreateProjectResults | ApiAiDashboardSummaryResponse['results'] | ApiAiGetDashboardSummaryResponse['results'] | ApiCatalogMetadataResults | ApiCatalogAnalyticsResults | ApiPromotionChangesResponse['results'] | ApiWarehouseTableFields['results'] | ApiTogglePinnedItem['results'] | ApiOrganizationMemberProfiles['results'] | ApiSqlChart['results'] | ApiCreateSqlChart['results'] | ApiUpdateSqlChart['results'] | ApiContentResponse['results'] | ApiChartContentResponse['results'] | ApiSqlRunnerJobStatusResponse['results'] | ApiSemanticLayerClientInfo['results'] | ApiSemanticViewerChartCreate['results'] | ApiSemanticViewerChartGet['results'] | ApiSemanticViewerChartUpdate['results'] | ApiCreateVirtualView['results'] | ApiGithubDbtWritePreview['results'] | ApiMetricsCatalog['results'] | ApiMetricsExplorerQueryResults['results'] | ApiGroupListResponse['results'] | ApiCreateTagResponse['results'] | ApiChartAsCodeListResponse['results'] | ApiDashboardAsCodeListResponse['results'] | ApiChartAsCodeUpsertResponse['results'] | ApiGetMetricsTree['results'] | ApiMetricsExplorerTotalResults['results'] | ApiGetSpotlightTableConfig['results'];
+type ApiResults = ApiQueryResults | ApiSqlQueryResults | ApiCompiledQueryResults | ApiExploresResults | ApiExploreResults | ApiStatusResults | ApiRefreshResults | ApiHealthResults | Organization | LightdashUser | LoginOptions | SavedChart | SavedChart[] | Space[] | InviteLink | OrganizationProject[] | Project | WarehouseCredentials | OrganizationMemberProfile[] | ProjectCatalog | TablesConfiguration | Dashboard | DashboardBasicDetails[] | OnboardingStatus | Dashboard[] | DeleteOpenIdentity | ApiFlashResults | Record<OpenIdIdentitySummary['issuerType'], OpenIdIdentitySummary[]> | FilterableField[] | DashboardAvailableFilters | ProjectSavedChartStatus | null | Array<unknown> | ApiJobStartedResults | ApiCreateUserTokenResults | CreatePersonalAccessToken | PersonalAccessToken | ProjectMemberProfile[] | ProjectGroupAccess | SearchResults | Space | ShareUrl | SlackSettings | ApiSlackChannelsResponse['results'] | UserActivity | SchedulerAndTargets | SchedulerAndTargets[] | FieldValueSearchResult | ApiDownloadCsv | AllowedEmailDomains | UpdateAllowedEmailDomains | UserAllowedOrganization[] | EmailStatusExpiring | ApiScheduledDownloadCsv | PinnedItems | ViewStatistics | SchedulerWithLogs | ValidationResponse[] | ChartHistory | ChartVersion | EmbedUrl | DecodedEmbed | Array<GitRepo> | PullRequestCreated | GitIntegrationConfiguration | UserWarehouseCredentials | ApiJobStatusResponse['results'] | ApiJobScheduledResponse['results'] | ApiSshKeyPairResponse['results'] | MostPopularAndRecentlyUpdated | ApiCalculateTotalResponse['results'] | Record<string, DbtExposure> | ApiCreateComment['results'] | ApiGetComments['results'] | ApiDeleteComment | ApiSuccessEmpty | ApiCreateProjectResults | ApiAiDashboardSummaryResponse['results'] | ApiAiGetDashboardSummaryResponse['results'] | ApiCatalogMetadataResults | ApiCatalogAnalyticsResults | ApiAiConversations['results'] | ApiAiConversationMessages['results'] | ApiAiConversationResponse['results'] | ApiPromotionChangesResponse['results'] | ApiWarehouseTableFields['results'] | ApiTogglePinnedItem['results'] | ApiOrganizationMemberProfiles['results'] | ApiSqlChart['results'] | ApiCreateSqlChart['results'] | ApiUpdateSqlChart['results'] | ApiContentResponse['results'] | ApiChartContentResponse['results'] | ApiSqlRunnerJobStatusResponse['results'] | ApiSemanticLayerClientInfo['results'] | ApiSemanticViewerChartCreate['results'] | ApiSemanticViewerChartGet['results'] | ApiSemanticViewerChartUpdate['results'] | ApiCreateVirtualView['results'] | ApiGithubDbtWritePreview['results'] | ApiMetricsCatalog['results'] | ApiMetricsExplorerQueryResults['results'] | ApiGroupListResponse['results'] | ApiCreateTagResponse['results'] | ApiChartAsCodeListResponse['results'] | ApiDashboardAsCodeListResponse['results'] | ApiChartAsCodeUpsertResponse['results'] | ApiGetMetricsTree['results'] | ApiMetricsExplorerTotalResults['results'] | ApiGetSpotlightTableConfig['results'];
 export type ApiResponse<T extends ApiResults = ApiResults> = {
     status: 'ok';
     results: T;

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getProjectDirectory = exports.deepEqual = exports.removeEmptyProperties = exports.formatRows = exports.itemsInMetricQuery = exports.getTableCalculationsFromItemsMap = exports.getMetricsFromItemsMap = exports.getFilterableDimensionsFromItemsMap = exports.getDimensionsFromItemsMap = exports.getItemMap = exports.getFieldMap = exports.getAxisName = exports.getDateGroupLabel = exports.getResultValueArray = exports.DbtProjectTypeLabels = exports.sensitiveDbtCredentialsFieldNames = exports.DBFieldTypes = exports.LightdashInstallType = exports.isLightdashMode = exports.LightdashMode = exports.isApiError = exports.hasInviteCode = exports.TableSelectionType = exports.hasSpecialCharacters = exports.snakeCaseName = exports.findFieldByIdInExplore = exports.getVisibleFields = exports.SEED_GROUP = exports.SEED_SPACE = exports.SEED_PROJECT = exports.SEED_ORG_2_ADMIN_PASSWORD = exports.SEED_ORG_2_ADMIN_EMAIL = exports.SEED_ORG_2_ADMIN = exports.SEED_ORG_2 = exports.SEED_ORG_1_ADMIN_PASSWORD = exports.SEED_ORG_1_ADMIN_EMAIL = exports.SEED_ORG_1_ADMIN = exports.SEED_ORG_1 = exports.hexToRGB = exports.replaceStringInArray = exports.toggleArrayValue = exports.hasIntersection = exports.validatePassword = exports.getPasswordSchema = exports.getEmailSchema = exports.validateEmail = exports.assertUnreachable = exports.lightdashProjectConfigSchema = exports.lightdashDbtYamlSchema = void 0;
+exports.getProjectDirectory = exports.deepEqual = exports.removeEmptyProperties = exports.formatRows = exports.itemsInMetricQuery = exports.getTableCalculationsFromItemsMap = exports.getMetricsFromItemsMap = exports.getFilterableDimensionsFromItemsMap = exports.getDimensionsFromItemsMap = exports.getItemMap = exports.getFieldMap = exports.getAxisName = exports.getDateGroupLabel = exports.getResultValueArray = exports.DbtProjectTypeLabels = exports.sensitiveDbtCredentialsFieldNames = exports.DBFieldTypes = exports.LightdashInstallType = exports.isLightdashMode = exports.LightdashMode = exports.isApiError = exports.hasInviteCode = exports.TableSelectionType = exports.hasSpecialCharacters = exports.snakeCaseName = exports.findFieldByIdInExplore = exports.getVisibleFields = exports.SEED_GROUP = exports.SEED_SPACE = exports.SEED_PROJECT = exports.SEED_EMBED_SECRET = exports.SEED_ORG_2_ADMIN_PASSWORD = exports.SEED_ORG_2_ADMIN_EMAIL = exports.SEED_ORG_2_ADMIN = exports.SEED_ORG_2 = exports.SEED_ORG_1_ADMIN_PASSWORD = exports.SEED_ORG_1_ADMIN_EMAIL = exports.SEED_ORG_1_ADMIN = exports.SEED_ORG_1 = exports.hexToRGB = exports.replaceStringInArray = exports.toggleArrayValue = exports.hasIntersection = exports.validatePassword = exports.getPasswordSchema = exports.getEmailSchema = exports.validateEmail = exports.assertUnreachable = exports.lightdashProjectConfigSchema = exports.lightdashDbtYamlSchema = void 0;
 const tslib_1 = require("tslib");
 const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
 const utc_1 = tslib_1.__importDefault(require("dayjs/plugin/utc"));
@@ -19,6 +19,7 @@ tslib_1.__exportStar(require("./compiler/exploreCompiler"), exports);
 tslib_1.__exportStar(require("./compiler/filtersCompiler"), exports);
 tslib_1.__exportStar(require("./compiler/translator"), exports);
 tslib_1.__exportStar(require("./dbt/validation"), exports);
+tslib_1.__exportStar(require("./ee/index"), exports);
 tslib_1.__exportStar(require("./pivotTable/pivotQueryResults"), exports);
 var lightdash_dbt_2_0_json_1 = require("./schemas/json/lightdash-dbt-2.0.json");
 Object.defineProperty(exports, "lightdashDbtYamlSchema", { enumerable: true, get: function () { return tslib_1.__importDefault(lightdash_dbt_2_0_json_1).default; } });
@@ -222,6 +223,7 @@ exports.SEED_ORG_2_ADMIN_EMAIL = {
 exports.SEED_ORG_2_ADMIN_PASSWORD = {
     password: 'demo_password!',
 };
+exports.SEED_EMBED_SECRET = 'zU3h50saDOO20czNFNRok';
 exports.SEED_PROJECT = {
     project_uuid: '3675b69e-8324-4110-bdca-059031aa8da3',
     name: 'Jaffle shop',

package/dist/index.test.js

@@ -100,3 +100,26 @@ describe('getDateGroupLabel', () => {
         })).toEqual('Day date day'); // doesn't recognize (day) as a valid time frame
     });
 });
+describe('email validation', () => {
+    test.each([
+        'demo@lightdash.com',
+        'de.mo@lightdash.com',
+        'Demo@lightdash.com',
+        'user+tag@domain.co.uk',
+        'user@sub.domain.com',
+        'user@domain.info',
+        'user123@domain.org',
+    ])('valid email: %s', (email) => {
+        expect((0, _1.isValidEmailAddress)(email)).toBe(true);
+    });
+    test.each([
+        ['demo@lightdash', 'Missing top-level domain'],
+        ['de mo@lightdash.com', 'Whitespace in email'],
+        ['demo@lightdash..com', 'Double dot in domain'],
+        ['@lightdash.com', 'Missing local part'],
+        ['demo@.com', 'Missing domain name'],
+        ['demo@lightdash.c', 'Top-level domain too short'],
+    ])('invalid email: %s - %s', (email) => {
+        expect((0, _1.isValidEmailAddress)(email)).toBe(false);
+    });
+});

package/dist/schemas/json/lightdash-dbt-2.0.json

@@ -190,11 +190,18 @@
                                             },
                                             "spotlight": {
                                                 "type": "object",
-                                                "description": "Set the visibility of a metric in Spotlight",
+                                                "description": "Set the visibility and/or categories of a metric in Spotlight",
                                                 "properties": {
                                                     "visibility": {
                                                         "type": "string",
                                                         "enum": ["show", "hide"]
+                                                    },
+                                                    "categories": {
+                                                        "type": "array",
+                                                        "items": {
+                                                            "type": "string"
+                                                        },
+                                                        "description": "An array of categories for the metric in Spotlight"
                                                     }
                                                 },
                                                 "anyOf": [
@@ -202,6 +209,11 @@
                                                         "required": [
                                                             "visibility"
                                                         ]
+                                                    },
+                                                    {
+                                                        "required": [
+                                                            "categories"
+                                                        ]
                                                     }
                                                 ]
                                             }
@@ -233,14 +245,24 @@
                             },
                             "spotlight": {
                                 "type": "object",
-                                "description": "Set the visibility of all metrics in this model in Spotlight",
+                                "description": "Set the visibility and/or categories of a metric in Spotlight",
                                 "properties": {
                                     "visibility": {
                                         "type": "string",
                                         "enum": ["show", "hide"]
+                                    },
+                                    "categories": {
+                                        "type": "array",
+                                        "items": {
+                                            "type": "string"
+                                        },
+                                        "description": "An optional array of categories for all metrics in this model in Spotlight"
                                     }
                                 },
-                                "anyOf": [{ "required": ["visibility"] }]
+                                "anyOf": [
+                                    { "required": ["visibility"] },
+                                    { "required": ["categories"] }
+                                ]
                             }
                         }
                     },
@@ -387,7 +409,7 @@
                                                         },
                                                         "spotlight": {
                                                             "type": "object",
-                                                            "description": "Set the visibility of a metric in Spotlight",
+                                                            "description": "Set the visibility and/or categories of a metric in Spotlight",
                                                             "properties": {
                                                                 "visibility": {
                                                                     "type": "string",
@@ -395,6 +417,13 @@
                                                                         "show",
                                                                         "hide"
                                                                     ]
+                                                                },
+                                                                "categories": {
+                                                                    "type": "array",
+                                                                    "items": {
+                                                                        "type": "string"
+                                                                    },
+                                                                    "description": "An array of categories for the metric in Spotlight"
                                                                 }
                                                             },
                                                             "anyOf": [
@@ -402,6 +431,11 @@
                                                                     "required": [
                                                                         "visibility"
                                                                     ]
+                                                                },
+                                                                {
+                                                                    "required": [
+                                                                        "categories"
+                                                                    ]
                                                                 }
                                                             ]
                                                         }
@@ -681,14 +715,24 @@
                             },
                             "spotlight": {
                                 "type": "object",
-                                "description": "Set the visibility of a metric in Spotlight",
+                                "description": "Set the visibility and/or categories of a metric in Spotlight",
                                 "properties": {
                                     "visibility": {
                                         "type": "string",
                                         "enum": ["show", "hide"]
+                                    },
+                                    "categories": {
+                                        "type": "array",
+                                        "items": {
+                                            "type": "string"
+                                        },
+                                        "description": "An array of categories for the metric in Spotlight"
                                     }
                                 },
-                                "anyOf": [{ "required": ["visibility"] }]
+                                "anyOf": [
+                                    { "required": ["visibility"] },
+                                    { "required": ["categories"] }
+                                ]
                             }
                         }
                     }

package/dist/schemas/json/lightdash-project-config-1.0.json

@@ -9,7 +9,39 @@
                 "default_visibility": {
                     "type": "string",
                     "enum": ["show", "hide"],
-                    "default": "show"
+                    "default": "show",
+                    "description": "The visibility of Spotlight metrics by default - if not provided, it will be set to 'show'"
+                },
+                "categories": {
+                    "type": "object",
+                    "description": "Define the categories that can be used in Spotlight on your model yml files",
+                    "patternProperties": {
+                        "^[a-zA-Z0-9_-]+$": {
+                            "type": "object",
+                            "properties": {
+                                "label": {
+                                    "description": "The label of the category as it will be displayed in Spotlight",
+                                    "type": "string"
+                                },
+                                "color": {
+                                    "description": "The color of the category, if not provided, it will be set to gray",
+                                    "type": "string",
+                                    "enum": [
+                                        "gray",
+                                        "violet",
+                                        "red",
+                                        "orange",
+                                        "green",
+                                        "blue",
+                                        "indigo",
+                                        "pink",
+                                        "yellow"
+                                    ]
+                                }
+                            },
+                            "required": ["label"]
+                        }
+                    }
                 }
             }
         }

package/dist/types/analytics.d.ts

@@ -55,6 +55,8 @@ export declare enum QueryExecutionContext {
     SCHEDULED_CHART = "scheduledChart",
     SCHEDULED_DASHBOARD = "scheduledDashboard",
     CALCULATE_TOTAL = "calculateTotal",
+    EMBED = "embed",
+    AI = "ai",
     API = "api",
     CLI = "cli",
     SEMANTIC_VIEWER = "semanticViewer",

package/dist/types/analytics.js

@@ -19,6 +19,8 @@ var QueryExecutionContext;
     QueryExecutionContext["SCHEDULED_CHART"] = "scheduledChart";
     QueryExecutionContext["SCHEDULED_DASHBOARD"] = "scheduledDashboard";
     QueryExecutionContext["CALCULATE_TOTAL"] = "calculateTotal";
+    QueryExecutionContext["EMBED"] = "embed";
+    QueryExecutionContext["AI"] = "ai";
     QueryExecutionContext["API"] = "api";
     QueryExecutionContext["CLI"] = "cli";
     QueryExecutionContext["SEMANTIC_VIEWER"] = "semanticViewer";

package/dist/types/catalog.d.ts

@@ -41,7 +41,7 @@ export type CatalogField = Pick<Field, 'name' | 'label' | 'fieldType' | 'tableLa
     tableName: string;
     tableGroupLabel?: string;
     tags?: string[];
-    categories: Pick<Tag, 'name' | 'color' | 'tagUuid'>[];
+    categories: Pick<Tag, 'name' | 'color' | 'tagUuid' | 'yamlReference'>[];
     chartUsage: number | undefined;
     icon: CatalogItemIcon | null;
 };
@@ -51,7 +51,7 @@ export type CatalogTable = Pick<TableBase, 'name' | 'label' | 'groupLabel' | 'de
     type: CatalogType.Table;
     groupLabel?: string;
     tags?: string[];
-    categories: Pick<Tag, 'name' | 'color' | 'tagUuid'>[];
+    categories: Pick<Tag, 'name' | 'color' | 'tagUuid' | 'yamlReference'>[];
     joinedTables?: CompiledExploreJoin[];
     chartUsage: number | undefined;
     icon: CatalogItemIcon | null;
@@ -129,6 +129,7 @@ export type CatalogItemWithTagUuids = CatalogItemSummary & {
         tagUuid: string;
         createdByUserUuid: string | null;
         createdAt: Date;
+        taggedViaYaml: boolean;
     }[];
 };
 export type CatalogItemsWithIcons = CatalogItemSummary & Pick<CatalogItem, 'icon'>;

package/dist/types/dashboard.d.ts

@@ -165,8 +165,8 @@ export type DashboardAvailableFilters = {
     allFilterableFields: FilterableDimension[];
 };
 export type SavedChartsInfoForDashboardAvailableFilters = {
-    tileUuid: DashboardChartTile['uuid'];
-    savedChartUuid: NonNullable<DashboardChartTile['properties']['savedChartUuid']>;
+    tileUuid: string;
+    savedChartUuid: string;
 }[];
 export declare const isDashboardUnversionedFields: (data: UpdateDashboard) => data is DashboardUnversionedFields;
 export declare const isDashboardVersionedFields: (data: UpdateDashboard) => data is DashboardVersionedFields;

package/dist/types/dbt.d.ts

@@ -68,6 +68,7 @@ type DbtModelLightdashConfig = {
     };
     spotlight?: {
         visibility?: NonNullable<LightdashProjectConfig['spotlight']>['default_visibility'];
+        categories?: string[];
     };
 };
 export type DbtModelGroup = {
@@ -133,6 +134,7 @@ export type DbtColumnLightdashMetric = {
     default_time_dimension?: DefaultTimeDimension;
     spotlight?: {
         visibility?: NonNullable<LightdashProjectConfig['spotlight']>['default_visibility'];
+        categories?: string[];
     };
 } & DbtLightdashFieldTags;
 export type DbtModelLightdashMetric = DbtColumnLightdashMetric & Required<Pick<DbtColumnLightdashMetric, 'sql'>>;
@@ -248,8 +250,9 @@ type ConvertModelMetricArgs = {
     dimensionReference?: string;
     requiredAttributes?: Record<string, string | string[]>;
     spotlightConfig?: LightdashProjectConfig['spotlight'];
+    modelCategories?: string[];
 };
-export declare const convertModelMetric: ({ modelName, name, metric, source, tableLabel, dimensionReference, requiredAttributes, spotlightConfig, }: ConvertModelMetricArgs) => Metric;
+export declare const convertModelMetric: ({ modelName, name, metric, source, tableLabel, dimensionReference, requiredAttributes, spotlightConfig, modelCategories, }: ConvertModelMetricArgs) => Metric;
 type ConvertColumnMetricArgs = Omit<ConvertModelMetricArgs, 'metric'> & {
     metric: DbtColumnLightdashMetric;
     dimensionName?: string;
@@ -257,7 +260,7 @@ type ConvertColumnMetricArgs = Omit<ConvertModelMetricArgs, 'metric'> & {
     requiredAttributes?: Record<string, string | string[]>;
     modelCategories?: string[];
 };
-export declare const convertColumnMetric: ({ modelName, dimensionName, dimensionSql, name, metric, source, tableLabel, requiredAttributes, spotlightConfig, }: ConvertColumnMetricArgs) => Metric;
+export declare const convertColumnMetric: ({ modelName, dimensionName, dimensionSql, name, metric, source, tableLabel, requiredAttributes, spotlightConfig, modelCategories, }: ConvertColumnMetricArgs) => Metric;
 export declare enum DbtManifestVersion {
     V7 = "v7",
     V8 = "v8",

package/dist/types/dbt.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCompiledModels = exports.getModelsFromManifest = exports.DbtExposureType = exports.getLatestSupportedDbtManifestVersion = exports.getDbtManifestVersion = exports.DbtManifestVersion = exports.convertColumnMetric = exports.convertModelMetric = exports.isDbtRpcRunSqlResults = exports.convertToGroups = exports.isDbtRpcCompileResults = exports.isDbtRpcManifestResults = exports.isSupportedDbtAdapterType = exports.isSupportedDbtAdapter = exports.isV9MetricRef = exports.isDbtPackages = exports.isDbtRpcDocsGenerateResults = exports.buildModelGraph = exports.patchPathParts = exports.normaliseModelDatabase = exports.SupportedDbtAdapter = void 0;
 const tslib_1 = require("tslib");
 const dependency_graph_1 = require("dependency-graph");
+const lightdashProjectConfig_1 = require("../compiler/lightdashProjectConfig");
 const assertUnreachable_1 = tslib_1.__importDefault(require("../utils/assertUnreachable"));
 const item_1 = require("../utils/item");
 const errors_1 = require("./errors");
@@ -136,9 +137,11 @@ results) => 'results' in results &&
         'rows' in result.table &&
         Array.isArray(result.table.rows));
 exports.isDbtRpcRunSqlResults = isDbtRpcRunSqlResults;
-const convertModelMetric = ({ modelName, name, metric, source, tableLabel, dimensionReference, requiredAttributes, spotlightConfig, }) => {
+const convertModelMetric = ({ modelName, name, metric, source, tableLabel, dimensionReference, requiredAttributes, spotlightConfig, modelCategories = [], }) => {
     const groups = (0, exports.convertToGroups)(metric.groups, metric.group_label);
     const spotlightVisibility = metric.spotlight?.visibility ?? spotlightConfig?.default_visibility;
+    const metricCategories = Array.from(new Set([...modelCategories, ...(metric.spotlight?.categories || [])]));
+    const spotlightCategories = (0, lightdashProjectConfig_1.getCategoriesFromResource)('metric', name, spotlightConfig, metricCategories);
     return {
         fieldType: field_1.FieldType.METRIC,
         name,
@@ -176,17 +179,11 @@ const convertModelMetric = ({ modelName, name, metric, source, tableLabel, dimen
                 },
             }
             : null),
-        ...(spotlightVisibility !== undefined
-            ? {
-                spotlight: {
-                    visibility: spotlightVisibility,
-                },
-            }
-            : {}),
+        ...(0, lightdashProjectConfig_1.getSpotlightConfigurationForResource)(spotlightVisibility, spotlightCategories),
     };
 };
 exports.convertModelMetric = convertModelMetric;
-const convertColumnMetric = ({ modelName, dimensionName, dimensionSql, name, metric, source, tableLabel, requiredAttributes, spotlightConfig, }) => (0, exports.convertModelMetric)({
+const convertColumnMetric = ({ modelName, dimensionName, dimensionSql, name, metric, source, tableLabel, requiredAttributes, spotlightConfig, modelCategories = [], }) => (0, exports.convertModelMetric)({
     modelName,
     name,
     metric: {
@@ -212,6 +209,7 @@ const convertColumnMetric = ({ modelName, dimensionName, dimensionSql, name, met
         }
         : null),
     spotlightConfig,
+    modelCategories,
 });
 exports.convertColumnMetric = convertColumnMetric;
 var DbtManifestVersion;

package/dist/types/explore.d.ts

@@ -45,7 +45,8 @@ export type Explore = {
     sqlPath?: string;
     type?: ExploreType;
     spotlight?: {
-        visibility: Required<NonNullable<LightdashProjectConfig['spotlight']>>['default_visibility'];
+        visibility: LightdashProjectConfig['spotlight']['default_visibility'];
+        categories?: string[];
     };
 };
 export declare enum InlineErrorType {

package/dist/types/field.d.ts

@@ -243,7 +243,8 @@ export interface Metric extends Field {
     requiredAttributes?: Record<string, string | string[]>;
     defaultTimeDimension?: DefaultTimeDimension;
     spotlight?: {
-        visibility: Required<NonNullable<LightdashProjectConfig['spotlight']>>['default_visibility'];
+        visibility: LightdashProjectConfig['spotlight']['default_visibility'];
+        categories?: string[];
     };
 }
 export declare const isFilterableDimension: (dimension: Dimension) => dimension is FilterableDimension;

package/dist/types/lightdashProjectConfig.d.ts

@@ -1,8 +1,15 @@
+type SpotlightCategory = {
+    label: string;
+    color?: string;
+};
 type SpotlightConfig = {
     default_visibility: 'show' | 'hide';
+    categories?: {
+        [yaml_reference: string]: SpotlightCategory;
+    };
 };
 export type LightdashProjectConfig = {
     spotlight: SpotlightConfig;
 };
-export declare const DEFAULT_SPOTLIGHT_CONFIG: Required<SpotlightConfig>;
+export declare const DEFAULT_SPOTLIGHT_CONFIG: SpotlightConfig;
 export {};

package/dist/types/slack.d.ts

@@ -13,6 +13,7 @@ export type ApiSlackCustomSettingsResponse = {
 export type SlackChannelProjectMapping = {
     projectUuid: string;
     slackChannelId: string;
+    availableTags: string[] | null;
 };
 export type SlackAppCustomSettings = {
     notificationChannel: string | null;

package/dist/types/slackSettings.js

@@ -10,6 +10,7 @@ exports.slackRequiredScopes = [
     'channels:join',
     'groups:read',
     'users:read',
+    'app_mentions:read',
     'files:write',
     'files:read',
 ];