talizen 0.0.6 → 0.0.8

package/README.md

@@ -1,26 +1,37 @@
 # talizen
 
-Talizen 前端 SDK 类型仓库，统一提供：
+Talizen's frontend SDK package. It provides a small runtime client and shared types for:
 
 - `talizen/core`
 - `talizen/cms`
 - `talizen/form`
 
-这个仓库的目标是把 Talizen 平台前端会直接使用的类型和最小运行时请求封装整理成一个可以独立发布到 GitHub 和 npm 的包。
+The package is designed to hold the platform-level APIs that frontend projects use directly, while project-specific CMS and form schema types can still be generated separately per project.
 
-## 安装
+## Install
 
 ```bash
 npm install talizen
 ```
 
-## 使用
+## Usage
+
+### Configure the client
 
 ```ts
 import { setTalizenConfig } from "talizen/core"
-import { ListContent, type BaseCmsItem } from "talizen/cms"
 
-interface Blogs extends BaseCmsItem {
+setTalizenConfig({
+  baseUrl: "https://www.talizen.com",
+})
+```
+
+### List CMS content
+
+```ts
+import { listContents, type BaseCmsItem } from "talizen/cms"
+
+interface Blog extends BaseCmsItem {
   readonly __cmsKey: "blogs"
   body: {
     title?: string
@@ -28,53 +39,61 @@ interface Blogs extends BaseCmsItem {
   }
 }
 
-setTalizenConfig({
-  baseUrl: "https://www.talizen.com",
-  projectId: "demo-project",
-})
-
-const blogs = await ListContent<Blogs>("blogs", {
+const result = await listContents<Blog>("blogs", {
   limit: 10,
+  orderBy: "-created_at",
 })
+
+console.log(result.list)
+console.log(result.total)
 ```
 
-表单提交：
+### Get a single CMS content item
 
 ```ts
-import { SubmitForm } from "talizen/form"
-
-await SubmitForm(
-  {
-    token: "form-token",
-    data: {
-      email: "hi@talizen.com",
-    },
-  },
-  {
-    projectId: "demo-project",
-  },
-)
+import { getContent, type BaseCmsItem } from "talizen/cms"
+
+interface Blog extends BaseCmsItem {
+  readonly __cmsKey: "blogs"
+  body: {
+    title?: string
+  }
+}
+
+const blog = await getContent<Blog>("blogs", "hello-world")
+```
+
+### Submit a form
+
+```ts
+import { submitForm } from "talizen/form"
+
+await submitForm("contact-form", {
+  email: "hi@talizen.com",
+  message: "Hello from the website",
+})
 ```
 
-## 类型设计
+## Package Layout
 
-- `talizen/core`：通用基础类型，来自后端 `internal/model`。
-- `talizen/cms`：CMS schema、content、筛选参数、获取内容 API。
-- `talizen/form`：Form schema、提交参数、日志类型、提交 API。
+- `talizen/core`: shared runtime config, request helpers, and base data types.
+- `talizen/cms`: CMS content types and content query APIs.
+- `talizen/form`: form submission helpers and related types.
 
-其中业务项目自己的 `types/cms.d.ts`、`types/form.d.ts` 依然建议由平台按项目 schema 动态生成；本仓库负责承载平台级公共类型和泛型 API。
+## Publish
 
-## 发布
+Build and prepare the package contents:
 
 ```bash
 npm install
 npm run build
-npm publish
+node scripts/prepare-publish.mjs
 ```
 
-GitHub Actions 工作流在 `.github/workflows/publish.yml`，按 tag 发布 npm 包：
+The GitHub Actions workflow in `.github/workflows/publish.yml` publishes on a tag push. Release a new version with:
 
 ```bash
-git tag v0.1.0
-git push origin v0.1.0
+git tag v0.0.8
+git push origin main
+git push origin v0.0.8
 ```

package/{dist/cms/index.d.ts → cms.d.ts}

@@ -1,15 +1,10 @@
-import { type TalizenRequestOptions } from "../core/index.js";
+import { type TalizenRequestOptions } from "./core.js";
 export interface BaseCmsItem {
     readonly __cmsKey: string;
     slug: string;
     id: string;
     body: Record<string, unknown>;
 }
-export interface CmsListItem<T extends BaseCmsItem = BaseCmsItem> {
-    key: T["__cmsKey"];
-    name: string;
-    Item: T;
-}
 export interface GetContentListFilterCondition {
     fieldId?: string;
     operator?: string;
@@ -42,10 +37,10 @@ export interface ContentWithPrevNext<T extends BaseCmsItem> {
     next?: T;
     prev?: T;
 }
-export interface ListResponse<T extends BaseCmsItem> {
+export interface ListResponse<T> {
     list?: T[];
     total?: number;
 }
-export declare function ListContent<T extends BaseCmsItem>(key: T["__cmsKey"], params?: ListContentParams, options?: TalizenRequestOptions): Promise<ListResponse<T>>;
-export declare function GetContent<T extends BaseCmsItem>(key: T["__cmsKey"], slug: string, params?: GetContentParams, options?: TalizenRequestOptions): Promise<T>;
-export declare function GetContentWithPrevNext<T extends BaseCmsItem>(key: T["__cmsKey"], slug: string, params?: GetContentWithPrevNextParams, options?: TalizenRequestOptions): Promise<ContentWithPrevNext<T>>;
+export declare function listContents<T extends BaseCmsItem>(key: T["__cmsKey"], params?: ListContentParams, options?: TalizenRequestOptions): Promise<ListResponse<T>>;
+export declare function getContent<T extends BaseCmsItem>(key: T["__cmsKey"], slug: string, params?: GetContentParams, options?: TalizenRequestOptions): Promise<T>;
+export declare function getContentWithPrevNext<T extends BaseCmsItem>(key: T["__cmsKey"], slug: string, params?: GetContentWithPrevNextParams, options?: TalizenRequestOptions): Promise<ContentWithPrevNext<T>>;

package/cms.js

@@ -0,0 +1,37 @@
+import { requestJson } from "./core.js";
+export async function listContents(key, params = {}, options) {
+    const response = await requestJson(`/cms/${key}/content_list`, {
+        method: "POST",
+        body: JSON.stringify({
+            limit: params.limit,
+            offset: params.offset,
+            search_key: params.searchKey,
+            order_by: params.orderBy,
+            builtin_ref: params.builtinRef,
+            filter: params.filter,
+        }),
+    }, options);
+    return response;
+}
+export async function getContent(key, slug, params, options) {
+    const url = new URL(`/cms/${key}/content`, "https://talizen.local");
+    url.searchParams.set("slug", slug);
+    if (params?.builtinRef != null) {
+        url.searchParams.set("builtin_ref", String(params.builtinRef));
+    }
+    return requestJson(url.pathname + url.search, undefined, options);
+}
+export async function getContentWithPrevNext(key, slug, params = {}, options) {
+    return requestJson(`/cms/${key}/content_with_prev_next`, {
+        method: "POST",
+        body: JSON.stringify({
+            slug,
+            prev: params.prev,
+            next: params.next,
+            search_key: params.searchKey,
+            order_by: params.orderBy,
+            builtin_ref: params.builtinRef,
+            filter: params.filter,
+        }),
+    }, options);
+}

package/{dist/core/index.d.ts → core.d.ts}

@@ -22,5 +22,4 @@ export interface TalizenRequestOptions extends TalizenClientConfig {
 export declare function setTalizenConfig(config: TalizenClientConfig): void;
 export declare function getTalizenConfig(): TalizenClientConfig;
 export declare function resolveTalizenConfig(config?: TalizenRequestOptions): Required<Pick<TalizenClientConfig, "baseUrl" | "fetch">> & TalizenRequestOptions;
-export declare function buildTalizenUrl(path: string, config?: TalizenRequestOptions): string;
 export declare function requestJson<T>(path: string, init?: RequestInit, config?: TalizenRequestOptions): Promise<T>;

package/{dist/core/index.js → core.js}

@@ -23,9 +23,14 @@ export function resolveTalizenConfig(config) {
         fetch: fetchImpl,
     };
 }
-export function buildTalizenUrl(path, config) {
+function joinUrl(baseUrl, path) {
+    const base = baseUrl.endsWith("/") ? baseUrl.slice(0, -1) : baseUrl;
+    const subPath = path.startsWith("/") ? path.slice(1) : path;
+    return `${base}/${subPath}`;
+}
+function buildTalizenUrl(path, config) {
     const resolved = resolveTalizenConfig(config);
-    return new URL(path.replace(/^\//, ""), ensureBaseUrl(resolved.baseUrl)).toString();
+    return joinUrl(resolved.baseUrl, path);
 }
 export async function requestJson(path, init, config) {
     const resolved = resolveTalizenConfig(config);
@@ -53,9 +58,6 @@ export async function requestJson(path, init, config) {
     }
     return JSON.parse(text);
 }
-function ensureBaseUrl(baseUrl) {
-    return baseUrl.endsWith("/") ? baseUrl : `${baseUrl}/`;
-}
 function getDefaultBaseUrl() {
     if (typeof window !== "undefined" && window.location?.origin) {
         return window.location.origin;

package/form.d.ts

@@ -0,0 +1,6 @@
+import { type TalizenRequestOptions } from "./core.js";
+export interface FormRecord {
+    readonly __formKey?: string;
+    [key: string]: unknown;
+}
+export declare function submitForm<T extends FormRecord>(keyOrToken: T["__formKey"] | string, payload: T, options?: TalizenRequestOptions): Promise<"ok">;

package/form.js

@@ -0,0 +1,7 @@
+import { requestJson } from "./core.js";
+export async function submitForm(keyOrToken, payload, options) {
+    return requestJson(`/form/${keyOrToken}/submit`, {
+        method: "POST",
+        body: JSON.stringify(payload),
+    }, options);
+}

package/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./core.js";
+export * from "./cms.js";
+export * from "./form.js";

package/index.js

@@ -0,0 +1,3 @@
+export * from "./core.js";
+export * from "./cms.js";
+export * from "./form.js";

package/package.json

@@ -1,38 +1,28 @@
 {
   "name": "talizen",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "Talizen frontend SDK types for cms, form and core.",
   "type": "module",
   "license": "MIT",
-  "files": [
-    "dist",
-    "README.md"
-  ],
   "sideEffects": false,
-  "types": "./dist/index.d.ts",
+  "main": "./index.js",
+  "types": "./index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "types": "./index.d.ts",
+      "import": "./index.js"
     },
     "./core": {
-      "types": "./dist/core/index.d.ts",
-      "import": "./dist/core/index.js"
+      "types": "./core.d.ts",
+      "import": "./core.js"
     },
     "./cms": {
-      "types": "./dist/cms/index.d.ts",
-      "import": "./dist/cms/index.js"
+      "types": "./cms.d.ts",
+      "import": "./cms.js"
     },
     "./form": {
-      "types": "./dist/form/index.d.ts",
-      "import": "./dist/form/index.js"
+      "types": "./form.d.ts",
+      "import": "./form.js"
     }
-  },
-  "scripts": {
-    "build": "tsc -p tsconfig.json",
-    "check": "tsc -p tsconfig.json --noEmit"
-  },
-  "devDependencies": {
-    "typescript": "^5.9.2"
   }
-}
+}

package/dist/cms/index.js

@@ -1,46 +0,0 @@
-import { requestJson, resolveTalizenConfig } from "../core/index.js";
-export async function ListContent(key, params = {}, options) {
-    const response = await requestJson(`/cms/${key}/content_list`, {
-        method: "POST",
-        body: JSON.stringify({
-            limit: params.limit,
-            offset: params.offset,
-            search_key: params.searchKey,
-            order_by: params.orderBy,
-            builtin_ref: params.builtinRef,
-            filter: params.filter,
-        }),
-    }, options);
-    return response;
-}
-export async function GetContent(key, slug, params, options) {
-    const url = new URL(`/cms/${key}/content`, "https://talizen.local");
-    url.searchParams.set("slug", slug);
-    if (params?.builtinRef != null) {
-        url.searchParams.set("builtin_ref", String(params.builtinRef));
-    }
-    return requestJson(url.pathname + url.search, undefined, options);
-}
-export async function GetContentWithPrevNext(key, slug, params = {}, options) {
-    const url = new URL(`/cms/${key}/content_with_prev_next`, "https://talizen.local");
-    url.searchParams.set("slug", slug);
-    if (params.prev != null) {
-        url.searchParams.set("prev", String(params.prev));
-    }
-    if (params.next != null) {
-        url.searchParams.set("next", String(params.next));
-    }
-    if (params.searchKey) {
-        url.searchParams.set("search_key", params.searchKey);
-    }
-    if (params.orderBy) {
-        url.searchParams.set("order_by", params.orderBy);
-    }
-    if (params.builtinRef != null) {
-        url.searchParams.set("builtin_ref", String(params.builtinRef));
-    }
-    if (params.filter) {
-        url.searchParams.set("filter", JSON.stringify(params.filter));
-    }
-    return requestJson(url.pathname + url.search, undefined, options);
-}

package/dist/form/index.d.ts

@@ -1,6 +0,0 @@
-import { type TalizenRequestOptions } from "../core/index.js";
-export interface SubmitFormParams<TBody extends Record<string, unknown>> {
-    token: string;
-    data: TBody;
-}
-export declare function SubmitForm<TBody extends Record<string, unknown> = Record<string, unknown>>(params: SubmitFormParams<TBody>, options?: TalizenRequestOptions): Promise<"ok">;

package/dist/form/index.js

@@ -1,10 +0,0 @@
-import { requestJson, resolveTalizenConfig } from "../core/index.js";
-export async function SubmitForm(params, options) {
-    return requestJson(`/form/submit`, {
-        method: "POST",
-        body: JSON.stringify({
-            token: params.token,
-            data: params.data,
-        }),
-    }, options);
-}

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./core/index.js";
-export * from "./cms/index.js";
-export * from "./form/index.js";

package/dist/index.js

@@ -1,3 +0,0 @@
-export * from "./core/index.js";
-export * from "./cms/index.js";
-export * from "./form/index.js";