@ram_28/kf-ai-sdk 2.0.2 → 2.0.3

package/sdk/workflow/types.ts

@@ -0,0 +1,84 @@
+// ============================================================
+// Workflow Types - Business Process / Activity Operations
+// ============================================================
+
+import type {
+  ListOptionsType,
+  ListResponseType,
+  MetricOptionsType,
+  MetricResponseType,
+  DraftResponseType,
+  CreateUpdateResponseType,
+} from "../types/common";
+
+import type {
+  StringFieldType,
+  SelectFieldType,
+  DateTimeFieldType,
+  ReferenceFieldType,
+} from "../types/base-fields";
+import type { UserRefType } from "../types/base-fields";
+
+/**
+ * Response from Workflow.start()
+ */
+export interface WorkflowStartResponseType {
+  activityId: string;
+  activityInstanceId: string;
+}
+
+/**
+ * Response from the activity progress endpoint
+ */
+export interface ActivityProgressType {
+  Stage?: string;
+  Progress?: number;
+  [key: string]: any;
+}
+
+/**
+ * System fields present on every activity instance response.
+ * Returned alongside activity-specific fields from `list()` and `read()`.
+ */
+export type ActivityInstanceFieldsType = {
+  _id: StringFieldType;
+  Status: SelectFieldType<"InProgress" | "Completed">;
+  AssignedTo: ReferenceFieldType<UserRefType>;
+  CompletedAt: DateTimeFieldType;
+};
+
+/**
+ * Unified activity operations — returned by Workflow.activity(activityId)
+ *
+ * List-level methods operate on the activity as a whole.
+ * Instance-level methods accept `instanceId` as their first parameter.
+ */
+export interface ActivityOperations<T> {
+  // ── List-level ──────────────────────────────────────────────
+
+  /** List activity instances (POST .../list) */
+  list(options?: ListOptionsType): Promise<ListResponseType<ActivityInstanceFieldsType & T>>;
+
+  /** Get activity metrics (POST .../metric) */
+  metric(options: Omit<MetricOptionsType, "Type">): Promise<MetricResponseType>;
+
+  // ── Instance-level ──────────────────────────────────────────
+
+  /** Read the activity instance data (GET .../read) */
+  read(instanceId: string): Promise<ActivityInstanceFieldsType & T>;
+
+  /** Update the activity instance (POST .../update) */
+  update(instanceId: string, data: Partial<T>): Promise<CreateUpdateResponseType>;
+
+  /** Start a draft edit session (PATCH .../draft) */
+  draftStart(instanceId: string, data: Partial<T>): Promise<DraftResponseType>;
+
+  /** End a draft edit session and commit (POST .../draft) */
+  draftEnd(instanceId: string, data: Partial<T>): Promise<CreateUpdateResponseType>;
+
+  /** Complete the activity (POST .../done) */
+  complete(instanceId: string): Promise<CreateUpdateResponseType>;
+
+  /** Get activity progress (GET .../progress) */
+  progress(instanceId: string): Promise<ActivityProgressType>;
+}

package/sdk/workflow.ts

@@ -0,0 +1,25 @@
+// ============================================================
+// WORKFLOW MODULE - Main Entry Point
+// @ram_28/kf-ai-sdk/workflow
+// ============================================================
+
+export { Workflow } from './workflow/client';
+export { Activity } from './workflow/Activity';
+export { ActivityInstance } from './workflow/ActivityInstance';
+export type {
+  ActivityInstanceType,
+  EditableFieldAccessor,
+  ReadonlyFieldAccessor,
+} from './workflow/ActivityInstance';
+export type {
+  ActivityInstanceFieldsType,
+  ActivityOperations,
+  ActivityProgressType,
+  WorkflowStartResponseType,
+} from './workflow/types';
+
+export { useActivityForm } from './workflow/components/useActivityForm';
+export type {
+  UseActivityFormOptions,
+  UseActivityFormReturn,
+} from './workflow/components/useActivityForm';

package/sdk/workflow.types.ts

@@ -0,0 +1,11 @@
+// ============================================================
+// WORKFLOW MODULE - Type Exports
+// @ram_28/kf-ai-sdk/workflow/types
+// ============================================================
+
+export type {
+  ActivityInstanceFieldsType,
+  ActivityOperations,
+  ActivityProgressType,
+  WorkflowStartResponseType,
+} from './workflow/types';

package/dist/client-Bo-RLKJi.cjs

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

package/dist/client-eA4VvNTo.js

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