talizen 0.2.4 → 0.2.5

package/README.md

@@ -137,13 +137,34 @@ const result = await invoke<{ success: boolean }>("user/auth.login", {
 await invoke("user/auth", { email: "hi@talizen.com" });
 ```
 
+### Write function runtime code
+
+Func code can use TypeScript and import runtime-only helpers from `talizen/func`:
+
+```ts
+import { auth, db, cache } from "talizen/func";
+
+export function create(input: { title: string }) {
+  const user = auth.requireUser();
+  const row = db.insert("book", {
+    title: input.title,
+    user_id: user.id,
+    status: "draft",
+  });
+  cache.set(`book:${row.id}`, row, 60);
+  return { ok: true, id: row.id };
+}
+```
+
+`db`, `cache`, and Func `auth` are injected by the Talizen Func runtime. They are typed in this package for authoring, but they are not browser/Node general-purpose APIs.
+
 ## Package Layout
 
 - `talizen/core`: shared runtime config, request helpers, and base data types.
 - `talizen/auth`: project user register, login, logout, and current user helpers.
 - `talizen/cms`: CMS content types and content query APIs.
 - `talizen/form`: form submission helpers and related types.
-- `talizen/func`: custom function invocation helpers.
+- `talizen/func`: custom function invocation helpers and Func-runtime-only `db`, `cache`, `auth` types.
 
 ## Publish
 

package/func.d.ts

@@ -1,4 +1,5 @@
 import { type TalizenRequestOptions } from "./core.js";
+import type { AuthUser } from "./auth.js";
 export interface FuncLogEntry {
     level: string;
     text: string;
@@ -9,6 +10,70 @@ export interface FuncRunResponse<T = unknown> {
     logs?: FuncLogEntry[];
     error?: string;
 }
+export type DbOrderBy = string;
+export interface DbFilterCondition {
+    field_id?: string;
+    fieldId?: string;
+    operator: "equal" | "not_equal" | "in";
+    value?: unknown;
+    values?: unknown[];
+}
+export interface DbFilter {
+    match?: "and" | "or";
+    conditions?: DbFilterCondition[];
+}
+export interface DbQuery {
+    where?: Record<string, unknown>;
+    filter?: DbFilter;
+    limit?: number;
+    offset?: number;
+    order_by?: DbOrderBy;
+    orderBy?: DbOrderBy;
+}
+export type DbRecord<T extends Record<string, unknown> = Record<string, unknown>> = T & {
+    id: string;
+};
+export interface FuncDbRuntime {
+    get<T extends Record<string, unknown> = Record<string, unknown>>(table: string, id: string): DbRecord<T> | null;
+    query<T extends Record<string, unknown> = Record<string, unknown>>(table: string, query?: DbQuery): Array<DbRecord<T>>;
+    insert<T extends Record<string, unknown> = Record<string, unknown>>(table: string, data: T): DbRecord<T>;
+    update<T extends Record<string, unknown> = Record<string, unknown>>(table: string, id: string, data: Partial<T>): {
+        ok?: boolean;
+        updated?: boolean;
+    } | DbRecord<T>;
+    delete(table: string, id: string): {
+        ok?: boolean;
+        deleted?: boolean;
+    };
+}
+export interface FuncAuthRuntime {
+    currentUser(): AuthUser | null;
+    requireUser(): AuthUser;
+}
+export interface CacheSetOptions {
+    ttl?: number;
+    ttlSeconds?: number;
+}
+export interface FuncCacheRuntime {
+    get<T = unknown>(key: string): T | null;
+    set(key: string, value: unknown, ttlSeconds?: number): {
+        ok?: boolean;
+    };
+    set(key: string, value: unknown, options?: CacheSetOptions): {
+        ok?: boolean;
+    };
+    del(key: string): {
+        ok?: boolean;
+        deleted?: boolean;
+    };
+    incr(key: string, delta?: number): number;
+    expire(key: string, ttlSeconds: number): {
+        ok?: boolean;
+    };
+}
+export declare const db: FuncDbRuntime;
+export declare const auth: FuncAuthRuntime;
+export declare const cache: FuncCacheRuntime;
 export declare class TalizenFuncError extends Error {
     readonly key: string;
     readonly method: string;

package/func.js

@@ -1,4 +1,25 @@
 import { requestJson, } from "./core.js";
+function funcRuntimeUnavailable() {
+    throw new Error("talizen/func db/cache/auth are only available inside Talizen Func runtime.");
+}
+export const db = {
+    get: funcRuntimeUnavailable,
+    query: funcRuntimeUnavailable,
+    insert: funcRuntimeUnavailable,
+    update: funcRuntimeUnavailable,
+    delete: funcRuntimeUnavailable,
+};
+export const auth = {
+    currentUser: funcRuntimeUnavailable,
+    requireUser: funcRuntimeUnavailable,
+};
+export const cache = {
+    get: funcRuntimeUnavailable,
+    set: funcRuntimeUnavailable,
+    del: funcRuntimeUnavailable,
+    incr: funcRuntimeUnavailable,
+    expire: funcRuntimeUnavailable,
+};
 export class TalizenFuncError extends Error {
     key;
     method;

package/index.d.ts

@@ -3,7 +3,6 @@ export * from "./auth.js";
 export * from "./cms.js";
 export * from "./captcha-ui.js";
 export * from "./form.js";
-export * from "./func.js";
 export * from "./i18n.js";
 type OneOrMany<T> = T | Array<T>;
 export interface MetadataTitle {

package/index.js

@@ -3,5 +3,4 @@ export * from "./auth.js";
 export * from "./cms.js";
 export * from "./captcha-ui.js";
 export * from "./form.js";
-export * from "./func.js";
 export * from "./i18n.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "talizen",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "Talizen frontend SDK types for cms, form and core.",
   "type": "module",
   "license": "MIT",