@lightdash/common 0.1358.0 → 0.1359.0

package/dist/types/catalog.d.ts

@@ -24,6 +24,15 @@ export type ApiCatalogSearch = {
     filter?: CatalogFilter;
     catalogTags?: string[];
 };
+type EmojiIcon = {
+    unicode: string;
+};
+type CustomIcon = {
+    url: string;
+};
+export type CatalogItemIcon = EmojiIcon | CustomIcon;
+export declare const isEmojiIcon: (icon: CatalogItemIcon | null) => icon is EmojiIcon;
+export declare const isCustomIcon: (icon: CatalogItemIcon | null) => icon is CustomIcon;
 export type CatalogField = Pick<Field, 'name' | 'label' | 'fieldType' | 'tableLabel' | 'description'> & Pick<Dimension, 'requiredAttributes'> & {
     catalogSearchUuid: string;
     type: CatalogType.Field;
@@ -33,6 +42,7 @@ export type CatalogField = Pick<Field, 'name' | 'label' | 'fieldType' | 'tableLa
     tags?: string[];
     categories: Pick<Tag, 'name' | 'color' | 'tagUuid'>[];
     chartUsage: number | undefined;
+    icon: CatalogItemIcon | null;
 };
 export type CatalogTable = Pick<TableBase, 'name' | 'label' | 'groupLabel' | 'description' | 'requiredAttributes'> & {
     catalogSearchUuid: string;
@@ -43,6 +53,7 @@ export type CatalogTable = Pick<TableBase, 'name' | 'label' | 'groupLabel' | 'de
     categories: Pick<Tag, 'name' | 'color' | 'tagUuid'>[];
     joinedTables?: CompiledExploreJoin[];
     chartUsage: number | undefined;
+    icon: CatalogItemIcon | null;
 };
 export type CatalogItem = CatalogField | CatalogTable;
 export type ApiCatalogResults = CatalogItem[];
@@ -75,12 +86,9 @@ export type CatalogFieldMap = {
         cachedExploreUuid: string;
     };
 };
-export type CatalogItemWithTagUuids = {
-    catalogSearchUuid: string;
+export type CatalogItemWithTagUuids = Pick<CatalogItem, 'catalogSearchUuid' | 'name' | 'type'> & {
     cachedExploreUuid: string;
     projectUuid: string;
-    name: string;
-    type: CatalogType;
     fieldType?: string;
     exploreBaseTable: string;
     catalogTags: {
@@ -89,11 +97,13 @@ export type CatalogItemWithTagUuids = {
         createdAt: Date;
     }[];
 };
+export type CatalogItemsWithIcons = Pick<CatalogItem, 'catalogSearchUuid' | 'icon' | 'name' | 'type'> & Pick<CatalogItemWithTagUuids, 'cachedExploreUuid' | 'projectUuid' | 'fieldType' | 'exploreBaseTable'>;
 export type SchedulerIndexCatalogJobPayload = {
     projectUuid: string;
     explores: (Explore | ExploreError)[];
     userUuid: string;
     prevCatalogItemsWithTags: CatalogItemWithTagUuids[];
+    prevCatalogItemsWithIcons: CatalogItemsWithIcons[];
 };
 export type CatalogFieldWhere = {
     fieldName: string;
@@ -103,3 +113,4 @@ export type ChartUsageIn = CatalogFieldWhere & {
     chartUsage: number;
 };
 export declare const indexCatalogJob = "indexCatalog";
+export {};

package/dist/types/catalog.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.indexCatalogJob = exports.getBasicType = exports.CatalogFilter = exports.CatalogType = void 0;
+exports.indexCatalogJob = exports.getBasicType = exports.isCustomIcon = exports.isEmojiIcon = exports.CatalogFilter = exports.CatalogType = void 0;
 const tslib_1 = require("tslib");
 const assertUnreachable_1 = tslib_1.__importDefault(require("../utils/assertUnreachable"));
 const field_1 = require("./field");
@@ -15,6 +15,10 @@ var CatalogFilter;
     CatalogFilter["Dimensions"] = "dimensions";
     CatalogFilter["Metrics"] = "metrics";
 })(CatalogFilter = exports.CatalogFilter || (exports.CatalogFilter = {}));
+const isEmojiIcon = (icon) => Boolean(icon && 'unicode' in icon);
+exports.isEmojiIcon = isEmojiIcon;
+const isCustomIcon = (icon) => Boolean(icon && 'url' in icon);
+exports.isCustomIcon = isCustomIcon;
 const getBasicType = (field) => {
     const { type } = field;
     switch (type) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lightdash/common",
-    "version": "0.1358.0",
+    "version": "0.1359.0",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "files": [