Skip to content

Commit 536d4d1

Browse files
refactor: consistently name DatabasePage and DatabaseEntry related classes
move classes/interfaces to separate files
1 parent 02d9cb7 commit 536d4d1

8 files changed

+31
-33
lines changed

src/DatabaseEntryMeta.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2+
export interface DatabaseEntryMeta {
3+
id: string;
4+
url: string;
5+
}
Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
1+
import { DatabaseEntryMeta } from './DatabaseEntryMeta';
2+
13
/**
24
* Conventional selection of meta information about a Notion API page.
35
* Made availabel as top-level frontmatter on rendered markdown pages
46
*/
5-
export interface PageMeta extends DatabaseEntryMeta {
6-
id: string;
7-
url: string;
7+
export interface DatabasePageMeta extends DatabaseEntryMeta {
88
title: string;
99
category: string;
1010
order?: number;
1111
layout?: string;
1212
}
1313

14-
export interface DatabaseEntryMeta {
15-
id: string;
16-
url: string;
17-
title: string;
18-
}
14+
Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
import { PageMeta } from "./PageMeta";
1+
import { DatabasePageMeta } from './DatabasePageMeta';
22

3-
export interface PageProperties {
3+
export interface DatabasePageProperties {
44
/**
55
* Meta information about a Notion API page
66
*/
7-
meta: PageMeta;
7+
meta: DatabasePageMeta;
88

99
/**
1010
* A mapping of property object keys -> property values
@@ -16,4 +16,3 @@ export interface PageProperties {
1616
*/
1717
keys: Map<string, string>;
1818
}
19-

src/FrontmatterRenderer.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
import * as yaml from "js-yaml";
2-
import { PageProperties } from "./PageProperties";
1+
import * as yaml from 'js-yaml';
2+
3+
import { DatabasePageProperties } from './DatabasePageProperties';
34

45
export class FrontmatterRenderer {
56
constructor() {}
67

7-
public renderFrontmatter(props: PageProperties) {
8+
public renderFrontmatter(props: DatabasePageProperties) {
89
const obj = {
910
...props.meta,
1011
properties: props.values,

src/PropertiesParser.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
import { Page, PropertyValue } from "@notionhq/client/build/src/api-types";
1+
import { Page, PropertyValue } from '@notionhq/client/build/src/api-types';
22

3-
import { logger } from "./logger";
4-
import { PageProperties } from "./PageProperties";
5-
import { RichTextRenderer } from "./RichTextRenderer";
6-
import { slugify } from "./slugify";
7-
import { DatabaseConfig, DatabaseConfigRenderPages } from "./SyncConfig";
3+
import { DatabasePageProperties } from './DatabasePageProperties';
4+
import { logger } from './logger';
5+
import { RichTextRenderer } from './RichTextRenderer';
6+
import { slugify } from './slugify';
7+
import { DatabaseConfig, DatabaseConfigRenderPages } from './SyncConfig';
88

99
const debug = require("debug")("properties");
1010

@@ -22,7 +22,7 @@ export class PropertiesParser {
2222
public async parsePageProperties(
2323
page: Page,
2424
config: DatabaseConfigRenderPages
25-
): Promise<PageProperties> {
25+
): Promise<DatabasePageProperties> {
2626
const {
2727
title,
2828
category,

src/RenderDatabasePageTask.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
import { PageProperties } from "./PageProperties";
2-
1+
import { DatabasePageProperties } from './DatabasePageProperties';
32

43
export interface RenderDatabasePageTask {
54
id: string;
65
file: string;
7-
properties: PageProperties;
6+
properties: DatabasePageProperties;
87
render: () => Promise<any>;
98
}

src/RenderedDatabaseEntry.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1+
import { DatabaseEntryMeta } from './DatabaseEntryMeta';
2+
13
export interface RenderedDatabaseEntry {
2-
meta: {
3-
id: string;
4-
url: string;
5-
};
4+
meta: DatabaseEntryMeta,
65
properties: Record<string, any>;
76
}

src/RenderedDatabasePage.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
import { PageMeta } from "./PageMeta";
2-
import { RenderedDatabaseEntry } from "./RenderedDatabaseEntry";
3-
1+
import { DatabasePageMeta } from './DatabasePageMeta';
2+
import { RenderedDatabaseEntry } from './RenderedDatabaseEntry';
43

54
export interface RenderedDatabasePage extends RenderedDatabaseEntry {
6-
meta: PageMeta;
5+
meta: DatabasePageMeta;
76
file: string;
87
}

0 commit comments

Comments
 (0)