@zudello/modelcontextprotocol 1.0.0

package/dist/constants/zudello.d.ts

@@ -0,0 +1,627 @@
+import { z } from "zod";
+/**
+ * Comprehensive Zudello model, module, and submodule definitions.
+ * This module provides shared knowledge of valid combinations across all Zudello tools.
+ *
+ * Data structure based on the official Zudello API specification.
+ */
+/**
+ * Valid Zudello models
+ */
+export declare const ZUDELLO_MODELS: readonly ["Budget", "Contract", "Account", "AccountCategory", "AccountGroup", "AccountingPeriod", "AmortizationSchedule", "Batch", "Bin", "ContractCategory", "ContractGroup", "CostCentre", "CostType", "Currency", "CustomerCategory", "CustomerGroup", "Department", "ExpenseCategory", "FixedAsset", "ItemCategory", "ItemGroup", "Location", "MileageRate", "PaymentMethod", "PaymentTerm", "Project", "ProjectGroup", "ProjectTask", "ProjectType", "Subsidiary", "SupplierCategory", "SupplierGroup", "TaxRate", "TaxSolution", "TeamAddress", "UnitOfMeasure", "Warehouse", "Zone", "Transaction", "Item", "Customer", "Employee", "Supplier"];
+/**
+ * Valid Zudello modules
+ */
+export declare const ZUDELLO_MODULES: readonly ["BUDGETS", "CONTRACTS", "DIMENSIONS", "EXPENSES", "INVENTORY", "PURCHASING", "RELATIONSHIPS", "SALES"];
+/**
+ * Valid Zudello submodules
+ */
+export declare const ZUDELLO_SUBMODULES: readonly ["BUDGET", "CONTRACT", "ACCOUNT", "ACCOUNT_CATEGORY", "ACCOUNT_GROUP", "ACCOUNTING_PERIOD", "AMORTIZATION_SCHEDULE", "BATCH", "BIN", "CONTRACT_CATEGORY", "CONTRACT_GROUP", "COST_CENTRE", "COST_TYPE", "CURRENCY", "CUSTOMER_CATEGORY", "CUSTOMER_GROUP", "DEPARTMENT", "EXPENSE_CATEGORY", "FIXED_ASSET", "ITEM_CATEGORY", "ITEM_GROUP", "LOCATION", "MILEAGE_RATE", "PAYMENT_METHOD", "PAYMENT_TERM", "PROJECT", "PROJECT_GROUP", "PROJECT_TASK", "PROJECT_TYPE", "SUBSIDIARY", "SUPPLIER_CATEGORY", "SUPPLIER_GROUP", "TAX_RATE", "TAX_SOLUTION", "TEAM_ADDRESS", "UNIT_OF_MEASURE", "WAREHOUSE", "ZONE", "CLAIM", "EXPENSE", "MILEAGE", "PAYMENT", "REFUND", "CATALOGUE", "RECEIPT", "CREDIT", "INVOICE", "ORDER", "QUOTE", "REQUISITION", "RETURN", "STATEMENT", "CUSTOMER", "EMPLOYEE", "SUPPLIER", "REMITTANCE"];
+export type ZudelloModel = typeof ZUDELLO_MODELS[number];
+export type ZudelloModule = typeof ZUDELLO_MODULES[number];
+export type ZudelloSubmodule = typeof ZUDELLO_SUBMODULES[number];
+/**
+ * Valid combinations of model, module, and submodule.
+ * Based on the official Zudello API specification.
+ */
+export declare const ZUDELLO_MODEL_COMBINATIONS: readonly [{
+    readonly model: "Budget";
+    readonly module: "BUDGETS";
+    readonly submodule: "BUDGET";
+}, {
+    readonly model: "Contract";
+    readonly module: "CONTRACTS";
+    readonly submodule: "CONTRACT";
+}, {
+    readonly model: "Account";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "ACCOUNT";
+}, {
+    readonly model: "AccountCategory";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "ACCOUNT_CATEGORY";
+}, {
+    readonly model: "AccountGroup";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "ACCOUNT_GROUP";
+}, {
+    readonly model: "AccountingPeriod";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "ACCOUNTING_PERIOD";
+}, {
+    readonly model: "AmortizationSchedule";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "AMORTIZATION_SCHEDULE";
+}, {
+    readonly model: "Batch";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "BATCH";
+}, {
+    readonly model: "Bin";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "BIN";
+}, {
+    readonly model: "ContractCategory";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "CONTRACT_CATEGORY";
+}, {
+    readonly model: "ContractGroup";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "CONTRACT_GROUP";
+}, {
+    readonly model: "CostCentre";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "COST_CENTRE";
+}, {
+    readonly model: "CostType";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "COST_TYPE";
+}, {
+    readonly model: "Currency";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "CURRENCY";
+}, {
+    readonly model: "CustomerCategory";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "CUSTOMER_CATEGORY";
+}, {
+    readonly model: "CustomerGroup";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "CUSTOMER_GROUP";
+}, {
+    readonly model: "Department";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "DEPARTMENT";
+}, {
+    readonly model: "ExpenseCategory";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "EXPENSE_CATEGORY";
+}, {
+    readonly model: "FixedAsset";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "FIXED_ASSET";
+}, {
+    readonly model: "ItemCategory";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "ITEM_CATEGORY";
+}, {
+    readonly model: "ItemGroup";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "ITEM_GROUP";
+}, {
+    readonly model: "Location";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "LOCATION";
+}, {
+    readonly model: "MileageRate";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "MILEAGE_RATE";
+}, {
+    readonly model: "PaymentMethod";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "PAYMENT_METHOD";
+}, {
+    readonly model: "PaymentTerm";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "PAYMENT_TERM";
+}, {
+    readonly model: "Project";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "PROJECT";
+}, {
+    readonly model: "ProjectGroup";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "PROJECT_GROUP";
+}, {
+    readonly model: "ProjectTask";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "PROJECT_TASK";
+}, {
+    readonly model: "ProjectType";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "PROJECT_TYPE";
+}, {
+    readonly model: "Subsidiary";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "SUBSIDIARY";
+}, {
+    readonly model: "SupplierCategory";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "SUPPLIER_CATEGORY";
+}, {
+    readonly model: "SupplierGroup";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "SUPPLIER_GROUP";
+}, {
+    readonly model: "TaxRate";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "TAX_RATE";
+}, {
+    readonly model: "TaxSolution";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "TAX_SOLUTION";
+}, {
+    readonly model: "TeamAddress";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "TEAM_ADDRESS";
+}, {
+    readonly model: "UnitOfMeasure";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "UNIT_OF_MEASURE";
+}, {
+    readonly model: "Warehouse";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "WAREHOUSE";
+}, {
+    readonly model: "Zone";
+    readonly module: "DIMENSIONS";
+    readonly submodule: "ZONE";
+}, {
+    readonly model: "Transaction";
+    readonly module: "EXPENSES";
+    readonly submodule: "CLAIM";
+}, {
+    readonly model: "Transaction";
+    readonly module: "EXPENSES";
+    readonly submodule: "EXPENSE";
+}, {
+    readonly model: "Transaction";
+    readonly module: "EXPENSES";
+    readonly submodule: "MILEAGE";
+}, {
+    readonly model: "Transaction";
+    readonly module: "EXPENSES";
+    readonly submodule: "PAYMENT";
+}, {
+    readonly model: "Transaction";
+    readonly module: "EXPENSES";
+    readonly submodule: "REFUND";
+}, {
+    readonly model: "Item";
+    readonly module: "INVENTORY";
+    readonly submodule: "CATALOGUE";
+}, {
+    readonly model: "Transaction";
+    readonly module: "INVENTORY";
+    readonly submodule: "RECEIPT";
+}, {
+    readonly model: "Transaction";
+    readonly module: "PURCHASING";
+    readonly submodule: "CREDIT";
+}, {
+    readonly model: "Transaction";
+    readonly module: "PURCHASING";
+    readonly submodule: "INVOICE";
+}, {
+    readonly model: "Transaction";
+    readonly module: "PURCHASING";
+    readonly submodule: "ORDER";
+}, {
+    readonly model: "Transaction";
+    readonly module: "PURCHASING";
+    readonly submodule: "QUOTE";
+}, {
+    readonly model: "Transaction";
+    readonly module: "PURCHASING";
+    readonly submodule: "REQUISITION";
+}, {
+    readonly model: "Transaction";
+    readonly module: "PURCHASING";
+    readonly submodule: "RETURN";
+}, {
+    readonly model: "Transaction";
+    readonly module: "PURCHASING";
+    readonly submodule: "STATEMENT";
+}, {
+    readonly model: "Customer";
+    readonly module: "RELATIONSHIPS";
+    readonly submodule: "CUSTOMER";
+}, {
+    readonly model: "Employee";
+    readonly module: "RELATIONSHIPS";
+    readonly submodule: "EMPLOYEE";
+}, {
+    readonly model: "Supplier";
+    readonly module: "RELATIONSHIPS";
+    readonly submodule: "SUPPLIER";
+}, {
+    readonly model: "Transaction";
+    readonly module: "SALES";
+    readonly submodule: "CREDIT";
+}, {
+    readonly model: "Transaction";
+    readonly module: "SALES";
+    readonly submodule: "INVOICE";
+}, {
+    readonly model: "Transaction";
+    readonly module: "SALES";
+    readonly submodule: "ORDER";
+}, {
+    readonly model: "Transaction";
+    readonly module: "SALES";
+    readonly submodule: "QUOTE";
+}, {
+    readonly model: "Transaction";
+    readonly module: "SALES";
+    readonly submodule: "REMITTANCE";
+}];
+export type ZudelloModelCombination = typeof ZUDELLO_MODEL_COMBINATIONS[number];
+/**
+ * All unique status keys used across Zudello modules.
+ * IMPORTANT: Statuses are user-configurable per organization.
+ * Use zudelloListConfigs with configType 'document_status' to get actual configured statuses.
+ */
+export declare const ZUDELLO_STATUS_KEYS: readonly ["DRAFT", "ACTIVE", "INACTIVE", "DELETED", "ARCHIVED", "PROCESSING", "APPROVAL", "REJECT", "REJECTED", "UNABLE", "SCANNING", "REVIEW", "READY", "COMPLETE", "CLOSED", "DUPLICATE", "NEW_VENDOR", "PO_MISSING", "PO_VARIANCE", "GR_PENDING", "PENDING", "PLACED", "PARTIALLY_RECEIVED", "RECEIVED", "PARTIALLY_INVOICED", "INVOICED_NOT_RECEIVED", "READY_TO_RECONCILE", "RECONCILE", "REQUESTED", "CUSTOMER_CHECK", "ITEM_CHECK", "PRICE_CHECK", "STOCK_CHECK", "UNSUPPORTED"];
+export type ZudelloStatusKey = typeof ZUDELLO_STATUS_KEYS[number];
+/**
+ * Status configuration entry with module, submodule, display name, and API key.
+ */
+export interface ZudelloStatusConfig {
+    module: string;
+    submodule: string;
+    statusName: string;
+    statusKey: string;
+}
+/**
+ * Default status configurations by module/submodule.
+ * IMPORTANT: These are default statuses. Organizations can configure custom statuses.
+ * Use zudelloListConfigs(configType: 'document_status', module, submodule) for actual configs.
+ */
+export declare const ZUDELLO_STATUS_CONFIGURATIONS: ZudelloStatusConfig[];
+/**
+ * Check if a model is valid
+ */
+export declare function isValidZudelloModel(model: string): model is ZudelloModel;
+/**
+ * Check if a module is valid
+ */
+export declare function isValidZudelloModule(module: string): module is ZudelloModule;
+/**
+ * Check if a submodule is valid
+ */
+export declare function isValidZudelloSubmodule(submodule: string): submodule is ZudelloSubmodule;
+/**
+ * Check if a model/module/submodule combination is valid
+ */
+export declare function isValidZudelloCombination(model: string, module?: string, submodule?: string): boolean;
+/**
+ * Get valid modules for a given model
+ */
+export declare function getValidModulesForModel(model: ZudelloModel): ZudelloModule[];
+/**
+ * Get valid submodules for a given model and module
+ */
+export declare function getValidSubmodulesForModel(model: ZudelloModel, module?: ZudelloModule): ZudelloSubmodule[];
+/**
+ * Get model combinations by functional area
+ */
+export declare function getModelsByModule(module: ZudelloModule): ZudelloModel[];
+/**
+ * Check if a status key is valid (exists in any context)
+ */
+export declare function isValidStatusKey(statusKey: string): statusKey is ZudelloStatusKey;
+/**
+ * Check if a status key is valid for a specific module/submodule context
+ */
+export declare function isValidStatusForContext(module: string, submodule: string, statusKey: string): boolean;
+/**
+ * Get default statuses for a module/submodule context.
+ * IMPORTANT: These are defaults. Use zudelloListConfigs with configType 'document_status' for actual configs.
+ */
+export declare function getDefaultStatusesForContext(module: string, submodule: string): ZudelloStatusConfig[];
+/**
+ * Convert a user-friendly status name to its API key for a given context.
+ * Returns undefined if not found.
+ */
+export declare function getStatusKeyByName(module: string, submodule: string, statusName: string): string | undefined;
+/**
+ * Convert an API status key to its user-friendly name for a given context.
+ * Returns undefined if not found.
+ */
+export declare function getStatusNameByKey(module: string, submodule: string, statusKey: string): string | undefined;
+/**
+ * Get common statuses that appear in most contexts.
+ * Useful for general filtering when context is not known.
+ */
+export declare function getCommonStatuses(): Array<{
+    name: string;
+    key: string;
+}>;
+/**
+ * Get a description of status usage for tool documentation.
+ */
+export declare function getStatusUsageGuide(): string;
+/**
+ * Zod schema for Zudello models
+ */
+export declare const zudelloModelSchema: z.ZodEnum<["Budget", "Contract", "Account", "AccountCategory", "AccountGroup", "AccountingPeriod", "AmortizationSchedule", "Batch", "Bin", "ContractCategory", "ContractGroup", "CostCentre", "CostType", "Currency", "CustomerCategory", "CustomerGroup", "Department", "ExpenseCategory", "FixedAsset", "ItemCategory", "ItemGroup", "Location", "MileageRate", "PaymentMethod", "PaymentTerm", "Project", "ProjectGroup", "ProjectTask", "ProjectType", "Subsidiary", "SupplierCategory", "SupplierGroup", "TaxRate", "TaxSolution", "TeamAddress", "UnitOfMeasure", "Warehouse", "Zone", "Transaction", "Item", "Customer", "Employee", "Supplier"]>;
+/**
+ * Zod schema for Zudello modules
+ */
+export declare const zudelloModuleSchema: z.ZodEnum<["BUDGETS", "CONTRACTS", "DIMENSIONS", "EXPENSES", "INVENTORY", "PURCHASING", "RELATIONSHIPS", "SALES"]>;
+/**
+ * Zod schema for Zudello submodules
+ */
+export declare const zudelloSubmoduleSchema: z.ZodEnum<["BUDGET", "CONTRACT", "ACCOUNT", "ACCOUNT_CATEGORY", "ACCOUNT_GROUP", "ACCOUNTING_PERIOD", "AMORTIZATION_SCHEDULE", "BATCH", "BIN", "CONTRACT_CATEGORY", "CONTRACT_GROUP", "COST_CENTRE", "COST_TYPE", "CURRENCY", "CUSTOMER_CATEGORY", "CUSTOMER_GROUP", "DEPARTMENT", "EXPENSE_CATEGORY", "FIXED_ASSET", "ITEM_CATEGORY", "ITEM_GROUP", "LOCATION", "MILEAGE_RATE", "PAYMENT_METHOD", "PAYMENT_TERM", "PROJECT", "PROJECT_GROUP", "PROJECT_TASK", "PROJECT_TYPE", "SUBSIDIARY", "SUPPLIER_CATEGORY", "SUPPLIER_GROUP", "TAX_RATE", "TAX_SOLUTION", "TEAM_ADDRESS", "UNIT_OF_MEASURE", "WAREHOUSE", "ZONE", "CLAIM", "EXPENSE", "MILEAGE", "PAYMENT", "REFUND", "CATALOGUE", "RECEIPT", "CREDIT", "INVOICE", "ORDER", "QUOTE", "REQUISITION", "RETURN", "STATEMENT", "CUSTOMER", "EMPLOYEE", "SUPPLIER", "REMITTANCE"]>;
+/**
+ * Zod schema for Zudello status keys.
+ * IMPORTANT: Statuses are user-configurable. These are default values.
+ * Use zudelloListConfigs with configType 'document_status' for actual configs.
+ */
+export declare const zudelloStatusKeySchema: z.ZodEnum<["DRAFT", "ACTIVE", "INACTIVE", "DELETED", "ARCHIVED", "PROCESSING", "APPROVAL", "REJECT", "REJECTED", "UNABLE", "SCANNING", "REVIEW", "READY", "COMPLETE", "CLOSED", "DUPLICATE", "NEW_VENDOR", "PO_MISSING", "PO_VARIANCE", "GR_PENDING", "PENDING", "PLACED", "PARTIALLY_RECEIVED", "RECEIVED", "PARTIALLY_INVOICED", "INVOICED_NOT_RECEIVED", "READY_TO_RECONCILE", "RECONCILE", "REQUESTED", "CUSTOMER_CHECK", "ITEM_CHECK", "PRICE_CHECK", "STOCK_CHECK", "UNSUPPORTED"]>;
+/**
+ * Enhanced model schema with validation for combinations
+ */
+export declare function createValidatedModelSchema(moduleParam?: string, submoduleParam?: string): z.ZodEffects<z.ZodString, string, string>;
+/**
+ * Get human-readable description for a model
+ */
+export declare function getModelDescription(model: ZudelloModel): string;
+/**
+ * Get all valid combinations for a specific model
+ */
+export declare function getCombinationsForModel(model: ZudelloModel): ZudelloModelCombination[];
+/**
+ * Format model combinations as human-readable strings
+ */
+export declare function formatCombination(combination: ZudelloModelCombination): string;
+/**
+ * Get examples for tool descriptions
+ */
+export declare function getModelExamples(): string;
+/**
+ * Valid trigger event types for sentence automation.
+ * These determine when a sentence rule is evaluated.
+ */
+export declare const ZUDELLO_TRIGGER_EVENTS: readonly ["submit", "create", "delete", "update", "converted", "extract", "approval", "related_resource_updated", "button"];
+export type ZudelloTriggerEvent = typeof ZUDELLO_TRIGGER_EVENTS[number];
+/**
+ * Descriptions for trigger event types
+ */
+export declare const ZUDELLO_TRIGGER_EVENT_DESCRIPTIONS: Record<ZudelloTriggerEvent, string>;
+/**
+ * Valid action codes for sentence automation.
+ * Use zudelloListSentenceResources with resourceType 'ACTION_TEMPLATE' to get full payload structure.
+ */
+export declare const ZUDELLO_ACTION_CODES: readonly ["ASSIGN", "UNASSIGN", "UNASSIGN_ALL", "COMPLETE", "SET_STATUS", "SET_FIELD", "GET_APPROVAL", "APPROVAL_DOA", "APPROVAL_MANAGER", "APPROVAL_SET_LIMIT", "MARK_AS_APPROVED", "RESTART_FLOW", "CANCEL_PROCESSING", "CONSOLIDATE_LINES", "REMOVE_MATCHED_LINES", "RUN_INTEGRATION_API_TRIGGER", "START_WORKFLOW", "POST_NOTICE", "CONVERT", "SEND_EMAIL", "GENERATE_PDF", "COMPUTE_FIELD"];
+export type ZudelloActionCode = typeof ZUDELLO_ACTION_CODES[number];
+/**
+ * Descriptions for action codes
+ */
+export declare const ZUDELLO_ACTION_CODE_DESCRIPTIONS: Record<ZudelloActionCode, string>;
+/**
+ * Valid condition codes for sentence automation.
+ * Use zudelloListSentenceResources with resourceType 'CONDITION_TEMPLATE' to get full payload structure.
+ */
+export declare const ZUDELLO_CONDITION_CODES: readonly ["ALLOCATION_PO", "ALLOCATION_RECEIPT", "VARIANCE_AMOUNT", "VARIANCE_PERC", "APPROVED_TRUE", "APPROVED_FALSE"];
+export type ZudelloConditionCode = typeof ZUDELLO_CONDITION_CODES[number];
+/**
+ * Descriptions for condition codes
+ */
+export declare const ZUDELLO_CONDITION_CODE_DESCRIPTIONS: Record<ZudelloConditionCode, string>;
+/**
+ * Sentence resource types for the listSentenceResources API
+ */
+export declare const ZUDELLO_SENTENCE_RESOURCE_TYPES: readonly ["ACTION_TEMPLATE", "CONDITION_TEMPLATE"];
+export type ZudelloSentenceResourceType = typeof ZUDELLO_SENTENCE_RESOURCE_TYPES[number];
+/**
+ * Check if a trigger event is valid
+ */
+export declare function isValidTriggerEvent(event: string): event is ZudelloTriggerEvent;
+/**
+ * Check if an action code is valid
+ */
+export declare function isValidActionCode(code: string): code is ZudelloActionCode;
+/**
+ * Check if a condition code is valid
+ */
+export declare function isValidConditionCode(code: string): code is ZudelloConditionCode;
+/**
+ * Get description for a trigger event
+ */
+export declare function getTriggerEventDescription(event: ZudelloTriggerEvent): string;
+/**
+ * Get description for an action code
+ */
+export declare function getActionCodeDescription(code: ZudelloActionCode): string;
+/**
+ * Get description for a condition code
+ */
+export declare function getConditionCodeDescription(code: ZudelloConditionCode): string;
+/**
+ * Get a usage guide for sentence automation.
+ * This can be referenced by tools for documentation.
+ */
+export declare function getSentenceUsageGuide(): string;
+/**
+ * Zod schema for trigger events
+ */
+export declare const zudelloTriggerEventSchema: z.ZodEnum<["submit", "create", "delete", "update", "converted", "extract", "approval", "related_resource_updated", "button"]>;
+/**
+ * Zod schema for action codes
+ */
+export declare const zudelloActionCodeSchema: z.ZodEnum<["ASSIGN", "UNASSIGN", "UNASSIGN_ALL", "COMPLETE", "SET_STATUS", "SET_FIELD", "GET_APPROVAL", "APPROVAL_DOA", "APPROVAL_MANAGER", "APPROVAL_SET_LIMIT", "MARK_AS_APPROVED", "RESTART_FLOW", "CANCEL_PROCESSING", "CONSOLIDATE_LINES", "REMOVE_MATCHED_LINES", "RUN_INTEGRATION_API_TRIGGER", "START_WORKFLOW", "POST_NOTICE", "CONVERT", "SEND_EMAIL", "GENERATE_PDF", "COMPUTE_FIELD"]>;
+/**
+ * Zod schema for condition codes
+ */
+export declare const zudelloConditionCodeSchema: z.ZodEnum<["ALLOCATION_PO", "ALLOCATION_RECEIPT", "VARIANCE_AMOUNT", "VARIANCE_PERC", "APPROVED_TRUE", "APPROVED_FALSE"]>;
+/**
+ * Zod schema for sentence resource types
+ */
+export declare const zudelloSentenceResourceTypeSchema: z.ZodEnum<["ACTION_TEMPLATE", "CONDITION_TEMPLATE"]>;
+/**
+ * Action template structures from Zudello API
+ * Based on sentence_actions.md documentation
+ */
+export interface ZudelloActionTemplate {
+    code: string;
+    name: string;
+    operator: {
+        value: string;
+        default: string;
+        use?: string;
+    };
+    field?: {
+        value: string;
+        meta: {
+            path: string;
+            type: string;
+            label?: string;
+            sentence_path?: string;
+            display_format?: string;
+            options?: Record<string, unknown>;
+        };
+    };
+    values?: Array<{
+        value: unknown;
+        source: "internal" | "external";
+        default?: unknown;
+        meta?: Record<string, unknown>;
+    }>;
+    template: string;
+    otherwise?: boolean;
+}
+/**
+ * Condition template structures from Zudello API
+ * Based on sentence_conditions.md documentation
+ */
+export interface ZudelloConditionTemplate {
+    code: string;
+    name: string;
+    operator: {
+        value: string;
+        default: string;
+        use?: string;
+    };
+    field: {
+        value: string;
+        meta: {
+            path: string;
+            type: string;
+            label?: string;
+            sentence_path?: string;
+            display_format?: string;
+            options?: Record<string, unknown>;
+        };
+    };
+    values: Array<{
+        value: unknown;
+        source: "internal" | "external";
+        default?: unknown;
+    }>;
+    template: string;
+}
+/**
+ * Common action templates with complete payload structures
+ * Extracted from sentence_actions.md
+ */
+export declare const ZUDELLO_ACTION_TEMPLATES: Record<string, ZudelloActionTemplate>;
+/**
+ * Common condition templates with complete payload structures
+ * Extracted from sentence_conditions.md
+ */
+export declare const ZUDELLO_CONDITION_TEMPLATES: Record<string, ZudelloConditionTemplate>;
+/**
+ * Get an action template by code
+ */
+export declare function getActionTemplate(code: string): ZudelloActionTemplate | undefined;
+/**
+ * Get a condition template by code
+ */
+export declare function getConditionTemplate(code: string): ZudelloConditionTemplate | undefined;
+/**
+ * Generate a sentence action payload from template
+ */
+export declare function generateActionPayload(code: string, values?: Array<{
+    value: unknown;
+    source?: "internal" | "external";
+    meta?: Record<string, unknown>;
+}>, field?: string, operator?: string, otherwise?: boolean): Record<string, unknown>;
+/**
+ * Generate a sentence condition payload from template
+ */
+export declare function generateConditionPayload(code: string, values?: Array<{
+    value: unknown;
+    source?: "internal" | "external";
+}>, field?: string, operator?: string): Record<string, unknown>;
+/**
+ * Generate a complete sentence recipe with trigger, conditions, and actions
+ */
+export declare function generateSentenceRecipe(options: {
+    trigger: {
+        module: string;
+        submodule: string;
+        event_type: string;
+        event_model?: string;
+        enabled?: boolean;
+    };
+    conditions?: Array<{
+        code: string;
+        values?: Array<{
+            value: unknown;
+            source?: "internal" | "external";
+        }>;
+        field?: string;
+        operator?: string;
+    }>;
+    actions: Array<{
+        code: string;
+        values?: Array<{
+            value: unknown;
+            source?: "internal" | "external";
+            meta?: Record<string, unknown>;
+        }>;
+        field?: string;
+        operator?: string;
+        otherwise?: boolean;
+    }>;
+    changeable?: boolean;
+}): Record<string, unknown>;
+/**
+ * Common sentence recipe templates for typical workflows
+ */
+export declare const SENTENCE_RECIPE_TEMPLATES: {
+    /**
+     * Simple status change on document submit
+     */
+    SIMPLE_STATUS_CHANGE: (module: string, submodule: string, statusKey: string) => Record<string, unknown>;
+    /**
+     * Approval workflow with fallback to rejected status
+     */
+    APPROVAL_WITH_FALLBACK: (module: string, submodule: string, approvalType?: "GET_APPROVAL" | "APPROVAL_DOA" | "APPROVAL_MANAGER") => Record<string, unknown>;
+    /**
+     * Conditional processing based on document type
+     */
+    CONDITIONAL_BY_DOCUMENT_TYPE: (module: string, submodule: string, documentTypeProperty: string, actions: Array<{
+        code: string;
+        values?: Array<{
+            value: unknown;
+            source?: "internal" | "external";
+            meta?: Record<string, unknown>;
+        }>;
+        field?: string;
+        operator?: string;
+        otherwise?: boolean;
+    }>) => Record<string, unknown>;
+};
+//# sourceMappingURL=zudello.d.ts.map

package/dist/constants/zudello.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zudello.d.ts","sourceRoot":"","sources":["../../src/constants/zudello.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;GAKG;AAMH;;GAEG;AACH,eAAO,MAAM,cAAc,wnBAuDjB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,eAAe,kHASlB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,kBAAkB,myBAyErB,CAAC;AAGX,MAAM,MAAM,YAAY,GAAG,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC;AACzD,MAAM,MAAM,aAAa,GAAG,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;AAC3D,MAAM,MAAM,gBAAgB,GAAG,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC;AAMjE;;;GAGG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4E7B,CAAC;AAEX,MAAM,MAAM,uBAAuB,GAAG,OAAO,0BAA0B,CAAC,MAAM,CAAC,CAAC;AAMhF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,ydA8CtB,CAAC;AAEX,MAAM,MAAM,gBAAgB,GAAG,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,EAAE,mBAAmB,EAkR9D,CAAC;AAMF;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,YAAY,CAExE;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,IAAI,aAAa,CAE5E;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,IAAI,gBAAgB,CAExF;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,KAAK,EAAE,MAAM,EACb,MAAM,CAAC,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAaT;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,YAAY,GAAG,aAAa,EAAE,CAI5E;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,YAAY,EACnB,MAAM,CAAC,EAAE,aAAa,GACrB,gBAAgB,EAAE,CAQpB;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,aAAa,GAAG,YAAY,EAAE,CAIvE;AAMD;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,IAAI,gBAAgB,CAEjF;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAChB,OAAO,CAIT;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAC1C,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,GAChB,mBAAmB,EAAE,CAIvB;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,GACjB,MAAM,GAAG,SAAS,CAMpB;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAChB,MAAM,GAAG,SAAS,CAKpB;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,CAcxE;AAED;;GAEG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,CAQ5C;AAMD;;GAEG;AACH,eAAO,MAAM,kBAAkB,0nBAI9B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,oHAI/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,qyBAGlC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,2dAIlC,CAAC;AAEF;;GAEG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,CAAC,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,6CAgBxB;AAMD;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAgD/D;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,YAAY,GAAG,uBAAuB,EAAE,CAEtF;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,uBAAuB,GAAG,MAAM,CAE9E;AAED;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,MAAM,CASzC;AAMD;;;GAGG;AACH,eAAO,MAAM,sBAAsB,6HAUzB,CAAC;AAEX,MAAM,MAAM,mBAAmB,GAAG,OAAO,sBAAsB,CAAC,MAAM,CAAC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,kCAAkC,EAAE,MAAM,CAAC,mBAAmB,EAAE,MAAM,CAUlF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,oBAAoB,kYAuBvB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAAG,OAAO,oBAAoB,CAAC,MAAM,CAAC,CAAC;AAEpE;;GAEG;AACH,eAAO,MAAM,gCAAgC,EAAE,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAuB9E,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,yHAO1B,CAAC;AAEX,MAAM,MAAM,oBAAoB,GAAG,OAAO,uBAAuB,CAAC,MAAM,CAAC,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,mCAAmC,EAAE,MAAM,CAAC,oBAAoB,EAAE,MAAM,CAOpF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,+BAA+B,oDAGlC,CAAC;AAEX,MAAM,MAAM,2BAA2B,GAAG,OAAO,+BAA+B,CAAC,MAAM,CAAC,CAAC;AAMzF;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,mBAAmB,CAE/E;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,iBAAiB,CAEzE;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,oBAAoB,CAE/E;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,mBAAmB,GAAG,MAAM,CAE7E;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,iBAAiB,GAAG,MAAM,CAExE;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,oBAAoB,GAAG,MAAM,CAE9E;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,IAAI,MAAM,CAmC9C;AAMD;;GAEG;AACH,eAAO,MAAM,yBAAyB,+HAGrC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB,oYAInC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,0BAA0B,2HAGtC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC,sDAE7C,CAAC;AAMF;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE;QACR,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,GAAG,CAAC,EAAE,MAAM,CAAC;KACd,CAAC;IACF,KAAK,CAAC,EAAE;QACN,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE;YACJ,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,aAAa,CAAC,EAAE,MAAM,CAAC;YACvB,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACnC,CAAC;KACH,CAAC;IACF,MAAM,CAAC,EAAE,KAAK,CAAC;QAEb,KAAK,EAAE,OAAO,CAAC;QACf,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC;QAEhC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAChC,CAAC,CAAC;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE;QACR,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,GAAG,CAAC,EAAE,MAAM,CAAC;KACd,CAAC;IACF,KAAK,EAAE;QACL,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE;YACJ,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,aAAa,CAAC,EAAE,MAAM,CAAC;YACvB,cAAc,CAAC,EAAE,MAAM,CAAC;YACxB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACnC,CAAC;KACH,CAAC;IACF,MAAM,EAAE,KAAK,CAAC;QAEZ,KAAK,EAAE,OAAO,CAAC;QACf,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC;QAChC,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC,CAAC;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,eAAO,MAAM,wBAAwB,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAkL1E,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,2BAA2B,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAgIhF,CAAC;AAMF;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS,CAEjF;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,wBAAwB,GAAG,SAAS,CAEvF;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,EAEZ,MAAM,CAAC,EAAE,KAAK,CAAC;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,CAAC,EACpG,KAAK,CAAC,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,OAAO,GAClB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAwBzB;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,MAAM,EAEZ,MAAM,CAAC,EAAE,KAAK,CAAC;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,CAAA;CAAE,CAAC,EACpE,KAAK,CAAC,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,MAAM,GAChB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAoBzB;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE;IAC9C,OAAO,EAAE;QACP,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;IACF,UAAU,CAAC,EAAE,KAAK,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QAEb,MAAM,CAAC,EAAE,KAAK,CAAC;YAAE,KAAK,EAAE,OAAO,CAAC;YAAC,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,CAAA;SAAE,CAAC,CAAC;QACrE,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC,CAAC;IACH,OAAO,EAAE,KAAK,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QAEb,MAAM,CAAC,EAAE,KAAK,CAAC;YAAE,KAAK,EAAE,OAAO,CAAC;YAAC,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SAAE,CAAC,CAAC;QACrG,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB,CAAC,CAAC;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAgC1B;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB;IACpC;;OAEG;mCAC4B,MAAM,aAAa,MAAM,aAAa,MAAM;IAa3E;;OAEG;qCAC8B,MAAM,aAAa,MAAM,iBAAgB,cAAc,GAAG,cAAc,GAAG,kBAAkB;IA2B9H;;OAEG;2CACoC,MAAM,aAAa,MAAM,wBAAwB,MAAM,WAAW,KAAK,CAAC;QAC7G,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,KAAK,CAAC;YAAE,KAAK,EAAE,OAAO,CAAC;YAAC,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SAAE,CAAC,CAAC;QACrG,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB,CAAC;CAeH,CAAC"}