본문으로 건너뛰기

설치

@knowledgepulse/sdk 패키지는 KnowledgePulse 프로토콜을 위한 TypeScript/JavaScript 타입, 유효성 검사 스키마, 지식 캡처, 검색, 평가, SKILL.md 유틸리티를 제공합니다.

  • 버전: 0.1.0
  • 라이선스: Apache-2.0

설치​

bun add @knowledgepulse/sdk

모듈 형식​

SDK는 완전한 TypeScript 선언과 함께 듀얼 형식 패키지로 제공됩니다. ESM과 CommonJS 모두 기본 지원됩니다.

ESM (권장)​

import {
  KPCapture,
  KPRetrieval,
  evaluateValue,
  parseSkillMd,
  KnowledgeUnitSchema,
} from "@knowledgepulse/sdk";

CommonJS​

const {
  KPCapture,
  KPRetrieval,
  evaluateValue,
  parseSkillMd,
  KnowledgeUnitSchema,
} = require("@knowledgepulse/sdk");

내보내기 맵​

패키지는 조건부 내보내기가 있는 단일 진입점(.)을 노출합니다:

{
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "require": "./dist/index.cjs"
    }
  }
}
경로형식파일
typesTypeScript 선언dist/index.d.ts
importESMdist/index.js
requireCommonJSdist/index.cjs

의존성​

패키지버전용도
zod^3.23.0모든 지식 유닛 타입에 대한 런타임 유효성 검사 스키마
yaml^2.4.0SKILL.md YAML 프론트매터 파싱 및 생성

선택적 의존성​

패키지버전크기용도
@huggingface/transformers^3.0.0~80 MB참신성 평가를 위한 임베딩 모델 (Xenova/all-MiniLM-L6-v2)

@huggingface/transformers 패키지는 선택적 의존성으로 나열됩니다. evaluateValue() 평가 함수의 참신성 차원에서만 사용됩니다. 설치되지 않으면 참신성 점수는 기본값 0.5로 대체됩니다.

명시적으로 설치하려면:

bun add @huggingface/transformers

TypeScript​

전체 타입 선언이 패키지의 dist/index.d.ts에 포함되어 있습니다. 추가 @types/* 패키지가 필요하지 않습니다.

SDK는 TypeScript 5.0 이상을 요구하며 ES2020을 대상으로 합니다. tsconfig.json에서 moduleResolution: "bundler" 또는 "node16"을 사용하면 내보내기 맵이 자동으로 해결됩니다.

// tsconfig.json (권장 설정)
{
  "compilerOptions": {
    "module": "ESNext",
    "moduleResolution": "bundler",
    "target": "ES2020",
    "strict": true
  }
}

설치 확인​

패키지가 올바르게 설치되었는지 빠르게 확인합니다:

import { KnowledgeUnitSchema, generateTraceId } from "@knowledgepulse/sdk";

console.log(generateTraceId());
// kp:trace:550e8400-e29b-41d4-a716-446655440000

console.log(typeof KnowledgeUnitSchema.parse);
// "function"

다음 단계​

  • 타입 -- 모든 지식 유닛 타입과 Zod 스키마 탐색
  • SKILL.md -- SKILL.md 파일 파싱, 생성, 유효성 검사
  • 평가 -- 가치 평가 알고리즘 이해
  • 유틸리티 -- ID 생성기, 해싱, 정제, 캡처, 검색