version: notion-utils v0.4.7

Author: 01-binary

packages/notion-to-utils/CHANGELOG.md

@@ -1,5 +1,11 @@
 # notion-to-utils
 
+## 0.4.7
+
+### Patch Changes
+
+- makePreviewImage 추가
+
 ## 0.4.6
 
 ### Patch Changes

packages/notion-to-utils/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notion-to-utils",
-  "version": "0.4.6",
+  "version": "0.4.7",
   "description": "",
   "repository": {
     "type": "git",
@@ -40,6 +40,8 @@
     "vitest": "^2.1.2"
   },
   "dependencies": {
-    "@notionhq/client": "^2.2.15"
+    "@notionhq/client": "^2.2.15",
+    "@types/lqip-modern": "^1.1.7",
+    "lqip-modern": "^2.1.0"
   }
 }

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

@@ -1,5 +1,5 @@
 import { Client } from '@notionhq/client';
-import { isPropertyFileType } from '../file/isPropertyFileType';
+import { isPropertyFileType } from './utils/isPropertyFileType';
 /**
  * Retrieves the URL of a file attached to a specific property of a Notion page.
  *

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

@@ -1,5 +1,5 @@
 import { Client } from '@notionhq/client';
-import { isPageObjectResponse } from '../page/isPageObjectResponse';
+import { isPageObjectResponse } from './utils/isPageObjectResponse';
 
 /**
  * Retrieves properties of a Notion page.

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

@@ -3,6 +3,11 @@ import {
   GetPageResponse,
 } from '@notionhq/client/build/src/api-endpoints';
 
+/**
+ * Type guard function to check if the response is a PageObjectResponse
+ * @param {GetPageResponse} obj - The response object from Notion API
+ * @returns {boolean} True if the object is a PageObjectResponse
+ */
 export const isPageObjectResponse = (
   obj: GetPageResponse
 ): obj is PageObjectResponse => {

packages/notion-to-utils/src/file/isPropertyFileType.ts renamed to packages/notion-to-utils/src/client/utils/isPropertyFileType.ts

@@ -5,6 +5,12 @@ import {
 
 type NonEmptyArray<T> = [T, ...T[]];
 
+/**
+ * Type guard function to check if a property of a Notion page is a files property and contains at least one file
+ * @param {GetPageResponse} obj - The response object from Notion API
+ * @param {keyof PageObjectResponse['properties']} propertyKey - The key of the property to check
+ * @returns {boolean} True if the property exists, is of type 'files', and contains at least one file
+ */
 export const isPropertyFileType = (
   obj: GetPageResponse,
   propertyKey: keyof PageObjectResponse['properties']

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

@@ -1,4 +1,5 @@
 export * from './client';
+export * from './utils';
 
 import type {
   PageObjectResponse,

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

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

packages/notion-to-utils/src/utils/makePreviewImage.spec.ts

@@ -0,0 +1,75 @@
+import {
+  describe,
+  it,
+  expect,
+  beforeEach,
+  vi,
+  beforeAll,
+  afterEach,
+} from 'vitest';
+import { makePreviewImage } from './makePreviewImage';
+import lqip from 'lqip-modern';
+
+beforeAll(() => {
+  // lqip-modern 모듈 모킹
+  vi.mock('lqip-modern');
+  // fetch 모킹
+  global.fetch = vi.fn();
+});
+
+afterEach(() => {
+  vi.clearAllMocks();
+});
+
+describe('makePreviewImage', () => {
+  it('이미지 URL이 주어졌을 때 PreviewImage 객체를 반환한다', async () => {
+    // 테스트 데이터 준비
+    const mockImageUrl = 'https://example.com/image.jpg';
+    const mockBuffer = Buffer.from('test');
+    const mockLqipResult = {
+      metadata: {
+        dataURIBase64: 'data:image/jpeg;base64,test',
+        originalHeight: 100,
+        originalWidth: 200,
+      },
+    };
+
+    // fetch 모의 구현
+    (global.fetch as unknown as ReturnType<typeof vi.fn>).mockResolvedValue({
+      arrayBuffer: () => Promise.resolve(mockBuffer),
+    });
+
+    // lqip 모의 구현
+    (lqip as unknown as ReturnType<typeof vi.fn>).mockResolvedValue(
+      mockLqipResult
+    );
+
+    // 함수 실행
+    const result = await makePreviewImage(mockImageUrl);
+
+    // 결과 검증
+    expect(result).toEqual({
+      dataURIBase64: mockLqipResult.metadata.dataURIBase64,
+      originalHeight: mockLqipResult.metadata.originalHeight,
+      originalWidth: mockLqipResult.metadata.originalWidth,
+    });
+
+    // fetch가 올바른 URL로 호출되었는지 확인
+    expect(fetch).toHaveBeenCalledWith(mockImageUrl);
+    // lqip가 올바른 버퍼로 호출되었는지 확인
+    expect(lqip).toHaveBeenCalledWith(mockBuffer);
+  });
+
+  it('에러가 발생했을 때 undefined를 반환한다', async () => {
+    const mockImageUrl = 'https://example.com/invalid-image.jpg';
+
+    // fetch 에러 시뮬레이션
+    (global.fetch as unknown as ReturnType<typeof vi.fn>).mockRejectedValue(
+      new Error('Failed to fetch')
+    );
+
+    const result = await makePreviewImage(mockImageUrl);
+
+    expect(result).toBeUndefined();
+  });
+});

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

@@ -0,0 +1,39 @@
+import lqip from 'lqip-modern';
+
+export interface PreviewImage {
+  originalWidth: number;
+  originalHeight: number;
+  dataURIBase64: string;
+}
+
+/**
+ * Generates a low-quality preview image from a given URL
+ *
+ * @param url - The URL of the image to generate a preview for
+ * @returns A Promise that resolves to a PreviewImage object containing the base64 data URI
+ *          and original dimensions, or undefined if the operation fails
+ *
+ * @example
+ * const preview = await makePreviewImage('https://example.com/image.jpg');
+ * if (preview) {
+ *   console.log(preview.dataURIBase64);
+ * }
+ */
+export const makePreviewImage = async (url: string) => {
+  try {
+    const response = await fetch(url);
+    const buffer = Buffer.from(await response.arrayBuffer());
+
+    const {
+      metadata: { dataURIBase64, originalHeight, originalWidth },
+    } = await lqip(buffer);
+    const result: PreviewImage = {
+      dataURIBase64,
+      originalHeight,
+      originalWidth,
+    };
+    return result;
+  } catch (error) {
+    return undefined;
+  }
+};