@lightdash/common 0.1385.1 → 0.1386.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +3 -1
- package/dist/index.js +1 -0
- package/dist/types/coder.d.ts +17 -0
- package/dist/types/coder.js +4 -0
- package/dist/types/filter.d.ts +1 -0
- package/dist/types/filter.js +21 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -37,6 +37,7 @@ import { type LightdashUser, type LoginOptions, type UserAllowedOrganization } f
|
|
|
37
37
|
import { type UserWarehouseCredentials } from './types/userWarehouseCredentials';
|
|
38
38
|
import { type ValidationResponse } from './types/validation';
|
|
39
39
|
import { type ApiCatalogAnalyticsResults, type ApiCatalogMetadataResults, type ApiMetricsCatalog } from './types/catalog';
|
|
40
|
+
import { type ApiChartAsCodeListResponse, type ApiChartAsCodeUpsertResponse } from './types/coder';
|
|
40
41
|
import { type ApiChartContentResponse, type ApiContentResponse } from './types/content';
|
|
41
42
|
import type { ApiGroupListResponse } from './types/groups';
|
|
42
43
|
import type { ApiMetricsExplorerQueryResults } from './types/metricsExplorer';
|
|
@@ -63,6 +64,7 @@ export * from './types/api/sort';
|
|
|
63
64
|
export * from './types/api/success';
|
|
64
65
|
export * from './types/api/uuid';
|
|
65
66
|
export * from './types/catalog';
|
|
67
|
+
export * from './types/coder';
|
|
66
68
|
export * from './types/comments';
|
|
67
69
|
export * from './types/conditionalFormatting';
|
|
68
70
|
export * from './types/conditionalRule';
|
|
@@ -379,7 +381,7 @@ export type ApiAiGetDashboardSummaryResponse = {
|
|
|
379
381
|
status: 'ok';
|
|
380
382
|
results: DashboardSummary;
|
|
381
383
|
};
|
|
382
|
-
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'];
|
|
384
|
+
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'] | ApiChartAsCodeUpsertResponse['results'];
|
|
383
385
|
export type ApiResponse<T extends ApiResults = ApiResults> = {
|
|
384
386
|
status: 'ok';
|
|
385
387
|
results: T;
|
package/dist/index.js
CHANGED
|
@@ -33,6 +33,7 @@ tslib_1.__exportStar(require("./types/api/sort"), exports);
|
|
|
33
33
|
tslib_1.__exportStar(require("./types/api/success"), exports);
|
|
34
34
|
tslib_1.__exportStar(require("./types/api/uuid"), exports);
|
|
35
35
|
tslib_1.__exportStar(require("./types/catalog"), exports);
|
|
36
|
+
tslib_1.__exportStar(require("./types/coder"), exports);
|
|
36
37
|
tslib_1.__exportStar(require("./types/comments"), exports);
|
|
37
38
|
tslib_1.__exportStar(require("./types/conditionalFormatting"), exports);
|
|
38
39
|
tslib_1.__exportStar(require("./types/conditionalRule"), exports);
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { SavedChart } from '..';
|
|
2
|
+
export declare const currentVersion = 1;
|
|
3
|
+
export type ChartAsCode = Pick<SavedChart, 'name' | 'description' | 'tableName' | 'metricQuery' | 'chartConfig' | 'tableConfig' | 'slug' | 'dashboardUuid' | 'colorPalette' | 'updatedAt'> & {
|
|
4
|
+
version: number;
|
|
5
|
+
spaceSlug: string;
|
|
6
|
+
};
|
|
7
|
+
export type ApiChartAsCodeListResponse = {
|
|
8
|
+
status: 'ok';
|
|
9
|
+
results: ChartAsCode[];
|
|
10
|
+
};
|
|
11
|
+
export type ApiChartAsCodeUpsertResponse = {
|
|
12
|
+
status: 'ok';
|
|
13
|
+
results: {
|
|
14
|
+
chart: ChartAsCode;
|
|
15
|
+
created: boolean;
|
|
16
|
+
};
|
|
17
|
+
};
|
package/dist/types/filter.d.ts
CHANGED
|
@@ -18,6 +18,7 @@ export declare enum UnitOfTime {
|
|
|
18
18
|
years = "years"
|
|
19
19
|
}
|
|
20
20
|
export declare const unitOfTimeFormat: Record<UnitOfTime, string>;
|
|
21
|
+
export declare const getUnitsOfTimeGreaterOrEqual: (unit: UnitOfTime) => UnitOfTime[];
|
|
21
22
|
export type FieldTarget = {
|
|
22
23
|
fieldId: string;
|
|
23
24
|
};
|
package/dist/types/filter.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.FilterOperator = exports.isFilterRuleDefinedForFieldId = exports.compressDashboardFiltersToParam = exports.convertDashboardFiltersParamToDashboardFilters = exports.convertDashboardFiltersToFilters = exports.FilterGroupOperator = exports.isDashboardFilterRule = exports.applyDimensionOverrides = exports.removeFieldFromFilterGroup = exports.updateFieldIdInFilters = exports.updateFieldIdInFilterGroupItem = exports.getFilterRules = exports.isMetricFilterTarget = exports.isFilterTarget = exports.isFilterRule = exports.isFilterGroup = exports.isAndFilterGroup = exports.isOrFilterGroup = exports.unitOfTimeFormat = exports.UnitOfTime = exports.FilterType = void 0;
|
|
3
|
+
exports.FilterOperator = exports.isFilterRuleDefinedForFieldId = exports.compressDashboardFiltersToParam = exports.convertDashboardFiltersParamToDashboardFilters = exports.convertDashboardFiltersToFilters = exports.FilterGroupOperator = exports.isDashboardFilterRule = exports.applyDimensionOverrides = exports.removeFieldFromFilterGroup = exports.updateFieldIdInFilters = exports.updateFieldIdInFilterGroupItem = exports.getFilterRules = exports.isMetricFilterTarget = exports.isFilterTarget = exports.isFilterRule = exports.isFilterGroup = exports.isAndFilterGroup = exports.isOrFilterGroup = exports.getUnitsOfTimeGreaterOrEqual = exports.unitOfTimeFormat = exports.UnitOfTime = exports.FilterType = void 0;
|
|
4
4
|
const conditionalRule_1 = require("./conditionalRule");
|
|
5
5
|
Object.defineProperty(exports, "FilterOperator", { enumerable: true, get: function () { return conditionalRule_1.ConditionalOperator; } });
|
|
6
6
|
var FilterType;
|
|
@@ -33,6 +33,26 @@ exports.unitOfTimeFormat = {
|
|
|
33
33
|
quarters: 'YYYY-MM',
|
|
34
34
|
years: 'YYYY',
|
|
35
35
|
};
|
|
36
|
+
const getUnitsOfTimeGreaterOrEqual = (unit) => {
|
|
37
|
+
const unitsInOrder = [
|
|
38
|
+
UnitOfTime.milliseconds,
|
|
39
|
+
UnitOfTime.seconds,
|
|
40
|
+
UnitOfTime.minutes,
|
|
41
|
+
UnitOfTime.hours,
|
|
42
|
+
UnitOfTime.days,
|
|
43
|
+
UnitOfTime.weeks,
|
|
44
|
+
UnitOfTime.months,
|
|
45
|
+
UnitOfTime.quarters,
|
|
46
|
+
UnitOfTime.years,
|
|
47
|
+
];
|
|
48
|
+
const index = unitsInOrder.indexOf(unit);
|
|
49
|
+
if (index === -1) {
|
|
50
|
+
// return the original array if the unit is not found
|
|
51
|
+
return unitsInOrder;
|
|
52
|
+
}
|
|
53
|
+
return unitsInOrder.slice(index);
|
|
54
|
+
};
|
|
55
|
+
exports.getUnitsOfTimeGreaterOrEqual = getUnitsOfTimeGreaterOrEqual;
|
|
36
56
|
/* Utils */
|
|
37
57
|
const isOrFilterGroup = (value) => 'or' in value;
|
|
38
58
|
exports.isOrFilterGroup = isOrFilterGroup;
|