talizen 0.0.4

package/README.md

@@ -0,0 +1,80 @@
+# talizen
+
+Talizen 前端 SDK 类型仓库，统一提供：
+
+- `talizen/core`
+- `talizen/cms`
+- `talizen/form`
+
+这个仓库的目标是把 Talizen 平台前端会直接使用的类型和最小运行时请求封装整理成一个可以独立发布到 GitHub 和 npm 的包。
+
+## 安装
+
+```bash
+npm install talizen
+```
+
+## 使用
+
+```ts
+import { setTalizenConfig } from "talizen/core"
+import { ListContent, type BaseCmsItem } from "talizen/cms"
+
+interface Blogs extends BaseCmsItem {
+  readonly __cmsKey: "blogs"
+  body: {
+    title?: string
+    content?: string
+  }
+}
+
+setTalizenConfig({
+  baseUrl: "https://www.talizen.com",
+  projectId: "demo-project",
+})
+
+const blogs = await ListContent<Blogs>("blogs", {
+  limit: 10,
+})
+```
+
+表单提交：
+
+```ts
+import { SubmitForm } from "talizen/form"
+
+await SubmitForm(
+  {
+    token: "form-token",
+    data: {
+      email: "hi@talizen.com",
+    },
+  },
+  {
+    projectId: "demo-project",
+  },
+)
+```
+
+## 类型设计
+
+- `talizen/core`：通用基础类型，来自后端 `internal/model`。
+- `talizen/cms`：CMS schema、content、筛选参数、获取内容 API。
+- `talizen/form`：Form schema、提交参数、日志类型、提交 API。
+
+其中业务项目自己的 `types/cms.d.ts`、`types/form.d.ts` 依然建议由平台按项目 schema 动态生成；本仓库负责承载平台级公共类型和泛型 API。
+
+## 发布
+
+```bash
+npm install
+npm run build
+npm publish
+```
+
+GitHub Actions 工作流在 `.github/workflows/publish.yml`，按 tag 发布 npm 包：
+
+```bash
+git tag v0.1.0
+git push origin v0.1.0
+```

package/dist/cms/index.d.ts

@@ -0,0 +1,77 @@
+import { type ContentBodyField, type ContentSchema, type DBId, type TalizenRequestOptions } from "../core/index.js";
+export interface BaseCmsItem {
+    readonly __cmsKey: string;
+    slug: string;
+    id: DBId;
+    body: Record<string, unknown>;
+}
+export interface CmsListItem<T extends BaseCmsItem = BaseCmsItem> {
+    key: T["__cmsKey"];
+    name: string;
+    Item: T;
+}
+export interface CmsApp<TSchema extends ContentSchema = ContentSchema> {
+    id: DBId;
+    project_id: DBId;
+    key: string;
+    user_id: number;
+    name: string;
+    desc: string;
+    schema: TSchema;
+    created_at: string;
+    updated_at: string;
+    visibility?: "private" | "public" | (string & {});
+}
+export type ContentStatus = "online" | "offline" | (string & {});
+export interface CmsContent<TBody extends Record<string, unknown> = Record<string, unknown>> {
+    id: DBId;
+    slug: string;
+    content_app_id: DBId;
+    user_id: number;
+    schema: ContentSchema;
+    tags?: string[];
+    status?: ContentStatus;
+    body: {
+        [K in keyof TBody]?: ContentBodyField<TBody[K]>;
+    };
+    draft_body?: {
+        [K in keyof TBody]?: ContentBodyField<TBody[K]>;
+    };
+    created_at: string;
+    updated_at: string;
+}
+export interface GetContentListFilterCondition {
+    fieldId?: string;
+    operator?: string;
+    value?: unknown;
+}
+export interface GetContentListFilter {
+    match?: "any" | "all";
+    conditions?: GetContentListFilterCondition[];
+}
+export interface ListContentParams {
+    limit?: number;
+    offset?: number;
+    searchKey?: string;
+    orderBy?: string;
+    builtinRef?: boolean;
+    filter?: GetContentListFilter;
+}
+export interface GetContentParams {
+    builtinRef?: boolean;
+}
+export interface GetContentWithPrevNextParams extends GetContentParams {
+    prev?: boolean;
+    next?: boolean;
+    searchKey?: string;
+    orderBy?: string;
+    filter?: GetContentListFilter;
+}
+export interface ContentWithPrevNext<T extends BaseCmsItem> {
+    current?: T;
+    next?: T;
+    prev?: T;
+}
+export declare function ListContent<T extends BaseCmsItem>(key: T["__cmsKey"], params?: ListContentParams, options?: TalizenRequestOptions): Promise<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/dist/cms/index.js

@@ -0,0 +1,56 @@
+import { requestJson, resolveTalizenConfig } from "../core/index.js";
+export async function ListContent(key, params = {}, options) {
+    const projectId = requireProjectId(options);
+    const response = await requestJson(`/api/r/project/${projectId}/cms_by_key/${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.list ?? [];
+}
+export async function GetContent(key, slug, params, options) {
+    const projectId = requireProjectId(options);
+    const url = new URL(`/api/r/project/${projectId}/cms_by_key/${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 projectId = requireProjectId(options);
+    const url = new URL(`/api/r/project/${projectId}/cms_by_key/${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);
+}
+function requireProjectId(options) {
+    const projectId = resolveTalizenConfig(options).projectId;
+    if (projectId) {
+        return projectId;
+    }
+    throw new Error("Talizen projectId is required. Pass options.projectId or call setTalizenConfig({ projectId }).");
+}

package/dist/core/index.d.ts

@@ -0,0 +1,68 @@
+export type DBId = string;
+export type Variable = unknown;
+export type Datatype = "array" | "string" | "int" | "float" | "bool" | "date" | "datetime" | "time" | "file" | "image" | "video" | "audio" | "text" | "cms";
+export interface TV<T = unknown> {
+    type: Datatype | string;
+    value: T;
+}
+export interface ImgItem {
+    size?: number;
+    name?: string;
+    src: string;
+    alt?: string;
+    width?: number;
+}
+export type Image = ImgItem[] | ImgItem;
+export type Link = string;
+export type LinkType = "custom" | "system" | (string & {});
+export interface LinkProps {
+    value?: string;
+    link?: string;
+    type?: LinkType;
+    linkType?: LinkType;
+    section?: string;
+    slug?: Variable;
+}
+export interface ContentBodyField<T = unknown> {
+    value?: T;
+    value_raw?: unknown;
+    type: Datatype | string;
+    type_ref?: string;
+}
+export interface SchemaControl {
+    path: string;
+    type: Datatype | string;
+    controls?: SchemaControl[];
+}
+export type ContentFieldOptionM = Record<string, TV>;
+export interface ContentSchemaField {
+    key: string;
+    name: string;
+    desc?: string;
+    name_locales?: Record<string, string>;
+    datatype?: Datatype | string;
+    help_locales?: Record<string, string>;
+    enable_search?: boolean;
+    extension?: unknown;
+    options?: ContentFieldOptionM[];
+    controls?: SchemaControl[];
+    cms_id?: string;
+    cms_label_field?: string;
+}
+export interface ContentSchema {
+    fields?: ContentSchemaField[];
+}
+export interface TalizenClientConfig {
+    baseUrl?: string;
+    projectId?: string;
+    headers?: HeadersInit;
+    fetch?: typeof fetch;
+}
+export interface TalizenRequestOptions extends TalizenClientConfig {
+    signal?: AbortSignal;
+}
+export declare function setTalizenConfig(config: TalizenClientConfig): void;
+export declare function getTalizenConfig(): TalizenClientConfig;
+export declare function resolveTalizenConfig(config?: TalizenRequestOptions): Required<Pick<TalizenClientConfig, "baseUrl" | "projectId" | "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

@@ -0,0 +1,72 @@
+let globalTalizenConfig = {};
+export function setTalizenConfig(config) {
+    globalTalizenConfig = {
+        ...globalTalizenConfig,
+        ...config,
+    };
+}
+export function getTalizenConfig() {
+    return {
+        ...globalTalizenConfig,
+    };
+}
+export function resolveTalizenConfig(config) {
+    const merged = {
+        ...globalTalizenConfig,
+        ...config,
+    };
+    const baseUrl = merged.baseUrl ?? getDefaultBaseUrl();
+    const projectId = merged.projectId ?? "";
+    const fetchImpl = merged.fetch ?? getDefaultFetch();
+    return {
+        ...merged,
+        baseUrl,
+        projectId,
+        fetch: fetchImpl,
+    };
+}
+export function buildTalizenUrl(path, config) {
+    const resolved = resolveTalizenConfig(config);
+    return new URL(path.replace(/^\//, ""), ensureBaseUrl(resolved.baseUrl)).toString();
+}
+export async function requestJson(path, init, config) {
+    const resolved = resolveTalizenConfig(config);
+    const headers = new Headers(resolved.headers ?? {});
+    if (init?.headers) {
+        new Headers(init.headers).forEach((value, key) => {
+            headers.set(key, value);
+        });
+    }
+    if (init?.body != null && !headers.has("content-type")) {
+        headers.set("content-type", "application/json");
+    }
+    const response = await resolved.fetch(buildTalizenUrl(path, resolved), {
+        ...init,
+        headers,
+        signal: resolved.signal,
+    });
+    if (!response.ok) {
+        const text = await response.text();
+        throw new Error(`Talizen request failed: ${response.status} ${response.statusText} ${text}`.trim());
+    }
+    const text = await response.text();
+    if (text === "") {
+        return undefined;
+    }
+    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;
+    }
+    throw new Error("Talizen baseUrl is required. Call setTalizenConfig({ baseUrl }) first.");
+}
+function getDefaultFetch() {
+    if (typeof fetch === "function") {
+        return fetch;
+    }
+    throw new Error("Talizen fetch implementation is required in the current runtime.");
+}

package/dist/form/index.d.ts

@@ -0,0 +1,39 @@
+import { type ContentBodyField, type ContentSchema, type DBId, type TalizenRequestOptions } from "../core/index.js";
+export interface FormSetting {
+}
+export interface FormApp<TSchema extends ContentSchema = ContentSchema> {
+    id: DBId;
+    project_id: DBId;
+    key: string;
+    user_id: number;
+    name: string;
+    desc: string;
+    schema: TSchema;
+    setting: FormSetting;
+    created_at: string;
+    updated_at: string;
+}
+export type FormLogBody<TBody extends Record<string, unknown>> = {
+    [K in keyof TBody]?: ContentBodyField<TBody[K]>;
+};
+export interface FormLog<TBody extends Record<string, unknown> = Record<string, unknown>> {
+    id: DBId;
+    form_id: DBId;
+    uid: string;
+    ua: string;
+    ip: string;
+    form_url: string;
+    body: FormLogBody<TBody>;
+    created_at: string;
+    updated_at: string;
+}
+export interface SubmitFormParams<TBody extends Record<string, unknown> = Record<string, unknown>> {
+    token: string;
+    data: TBody;
+    ip?: string;
+    uid?: string;
+    ua?: string;
+    fromUrl?: string;
+}
+export declare function GetForm(formId: DBId, options?: TalizenRequestOptions): Promise<FormApp>;
+export declare function SubmitForm<TBody extends Record<string, unknown> = Record<string, unknown>>(params: SubmitFormParams<TBody>, options?: TalizenRequestOptions): Promise<"ok">;

package/dist/form/index.js

@@ -0,0 +1,26 @@
+import { requestJson, resolveTalizenConfig } from "../core/index.js";
+export async function GetForm(formId, options) {
+    const projectId = requireProjectId(options);
+    return requestJson(`/api/r/project/${projectId}/form/${formId}`, undefined, options);
+}
+export async function SubmitForm(params, options) {
+    const projectId = requireProjectId(options);
+    return requestJson(`/api/r/project/${projectId}/form`, {
+        method: "POST",
+        body: JSON.stringify({
+            token: params.token,
+            data: params.data,
+            ip: params.ip,
+            uid: params.uid,
+            ua: params.ua,
+            from_url: params.fromUrl,
+        }),
+    }, options);
+}
+function requireProjectId(options) {
+    const projectId = resolveTalizenConfig(options).projectId;
+    if (projectId) {
+        return projectId;
+    }
+    throw new Error("Talizen projectId is required. Pass options.projectId or call setTalizenConfig({ projectId }).");
+}

package/dist/index.d.ts

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

package/dist/index.js

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

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "talizen",
+  "version": "0.0.4",
+  "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",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./core": {
+      "types": "./dist/core/index.d.ts",
+      "import": "./dist/core/index.js"
+    },
+    "./cms": {
+      "types": "./dist/cms/index.d.ts",
+      "import": "./dist/cms/index.js"
+    },
+    "./form": {
+      "types": "./dist/form/index.d.ts",
+      "import": "./dist/form/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "check": "tsc -p tsconfig.json --noEmit"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.2"
+  }
+}