Skip to content

Commit 8636872

Browse files
improve type safety
1 parent 76546fd commit 8636872

File tree

7 files changed

+25
-12
lines changed

7 files changed

+25
-12
lines changed

src/core/module-exporter.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
import { formatError, log } from '@contentstack/cli-utilities';
22
import ExportCommand from '@contentstack/cli-cm-export';
33
import { QueryExportConfig, Modules, ExportOptions } from '../types';
4-
import { createLogContext } from '../utils/logger';
4+
import { createLogContext, LogContext } from '../utils/logger';
55

66

77
export class ModuleExporter {
88
private exportQueryConfig: QueryExportConfig;
99
private exportedModules: string[] = [];
10-
private logContext: any;
10+
private readonly logContext: LogContext;
1111

1212
constructor(exportQueryConfig: QueryExportConfig) {
1313
this.exportQueryConfig = exportQueryConfig;

src/core/query-executor.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import * as path from 'path';
33
import { QueryExportConfig, Modules } from '../types';
44
import { QueryParser } from '../utils/query-parser';
55
import { ModuleExporter } from './module-exporter';
6-
import { createLogContext } from '../utils/logger';
6+
import { createLogContext, LogContext } from '../utils/logger';
77
import { ReferencedContentTypesHandler } from '../utils';
88
import { fsUtil } from '../utils';
99
import { ContentTypeDependenciesHandler } from '../utils';
@@ -14,7 +14,7 @@ export class QueryExporter {
1414
private exportQueryConfig: QueryExportConfig;
1515
private queryParser: QueryParser;
1616
private moduleExporter: ModuleExporter;
17-
private logContext: any;
17+
private readonly logContext: LogContext;
1818

1919
constructor(managementAPIClient: ContentstackClient, exportQueryConfig: QueryExportConfig) {
2020
this.exportQueryConfig = exportQueryConfig;

src/utils/content-type-helper.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
import * as path from 'path';
22
import { log } from '@contentstack/cli-utilities';
33
import { QueryExportConfig } from '../types';
4-
import { createLogContext } from './logger';
4+
import { createLogContext, LogContext } from './logger';
55

66
export class ReferencedContentTypesHandler {
77
private exportQueryConfig: QueryExportConfig;
8-
private logContext: any;
8+
private readonly logContext: LogContext;
99

1010
constructor(exportQueryConfig: QueryExportConfig) {
1111
this.exportQueryConfig = exportQueryConfig;

src/utils/dependency-resolver.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@ import * as path from 'path';
22
import { QueryExportConfig } from '../types';
33
import { fsUtil } from './index';
44
import { ContentstackClient, sanitizePath, log } from '@contentstack/cli-utilities';
5-
import { createLogContext } from './logger';
5+
import { createLogContext, LogContext } from './logger';
66

77
export class ContentTypeDependenciesHandler {
88
private exportQueryConfig: QueryExportConfig;
99
private stackAPIClient: ReturnType<ContentstackClient['stack']>;
10-
private logContext: any;
10+
private readonly logContext: LogContext;
1111

1212
constructor(stackAPIClient: any, exportQueryConfig: QueryExportConfig) {
1313
this.exportQueryConfig = exportQueryConfig;

src/utils/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
export * as fileHelper from './file-helper';
22
export { fsUtil } from './file-helper';
3-
export { log, unlinkFileLogger, createLogContext } from './logger';
3+
export { log, unlinkFileLogger, createLogContext, LogContext } from './logger';
44
export * from './common-helper';
55
export * from './config-handler';
66
export * from './content-type-helper';

src/utils/logger.ts

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,10 +167,23 @@ export const unlinkFileLogger = () => {
167167
}
168168
};
169169

170+
/**
171+
* Log context interface for centralized logging
172+
*/
173+
export interface LogContext {
174+
command: string;
175+
module: string;
176+
email: string;
177+
sessionId: string;
178+
apiKey: string;
179+
orgId: string;
180+
authenticationMethod: string;
181+
}
182+
170183
/**
171184
* Creates a context object for logging from QueryExportConfig
172185
*/
173-
export function createLogContext(config: QueryExportConfig): any {
186+
export function createLogContext(config: QueryExportConfig): LogContext {
174187
return {
175188
command: 'cm:stacks:export-query',
176189
module: '',

src/utils/referenced-asset-handler.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ import * as fs from 'fs';
33
import { QueryExportConfig } from '../types';
44
import { fsUtil } from './index';
55
import { sanitizePath, log } from '@contentstack/cli-utilities';
6-
import { createLogContext } from './logger';
6+
import { createLogContext, LogContext } from './logger';
77

88
export class AssetReferenceHandler {
99
private exportQueryConfig: QueryExportConfig;
1010
private entriesDir: string;
11-
private logContext: any;
11+
private readonly logContext: LogContext;
1212

1313
constructor(exportQueryConfig: QueryExportConfig) {
1414
this.exportQueryConfig = exportQueryConfig;

0 commit comments

Comments
 (0)