@ram_28/kf-ai-sdk 1.0.20 → 1.0.22

package/sdk/types/base-fields.ts

@@ -67,27 +67,47 @@ export type LongFieldType = number;
  */
 export type BooleanFieldType = boolean;
 
+/**
+ * Encoded date format from API response
+ * API returns: { "$__d__": "YYYY-MM-DD" }
+ */
+export interface DateEncodedType {
+  $__d__: string;
+}
+
+/**
+ * Encoded datetime format from API response
+ * API returns: { "$__dt__": unix_timestamp_seconds }
+ */
+export interface DateTimeEncodedType {
+  $__dt__: number;
+}
+
 /**
  * Date field (date only, no time)
- * Resolves to: Date
+ * API Response Format: { "$__d__": "YYYY-MM-DD" }
+ * API Request Format: "YYYY-MM-DD"
  * Storage: DATE in database
  * Use this for birth dates, due dates, calendar events
  *
  * @example
- * DateFieldType // => Date (date only)
+ * // Response from API:
+ * { "$__d__": "2025-03-15" }
  */
-export type DateFieldType = Date;
+export type DateFieldType = DateEncodedType;
 
 /**
  * DateTime field (date and time)
- * Resolves to: Date
+ * API Response Format: { "$__dt__": unix_timestamp_seconds }
+ * API Request Format: "YYYY-MM-DD HH:MM:SS"
  * Storage: DATETIME/TIMESTAMP in database
  * Use this for created_at, updated_at, event timestamps
  *
  * @example
- * DateTimeFieldType // => Date (with time)
+ * // Response from API:
+ * { "$__dt__": 1769110463 }
  */
-export type DateTimeFieldType = Date;
+export type DateTimeFieldType = DateTimeEncodedType;
 
 // ============================================================
 // COMPLEX FIELD TYPES
@@ -124,7 +144,47 @@ export type CurrencyValueType =
  */
 export type JSONFieldType<T = JSONValueType> = T;
 
-export type ReferenceFieldType = string;
+/**
+ * Reference/Lookup field for relationships to other Business Data Objects
+ *
+ * @template TReferencedType - The full type of the referenced BDO record
+ *
+ * Runtime behavior:
+ * - The field stores the full referenced record (e.g., full supplier object)
+ * - API returns the complete record from the referenced BDO
+ * - On save, the full object is sent in the payload
+ *
+ * @example
+ * SupplierInfo: ReferenceFieldType<BaseSupplierType>;
+ * // At runtime: { _id: "...", SupplierId: "...", SupplierName: "...", ... }
+ */
+export type ReferenceFieldType<TReferencedType = unknown> = TReferencedType;
+
+/**
+ * Extract the referenced type from a ReferenceFieldType
+ * Note: Since ReferenceFieldType<T> = T, this just returns T if it has _id
+ */
+export type ExtractReferenceType<T> = T extends { _id: string } ? T : never;
+
+/**
+ * Extract the type that fetchField should return for a given field type
+ * - For Reference fields (objects with _id) → the full referenced record type
+ * - For other field types → { Value: string; Label: string } (static dropdown)
+ *
+ * Detection: All BDO types have _id: string, so we check for that property
+ * to distinguish reference fields from primitive fields like StringFieldType.
+ *
+ * @example
+ * type SupplierOptions = ExtractFetchFieldType<BaseProductType["SupplierInfo"]>;
+ * // Result: BaseSupplierType (has _id)
+ *
+ * type CategoryOptions = ExtractFetchFieldType<BaseProductType["Category"]>;
+ * // Result: { Value: string; Label: string } (string has no _id)
+ */
+export type ExtractFetchFieldType<T> =
+  T extends { _id: string }
+    ? T
+    : { Value: string; Label: string };
 
 /**
  * Valid JSON value types
@@ -156,17 +216,11 @@ export interface JSONArrayType extends Array<JSONValueType> {}
 export type SelectFieldType<T extends string> = T;
 
 /**
- * Lookup field for references to other records
- * @template T - Type of the referenced record ID (defaults to string)
- * Resolves to: T
- * Storage: VARCHAR in database (stores the ID)
- * Use this for foreign keys, relationships, references
- *
- * @example
- * LookupFieldType // => string (referenced record ID)
- * LookupFieldType<IdFieldType> // => string (typed as IdFieldType)
+ * Alias for ReferenceFieldType (Lookup = Reference in the backend)
+ * @template TReferencedType - The full type of the referenced BDO record
+ * @deprecated Use ReferenceFieldType instead
  */
-export type LookupFieldType<T extends string = string> = T;
+export type LookupFieldType<TReferencedType = unknown> = ReferenceFieldType<TReferencedType>;
 
 // ============================================================
 // CONTAINER AND UTILITY TYPES

package/sdk/types/common.ts

@@ -71,19 +71,8 @@ export interface ConditionGroupType<T = any> {
  */
 export type FilterType<T = any> = ConditionGroupType<T>;
 
-/**
- * DateTime encoding format used by the API
- */
-export interface DateTimeEncodedType {
-  $__dt__: number;
-}
-
-/**
- * Date encoding format used by the API
- */
-export interface DateEncodedType {
-  $__d__: string;
-}
+// Note: DateTimeEncodedType and DateEncodedType are now defined in base-fields.ts
+// They are re-exported from api/index.ts for convenience
 
 /**
  * Standard paginated list response

package/dist/client-DgtkT50N.cjs

@@ -1 +0,0 @@
-"use strict";let o={baseUrl:"",headers:{"Content-Type":"application/json"}};function u(e){o.baseUrl=e}function h(e){o.headers={...o.headers,...e}}function d(){return{...o.headers}}function l(){return o.baseUrl||""}function i(e){if(e==null)return e;if(Array.isArray(e))return e.map(s=>i(s));if(typeof e=="object"){if("$__dt__"in e)return new Date(e.$__dt__*1e3);if("$__d__"in e)return new Date(e.$__d__);const s={};for(const[n,t]of Object.entries(e))s[n]=i(t);return s}return e}function w(e){const s=o.baseUrl,n=o.headers;return{async get(t){const r=await fetch(`${s}/api/app/${e}/${t}/read`,{method:"GET",headers:n});if(!r.ok)throw new Error(`Failed to get ${e} ${t}: ${r.statusText}`);const a=await r.json();return i(a.Data)},async create(t){const r=await fetch(`${s}/api/app/${e}/create`,{method:"POST",headers:n,body:JSON.stringify(t)});if(!r.ok)throw new Error(`Failed to create ${e}: ${r.statusText}`);return r.json()},async update(t,r){const a=await fetch(`${s}/api/app/${e}/${t}/update`,{method:"POST",headers:n,body:JSON.stringify(r)});if(!a.ok)throw new Error(`Failed to update ${e} ${t}: ${a.statusText}`);return a.json()},async delete(t){const r=await fetch(`${s}/api/app/${e}/${t}/delete`,{method:"DELETE",headers:n});if(!r.ok)throw new Error(`Failed to delete ${e} ${t}: ${r.statusText}`);return r.json()},async list(t){const r={Type:"List",...t},a=await fetch(`${s}/api/app/${e}/list`,{method:"POST",headers:n,body:JSON.stringify(r)});if(!a.ok)throw new Error(`Failed to list ${e}: ${a.statusText}`);return{Data:(await a.json()).Data.map(f=>i(f))}},async count(t){var p,$;const r={Type:"Metric",GroupBy:[],Metric:[{Field:"_id",Type:"Count"}],...(t==null?void 0:t.Filter)&&{Filter:t.Filter}},a=await fetch(`${s}/api/app/${e}/metric`,{method:"POST",headers:n,body:JSON.stringify(r)});if(!a.ok)throw new Error(`Failed to count ${e}: ${a.statusText}`);return{Count:(($=(p=(await a.json()).Data)==null?void 0:p[0])==null?void 0:$.count__id)??0}},async draft(t){const r=await fetch(`${s}/api/app/${e}/draft`,{method:"POST",headers:n,body:JSON.stringify(t)});if(!r.ok)throw new Error(`Failed to create draft for ${e}: ${r.statusText}`);return r.json()},async draftUpdate(t,r){const a=await fetch(`${s}/api/app/${e}/${t}/draft`,{method:"POST",headers:n,body:JSON.stringify(r)});if(!a.ok)throw new Error(`Failed to update draft for ${e} ${t}: ${a.statusText}`);return a.json()},async draftPatch(t,r){const a=await fetch(`${s}/api/app/${e}/${t}/draft`,{method:"PATCH",headers:n,body:JSON.stringify(r)});if(!a.ok)throw new Error(`Failed to patch draft for ${e} ${t}: ${a.statusText}`);return a.json()},async draftInteraction(t){const r=await fetch(`${s}/api/app/${e}/draft`,{method:"PATCH",headers:n,body:JSON.stringify(t)});if(!r.ok)throw new Error(`Failed to create interactive draft for ${e}: ${r.statusText}`);const a=await r.json();return{...a.Data,_id:a.Data._id}},async metric(t){const r={Type:"Metric",...t},a=await fetch(`${s}/api/app/${e}/metric`,{method:"POST",headers:n,body:JSON.stringify(r)});if(!a.ok)throw new Error(`Failed to get metrics for ${e}: ${a.statusText}`);return a.json()},async pivot(t){const r={Type:"Pivot",...t},a=await fetch(`${s}/api/app/${e}/pivot`,{method:"POST",headers:n,body:JSON.stringify(r)});if(!a.ok)throw new Error(`Failed to get pivot data for ${e}: ${a.statusText}`);return a.json()},async fields(){const t=await fetch(`${s}/api/app/${e}/fields`,{method:"GET",headers:n});if(!t.ok)throw new Error(`Failed to get fields for ${e}: ${t.statusText}`);return t.json()},async fetchField(t,r){const a=await fetch(`${s}/api/app/${e}/${t}/field/${r}/fetch`,{method:"GET",headers:n});if(!a.ok)throw new Error(`Failed to fetch field ${r} for ${e}: ${a.statusText}`);return(await a.json()).Data}}}exports.api=w;exports.getApiBaseUrl=l;exports.getDefaultHeaders=d;exports.setApiBaseUrl=u;exports.setDefaultHeaders=h;

package/dist/client-V-WzUb8H.js

@@ -1,237 +0,0 @@
-let o = {
-  baseUrl: "",
-  headers: {
-    "Content-Type": "application/json"
-  }
-};
-function u(e) {
-  o.baseUrl = e;
-}
-function h(e) {
-  o.headers = { ...o.headers, ...e };
-}
-function d() {
-  return { ...o.headers };
-}
-function w() {
-  return o.baseUrl || "";
-}
-function i(e) {
-  if (e == null)
-    return e;
-  if (Array.isArray(e))
-    return e.map((s) => i(s));
-  if (typeof e == "object") {
-    if ("$__dt__" in e)
-      return new Date(e.$__dt__ * 1e3);
-    if ("$__d__" in e)
-      return new Date(e.$__d__);
-    const s = {};
-    for (const [n, t] of Object.entries(e))
-      s[n] = i(t);
-    return s;
-  }
-  return e;
-}
-function y(e) {
-  const s = o.baseUrl, n = o.headers;
-  return {
-    async get(t) {
-      const r = await fetch(`${s}/api/app/${e}/${t}/read`, {
-        method: "GET",
-        headers: n
-      });
-      if (!r.ok)
-        throw new Error(`Failed to get ${e} ${t}: ${r.statusText}`);
-      const a = await r.json();
-      return i(a.Data);
-    },
-    async create(t) {
-      const r = await fetch(`${s}/api/app/${e}/create`, {
-        method: "POST",
-        headers: n,
-        body: JSON.stringify(t)
-      });
-      if (!r.ok)
-        throw new Error(`Failed to create ${e}: ${r.statusText}`);
-      return r.json();
-    },
-    async update(t, r) {
-      const a = await fetch(`${s}/api/app/${e}/${t}/update`, {
-        method: "POST",
-        headers: n,
-        body: JSON.stringify(r)
-      });
-      if (!a.ok)
-        throw new Error(
-          `Failed to update ${e} ${t}: ${a.statusText}`
-        );
-      return a.json();
-    },
-    async delete(t) {
-      const r = await fetch(`${s}/api/app/${e}/${t}/delete`, {
-        method: "DELETE",
-        headers: n
-      });
-      if (!r.ok)
-        throw new Error(
-          `Failed to delete ${e} ${t}: ${r.statusText}`
-        );
-      return r.json();
-    },
-    async list(t) {
-      const r = {
-        Type: "List",
-        ...t
-      }, a = await fetch(`${s}/api/app/${e}/list`, {
-        method: "POST",
-        headers: n,
-        body: JSON.stringify(r)
-      });
-      if (!a.ok)
-        throw new Error(`Failed to list ${e}: ${a.statusText}`);
-      return {
-        Data: (await a.json()).Data.map((f) => i(f))
-      };
-    },
-    async count(t) {
-      var p, $;
-      const r = {
-        Type: "Metric",
-        GroupBy: [],
-        Metric: [{ Field: "_id", Type: "Count" }],
-        ...(t == null ? void 0 : t.Filter) && { Filter: t.Filter }
-      }, a = await fetch(`${s}/api/app/${e}/metric`, {
-        method: "POST",
-        headers: n,
-        body: JSON.stringify(r)
-      });
-      if (!a.ok)
-        throw new Error(`Failed to count ${e}: ${a.statusText}`);
-      return { Count: (($ = (p = (await a.json()).Data) == null ? void 0 : p[0]) == null ? void 0 : $.count__id) ?? 0 };
-    },
-    // ============================================================
-    // DRAFT/INTERACTIVE OPERATIONS
-    // ============================================================
-    async draft(t) {
-      const r = await fetch(`${s}/api/app/${e}/draft`, {
-        method: "POST",
-        headers: n,
-        body: JSON.stringify(t)
-      });
-      if (!r.ok)
-        throw new Error(
-          `Failed to create draft for ${e}: ${r.statusText}`
-        );
-      return r.json();
-    },
-    async draftUpdate(t, r) {
-      const a = await fetch(`${s}/api/app/${e}/${t}/draft`, {
-        method: "POST",
-        headers: n,
-        body: JSON.stringify(r)
-      });
-      if (!a.ok)
-        throw new Error(
-          `Failed to update draft for ${e} ${t}: ${a.statusText}`
-        );
-      return a.json();
-    },
-    async draftPatch(t, r) {
-      const a = await fetch(`${s}/api/app/${e}/${t}/draft`, {
-        method: "PATCH",
-        headers: n,
-        body: JSON.stringify(r)
-      });
-      if (!a.ok)
-        throw new Error(
-          `Failed to patch draft for ${e} ${t}: ${a.statusText}`
-        );
-      return a.json();
-    },
-    async draftInteraction(t) {
-      const r = await fetch(`${s}/api/app/${e}/draft`, {
-        method: "PATCH",
-        headers: n,
-        body: JSON.stringify(t)
-      });
-      if (!r.ok)
-        throw new Error(
-          `Failed to create interactive draft for ${e}: ${r.statusText}`
-        );
-      const a = await r.json();
-      return {
-        ...a.Data,
-        _id: a.Data._id
-      };
-    },
-    // ============================================================
-    // QUERY OPERATIONS
-    // ============================================================
-    async metric(t) {
-      const r = {
-        Type: "Metric",
-        ...t
-      }, a = await fetch(`${s}/api/app/${e}/metric`, {
-        method: "POST",
-        headers: n,
-        body: JSON.stringify(r)
-      });
-      if (!a.ok)
-        throw new Error(
-          `Failed to get metrics for ${e}: ${a.statusText}`
-        );
-      return a.json();
-    },
-    async pivot(t) {
-      const r = {
-        Type: "Pivot",
-        ...t
-      }, a = await fetch(`${s}/api/app/${e}/pivot`, {
-        method: "POST",
-        headers: n,
-        body: JSON.stringify(r)
-      });
-      if (!a.ok)
-        throw new Error(
-          `Failed to get pivot data for ${e}: ${a.statusText}`
-        );
-      return a.json();
-    },
-    // ============================================================
-    // METADATA OPERATIONS
-    // ============================================================
-    async fields() {
-      const t = await fetch(`${s}/api/app/${e}/fields`, {
-        method: "GET",
-        headers: n
-      });
-      if (!t.ok)
-        throw new Error(
-          `Failed to get fields for ${e}: ${t.statusText}`
-        );
-      return t.json();
-    },
-    async fetchField(t, r) {
-      const a = await fetch(
-        `${s}/api/app/${e}/${t}/field/${r}/fetch`,
-        {
-          method: "GET",
-          headers: n
-        }
-      );
-      if (!a.ok)
-        throw new Error(
-          `Failed to fetch field ${r} for ${e}: ${a.statusText}`
-        );
-      return (await a.json()).Data;
-    }
-  };
-}
-export {
-  y as a,
-  h as b,
-  w as c,
-  d as g,
-  u as s
-};