feat: utils: getPageProperties add

Author: 01-binary

packages/notion-to-utils/package.json

@@ -11,9 +11,12 @@
   "author": "Jinsoo Lee",
   "license": "MIT",
   "devDependencies": {
-    "typescript": "^5.6.3",
-    "vitest": "^2.1.2",
     "@repo/eslint-config": "workspace:*",
-    "@repo/typescript-config": "workspace:*"
+    "@repo/typescript-config": "workspace:*",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.2"
+  },
+  "dependencies": {
+    "@notionhq/client": "^2.2.15"
   }
 }

packages/notion-to-utils/src/client/getPageProperties.spec.ts

@@ -0,0 +1,62 @@
+import { afterEach, beforeAll, describe, expect, it, vi } from 'vitest';
+import Client from '.';
+
+let notionClient: Client;
+
+beforeAll(() => {
+  notionClient = new Client();
+});
+
+afterEach(() => {
+  vi.restoreAllMocks();
+});
+
+const TEST_ID = 'TEMP';
+
+// Mock response data
+const getPagePropertiesMock = {
+  object: 'page',
+  id: TEST_ID,
+  properties: {
+    Category: { id: '1', type: 'text', text: { content: 'Category A' } },
+    Slug: { id: '2', type: 'text', text: { content: 'slug-value' } },
+  },
+};
+
+describe('getPageProperties', () => {
+  it('should return properties when valid pageId is provided', async () => {
+    // Mock the notionClient.pages.retrieve method
+    notionClient.pages.retrieve = vi
+      .fn()
+      .mockResolvedValue(getPagePropertiesMock);
+
+    // Test when no keys are provided (should return all properties)
+    const properties = await notionClient.getPageProperties(TEST_ID);
+    expect(properties).toEqual(getPagePropertiesMock.properties);
+  });
+
+  it('should return properties when valid pageId, keys are provided', async () => {
+    // Mock the notionClient.pages.retrieve method
+    notionClient.pages.retrieve = vi
+      .fn()
+      .mockResolvedValue(getPagePropertiesMock);
+
+    const filteredProperties = await notionClient.getPageProperties(TEST_ID, [
+      'Category',
+    ]);
+
+    expect(filteredProperties).toEqual({
+      Category: getPagePropertiesMock.properties.Category,
+    });
+  });
+
+  it('should return undefined when invalid pageId is provided', async () => {
+    notionClient.pages.retrieve = vi.fn().mockResolvedValue(null);
+
+    const filteredProperties = await notionClient.getPageProperties(TEST_ID, [
+      'Category',
+    ]);
+
+    expect(filteredProperties).toBeUndefined();
+  });
+});

packages/notion-to-utils/src/client/index.ts

@@ -0,0 +1,40 @@
+import { Client as NotionClient } from '@notionhq/client';
+
+import type { ClientOptions } from '@notionhq/client/build/src/Client';
+import { isPageObjectResponse } from '../page/isPageObjectResponse';
+
+export class Client extends NotionClient {
+  constructor(options: ClientOptions = {}) {
+    super(options);
+  }
+
+  async getPageProperties(pageId: string, keys: string[] = []) {
+    const res = await this.pages.retrieve({
+      page_id: pageId,
+    });
+
+    if (isPageObjectResponse(res)) {
+      const properties = res.properties;
+
+      // keys가 빈 배열이면 모든 properties를 반환
+      if (keys.length === 0) {
+        return properties;
+      }
+
+      const filteredProperties: Record<string, any> = {};
+
+      // keys 배열을 순회하면서 해당하는 properties 값을 추출
+      keys.forEach((key) => {
+        if (key in properties) {
+          filteredProperties[key] = properties[key];
+        }
+      });
+
+      return filteredProperties; // 추출된 properties 반환
+    }
+
+    return;
+  }
+}
+
+export default Client;

packages/notion-to-utils/src/index.ts

@@ -0,0 +1 @@
+export * from './client';

packages/notion-to-utils/src/page/isPageObjectResponse.ts

@@ -0,0 +1,10 @@
+import {
+  PageObjectResponse,
+  GetPageResponse,
+} from '@notionhq/client/build/src/api-endpoints';
+
+export const isPageObjectResponse = (
+  obj: GetPageResponse
+): obj is PageObjectResponse => {
+  return obj && 'properties' in obj;
+};