@rsconcept/rstool 0.10.2 → 1.0.0

package/src/models/import-export.ts

@@ -0,0 +1,24 @@
+import { type PortalModelImportData, type PortalSchemaImportData } from './portal-json';
+
+/** Portal export target: conceptual schema or model values. */
+export type PortalExportKind = 'schema' | 'model';
+
+/** Serialized JSON string or parsed object for export helpers. */
+export type ExportFormat = 'json' | 'object';
+
+/** Input for {@link RSToolAgent.exportPortal}. */
+export interface ExportPortalInput {
+  kind: PortalExportKind;
+  /** Default: `json` (string). Use `object` for structured data. */
+  format?: ExportFormat;
+}
+
+/**
+ * Import payload discriminator.
+ *
+ * Use `'auto'` to detect from JSON shape, or pass an explicit kind when ambiguous.
+ */
+export type ImportDataKind = 'auto' | 'session' | 'portal-schema' | 'portal-details';
+
+/** JSON string or Portal import object, depending on {@link ExportFormat}. */
+export type ExportPortalResult = string | PortalSchemaImportData | PortalModelImportData;

package/src/models/index.ts

@@ -1,3 +1,12 @@
+export {
+  type AgentConstituentaPatch,
+  type ApplySchemaPatchInput,
+  type ApplySchemaPatchResult,
+  type SessionStateDetail,
+  type SessionStateResult,
+  type SessionSummary,
+  type SessionSummaryItem
+} from './agent-workflow';
 export { type AnalysisResult, type AnalyzeExpressionInput } from './analysis';
 export {
   CstType,
@@ -8,34 +17,33 @@ export {
   type RSToolErrorDescription,
   type RSToolValue
 } from './common';
-export {
-  type AddOrUpdateConstituentaInput,
-  type AddOrUpdateConstituentaResult,
-  type ConstituentaDraft,
-  type ConstituentaState
-} from './constituenta';
+export { type ApplyConstituentsMode, type ConstituentaDraft, type ConstituentaState } from './constituenta';
 export { type DiagnosticRecord, type ListDiagnosticsFilters } from './diagnostic';
+export { type EvaluateInput, type EvaluationResult } from './evaluation';
 export {
-  type EvaluateConstituentaInput,
-  type EvaluateExpressionInput,
-  type EvaluationResult
-} from './evaluation';
+  type ExportFormat,
+  type ExportPortalInput,
+  type ExportPortalResult,
+  type ImportDataKind,
+  type PortalExportKind
+} from './import-export';
 export {
-  type ClearConstituentaValuesInput,
   type ModelValueState,
   type RecalculateModelResult,
   type SessionModelState,
   type SetConstituentaValueInput,
-  type SetConstituentaValuesInput
+  type SetModelValuesInput
 } from './model-value';
 export {
   PORTAL_JSON_CONTRACT_VERSION,
   type PortalImportMetadata,
   type PortalModelImportData,
+  type PortalRsformDetails,
   type PortalSchemaConstituenta,
   type PortalSchemaImportData,
-  type PortalTermForm
+  type PortalTermForm,
+  portalItemToDraft
 } from './portal-json';
 export { RSToolAgent } from './rstool-agent';
 export { type SessionHandle, type SessionRevision, type SessionState } from './session';
-export { CONTRACT_VERSION, type RSToolAgentContract } from './tool-contract';
+export { CONTRACT_VERSION, type RSToolAgentContract, type RSToolAgentOptions } from './tool-contract';

package/src/models/model-value.ts

@@ -1,5 +1,6 @@
 import { type BasicBinding, type EvalStatus, type RSToolValue } from './common';
 
+/** Model value for one constituent. */
 export interface ModelValueState {
   id: number;
   /** Frontend type string: `basic` or normalized effective typification. */
@@ -7,11 +8,14 @@ export interface ModelValueState {
   value: RSToolValue | BasicBinding;
 }
 
+/** All model values in a session. */
 export interface SessionModelState {
   items: ModelValueState[];
 }
 
+/** Set or replace the model value for one constituent. */
 export interface SetConstituentaValueInput {
+  /** Target constituent id. */
   target: number;
   /** Optional type override; inferred from schema when omitted. */
   type?: string;
@@ -26,6 +30,14 @@ export interface ClearConstituentaValuesInput {
   items: number[];
 }
 
+/** Input for {@link RSToolAgent.setModelValues}. */
+export interface SetModelValuesInput {
+  set?: SetConstituentaValueInput[];
+  /** Constituent ids whose model values should be cleared. */
+  clear?: number[];
+}
+
+/** Per-constituent outcome after {@link RSToolAgent.recalculateModel}. */
 export interface RecalculateModelResult {
   items: Array<{ id: number; alias: string; value: RSToolValue | null; status: EvalStatus }>;
 }

package/src/models/portal-json.ts

@@ -1,8 +1,10 @@
 import { type BasicBinding, type RSToolValue } from './common';
+import { type ConstituentaDraft } from './constituenta';
 
 /** Portal JSON import/export format version (schema and model files). */
 export const PORTAL_JSON_CONTRACT_VERSION = '1.0.0';
 
+/** Shared metadata block in Portal schema and model JSON files. */
 export interface PortalImportMetadata {
   contract_version: string;
   title: string;
@@ -10,11 +12,13 @@ export interface PortalImportMetadata {
   description: string;
 }
 
+/** Inflected or tagged surface form of a term. */
 export interface PortalTermForm {
   text: string;
   tags: string;
 }
 
+/** One constituent in Portal schema JSON (`cst_type`, snake_case fields). */
 export interface PortalSchemaConstituenta {
   id: number;
   alias: string;
@@ -31,11 +35,30 @@ export interface PortalSchemaConstituenta {
   term_forms: PortalTermForm[];
 }
 
+/** Full Portal conceptual schema import/export document. */
 export interface PortalSchemaImportData extends PortalImportMetadata {
   items: PortalSchemaConstituenta[];
   attribution: Array<{ container: number; attribute: number }>;
 }
 
+/** `GET /api/rsforms/:id/details` response (schema payload only). */
+export interface PortalRsformDetails {
+  id?: number;
+  title?: string;
+  alias?: string;
+  description?: string;
+  items: Array<{
+    id: number;
+    alias: string;
+    cst_type: string;
+    definition_formal?: string;
+    term_raw?: string;
+    definition_raw?: string;
+    convention?: string;
+  }>;
+}
+
+/** Full Portal conceptual model import/export document. */
 export interface PortalModelImportData extends PortalImportMetadata {
   items: Array<{
     id: number;
@@ -43,3 +66,24 @@ export interface PortalModelImportData extends PortalImportMetadata {
     value: RSToolValue | BasicBinding;
   }>;
 }
+
+/** Map a Portal API or JSON schema item to an agent {@link ConstituentaDraft}. */
+export function portalItemToDraft(item: {
+  id: number;
+  alias: string;
+  cst_type: string;
+  definition_formal?: string;
+  term_raw?: string;
+  definition_raw?: string;
+  convention?: string;
+}): ConstituentaDraft {
+  return {
+    id: item.id,
+    alias: item.alias,
+    cstType: item.cst_type as ConstituentaDraft['cstType'],
+    definitionFormal: item.definition_formal ?? '',
+    term: item.term_raw ?? '',
+    definitionText: item.definition_raw ?? '',
+    convention: item.convention ?? ''
+  };
+}